Testrail Reporter for Cypress

Pushes test results into TestRail system.

Install

$ npm i -D cypress-testrail-reporter

Usage

Add reporter to the cypress.json:

"reporter": "cypress-testrail-reporter",
"reporterOptions": {
  "domain": "yourdomain.testrail.com",
  "username": "username",
  "password": "password",
  "projectId": 1,
  "suiteId": 1,
}

Your Cypress tests should include ID of a TestRail test cases. Make sure your test case ids are distinct from the test titles:

it("C123 C124 Can authenticate with invalid user", . . .
it("Can authenticate a valid user C321", . . .

Reporter Options

domain: string domain name of your TestRail instance (e.g. for a hosted instance instance.testrail.net)

username: string email of a user under which the test run will be created

password: string password or the API key for the aforementioned user

projectId: number projet with which the tests are associated

suiteId: number suite with which the tests are associated

runName: string (optional) name of the Testrail run

TestRail Settings

To increase security, TestRail team suggests using an API key instead of the 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

• Milutin Savovic - Initial setup - github

License

This project is licensed under the MIT License

Acknowledgments

• Pierre Awaragi who owns the mocha-testrail-reporter repository that was forked