npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

send-cypress-testrail-reporter

v1.0.0

Published

A Testrail reporter for cypress including TestRail API basic library

Downloads

826

Readme

TestRail Reporter for Cypress

version downloads MIT License

Publishes Cypress runs on TestRail.

Install

$ npm i send-cypress-testrail-reporter --save-dev

Usage

Add reporter to your cypress.json:

...
"reporter": "send-cypress-testrail-reporter",
"reporterOptions": {
  "domain": "yourdomain.testrail.com",
  "username": "username",
  "password": "password",
  "projectId": idNumber,
  "createTestRun": "boolean",
  "suiteId": suiteNumber,
  "runId": testRunNumber,
  "event": "suite end"
}

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

How to add defect ID for specific test:

// title contains pattern 'cypress-defect=<defect_id>':
it("C123 C124 Can authenticate a valid user cypress-defect=NCT-1234", ...

Add custom comment via the environment variable:

export CUSTOM_COMMENT="http://gitlab.company.com/group/project/-/jobs/188786/raw"

then in the result comment of failed test cases:

http://gitlab.company.com/group/project/-/jobs/188786/raw

Cypress result:

    <error_message>

Reporter Options

domain: string domain name of your TestRail instance (e.g. for a hosted instance 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.

createTestRun: boolean true if you want to create a new Test Run / false if you only update results to existed Test Run

suiteId: number (optional: required when TestRail project uses multiple test suites to manage cases) suite with which the tests are associated.

runId: number (optional: required when createTestRun = false) Test Run id.

event: string (optional: default value is 'end') emitted event to report result. There are 3 options: 'test end', 'suite end', 'end'.

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

Lyn

License

This project is licensed under the MIT license.

Acknowledgments