mochalastic v2.0.1

mochalastic - elasticsearch reporter for mocha

Pushes test results into an elasticsearch instance.

Installation

$ npm install mochalastic --save

Usage

Ensure that your elasticsearch installation is up and running.

Run mocha with mochalastic:

$ mocha test --reporter mochalastic --reporter-options nodeUris=https://localhost:9200,username=elastic,password=changeme,project=some_project,suite=some_suite, indexPrefix=test-results

or use a mocha.options file

mocha --opts mochalastic.opts build/test
--recursive
--reporter mochalastic
--reporter-options nodeUris=https://localhost:9200,username=elastic,password=changeme,project=some_project,suite=some_suite, indexPrefix=test-results
--no-exit

Your mocha test executions will be marked with a unique id and be pushed into elasticsearch.

it("should return 401 when authenticated with invalid username", . . .
it("should return 201 when product created", . . .

All tests will be published. There is a feature request for skipping 'Pending' or 'Skipped' tests.

Options

nodeUris: string the address of your elasticsearch instance (e.g. for a hosted instance https://localhost:9200m)

username: string elasticsearch username

password: string elasticsearch password

project: string projet name with which the tests are associated

suite: string suite name with which the tests are associated

indexPrefix: string index prefix will be used to create index. After the prefix, the system adds the current date format as yyyy.MM.dd. (e.g. for test-results prefix test-results-2020-02-17)

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

License

This project is licensed under the MIT License - see the LICENSE file for details

References

• http://mochajs.org/#mochaopts
• https://github.com/mochajs/mocha/wiki/Third-party-reporters