FDC3 Conformance Framework

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

This project currently targets FDC3 v1.2.

Installation

This repository currently contains:

• tests - the FDC3 conformance tests, implemented using Mocha / TypeScript, making use of the FDC3 type definitions, @finos/fdc3.
• app - A React application that hosts the tests, allowing them to be executed from within a desktop container.
• cli - Documentation and an example that demosntrates how these tests can be run within a CI environment.

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

yarn

Then build all the components with:

yarn build

The server can be started as follows:

cd app
yarn start

The application will start and will open a webbrowser tab, this tab will have an error. The reason is that the app does not have a Window.FDC3 object and should be ran through the desktop agent.

Here is the setup steps for the following desktop agents:

Finsemble setup

Clone and setup the Finsemble seed project with:

git clone https://github.com/ChartIQ/finsemble-seed.git
cd finsemble-seed
yarn install

After the installation, add the following entry into /public/configs/application/appd.json under appd:

"Conformance": {
    "appId": "Conformance",
    "name": "FDC3 Conformance Framework",
    "description": "Testing spec conformance",
    "manifest": {
        "window": {
            "url": "http://localhost:3000",
            "affinity": "workspaceComponents",
            "options": {
                "resizable": true,
                "autoShow": true,
                "alwaysOnTop": false,
                "addToWorkspace": true
            },
            "top": "center",
            "left": "center",
            "width": 800,
            "height": 600
        },
        "component": {
            "displayName": "FDC3 Conformance Framework",
            "preload": "$applicationRoot/preloads/zoom.js"
        },
        "foreign": {
            "services": {
                "windowService": {
                    "allowSnapping": true,
                    "allowGrouping": true,
                    "allowTabbing": true,
                    "allowAutoArrange": true,
                    "allowMinimize": true
                }
            },
            "components": {
                "App Launcher": {
                    "launchableByUser": true
                },
                "Window Manager": {
                    "alwaysOnTopIcon": false,
                    "FSBLHeader": {
                        "hideMaximize": false
                    },
                    "persistWindowState": true,
                    "title": "FDC3 Conformance Framework"
                }
            }
        }
    },
    "version": "1.0.0",
    "publisher": "Scott Logic",
    "icons": [
        {
            "src": "http://localhost:3000/scott-logic-icon-256.png"
        }
    ]
}

The desktop agent can be started with:

yarn start

The testing framework can be found under the Apps menu.

Openfin setup

Ensure you have the OpenFin Runtime cli tool installed, that can be done with: npm install -g openfin-cli.

Once the Testing Framework server has been started, it can be opened with:

openfin --launch --config http://localhost:3000/openfin_app.json.

Contributing

1. Fork this repository
2. Create your feature branch (git checkout -b feature/fooBar)
3. Read our contribution guidelines and Community Code of Conduct
4. Commit your changes (git commit -am 'Add some fooBar')
5. Push to the branch (git push origin feature/fooBar)
6. Create a new Pull Request

NOTE: Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

Need an ICLA? Unsure if you are covered under an existing CCLA? Email [email protected]

License

Copyright 2022 FINOS

Distributed under the Apache License, Version 2.0.

SPDX-License-Identifier: Apache-2.0