cucumberjs-qase-reporter 0.2.8-alpha.1 → 2.0.0-beta.0

package/README.md

@@ -36,34 +36,17 @@ Feature: Cucumber documentation
         Then I should see a "Build Status" badge
         And I should see a "Dependencies" badge
 ```
-
-You should also have an active item in the project settings at
-
-```
-https://app.qase.io/project/QASE_PROJECT_CODE/settings/options
-```
-
-options in the `Test Runs` block:
-
-```
-Auto create test cases
-```
-and
-
-```
-Allow submitting results in bulk
-```
 ---
-To run tests and create a test run, execute the command (for example from folder examples):
+To run tests and create a test run, execute the command (for example from folder examples/cucumberjs):
 ```bash
-cucumber-js -f cucumberjs-qase-reporter --format-options='{\"qaseConfig\": \"./.qaserc\"}' features -r examples/zombie/support -r examples/zombie/steps
+QASE_MODE=testops cucumber-js -f cucumberjs-qase-reporter:/dev/null features -r zombie/support -r zombie/steps --publish-quiet
 ```
 or
 ```bash
 npm test
 ```
 <p align="center">
-  <img width="65%" src="./examples/screenshots/screenshot.png">
+  <img width="65%" src="./screenshots/screenshot.png">
 </p>
 
 A test run will be performed and available at:
@@ -73,56 +56,53 @@ https://app.qase.io/run/QASE_PROJECT_CODE
 ```
 
 <p align="center">
-  <img src="./examples/screenshots/demo.gif">
+  <img src="./screenshots/demo.gif">
 </p>
 
 ## Configuration
 
 Qase reporter supports passing parameters using two ways:
-using `.qaserc` file and using ENV variables.
+using `.qaserc`/`qase.config.json` file and using ENV variables.
 
-`.qaserc` parameters:
-- `enabled` - Enable reporter
-- `basePath` - URL Qase.io
-- `environmentId` - To execute with the sending of the envinroment information
-- `apiToken` - Token for API access, you can find more information
+`.qaserc` parameters, (* - required):
+- `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
+- *`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` - Pass Run ID
-- `runName` - Set custom Run name, when new run is created.
-  Supported parameters:
-    - `%DATE%`
-- `runDescription` - Set custom Run description, when new run is created
-- `logging` - Enabled debug logging from reporter or not
-- `rootSuiteTitle` - A parent suite for your autocreated tests
+- `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
 
 Example configuration file:
+
 ```json
 {
-  "enabled": true,
-  "logging": true,
-  "apiToken": "api_key",
-  "projectCode": "project_code",
-  "runName": "CucumberJS run %DATE%",
-  "environmentId": 1,
-  "basePath": "https://api.qase.io/v1"
+  "debug": true,
+  "environment": 1,
+  "testops": {
+    "api": {
+      "token": "api_key"
+    },
+    "project": "project_code"
+  }
 }
 ```
 
 Supported ENV variables:
 
-- `QASE_ENABLED` - Same as `enabled`
-- `QASE_API_BASE_URL` - Same as `basePath`
-- `QASE_API_TOKEN` - Same as `apiToken`
-- `QASE_PROJECT` - Same as `projectCode`
-- `QASE_RUN_ID` - Pass Run ID from ENV and override reporter options
-- `QASE_RUN_NAME` - Same as `runName`
-- `QASE_RUN_DESCRIPTION` - Same as `runDescription`
-- `QASE_ENVIRONMENT_ID` - Same as `environmentId`
-- `QASE_LOGGING` - Same as `logging`
-- `QASE_ROOT_SUITE_TITLE` - Same as `rootSuiteTitle`
+- `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`
 
 To run using ENV you have to execute:
 ```bash
@@ -153,8 +133,13 @@ exports.config = {
 }
 ```
 
-**Do not forget to add .qaserc file!**
+**Do not forget to add `.qaserc`/`qase.config.json` file!**
+
+## 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/)
 <!-- references -->
 
+`@cucumber/cucumber >= 7.0.0`
+
 [auth]: https://developers.qase.io/#authentication

package/package.json

