Skip to content

Infragistics/mocha-trx-reporter

Repository files navigation

mocha-trx-reporter

Reporter for the Visual Studio TRX format.

Build Status

Usage

Install package

$ npm install mocha-trx-reporter --save

Run mocha with trx reporter

$ mocha --reporter mocha-trx-reporter path/to/tests

To save the output into a file, run:

$ mocha --reporter mocha-trx-reporter --reporter-options output=myResult.trx path/to/tests

or, if you want a more detailed filename:

$ mocha --reporter mocha-trx-reporter --reporter-options output="$(whoami)_$(hostname)_$(date +%F_%H_%M_%S).trx" path/to/tests

or you can set MOCHA_REPORTER_FILE environment var with the desired filename

Reporter options

  • output (string) Outputs as a TRX file into the provided path. If not provided, outputs to stdout. The path can contain [hash], e.g. ./path_to_your/test-results.[hash].trx. [hash] is replaced by a random 32 hex char hash. This enables support of parallel execution of multiple mocha-trx-reporter's writing test results in separate files.
  • treatPendingAsNotExecuted (boolean) Pending tests (tests without implementation, or maked with .skip) have an outcome of NotExecuted instead of Pending in the TRX file.
  • excludePending (boolean) Tests with a Pending state are excluded from the TRX file.
  • warnExcludedPending (boolean) When combined with excludePending, writes a warning to stderr with the number of tests that have been excluded because they had the state Pending, if the number is more than 0.

Multiple options

If you want to use multiple options, separate them with a , like this:

--reporter-options treatPendingAsNotExecuted,output=./test-result.trx

Development

Clone repository and install dependencies

$ npm install

Running tests

$ npm test

For generating sample trx file

$ npx mocha --reporter lib/trx.js --reporter-options output=sampleResult.trx sampleTest/test.js