autoset-status-cypress-testrail-reporter

TestRail Reporter for specific TestRun for Cypress

Publishes Cypress runs on TestRail.

Cloned from the original package cypress-testrail-reporter by Milutin Savovic

The original package by Milutin is awesome!

Allows you to set statuses for test cases in a specific TestRun.

Install

$ npm i autoset-status-cypress-testrail-reporter

Usage

Add reporter to your cypress.json:

...
{
  "reporter": "autoset-status-cypress-testrail-reporter",
  "reporterOptions": {
    "host": "https://yourdomain.testrail.io",
    "username": "username",
    "password": "password",
    "projectId": idNumber,
    "runId": testRunNumber,
  }
}

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 domain name 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.

projectId: number project with which the tests are associated.

runId: number a specific test run id number.

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

Author: Dmytro Kuznetsov - 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.