Incorrect test definitions

FDC3 Conformance Framework

A framework for testing whether desktop containers implement the FDC3 standard.

The tests implemented for each FDC3 version are based on the FDC3 Conformance tests specifications defined by the FDC3 maintainers and provided in the main FDC3 repository. Please see the README file in that repository for further details.

Tests are currently implemented for version 1.2 and 2.0 of the FDC3 Standard.

What Is It?

There are many vendors implementing Desktop Agents for the FDC3 standard.
Developers building apps interoperating with the FDC3 standard want to be sure that their apps will work with every Desktop Agent.
This suite of conformance tests allows for programmatic verification of an FDC3 Desktop Agent implementation.

Why Is This Important?

✔️ Multiple Platforms

It can be annoying for users to find that features in their apps that they rely on don't work when changing between Desktop Agents. Hopefully these conformance tests will add security around that.

✔️ Marketing

FINOS has created badges to indicate conformance with the FDC3 standard. By passing the conformance tests and joining the conformance program, firms are able to use those badges in their own marketing materials.

✔️ Backwards Compatibility

There are multiple versions of the FDC3 standard. A Desktop Agent could host apps written in any one of these versions. For that reason, it's important that Desktop Agents are tested to make sure that they keep on supporting apps written against older versions of FDC3.

How Does It Work?

There are two main parts to conformance:

Running the tests locally, then
Joining the Conformance Program

Running The Conformance Tests

You can either run the hosted conformance tests listed in the FINOS App Directory, or run them on your local machine (useful if you are making changes). Instructions for doing either of those things are here:

Using The FINOS App Directory

If you have a Desktop Agent supporting the AppD v2 standard, you can point it at The FINOS App Directory which contains not only the current conformance suite but also many other sample FDC3 applications. The endpoint for your agent is:

https://directory.fdc3.finos.org/v2/apps

Local Installation

Check Out The Repo

This repository currently contains:

tests - the FDC3 conformance tests, implemented using Mocha / TypeScript, making use of the FDC3 type definitions, @finos/fdc3.
static - HTML files used to create the static server
directory - Some JSON files in the FDC3 V2 Directory format that you can use to set up your desktop agent with either 1.2 or 2.0 test suites.
terms-conditions - Terms and Conditions of the Conformance Program. Instructions for joining the program are here

Install Dependencies

In order to get started, install all the dependencies with:

npm install

Run The Apps Locally

To run the conformance suite locally on port 3001:

npm run start

Set Up Your Desktop Agent

You will need to set up your desktop agent so that it has an App Directory containing all the conformance apps.
This step is vendor-dependent, but examples of AppD records can be found in the directory folder.

Running The Tests

Once you have configured your desktop agent correctly, open the conformance app and select the tests you wish to run:

The tests run and produce an output in the window. Failure are shown with a stack trace in red:

Successful runs look something like this:

Joining The Conformance Program

If you've had a clean run of all the tests locally, why not join the conformance program?

Instructions to join the Certified FDC3 Desktop Agent Conformance Program

Once you have followed these steps, you will be allowed to display the FDC3 Compliance Badges within your marketing literature.

Who Is Conformant?

We publish the details of conformant desktop agents on the FDC3 Community Page. Please check there to find out who FINOS has certified!

Read the latest blog post here about the certification announcements at OSFF New York

Contributing

Please see CONTRIBUTING page.

License

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0

	//App B joins the same app channel as A then broadcasts context
	await window.fdc3.open("ChannelsApp", channelsAppContext);

	//get contexts from app B
	const context = await testChannel.getCurrentContext("fdc3.instrument");

	expect(context.type).to.be.equals("fdc3.instrument", errorMessage);
	expect(context.name).to.be.equals("History-item-2", errorMessage);
	});

App	Required Metadata
A	A’s AppD Record contains: `aTestingIntent` (with context type `testContextX`, `testContextZ`) and `sharedTestingIntent1` (with context type `testContextX`)
B	B’s AppD Record contains `bTestingIntent` (with context type `testContextY`) and `sharedTestingIntent1` (with context types `testContextX` and `testContextY`)
C	C’s AppD Record contains `cTestingIntent` (with context type `testContextX`)

