@stryker-mutator/mocha-runner

Stryker Mocha Runner

A plugin to use Mocha in Stryker, the JavaScript mutation testing framework.

Install

Install @stryker-mutator/mocha-runner locally within your project folder, like so:

npm i --save-dev @stryker-mutator/mocha-runner

Peer dependencies

The @stryker-mutator/mocha-runner is a plugin for stryker to enable mocha as a test runner. As such, you should make sure you have the correct versions of its dependencies installed:

• mocha
• @stryker-mutator/core

Configuring

You can configure the mocha test runner in the stryker.conf.js (or stryker.conf.json) file.

// stryker.conf.js
module.exports = {
    // ...
    testRunner: 'mocha',
    // ...
    mochaOptions: {
        // Optional mocha options
        spec: [ 'test/**/*.js' ],
        config: 'path/to/mocha/config/.mocharc.json',
        package: 'path/to/custom/package/package.json',
        opts: 'path/to/custom/mocha.opts',
        ui: 'bdd',
        timeout: 3000,
        require: [ /*'babel-register' */],
        'async-only': false,
        grep: /.*/
    }
}

When using Mocha version 6, @stryker-mutator/mocha-runner will use mocha's internal file loading mechanism to load your mocha configuration. So feel free to leave out the mochaOptions entirely if you're using one of the default file locations.

Alternatively, use ['no-config']: true, ['no-package']: true or ['no-opts']: true to ignore the default mocha config, default mocha package.json and default mocha opts locations respectively.

mochaOptions.spec [string or string[]]

Default: 'test/**/*.js'

Choose which files to include. This is comparable to mocha's test directory although there is no support for --recursive.

If you want to load all files recursively: use a globbing expression ('test/**/*.js'). If you want to decide on the order of files, use multiple globbing expressions. For example: use ['test/helpers/**/*.js', 'test/unit/**/*.js'] if you want to make sure your helpers are loaded before your unit tests.

mochaOptions.config [string | undefined]

Default: undefined

Explicit path to the mocha config file

New since Mocha 6

mochaOptions.package [string | undefined]

Default: undefined

Specify an explicit path to a package.json file (ostensibly containing configuration in a mocha property). See https://mochajs.org/#-package-path.

New since Mocha 6

mochaOptions.opts [string | false]

Default: 'test/mocha.opts'

Specify a 'mocha.opts' file to be loaded. Options specified directly in your stryker.conf.js file will overrule options from the 'mocha.opts' file. Disable loading of an additional mocha.opts file with false.

The only supported mocha options are used: --ui, --require, --async-only, --timeout, --grep (or their short form counterparts). Others are ignored by the @stryker-mutator/mocha-runner.

mochaOptions.grep [RegExp]

Default: undefined

Specify a mocha grep command, to single out individual tests.

mochaOptions.ui [string]

Default: undefined

Set the name of your mocha ui

mochaOptions.extension [string]

Default: undefined

Set mocha's --extension property.

mochaOptions.require [string[]]

Default: []

Set mocha's require option

mochaOptions.async-only [boolean]

Default: false

Set mocha's asyncOnly option

mochaOptions.timeout [number]

Default: undefined

Set mocha's timeout option

Changelog

4.0.0-beta.4 (2020-08-29)

Bug Fixes

• input files: support emojis in file names (#2430) (139f9f3)
• input files: support emojis in file names (#2433) (b5feae2)

Features

• api: rename test_runner2 -> test_runner (#2442) (4d3ae97)
• jest-runner: switch mutants using env (#2416) (cad01ba)
• karma-runner: force bail = true in all cases (ba928a1)
• options: deprecate old stryker options (#2395) (7c637c8)
• reporter-api: support mutation switching (67f1ed5)
• test-runner: add nrOfTests metric (0eea448)
• wct-runner: drop support for wct (#2440) (7c55424)

Performance Improvements

• express: add benchmark express (#2431) (7cfb8f1)

BREAKING CHANGES

• api: Plugin creators should now use 'test_runner' instead of 'test_runner2'.
• wct-runner: The @stryker-mutator/wct-runner package is dropped in Stryker 4.0. Please see https://github.com/stryker-mutator/stryker/issues/2386 for more details. Feel free to keep using @stryker-mutator/wct-runner@3 or start a community fork. Note that support for the web-component-tester itself is minimal, you might want to consider switching to a different test runner. Stryker still supports Mocha, Jest, Jasmine and Karma.
• reporter-api: The onMutantTested and onAllMutantsTested methods on the Reporter api have changed