Skip to content

Commit

Permalink
Update Testing locally section.
Browse files Browse the repository at this point in the history
  • Loading branch information
JSAssassin committed Dec 12, 2023
1 parent 4ba018c commit 03fc824
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,14 @@ section in that case).

### Testing locally

If you need to test implementations for endpoints running locally you may add a
If you need to test implementations for endpoints running locally, create a
config file in the root dir of the test suite:

```
.vcApiTestImplementationsConfig.cjs
```

That file must be a common js module that exports an array of implementations:
This file must be a CommonJS module that exports an array of implementations:

```js
// file .vcApiTestImplementationsConfig.cjs
Expand All @@ -125,8 +125,14 @@ module.exports = [{
}];
```

Then update the test suite to filter the implementations with the tag you've
specified in your config file and run the tests.
To run the tests only against the localhost implementation, update the test
suite to filter implementations using the specified tag in your config file.

For instance, if your `.vcApiTestImplementationsConfig.cjs` looks like above
in the `vc-api-issuer-test-suite`, you can adjust the
[tag](https://github.com/w3c-ccg/vc-api-issuer-test-suite/blob/main/tests/10-issuer.js#L14)
to filter the implementation by `localhost` rather than `vc-api` and
then run the tests.

### Opting into a Test Suite

Expand Down

0 comments on commit 03fc824

Please sign in to comment.