Mocha JSON Reporter
A Mocha JSON test reporter to create test reports that follow the CTRF standard.
Common Test Report Format ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.
Features
- Generate JSON test reports that are CTRF compliant
- Straightforward integration with Mocha
What is CTRF?
CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
Consistency Across Tools: Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
Language and Framework Agnostic: It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
Facilitates Better Analysis: With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
{
"results": {
"tool": {
"name": "mocha"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1706828654274,
"stop": 1706828655782
},
"tests": [
{
"name": "ctrf should generate the same report with any tool",
"status": "passed",
"duration": 100
}
],
"environment": {
"appName": "MyApp",
"buildName": "MyBuild",
"buildNumber": "1"
}
}
}
Installation
npm install --save-dev mocha-ctrf-json-reporter
You can configure Mocha to use mocha-ctrf-json-reporter in several ways: through .mocharc.js, .mocharc.json, or via the command line. Below are the instructions for each method:
Update your .mocharc.js file as follows:
module.exports = {
reporter: 'mocha-ctrf-json-reporter',
}
Using .mocharc.json, update your config file as follows:
{
"reporter": "mocha-ctrf-json-reporter"
}
Run your tests as you normally would:
npx mocha
You'll find a JSON file named ctrf-report.json
in the ctrf
directory.
You can also specify the reporter from the command line:
mocha --reporter mocha-ctrf-json-reporter
Reporter Options
The reporter supports several configuration options, update your .mocharc.js
{
reporter: "mocha-ctrf-json-reporter",
reporterOptions: {
outputFile: 'custom-name.json',
outputDir: 'custom-directory',
appName: 'MyApp',
appVersion: '1.0.0',
osPlatform: 'linux',
osRelease: '18.04',
osVersion: '5.4.0',
buildName: 'MyApp Build',
buildNumber: '100',
}
},
For .mocharc.json
{
"reporter": "mocha-ctrf-json-reporter",
"reporterOptions": {
"outputFile": "custom-name.json"
}
}
Alternatively, you can pass the reporter options via the command line when running your Mocha tests. Use the --reporter-options flag followed by the options in a key=value format, separated by commas:
npx mocha --reporter mocha-ctrf-json-reporter --reporter-options "outputFile=custom-name.json,outputDir=custom-directory,appName=MyApp,appVersion=1.0.0"
Test Object Properties
The test object in the report includes the following CTRF properties:
Name | Type | Required | Details |
---|
name | String | Required | The name of the test. |
status | String | Required | The outcome of the test. One of: passed , failed , skipped , pending , other . |
duration | Number | Required | The time taken for the test execution, in milliseconds. |
message | String | Optional | The failure message if the test failed. |
trace | String | Optional | The stack trace captured if the test failed. |