TestRail Reporter for Cypress

Publishes Cypress runs on TestRail.

Install

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

Usage

Add reporter to your cypress.json:

...
"reporter": "vn-cypress-testrail-reporter",
"reporterOptions": {
  "domain": "yourdomain.testrail.com",
  "username": "username",
  "password": "password",
  "projectId": idNumber,
  "createTestRun": "boolean",
  "suiteId": suiteNumber,
  "runId": testRunNumber,
  "event": "suite end"
}

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", ...

How to add defect ID for specific test:

// title contains pattern 'cypress-defect=<defect_id>':
it("C123 C124 Can authenticate a valid user cypress-defect=NCT-1234", ...

Add custom comment via the environment variable:

export CUSTOM_COMMENT="http://gitlab.company.com/group/project/-/jobs/188786/raw"

then in the result comment of failed test cases:

http://gitlab.company.com/group/project/-/jobs/188786/raw

Cypress result:

    <error_message>

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.

createTestRun: boolean true if you want to create a new Test Run / false if you only update results to existed Test Run

suiteId: number (optional: required when TestRail project uses multiple test suites to manage cases) suite with which the tests are associated.

runId: number (optional: required when createTestRun = false) Test Run id.

event: string (optional: default value is 'end') emitted event to report result. There are 3 options: 'test end', 'suite end', 'end'.

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.

Author

NGUYEN Viet - github

License

This project is licensed under the MIT license.

Acknowledgments

• Milutin Savovic, author of the cypress-testrail-reporter repository that was cloned.
• 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.