Clean-up conformance test IDs and ensure labelling with version of FDC3 where introduced

Author: kriswest

toolbox/fdc3-conformance/src/test/advanced/fdc3.context-metadata.ts

@@ -36,7 +36,7 @@ export default async () => {
     // --- User Channel Tests ---
 
     const ucMetadataBroadcast =
-      '(3.0-UCContextMetadataOnBroadcast) Should receive ContextMetadata with source and timestamp when context is broadcast on a user channel';
+      '(UCContextMetadataOnBroadcast) Should receive ContextMetadata with source and timestamp when context is broadcast on a user channel';
     it(ucMetadataBroadcast, async () => {
       const errorMessage = `\r\nSteps:\r\n- App A adds fdc3.instrument context listener\r\n- App A joins channel\r\n- App B joins channel and broadcasts fdc3.instrument${documentation}`;
 
@@ -74,7 +74,7 @@ export default async () => {
     });
 
     const ucMetadataTraceId =
-      '(3.0-UCContextMetadataTraceId) Should receive app-provided traceId in ContextMetadata on user channel broadcast';
+      '(UCContextMetadataTraceId) Should receive app-provided traceId in ContextMetadata on user channel broadcast';
     it(ucMetadataTraceId, async () => {
       const errorMessage = `\r\nSteps:\r\n- App A adds listener\r\n- App B broadcasts with traceId metadata${documentation}`;
 
@@ -113,7 +113,7 @@ export default async () => {
     });
 
     const ucMetadataSignatureCustom =
-      '(3.0-UCContextMetadataSignatureCustom) Should receive app-provided signature and custom fields in ContextMetadata on user channel broadcast';
+      '(UCContextMetadataSignatureCustom) Should receive app-provided signature and custom fields in ContextMetadata on user channel broadcast';
     it(ucMetadataSignatureCustom, async () => {
       const errorMessage = `\r\nSteps:\r\n- App A adds listener\r\n- App B broadcasts with signature and custom metadata${documentation}`;
 
@@ -155,7 +155,7 @@ export default async () => {
     // --- App Channel Tests ---
 
     const acMetadataBroadcast =
-      '(3.0-ACContextMetadataOnBroadcast) Should receive ContextMetadata with source and timestamp when context is broadcast on an app channel';
+      '(ACContextMetadataOnBroadcast) Should receive ContextMetadata with source and timestamp when context is broadcast on an app channel';
     it(acMetadataBroadcast, async () => {
       const errorMessage = `\r\nSteps:\r\n- App A gets app channel and adds listener\r\n- App B gets same channel and broadcasts${documentation}`;
 
@@ -192,7 +192,7 @@ export default async () => {
     // --- getCurrentContextWithMetadata Tests ---
 
     const acGetCurrentContextWithMetadata =
-      '(3.0-ACGetCurrentContextWithMetadata) getCurrentContextWithMetadata should return context and metadata from an app channel';
+      '(ACGetCurrentContextWithMetadata) getCurrentContextWithMetadata should return context and metadata from an app channel';
     it(acGetCurrentContextWithMetadata, async () => {
       const errorMessage = `\r\nSteps:\r\n- App B broadcasts to app channel\r\n- App A calls getCurrentContextWithMetadata${documentation}`;
 
@@ -215,7 +215,7 @@ export default async () => {
     });
 
     const acGetCurrentContextWithMetadataNull =
-      '(3.0-ACGetCurrentContextWithMetadataNull) getCurrentContextWithMetadata should return null on an empty channel';
+      '(ACGetCurrentContextWithMetadataNull) getCurrentContextWithMetadata should return null on an empty channel';
     it(acGetCurrentContextWithMetadataNull, async () => {
       const testChannel = await fdc3.getOrCreateChannel('test-channel-empty-' + cc.getRandomId());
       const result: ContextWithMetadata | null = await testChannel.getCurrentContextWithMetadata('fdc3.instrument');

toolbox/fdc3-conformance/src/test/advanced/fdc3.intent-context-metadata.ts

@@ -16,7 +16,7 @@ export default async () => {
     });
 
     const intentMetadata =
-      '(3.0-IntentContextMetadata) Should receive ContextMetadata with source and timestamp when an intent is raised';
+      '(IntentContextMetadata) Should receive ContextMetadata with source and timestamp when an intent is raised';
     it(intentMetadata, async function () {
       this.timeout(constants.TestTimeout);
 
@@ -46,7 +46,7 @@ export default async () => {
     });
 
     const intentMetadataWithAppMeta =
-      '(3.0-IntentContextMetadataWithAppMetadata) Should forward app-provided traceId, signature and custom in ContextMetadata on raised intent';
+      '(IntentContextMetadataWithAppMetadata) Should forward app-provided traceId, signature and custom in ContextMetadata on raised intent';
     it(intentMetadataWithAppMeta, async function () {
       this.timeout(constants.TestTimeout);
 

website/docs/api/conformance/App-Channel-Tests.md

@@ -18,7 +18,7 @@ hide_title: true
 | B   | 4. Broadcast            | Broadcast an `fdc3.instrument` Context to the channel with: <br />`testChannel.broadcast(<fdc3.instrument>)`|
 | A   | 5. Receive Context      | The handler added in step 2 will receive the instrument context. Ensure that the instrument received by A is identical to that sent by B.  |
 
-- `ACBasicUsage1` Perform above test.
+- `ACBasicUsage1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue) Perform above test.
 
 ## Current Context
 
@@ -29,7 +29,7 @@ hide_title: true
 | A   | 3. Retrieve `Channel`       |Retrieve a `Channel` object representing the same 'App' channel B did (`test-channel`)|
 | A   | 4. Retrieve Current Context | A gets the _current context_ of the user channel. via:  `await testChannel.getCurrentContext()` <br />Ensure that the instrument received by A is identical to that sent by B    |
 
-- `ACBasicUsage2` Perform above test
+- `ACBasicUsage2` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue) Perform above test
 
 ## Filtered Context
 
@@ -41,11 +41,11 @@ hide_title: true
 | B   | 4. Broadcast            | B broadcasts both an `fdc3.instrument` context and an `fdc3.contact` context, using: <br /> `testChannel.broadcast(<fdc3.instrument>)` <br /> `testChannel.broadcast(<fdc3.contact>)`|
 | A   | 5. Receive Context      | An fdc3.instrument context is received by the handler added in step 2.<br />Ensure that the fdc3.instrument received by A is identical to that sent by B<br />Ensure that the fdc3.contact context is NOT received.                                                                   |
 
-- `ACFilteredContext1`: Perform above test.
-- `ACFilteredContext2`: Perform above test, but add listeners for both `fdc3.instrument` and `fdc3.contact` in step2.  Ensure that both context objects are received.
-- `ACFilteredContext3`: Perform above test, except creating a _different_ channel in app B. Check that you _don't_ receive anything (as the channels don't match).
-- `ACFilteredContext4`: Perform above test, except that after creating the channel **A** creates another channel with a further _different_ channel id and adds a further context listener to it.  Ensure that **A** is still able to receive context on the first channel (i.e. it is unaffected by the additional channel) and does NOT receive anything on the second channel.
-- `ACUnsubscribe`: Perform above test, except that after creating the channel **A** then `unsubscribe()`s the listener it added to the channel. Check that **A** does NOT receive anything.
+- `ACFilteredContext1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): Perform above test.
+- `ACFilteredContext2` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): Perform above test, but add listeners for both `fdc3.instrument` and `fdc3.contact` in step2.  Ensure that both context objects are received.
+- `ACFilteredContext3` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): Perform above test, except creating a _different_ channel in app B. Check that you _don't_ receive anything (as the channels don't match).
+- `ACFilteredContext4` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): Perform above test, except that after creating the channel **A** creates another channel with a further _different_ channel id and adds a further context listener to it.  Ensure that **A** is still able to receive context on the first channel (i.e. it is unaffected by the additional channel) and does NOT receive anything on the second channel.
+- `ACUnsubscribe` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): Perform above test, except that after creating the channel **A** then `unsubscribe()`s the listener it added to the channel. Check that **A** does NOT receive anything.
 
 ### App Channel History
 
@@ -57,9 +57,9 @@ hide_title: true
 | A   | 4. Add Context Listener     | A adds a context listener to the channel _after_ B has completed all its broadcasts, via: <br />`await testChannel.addContextListener("fdc3.instrument", handler)` <br /> Ensure that A does NOT receive any context via these listeners (past context is only retrieved via a `getCurrentContext()` call on App channels). |
 | A   | 5. Retrieve Current Context | A is able to retrieve the most recent context of each context type from the `Channel`  via: <br />`const instrument = await testChannel.getCurrentContext("fdc3.instrument")`<br />`const contact = await testChannel.getCurrentContext("fdc3.contact")`<br />Ensure that both contexts retrieved by A are identical to those sent by B|
 
-- `ACContextHistoryTyped`: Perform above test.
-- `ACContextHistoryMultiple`: **B** Broadcasts multiple history items of both types.  Ensure that only the last version of each type is received by **A**.
-- `ACContextHistoryLast`: In step 5. **A** retrieves the _untyped_ current context of the channel via `const currentContext = await testChannel.getCurrentContext()`. Ensure that A receives only the very last broadcast context item _of any type_.
+- `ACContextHistoryTyped` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): Perform above test.
+- `ACContextHistoryMultiple` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): **B** Broadcasts multiple history items of both types.  Ensure that only the last version of each type is received by **A**.
+- `ACContextHistoryLast` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): In step 5. **A** retrieves the _untyped_ current context of the channel via `const currentContext = await testChannel.getCurrentContext()`. Ensure that A receives only the very last broadcast context item _of any type_.
 
 ## Basic Broadcast - Destructured
 
@@ -72,7 +72,7 @@ hide_title: true
 | B   | 5. Destructure & Broadcast | Destructure broadcast method and broadcast context: <br />`const { broadcast } = testChannel`<br />`broadcast(<fdc3.instrument>)`|
 | A   | 6. Receive Context      | The handler added in step 3 will receive the instrument context. Ensure that the instrument received by A is identical to that sent by B.  |
 
-- `ACBasicUsage1-Destructured` Perform above test to verify destructured methods work correctly.
+- `ACBasicUsage1-Destructured` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue) Perform above test to verify destructured methods work correctly.
 
 ## Current Context - Destructured
 
@@ -83,7 +83,7 @@ hide_title: true
 | A   | 3. Retrieve `Channel`       |Retrieve a `Channel` object representing the same 'App' channel B did (`test-channel`)|
 | A   | 4. Destructured & Get Context | Destructure getCurrentContext and retrieve context: <br />`const { getCurrentContext } = testChannel`<br />`await getCurrentContext()` <br />Ensure that the instrument received by A is identical to that sent by B    |
 
-- `ACBasicUsage2-Destructured` Perform above test to verify destructured getCurrentContext works correctly.
+- `ACBasicUsage2-Destructured` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue) Perform above test to verify destructured getCurrentContext works correctly.
 
 ## Clearing Context
 
@@ -98,8 +98,8 @@ hide_title: true
 | B   | 7. Clear Context        | B clears context using `testChannel.clearContext()`|
 | A   | 8. Received Event       | A receives event added in step 6 |
 
-- `ACClearContext1`: Perform above test.
-- `ACClearContext2`: Perform above test, but add specific type of the context type to the `testChannel.clearContext()`.
+- `ACClearContext1` ![3.0+](https://img.shields.io/badge/FDC3-3.0+-purple): Perform above test.
+- `ACClearContext2` ![3.0+](https://img.shields.io/badge/FDC3-3.0+-purple): Perform above test, but add specific type of the context type to the `testChannel.clearContext()`.
 
 
 ## Multiple listeners On The Same Or Overlapping Context types  

website/docs/api/conformance/Basic-Tests.md

@@ -24,13 +24,13 @@ _These are some basic sanity tests implemented in the FDC3 Conformance Framework
 
 ## Basic API Usage
 
-- `BasicCL1`: A context listener can be created for a specific context type by calling `fdc3.addContextListener("fdc3.contact",<handler>)`.  A `Listener` object is returned and can be used to remove the listener again by calling its `unsubscribe` function.
-- `BasicCL2`: An **unfiltered** context listener can be created by calling `fdc3.addContextListener(null,<handler>)`.  A `Listener` object is returned and can be used to remove the listener again by calling its `unsubscribe` function.
-- `BasicIL1`: An intent listener can be created for a specific intent by calling `fdc3.addIntentListener(<intentName>,<handler>)`. A `Listener` object is returned and can be used to remove the listener again by calling its `unsubscribe` function.
-- `BasicGI1`: An `ImplementationMetadata` object can be retrieved, to find out the version of FDC3 that is in use along with details of the provider, by calling:
+- `BasicCL1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): A context listener can be created for a specific context type by calling `fdc3.addContextListener("fdc3.contact",<handler>)`.  A `Listener` object is returned and can be used to remove the listener again by calling its `unsubscribe` function.
+- `BasicCL2` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): An **unfiltered** context listener can be created by calling `fdc3.addContextListener(null,<handler>)`.  A `Listener` object is returned and can be used to remove the listener again by calling its `unsubscribe` function.
+- `BasicIL1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): An intent listener can be created for a specific intent by calling `fdc3.addIntentListener(<intentName>,<handler>)`. A `Listener` object is returned and can be used to remove the listener again by calling its `unsubscribe` function.
+- `BasicGI1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): An `ImplementationMetadata` object can be retrieved, to find out the version of FDC3 that is in use along with details of the provider, by calling:
   - `await fdc3.getInfo()`. The FDC3 version should match the API version being tested for conformance.
-- `BasicAC1`: A named 'App' channel can be retrieved by calling `fdc3.getOrCreateChannel(<name>)`. The `Channel` object returned conforms to the defined interface.
-- `BasicUC1`: The list available user/system channels can be retrieved, as an array of `Channel` Objects conforming to the defined interface, by calling `await fdc3.getUserChannels()`.
-- `BasicJC1`: A user/system channel can be joined with the with the channel's id by calling `fdc3.joinUserChannel(<channelId>)`.  Having done so, the current channel, retrieved by calling `fdc3.getCurrentChannel()` should NOT be null and should match _the channel id given_.  After leaving the current channel by calling `fdc3.leaveCurrentChannel()`, it should go back to being `null`.
-- `BasicRI1`: A specified intent can be raised by invoking `fdc3.raiseIntent(<intent name>, <context>)`. A promise should be returned.
-- `BasicRI2`: An intent can be raised for some item of context by invoking: `fdc3.raiseIntentForContext(<context>)`. A promise should be returned.
+- `BasicAC1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): A named 'App' channel can be retrieved by calling `fdc3.getOrCreateChannel(<name>)`. The `Channel` object returned conforms to the defined interface.
+- `BasicUC1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): The list available user/system channels can be retrieved, as an array of `Channel` Objects conforming to the defined interface, by calling `await fdc3.getUserChannels()`.
+- `BasicJC1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): A user/system channel can be joined with the with the channel's id by calling `fdc3.joinUserChannel(<channelId>)`.  Having done so, the current channel, retrieved by calling `fdc3.getCurrentChannel()` should NOT be null and should match _the channel id given_.  After leaving the current channel by calling `fdc3.leaveCurrentChannel()`, it should go back to being `null`.
+- `BasicRI1` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): A specified intent can be raised by invoking `fdc3.raiseIntent(<intent name>, <context>)`. A promise should be returned.
+- `BasicRI2` ![2.0+](https://img.shields.io/badge/FDC3-2.0+-blue): An intent can be raised for some item of context by invoking: `fdc3.raiseIntentForContext(<context>)`. A promise should be returned.