App	Step	Details
D	Raise	`fdc3.raiseIntent(‘sharedTestingIntent1’, {testContextY})` starts app B.
B	Gather Context	`fdc.addIntentListener(‘sharedTestingIntent1’)` Receives testContextY, matching that sent by D

	it("Should receive context when app B broadcasts context to an app channel before A joins and listens on the same channel", async () => {
	const errorMessage = `\r\nSteps to reproduce:\r\n- App B joins an app channel\r\n- App B broadcasts context of type fdc3.instrument\r\n- App A joins the same app channel as B\r\n- App A adds a context listener of type null${documentation}`;

	return new Promise(async (resolve, reject) => {
	channelsAppContext.useAppChannel = true;

	//App B creates/joins an app channel then broadcasts context
	await window.fdc3.open("ChannelsApp", channelsAppContext);

	//give app B time to fully execute
	await wait();

	//Add context listener to app A
	listener = await testChannel.addContextListener(null, (context) => {
	expect(context.type).to.be.equals("fdc3.instrument", errorMessage);
	resolve();
	});

	validateListenerObject(listener);

	//if no context received throw error
	await wait();

App	Step	Details
A	joinChannel	`fdc3.getOrCreateChannel("test-channel")`
A	addContextListener	Call `testChannel.addContextListener(null, handler)` Check listener object returned Check that there is an `unsubscribe` function on the returned object
B	joinChannel	`fdc3. getOrCreateChannel("test-channel")`
B	Broadcast	`testChannel.broadcast(<some instrument>)`
A	Receive Context	Instrument object matches the one broadcast in 2 above.

App	Step	Details
A	addContextListener	Call `fdc3.addContextListener(null, handler)` Check listener object returned Check that there is an `unsubscribe` function on the returned object
A	joinChannel	`fdc3.getSystemChannels()` Check channels are returned. Call `fdc3.joinChannel()` on first non-global channel
B	joinChannel	`fdc3.getSystemChannels()` Check channels are returned. Call `fdc3.joinChannel()` on first non-global channel
B	Broadcast	`fdc3.broadcast(<some instrument>)`
A	Receive Context	Instrument object matches the one broadcast in 2 above.

App	Step	Details
A	addContextListener	Call `fdc3.addContextListener("fdc3.instrument", handler)` Check listener object returned Check that there is an `unsubscribe` function on the returned object
A	joinChannel	`fdc3.getSystemChannels()` Check channels are returned. Call `fdc3.joinChannel()` on first non-global channel
B	joinChannel	`fdc3.getSystemChannels()` Check channels are returned. Call `fdc3.joinChannel()` on first non-global channel
B	Broadcast	`fdc3.broadcast()` the instrument context. `fdc3.broadcast()` a contact context.
A	Receive Context	Instrument object matches the one broadcast in 2 above. Check that the contact is not received.

App	Step	Details
A	addContextListener	Call `addContextListener (“fdc3.instrument”, handler)` Check listener object returned Check that there is an unsubscribe function on the returned object Call `addContextListener (“fdc3.contact”, handler)` Check listener object returned Check that there is an unsubscribe function on the returned object
A	joinChannel	Check that there is an unsubscribe function on the returned object
B	joinChannel	`fdc3.getSystemChannels()` Check channels are returned. Call `fdc3.joinChannel()` on first non-global channel
B	Broadcast	`fdc3.broadcast()` the instrument context. `fdc3.broadcast()` a contact context.
A	Receive Context	Instrument object matches the one broadcast in 2 above. Contact object matches the one broadcast in 2 above.

	const broadcastSystemChannelCloseWindow = async () => {
	await window.fdc3.broadcast({ type: "closeWindow" });
	return new Promise<void>((resolve) => setTimeout(() => resolve(), 3000)); // Wait until close window event is handled
	};

	listener = await window.fdc3.addContextListener(null, (context) => {
	expect(context.type).to.be.equal("fdc3.instrument", errorMessage);
	resolve();
	});

App	Step	Description
A	Opening App	various open methods as in `AOpensB1` except with a `<context>` argument check app opens
B	Context present	`fdc3.addContextListener()` - receives `<context>` from A

App	Step	Description
A	Opening App	`fdc3.open(‘app Name’, <contact context>)` check app opens
B	Context present	fdc3.addContextListener() - receives from a
A	Promise	- receives a rejection from the open promise with “App Timeout’ from https://fdc3.finos.org/docs/api/ref/Errors#openerror

finos / fdc3-conformance-framework Goto Github PK

fdc3-conformance-framework's Introduction

FDC3 Conformance Framework

What Is It?

Why Is This Important?

How Does It Work?

Running The Conformance Tests

Using The FINOS App Directory

Local Installation

Running The Tests

Joining The Conformance Program

Who Is Conformant?

Contributing

License

fdc3-conformance-framework's People

Contributors

Stargazers

Watchers

Forkers

fdc3-conformance-framework's Issues

Incorrectly defined tests

1)

2)

3)

4)

5)

6)

CVE-2022-29078 - High Severity Vulnerability

CVE-2020-28469 - High Severity Vulnerability

CVE-2021-33587 - High Severity Vulnerability

CVE-2022-24772 - High Severity Vulnerability

Setup

Find Intent From AppD

Find Intents By Context

Raise Intent

CVE-2021-33502 - High Severity Vulnerability

1) Getting started

2) Multiple app servers

3) Some tests are hard to grok

4) Wait times and total runtime.

5) Window closing

CVE-2022-24771 - High Severity Vulnerability

CVE-2021-3803 - High Severity Vulnerability

App Channels Broadcast (Basic)

App Channels Broadcast (Filtered Context)

App Channel History

User Channels Broadcast (Basic)

User Channels Broadcast (Filtered Context)

WS-2022-0008 - Medium Severity Vulnerability

WS-2021-0153 - High Severity Vulnerability

CVE-2022-24773 - Medium Severity Vulnerability

1) Add a clear indication that tests are complete.

2) Add an easy way to re-run the tests.

3) Refine or replace the test selection menu to work with Mocha's built-in grep functionality.

CVE-2021-23364 - Medium Severity Vulnerability

CVE-2021-23436 - High Severity Vulnerability

CVE-2021-3757 - High Severity Vulnerability

CVE-2021-23424 - High Severity Vulnerability

CVE-2022-0122 - Medium Severity Vulnerability

A Opens B

A Fails To Open B

A Opens B With Context

Specific Context

Recommend Projects

Recommend Topics

Recommend Org