Skip to content

Commit 049fc3f

Browse files
committed
Add Test Suite Settings section to README.
1 parent 64fd9a6 commit 049fc3f

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

+38
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Verifiable Credentials test suites (see [Tags](#tags) for the full list).
2020
- [Usage](#usage)
2121
- [Adding a new implementation](#adding-a-new-implementation)
2222
- [Testing locally](#testing-locally)
23+
- [Test Suite Settings](#test-suite-settings)
2324
- [Tags](#tags)
2425
- [Contribute](#contribute)
2526
- [License](#license)
@@ -139,6 +140,43 @@ module.exports = {
139140

140141
After adding the config file, only implementations in `localConfig.cjs` will run.
141142

143+
### Test Suite Settings
144+
145+
Additional test suite runtime configuration can be done via the `settings` key
146+
in a `localConfig.cjs`. The current global settings are:
147+
148+
* `enableInteropTests` - enable/disable the cross-implementation "interop" tests
149+
* `testAllImplementations` - enable/disable testing _all_ implementations (not
150+
just what's in `localConfig.cjs`)
151+
152+
Both of these settings are `false` when `localConfig.cjs` is present, but may be
153+
overridden as below:
154+
155+
```js
156+
module.exports = {
157+
"settings": {
158+
// overriding the default, false, for local testing
159+
"enableInteropTests": true,
160+
"testAllImplementations": true
161+
},
162+
"implementations": [{
163+
"name": "My Company",
164+
"implementation": "My Implementation Name",
165+
"issuers": [{
166+
"id": "urn:uuid:my:implementation:issuer:id",
167+
"endpoint": "https://localhost:40443/issuers/foo/credentials/issue",
168+
"tags": ["eddsa-rdfc-2022"]
169+
}],
170+
"verifiers": [{
171+
"id": "https://localhost:40443/verifiers/z19uokPn3b1Z4XDbQSHo7VhFR",
172+
"endpoint": "https://localhost:40443/verifiers/z19uokPn3b1Z4XDbQSHo7VhFR/credentials/verify",
173+
"tags": ["eddsa-rdfc-2022"]
174+
}]
175+
}, {
176+
// Add additional implementations as needed
177+
}];
178+
```
179+
142180
### Tags
143181
144182
Tags tell the test suites which implementations' endpoints to run the test suites against.

0 commit comments

Comments
 (0)