wdio-qase-reporter 1.1.1 → 1.1.3

package/README.md

@@ -20,6 +20,8 @@ from Qase.io before executing tests. It's a more reliable way to bind
 autotests to test cases, that persists when you rename, move, or
 parameterize your tests.
 
+For more information, see the [Usage Guide](docs/usage.md).
+
 For example:
 
 ### Mocha/Jasmine
@@ -28,14 +30,12 @@ For example:
 import {qase} from "wdio-qase-reporter";
 
 describe('My First Test', () => {
-  it('Several ids', () => {
-    qase.id(1);
+  it(qase(1, 'Several ids'), () => {
     expect(true).to.equal(true);
   });
 
   // a test can check multiple test cases
-  it('Correct test', () => {
-    qase.id([2, 3]);
+  it(qase([2,3], 'Correct test'), () => {
     expect(true).to.equal(true);
   });
 

package/changelog.md

@@ -1,3 +1,11 @@
+# qase-wdio@1.1.2
+
+## What's new
+
+- Fixed an issue where the test result was not uploaded to the Qase TMS when the test has skipped status.
+- Added a new function `qase` to set the test case ID.
+- Marked the function `qase.id` as deprecated.
+
 # qase-wdio@1.1.0
 
 ## What's new

package/dist/reporter.d.ts

@@ -2,6 +2,10 @@ import WDIOReporter, { AfterCommandArgs, BeforeCommandArgs, RunnerStats, SuiteSt
 import { TestStatusEnum, TestStepType } from 'qase-javascript-commons';
 import { AddAttachmentEventArgs, AddQaseIdEventArgs, AddRecordsEventArgs, AddSuiteEventArgs, AddTitleEventArgs } from './models';
 export default class WDIOQaseReporter extends WDIOReporter {
+    /**
+   * @type {RegExp}
+   */
+    static qaseIdRegExp: RegExp;
     /**
      * @type {Record<string, TestStatusEnum>}
      */
@@ -56,4 +60,16 @@ export default class WDIOQaseReporter extends WDIOReporter {
     private attachFile;
     private _endStep;
     private parseTag;
+    /**
+   * @param {string} title
+   * @returns {number[]}
+   * @private
+   */
+    private static extractQaseIdsFromTitle;
+    /**
+   * @param {string} title
+   * @returns {string}
+   * @private
+   */
+    private removeQaseIdsFromTitle;
 }

package/dist/reporter.js

@@ -12,6 +12,10 @@ const utils_1 = require("./utils");
 const path_1 = __importDefault(require("path"));
 const events_1 = require("./events");
 class WDIOQaseReporter extends reporter_1.default {
+    /**
+   * @type {RegExp}
+   */
+    static qaseIdRegExp = /\(Qase ID:? ([\d,]+)\)/;
     /**
      * @type {Record<string, TestStatusEnum>}
      */
@@ -188,6 +192,9 @@ class WDIOQaseReporter extends reporter_1.default {
             this._endStep(qase_javascript_commons_1.TestStatusEnum.skipped);
             return;
         }
+        if (this.storage.getCurrentTest()?.title !== test.title) {
+            this._startTest(test.title, test.cid, test.start.valueOf() / 1000);
+        }
         await this._endTest(WDIOQaseReporter.statusMap[test.state] ?? qase_javascript_commons_1.TestStatusEnum.skipped, null);
     }
     async _endTest(status, err, end_time = Date.now().valueOf() / 1000) {
@@ -218,6 +225,11 @@ class WDIOQaseReporter extends reporter_1.default {
             null : err.message === undefined ?
             null : err.message;
         testResult.signature = (0, qase_javascript_commons_1.generateSignature)(Array.isArray(testResult.testops_id) ? testResult.testops_id : testResult.testops_id ? [testResult.testops_id] : null, [...this.storage.suites, testResult.title], testResult.params);
+        const ids = WDIOQaseReporter.extractQaseIdsFromTitle(testResult.title);
+        if (ids.length > 0) {
+            testResult.testops_id = ids;
+        }
+        testResult.title = this.removeQaseIdsFromTitle(testResult.title);
         await this.reporter.addTestResult(testResult);
     }
     onBeforeCommand(command) {
@@ -441,5 +453,26 @@ class WDIOQaseReporter extends reporter_1.default {
         }
         return { key, value };
     }
+    /**
+   * @param {string} title
+   * @returns {number[]}
+   * @private
+   */
+    static extractQaseIdsFromTitle(title) {
+        const [, ids] = title.match(WDIOQaseReporter.qaseIdRegExp) ?? [];
+        return ids ? ids.split(',').map((id) => Number(id)) : [];
+    }
+    /**
+   * @param {string} title
+   * @returns {string}
+   * @private
+   */
+    removeQaseIdsFromTitle(title) {
+        const matches = title.match(WDIOQaseReporter.qaseIdRegExp);
+        if (matches) {
+            return title.replace(matches[0], '').trimEnd();
+        }
+        return title;
+    }
 }
 exports.default = WDIOQaseReporter;

package/dist/wdio.d.ts

@@ -1,61 +1,135 @@
 import { StepFunction } from 'qase-javascript-commons';
-export declare class qase {
+/**
+ * Set IDs for the test case
+ *
+ * @param qaseId
+ * @param name
+ * @example
+ * describe('suite', () => {
+ *  it(qase(1, 'should work'), () => {
+ *    // test code
+ *  });
+ * });
+ * @returns {string}
+ */
+export declare const qase: {
+    (qaseId: number | string | number[] | string[], name: string): string;
     /**
-     * Assign QaseID to test
-     * @name id
-     * @param {number | number[]} value
+     * Set IDs for the test case.
+     * Deprecated: Use qase(qaseId, name) instead.
+     *
+     * @param value
+     * @returns {string}
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.id(1);
+     *    // test code
+     *  });
+     * });
      */
-    static id(value: number | number[]): typeof qase;
+    id(value: number | number[]): undefined;
     /**
-     * Assign title to test
-     * @name title
+     * Set a title for the test case
      * @param {string} value
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.title("Title");
+     *    // test code
+     *  });
+     * });
      */
-    static title(value: string): typeof qase;
+    title(value: string): undefined;
     /**
-     * Assign parameters to test
-     * @name parameters
+     * Set parameters for the test case
      * @param {Record<string, string>} values
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.parameters({ param1: 'value1', param2: 'value2' });
+     *    // test code
+     *  });
+     * });
      */
-    static parameters(values: Record<string, string>): typeof qase;
+    parameters(values: Record<string, string>): undefined;
     /**
-     * Assign group parameters to test
-     * @name groupParameters
+     * Set group parameters for the test case
      * @param {Record<string, string>} values
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.groupParameters({ param1: 'value1', param2: 'value2' });
+     *    // test code
+     *  });
+     * });
      */
-    static groupParameters(values: Record<string, string>): typeof qase;
+    groupParameters(values: Record<string, string>): undefined;
     /**
-     * Assign fields to test
-     * @name fields
+     * Set fields for the test case
      * @param {Record<string, string>} values
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.fields({ field1: 'value1', field2: 'value2' });
+     *    // test code
+     *  });
+     * });
      */
-    static fields(values: Record<string, string>): typeof qase;
+    fields(values: Record<string, string>): undefined;
     /**
-     * Assign suite to test
-     * @name suite
+     * Set suite for the test case
      * @param {string} value
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.suite('Suite');
+     *    // test code
+     *  });
+     * });
      */
-    static suite(value: string): typeof qase;
+    suite(value: string): undefined;
     /**
-     * Assign ignore mark to test
-     * @name ignore
+     * Set ignore for the test case
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.ignore();
+     *    // test code
+     *  });
+     * });
      */
-    static ignore(): typeof qase;
+    ignore(): undefined;
     /**
-     * Assign attachment to test
-     * @name attach
-     * @param attach
+     * Set attachment for the test case
+     * @param {object} attach
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.attach({ name: 'attachment', type: 'text/plain', content: 'attachment content' });
+     *    // test code
+     *  });
+     * });
      */
-    static attach(attach: {
+    attach(attach: {
         name?: string;
         type?: string;
         content?: string;
         paths?: string[];
-    }): typeof qase;
+    }): undefined;
     /**
-     * Starts step
-     * @param {string} name - the step name
-     * @param {StepFunction} body - the step content function
+     * Set step for the test case
+     * @param {string} name
+     * @param {StepFunction} body
+     * @example
+     * describe('suite', () => {
+     *  it('should work', () => {
+     *    qase.step('step', async () => {
+     *      // step code
+     *    });
+     *    // test code
+     *  });
+     * });
      */
-    static step(name: string, body: StepFunction): Promise<void>;
-}
+    step(name: string, body: StepFunction): Promise<undefined>;
+};

package/dist/wdio.js

@@ -14,88 +14,177 @@ const sendEvent = (event, msg = {}) => {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
     process.emit(event, msg);
 };
-// eslint-disable-next-line @typescript-eslint/no-extraneous-class
-class qase {
-    /**
-     * Assign QaseID to test
-     * @name id
-     * @param {number | number[]} value
-     */
-    static id(value) {
-        sendEvent(events_1.events.addQaseID, { ids: Array.isArray(value) ? value : [value] });
-        return this;
-    }
-    /**
-     * Assign title to test
-     * @name title
-     * @param {string} value
-     */
-    static title(value) {
-        sendEvent(events_1.events.addTitle, { title: value });
-        return this;
-    }
-    /**
-     * Assign parameters to test
-     * @name parameters
-     * @param {Record<string, string>} values
-     */
-    static parameters(values) {
-        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
-     * @param {Record<string, string>} values
-     */
-    static fields(values) {
-        sendEvent(events_1.events.addFields, { records: values });
-        return this;
-    }
-    /**
-     * Assign suite to test
-     * @name suite
-     * @param {string} value
-     */
-    static suite(value) {
-        sendEvent(events_1.events.addSuite, { suite: value });
-        return this;
-    }
-    /**
-     * Assign ignore mark to test
-     * @name ignore
-     */
-    static ignore() {
-        sendEvent(events_1.events.addIgnore, {});
-        return this;
-    }
-    /**
-     * Assign attachment to test
-     * @name attach
-     * @param attach
-     */
-    static attach(attach) {
-        sendEvent(events_1.events.addAttachment, attach);
-        return this;
-    }
-    /**
-     * Starts step
-     * @param {string} name - the step name
-     * @param {StepFunction} body - the step content function
-     */
-    static async step(name, body) {
-        const runningStep = new qase_javascript_commons_1.QaseStep(name);
-        // eslint-disable-next-line @typescript-eslint/require-await
-        await runningStep.run(body, async (message) => sendEvent(events_1.events.addStep, message));
+/**
+ * Set IDs for the test case
+ *
+ * @param qaseId
+ * @param name
+ * @example
+ * describe('suite', () => {
+ *  it(qase(1, 'should work'), () => {
+ *    // test code
+ *  });
+ * });
+ * @returns {string}
+ */
+const qase = (qaseId, name) => {
+    const caseIds = Array.isArray(qaseId) ? qaseId : [qaseId];
+    const ids = [];
+    for (const id of caseIds) {
+        if (typeof id === 'number') {
+            ids.push(id);
+            continue;
+        }
+        const parsedId = parseInt(id);
+        if (!isNaN(parsedId)) {
+            ids.push(parsedId);
+            continue;
+        }
+        console.log(`qase: qase ID ${id} should be a number`);
     }
-}
+    const newName = `${name} (Qase ID: ${caseIds.join(',')})`;
+    return newName;
+};
 exports.qase = qase;
+/**
+ * Set IDs for the test case.
+ * Deprecated: Use qase(qaseId, name) instead.
+ *
+ * @param value
+ * @returns {string}
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.id(1);
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.id = (value) => {
+    sendEvent(events_1.events.addQaseID, { ids: Array.isArray(value) ? value : [value] });
+    return this;
+};
+/**
+ * Set a title for the test case
+ * @param {string} value
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.title("Title");
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.title = (value) => {
+    sendEvent(events_1.events.addTitle, { title: value });
+    return this;
+};
+/**
+ * Set parameters for the test case
+ * @param {Record<string, string>} values
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.parameters({ param1: 'value1', param2: 'value2' });
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.parameters = (values) => {
+    sendEvent(events_1.events.addParameters, { records: values });
+    return this;
+};
+/**
+ * Set group parameters for the test case
+ * @param {Record<string, string>} values
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.groupParameters({ param1: 'value1', param2: 'value2' });
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.groupParameters = (values) => {
+    sendEvent(events_1.events.addGroupParameters, { records: values });
+    return this;
+};
+/**
+ * Set fields for the test case
+ * @param {Record<string, string>} values
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.fields({ field1: 'value1', field2: 'value2' });
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.fields = (values) => {
+    sendEvent(events_1.events.addFields, { records: values });
+    return this;
+};
+/**
+ * Set suite for the test case
+ * @param {string} value
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.suite('Suite');
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.suite = (value) => {
+    sendEvent(events_1.events.addSuite, { suite: value });
+    return this;
+};
+/**
+ * Set ignore for the test case
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.ignore();
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.ignore = () => {
+    sendEvent(events_1.events.addIgnore, {});
+    return this;
+};
+/**
+ * Set attachment for the test case
+ * @param {object} attach
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.attach({ name: 'attachment', type: 'text/plain', content: 'attachment content' });
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.attach = (attach) => {
+    sendEvent(events_1.events.addAttachment, attach);
+    return this;
+};
+/**
+ * Set step for the test case
+ * @param {string} name
+ * @param {StepFunction} body
+ * @example
+ * describe('suite', () => {
+ *  it('should work', () => {
+ *    qase.step('step', async () => {
+ *      // step code
+ *    });
+ *    // test code
+ *  });
+ * });
+ */
+exports.qase.step = async (name, body) => {
+    const runningStep = new qase_javascript_commons_1.QaseStep(name);
+    // eslint-disable-next-line @typescript-eslint/require-await
+    await runningStep.run(body, async (message) => sendEvent(events_1.events.addStep, message));
+    return this;
+};

package/docs/usage.md

@@ -0,0 +1,247 @@
+# Qase Integration in WebdriverIO
+
+This guide demonstrates how to integrate Qase with WebdriverIO, providing instructions on how to add Qase IDs, titles,
+fields, suites, comments, and file attachments to your test cases.
+
+---
+
+## Adding QaseID to a Test
+
+To associate a QaseID with a test in WebdriverIO, use the `qase` function. This function accepts a single integer
+representing the test's ID in Qase.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it(qase(1, 'test'), () => {
+  browser.url('https://example.com');
+});
+
+it(qase([1, 2, 3], 'test'), () => {
+  browser.url('https://example.com');
+});
+```
+
+---
+
+## Adding a Title to a Test
+
+You can provide a title for your test using the `qase.title` function. The function accepts a string, which will be
+used as the test's title in Qase. If no title is provided, the test method name will be used by default.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.title('Title');
+  browser.url('https://example.com');
+});
+```
+
+---
+
+## Adding Fields to a Test
+
+The `qase.fields` function allows you to add additional metadata to a test case. You can specify multiple fields to
+enhance test case information in Qase.
+
+### System Fields
+
+- `description` — Description of the test case.
+- `preconditions` — Preconditions for the test case.
+- `postconditions` — Postconditions for the test case.
+- `severity` — Severity of the test case (e.g., `critical`, `major`).
+- `priority` — Priority of the test case (e.g., `high`, `low`).
+- `layer` — Test layer (e.g., `UI`, `API`).
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.fields({ description: "Description", preconditions: "Preconditions" });
+  browser.url('https://example.com');
+});
+```
+
+---
+
+## Adding a Suite to a Test
+
+To assign a suite or sub-suite to a test, use the `qase.suite` function. It can receive a suite name, and optionally a
+sub-suite, both as strings.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.suite("Suite 01");
+  browser.url('https://example.com');
+});
+
+it('test', () => {
+  qase.suite("Suite 01\tSuite 02");
+  browser.url('https://example.com');
+});
+```
+
+---
+
+## Ignoring a Test in Qase
+
+To exclude a test from being reported to Qase (while still executing the test in WebdriverIO), use the `qase.ignore`
+function. The test will run, but its result will not be sent to Qase.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.ignore();
+  browser.url('https://example.com');
+});
+```
+
+---
+
+## Adding a Comment to a Test
+
+You can attach comments to the test results in Qase using the `qase.comment` function. The comment will be displayed
+alongside the test execution details in Qase.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.comment("Some comment");
+  browser.url('https://example.com');
+});
+```
+
+---
+
+## Attaching Files to a Test
+
+To attach files to a test result, use the `qase.attach` function. This method supports attaching one or multiple files,
+along with optional file names, comments, and file types.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.attach({ name: 'attachment.txt', content: 'Hello, world!', type: 'text/plain' });
+  qase.attach({ paths: '/path/to/file' });
+  qase.attach({ paths: ['/path/to/file', '/path/to/another/file'] });
+  browser.url('https://example.com');
+});
+```
+
+## Adding Parameters to a Test
+
+You can add parameters to a test case using the `qase.parameters` function. This function accepts an object with
+parameter names and values.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.parameters({ param1: 'value1', param2: 'value2' });
+  browser.url('https://example.com');
+});
+```
+
+## Adding Group Parameters to a Test
+
+To add group parameters to a test case, use the `qase.groupParameters` function. This function accepts an object with
+group parameter names and values.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', () => {
+  qase.parameters({ param1: 'value1', param2: 'value2' });
+  qase.groupParameters({ param3: 'value3', param4: 'value4' });
+  browser.url('https://example.com');
+});
+```
+
+## Adding Steps to a Test
+
+You can add steps to a test case using the `qase.step` function. This function accepts a string and a callback function,
+which will be used as the step description and actions in Qase.
+
+### Example
+
+```javascript
+import { qase } from 'wdio-qase-reporter';
+
+it('test', async () => {
+  await qase.step('Some step', async (step) => {
+    // some actions
+    step.attach({ name: 'screenshot.png', type: 'image/png', content: await browser.takeScreenshot() });
+  });
+  browser.url('https://example.com');
+});
+```
+
+## Cucumber Integration
+
+WebdriverIO Qase reporter supports Cucumber integration. When using Cucumber, you can annotate your scenarios with Qase IDs using tags.
+
+### Feature file example
+
+```gherkin
+Feature: Test user role
+
+  @QaseId=3
+  Scenario: Login
+    Given I test login
+    When I enter credentials
+    Then I should be logged in
+
+  @QaseId=4,5
+  @Title=Custom Test Title
+  @Suite=Authentication
+  Scenario: Logout
+    Given I am logged in
+    When I click logout
+    Then I should be logged out
+```
+
+### Supported Cucumber tags
+
+- `@QaseId=<id>` - Set Qase test case ID(s). Multiple IDs can be separated by commas
+- `@Title=<title>` - Set custom test title
+- `@Suite=<suite>` - Set test suite name
+
+### Configuration for Cucumber
+
+```javascript
+// wdio.conf.js
+const WDIOQaseReporter = require('wdio-qase-reporter').default;
+
+exports.config = {
+  reporters: [[WDIOQaseReporter, {
+    useCucumber: true,  // Enable Cucumber support
+    disableWebdriverStepsReporting: true,
+    disableWebdriverScreenshotsReporting: false,
+  }]],
+  // ... other options
+};
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-qase-reporter",
-  "version": "1.1.1",
+  "version": "1.1.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.3.3",
+    "qase-javascript-commons": "~2.4.1",
     "uuid": "^9.0.1",
     "@types/node": "^20.1.0",
     "@wdio/reporter": "^8.39.0",