mocha-ci-slack-reporter

Slack reporter for Mocha when running in CI environments.

Although this can be used in non-CI environments too, it is suited for CI environment in that it is able to report build number, build URL, etc alongside standard test pass/failed information.

It posts a single notification to your Slack channel with a summary of the test results.

Installation

1$ npm install mocha-ci-slack-reporter

Usage

All options:

• url (mandatory) - Slack incoming webhook URL
• username (mandatory) - Username to post as
• channel (mandatory) - Channel to post to
• logsUrl - URL to logs page (appended to message text as a View logs link)
• passEmoji - Emoji to use for test pass (default is :ok_hand:)
• failEmoji - Emoji to use for test failure (default is :bomb:)
• failuresOnly - Whether to only report failures (default is false)

via Command-line

1$ mocha test --reporter mocha-ci-slack-reporter  --reporter-options username=name,channel=#channel_name,...

via API

1var mocha = new Mocha({
2  reporter: 'mocha-ci-slack-reporter',
3  reporterOptions: {
4    url: 'https://hooks.slack.com/...',
5    username: 'reporter',
6    channel: '#mychannel',
7    logsUrl: 'https://ci.com/project/...'
8  }
9});

License

MIT - see LICENSE.md