testcafe-reporter-qase 1.0.5 → 1.2.0-alpha.1

package/README.md

@@ -1,14 +1,15 @@
-# [Qase TMS](https://qase.io) TestCafe Reporter
+> # Qase TMS TestCafe 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 testcafe-reporter-qase
+npm install testcafe testcafe-reporter-qase
 ```
 
-## Usage
+## Example of usage
+
 In order to use reporter, you should add meta information to your tests. Meta key should be `CID`.
 You should assign list of case IDs to it, e.g.:
 ```js
@@ -24,12 +25,35 @@ test
         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:
 
-After that you can run your tests by providing custom reporter:
+```
+Allow submitting results in bulk
+```
+You can run your tests by providing custom reporter:
 ```bash
-npx testcafe chrome examples/use-page-model -r spec,qase
+npx testcafe chrome test.js -r spec,qase
 ```
+or
+```
+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
 
 Qase reporter supports passing parameters using two ways: 
@@ -39,15 +63,19 @@ using `.qaserc` file and using ENV variables.
 - `enabled` - Enable reporter
 - `apiToken` - 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
   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
 
 Example configuration file:
@@ -55,8 +83,8 @@ Example configuration file:
 {
     "enabled": true,
     "logging": true,
-    "apiToken": "a786b45e371e1097c4c78a3211e3a1d23018ceb9",
-    "projectCode": "PROJECTCODE",
+    "apiToken": "api_key",
+    "projectCode": "project_code",
     "runName": "TestCafe run %DATE% %AGENTS%"
 }
 ```
@@ -69,4 +97,10 @@ Supported ENV variables:
 - `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`
+
+<!-- references -->
+
+[auth]: https://developers.qase.io/#authentication

package/dist/CustomBoundaryFormData.d.ts

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

package/dist/CustomBoundaryFormData.js

@@ -0,0 +1,37 @@
+"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

@@ -0,0 +1 @@
+{"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

@@ -23,7 +23,6 @@ interface TestRunInfo {
     skipped: boolean;
 }
 declare class TestcafeQaseReporter {
-    private formatError;
     private config;
     private api;
     private enabled;
@@ -31,18 +30,25 @@ declare class TestcafeQaseReporter {
     private pending;
     private results;
     private screenshots;
+    private queued;
+    private sending;
     constructor();
+    private static getCaseId;
+    private static createHeaders;
+    private static createRunObject;
+    private static getPackageVersion;
     reportTaskStart: (_startTime: number, userAgents: string[]) => 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 getCaseId;
     private logTestItem;
-    private publishCaseResult;
+    private prepareCaseResult;
+    private uploadAttachments;
 }
 declare const _default: () => {
     reportTaskStart: (_startTime: number, userAgents: string[]) => Promise<void>;