razr-cypress-testrail-reporter v0.0.11
RAZR TestRail Reporter for Cypress
Publishes Cypress runs on TestRail.
Cloned from the original package cypress-testrail-reporter by Milutin Savovic
Install
$ npm install razr-cypress-testrail-reporter --save-dev
Usage
Add reporter to your cypress.json
:
...
{
"reporter": "razr-cypress-testrail-reporter",
"reporterOptions": {
"domain": "https://razrhq.testrail.net",
"username": "",
"password": "",
"projectId": 0,
"suiteId": 0,
"runId": 0,
"createTestRun": boolean,
"runName": "Test Run Name"
}
}
Your Cypress tests should include the ID of your TestRail test case. Make sure your test case IDs are distinct from your test titles:
// Good:
it("C123 C124 Can authenticate a valid user", ...
it("Can authenticate a valid user C321", ...
// Bad:
it("C123Can authenticate a valid user", ...
it("Can authenticate a valid userC123", ...
Reporter Options
domain: string domain name of your TestRail instance (e.g. for a hosted instance instance.testrail.com).
username: string email of the user under which the test run will be created.
password: string password or the API key for the aforementioned user.
projectId: number project with which the tests are associated.
suiteId: number suite with which the tests are associated.
createTestRun: boolean true if you want a test run created for you : false if you want to manually create your own test run on TestRail. If you select false, you have to pass a value into the runID property.
runId: number (optional: only necessary if createTestRun is set to false) a specific test run id number.
runName: string (optional) name of the Testrail run.
TestRail Settings
To increase security, the TestRail team suggests using an API key instead of a password. You can see how to generate an API key here.
Deploying to JFROG
npm run build
npm version {major, minor, patch}
npm publish
git push