@anestopcic/cypress-testrail-reporter-ms NPM

TestRail Reporter for Cypress

Publishes Cypress runs on TestRail.

Install

$ npm install @anestopcic/cypress-testrail-reporter-ms --save-dev

Usage

Add reporter to your cypress.json:

...
"reporter": "@anestopcic/cypress-testrail-reporter-ms",
"reporterOptions": {
  "domain": "yourdomain.testrail.com",
  "username": "username",
  "password": "password",
  "projectId": 1,
}

This reporter can handle multiple suite project. In order to use it you should pass testRailSuiteId argument when you define all other CLI agruments during cypress execution. testRailSuiteId can be set before every pipeline job or predefined for each test file for which suiteId belongs to.

Example:

CYPRESS_OPTIONS="baseUrl=${url},trashAssetsBeforeRuns=false,video=${video},screenshotOnRunFailure=${screenshotOnRunFailure}"
CYPRESS_ENV="testRailSuiteId=${TESTRAIL_SUITEID}"

npx cypress run --headed --browser chrome --config "${CYPRESS_OPTIONS}" --env="${CYPRESS_ENV}"

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