mochawesome-converter

Test report files to Mochawesome and JUnit converter

[![Actions Status][github-img]][github-url]
[![Codacy Badge][codacy-img]][codacy-url]
[![Git Issues][issues-img]][issues-url]
[![Closed Issues][closed-issues-img]][closed-issues-url]

$3

- Convert your XML/TRX test report files to Mochawesome JSON/HTML for easy viewing and troubleshooting.
- Convert test report files to JUnit format.
- Convert JUnit to HTML using Mochawesome.

$3

- JUnit/xUnit XML Format
- NUnit v3+ XML Format
- xUnit.net v2+ XML Format
- MSTest TRX Format (this is default dotnet test report output)

$3

Mochawesome is a custom test reporter originally designed for Mocha Javascript testing framework.
It features a clean modern interface allowing users to easily view and navigate test runs.
https://github.com/adamgruber/mochawesome

$3

- Simple, clean, and modern design
- Per suite charts (via ChartJS)
- Stack trace for failed tests
- Support for displaying context information
- Filters to display only the tests you want
- Responsive and mobile-friendly
- Offline viewing

$3

- Support for test and suite nesting
- Displays before and after hooks
- Review test code inline

$3

- All test reports are first converted to JUnit format using junit-converter.
- Set junit option to true to get JUnit conversion results.
- If you only require JUnit conversion, you can use junit-converter.

$3

- Converts <skipped> test messages to Mochawesome test context values.
- Converts <properties>, <system-out> and <system-err> to Mochawesome context values.
- Converts <failure> and <error> elements to Mochawesome error stack.
- Tests suites without any tests are excluded from Mochawesome and JUnit.
- Attachments are not supported.

$3

- Full conversion process is described in junit-converter

$3

``bash
npm i --save-dev mochawesome-converter
`

`js
const convert = require('mochawesome-converter');

let options = {
testFile: 'mytesfiles/nunit.xml',
testType: 'nunit',
junit: true
}

convert(options).then(() => console.log(Mochawesome report created));
`

$3

`bash
npm i -g mochawesome-converter
`

`bash
mochawesome-converter --testFile mytests/nunit.xml --testType nunit --junit true --html true
`

$3

| Option | Type | Default | Description |
|:--------------------------|:--------|:---------------------------------|:--------------------------------------------------|
| testFile (required) | string | | Path to test file for conversion |
| testType (required) | string | | Test report type |
| reportDir | string | ./report | Converted report output path |
| reportFile | string | testFile.name-mochawesome.json | Mochawesome JSON report name |
| junit | boolean | false | Create JUnit report? |
| junitReportFile | string | testFile.name-junit.xml | JUnit report file name |
| html | boolean | false | Create Mochawesome HTML? |
| htmlReportFile | string | testFile.name-mochawesome.html | Mochawesome HTML file name |
| splitByClassname | boolean | false | Split into multiple test suites by test classname |
| skippedAsPending | boolean | true | Show skipped tests as pending in Mochawesome |
| switchClassnameAndName | boolean | false | Switch test case classname and name |

- testFile - relative or absolute path to input test file.
- testType - type of test report, not case-sensitive.
- reportDir - will be created if path does not exist.
- splitByClassname - If true, splits test cases into multiple test suites by classname.
This is useful for test runners that generate tests under a single test suite such as dotnet test when using JUnit loggers.
TRX report files are always split by classname, so this option is ignored for TRX files.
- skippedAsPending - Mocha always reports skipped tests as pending and this is default behaviour of converter.
Set to false to display tests as skipped.
- switchClassnameAndName - Switches classname and name attributes of testcase if your test naming data is generated in reverse order.

#### Supported testType options.

| testType | File Type |
|:-----------|:---------------------------|
| JUnit | JUnit/xUnit XML |
| NUnit | NUnit v3+ XML |
| xUnit | xUnit.net v2+ XML |
| TRX | MSTest TRX (dotnet test`) |



[issues-img]: https://img.shields.io/github/issues-raw/agracio/mochawesome-converter.svg?style=flat-square
[issues-url]: https://github.com/agracio/mochawesome-converter/issues
[closed-issues-img]: https://img.shields.io/github/issues-closed-raw/agracio/mochawesome-converter.svg?style=flat-square&color=brightgreen
[closed-issues-url]: https://github.com/agracio/mochawesome-converter/issues?q=is%3Aissue+is%3Aclosed

[codacy-img]: https://app.codacy.com/project/badge/Grade/1b8b8f9fdbce4267bf779197141657a2
[codacy-url]: https://app.codacy.com/gh/agracio/mochawesome-converter/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

[github-img]: https://github.com/agracio/mochawesome-converter/workflows/Test/badge.svg
[github-url]: https://github.com/agracio/edge-js/mochawesome-converter/workflows/main.yml