@@ -1,63 +1,54 @@
 {
   "name": "cucumberjs-qase-reporter",
-  "version": "v0.2.8-alpha.1",
+  "version": "2.0.0-beta.0",
   "description": "Qase TMS CucumberJS Reporter",
+  "homepage": "https://github.com/qase-tms/qase-javascript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "homepage": "",
+  "exports": {
+    ".": "./dist/index.js",
+    "./reporter": "./dist/reporter.js",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.d.ts"
+      ],
+      "reporter": [
+        "./dist/reporter.d.ts"
+      ]
+    }
+  },
   "bugs": {
-    "url": "https://github.com/qase-tms/qase-javascript/"
+    "url": "https://github.com/qase-tms/qase-javascript/issues"
   },
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "git+https://github.com/qase-tms/qase-javascript.git"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=14"
   },
   "scripts": {
-    "dev": "npm run lint && tsc",
-    "dev:watch": "nodemon --exec 'npm run dev || exit 1'",
-    "lint": "eslint src/**",
-    "lint:fix": "eslint --fix src/**",
-    "build": "npm run clean && npm run dev",
-    "test": "jest --coverage",
-    "clean": "rm -rf dist || true",
-    "example": "npm run build && cd examples && npm run test-zombie"
-  },
-  "author": {
-    "name": "Parviz Khavari",
-    "email": "havaripa@gmail.com"
+    "build": "npm run clean && tsc --project tsconfig.build.json",
+    "lint": "eslint .",
+    "test": "jest --passWithNoTests",
+    "clean": "rm -rf dist"
   },
+  "author": "Parviz Khavari <havaripa@gmail.com>",
   "license": "Apache-2.0",
-  "devDependencies": {
-    "@cucumber/cucumber": "^7.0.0",
-    "@cucumber/messages": "^14.0.1",
-    "@hutson/npm-deploy-git-tag": "^6.0.0",
-    "@types/jest": "^23.3.7",
-    "@types/long": "^4.0.1",
-    "@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",
-    "eslint": "^7.17.0",
-    "eslint-plugin-jsdoc": "^26.0.1",
-    "eslint-plugin-prefer-arrow": "^1.2.1",
-    "handlebars": "^4.7.7",
-    "jest": "^26.6.3",
-    "json-schema": "^0.4.0",
-    "long": "^4.0.0",
-    "nodemon": "^2.0.7",
-    "ts-jest": "^26.4.4",
-    "typescript": "^3.9.3"
-  },
   "dependencies": {
-    "chalk": "^4.1.0",
-    "file-type": "^17.1.1",
-    "mime-types": "^2.1.35",
-    "moment": "^2.29.1",
-    "qaseio": "^2.0.1",
-    "read-chunk": "^4.0.2"
+    "@cucumber/messages": "^22.0.0",
+    "qase-javascript-commons": "^2.0.0-beta.0"
+  },
+  "peerDependencies": {
+    "@cucumber/cucumber": ">=7.0.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.2",
+    "jest": "^29.5.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,36 +0,0 @@
-import { Formatter } from '@cucumber/cucumber';
-import { IFormatterOptions } from '@cucumber/cucumber/lib/formatter';
-declare class QaseReporter extends Formatter {
-    private readonly config;
-    private api;
-    private enabled;
-    private pickleInfo;
-    private testCaseStarts;
-    private testCaseStartedResult;
-    private testCaseStartedAttachment;
-    private testCaseStartedErrors;
-    private testCaseScenarioId;
-    private pending;
-    private results;
-    private scenarios;
-    private uploadsInQueueCount;
-    constructor(options: IFormatterOptions);
-    private waitUploads;
-    private upload;
-    private publishResults;
-    private addErrorMessage;
-    private _log;
-    private checkProject;
-    private createRun;
-    private createRunObject;
-    private checkRun;
-    private saveRunId;
-    private logTestItem;
-    private addForSending;
-    private addKnownCasesForSending;
-    private addNewCasesForSending;
-    private extractIds;
-    private createHeaders;
-    private getPackageVersion;
-}
-export = QaseReporter;