@qanalyzer/forge-wdio 1.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright © 2026 JSoft
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,136 @@
+# @qanalyzer/forge-wdio
+
+WebdriverIO reporter + service for **QAnalyzer** (Jira Forge quality hub).
+
+Supports **WebdriverIO 8+** with **Mocha** (`@wdio/mocha-framework`) or **Cucumber** (`@wdio/cucumber-framework`).
+
+## Install
+
+```bash
+# Mocha (default)
+npm install -D @qanalyzer/forge-wdio @qanalyzer/forge-commons @wdio/mocha-framework
+
+# Cucumber
+npm install -D @qanalyzer/forge-wdio @qanalyzer/forge-commons @wdio/cucumber-framework
+```
+
+## Configure — Mocha
+
+```js
+// wdio.conf.js
+const QaWdioReporter = require('@qanalyzer/forge-wdio').default;
+const { beforeRunHook, afterRunHook, QaWdioService } = require('@qanalyzer/forge-wdio');
+
+exports.config = {
+  specs: ['./test/specs/**/*.spec.js'],
+  baseUrl: 'https://www.saucedemo.com',
+  framework: 'mocha',
+  reporters: [
+    [
+      QaWdioReporter,
+      {
+        // Defaults to mode=off (no credentials required)
+        // mode: 'ingest' | 'file' | 'off',
+        // projectKey: 'DEMO',
+        disableWebdriverStepsReporting: true, // default
+      },
+    ],
+  ],
+  services: [[QaWdioService, {}]],
+  capabilities: [
+    {
+      browserName: 'chrome',
+      'goog:chromeOptions': { args: ['--headless', '--disable-gpu'] },
+    },
+  ],
+  onPrepare: async function () {
+    await beforeRunHook();
+  },
+  onComplete: async function () {
+    await afterRunHook();
+  },
+};
+```
+
+## Configure — Cucumber
+
+```js
+// wdio.cucumber.conf.js
+const QaWdioReporter = require('@qanalyzer/forge-wdio').default;
+const { beforeRunHook, afterRunHook, QaWdioService } = require('@qanalyzer/forge-wdio');
+
+exports.config = {
+  specs: ['./test/features/**/*.feature'],
+  framework: 'cucumber',
+  cucumberOpts: {
+    require: ['./test/step-definitions/**/*.js'],
+  },
+  reporters: [
+    [
+      QaWdioReporter,
+      {
+        useCucumber: true, // scenario → one result; Gherkin steps → meta.qa.steps
+        disableWebdriverStepsReporting: true,
+      },
+    ],
+  ],
+  services: [[QaWdioService, {}]],
+  onPrepare: async () => { await beforeRunHook(); },
+  onComplete: async () => { await afterRunHook(); },
+};
+```
+
+Tag conventions:
+
+- Prefer **Jira keys in the scenario title** or bare tags: `@AUTH-101`
+- Optional metadata: `@suite=Checkout`, `@title=…`, `@tags=smoke,e2e`
+
+See `examples/single/wdio/wdio.cucumber.conf.js`.
+
+**Required for ingest/file:** `onPrepare` → `beforeRunHook` and `onComplete` → `afterRunHook`.
+
+### Modes
+
+| Mode | Behavior |
+| ---- | -------- |
+| `off` (default) | No network / file write |
+| `file` | Writes the ingest payload (default `./qanalyzer-results.json`) |
+| `ingest` | POSTs the payload with `format: jest-json` |
+
+Env: `QANALYZER_MODE`, `QANALYZER_PROJECT_KEY`, `QANALYZER_INGEST_URL`, `QANALYZER_INGEST_TOKEN`, `QANALYZER_LAUNCH_NAME`.
+
+## Helpers (Mocha)
+
+```js
+const { qa } = require('@qanalyzer/forge-wdio');
+const LoginPage = require('../pageobjects/LoginPage');
+
+describe('Login', () => {
+  it('AUTH-101 User can login with valid credentials', async () => {
+    qa.fields({ severity: 'critical', layer: 'e2e' });
+    qa.suite('E-commerce\\tAuthentication\\tLogin');
+
+    await qa.step('Open login page', async () => {
+      await LoginPage.open();
+      await expect(LoginPage.usernameInput).toBeDisplayed();
+    });
+
+    await qa.step('Login', async (step) => {
+      await step.step('Fill credentials', async () => {
+        await LoginPage.login('standard_user', 'secret_sauce');
+      });
+    });
+  });
+});
+```
+
+Prefer **Jira issue keys in test titles**. Use **`await qa.step()`** for step timelines (including nested `step.step()`).
+
+`qa.attach({ type: 'text/plain', ... })` uploads via Forge when content/path is set (still-image / small files). Use **`type`**, not `contentType`.
+
+## Run
+
+```bash
+QANALYZER_MODE=off npx wdio run wdio.conf.js
+QANALYZER_MODE=off npx wdio run wdio.cucumber.conf.js
+```

