TestRail Reporter for Cypress

Publishes Cypress runs on TestRail.

Install

$ npm install stu-cypress-testrail-reporter --save-dev 

Usage

Add reporter to your cypress.json:

...
"reporter": "stu-cypress-testrail-reporter",
"reporterOptions": {
  "domain": "yourdomain.testrail.io",
  "username": "username",
  "password": "password",
  "projectId": 1,
  "suiteId": 1,
  "runId": 1,
  "runName": "My Automated Tests: ",
  "includeAll": false,
  "caseIds": [1, 4, 5, 10]
}

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.

runId: string id of the Testrail run.

runName: string (optional) name of the Testrail run.

includeAll: boolean (optional) whether to include all tests in test run;

caseIds: Array (optional) An array of case IDs for the custom case selection;

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.

If you maintain your own TestRail instance on your own server, it is recommended to enable HTTPS for your TestRail installation.

For TestRail hosted accounts maintained by Gurock, all accounts will automatically use HTTPS.

You can read the whole TestRail documentation here.

Enhancements from cypress-testrail-reporter

Instead of creating a new test run each time automated tests are run in cypress, the nominated test run (runId) will be updated everytime to reflect the latest state of the tests.

Author

Stuart Richardson - github

License

This project is licensed under the MIT license.

Acknowledgments

• Milutin Savovic Author of [cypress-testrail-reporter]
• Pierre Awaragi, owner of the mocha-testrail-reporter repository that was forked.
• Valerie Thoma and Aileen Santos for proofreading the README.md file and making it more understandable.