Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename .vcApiTestImplementationsConfig.cjs to .localImplementationsConfig.cjs. #98

Merged
merged 3 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# vc-test-suite-implementations Changelog

## 3.0.0 - 2024-01-02

### Changed
- **BREAKING**: Rename `.vcApiTestImplementationsConfig.cjs` config for testing
localhost implementations to `.localImplementationsConfig.cjs`.

## 2.1.0 - 2023-12-18

### Removed
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,13 @@ If you need to test implementations for endpoints running locally, create a
config file in the root dir of the test suite:

```
.vcApiTestImplementationsConfig.cjs
.localImplementationsConfig.cjs
```

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

```js
// file .vcApiTestImplementationsConfig.cjs
// file .localImplementationsConfig.cjs
module.exports = [{
"name": "My Company",
"implementation": "My Implementation Name",
Expand All @@ -128,7 +128,7 @@ module.exports = [{
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
For instance, if your `.localImplementationsConfig.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
Expand Down
2 changes: 1 addition & 1 deletion implementations/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const dir = requireDir('./');
const getLocalImplementations = () => {
try {
const path = join(
appRoot.toString(), '.vcApiTestImplementationsConfig.cjs');
appRoot.toString(), '.localImplementationsConfig.cjs');
return require(path);
} catch(e) {
if(e?.code === 'MODULE_NOT_FOUND') {
Expand Down