From ba5a93ec1824906e54887b956c57d19017fa4e7f Mon Sep 17 00:00:00 2001 From: Tashi D Gyeltshen Date: Wed, 27 Dec 2023 16:50:57 -0500 Subject: [PATCH] Rename `vcApiTestImplementationsConfig.cjs` to `localImplementationsConfig.cjs`. --- CHANGELOG.md | 6 ++++++ README.md | 6 +++--- implementations/index.js | 2 +- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 143694c..37f17cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # vc-test-suite-implementations Changelog +## 3.0.0 - 2023-12-27 + +### Changed +- **BREAKING**: Rename `vcApiTestImplementationsConfig.cjs` config for testing + localhost implementations to `localImplementationsConfig.cjs`. + ## 2.1.0 - 2023-12-18 ### Removed diff --git a/README.md b/README.md index d0a9ae6..260d63d 100644 --- a/README.md +++ b/README.md @@ -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", @@ -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 diff --git a/implementations/index.js b/implementations/index.js index f685657..d2be7e7 100644 --- a/implementations/index.js +++ b/implementations/index.js @@ -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') {