jest-bamboo-reporter
v1.3.0
Published
A reporter for jest which produces a report compatible with Atlassian Bamboo Mocha Test Parser
Downloads
35,264
Maintainers
Readme
jest-bamboo-reporter
A reporter for jest which produces a report compatible with Atlassian Bamboo Mocha Test Parser.
Forked from jest-bamboo-formatter, with major changes in order to work around Bamboo's naming restrictions:
- Bamboo skips tests with identical names, making some tests magically "disappear". This issue is fixed by appending "(2)", "(3)", etc. to the end of tests with otherwise identical names
- The separation into a "class name" (as expected by Bamboo) and a "test name" is based on the suite name hierarchy (with file name as fallback)
- Bamboo completely messes up test (suite) names that contain a period ("."), so this fork replaces those with underscores ("_")
Installation
npm install --save-dev jest-bamboo-reporter
Usage
In the jest config file add the path to the module. For example:
{
"testResultsProcessor": "jest-bamboo-reporter"
}
then run jest (or a npm run
command) with the path to the config file
jest --config=./config/jest.config.json
Configuration
The name of test suite and separator can be customized by setting the environment variables
JEST_BAMBOO_SUITE_NAME="{fileNameWithoutExtension}" JEST_BAMBOO_NAME_SEPARATOR=" >> " jest
JEST_BAMBOO_SUITE_NAME
supports following variables
- firstAncestorTitle: The name of the outermost "describe" group
- filePath: Full path of the test
- fileName: File name of the test
- fileNameWithoutExtension: File name of the test without extension
Also, variable supports fallback. For example:
{firstAncestorTitle|filename}
means use file name of the test if it doesn't have a group name.
Output
By default, the reporter writes to test-report.json
. The file name can be changed by setting the JEST_REPORT_FILE
environment variable.
JEST_REPORT_FILE="./jest-report.json" jest