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

mine-cypress-testrail-reporter

v1.3.10

Published

A Testrail reporter for cypress including TestRail API basic library

Downloads

6

Readme

TestRail Reporter for Cypress

version downloads MIT License

Publishes Cypress runs on TestRail.

Cloned from the original package salty-cypress-testrail-reporter by Milutin Savovic

The original package by Milutin is awesome!

Allows for options to create a new test run on cypress run or if you want the option to create one manually.

Install

$ npm install  mine-cypress-testrail-reporter --save-dev

Usage

Add reporter to your cypress.json:

...
{
  "reporter": "mine-cypress-testrail-reporter",
  "reporterOptions": {
    "domain": "yourdomain.testrail.com",
    "username": "username",
    "password": "password",
    "projectId": idNumber,
    "suiteId": suiteNumber,
    "createTestRun": "boolean",
    "runId": testRunNumber,
    "runName": "Test Run Name"
  }
}

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

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.

suiteId: number suite with which the tests are associated.

createTestRun: boolean true if you want a test run created for you : false if you want to manually create your own test run on TestRail. If you select false, you have to pass a value into the runID property.

runId: number (optional: only necessary if createTestRun is set to true) a specific test run id number.

runName: string (optional) name of the Testrail run.

Functionality Update 01/04/2019

We were having issues where we wanted to run a test run once a day using multiple spec files. However, when createTestRun: true, the testrail reporter would create a testrun for each spec file which is not what we wanted.

I included some logic for when createTestRun: true that checks the most recently created test run in Testrail with the current date you are running your test.

The testrail reporter will create a single testrun for the day and push all results to that newly created testrun.

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

Author: Spencer Kekauoha - github

License

This project is licensed under the MIT license.

Acknowledgments