testcafe-reporter-qase 1.2.0-alpha.2 → 2.0.0-beta.0

package/README.md

@@ -18,45 +18,34 @@ existing test cases from TMS before the executing tests. Meta key should be `CID
 You should assign list of case IDs to it, e.g.:
 
 ```js
-test
-    .meta('CID', [1])
-    ('Text typing basics', async (t) => {
-        await t
-    });
-
-test
-    .meta({ CID: [2, 3] })
-    ('Click check boxes and then verify their state', async (t) => {
-        await t
-    });
+test.meta('CID', [1])('Text typing basics', async (t) => {
+  await t;
+});
+
+test.meta({ CID: [2, 3] })(
+  'Click check boxes and then verify their state',
+  async (t) => {
+    await t;
+  },
+);
 ```
-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):
+
 ```bash
-npx testcafe chrome test.js -r spec,qase
+QASE_MODE=testops npx testcafe chrome test.js -r spec,qase
 ```
+
 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:
@@ -66,57 +55,61 @@ 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.
+Qase reporter supports passing parameters using two ways:
+using `.qaserc`/`qase.config.json` file and using ENV variables.
+
+`.qaserc` parameters, (* - required):
 
-`.qaserc` parameters:
-- `enabled` - Enable reporter
-- `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)
-- `basePath` - Qase.io URL
-- `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
-- `environmentId` - Environment ID from Qase TMS
-- `runName` - Set custom Run name, when new run is created.
-  Supports two parameters:
-    - `%DATE%`
-    - `%AGENTS%`
-- `runDescription` - Set custom Run description, when new run is created
-- `uploadAttachments` - Uploading attachment to Qase TMS
-- `runComplete` - Complete run after all tests are finished
-- `logging` - Enabled debug logging from reporter or not
-- `rootSuiteTitle` - A parent suite for your autocreated tests
+- `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
 
 Example configuration file:
+
 ```json
 {
-    "enabled": true,
-    "logging": true,
-    "apiToken": "api_key",
-    "projectCode": "project_code",
-    "runName": "TestCafe run %DATE% %AGENTS%"
+  "debug": true,
+  "environment": 1,
+  "testops": {
+    "api": {
+      "token": "api_key"
+    },
+    "project": "project_code"
+  }
 }
 ```
 
 Supported ENV variables:
 
-- `QASE_ENABLED` - Same as `enabled`
-- `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_RUN_COMPLETE` - Same as `runComplete`
-- `QASE_LOGGING` - Same as `logging`
-- `QASE_UPLOAD_ATTACHMENTS` - Same as `uploadAttachments`
-- `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`
+
+## 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/)
+
+`testcafe >= 2.0.0`
 
 <!-- references -->
 

package/package.json

