Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
cypress-ctrf-json-reporter
Advanced tools
Readme
Save Cypress test results as a JSON file
A Cypress 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.
⭐ If you find this project useful, consider giving it a GitHub star ⭐
It means a lot to us and helps us grow this open source library.
{
"results": {
"tool": {
"name": "cypress"
},
"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"
}
}
}
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.
npm install --save-dev cypress-ctrf-json-reporter
Add the reporter to your cypress.config.js/ts file:
const { defineConfig } = require('cypress')
const { generateCtrfJsonReport } = require('cypress-ctrf-json-report')
module.exports = defineConfig({
e2e: {
setupNodeEvents(on, config) {
// Implement node event listeners here
GenerateCtrfReport({
on,
})
},
},
})
Run your tests:
npx cypress run
You'll find a JSON file named ctrf-report.json
in the ctrf
directory.
Add the reporter to your cypress/plugins/index.js/ts
const { generateCtrfJsonReport } = require('cypress-ctrf-json-report')
/// <reference types="cypress" />
/**
* @type {Cypress.PluginConfig}
*/
// eslint-disable-next-line no-unused-vars
module.exports = (on, config) => {
GenerateCtrfReport({
on,
})
}
The reporter supports several configuration options:
GenerateCtrfReport({
on, {
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: 'e2e', // Optional: Specify the test type (e.g., 'api', 'e2e'). Defaults to 'e2e'.
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.
}
})
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. |
rawStatus | String | Optional | The original cypress status of the test before mapping to CTRF status. |
type | String | Optional | The type of test (e.g., api , e2e ). |
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. |
browser | String | Optional | The browser used for the test. |
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.
FAQs
> Save Cypress test results as a JSON file
The npm package cypress-ctrf-json-reporter receives a total of 1,095 weekly downloads. As such, cypress-ctrf-json-reporter popularity was classified as popular.
We found that cypress-ctrf-json-reporter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.