-## Background
-This project represents a means to confirm conformance of a [desktop agent](https://fdc3.finos.org/docs/api/ref/DesktopAgent) to the [fdc3 api specification](https://fdc3.finos.org/docs/api/spec). See [here](https://fdc3.finos.org/docs/fdc3-compliance) for more information about conformance.
+# FDC3 Conformance
+This project represents a means to confirm conformance of a [desktop agent](https://fdc3.finos.org/docs/api/ref/DesktopAgent) to the [fdc3 api specification](https://fdc3.finos.org/docs/api/spec).
To do so this application can be launched within the desktop agent which will run a series of tests to verify conformance against the specification.
@@ -23,12 +23,36 @@ yarn build
`yarn start`
-4. Add the URL http://localhost:8080 to your FDC3-enabled container or desktop agent and ensure it has access to the `window.fdc3` object.
+4. Add the URL http://localhost:3000 to your FDC3-enabled container or desktop agent and ensure it has access to the `window.fdc3` object.
Alternatively, a full set of static files are available in the `build` folder. Load the index.html file into an environment that has the `window.fdc3` object available.
-5. Upon loading the application's index.html, the tests will detect FDC3 and run automatically.
-
## Application Definition
A basic FDC3 application definition, as defined in the [application directory specification](https://fdc3.finos.org/schemas/1.2/app-directory#tag/Application), is supplied in the [file](./src/appDefinition.json) `appDefinition.json`. This may be useful when adding the conformance tests to an application directory. This file may need to be updated with additional manifest information, depending on the desktop agent. Consult the host environment documentation for information on configuring new applications.
+
+## Integration with automated testing
+
+The test suite can be run independently without interaction - for example as part of a CI build, or from the command line. See TypeScript and JavaScript examples [here](./testRunner/examples/). The test runner can be used as a module to run the compliance test suite.
+Perform the following steps to include the module in your code:
+- Import the fdc3-compliance module: ```yarn add [path to testRunner folder]```
+- Import/require the ```fdc3-compliance``` module in your code
+- Call the ```runSilentTests``` function, passing in the fdc3 implementation to be tested
+
+Example:
+```javascript
+const { runSilentTests } = require("fdc3-compliance");
+
+// Pass in the fdc3 global object to be tested
+// Results are returned via callback
+runSilentTests(fdc3, (results) => {
+ // results.stats contains the summary results
+ // For more details, see the passed and failed arrays
+ console.log(results.stats);
+});
+```
+
+The included example code can be run with the following command line:
+```bash
+node testRunner/examples/ci-test.js
+```
diff --git a/toolbox/fdc3-compliance/appDefinition.json b/toolbox/fdc3-compliance/appDefinition.json
new file mode 100644
index 000000000..b897781ca
--- /dev/null
+++ b/toolbox/fdc3-compliance/appDefinition.json
@@ -0,0 +1,29 @@
+{
+ "appId": "fdc3-compliance",
+ "name": "FDC3 Compliance",
+ "manifest": "{\"url\":\"http://localhost:3000\"}",
+ "manifestType": "web",
+ "version": "1.2",
+ "title": "FDC3 Compliance",
+ "tooltip": "FDC3 Compliance Test",
+ "description": "FDC3 Compliance Test",
+ "images": [
+ {
+ "url": "https://fdc3.finos.org/img/fdc3-logo-2019.png"
+ }
+ ],
+ "publisher": "FINOS",
+ "icons": [
+ {
+ "icon": "https://fdc3.finos.org/img/fdc3-logo-2019.png"
+ }
+ ],
+ "intents": [
+ {
+ "name": "fdc3.conformanceListener",
+ "displayName": "FDC3 Conformance",
+ "contexts": ["fdc3.contact"],
+ "customConfig": {}
+ }
+ ]
+}
diff --git a/toolbox/fdc3-compliance/package.json b/toolbox/fdc3-compliance/package.json
index 33e1b8eaa..57a51e419 100644
--- a/toolbox/fdc3-compliance/package.json
+++ b/toolbox/fdc3-compliance/package.json
@@ -1,46 +1,82 @@
{
"name": "fdc3-compliance",
- "version": "1.2.0",
- "description": "FDC3 Compliance Testing",
- "main": "index.js",
+ "version": "1.0.0",
+ "private": true,
+ "homepage": ".",
+ "dependencies": {
+ "@apidevtools/json-schema-ref-parser": "^9.0.9",
+ "@emotion/react": "^11.8.2",
+ "@emotion/styled": "^11.8.1",
+ "@finos/fdc3": "^1.2.0",
+ "@fontsource/roboto": "^4.4.5",
+ "@fontsource/source-code-pro": "^4.5.0",
+ "@mui/icons-material": "^5.5.1",
+ "@mui/lab": "^5.0.0-alpha.74",
+ "@mui/material": "^5.5.1",
+ "@types/node": "^17.0.21",
+ "@types/react": "^17.0.0",
+ "@types/react-dom": "^17.0.0",
+ "fdc3-compliance": "./testRunner/",
+ "jsoneditor": "^9.5.6",
+ "mobx": "^6.3.2",
+ "mobx-react": "^7.2.0",
+ "nanoid": "^3.1.31",
+ "normalize.css": "^8.0.1",
+ "react": "^17.0.2",
+ "react-dom": "^17.0.2",
+ "react-scripts": "4.0.3",
+ "typescript": "^4.1.2",
+ "web-vitals": "^1.0.1"
+ },
"scripts": {
- "build": "yarn run build:prettier && yarn run build:webpack && yarn run build:copy",
- "build:copy": "npx copyfiles --exclude **/*.ts --exclude src/index.html --flat src/*.* build/",
- "build:prettier": "prettier --write ./src/**/*.ts",
- "build:webpack": "webpack build",
- "start": "live-server build",
- "test": "test"
+ "start": "react-scripts start",
+ "build:app": "react-scripts build",
+ "build:lib": "cd testRunner && yarn install && yarn build",
+ "build": "yarn build:lib && yarn install && yarn build:app",
+ "test": "react-scripts test",
+ "eject": "react-scripts eject",
+ "lint": "eslint --cache --quiet **/*.{ts,tsx,js,jsx} && prettier --check **/*.{ts,tsx,js,jsx,json,yml,css,html,md}",
+ "lint:fix": "eslint --cache --quiet --fix **/*.{ts,tsx,js,jsx} && prettier --write **/*.{ts,tsx,js,jsx} && prettier --write **/*.{json,yml,css,html,md}"
},
- "repository": {
- "type": "git",
- "url": "git+https://github.com/finos/FDC3.git"
+ "eslintConfig": {
+ "extends": [
+ "react-app"
+ ]
},
- "author": "",
- "license": "Apache-2.0",
- "bugs": {
- "url": "https://github.com/finos/FDC3/issues"
+ "browserslist": {
+ "production": [
+ ">0.2%",
+ "not dead",
+ "not op_mini all"
+ ],
+ "development": [
+ "last 1 chrome version",
+ "last 1 firefox version",
+ "last 1 safari version"
+ ]
},
- "homepage": "https://github.com/finos/FDC3/toolbox/fdc3-compliance#readme",
- "dependencies": {
- "@finos/fdc3": "^1.2.0",
- "buffer": "^6.0.3",
+ "devDependencies": {
+ "@types/jsoneditor": "^8.6.1",
+ "@types/mocha": "^9.1.0",
+ "@typescript-eslint/eslint-plugin": "^4.27.0",
+ "@typescript-eslint/parser": "^4.27.0",
"chai": "^4.3.6",
- "html-webpack-plugin": "^5.5.0",
+ "eslint": "^7.28.0",
+ "eslint-config-prettier": "^8.3.0",
+ "eslint-plugin-import": "^2.23.4",
+ "eslint-plugin-react": "^7.24.0",
+ "lint-staged": "^11.0.0",
"mocha": "^9.2.1",
- "process": "^0.11.10",
- "stream-browserify": "^3.0.0",
- "util": "^0.12.4"
+ "prettier": "^2.3.1",
+ "pretty-quick": "^3.1.0"
},
- "devDependencies": {
- "@types/chai": "^4.3.0",
- "@types/mocha": "^9.1.0",
- "css-loader": "^6.6.0",
- "express": "^4.17.3",
- "live-server": "^1.2.1",
- "prettier": "^2.5.1",
- "ts-loader": "^9.2.7",
- "typescript": "^4.6.2",
- "webpack": "^5.69.1",
- "webpack-cli": "^4.9.2"
+ "lint-staged": {
+ "*.{ts,tsx,js,jsx}": [
+ "eslint --cache --quiet --fix",
+ "prettier --write --prose-wrap never"
+ ],
+ "*.{json,yml,css,html,md}": "prettier --write --prose-wrap never",
+ "*.js": "eslint --cache --fix",
+ "*.{js,css,md}": "prettier --write"
}
}
diff --git a/toolbox/fdc3-compliance/public/favicon.ico b/toolbox/fdc3-compliance/public/favicon.ico
new file mode 100644
index 000000000..755eb4146
Binary files /dev/null and b/toolbox/fdc3-compliance/public/favicon.ico differ
diff --git a/toolbox/fdc3-compliance/public/fdc3-icon-192.png b/toolbox/fdc3-compliance/public/fdc3-icon-192.png
new file mode 100644
index 000000000..8b7813e61
Binary files /dev/null and b/toolbox/fdc3-compliance/public/fdc3-icon-192.png differ
diff --git a/toolbox/fdc3-compliance/public/fdc3-icon-256.png b/toolbox/fdc3-compliance/public/fdc3-icon-256.png
new file mode 100644
index 000000000..6b72d2743
Binary files /dev/null and b/toolbox/fdc3-compliance/public/fdc3-icon-256.png differ
diff --git a/toolbox/fdc3-compliance/public/fdc3-logo.svg b/toolbox/fdc3-compliance/public/fdc3-logo.svg
new file mode 100644
index 000000000..7ad047fe9
--- /dev/null
+++ b/toolbox/fdc3-compliance/public/fdc3-logo.svg
@@ -0,0 +1,41 @@
+
+
+
diff --git a/toolbox/fdc3-compliance/public/index.html b/toolbox/fdc3-compliance/public/index.html
new file mode 100644
index 000000000..3f50aeb4e
--- /dev/null
+++ b/toolbox/fdc3-compliance/public/index.html
@@ -0,0 +1,20 @@
+
+
+
+
+
+
+
+
+
+
+ window.fdc3.
+ 
+ | FDC3 Version | +{appInfo?.fdc3Version ? appInfo.fdc3Version : "unknown"} | +
|---|---|
| Provider | +{appInfo?.provider ? appInfo.provider : "unknown"} | +
| Provider version | +{appInfo?.providerVersion ? appInfo.providerVersion : "unknown"} | +
- An FDC3 desktop agent implementation was not found at window.fdc3.
-For web applications to be FDC3-enabled, they need to run in the context of an agent that makes the FDC3 API available to the application. This desktop agent is also responsible for lauching and co-ordinating applications. It could be a browser extension, web app, or full-fledged desktop container framework.
-See the FDC3 standard documentation for details on supported platforms and accessing the FDC3 API.
-