mocha-junit-reporter

What is mocha-junit-reporter?

The mocha-junit-reporter npm package is designed to generate JUnit-style XML test results from Mocha tests, which is particularly useful for integrating Mocha tests with continuous integration systems like Jenkins, CircleCI, or GitLab CI that can consume JUnit XML reports. This reporter is highly configurable and can be used both in command line and programmatically in Node.js.

What are mocha-junit-reporter's main functionalities?

JUnit XML Report Generation

This feature allows the generation of JUnit XML reports from Mocha tests. The code sample demonstrates how to set up Mocha with the mocha-junit-reporter to output test results in JUnit XML format to a specified file.

const Mocha = require('mocha');
const mocha = new Mocha({
  reporter: 'mocha-junit-reporter',
  reporterOptions: {
    mochaFile: './test-results/results.xml'
  }
});
mocha.addFile('./test/some-test.js');
mocha.run();

Configuration via Environment Variables

This feature supports configuring the reporter through environment variables. The code sample shows how to configure the output file and additional properties using environment variables before running the tests.

process.env.MOCHA_FILE = './test-results/results.xml';
process.env.PROPERTIES = 'HOSTNAME=localhost';

const Mocha = require('mocha');
const mocha = new Mocha({
  reporter: 'mocha-junit-reporter'
});
mocha.addFile('./test/some-test.js');
mocha.run();

Other packages similar to mocha-junit-reporter

junit-reporter

This package also generates JUnit XML reports from test results. It is similar to mocha-junit-reporter but is less popular and might not support all the features or have the same level of community support and documentation.

karma-junit-reporter

While mocha-junit-reporter is used with Mocha, karma-junit-reporter is used within the Karma test runner environment. It serves a similar purpose of generating JUnit reports but is tailored for Karma's ecosystem, showing how these reporters are adapted to different JavaScript testing frameworks.

README

JUnit Reporter for Mocha

Produces JUnit-style XML test results.

Installation

$ npm install mocha-junit-reporter --save-dev

or as a global module

$ npm install -g mocha-junit-reporter

Usage

Run mocha with mocha-junit-reporter:

$ mocha test --reporter mocha-junit-reporter

This will output a results file at ./test-results.xml. You may optionally declare an alternate location for results XML file by setting the environment variable MOCHA_FILE or specifying mochaFile in reporterOptions:

$ MOCHA_FILE=./path_to_your/file.xml mocha test --reporter mocha-junit-reporter

or

$ mocha test --reporter mocha-junit-reporter --reporter-options mochaFile=./path_to_your/file.xml

or

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        mochaFile: './path_to_your/file.xml'
    }
});

Append properties to testsuite

You can also add properties to the report under testsuite. This is useful if you want your CI environment to add extra build props to the report for analytics purposes

<testsuites>
  <testsuite>
    <properties>
      <property name="BUILD_ID" value="4291"/>
    </properties>
    <testcase/>
    <testcase/>
    <testcase/>
  </testsuite>
</testsuites>

To do so pass them in via env variable:

PROPERTIES=BUILD_ID:4291 mocha test --reporter mocha-junit-reporter

or

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        properties: {
            BUILD_ID: 4291
        }
    }
})

Results Report

Results XML filename can contain [hash], e.g. ./path_to_your/test-results.[hash].xml. [hash] is replaced by MD5 hash of test results XML. This enables support of parallel execution of multiple mocha-junit-reporter's writing test results in separate files. In addition to this these placeholders can also be used:

placeholder	output
[testsuitesTitle]	will be replaced by the testsuitesTitle setting
[rootSuiteTitle]	will be replaced by the rootSuiteTitle setting
[suiteFilename]	will be replaced by the filename of the spec file
[suiteName]	will be replaced by the name the first test suite

In order to display full suite title (including parents) just specify testsuitesTitle option

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        testsuitesTitle: true,
        suiteTitleSeparatedBy: '.' // suites separator, default is space (' '), or period ('.') in jenkins mode
    }
});

If you want to switch classname and name of the generated testCase XML entries, you can use the testCaseSwitchClassnameAndName reporter option.

