cypress-qase-reporter 1.3.3 → 1.4.2-alpha.2

package/README.md

@@ -1,50 +1,14 @@
-# [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)
-
-## Installation
+## How to integrate
 
 ```
 npm install cypress-qase-reporter
 ```
 
-## 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": "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
+## Example of usage
 
 If you want to decorate come test with Qase Case ID you could use qase function:
 
@@ -74,13 +38,91 @@ describe('My First Test', () => {
     );
 });
 
+```
+You should also have an active item in the project settings at
+```
+https://app.qase.io/project/QASE_PROJECT_CODE/settings/options
+```
+option in the `Test Runs` block:
+```
+Allow submitting results in bulk
+```
+If you are going to use several specifications for execution and you have in config 
+```bash
+"runComplete": true
+```
+then it is necessary to additionally set in the project settings
+```
+Allow to add results for cases in closed runs.
 ```
 
-## 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 (for example from folder examples):
 ```bash
 QASE_REPORT=1 npx cypress run
 ```
+or
+```bash
+npm test
+```
+<p align="center">
+  <img width="65%" src="./examples/screenshots/screenshot.png">
+</p>
+
+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
+- `environmentId` - To execute with the sending of the envinroment information
+- `basePath` - URL Qase.io
+- `screenshotFolder` - Folder for save screenshot cypress,
+- `sendScreenshot` [true/false] - Permission to send screenshots to Qase TMS
+- `runComplete` [true/false] - Permission for automatic completion of the test run
+
+Example `cypress.json` config:
+
+```json
+{
+    "reporter": "cypress-qase-reporter",
+    "reporterOptions": {
+        "apiToken": "api_key",
+        "projectCode": "project_code",
+        "runId": 45,
+        "logging": true,
+        "basePath": "https://api.qase.io/v1"
+    }
+}
+```
+
+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
+- `QASE_API_TOKEN` - Token for API access, you can find more information
+  [here](https://developers.qase.io/#authentication)
+- `QASE_API_BASE_URL` - URL Qase.io, default value `https://api.qase.io/v1`
+- `QASE_ENVIRONMENT_ID` - To execute with the sending of the envinroment information
+- `QASE_SCREENSHOT_FOLDER` - Folder for save screenshot cypress
+ - `QASE_SCREENSHOT_SENDING` - Permission to send screenshots to Qase TMS
+ - `QASE_RUN_COMPLETE` - Permission for automatic completion of the test run
+
+<!-- references -->
 
-![Reporter in console](docs/stdout.png)
+[auth]: https://developers.qase.io/#authentication

package/dist/index.d.ts

@@ -1,21 +1,27 @@
 import { MochaOptions, Runner, reporters } from 'mocha';
 declare class CypressQaseReporter extends reporters.Base {
+    testCasesForPublishingCount: number;
     private api;
     private pending;
-    private results;
     private shouldPublish;
+    private results;
     private options;
     private runId?;
+    private isDisabled;
+    private resultsForPublishing;
     constructor(runner: Runner, options: MochaOptions);
+    private static getEnv;
+    private static getCaseId;
+    private static createRunObject;
+    private static createHeaders;
+    private static getPackageVersion;
     private log;
     private addRunnerListeners;
     private checkProject;
     private createRun;
     private checkRun;
-    private getEnv;
     private saveRunId;
-    private getCaseId;
     private logTestItem;
-    private publishCaseResult;
+    private transformCaseResultToBulkObject;
 }
 export = CypressQaseReporter;