cypress-qase-reporter 3.1.2 → 3.2.0

package/README.md

@@ -259,6 +259,12 @@ module.exports = cypress.defineConfig({
 Check out the example of configuration for multiple reporters in the
 [demo project](../examples/cypress/cypress.config.js).
 
+### Multi-Project Support
+
+Qase Cypress Reporter supports sending test results to multiple Qase projects simultaneously. You can specify different test case IDs for each project using `qase.projects(mapping, it(...))`.
+
+For detailed information, configuration, and examples, see the [Multi-Project Support Guide](docs/MULTI_PROJECT.md).
+
 ## Cucumber/Gherkin Integration
 
 If you use Cucumber with Gherkin feature files in your Cypress tests, Qase reporter provides full support for both the legacy `cypress-cucumber-preprocessor` and the modern `@badeball/cypress-cucumber-preprocessor`.

package/changelog.md

@@ -1,3 +1,9 @@
+# cypress-qase-reporter@3.2.0
+
+## What's new
+
+- Added support for multi-project support.
+
 # cypress-qase-reporter@3.1.2
 
 ## What's new

package/dist/mocha.d.ts

@@ -1,6 +1,9 @@
 import { Test } from 'mocha';
+/** Project code → test case IDs for multi-project (testops_multi) mode. */
+export type ProjectMapping = Record<string, number[]>;
 export declare const qase: {
     (caseId: number | string | number[] | string[], test: Test): Test;
+    projects(mapping: ProjectMapping, nameOrTest: string | Test): string | Test;
     title(value: string): Cypress.Chainable<JQuery<void>>;
     fields(values: Record<string, string>): Cypress.Chainable<JQuery<void>>;
     ignore(): Cypress.Chainable<JQuery<void>>;

package/dist/mocha.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.qase = void 0;
+const qase_javascript_commons_1 = require("qase-javascript-commons");
 const qase = (caseId, test) => {
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (!test?.title) {
@@ -11,6 +12,24 @@ const qase = (caseId, test) => {
     return test;
 };
 exports.qase = qase;
+/**
+ * Build test title with multi-project markers (for testops_multi mode).
+ * Supports two usages:
+ * - it(qase.projects({ PROJ1: [100], PROJ2: [200] }, 'Login flow'), () => { ... }) — returns formatted title string.
+ * - qase.projects({ PROJ1: [100], PROJ2: [200] }, it('Login flow', () => { ... })) — mutates test.title and returns the test.
+ * @param mapping — e.g. { PROJ1: [1, 2], PROJ2: [3] }
+ * @param nameOrTest — test title string or Mocha Test (when passing it(...)); the test title is updated with markers so the reporter can parse testops_project_mapping.
+ */
+function isTestObject(nameOrTest) {
+    return Boolean(nameOrTest && typeof nameOrTest === 'object' && 'title' in nameOrTest && typeof nameOrTest.title === 'string');
+}
+exports.qase.projects = (mapping, nameOrTest) => {
+    if (isTestObject(nameOrTest)) {
+        nameOrTest.title = (0, qase_javascript_commons_1.formatTitleWithProjectMapping)(nameOrTest.title, mapping);
+        return nameOrTest;
+    }
+    return (0, qase_javascript_commons_1.formatTitleWithProjectMapping)(String(nameOrTest), mapping);
+};
 /**
  * Set a title for the test case
  * @param {string} value

package/dist/reporter.d.ts

@@ -13,17 +13,12 @@ export declare class CypressQaseReporter extends reporters.Base {
     /**
      * @type {RegExp}
      */
+    /** @deprecated Use parseProjectMappingFromTitle from qase-javascript-commons for multi-project support. */
     static qaseIdRegExp: RegExp;
     /**
      * @type {Record<CypressState, TestStatusEnum>}
      */
     static statusMap: Record<CypressState, TestStatusEnum>;
-    /**
-     * @param {string} title
-     * @returns {number[]}
-     * @private
-     */
-    private static getCaseId;
     /**
      * @type {string | undefined}
      * @private
@@ -114,12 +109,6 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private removeQaseIdsFromTitle;
-    /**
-     * Extracts numbers from @qaseid tags, regardless of case.
-     * @param tags - An array of tags to process.
-     * @returns An array of numbers extracted from the tags.
-     */
-    private extractQaseIds;
     private convertCypressMessages;
     private getSteps;
 }

package/dist/reporter.js

@@ -23,6 +23,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
     /**
      * @type {RegExp}
      */
+    /** @deprecated Use parseProjectMappingFromTitle from qase-javascript-commons for multi-project support. */
     static qaseIdRegExp = /\(Qase ID:? ([\d,]+)\)/;
     /**
      * @type {Record<CypressState, TestStatusEnum>}
@@ -32,15 +33,6 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         passed: qase_javascript_commons_1.TestStatusEnum.passed,
         pending: qase_javascript_commons_1.TestStatusEnum.skipped,
     };
-    /**
-     * @param {string} title
-     * @returns {number[]}
-     * @private
-     */
-    static getCaseId(title) {
-        const [, ids] = title.match(CypressQaseReporter.qaseIdRegExp) ?? [];
-        return ids ? ids.split(',').map((id) => Number(id)) : [];
-    }
     /**
      * @type {string | undefined}
      * @private
@@ -196,7 +188,9 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const end_time = Date.now();
         const duration = 0; // Skipped tests have no duration
         const start_time = this.testBeginTime || Date.now();
-        const ids = CypressQaseReporter.getCaseId(test.title);
+        const fromTitle = (0, qase_javascript_commons_1.parseProjectMappingFromTitle)(test.title);
+        const legacyIds = [...fromTitle.legacyIds];
+        const projectMapping = { ...fromTitle.projectMapping };
         const testFileName = this.getTestFileName(test);
         const files = this.screenshotsFolder ?
             fileSearcher_1.FileSearcher.findFilesBeforeTime(this.screenshotsFolder, testFileName, new Date(start_time))
@@ -230,9 +224,14 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             const file = this.getFile(test.parent);
             if (file) {
                 const tags = (0, tagParser_1.extractTags)(file, test.title);
-                ids.push(...this.extractQaseIds(tags));
+                const fromTags = (0, qase_javascript_commons_1.parseProjectMappingFromTags)(tags);
+                legacyIds.push(...fromTags.legacyIds);
+                for (const [code, idsFromTag] of Object.entries(fromTags.projectMapping)) {
+                    projectMapping[code] = [...(projectMapping[code] ?? []), ...idsFromTag];
+                }
             }
         }
+        const hasProjectMapping = Object.keys(projectMapping).length > 0;
         const result = {
             attachments: attachments,
             author: null,
@@ -243,7 +242,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             group_params: {},
             relations: relations,
             run_id: null,
-            signature: this.getSignature(test, ids, {}),
+            signature: this.getSignature(test, hasProjectMapping ? [] : legacyIds, {}),
             steps: [],
             id: (0, uuid_1.v4)(),
             execution: {
@@ -254,8 +253,11 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                 stacktrace: null,
                 thread: null,
             },
-            testops_id: ids.length > 0 ? ids : null,
-            title: this.removeQaseIdsFromTitle(test.title),
+            testops_id: !hasProjectMapping && legacyIds.length > 0
+                ? (legacyIds.length === 1 ? legacyIds[0] : legacyIds)
+                : null,
+            testops_project_mapping: hasProjectMapping ? projectMapping : null,
+            title: fromTitle.cleanedTitle || this.removeQaseIdsFromTitle(test.title),
             preparedAttachments: [],
         };
         void this.reporter.addTestResult(result);
@@ -276,7 +278,9 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             manager_1.MetadataManager.clear();
             return;
         }
-        const ids = CypressQaseReporter.getCaseId(test.title);
+        const fromTitle = (0, qase_javascript_commons_1.parseProjectMappingFromTitle)(test.title);
+        const legacyIds = [...fromTitle.legacyIds];
+        const projectMapping = { ...fromTitle.projectMapping };
         const testFileName = this.getTestFileName(test);
         const files = this.screenshotsFolder ?
             fileSearcher_1.FileSearcher.findFilesBeforeTime(this.screenshotsFolder, testFileName, new Date(this.testBeginTime))
@@ -340,10 +344,15 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                 const file = this.getFile(test.parent);
                 if (file) {
                     const tags = (0, tagParser_1.extractTags)(file, test.title);
-                    ids.push(...this.extractQaseIds(tags));
+                    const fromTags = (0, qase_javascript_commons_1.parseProjectMappingFromTags)(tags);
+                    legacyIds.push(...fromTags.legacyIds);
+                    for (const [code, idsFromTag] of Object.entries(fromTags.projectMapping)) {
+                        projectMapping[code] = [...(projectMapping[code] ?? []), ...idsFromTag];
+                    }
                 }
             }
         }
+        const hasProjectMapping = Object.keys(projectMapping).length > 0;
         const result = {
             attachments: attachments,
             author: null,
@@ -354,7 +363,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             group_params: metadata?.groupParams ?? {},
             relations: relations,
             run_id: null,
-            signature: this.getSignature(test, ids, metadata?.parameters ?? {}),
+            signature: this.getSignature(test, hasProjectMapping ? [] : legacyIds, metadata?.parameters ?? {}),
             steps: steps,
             id: (0, uuid_1.v4)(),
             execution: {
@@ -365,8 +374,11 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                 stacktrace: test.err?.stack ?? null,
                 thread: null,
             },
-            testops_id: ids.length > 0 ? ids : null,
-            title: metadata?.title ?? this.removeQaseIdsFromTitle(test.title),
+            testops_id: !hasProjectMapping && legacyIds.length > 0
+                ? (legacyIds.length === 1 ? legacyIds[0] : legacyIds)
+                : null,
+            testops_project_mapping: hasProjectMapping ? projectMapping : null,
+            title: metadata?.title ?? (fromTitle.cleanedTitle || this.removeQaseIdsFromTitle(test.title)),
             preparedAttachments: [],
         };
         void this.reporter.addTestResult(result);
@@ -428,25 +440,6 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         }
         return title;
     }
-    /**
-     * Extracts numbers from @qaseid tags, regardless of case.
-     * @param tags - An array of tags to process.
-     * @returns An array of numbers extracted from the tags.
-     */
-    extractQaseIds(tags) {
-        const qaseIdRegex = /@qaseid\((\d+(?:,\d+)*)\)/i;
-        const qaseIds = [];
-        for (const tag of tags) {
-            const match = qaseIdRegex.exec(tag);
-            if (match) {
-                const ids = match[1]?.split(',').map(id => parseInt(id, 10));
-                if (ids) {
-                    qaseIds.push(...ids);
-                }
-            }
-        }
-        return qaseIds;
-    }
     convertCypressMessages(messages, testStatus) {
         const result = [];
         const lastIndex = messages.length - 1;

package/docs/MULTI_PROJECT.md

@@ -0,0 +1,107 @@
+# Multi-Project Support in Cypress
+
+Qase Cypress Reporter supports sending test results to multiple Qase projects simultaneously. This feature allows you to report the same test execution to different projects with different test case IDs, which is useful when:
+
+* You need to report the same test to different projects
+* Different projects track the same functionality with different test case IDs
+* You want to maintain separate test runs for different environments or teams
+
+## Configuration
+
+For detailed configuration options, refer to the [qase-javascript-commons README](../../qase-javascript-commons/README.md#multi-project-support).
+
+### Basic Multi-Project Configuration
+
+To enable multi-project support, set the mode to `testops_multi` in your Cypress reporter options (e.g. in `cypress.config.js` or `qase.config.json`):
+
+```json
+{
+  "mode": "testops_multi",
+  "testops": {
+    "api": { "token": "<token>", "host": "qase.io" },
+    "batch": { "size": 100 }
+  },
+  "testops_multi": {
+    "default_project": "PROJ1",
+    "projects": [
+      {
+        "code": "PROJ1",
+        "run": { "title": "PROJ1 Cypress Run", "complete": true }
+      },
+      {
+        "code": "PROJ2",
+        "run": { "title": "PROJ2 Cypress Run", "complete": true }
+      }
+    ]
+  }
+}
+```
+
+## Using `qase.projects()`
+
+The `qase.projects(mapping, nameOrTest)` helper lets you map a test to one or more projects and case IDs.
+
+### Pass the test (recommended)
+
+Pass the result of `it()` as the second argument so the test title is updated with markers; the reporter will parse them and set `testops_project_mapping`:
+
+```javascript
+const { qase } = require('cypress-qase-reporter');
+
+describe('Suite', () => {
+  qase.projects({ PROJ1: [1], PROJ2: [2] }, it('A test reported to two projects', () => {
+    cy.visit('https://example.cypress.io');
+    cy.contains('type').click();
+  }));
+
+  qase.projects(
+    { PROJ1: [10, 11], PROJ2: [20] },
+    it('Multiple cases per project', () => {
+      cy.visit('https://example.cypress.io');
+    }),
+  );
+});
+```
+
+### Pass the title string
+
+You can also pass a title string; the helper returns the formatted title for use as the first argument to `it()`:
+
+```javascript
+it(qase.projects({ PROJ1: [100], PROJ2: [200] }, 'Login flow'), () => {
+  cy.visit('/login');
+});
+```
+
+### Combining with other Qase methods
+
+Use `qase.projects()` together with other Qase methods (e.g. `qase.title()`, `qase.attach()`) inside the test.
+
+## Tests Without Project Mapping
+
+If a test does not use `qase.projects()` and has no `(Qase PROJ: ids)` markers in the title, it is sent to the `default_project` from your configuration. If the test also has no `(Qase ID: …)` legacy ID, the result is sent to the default project without linking to a test case.
+
+## Important Notes
+
+1. **Project codes must match**: The project codes in `qase.projects({ PROJ1: [1], ... })` must exactly match the codes in `testops_multi.projects[].code`.
+
+2. **Mode requirement**: Set `mode` to `testops_multi` in your reporter config. Single-project mode (`testops`) does not use project mapping.
+
+3. **Cucumber/BDD**: When using Cypress with Cucumber (e.g. `@badeball/cypress-cucumber-preprocessor`), use tags in feature files: `@qaseid.PROJ1(1) @qaseid.PROJ2(2)`. See [Cucumber documentation](cucumber.md).
+
+## Examples
+
+See the [multi-project Cypress example](../../examples/multiProject/cypress/) for a complete runnable setup.
+
+## Troubleshooting
+
+### Results not appearing in projects
+
+* Ensure `mode` is `testops_multi` in reporter options.
+* Verify project codes in `qase.projects()` match `testops_multi.projects[].code`.
+* For Cypress, ensure you pass the test to `qase.projects(mapping, it(...))` so the title is updated with markers, or use a title that already contains `(Qase PROJ: ids)`.
+
+### Results sent to wrong project
+
+* Check the `default_project` setting for tests without explicit mapping.
+* Project codes are case-sensitive and must match exactly.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -51,7 +51,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.4.14",
+    "qase-javascript-commons": "~2.5.0",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {