Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@reportportal/agent-js-cypress
Advanced tools
@reportportal/agent-js-cypress - npm Package Compare versions
Comparing version 5.1.2 to 5.1.3
@@ -80,8 +80,18 @@ /* | ||
| const { apiKey, token, ...reporterOptions } = initialConfig.reporterOptions; | ||
| let calculatedApiKey = process.env.RP_API_KEY || apiKey; | ||
| if (!calculatedApiKey) { | ||
| calculatedApiKey = process.env.RP_TOKEN || token; | ||
| if (calculatedApiKey) { | ||
| console.warn('ReportPortal warning. Option "token" is deprecated. Use "apiKey" instead.'); | ||
| } | ||
| } | ||
| return { | ||
| ...initialConfig, | ||
| reporterOptions: { | ||
| ...initialConfig.reporterOptions, | ||
| ...reporterOptions, | ||
| attributes, | ||
| token: process.env.RP_TOKEN || initialConfig.reporterOptions.token, | ||
| apiKey: calculatedApiKey, | ||
| }, | ||
@@ -88,0 +98,0 @@ }; |
| { | ||
| "name": "@reportportal/agent-js-cypress", | ||
| "version": "5.1.2", | ||
| "version": "5.1.3", | ||
| "description": "This agent helps Cypress to communicate with Report Portal", | ||
@@ -17,3 +17,3 @@ "main": "index.js", | ||
| "dependencies": { | ||
| "@reportportal/client-javascript": "^5.0.8", | ||
| "@reportportal/client-javascript": "^5.0.12", | ||
| "glob": "^7.2.3", | ||
@@ -30,15 +30,19 @@ "minimatch": "^3.1.2", | ||
| ], | ||
| "engines": { | ||
| "node": ">=10.x" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "devDependencies": { | ||
| "cypress": "10.8.0", | ||
| "eslint": "6.5.1", | ||
| "eslint-config-airbnb-base": "14.0.0", | ||
| "eslint-config-prettier": "6.9.0", | ||
| "eslint-plugin-cypress": "2.8.1", | ||
| "eslint-plugin-import": "2.20.0", | ||
| "eslint-plugin-jest": "^23.8.1", | ||
| "eslint-plugin-prettier": "3.1.2", | ||
| "jest": "^28.1.3", | ||
| "mock-fs": "^4.11.0", | ||
| "prettier": "1.19.1" | ||
| "@types/jest": "^29.5.3", | ||
| "cypress": "^12.17.1", | ||
| "eslint": "^8.45.0", | ||
| "eslint-config-airbnb-base": "^15.0.0", | ||
| "eslint-config-prettier": "^8.8.0", | ||
| "eslint-plugin-cypress": "2.12.1", | ||
| "eslint-plugin-import": "^2.27.5", | ||
| "eslint-plugin-jest": "^23.20.0", | ||
| "eslint-plugin-prettier": "^4.2.1", | ||
| "jest": "^29.6.1", | ||
| "mock-fs": "^4.14.0", | ||
| "prettier": "^2.8.8" | ||
| }, | ||
@@ -45,0 +49,0 @@ "keywords": [ |
| # @reportportal/agent-js-cypress | ||
| `agent-js-cypress` is a runtime reporter for the [Report Portal](https://github.com/reportportal/reportportal) which provides information about collection run. | ||
| Agent to integrate Cypress with ReportPortal. | ||
| * More about [Cypress](https://cypress.io/) | ||
@@ -10,3 +10,3 @@ * More about [ReportPortal](http://reportportal.io/) | ||
| ```console | ||
| $ npm install @reportportal/agent-js-cypress | ||
| $ npm install --save-dev @reportportal/agent-js-cypress | ||
| ``` | ||
@@ -33,3 +33,3 @@ | ||
| endpoint: 'http://your-instance.com:8080/api/v1', | ||
| token: '00000000-0000-0000-0000-000000000000', | ||
| apiKey: 'reportportalApiKey', | ||
| launch: 'LAUNCH_NAME', | ||
@@ -83,3 +83,3 @@ project: 'PROJECT_NAME', | ||
| "endpoint": "http://your-instance.com:8080/api/v1", | ||
| "token": "00000000-0000-0000-0000-000000000000", | ||
| "apiKey": "reportportalApiKey", | ||
| "launch": "LAUNCH_NAME", | ||
@@ -107,7 +107,5 @@ "project": "PROJECT_NAME", | ||
| ```javascript | ||
| const registerReportPortalPlugin = require('@reportportal/agent-js-cypress/lib/plugin'); | ||
| module.exports = (on, config) => registerReportPortalPlugin(on, config); | ||
| ``` | ||
@@ -120,5 +118,3 @@ | ||
| ```javascript | ||
| require('@reportportal/agent-js-cypress/lib/commands/reportPortalCommands'); | ||
| ``` | ||
@@ -128,22 +124,24 @@ | ||
| Reporter support following options: | ||
| The full list of available options presented below. | ||
| | Parameter | Description | | ||
| |-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | token | (required) User's Report Portal token from which you want to send requests. It can be found on the profile page of this user. | | ||
| | endpoint | (required) URL of your server. For example 'https://server:8080/api/v1'. | | ||
| | launch | (required) Name of launch at creation. | | ||
| | project | (required) The name of the project in which the launches will be created. | | ||
| | attributes | (optional) *Default: [].* Launch attributes. | | ||
| | description | (optional) *Default: not set.* Launch description. | | ||
| | rerun | (optional) *Default: false.* Enable [rerun](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md). | | ||
| | rerunOf | (optional) *Default: not set.* UUID of launch you want to rerun. If not specified, report portal will update the latest launch with the same name. | | ||
| | mode | (optional) *Default: DEFAULT.* Results will be submitting to Launches page<br> *"DEBUG"* - Results will be submitting to Debug page. | | ||
| | debug | (optional) *Default: false.* This flag allows seeing the logs of the client-javascript. Useful for debugging. Parameter could be equal boolean values. | | ||
| | skippedIssue | (optional) *Default: true.* ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side.<br> Parameter could be equal boolean values:<br> *TRUE* - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal (default value).<br> *FALSE* - skipped tests will not be marked as 'To Investigate' on application. | | ||
| | restClientConfig | (optional) *Default: not set.*<br/> The object with `agent` property for configure [http(s)](https://nodejs.org/api/https.html#https_https_request_url_options_callback) client, may contain other client options eg. `timeout`.<br/> Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details. | | ||
| | autoMerge | (optional) *Default: false.* Enable automatic report test items of all runned spec into one launch. You should install plugin or setup additional settings in reporterOptions. See [Automatically merge launch](#automatically-merge-launches). | | ||
| | reportHooks | (optional) *Default: false.* Determines report before and after hooks or not. | | ||
| | isLaunchMergeRequired | (optional) *Default: false.* Allows to merge Cypress run's into one launch at the end of the run. Needs additional setup. See [Manual merge launches](#manual-merge-launches). | | ||
| | parallel | (optional) *Default: false.* Indicates to the reporter that spec files will be executed in parallel. Parameter could be equal boolean values. See [Parallel execution](#parallel-execution). | | ||
| | Option | Necessity | Default | Description | | ||
| |------------------|------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | apiKey | Required | | User's reportportal token from which you want to send requests. It can be found on the profile page of this user. | | ||
| | endpoint | Required | | URL of your server. For example 'https://server:8080/api/v1'. | | ||
| | launch | Required | | Name of launch at creation. | | ||
| | project | Required | | The name of the project in which the launches will be created. | | ||
| | attributes | Optional | [] | Launch attributes. | | ||
| | description | Optional | '' | Launch description. | | ||
| | rerun | Optional | false | Enable [rerun](https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/rerun.md) | | ||
| | rerunOf | Optional | Not set | UUID of launch you want to rerun. If not specified, reportportal will update the latest launch with the same name | | ||
| | mode | Optional | 'DEFAULT' | Results will be submitted to Launches page <br/> *'DEBUG'* - Results will be submitted to Debug page. | | ||
| | skippedIssue | Optional | true | reportportal provides feature to mark skipped tests as not 'To Investigate'. <br/> Option could be equal boolean values: <br/> *true* - skipped tests considered as issues and will be marked as 'To Investigate' on reportportal. <br/> *false* - skipped tests will not be marked as 'To Investigate' on application. | | ||
| | debug | Optional | false | This flag allows seeing the logs of the client-javascript. Useful for debugging. | | ||
| | launchId | Optional | Not set | The _ID_ of an already existing launch. The launch must be in 'IN_PROGRESS' status while the tests are running. Please note that if this _ID_ is provided, the launch will not be finished at the end of the run and must be finished separately. | | ||
| | restClientConfig | Optional | Not set | The object with `agent` property for configure [http(s)](https://nodejs.org/api/https.html#https_https_request_url_options_callback) client, may contain other client options eg. [`timeout`](https://github.com/reportportal/client-javascript#timeout-30000ms-on-axios-requests). <br/> Visit [client-javascript](https://github.com/reportportal/client-javascript) for more details. | | ||
| | autoMerge | Optional | false | Enable automatic report test items of all runned spec into one launch. You should install plugin or setup additional settings in reporterOptions. See [Automatically merge launch](#automatically-merge-launches). | | ||
| | reportHooks | Optional | false | Determines report before and after hooks or not. | | ||
| | isLaunchMergeRequired | Optional | false | Allows to merge Cypress run's into one launch at the end of the run. Needs additional setup. See [Manual merge launches](#manual-merge-launches). | | ||
| | parallel | Optional | false | Indicates to the reporter that spec files will be executed in parallel. Parameter could be equal boolean values. See [Parallel execution](#parallel-execution). | | ||
| | token | Deprecated | Not set | Use `apiKey` instead. | | ||
@@ -159,3 +157,3 @@ ### Overwrite options from config file | ||
| ...config.reporterOptions, | ||
| token: process.env.RP_TOKEN, | ||
| apiKey: process.env.RP_API_KEY, | ||
| }, | ||
@@ -168,7 +166,7 @@ }; | ||
| | Parameter | Env variable | | ||
| |-----------|--------------| | ||
| | token | RP_TOKEN | | ||
| | Option | ENV variable | Note | | ||
| |-------------|-----------------|----------------------------------------| | ||
| | apiKey | RP_API_KEY || | ||
| | token | RP_TOKEN | *deprecated* Use `RP_API_KEY` instead. | | ||
| ## ReportPortal custom commands | ||
@@ -175,0 +173,0 @@ |
New alerts
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.15%
85464
- Lines of code
- increased by4.54%
1519
Worsened metrics
- Dev dependency count
- increased by9.09%
12
- Number of lines in readme file
- decreased by-0.45%
441
- Number of low supply chain risk alerts
- increased by16.67%
7