cypress-qase-reporter 2.2.4 → 2.2.5

package/README.md

@@ -165,7 +165,7 @@ the [Configuration reference](../qase-javascript-commons/README.md#configuration
 
 Example `cypress.config.js` config:
 
-```js
+```javascript
 import cypress from 'cypress';
 
 module.exports = cypress.defineConfig({
@@ -211,6 +211,66 @@ module.exports = cypress.defineConfig({
 Check out the example of configuration for multiple reporters in the
 [demo project](../examples/cypress/cypress.config.js).
 
+If you use Cucumber, you need to add the following configuration in `cypress.config.js`:
+
+```javascript
+import cypress from 'cypress';
+
+const cucumber = require('cypress-cucumber-preprocessor').default;
+
+module.exports = cypress.defineConfig({
+  reporter: 'cypress-multi-reporters',
+  reporterOptions: {
+    reporterEnabled: 'cypress-mochawesome-reporter, cypress-qase-reporter',
+    cypressMochawesomeReporterReporterOptions: {
+      charts: true,
+    },
+    cypressQaseReporterReporterOptions: {
+      debug: true,
+
+      testops: {
+        api: {
+          token: 'api_key',
+        },
+
+        project: 'project_code',
+        uploadAttachments: true,
+
+        run: {
+          complete: true,
+        },
+      },
+
+      framework: {
+        cypress: {
+          screenshotsFolder: 'cypress/screenshots',
+        },
+      },
+    },
+  },
+  video: false,
+  e2e: {
+    setupNodeEvents(on, config) {
+      on('file:preprocessor', cucumber());
+      require('cypress-qase-reporter/plugin')(on, config);
+      require('cypress-qase-reporter/metadata')(on);
+    },
+    specPattern: 'cypress/e2e/*.feature',
+  },
+});
+``` 
+
+And add the following lines in `support/e2e.js` file:
+
+```javascript
+import { enableCucumberSupport } from "cypress-qase-reporter";
+
+enableCucumberSupport();
+```
+
+Check out the example of configuration for multiple reporters in the
+[demo project](../examples/cypressCucumber/cypress.config.js).
+
 ## Requirements
 
 We maintain the reporter on [LTS versions of Node](https://nodejs.org/en/about/releases/).

package/changelog.md

@@ -1,3 +1,9 @@
+# cypress-qase-reporter@2.2.5
+
+## What's new
+
+Support Cucumber tests in Cypress with the `cypress-cucumber-preprocessor` plugin.
+
 # cypress-qase-reporter@2.2.4
 
 ## What's new

package/dist/cucumber.d.ts

@@ -0,0 +1 @@
+export declare const enableCucumberSupport: () => void;

package/dist/cucumber.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enableCucumberSupport = void 0;
+const CUCUMBER_TASK_NAME = 'qaseCucumberStepStart';
+const enableCucumberSupport = () => {
+    registerCypressEventListeners();
+};
+exports.enableCucumberSupport = enableCucumberSupport;
+const registerCypressEventListeners = () => {
+    Cypress.on('log:added', handleLogAdded);
+};
+const handleLogAdded = (_, entry) => {
+    if (isCucumberStep(entry)) {
+        processCucumberStep(entry);
+    }
+};
+const isCucumberStep = ({ attributes: { name, event, instrument } }) => {
+    return instrument === 'command' && !event && name === 'step';
+};
+const processCucumberStep = ({ attributes: { displayName, message } }) => {
+    sendTaskMessage(`${displayName ?? ''} ${message}`);
+};
+const sendTaskMessage = (message) => {
+    cy.task(CUCUMBER_TASK_NAME, message, { log: false });
+};

package/dist/index.cjs.d.ts

@@ -1 +1,2 @@
 export { qase } from './mocha';
+export { enableCucumberSupport } from './cucumber';

package/dist/index.cjs.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.qase = void 0;
+exports.enableCucumberSupport = exports.qase = void 0;
 var mocha_1 = require("./mocha");
 Object.defineProperty(exports, "qase", { enumerable: true, get: function () { return mocha_1.qase; } });
+var cucumber_1 = require("./cucumber");
+Object.defineProperty(exports, "enableCucumberSupport", { enumerable: true, get: function () { return cucumber_1.enableCucumberSupport; } });

package/dist/metadata/manager.d.ts

@@ -6,6 +6,7 @@ export declare class MetadataManager {
     static setIgnore(): void;
     static addStepStart(name: string): void;
     static addStepEnd(status: string): void;
+    static addCucumberStep(name: string): void;
     static addAttach(attach: Attach): void;
     static setSuite(suite: string): void;
     static setComment(comment: string): void;

package/dist/metadata/manager.js

@@ -10,6 +10,7 @@ const path_1 = __importDefault(require("path"));
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 class MetadataManager {
+    static metadataPath = path_1.default.resolve(__dirname, 'qaseMetadata');
     static getMetadata() {
         if (!this.isExists()) {
             return undefined;
@@ -23,6 +24,7 @@ class MetadataManager {
             suite: undefined,
             comment: undefined,
             steps: [],
+            cucumberSteps: [],
             currentStepId: undefined,
             firstStepName: undefined,
             attachments: [],
@@ -70,6 +72,23 @@ class MetadataManager {
         metadata.currentStepId = parentId;
         this.setMetadata(metadata);
     }
+    static addCucumberStep(name) {
+        const metadata = this.getMetadata() ?? {};
+        if (metadata.firstStepName === name) {
+            return;
+        }
+        if (!metadata.cucumberSteps) {
+            metadata.cucumberSteps = [];
+        }
+        const id = (0, uuid_1.v4)();
+        const parentId = metadata.currentStepId ?? undefined;
+        metadata.cucumberSteps.push({ timestamp: Date.now(), name, id: id, parentId: parentId });
+        metadata.currentStepId = id;
+        if (!metadata.firstStepName) {
+            metadata.firstStepName = name;
+        }
+        this.setMetadata(metadata);
+    }
     static addAttach(attach) {
         const metadata = this.getMetadata() ?? {};
         if (!metadata.attachments) {
@@ -189,4 +208,3 @@ class MetadataManager {
     }
 }
 exports.MetadataManager = MetadataManager;
-MetadataManager.metadataPath = path_1.default.resolve(__dirname, 'qaseMetadata');

package/dist/metadata/models.d.ts

@@ -9,6 +9,7 @@ export interface Metadata {
     suite?: string | undefined;
     comment?: string | undefined;
     steps?: (StepStart | StepEnd)[];
+    cucumberSteps?: StepStart[];
     currentStepId?: string | undefined;
     firstStepName?: string | undefined;
     attachments?: Attachment[];

package/dist/metadata.js

@@ -62,4 +62,10 @@ module.exports = function (on) {
             return null;
         },
     });
+    on('task', {
+        qaseCucumberStepStart(value) {
+            manager_1.MetadataManager.addCucumberStep(value);
+            return null;
+        },
+    });
 };

package/dist/reporter.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="cypress" />
 import { MochaOptions, reporters, Runner } from 'mocha';
-import { ConfigLoader, TestStatusEnum, FrameworkOptionsType } from 'qase-javascript-commons';
+import { ConfigLoader, FrameworkOptionsType, TestStatusEnum } from 'qase-javascript-commons';
 import { ReporterOptionsType } from './options';
 type CypressState = 'failed' | 'passed' | 'pending';
 export type CypressQaseOptionsType = Omit<MochaOptions, 'reporterOptions'> & {
@@ -71,6 +71,13 @@ 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;
 }
 export {};

package/dist/reporter.js

@@ -12,12 +12,25 @@ const qase_javascript_commons_1 = require("qase-javascript-commons");
 const configSchema_1 = require("./configSchema");
 const manager_1 = require("./metadata/manager");
 const fileSearcher_1 = require("./fileSearcher");
+const tagParser_1 = require("./utils/tagParser");
 const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, EVENT_TEST_BEGIN, } = mocha_1.Runner.constants;
 /**
  * @class CypressQaseReporter
  * @extends reporters.Base
  */
 class CypressQaseReporter extends mocha_1.reporters.Base {
+    /**
+     * @type {RegExp}
+     */
+    static qaseIdRegExp = /\(Qase ID:? ([\d,]+)\)/;
+    /**
+     * @type {Record<CypressState, TestStatusEnum>}
+     */
+    static statusMap = {
+        failed: qase_javascript_commons_1.TestStatusEnum.failed,
+        passed: qase_javascript_commons_1.TestStatusEnum.passed,
+        pending: qase_javascript_commons_1.TestStatusEnum.skipped,
+    };
     /**
      * @param {string} title
      * @returns {number[]}
@@ -27,6 +40,18 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const [, ids] = title.match(CypressQaseReporter.qaseIdRegExp) ?? [];
         return ids ? ids.split(',').map((id) => Number(id)) : [];
     }
+    /**
+     * @type {string | undefined}
+     * @private
+     */
+    screenshotsFolder;
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    reporter;
+    testBeginTime = Date.now();
+    options;
     /**
      * @param {Runner} runner
      * @param {CypressQaseOptionsType} options
@@ -34,7 +59,6 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
      */
     constructor(runner, options, configLoader = new qase_javascript_commons_1.ConfigLoader(configSchema_1.configSchema)) {
         super(runner, options);
-        this.testBeginTime = Date.now();
         const { reporterOptions } = options;
         const config = configLoader.load();
         const { framework, ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions, config);
@@ -58,6 +82,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         runner.on(EVENT_TEST_FAIL, (test) => this.addTestResult(test));
         runner.on(EVENT_TEST_BEGIN, () => {
             this.testBeginTime = Date.now();
+            manager_1.MetadataManager.clear();
         });
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
         runner.once(EVENT_RUN_END, () => {
@@ -82,9 +107,9 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             return;
         }
         const ids = CypressQaseReporter.getCaseId(test.title);
-        const testFile = this.getTestFileName(test);
+        const testFileName = this.getTestFileName(test);
         const files = this.screenshotsFolder ?
-            fileSearcher_1.FileSearcher.findFilesBeforeTime(path_1.default.join(this.screenshotsFolder, testFile), new Date(this.testBeginTime))
+            fileSearcher_1.FileSearcher.findFilesBeforeTime(path_1.default.join(this.screenshotsFolder, testFileName), new Date(this.testBeginTime))
             : [];
         const attachments = files.map((file) => ({
             content: '',
@@ -122,15 +147,21 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
                 },
             };
         }
-        let message = null;
-        if (metadata?.comment) {
-            message = metadata.comment;
-        }
+        let message = metadata?.comment ?? '';
         if (test.err?.message) {
-            if (message) {
-                message += '\n\n';
+            message += message ? `\n\n${test.err.message}` : test.err.message;
+        }
+        const steps = metadata?.steps ? this.getSteps(metadata.steps, metadata.stepAttachments ?? {}) : [];
+        // support for cucumber steps and metadata
+        if (metadata?.cucumberSteps && metadata.cucumberSteps.length > 0) {
+            steps.push(...this.convertCypressMessages(metadata.cucumberSteps, test.state ?? 'failed'));
+            if (test.parent) {
+                const file = this.getFile(test.parent);
+                if (file) {
+                    const tags = (0, tagParser_1.extractTags)(file, test.title);
+                    ids.push(...this.extractQaseIds(tags));
+                }
             }
-            message += test.err.message;
         }
         const result = {
             attachments: attachments ?? [],
@@ -143,7 +174,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             relations: relations,
             run_id: null,
             signature: this.getSignature(test, ids),
-            steps: metadata?.steps ? this.getSteps(metadata.steps, metadata.stepAttachments ?? {}) : [],
+            steps: steps,
             id: (0, uuid_1.v4)(),
             execution: {
                 status: test.state
@@ -220,6 +251,44 @@ 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;
+        for (const message of messages) {
+            const step = new qase_javascript_commons_1.TestStepType(qase_javascript_commons_1.StepType.TEXT);
+            step.id = message.id;
+            step.execution.status = qase_javascript_commons_1.StepStatusEnum.passed;
+            step.execution.start_time = message.timestamp;
+            step.data = {
+                action: message.name,
+                expected_result: null,
+            };
+            if (lastIndex === messages.indexOf(message) && testStatus !== 'passed') {
+                step.execution.status = qase_javascript_commons_1.StepStatusEnum.failed;
+            }
+            result.push(step);
+        }
+        return result;
+    }
     getSteps(steps, attachments) {
         const result = [];
         const stepMap = new Map();
@@ -262,15 +331,3 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
     }
 }
 exports.CypressQaseReporter = CypressQaseReporter;
-/**
- * @type {RegExp}
- */
-CypressQaseReporter.qaseIdRegExp = /\(Qase ID:? ([\d,]+)\)/;
-/**
- * @type {Record<CypressState, TestStatusEnum>}
- */
-CypressQaseReporter.statusMap = {
-    failed: qase_javascript_commons_1.TestStatusEnum.failed,
-    passed: qase_javascript_commons_1.TestStatusEnum.passed,
-    pending: qase_javascript_commons_1.TestStatusEnum.skipped,
-};

package/dist/utils/tagParser.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Extracts tags for a given scenario name from a Gherkin feature file.
+ * @param filePath - Path to the feature file.
+ * @param scenarioName - Name of the scenario to search for.
+ * @returns An array of tags found for the specified scenario.
+ */
+export declare function extractTags(filePath: string, scenarioName: string): string[];

package/dist/utils/tagParser.js

@@ -0,0 +1,61 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractTags = void 0;
+const fs = __importStar(require("fs"));
+/**
+ * Extracts tags for a given scenario name from a Gherkin feature file.
+ * @param filePath - Path to the feature file.
+ * @param scenarioName - Name of the scenario to search for.
+ * @returns An array of tags found for the specified scenario.
+ */
+function extractTags(filePath, scenarioName) {
+    // Read the file content
+    const fileContent = fs.readFileSync(filePath, 'utf-8');
+    // Split the content into lines
+    const lines = fileContent.split('\n');
+    let tags = [];
+    for (let i = 0; i < lines.length; i++) {
+        const trimmedLine = lines[i]?.trim(); // Ensure line exists and trim it
+        // Check if the line is a Scenario line and matches the provided name
+        if (trimmedLine?.startsWith('Scenario:') && trimmedLine === `Scenario: ${scenarioName}`) {
+            // Collect tags from preceding lines
+            for (let j = i - 1; j >= 0; j--) {
+                const previousLine = lines[j]?.trim(); // Ensure line exists and trim it
+                if (previousLine?.startsWith('@')) {
+                    tags = previousLine.split(/\s+/).filter(tag => tag.startsWith('@'));
+                    break;
+                }
+                else if (previousLine === '' || previousLine?.startsWith('Feature:')) {
+                    // Stop searching if an empty line or the start of a feature is reached
+                    break;
+                }
+            }
+            break; // Stop processing further as the scenario is found
+        }
+    }
+    return tags;
+}
+exports.extractTags = extractTags;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.2.4",
+  "version": "2.2.5",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -13,7 +13,8 @@
     "./package.json": "./package.json",
     "./plugin": "./dist/plugin.js",
     "./metadata": "./dist/metadata.js",
-    "./hooks": "./dist/hooks.js"
+    "./hooks": "./dist/hooks.js",
+    "./cucumber": "./dist/cucumber.js"
   },
   "typesVersions": {
     "*": {
@@ -25,6 +26,9 @@
       ],
       "reporter": [
         "./dist/reporter.d.ts"
+      ],
+      "cucumber": [
+        "./dist/cucumber.d.ts"
       ]
     }
   },