ℹ️ OpenFin Workspace: OpenFin Workspace is a commercial product and this repo is for evaluation purposes (See LICENSE.MD). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see manifest). Please contact us if you would like to request a developer evaluation key or to discuss a production license.
Unit testing should be performed on your code to improve its correctness, there are some example tests included to demonstrate how to achieve this goal in the OpenFin environment.
There is an npm command which will execute the included tests.
npm run testThe tests are executed using Jest as the test runner, the configuration is setup so that it will test TypeScript files and include code coverage.
Included in the project are some example tests, see ../test folder.
Example output from running the tests using the npm command:
You can also run and debug the tests from inside VSCode, you must first install the following plugin Jest
By selecting the flask icon on the left you should see all the tests available and be able to run or debug them as a whole or individually. This includes being able to set breakpoints in them in debug mode.
Code coverage is enabled for Jest, if you open a source file that you have been testing, and switch on the VSCode Code Coverage option you should see a display similar to the following, which highlights areas which have not been covered by the tests.
As part of your testing you will no doubt need to mock parts of the fin API, you can see an examples of this in the ../test/setup.ts
The setup.ts file is always executed when running the tests, so anything you define in there will be available to all of your tests.
e.g. Mocking the fin.System.getMonitorInfo method
Object.defineProperty(globalThis, 'fin', {
value: {
System: {
getMonitorInfo: async () => ({
primaryMonitor: {
monitorRect: PRIMARY_MONITOR_RECT
},
nonPrimaryMonitors: [
{
monitorRect: SECONDARY_MONITOR_RECT
},
{
monitorRect: TERTIARY_MONITOR_RECT
}
]
})
}
}
});