New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

cypress-qase-reporter

Package Overview
Dependencies
Maintainers
2
Versions
44
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cypress-qase-reporter - npm Package Compare versions

Comparing version

1.4.0
to
1.4.1

4

package.json
{
"name": "cypress-qase-reporter",
"version": "v1.4.0",
"version": "v1.4.1",
"description": "Qase TMS Cypress Reporter",

@@ -42,2 +42,3 @@ "main": "./dist/index.js",

"@typescript-eslint/parser": "^3.10.1",
"ansi-regex": "^6.0.1",
"axios-mock-adapter": "^1.19.0",

@@ -51,2 +52,3 @@ "chalk": "^4.1.0",

"jest": "^26.6.3",
"json-schema": "^0.4.0",
"mocha": "^9.0.0",

@@ -53,0 +55,0 @@ "nodemon": "^2.0.6",

95

README.md

@@ -1,7 +0,7 @@

# [Qase TMS](https://qase.io) Cypress Reporter
> # Qase TMS Cypress reporter
>
> Publish results simple and easy.
[![License](https://lxgaming.github.io/badges/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
## How to integrate
## Installation
```

@@ -11,40 +11,4 @@ npm install cypress-qase-reporter

## Configuration
## Example of usage
Reporter options (* - required):
- *`apiToken` - Token for API access, you can find more information
[here](https://developers.qase.io/#authentication)
- *`projectCode` - Code of your project (can be extracted from main
page of your project: `https://app.qase.io/project/DEMOTR` -
`DEMOTR` is project code here)
- `runId` - Run ID from Qase TMS (also can be got from run URL)
- `logging` [true/false] - Enabled debug logging from reporter or not
Example cypress.json config:
```json
{
"reporter": "cypress-qase-reporter",
"reporterOptions": {
"apiToken": "578e3b73a34f06e84eafea103cd44dc24253b2c5",
"projectCode": "PRJCODE",
"runId": 45,
"logging": true
}
}
```
You can check example configuration with multiple reporters in [demo project](./demo/cypress.json)
Supported ENV variables:
- `QASE_REPORT` - You **should** pass this ENV if you want to use
qase reporter
- `QASE_RUN_ID` - Pass Run ID from ENV and override reporter options
- `QASE_RUN_NAME` - Set custom Run name, when new run is created
- `QASE_RUN_DESCRIPTION` - Set custom Run description, when new run is created
## Using Reporter
If you want to decorate come test with Qase Case ID you could use qase function:

@@ -80,5 +44,3 @@

## Running Qase Reporter
To start cypress run with qase reporter run it like this:
To run tests and create a test run, execute the command:
```bash

@@ -89,1 +51,46 @@ QASE_REPORT=1 npx cypress run

![Reporter in console](docs/stdout.png)
A test run will be performed and available at:
```
https://app.qase.io/run/QASE_PROJECT_CODE
```
## Configuration
Reporter options (* - required):
- *`apiToken` - Token for API access, you can find more information
[here](https://developers.qase.io/#authentication)
- *`projectCode` - Code of your project (can be extracted from main
page of your project: `https://app.qase.io/project/DEMOTR` -
`DEMOTR` is project code here)
- `runId` - Run ID from Qase TMS (also can be got from run URL)
- `logging` [true/false] - Enabled debug logging from reporter or not
Example `cypress.json` config:
```json
{
"reporter": "cypress-qase-reporter",
"reporterOptions": {
"apiToken": "api_key",
"projectCode": "project_code",
"runId": 45,
"logging": true
}
}
```
You can check example configuration with multiple reporters in [demo project](./demo/cypress.json).
Supported ENV variables:
- `QASE_REPORT` - You **should** pass this ENV if you want to use
qase reporter
- `QASE_RUN_ID` - Pass Run ID from ENV and override reporter options
- `QASE_RUN_NAME` - Set custom Run name, when new run is created
- `QASE_RUN_DESCRIPTION` - Set custom Run description, when new run is created
<!-- references -->
[auth]: https://developers.qase.io/#authentication