wdio-qase-reporter 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -117,6 +117,7 @@ Also, you need to configure the reporter using the `wdio.conf.ts` file:
 // wdio.conf.ts
 import WDIOQaseReporter from 'wdio-qase-reporter';
 import type { Options } from '@wdio/types';
+import { afterRunHook, beforeRunHook } from 'wdio-qase-reporter';
 
 export const config: Options.Testrunner = {
   reporters: [[WDIOQaseReporter, {
@@ -124,6 +125,17 @@ export const config: Options.Testrunner = {
     disableWebdriverScreenshotsReporting: true,
     useCucumber: false,
   }]],
+
+  // ...
+  // =====
+  // Hooks
+  // =====
+  onPrepare: async function() {
+    await beforeRunHook();
+  },
+  onComplete: async function() {
+    await afterRunHook();
+  },
   // ... other options
 };
 ```

package/changelog.md

@@ -1,3 +1,67 @@
+# qase-wdio@1.0.0-beta.3
+
+## What's new
+
+- Fix an issue with `cucumber` steps. Now, the reporter will correctly handle the `cucumber` steps and will report them
+  to the Qase TMS.
+- Fix an issue with duplicate test runs. Now, the reporter will correctly handle the test runs and will not create
+  duplicate test runs in the Qase TMS.
+
+  You need to add `beforeRunHook` hook to the `onPrepare` and `afterRunHook` hook to the `onComplete` in the
+  `wdio.conf.ts` configuration file:
+
+  ```ts
+    import type { Options } from '@wdio/types'
+    import WDIOQaseReporter from "wdio-qase-reporter";
+    import { afterRunHook, beforeRunHook } from "wdio-qase-reporter";
+
+    export const config: Options.Testrunner = {
+    // ...
+    //
+    // =====
+    // Hooks
+    // =====
+    // WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
+    // it and to build services around it. You can either apply a single function or an array of
+    // methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
+    // resolved to continue.
+    /**
+     * Gets executed once before all workers get launched.
+     * @param {object} config wdio configuration object
+     * @param {Array.<Object>} capabilities list of capabilities details
+     */
+    onPrepare: async function() {
+      await beforeRunHook();
+    },
+
+    /**
+     * Gets executed after all workers got shut down and the process is about to exit. An error
+     * thrown in the onComplete hook will result in the test run failing.
+     * @param {object} exitCode 0 - success, 1 - fail
+     * @param {object} config wdio configuration object
+     * @param {Array.<Object>} capabilities list of capabilities details
+     * @param {<Object>} results object containing test results
+     */
+    onComplete: async function() {
+      await afterRunHook();
+    },
+  }
+  ```
+
+# qase-wdio@1.0.0-beta.2
+
+## What's new
+
+Support group parameters for test cases. You can specify the group parameters in the test case using the following
+format:
+
+```ts
+  it('test', () => {
+  qase.groupParameters({ 'param01': 'value01', 'param02': 'value02' });
+  expect(true).to.equal(true);
+});
+```
+
 # qase-wdio@1.0.0-beta.1
 
 ## What's new

package/dist/events.d.ts

@@ -5,6 +5,7 @@ export declare const events: {
     readonly addSuite: "qase:suite";
     readonly addIgnore: "qase:ignore";
     readonly addParameters: "qase:parameters";
+    readonly addGroupParameters: "qase:groupParameters";
     readonly addAttachment: "qase:attachment";
     readonly startStep: "qase:startStep";
     readonly endStep: "qase:endStep";

package/dist/events.js

@@ -8,6 +8,7 @@ exports.events = {
     addSuite: 'qase:suite',
     addIgnore: 'qase:ignore',
     addParameters: 'qase:parameters',
+    addGroupParameters: 'qase:groupParameters',
     addAttachment: 'qase:attachment',
     startStep: 'qase:startStep',
     endStep: 'qase:endStep',

package/dist/hooks.d.ts

@@ -0,0 +1,2 @@
+export declare function beforeRunHook(): Promise<void>;
+export declare function afterRunHook(): Promise<void>;

package/dist/hooks.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.afterRunHook = exports.beforeRunHook = void 0;
+const qase_javascript_commons_1 = require("qase-javascript-commons");
+async function beforeRunHook() {
+    const configLoader = new qase_javascript_commons_1.ConfigLoader();
+    const config = configLoader.load();
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    const reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+        ...config,
+        frameworkPackage: 'wdio',
+        frameworkName: 'wdio',
+        reporterName: 'wdio-qase-reporter',
+    });
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+    await reporter.startTestRunAsync();
+}
+exports.beforeRunHook = beforeRunHook;
+async function afterRunHook() {
+    const configLoader = new qase_javascript_commons_1.ConfigLoader();
+    const config = configLoader.load();
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    const reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+        ...config,
+        frameworkPackage: 'wdio',
+        frameworkName: 'wdio',
+        reporterName: 'wdio-qase-reporter',
+    });
+    await reporter.complete();
+}
+exports.afterRunHook = afterRunHook;

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 import WDIOQaseReporter from './reporter.js';
 export * from './wdio';
+export * from './hooks';
 export default WDIOQaseReporter;

package/dist/index.js

@@ -19,4 +19,5 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const reporter_js_1 = __importDefault(require("./reporter.js"));
 __exportStar(require("./wdio"), exports);
+__exportStar(require("./hooks"), exports);
 exports.default = reporter_js_1.default;

package/dist/reporter.d.ts

@@ -33,10 +33,11 @@ export default class WDIOQaseReporter extends WDIOReporter {
      * @private
      */
     private static transformError;
-    onTestEnd(test: TestStats): Promise<void>;
+    onTestPass(): Promise<void>;
+    onTestRetry(test: TestStats): Promise<void>;
+    onTestFail(test: TestStats): Promise<void>;
+    onTestSkip(test: TestStats): Promise<void>;
     private _endTest;
-    onHookStart(): void;
-    onHookEnd(): void;
     onBeforeCommand(command: BeforeCommandArgs): void;
     onAfterCommand(command: AfterCommandArgs): void;
     registerListeners(): void;
@@ -44,6 +45,7 @@ export default class WDIOQaseReporter extends WDIOReporter {
     addTitle({ title }: AddTitleEventArgs): void;
     addSuite({ suite }: AddSuiteEventArgs): void;
     addParameters({ records }: AddRecordsEventArgs): void;
+    addGroupParameters({ records }: AddRecordsEventArgs): void;
     addFields({ records }: AddRecordsEventArgs): void;
     addAttachment({ name, type, content, paths }: AddAttachmentEventArgs): void;
     ignore(): void;

package/dist/reporter.js

@@ -38,7 +38,7 @@ class WDIOQaseReporter extends reporter_1.default {
     }
     onRunnerStart(runner) {
         this._isMultiremote = runner.isMultiremote;
-        this.reporter.startTestRun();
+        // this.reporter.startTestRun();
         this.isSync = false;
     }
     onSuiteStart(suite) {
@@ -69,20 +69,6 @@ class WDIOQaseReporter extends reporter_1.default {
                     case '@suite':
                         this.addSuite({ suite: tagData.value });
                         break;
-                    // case 'parameters':
-                    //   const params = tagData.value.split(',').map((param) => {
-                    //     const [key, value] = param.split(':');
-                    //     return { key, value };
-                    //   });
-                    //   process.emit(events.addParameters, { records: params });
-                    //   break;
-                    // case 'fields':
-                    //   const fields = tagData.value.split(',').map((field) => {
-                    //     const [key, value] = field.split(':');
-                    //     return { key, value };
-                    //   });
-                    //   process.emit(events.addFields, { records: fields });
-                    //   break;
                 }
             }
             return;
@@ -120,7 +106,7 @@ class WDIOQaseReporter extends reporter_1.default {
         this.storage.clear();
     }
     async onRunnerEnd(_) {
-        await this.reporter.publish();
+        await this.reporter.sendResults();
         this.isSync = true;
     }
     onTestStart(test) {
@@ -151,10 +137,36 @@ class WDIOQaseReporter extends reporter_1.default {
         }
         return err;
     }
-    async onTestEnd(test) {
+    async onTestPass() {
+        if (this._options.useCucumber) {
+            this._endStep();
+            return;
+        }
+        await this._endTest(qase_javascript_commons_1.TestStatusEnum.passed, null);
+    }
+    async onTestRetry(test) {
+        const error = test.errors ? WDIOQaseReporter.transformError(test.errors) : null;
+        if (this._options.useCucumber) {
+            this._endStep(error ? qase_javascript_commons_1.TestStatusEnum.failed : qase_javascript_commons_1.TestStatusEnum.passed);
+            return;
+        }
+        await this._endTest(WDIOQaseReporter.statusMap[test.state] ?? qase_javascript_commons_1.TestStatusEnum.skipped, error, test.end ? test.end.valueOf() / 1000 : Date.now().valueOf() / 1000);
+    }
+    async onTestFail(test) {
         const error = test.errors ? WDIOQaseReporter.transformError(test.errors) : null;
+        if (this._options.useCucumber) {
+            this._endStep(qase_javascript_commons_1.TestStatusEnum.failed);
+            return;
+        }
         await this._endTest(WDIOQaseReporter.statusMap[test.state] ?? qase_javascript_commons_1.TestStatusEnum.skipped, error, test.end ? test.end.valueOf() / 1000 : Date.now().valueOf() / 1000);
     }
+    async onTestSkip(test) {
+        if (this._options.useCucumber) {
+            this._endStep(qase_javascript_commons_1.TestStatusEnum.skipped);
+            return;
+        }
+        await this._endTest(WDIOQaseReporter.statusMap[test.state] ?? qase_javascript_commons_1.TestStatusEnum.skipped, null);
+    }
     async _endTest(status, err, end_time = Date.now().valueOf() / 1000) {
         const testResult = this.storage.getCurrentTest();
         if (testResult === undefined || this.storage.ignore) {
@@ -180,15 +192,8 @@ class WDIOQaseReporter extends reporter_1.default {
         testResult.message = err === null ?
             null : err.message === undefined ?
             null : err.message;
-        console.log(testResult);
         await this.reporter.addTestResult(testResult);
     }
-    onHookStart() {
-        console.log('Hook started');
-    }
-    onHookEnd() {
-        console.log('Hook ended');
-    }
     onBeforeCommand(command) {
         if (!this.storage.getLastItem()) {
             return;
@@ -227,6 +232,7 @@ class WDIOQaseReporter extends reporter_1.default {
         process.on(events_1.events.addFields, this.addFields.bind(this));
         process.on(events_1.events.addSuite, this.addSuite.bind(this));
         process.on(events_1.events.addParameters, this.addParameters.bind(this));
+        process.on(events_1.events.addGroupParameters, this.addGroupParameters.bind(this));
         process.on(events_1.events.addAttachment, this.addAttachment.bind(this));
         process.on(events_1.events.addIgnore, this.ignore.bind(this));
         process.on(events_1.events.addStep, this.addStep.bind(this));
@@ -272,6 +278,17 @@ class WDIOQaseReporter extends reporter_1.default {
         }
         curTest.params = stringRecord;
     }
+    addGroupParameters({ records }) {
+        const curTest = this.storage.getCurrentTest();
+        if (!curTest) {
+            return;
+        }
+        const stringRecord = {};
+        for (const [key, value] of Object.entries(records)) {
+            stringRecord[String(key)] = String(value);
+        }
+        curTest.group_params = stringRecord;
+    }
     addFields({ records }) {
         const curTest = this.storage.getCurrentTest();
         if (!curTest) {

package/dist/wdio.d.ts

@@ -18,6 +18,12 @@ export declare class qase {
      * @param {Record<string, string>} values
      */
     static parameters(values: Record<string, string>): typeof qase;
+    /**
+     * Assign group parameters to test
+     * @name groupParameters
+     * @param {Record<string, string>} values
+     */
+    static groupParameters(values: Record<string, string>): typeof qase;
     /**
      * Assign fields to test
      * @name fields

package/dist/wdio.js

@@ -41,6 +41,15 @@ class qase {
         sendEvent(events_1.events.addParameters, { records: values });
         return this;
     }
+    /**
+     * Assign group parameters to test
+     * @name groupParameters
+     * @param {Record<string, string>} values
+     */
+    static groupParameters(values) {
+        sendEvent(events_1.events.addGroupParameters, { records: values });
+        return this;
+    }
     /**
      * Assign fields to test
      * @name fields

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-qase-reporter",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "Qase WebDriverIO Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -32,7 +32,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.1.2",
+    "qase-javascript-commons": "~2.2.0",
     "uuid": "^9.0.1",
     "@types/node": "^20.1.0",
     "@wdio/reporter": "^8.39.0",