cypress-qase-reporter 1.4.3 → 2.0.0-beta.0

package/README.md

@@ -13,7 +13,7 @@ npm install cypress-qase-reporter
 If you want to decorate come test with Qase Case ID you could use qase function:
 
 ```typescript
-import { qase } from 'cypress-qase-reporter/dist/mocha';
+import { qase } from 'cypress-qase-reporter';
 
 describe('My First Test', () => {
     qase([1,2],
@@ -40,8 +40,12 @@ describe('My First Test', () => {
 
 ```
 If you are going to use several specifications for execution and you have in config 
-```bash
-"runComplete": true
+```json
+"testops": {
+  "run": {
+    "complete": true
+  }
+}
 ```
 then it is necessary to additionally set in the project settings
 ```
@@ -50,14 +54,14 @@ Allow to add results for cases in closed runs.
 
 To run tests and create a test run, execute the command (for example from folder examples):
 ```bash
-QASE_REPORT=1 npx cypress run
+QASE_MODE=testops npx cypress run
 ```
 or
 ```bash
 npm test
 ```
 <p align="center">
-  <img width="65%" src="examples_cypress_v10/screenshots/screenshot.png">
+  <img width="65%" src="./screenshots/screenshot.png">
 </p>
 
 A test run will be performed and available at:
@@ -70,40 +74,40 @@ https://app.qase.io/run/QASE_PROJECT_CODE
 
 Reporter options (* - required):
 
-- *`apiToken` - Token for API access, you can find more information
+- `mode` - `testops`/`off` Enables reporter, default - `off`
+- `debug` - Enables debug logging, defaule - `false`
+- `environment` - To execute with the sending of the envinroment information
+- *`testops.api.token` - 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` - 
+- *`testops.project` - 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
+- `testops.uploadAttachments` - Permission to send screenshots to Qase TMS
+- `testops.run.id` - Pass Run ID
+- `testops.run.title` - Set custom Run name, when new run is created
+- `testops.run.description` - Set custom Run description, when new run is created
+- `testops.run.complete` - Whether the run should be completed
+- `framework.cypress.screenshotFolder` - Folder for save screenshot cypress
 
-#### You can check example configuration with multiple reporters in [demo project (cypress v10)](examples_cypress_v10/cypress.config.js) and [demo project (cypress v6)](examples_cypress_v6/cypress.json).
+#### You can check example configuration with multiple reporters in [demo project](../examples/cypress/cypress.config.js).
 
 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
+- `QASE_MODE` - Same as `mode`
+- `QASE_DEBUG` - Same as `debug`
+- `QASE_ENVIRONMENT` - Same as `environment`
+- `QASE_TESTOPS_API_TOKEN` - Same as `testops.api.token`
+- `QASE_TESTOPS_PROJECT` - Same as `testops.project`
+- `QASE_TESTOPS_RUN_ID` - Pass Run ID from ENV and override reporter option `testops.run.id`
+- `QASE_TESTOPS_RUN_TITLE` - Same as `testops.run.title`
+- `QASE_TESTOPS_RUN_DESCRIPTION` - Same as `testops.run.description`
 
 ## Requirements
 
 We maintain the reporter on LTS versions of Node. You can find the current versions by following the [link](https://nodejs.org/en/about/releases/)
 
+`cypress >= 8.0.0`
+
 <!-- references -->
 
 [auth]: https://developers.qase.io/#authentication

package/package.json

@@ -1,58 +1,61 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "v1.4.3",
-  "description": "Qase TMS Cypress Reporter",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "homepage": "https://github.com/qase-tms/qase-cypress",
+  "version": "2.0.0-beta.0",
+  "description": "Qase Cypress Reporter",
+  "homepage": "https://github.com/qase-tms/qase-javascript",
+  "sideEffects": false,
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.cjs.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./mocha": "./dist/mocha.js",
+    "./reporter": "./dist/reporter.js",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.d.ts"
+      ],
+      "mocha": [
+        "./dist/mocha.d.ts"
+      ],
+      "reporter": [
+        "./dist/reporter.d.ts"
+      ]
+    }
+  },
   "bugs": {
-    "url": "https://github.com/qase-tms/qase-cypress/issues"
+    "url": "https://github.com/qase-tms/qase-javascript/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/qase-tms/qase-cypress.git"
+    "url": "git+https://github.com/qase-tms/qase-javascript.git"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "scripts": {
-    "dev": "npm run lint && tsc && cp ./src/reportBulk.js ./dist",
-    "dev:watch": "nodemon --exec 'npm run dev || exit 1'",
-    "lint": "eslint --fix src/**",
-    "build": "npm run clean && npm run dev",
-    "test": "jest --coverage",
-    "clean": "rm -rf dist || true"
-  },
-  "author": {
-    "name": "Parviz Khavari",
-    "email": "csctclan@gmail.com"
+    "build": "npm run clean && tsc --project tsconfig.build.json",
+    "lint": "eslint .",
+    "test": "jest --passWithNoTests",
+    "clean": "rm -rf dist"
   },
+  "author": "Nikita Fedorov <nik333r@gmail.com>",
   "license": "Apache-2.0",
   "dependencies": {
-    "form-data": "^4.0.0",
-    "qaseio": "^2.0.2"
+    "qase-javascript-commons": "^2.0.0-beta.0"
+  },
+  "peerDependencies": {
+    "cypress": ">=8.0.0"
   },
   "devDependencies": {
-    "@hutson/npm-deploy-git-tag": "^6.0.0",
-    "@types/chalk": "^2.2.0",
-    "@types/jest": "^23.3.7",
-    "@types/mocha": "^7.0.2",
-    "@typescript-eslint/eslint-plugin": "^3.10.1",
-    "@typescript-eslint/eslint-plugin-tslint": "^3.10.1",
-    "@typescript-eslint/parser": "^3.10.1",
-    "ansi-regex": "^6.0.1",
-    "axios-mock-adapter": "^1.19.0",
-    "chalk": "^4.1.0",
-    "cypress": "^4.12.1",
-    "eslint": "^7.14.0",
-    "eslint-plugin-jsdoc": "^26.0.1",
-    "eslint-plugin-prefer-arrow": "^1.2.2",
-    "handlebars": "^4.7.7",
-    "jest": "^26.6.3",
-    "json-schema": "^0.4.0",
-    "mocha": "^9.0.0",
-    "nodemon": "^2.0.6",
-    "ts-jest": "^26.4.4",
-    "typescript": "^3.9.7"
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.2",
+    "@types/mocha": "^10.0.1",
+    "ajv": "^8.12.0",
+    "jest": "^29.5.0",
+    "mocha": "^10.2.0",
+    "ts-jest": "^29.1.0"
   }
 }

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+
+  "compilerOptions": {
+    "noEmit": false
+  },
+
+  "include": ["./src/**/*.ts"]
+}

package/dist/index.d.ts

@@ -1,28 +0,0 @@
-import { MochaOptions, Runner, reporters } from 'mocha';
-declare class CypressQaseReporter extends reporters.Base {
-    testCasesForPublishingCount: number;
-    private api;
-    private pending;
-    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 getSuitePath;
-    private static getPackageVersion;
-    private log;
-    private addRunnerListeners;
-    private checkProject;
-    private createRun;
-    private checkRun;
-    private saveRunId;
-    private logTestItem;
-    private transformCaseResultToBulkObject;
-}
-export = CypressQaseReporter;