cypress-testrail

Cypress TestRail Integration

This integration helps you to automatically send test results to TestRail.

Simply add your TestRail credentials in Cypress, decide which test results should be sent to TestRail and you're done!

This is a TestRail-driven workflow, so your QA team will always be in charge of the TestRail documentation and Cypress will only work as a testing client and does not modify anything in your test cases anymore.

Define new test cases in TestRail, and add automation to it, when you are ready.

1. Installation

npm i cypress-testrail

2. Setup TestRail credentials

Now configure your credentials for the TestRail API. Just add this snippet in your Cypress.env.json file and adjust the values. Please keep in mind, the runId is always the test run, that you want to send the results to. You can find the ID inside the test run in TestRail. It usually starts with an R, like "R68".

{
  "testrail": {
    "domain": "my-company.testrail.io",
    "username": "myUser",
    "password": "myPwd",
    "runId": "12345"
  }
}

3. Register Plugin

Just place this line in your support/index.js file. There's nothing more that is required to register the TestRail reporter.

import 'cypress-testrail';

4. Map Test Cases

We're almost done. You can now map TestRail test cases to your Cypress tests. Please use the TestRail case ID as a prefix inside the Cypress tests. The plugin will automatically extract it, and send the results to your test run in TestRail.

it('C123: My Test for TestRail XYZ', () => {

    cy.get('#sw-field--name').type('John');
    // ...
    // ...
    
})

That's it!

You can now start Cypress (restart after config changes), and all your results should be sent to TestRail as soon as your mapped tests pass or faiil!

Copying / License

This repository is distributed under the MIT License (MIT). You can find the whole license text in the LICENSE file.