Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dkuznetsov21/autoset-status-cypress-testrail-reporter
https://github.com/dkuznetsov21/autoset-status-cypress-testrail-reporter
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dkuznetsov21/autoset-status-cypress-testrail-reporter
- Owner: dkuznetsov21
- License: mit
- Created: 2020-12-09T14:03:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-27T08:53:20.000Z (over 3 years ago)
- Last Synced: 2024-11-06T23:03:47.654Z (2 months ago)
- Language: TypeScript
- Size: 32.2 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-cypress - Autoset status cypress testrail reporter
README
# TestRail Reporter for specific TestRun for Cypress
[](https://www.npmjs.com/package/autoset-status-cypress-testrail-reporter)
[](https://www.npmjs.com/package/autoset-status-cypress-testrail-reporter)
[](https://github.com/dkuznetsov21/autoset-status-cypress-testrail-reporter/blob/main/LICENSE.md)
Publishes [Cypress](https://www.cypress.io/) runs on TestRail.
Cloned from the original package [cypress-testrail-reporter](https://github.com/Vivify-Ideas/cypress-testrail-reporter) by [Milutin Savovic](https://github.com/mickosav)
The original package by Milutin is awesome!
Allows you to set statuses for test cases in a specific TestRun.
## Install
```shell
$ npm i autoset-status-cypress-testrail-reporter
```
## Usage
Add reporter to your `cypress.json`:
```json
...
{
"reporter": "autoset-status-cypress-testrail-reporter",
"reporterOptions": {
"host": "https://yourdomain.testrail.io",
"username": "username",
"password": "password",
"projectId": idNumber,
"runId": testRunNumber,
}
}
```
Your Cypress tests should include the ID of your TestRail test case. Make sure your test case IDs are distinct from your test titles:
```Javascript
// 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
**host**: _string_ domain name of your TestRail instance (e.g. for a hosted instance _https://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.
**runId**: _number_ a specific test run id number.
## 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](http://docs.gurock.com/testrail-api2/accessing#username_and_api_key).
If you maintain your own TestRail instance on your own server, it is recommended to [enable HTTPS for your TestRail installation](http://docs.gurock.com/testrail-admin/admin-securing#using_https).
For TestRail hosted accounts maintained by [Gurock](http://www.gurock.com/), all accounts will automatically use HTTPS.
You can read the whole TestRail documentation [here](http://docs.gurock.com/).
## Author
Author: Dmytro Kuznetsov - [github](https://github.com/dkuznetsov21)
## License
This project is licensed under the [MIT license](/LICENSE.md).
## Acknowledgments
* [Milutin Savovic](https://github.com/mickosav), author of the [cypress-testrail-reporter](https://github.com/Vivify-Ideas/cypress-testrail-reporter) repository that was cloned.
* [Pierre Awaragi](https://github.com/awaragi), owner of the [mocha-testrail-reporter](https://github.com/awaragi/mocha-testrail-reporter) repository that was forked.