https://github.com/finos/fdc3-conformance-framework
A framework for testing whether desktop containers implement the FDC3 standard
https://github.com/finos/fdc3-conformance-framework
fdc3 finos
Last synced: 6 months ago
JSON representation
A framework for testing whether desktop containers implement the FDC3 standard
- Host: GitHub
- URL: https://github.com/finos/fdc3-conformance-framework
- Owner: finos
- License: apache-2.0
- Created: 2022-05-09T09:28:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-20T13:40:34.000Z (about 1 year ago)
- Last Synced: 2024-12-20T14:42:35.842Z (about 1 year ago)
- Topics: fdc3, finos
- Language: TypeScript
- Homepage:
- Size: 10.3 MB
- Stars: 14
- Watchers: 13
- Forks: 15
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
[](https://bestpractices.coreinfrastructure.org/projects/6456)
# FDC3 Conformance Framework
A framework for testing whether desktop containers implement the [FDC3 standard](https://fdc3.finos.org/).
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](https://github.com/finos/FDC3/blob/master/toolbox/fdc3-conformance/README.md) for further details.
Tests are currently implemented for version [1.2](https://fdc3.finos.org/docs/1.2/fdc3-intro) and [2.0](https://fdc3.finos.org/docs/fdc3-intro) 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](https://fdc3.finos.org/docs/app-directory/spec), you can point it at [The FINOS App Directory](https://directory.fdc3.finos.org) 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
1. **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](https://www.npmjs.com/package/@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](terms-conditions/FDC3-Certified-Terms.md) of the Conformance Program. Instructions for joining the program are [here](Instructions.md)
2. **Install Dependencies**
In order to get started, install all the dependencies with:
```sh
npm install
```
3. **Run The Apps Locally**
To run the conformance suite locally on port 3001:
```sh
npm run start
```
4. **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](instructions.md)
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](https://fdc3.finos.org/community). Please check there to find out who FINOS has certified!
[Read the latest blog post here about the certification announcements at OSFF New York](https://www.finos.org/blog/first-fdc3-1.2-certified-desktop-agents)
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) page.
## License
Copyright 2022 FINOS
Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)