@@ -1,58 +1,54 @@
 {
   "name": "testcafe-reporter-qase",
-  "version": "v1.2.0-alpha.2",
+  "version": "2.0.0-beta.0",
   "description": "Qase TMS TestCafe Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "homepage": "https://github.com/qase-tms/qase-testcafe",
+  "exports": {
+    ".": "./dist/index.js",
+    "./reporter": "./dist/reporter.js",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/index.d.ts"
+      ],
+      "reporter": [
+        "./dist/reporter.d.ts"
+      ]
+    }
+  },
+  "homepage": "https://github.com/qase-tms/qase-javascript",
   "bugs": {
-    "url": "https://github.com/qase-tms/qase-testcafe"
+    "url": "https://github.com/qase-tms/qase-javascript/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/qase-tms/qase-testcafe.git"
+    "url": "git+https://github.com/qase-tms/qase-javascript.git"
   },
   "engines": {
     "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": "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": {
-    "@hutson/npm-deploy-git-tag": "^6.0.0",
-    "@types/jest": "^23.3.7",
-    "@types/node-fetch": "^2.5.7",
-    "@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",
-    "moment": "^2.29.1",
-    "node-fetch": "^3.1.1",
-    "nodemon": "^2.0.7",
-    "ts-jest": "^26.4.4",
-    "typescript": "^3.9.3"
-  },
   "dependencies": {
-    "chalk": "^4.1.0",
-    "form-data": "^3.0.0",
-    "qaseio": "^2.0.1"
+    "qase-javascript-commons": "^2.0.0-beta.0",
+    "uuid": "^9.0.0"
+  },
+  "peerDependencies": {
+    "testcafe": ">=2.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/CustomBoundaryFormData.d.ts

@@ -1,6 +0,0 @@
-import FormData from 'form-data';
-export declare let customBoundary: string;
-export declare class CustomBoundaryFormData extends FormData {
-    constructor();
-    getBoundary(): string;
-}

package/dist/CustomBoundaryFormData.js

@@ -1,37 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomBoundaryFormData = exports.customBoundary = void 0;
-var form_data_1 = __importDefault(require("form-data"));
-var crypto_1 = __importDefault(require("crypto"));
-exports.customBoundary = '----------------------------';
-crypto_1.default.randomBytes(24).forEach(function (value) {
-    exports.customBoundary += Math.floor(value * 10).toString(16);
-});
-var CustomBoundaryFormData = /** @class */ (function (_super) {
-    __extends(CustomBoundaryFormData, _super);
-    function CustomBoundaryFormData() {
-        return _super.call(this) || this;
-    }
-    CustomBoundaryFormData.prototype.getBoundary = function () {
-        return exports.customBoundary;
-    };
-    return CustomBoundaryFormData;
-}(form_data_1.default));
-exports.CustomBoundaryFormData = CustomBoundaryFormData;
-//# sourceMappingURL=CustomBoundaryFormData.js.map

package/dist/CustomBoundaryFormData.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CustomBoundaryFormData.js","sourceRoot":"","sources":["../src/CustomBoundaryFormData.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,wDAAiC;AACjC,kDAA4B;AAGjB,QAAA,cAAc,GAAG,8BAA8B,CAAC;AAC3D,gBAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,UAAC,KAAK;IACjC,sBAAc,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC,CAAC;AAEH;IAA4C,0CAAQ;IAChD;eACI,iBAAO;IACX,CAAC;IACM,4CAAW,GAAlB;QACI,OAAO,sBAAc,CAAC;IAC1B,CAAC;IACL,6BAAC;AAAD,CAAC,AAPD,CAA4C,mBAAQ,GAOnD;AAPY,wDAAsB"}

package/dist/index.d.ts

@@ -1,61 +0,0 @@
-interface Meta {
-    [key: string]: string;
-}
-interface Screenshot {
-    screenshotPath: string;
-    thumbnailPath: string;
-    userAgent: string;
-    quarantineAttempt: number;
-    takenOnFail: boolean;
-}
-interface TestRunInfo {
-    errs: Array<Record<string, unknown>>;
-    warnings: string[];
-    durationMs: number;
-    unstable: boolean;
-    screenshotPath: string;
-    screenshots: Screenshot[];
-    quarantine: {
-        [key: string]: {
-            passed: boolean;
-        };
-    };
-    skipped: boolean;
-}
-declare class TestcafeQaseReporter {
-    private config;
-    private api;
-    private enabled;
-    private userAgents;
-    private pending;
-    private results;
-    private screenshots;
-    private queued;
-    private fixtureName;
-    constructor();
-    private static getCaseId;
-    private static createHeaders;
-    private static createRunObject;
-    private static getPackageVersion;
-    reportTaskStart: (_startTime: number, userAgents: string[]) => Promise<void>;
-    reportFixtureStart: (name: any) => Promise<void>;
-    reportTestDone: (name: string, testRunInfo: TestRunInfo, meta: Meta, formatError: (x: Record<string, unknown>) => string) => Promise<void>;
-    reportTaskDone: () => Promise<void>;
-    private completeRun;
-    private log;
-    private checkProject;
-    private createRun;
-    private checkRun;
-    private saveRunId;
-    private logTestItem;
-    private prepareCaseResult;
-    private uploadAttachments;
-}
-declare const _default: () => {
-    reportTaskStart: (_startTime: number, userAgents: string[]) => Promise<void>;
-    reportFixtureStart: (name: any) => Promise<void>;
-    reportTestDone(name: string, testRunInfo: TestRunInfo, meta: Meta): Promise<void>;
-    reportTaskDone: () => Promise<void>;
-    reporter: TestcafeQaseReporter;
-};
-export = _default;