##Testrail Reporter for Cypress

Pushes test results into Testrail system. Forked from mocha testrail reporter

Installation

$ npm i -D cypress-testrail-reporter

Usage

Ensure that your testrail installation API is enabled and generate your API keys. See Username and API Key

Add reporter to cypress.json:

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

Mark your Cypress test names with ID of a Testrail test cases. Ensure that your case ids are well distinct from test descriptions.

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

Only passed or failed tests will be published. Skipped or pending tests will not be published resulting in a "Pending" status in testrail test run.

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 number with which the tests are associated

suiteId: number suite number with which the tests are associated

runName: number (optional) name of the Testrail run

References

• https://github.com/awaragi/mocha-testrail-reporter
• http://mochajs.org/#mochaopts
• https://github.com/mochajs/mocha/wiki/Third-party-reporters
• http://docs.gurock.com/testrail-api2/start