TestRail Reporter for Cypress

Publishes Cypress runs on TestRail.

NOTES:

• Use Vivify-Ideas' cypress-testrail-reporter first, before trying this repo here.
• This would've been a proper fork of Vivify-Ideas' repo, if I didn't need to actually fix their v1.2.3 for the recent breaking API changes from TestRail. This repo started as an export of their repo at v.1.2.3.

Install

npm install cy-tr-reporter --save-dev

or

yarn add cy-tr-reporter --dev

[Below is Vivify-Ideas' original README content, with some udpates to Authors]

Usage

Add reporter to your cypress.json:

...
"reporter": "cy-tr-reporter",
"reporterOptions": {
  "host": "https://yourdomain.testrail.com",
  "username": "username",
  "password": "password",
  "projectId": 1,
  "suiteId": 1,
}

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

host: string host of your TestRail instance (e.g. for a hosted instance https://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. When you set CYPRESS_TESTRAIL_REPORTER_PASSWORD in runtime environment variables, this option would be overwritten with it.

projectId: number project with which the tests are associated.

suiteId: number suite with which the tests are associated.

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

includeAllInTestRun: bool (optional: default is true) will return all test cases in test run. set to false to return test runs based on filter or section/group.

groupId: string (optional: needs "includeAllInTestRun": false ) The ID of the section/group

filter: string (optional: needs "includeAllInTestRun": false) Only return cases with matching filter string in the case title

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.

Authors

Tze-chiu Lei - github - publisher of this repo. Milutin Savovic - github - author of the original cypress-testrail-reporter (see below). Anes Topcic - github - author of the fix for API-response changes in recent TestRail 7.2 upgrade.

License

This project is licensed under the MIT license.

Acknowledgments

• Vivify-Ideas, owner of the cypress-testrail-reporter repository, on which this project was based.