Cypress-TestRail-Helper (CTH) is a Node-CLI helper-app that makes using vagov-cy-tr-reporter (CTR) much easier. Once you've completed initial integration steps for your Cypress spec-file, you can use CTH to run the spec just by inputting it's filename!

Private app: This is not a public-facing app -- it pushes Cypress test-results to our private TestRail test case management system. You must be a VA employee/contractor officially onboarded to a VA.gov product team, in order to obtain private-systems access.

For basic TestRail help/info, see Platform's TestRail Guide.

You need to do the following before using CTH:

1. Integrate your Cypress spec-file with TestRail -- you should have a TestRail test-case section containing TestRail test-cases which correspond to your spec's tests.

2. Integrate your Cypress spec-file with CTH -- copy the following JSDOC comment-block and prepend to your spec [replacing <placeholders> with your actual values from the previous step]:

   /**
    * [TestRail-integrated] Spec for <spec description>
    * @testrailinfo projectId <your team's TestRail Project ID>
    * @testrailinfo suiteId <your team's TestRail Suite ID>
    * @testrailinfo groupId <your spec's TestRail Group ID>
    * @testrailinfo runName <Run-Name-you-want-to-see-in-TestRail>
    */

   NOTE: Do NOT use spaces for runName. Use dashes/underscores instead to separate words.

   [For an already-integrated example, see hlr-contact-loop.cypress.spec.js.]

3. IF you'll be launching CTH for the first time, gather your team-specific¹ TestRail credentials:

   • TestRail Username
   • TestRail API Key

[See Platform's Cypress to TestRail Reporter Configuration doc for details on Step 1. NOTE: No need to export environment-variables here with CTH; just copy the values somewhere so they're ready for input into CTH.]

For each new spec with which you want to use CTH, just repeat Steps 1-2 above.

1. Start your local vets-website app.

2. Stop your local vets-api app if it's running.

3. In a separate Terminal/shell window, navigate to your vets-website project-root [if your're not there already], then Launch the app: yarn cy:my-testrail-helper

   • If this is your first launch, provide your TestRail Username, TestRail API Key when prompted.
   • If you've used this app before, you can optionally rerun your previous spec by appending the --rerun command-flag: yarn cy:my-testrail-helper --rerun

4. Provide your Cypress spec's filename if prompted. [No need to include path or cypress-extensions (.cypress...); just input the filename.]

5. CTH will execute a child process to run your Cypress spec.

That's it! You'll see the Cypress-run child-process output, and then your user-prompt returns after the child-process exits.

Tip: To quickly check your TestRail Test Run, scroll up the child-process output to (TestRail Reporter) section, then next to [VCTR] Run should be viewable at:, Cmd-click [or Ctrl-click on Windows] the generated URL on the next line.

For any questions about this app, contact Shared-Support QA Engineer Tze-chiu Lei:

• GitHub: tlei123
• Slack:
  • DSVA workspace: Tze-chiu Lei
  • Ad Hoc workspace: Tze Lei

IF this app's not working, open a Bug.