var mocha = new Mocha({
    reporter: 'mocha-junit-reporter',
    reporterOptions: {
        testCaseSwitchClassnameAndName: true
    }
});

Here is an example of the XML output when using the testCaseSwitchClassnameAndName option:

value	XML output
true	<testcase name="should behave like so" classname="Super Suite should behave like so">
false (default)	<testcase name="Super Suite should behave like so" classname="should behave like so">

You can also configure the testsuites.name attribute by setting reporterOptions.testsuitesTitle and the root suite's name attribute by setting reporterOptions.rootSuiteTitle.

System out and system err

The JUnit format defines a pair of tags - <system-out/> and <system-err/> - for describing a test's generated output and error streams, respectively. It is possible to pass the test outputs/errors as an array of text lines:

it ('should report output', function () {
  this.test.consoleOutputs = [ 'line 1 of output', 'line 2 of output' ];
});
it ('should report error', function () {
  this.test.consoleErrors = [ 'line 1 of errors', 'line 2 of errors' ];
});

Since this module is only a reporter and not a self-contained test runner, it does not perform output capture itself. Thus, the author of the tests is responsible for providing a mechanism via which the outputs/errors array will be populated.

If capturing only console.log/console.error is an option, a simple (if a bit hack-ish) solution is to replace the implementations of these functions globally, like so:

var util = require('util');

describe('my console tests', function () {
  var originalLogFunction = console.log;
  var originalErrorFunction = console.error;
  beforeEach(function _mockConsoleFunctions() {
    var currentTest = this.currentTest;
    console.log = function captureLog() {
      var formattedMessage = util.format.apply(util, arguments);
      currentTest.consoleOutputs = (currentTest.consoleOutputs || []).concat(formattedMessage);
    };
    console.error = function captureError() {
      var formattedMessage = util.format.apply(util, arguments);
      currentTest.consoleErrors = (currentTest.consoleErrors || []).concat(formattedMessage);
    };
  });
  afterEach(function _restoreConsoleFunctions() {
    console.log = originalLogFunction;
    console.error = originalErrorFunction;
  });
  it('should output something to the console', function() {
    // This should end up in <system-out>:
    console.log('hello, %s', 'world');
  });
});

Remember to run with --reporter-options outputs=true if you want test outputs in XML.

Attachments

enabling the attachments configuration option will allow for attaching files and screenshots in JUnit Attachments Plugin format.

Attachment path can be injected into the test object

it ('should include attachment', function () {
  this.test.attachments = ['/absolut/path/to/file.png'];
});

If both attachments and outputs are enabled, and a test injects both consoleOutputs and attachments, then the XML output will look like the following:

<system-out>output line 1
output line 2
[[ATTACHMENT|path/to/file]]</system-out>

Full configuration options

Parameter	Default	Effect
mochaFile	test-results.xml	configures the file to write reports to
includePending	false	if set to a truthy value pending tests will be included in the report
properties	null	a hash of additional properties to add to each test suite
toConsole	false	if set to a truthy value the produced XML will be logged to the console
useFullSuiteTitle	false	if set to a truthy value nested suites' titles will show the suite lineage
suiteTitleSeparatedBy	(space)	the character to use to separate nested suite titles. (defaults to ' ', '.' if in jenkins mode)
testCaseSwitchClassnameAndName	false	set to a truthy value to switch name and classname values
rootSuiteTitle	Root Suite	the name for the root suite. (defaults to 'Root Suite')
testsuitesTitle	Mocha Tests	the name for the testsuites tag (defaults to 'Mocha Tests')
outputs	false	if set to truthy value will include console output and console error output
attachments	false	if set to truthy value will attach files to report in JUnit Attachments Plugin format (after console outputs, if any)
antMode	false	set to truthy value to return xml compatible with Ant JUnit schema
antHostname	process.env.HOSTNAME	hostname to use when running in antMode will default to environment HOSTNAME
jenkinsMode	false	if set to truthy value will return xml that will display nice results in Jenkins
jenkinsClassnamePrefix	undefined	adds a prefix to a classname when running in jenkinsMode