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.
@sum.cumo/cypress-testrail-reporter
Advanced tools
Readme
This little tool will help you to parse and post cypress test results to testrail.
This tools works with Mochawesome Json Reports. So please make sure you have the following packages installed:
yarn add --dev mocha mochawesome mochawesome-merge
Example Configuration of the Mochawesome Reporter (cypress.json
):
"reporter": "mochawesome",
"reporterOptions": {
"reportDir": "test/cypress/results",
"reportFilename": "mochawesomeReport.json",
"overwrite": false,
"html": false,
"json": true
},
This tool internally uses @sum.cumo/Node-TestRail
(https://github.com/sumcumo/Node-TestRail) as Testrail API Client.
yarn add --dev @sum.cumo/cypress-testrail-reporter
In order to link you cypress tests to testrail cases it's required to provide the actual Testrail CaseId(s) in your tests title. Example:
it('should do something [123]', () => {})
Or
describe('Feature Tests [123]', () => {
it('should do something', () => {})
})
The above examples will link the results of the test to a case C123 (C is the testrail Case Prefix. Case IDs are numerical)
The Testrail Reporter gets its config from your cypress.json
and / or provided cli arguments.
cypress.json
Add a testrailReporter
section to your Cypress Config. You can provide the following:
Argument | Description |
---|---|
projectId | The ID of your Testrail Project |
suiteId | Testrails Suite Id |
branchReferenceRegex | This Reporter will create JIRA References if this regex is matching your Branch name |
host | The Address of your running Testrail Application (API) |
username | A Username for Authentication against Testrail API |
password | The corresponding password or API token |
reportFilename | The relative path to your mochawesome report, eg ./test/cypress/results/result.json |
includeAll . | Whether include all test cases to current test run, Default: false |
Example:
{
...
"testrailReporter": {
"projectId": "1",
"suiteId": "2",
"branchReferenceRegex": "((feat|chore)-\\d*)",
"host": "https://example.testrail.io/",
"user": "some@one.com",
"password": "YOUR_PASSWORD",
"includeAll": true
},
You can also provide the arguments name
password
and host
within the cli like
yarn cypress-testrail-reporter --user some@one.com --password YOUR_PASSWORD --host https://example.testrail.io/
As soon as your Mochawesome Report was generated you can execute the following
yarn cypress-testrail-reporter --name NAME_OF_YOUR_TESTRUN
This will create a new or update an existing Testrun with the given name and will report all results found in your Mochawesome Report.
yarn cypress-testrail-reporter --name NAME_OF_YOUR_TESTRUN --attach test/cypress/results/report.html --assets test/cypress/videos test/cypress/screenshots --assetsArchiveName CUSTOM_NAME_FOR_YOUR_ARCHIVE
This will create a new or update an existing Testrun with the given name and will report all results found in your Mochawesome Report. Afterwards it will attach a report.html to this run and create an archive containing all provided assets and attach it as well.
Argument | Description |
---|---|
name | The Name of your Testrail Run |
suiteId | Testrails suite Id |
reportFilename | The relative path to your report (from process.cwd ).Example: result.json Default: testrailReporter.reportFilename |
closeRun | Whether to close the run automatically or not. Default: false |
host | The Address of your running Testrail Application (API) |
username | A Username for Authentication against Testrail API |
password | The corresponding password |
assets | Provide Assets Paths if you want to attach them to a run |
assetsArchiveName | Provide a custom archive Name. Default: cypressAssets |
attach | Provide further attachments like reports |
Further Details:
yarn cypress-testrail-reporter --help
This Reporter is intended to be used in your CI / CD Pipeline.
Integration Test:
scripts:
- yarn cypress # Run your cypress tests
- yarn cypress-testrail-reporter --name $CI_COMMIT_REF_SLUG --user $TESTRAIL_USERNAME --password $TESTRAIL_PASSWORD
The Example above will report result for the current branch and uses global variables for authentication. So you don't have to store credentials within your project and can use Gitlab CI Variables instead.
FAQs
Parse and Post your cypress results to testrail
The npm package @sum.cumo/cypress-testrail-reporter receives a total of 688 weekly downloads. As such, @sum.cumo/cypress-testrail-reporter popularity was classified as not popular.
We found that @sum.cumo/cypress-testrail-reporter demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 6 open source maintainers 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.