Automation CLI

This package contains a command line application that can be used to run automation tests within the OpenFin ecosystem.

The CLI is run by providing the location of the OpenFin application manifest and a set of test files.

During the execution of the CLI it will retrieve the required OpenFin runtimes as well as the correct version of the chromedriver to use with the runtime.

The CLI can also run in offline more where the OpenFin runtimes and chromedriver are already expected to be available locally. An offline-versions.json file is also expected to exist in the storage folder to define the real version numbers for labelled runtimes (see example below)

Currently Jasmine, Mocha and Jest are provided as in-built test runners.

When the test frameworks run they will automatically determine if your tests are written with JavaScript and TypeScript and behave accordingly.

The CLI process will exit with code 1 if any of the tests failed.

Installation

Run npm i @openfin/automation-cli.

Command Line Options

``shell
🚀 OpenFin Automation v1.2.0

Usage: of-automation [options] > >

Run Automation Tests using Chrome Driver with an OpenFin UI

Arguments:
manifestUrl The url of the manifest to load, can be http|https|file|none
testGlobs Globs pointing to the tests to run, semi-colon separate for additional folders

Options:
-V, --version output the version number
--logLevel The log level for the webdriver (choices: "debug", "silent", default: "silent")
--devToolsPort The port to run the dev tools on (default: 9090)
--chromeDriverPort The port to run the chromedriver on (default: 4444)
--storageFolder The path to store any downloaded or offline data (default: "./storage/")
--offline In offline mode no resources are retrieved, they are expected to be in the storageFolder
--testTimeout The timeout in seconds for running tests (default: 120)
--testFailCount Will exit the tests after given number of failures, 0 will allow all failures (default: 0)
--defaultRuntimeVersion The OpenFin runtime version to use if not specified in manifest (default: "stable")
--framework The test framework to run the tests with (choices: "mocha", "jasmine", "jest", default: "mocha")
--reporter Additional runner config to be passed to frameworks
--driver The webdriver used to access the runtime (choices: "node", "selenium", default: "node")
--workspace The workspace version to use e.g. 9.2.5 for the DOS settings (default: "stable")
--notifications The notifications version to use e.g. 1.20.2 for the DOS settings (default: "stable")
--chromeDriverOverride Override the version of chromedriver e.g. 113
--closeRuntime When to close OpenFin runtimes in the workflow (choices: "never", "start", "end", "both", default: "both")
--dos Provide a custom DOS file to use when running tests
--screenshotFolder The path to store any screen shots that have been taken (default: "./reports/screenshots/")
--verbosity What to display from the runner output (choices: "all", "none", "results", default: "all")
--hooks A file which contains global setup and teardown hooks (default: "./automation-hooks.{js,ts}")
-h, --help display help for command
`

Helper packages

Any tests that you write can make use of two helper packages @openfin/automation-helpers and @openfin/automation-native which provide features to aid in interacting with OpenFin.

Example tests

There are JavaScript/TypeScript examples in the Workspace Starter repo

There are .NET examples in the C# Starter repo

CI Environments

The CLI can be used to run tests in a headless CI environment such as GitHub Actions, it requires a windows platform to be executed on.

Reporter config

To provide an additional reporter output for a test framework you can specify a reporter config file e.g. --reporter mocha.reporter.json. You must install the necessary npm package in the node_modules where you are running the tests from.

Some examples for each framework are.

$3

`shell
npm install mochawesome
`

`json
{
"reporter": "mochawesome",
"options": {
"reportDir": "./reports/mocha/",
"reportFilename": "report.html",
"html": true,
"json": false
}
}
`

$3

`shell
npm install jasmine-pretty-html-reporter
`

`json
{
"reporter": "Reporter",
"module": "jasmine-pretty-html-reporter",
"options": {
"path": "./reports/jasmine"
}
}
`

$3

`shell
npm install jest-html-reporters
`

`json
{
"reporter": "jest-html-reporters",
"options": {
"publicPath": "./reports/jest",
"filename": "report.html"
}
}
`

Execution example

Assuming your manifest is already being served at http://localhost:8080/manifest.fin.json and your files are stored in ./tests.

`shell
of-automation http://localhost:8080/manifest.fin.json ./tests/*/.spec.js
`

You should see a summary similar to that shown below:

$3

Example file for offline-versions.json required if running in offline mode.

`json
{
"stable": "32.114.76.10",
"release-candidate": "32.114.76.10",
"beta": "32.114.76.10",
"canary": "34.116.78.17",
"stable-v32": "32.114.76.10",
"stable-v31": "31.112.75.7",
"stable-v30": "30.110.74.16",
"stable-v29": "29.108.73.19",
"stable-v28": "28.106.72.17",
"stable-v27": "27.104.71.29",
"stable-v26": "26.102.71.10",
"stable-v25": "25.100.70.4",
"stable-v24": "24.98.69.10",
"stable-v23": "23.96.68.7",
"stable-v22": "22.94.67.8",
"stable-v21": "21.93.65.4",
"stable-v20": "20.91.64.4",
"stable-v19": "19.89.61.8",
"stable-v18": "18.87.57.42",
"stable-v17": "17.85.55.40",
"stable-v16": "16.83.53.27",
"stable-v15": "15.80.50.34",
"stable-v14": "14.78.48.16",
"stable-v13": "13.76.45.15",
"stable-v12": "12.69.43.22",
"stable-v11": "11.69.42.29",
"stable-v10": "10.66.41.18",
"stable-v9": "9.61.38.43",
"stable-v8": "8.56.30.71",
"stable-v7": "7.53.23.23",
"stable-v6": "6.49.21.24"
}

``

OpenFin Debugging

For more information on debugging in OpenFin see https://developers.openfin.co/of-docs/docs/debugging

Related Packages

- @openfin/automation-helpers
- @openfin/automation-native