json-reporter

Common plugin for:

• testplane
• hermione

which is intended to aggregate the results of tests running.

You can read more about testplane plugins here.

Installation

npm install json-reporter

Usage

Plugin has following configuration:

• enabled (optional) Boolean – enable/disable the plugin; by default plugin is enabled
• path (optional) String - path for saving json report file; by default json report will be saved into json-reporter.json inside current work directory.
• includeHistory (optional) Boolean – include test execution history in the json report; by default history is not included. Note: history is not available for skipped tests and may be undefined.

Also there is ability to override plugin parameters by CLI options or environment variables (see configparser).

Testplane usage

Add plugin to your testplane config file:

export default {
    // ...
    plugins: {
        'json-reporter/testplane': {
            enabled: true,
            path: 'my/custom/report.json',
            includeHistory: true
        }
    },
    //...
}

Hermione usage

Add plugin to your hermione config file:

module.exports = {
    // ...
    plugins: {
        'json-reporter/hermione': {
            enabled: true,
            path: 'my/custom/report.json',
            includeHistory: true
        }
    },
    //...
}

Testing

Run mocha tests:

npm run test-unit

Run tests with istanbul coverage calculation:

npm run cover

Run eslint codestyle verification

npm run lint