Vitest JSON Test Results Report

> Save Vitest test results as a JSON file

A Vitest 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 Vitest

``json
{
"results": {
"tool": {
"name": "vitest"
},
"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"
}
}
}
`

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, programmatically analyzing test outcomes across multiple platforms becomes more straightforward.

Installation

`bash
npm install --save-dev @d2t/vitest-ctrf-json-reporter
`

Add the reporter to your vitest.config.js file:

`javascript
reporters: ['default', ['@d2t/vitest-ctrf-json-reporter', {}]]
`

Run your tests:

`bash
npx vitest
`

You'll find a JSON file named ctrf-report.json in the ctrf directory.

Reporter Options

The reporter supports several configuration options:

`javascript
reporter: [
[
'@d2t/vitest-ctrf-json-reporter',
{
outputFile: 'custom-name.json', // Optional: Output file name. Defaults to 'ctrf-report.json'.
outputDir: 'custom-directory', // Optional: Output directory path. Defaults to 'ctrf'.
minimal: true, // Optional: Generate a minimal report. Defaults to 'false'. Overrides screenshot and testType when set to true
testType: 'unit', // Optional: Specify the test type (e.g., 'unit', 'component'). Defaults to 'unit'.
appName: 'MyApp', // Optional: Specify the name of the application under test.
appVersion: '1.0.0', // Optional: Specify the version of the application under test.
osPlatform: 'linux', // Optional: Specify the OS platform.
osRelease: '18.04', // Optional: Specify the OS release version.
osVersion: '5.4.0', // Optional: Specify the OS version.
buildName: 'MyApp Build', // Optional: Specify the build name.
buildNumber: '100', // Optional: Specify the build number.
buildUrl: 'https://ctrf.io', // Optional: Specify the build url.
repositoryName: 'ctrf-json', // Optional: Specify the repository name.
repositoryUrl: 'https://gh.io', // Optional: Specify the repository url.
branchName: 'main', // Optional: Specify the branch name.
testEnvironment: 'staging', // Optional: Specify the test environment (e.g. staging, production).
},
],
]
`

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. |
| suite | String | Optional | The suite or group to which the test belongs. |
| message | String | Optional | The failure message if the test failed. |
| trace | String | Optional | The stack trace captured if the test failed. |
| rawStatus | String | Optional | The original vitest status of the test before mapping to CTRF status. |
| type | String | Optional | The type of test (e.g., unit, component). |
| filepath | String | Optional | The file path where the test is located in the project. |
| retries | Number | Optional | The number of retries attempted for the test. |
| flaky | Boolean | Optional | Indicates whether the test result is flaky. |
| line` | Number | Optional | Line number in the source file if the test failed. |