jest-qase-reporter 1.3.0-alpha.4 → 2.0.0-beta.0

package/README.md

@@ -17,7 +17,7 @@ But if necessary, you can independently register the ID of already
 existing test cases from TMS before the executing tests. For example:
 
 ```typescript
-import { qase } from 'jest-qase-reporter/dist/jest';
+import { qase } from 'jest-qase-reporter/jest';
 
 describe('My First Test', () => {
     test(qase([1,2], 'Several ids'), () => {
@@ -37,29 +37,21 @@ describe('My First Test', () => {
     })
 });
 ```
-
-You should also have an active item in the project settings at
-
+To run tests and create a test run, execute the command (for example from folder examples):
+```bash
+QASE_MODE=testops npx jest
 ```
-https://app.qase.io/project/QASE_PROJECT_CODE/settings/options
+or
+```bash
+npm test
 ```
 
-options in the `Test Runs` block:
+<p align="center">
+  <img width="65%" src="./screenshots/screenshot.png">
+</p>
 
-```
-Auto create test cases
-```
-and
-```
-Allow submitting results in bulk
-```
-
-To run tests and create a test run, execute the command:
-```bash
-QASE_REPORT=1 npx jest
-```
-![Output of run](examples/screenshots/screenshot.png)​
 A test run will be performed and available at:
+
 ```
 https://app.qase.io/run/QASE_PROJECT_CODE
 ```
@@ -68,15 +60,18 @@ 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)
-- `environmentId` - Environment ID from Qase TMS
-- `logging` [true/false] - Enabled debug logging from reporter or not
-- `runComplete` [true/false] - Complete run after all tests are finished
+- `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 `jest.config.js` config:
 
@@ -87,12 +82,18 @@ module.exports = {
     [
       'jest-qase-reporter',
       {
-        apiToken: 'api_key',
-        projectCode: 'project_code',
-        runId: 45,
-        environmentId: 1,
-        logging: true,
-        runComplete: true,
+        debug: true,
+        environment: 1,
+        testops: {
+          api: {
+            token: 'api_key'
+          },
+          project: 'project_code',
+          run: {
+            id: 45,
+            complete: true,
+          },
+        },
       },
     ],
   ],
@@ -100,20 +101,24 @@ module.exports = {
 };
 ```
 
-You can check example configuration with multiple reporters in [example project](./examples/jest.config.js).
+You can check example configuration with multiple reporters in [example project](../examples/jest/jest.config.js).
 
 Supported ENV variables:
 
-- `QASE_REPORT` - You **should** pass this ENV if you want to use 
-  qase reporter
-- `QASE_API_TOKEN` - API token
-- `QASE_PROJECT_CODE` - Your project code
-- `QASE_ROOT_SUITE_TITLE` - Setting the root suite that the reporter will use
-- `QASE_RUN_ID` - Pass Run ID from ENV and override reporter options
-- `QASE_ENVIRONMENT_ID` - Pass Environment 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_RUN_COMPLETE` - Complete run after all tests are finished
+- `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/)
+
+`jest >= 28.0.0`
 
 <!-- references -->
 

package/package.json

@@ -1,55 +1,64 @@
 {
   "name": "jest-qase-reporter",
-  "version": "v1.3.0-alpha.4",
+  "version": "2.0.0-beta.0",
   "description": "Qase TMS Jest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./jest": "./dist/jest.js",
+    "./reporter": "./dist/reporter.js",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.d.ts"
+      ],
+      "jest": [
+        "./dist/jest.d.ts"
+      ],
+      "reporter": [
+        "./dist/reporter.d.ts"
+      ]
+    }
+  },
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "bugs": {
     "url": "https://github.com/qase-tms/qase-javascript/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/qase-tms/qase-javascript.git"
+    "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"
-  },
-  "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": "Parviz Khavari <csctclan@gmail.com>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qaseio": "^2.0.0-alpha.5"
+    "lodash.get": "^4.4.2",
+    "lodash.has": "^4.5.2",
+    "qase-javascript-commons": "^2.0.0-beta.0",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@hutson/npm-deploy-git-tag": "^6.0.0",
-    "@jest/reporters": "^27.0.4",
-    "@types/chalk": "^2.2.0",
-    "@types/deasync": "^0.1.1",
-    "@types/jest": "^23.3.7",
-    "@typescript-eslint/eslint-plugin": "^3.10.1",
-    "@typescript-eslint/eslint-plugin-tslint": "^3.10.1",
-    "@typescript-eslint/parser": "^3.10.1",
-    "axios-mock-adapter": "^1.19.0",
-    "chalk": "^4.1.0",
-    "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",
-    "nodemon": "^2.0.6",
-    "ts-jest": "^26.4.4",
-    "typescript": "^3.9.7"
+    "@jest/globals": "^29.5.0",
+    "@jest/reporters": "^29.5.0",
+    "@jest/test-result": "^29.5.0",
+    "@types/jest": "^29.5.2",
+    "@types/lodash.get": "^4.4.7",
+    "@types/lodash.has": "^4.5.7",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0"
+  },
+  "peerDependencies": {
+    "jest": ">=28.0.0"
   }
 }

package/tsconfig.build.json

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

package/dist/index.d.ts

@@ -1,39 +0,0 @@
-import { Reporter, Test, TestResult } from '@jest/reporters';
-interface QaseOptions {
-    apiToken: string;
-    basePath?: string;
-    rootSuiteTitle?: string;
-    projectCode: string;
-    runId?: string;
-    runPrefix?: string;
-    logging?: boolean;
-    runComplete?: boolean;
-    environmentId?: number;
-}
-declare class QaseReporter implements Reporter {
-    private api;
-    private options;
-    private runId?;
-    private isDisabled;
-    private publishedResultsCount;
-    private preparedTestCases;
-    constructor(_: Record<string, unknown>, _options: QaseOptions);
-    onRunStart(): Promise<void>;
-    onTestResult(_test: Test, testResult: TestResult): Promise<void>;
-    onRunComplete(): Promise<void>;
-    getLastError(): void;
-    private log;
-    private getEnv;
-    private getCaseIds;
-    private logTestItem;
-    private createPreparedForPublishTestsArray;
-    private publishBulkTestResult;
-    private checkProject;
-    private createRunObject;
-    private createRun;
-    private checkRun;
-    private createResultCasesArray;
-    private createHeaders;
-    private getPackageVersion;
-}
-export = QaseReporter;