package/dist/__fixtures__/saucedemo-13.json

@@ -0,0 +1,183 @@
+{
+  "suite": "saucedemo-reference-wdio",
+  "source": "saucedemo e-commerce suite (login/inventory/cart/checkout) \u2014 titles use FR43 AUTH-* keys; steps via await qa.step()",
+  "specs": [
+    {
+      "name": "test/specs/login.spec.js",
+      "assertions": [
+        {
+          "ancestorTitles": [
+            "Login Scenarios"
+          ],
+          "title": "AUTH-101 User can login with valid credentials",
+          "status": "passed",
+          "duration": 1200,
+          "steps": [
+            "Fill in username",
+            "Fill in password",
+            "Submit login form",
+            "Verify successful login"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Login Scenarios"
+          ],
+          "title": "AUTH-102 User cannot login with invalid password",
+          "status": "passed",
+          "duration": 800,
+          "steps": [
+            "Attempt login with invalid credentials",
+            "Verify error message is shown"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Login Scenarios"
+          ],
+          "title": "AUTH-103 Locked user cannot login",
+          "status": "passed",
+          "duration": 700,
+          "steps": [
+            "Attempt login with locked user",
+            "Verify locked out error"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "test/specs/inventory.spec.js",
+      "assertions": [
+        {
+          "ancestorTitles": [
+            "Product Inventory"
+          ],
+          "title": "AUTH-104 User can browse all products",
+          "status": "passed",
+          "duration": 900,
+          "steps": [
+            "Verify Products page title",
+            "Count inventory items"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Product Inventory"
+          ],
+          "title": "AUTH-105 User can sort products by price",
+          "status": "passed",
+          "duration": 850,
+          "steps": [
+            "Select sort by price low to high",
+            "Verify prices ascending"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Product Inventory"
+          ],
+          "title": "AUTH-106 User can view product details",
+          "status": "passed",
+          "duration": 750,
+          "steps": [
+            "Click on first product name",
+            "Verify product detail page"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "test/specs/cart.spec.js",
+      "assertions": [
+        {
+          "ancestorTitles": [
+            "Cart Management"
+          ],
+          "title": "AUTH-107 User can add product to cart",
+          "status": "passed",
+          "duration": 1000,
+          "steps": [
+            "Add to cart",
+            "Verify cart badge"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Cart Management"
+          ],
+          "title": "AUTH-108 User can remove product from cart",
+          "status": "passed",
+          "duration": 950,
+          "steps": [
+            "Remove from cart",
+            "Verify empty"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Cart Management"
+          ],
+          "title": "AUTH-109 User can add multiple products to cart",
+          "status": "passed",
+          "duration": 1100,
+          "steps": [
+            "Add products",
+            "Verify count"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "test/specs/checkout.spec.js",
+      "assertions": [
+        {
+          "ancestorTitles": [
+            "Checkout Flow"
+          ],
+          "title": "AUTH-110 User can complete checkout with valid information",
+          "status": "passed",
+          "duration": 1500,
+          "steps": [
+            "Fill checkout",
+            "Finish",
+            "Verify confirmation"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Checkout Flow"
+          ],
+          "title": "AUTH-111 Checkout fails without required information",
+          "status": "passed",
+          "duration": 600,
+          "steps": [
+            "Submit empty",
+            "Verify validation"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Checkout Flow"
+          ],
+          "title": "AUTH-112 User can cancel checkout",
+          "status": "passed",
+          "duration": 700,
+          "steps": [
+            "Cancel",
+            "Verify cart"
+          ]
+        },
+        {
+          "ancestorTitles": [
+            "Checkout Flow"
+          ],
+          "title": "AUTH-113 Demo test that will be ignored in reporting",
+          "status": "pending",
+          "duration": 0,
+          "steps": [],
+          "ignore": true
+        }
+      ]
+    }
+  ]
+}

package/dist/cucumber-tags.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Map WDIO Cucumber tags → MetadataManager / issue-key sources (FR135 / FR43).
+ * Supports `@suite=…`, `@tags=…`, `@title=…` and bare `@PROJ-123` issue keys.
+ * Does not handle Qase `@QaseId`.
+ */
+export type TagLike = {
+    name: string;
+};
+export type CucumberTagApplyResult = {
+    issueKeys: string[];
+};
+/**
+ * Apply Cucumber scenario tags onto MetadataManager; return bare issue keys.
+ */
+export declare function applyCucumberTags(tags: readonly TagLike[]): CucumberTagApplyResult;

package/dist/cucumber-tags.js

@@ -0,0 +1,60 @@
+"use strict";
+/**
+ * Map WDIO Cucumber tags → MetadataManager / issue-key sources (FR135 / FR43).
+ * Supports `@suite=…`, `@tags=…`, `@title=…` and bare `@PROJ-123` issue keys.
+ * Does not handle Qase `@QaseId`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyCucumberTags = applyCucumberTags;
+const metadata_manager_1 = require("./metadata-manager");
+const ISSUE_KEY_TAG_RE = /^@?([A-Z][A-Z0-9]+-\d+)$/;
+function parseKeyValueTag(tag) {
+    const raw = tag.startsWith('@') ? tag : `@${tag}`;
+    const eq = raw.indexOf('=');
+    if (eq <= 0)
+        return null;
+    const key = raw.slice(0, eq);
+    const value = raw.slice(eq + 1).trim();
+    if (!key || !value)
+        return null;
+    return { key, value };
+}
+function extractBareIssueKey(tag) {
+    const m = tag.match(ISSUE_KEY_TAG_RE);
+    return m?.[1] ?? null;
+}
+/**
+ * Apply Cucumber scenario tags onto MetadataManager; return bare issue keys.
+ */
+function applyCucumberTags(tags) {
+    const issueKeys = [];
+    for (const tag of tags) {
+        const name = typeof tag?.name === 'string' ? tag.name.trim() : '';
+        if (!name)
+            continue;
+        const kv = parseKeyValueTag(name);
+        if (kv) {
+            switch (kv.key.toLowerCase()) {
+                case '@suite':
+                    metadata_manager_1.MetadataManager.push('qa-suite', kv.value);
+                    break;
+                case '@tags':
+                    metadata_manager_1.MetadataManager.push('qa-fields', {
+                        tags: kv.value,
+                    });
+                    break;
+                case '@title':
+                    metadata_manager_1.MetadataManager.push('qa-title', kv.value);
+                    break;
+                default:
+                    break;
+            }
+            continue;
+        }
+        const issueKey = extractBareIssueKey(name);
+        if (issueKey) {
+            issueKeys.push(issueKey);
+        }
+    }
+    return { issueKeys };
+}

package/dist/enrich-screenshots.d.ts

@@ -0,0 +1,2 @@
+import type { WdioSpecInput } from './report-builder';
+export declare function enrichSpecsWithFailureScreenshots(specs: WdioSpecInput[]): void;

package/dist/enrich-screenshots.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enrichSpecsWithFailureScreenshots = enrichSpecsWithFailureScreenshots;
+const failure_screenshot_buffer_1 = require("./failure-screenshot-buffer");
+function ensureQaMeta(assertion) {
+    if (!assertion.meta)
+        assertion.meta = {};
+    if (!assertion.meta.qa) {
+        assertion.meta.qa = {
+            framework: 'wdio',
+            host: { framework: 'wdio', reporter: '@qanalyzer/forge-wdio' },
+        };
+    }
+    return assertion.meta.qa;
+}
+function enrichSpecsWithFailureScreenshots(specs) {
+    for (const spec of specs) {
+        for (const assertion of spec.assertions) {
+            if (assertion.status !== 'failed')
+                continue;
+            const shots = failure_screenshot_buffer_1.FailureScreenshotBuffer.takeForTitle(assertion.title);
+            if (shots.length === 0)
+                continue;
+            const qa = ensureQaMeta(assertion);
+            if (!qa.attachments)
+                qa.attachments = [];
+            qa.attachments.push(...shots);
+        }
+    }
+    // Ordered fallback for any remaining shots vs remaining failed assertions
+    const leftovers = failure_screenshot_buffer_1.FailureScreenshotBuffer.takeAll();
+    if (leftovers.length === 0)
+        return;
+    let li = 0;
+    for (const spec of specs) {
+        for (const assertion of spec.assertions) {
+            if (assertion.status !== 'failed' || li >= leftovers.length)
+                continue;
+            // Skip if already has a screenshot-like attach from takeForTitle
+            const qa = ensureQaMeta(assertion);
+            const hasShot = (qa.attachments ?? []).some((a) => a.mime_type?.startsWith('image/') ||
+                /\.(png|jpe?g|webp)$/i.test(a.file_name ?? ''));
+            if (hasShot)
+                continue;
+            if (!qa.attachments)
+                qa.attachments = [];
+            qa.attachments.push(leftovers[li].attachment);
+            li += 1;
+        }
+    }
+}

package/dist/failure-screenshot-buffer.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Buffer for failure still-image wire metadata between service afterTest and publish (FR133).
+ */
+import type { QaMetaAttachmentWire } from '@qanalyzer/forge-commons';
+type ShotEntry = {
+    title: string;
+    attachment: QaMetaAttachmentWire;
+};
+export declare const FailureScreenshotBuffer: {
+    clear(): void;
+    add(title: string, attachment: QaMetaAttachmentWire): void;
+    /**
+     * Take all shots matching a test title (exact or substring), removing them from the buffer.
+     */
+    takeForTitle(title: string): QaMetaAttachmentWire[];
+    /** Drain remaining shots (ordered) for publish-time fallback. */
+    takeAll(): ShotEntry[];
+    size(): number;
+};
+export {};