Tests

Running Tests

This section is about testing your changes to OsmiCSX as a contributor.

Build

First, you need to build the project before running a test with:

yarn build

JavaScript Tests

The simplest way to run the JavaScript test suite is by using the following command at the root of your OsmiCSX checkout:

yarn test

This will run tests using Jest.

Continuous Testing

We use GitHub Actions to automatically run our open source tests. GitHub Actions will run these tests whenever a commit is added to a pull request, as a way to help maintainers understand whether a code change introduces a regression.

If one of these tests fails, you'll need someone with a Core Engineer role to take a look. Since pull requests can only be imported by a Core Engineer role, whoever imported the pull request should be able to facilitate any details.