# @faiteanu/mocha-junit-reporter
> A JUnit reporter for mocha.
Latest version **2.0.4** (published 2022-01-17) · MIT license · 0 weekly downloads
## Install
```sh
npm install @faiteanu/mocha-junit-reporter
pnpm add @faiteanu/mocha-junit-reporter
yarn add @faiteanu/mocha-junit-reporter
bun add @faiteanu/mocha-junit-reporter
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.4 |
| Published | 2022-01-17 |
| First published | 2022-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 85 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Fabian Aiteanu |
| Maintainers | faiteanu |
| Keywords | mocha, junit, reporter |
## Links
- npm: https://www.npmjs.com/package/@faiteanu/mocha-junit-reporter
- Repository: https://github.com/faiteanu/mocha-junit-reporter
- Homepage: https://github.com/faiteanu/mocha-junit-reporter#readme
- Issues: https://github.com/faiteanu/mocha-junit-reporter/issues
- npm.io page: https://npm.io/package/@faiteanu/mocha-junit-reporter
## Dependencies (5)
- [md5](https://npm.io/package/md5.md) ^2.1.0
- [xml](https://npm.io/package/xml.md) ^1.0.0
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [mkdirp](https://npm.io/package/mkdirp.md) ~0.5.1
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^6.0.1
## Recent versions
- 2.0.4 (latest) — 2022-01-17
- 2.0.3 — 2022-01-17
- 2.0.2 — 2022-01-14
## README
# JUnit Reporter for Mocha
Produces JUnit-style XML test results.
## Installation
```shell
$ npm install mocha-junit-reporter --save-dev
```
or as a global module
```shell
$ npm install -g mocha-junit-reporter
```
## Usage
Run mocha with `mocha-junit-reporter`:
```shell
$ 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`:
```shell
$ MOCHA_FILE=./path_to_your/file.xml mocha test --reporter mocha-junit-reporter
```
or
```shell
$ mocha test --reporter mocha-junit-reporter --reporter-options mochaFile=./path_to_your/file.xml
```
or
```javascript
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
```xml
```
To do so pass them in via env variable:
```shell
PROPERTIES=BUILD_ID:4291 mocha test --reporter mocha-junit-reporter
```
or
```javascript
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 order to display full suite title (including parents) just specify `testsuitesTitle` option
```javascript
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.
```javascript
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` | `` |
| `false` (default) | `` |
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 - `` and `` - 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:
```js
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:
```js
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 :
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](https://wiki.jenkins.io/display/JENKINS/JUnit+Attachments+Plugin) format.
Attachment path can be injected into the test object
```js
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:
```xml
output line 1
output line 2
[[ATTACHMENT|path/to/file]]
```
### Attachment from Test Context with Cypress
Enabling the `attachmentFromTestContext` configuration option will allow for attaching files and screenshots in [JUnit Attachments Plugin](https://wiki.jenkins.io/display/JENKINS/JUnit+Attachments+Plugin) format.
Three different settings need to be configured suitably so that the paths match.
1. Add the following code to your Cypress `support/index.js`
```js
import addContext from "mochawesome/addContext";
Cypress.on("test:after:run", (test, runnable) => {
if (test.state === "failed") {
const screenshot =`assets/${Cypress.spec.name}/${runnable.parent.title} -- ${test.title} (failed).png`;
addContext({ test }, screenshot);
}
});
```
2. In `cypress.json`
```json
{
"screenshotOnRunFailure": true,
"screenshotsFolder": "cypress/results/html-report/assets",
"reporter": "mocha-multi-reporters",
"reporterOptions": {
"reporterEnabled": "spec, mochawesome, mocha-junit-reporter",
"mochaJunitReporterReporterOptions": {
"mochaFile": "cypress/results/junit/output-[hash].xml",
"attachmentFromTestContext": true
},
"mochawesomeReporterOptions": {
"reportDir": "cypress/results/mochawesome",
"overwrite": false,
"html": false,
"json": true
}
}
}
```
3. In package.json in the scripts tag, add the following scripts. Those are just examples and should be adapted to your needs.
```json
{
"headless:firefox": "./node_modules/.bin/cypress run --headless --config video=false --browser firefox",
"mochawesome:merge": "./node_modules/.bin/mochawesome-merge cypress/results/mochawesome/*.json > cypress/results/mochawesome-merged.json",
"html-report": "./node_modules/.bin/marge cypress/results/mochawesome-merged.json -f test-results.html -o cypress/results/html-report --charts=true --showPassed=false",
"headless-test:firefox": "npm run headless:firefox || npm run mochawesome:merge && npm run html-report"
}
```
Then execute `npm run headless-test:firefox`. That will run the tests, merge all test results into one file,
and create the output test-results.html with included attachments. `marge` creates an `assets` folder in the same directory
as test-results.html, so the screenshotsFolder needs to match it.
### 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') |
| skipRootSuiteXmlOutput | `false` | if set to a truthy value the rootSuite `testsuites` tag is not written to the xml output, as is empty anyway |
| testSuiteOutputFilename | `false` | if set to a truthy value will `file` is set on each `testsuite` tag equal to the rootSuite file |
| testSuiteOutputFilenamePrefix | `` (empty) | prefix to prepend to `file` attribute in output. Useful if testsuite is not in the git root folder.
| useSuiteNameAsClassName | `false` | if set to a truthy value will use the suite name as classname. Useful for gitlab |
| 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) |
| attachmentFromTestContext | `false` | if set to truthy value will attach files from `mochawesome/addContext` 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][ant-schema] |
| antHostname | `process.env.HOSTNAME` | hostname to use when running in `antMode` will default to environment `HOSTNAME` |
| gitlabMode | `false` | if set to truthy value will return xml that will display nice results in Gitlab |
| jenkinsMode | `false` | if set to truthy value will return xml that will display nice results in Jenkins |
[travis-badge]: https://travis-ci.org/michaelleeallen/mocha-junit-reporter.svg?branch=master
[travis-build]: https://travis-ci.org/michaelleeallen/mocha-junit-reporter
[npm-badge]: https://img.shields.io/npm/v/mocha-junit-reporter.svg?maxAge=2592000
[npm-listing]: https://www.npmjs.com/package/mocha-junit-reporter
[ant-schema]: http://windyroad.org/dl/Open%20Source/JUnit.xsd
---
_Source: https://npm.io/package/@faiteanu/mocha-junit-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._