Skip to content

Commit

Permalink
Rename vc-api-test-suite-implementations to
Browse files Browse the repository at this point in the history
`vc-test-suite-implementations` and update `README.md`.
  • Loading branch information
JSAssassin committed Dec 14, 2023
1 parent 2a8eaca commit 6eef074
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 6 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# vc-api-issuer-test-suite

Test Suite for Issuers that implement the VC HTTP API

## Table of Contents
Expand Down Expand Up @@ -27,6 +28,12 @@ npm test


## Implementation
To add your implementation to this test suite see the [README here.](https://github.com/w3c-ccg/vc-api-test-suite-implementations)
Add the tag `vc-api` to the issuers and verifiers you want tested. To run the tests, some implementations require client secrets
that can be passed as env variables to the test script. To see which ones require client secrets, you can check the [vc-api-test-suite-implementations](https://github.com/w3c-ccg/vc-api-test-suite-implementations) library.

To add your implementation to this test suite see the
`w3c-ccg/vc-test-suite-implementations` [README](https://github.com/w3c-ccg/vc-test-suite-implementations/blob/main/README.md). Add the tag `vc-api` to the issuers you want
to run the tests against.

Note: To run the tests, some implementations require client secrets that can be
passed as env variables to the test script. To see which ones require client
secrets, you can check configs in the `w3c-ccg/vc-test-suite-implementations`
repo.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"klona": "^2.0.5",
"mocha": "^10.0.0",
"uuid": "^8.3.2",
"vc-api-test-suite-implementations": "github:w3c-ccg/vc-api-test-suite-implementations"
"vc-test-suite-implementations": "github:w3c-ccg/vc-test-suite-implementations#rename-package"
},
"devDependencies": {
"eslint": "^8.54.0",
Expand Down
2 changes: 1 addition & 1 deletion tests/10-issuer.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
shouldThrowInvalidInput
} from './assertions.js';
import chai from 'chai';
import {filterByTag} from 'vc-api-test-suite-implementations';
import {filterByTag} from 'vc-test-suite-implementations';

const should = chai.should();
const tag = 'vc-api';
Expand Down
2 changes: 1 addition & 1 deletion tests/11-issuer-jwt.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import {shouldBeIssuedVc, shouldThrowInvalidInput} from './assertions.js';
import chai from 'chai';
import {createRequestBody} from './mock.data.js';
import {filterByTag} from 'vc-api-test-suite-implementations';
import {filterByTag} from 'vc-test-suite-implementations';

const should = chai.should();

Expand Down

0 comments on commit 6eef074

Please sign in to comment.