This repository was archived by the owner on Feb 12, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Replaces the README with a link to https://github.com/w3c/did-test-suite - Updates the LICENSE with the W3C accepted license
- Loading branch information
Showing
2 changed files
with
9 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,8 @@ | ||
BSD 3-Clause License | ||
All Reports in this Repository are licensed by Contributors under the [W3C Software and Document | ||
License](https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document). | ||
|
||
Copyright (c) 2018, Digital Bazaar, Inc. | ||
Contributions to Specifications are made under the | ||
[W3C CLA](https://www.w3.org/community/about/agreements/cla/). | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
* Redistributions of source code must retain the above copyright notice, this | ||
list of conditions and the following disclaimer. | ||
|
||
* Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
* Neither the name of the copyright holder nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
Contributions to Software, including sample implementations, are under the | ||
[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,6 @@ | ||
# W3C Decentralized Identifiers Working Group Test Suite | ||
|
||
This repository contains the W3C | ||
[Credentials Community Group](https://www.w3.org/community/credentials/) test suite. | ||
Any conforming implementation MUST pass all tests in the test suite. | ||
This repository has moved to the W3C DID Working Group, and it can be found | ||
here: | ||
|
||
There are multiple test suites, each of which is detailed below. | ||
|
||
## Decentralized Identifiers 1.0 Test Suite | ||
|
||
This test suite will check any application that generates [Decentralized Identifiers](https://w3c-ccg.github.io/did-spec/) documents to | ||
ensure conformance with the specification. | ||
|
||
### Creating a Binary | ||
You web application will need to be accessible from the command line. It will also need to accept the following command line parameters: | ||
``` | ||
Usage: <your_program> [options] [command] | ||
Options: | ||
-?, --question //TODO add commands | ||
-h, --help output usage information | ||
Commands: | ||
validate | ||
--did true|false | ||
--document true|false | ||
--contexts [path-to-context] | ||
``` | ||
--did is used for validating identifiers. | ||
--document is used for validating documents | ||
--contexts is a list of paths to jsonld contexts used in the tests. | ||
Both did and document accept the tested object via stdin. | ||
|
||
All tests will run against your binary and assume that an exit code greater than 0 represents an error. | ||
|
||
### Creating a Config File | ||
An example local configuration for the test suite. To use: | ||
|
||
1. Copy the file config.json.example to a new file called config.json. | ||
2. Modify the file and replace with appropriate values for your system. | ||
|
||
``` | ||
{ | ||
"generator": "../your-application/bin", | ||
"baseDIDContext": "../path/to/base/context/did.json" | ||
} | ||
``` | ||
baseDIDContext is the path to the test suite's test/contexts/base.json file. | ||
|
||
### Running the Test Suite | ||
|
||
1. npm install | ||
2. Copy the `config.json.example` file to `config.json` and modify. | ||
3. All that is needed is a path to the binary that runs the tests | ||
4. npm test | ||
|
||
### Submit an Implementation Report | ||
|
||
1. npm install | ||
2. Copy the `config.json.example` file to `config.json` and modify. | ||
3. npm run report | ||
4. Rename implementation/results.json to | ||
implementation/YOUR_IMPLEMENTATION-results.json. | ||
5. git add implementations/YOUR_IMPLEMENTATION-results.json and submit a | ||
pull request for your implementation. | ||
|
||
## Contributing | ||
|
||
You may contribute to this test suite by submitting pull requests here: | ||
|
||
https://github.com/w3c-ccg/did-test-suite | ||
[https://github.com/w3c/did-test-suite](https://github.com/w3c/did-test-suite) |