testcafe-reporter-qase 1.2.1 → 2.0.0-beta.1

package/README.md

@@ -18,30 +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;
+  },
+);
 ```
+
 ---
+
 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:
@@ -51,62 +55,62 @@ 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 -->
 
 [auth]: https://developers.qase.io/#authentication

package/dist/factory.d.ts

@@ -0,0 +1,12 @@
+import { TestcafeQaseOptionsType, TestcafeQaseReporter } from './reporter';
+/**
+ * @param {TestcafeQaseOptionsType} options
+ * @returns {object}
+ */
+export declare const factory: (options: TestcafeQaseOptionsType) => {
+    reportTaskStart: () => void;
+    reportFixtureStart: () => void;
+    reportTestDone: (title: string, testRunInfo: import("./reporter").TestRunInfoType, meta: Record<string, string>) => void;
+    reportTaskDone: () => Promise<void>;
+    reporter: TestcafeQaseReporter;
+};

package/dist/factory.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.factory = void 0;
+const reporter_1 = require("./reporter");
+/**
+ * @param {TestcafeQaseOptionsType} options
+ * @returns {object}
+ */
+const factory = (options) => {
+    const reporter = new reporter_1.TestcafeQaseReporter(options);
+    return {
+        reportTaskStart: () => {
+            /* empty */
+        },
+        reportFixtureStart: () => {
+            /* empty */
+        },
+        reportTestDone: reporter.reportTestDone,
+        reportTaskDone: reporter.reportTaskDone,
+        reporter,
+    };
+};
+exports.factory = factory;

package/dist/index.d.ts

@@ -1,61 +1,2 @@
-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;
+import { factory } from './factory';
+export = factory;