cypress-qase-reporter 3.1.0 → 3.1.1

package/changelog.md

@@ -1,3 +1,9 @@
+# cypress-qase-reporter@3.1.1
+
+## What's new
+
+- Fixed an issue where the reporter was not reporting skipped tests due to failing beforeEach hooks.
+
 # cypress-qase-reporter@3.1.0
 
 ## What's new

package/dist/reporter.d.ts

@@ -35,6 +35,12 @@ export declare class CypressQaseReporter extends reporters.Base {
      */
     private reporter;
     private testBeginTime;
+    /**
+     * Set to track processed tests to identify skipped tests when beforeEach fails
+     * @type {Set<string>}
+     * @private
+     */
+    private processedTests;
     /**
      * @param {Runner} runner
      * @param {CypressQaseOptionsType} options
@@ -46,6 +52,38 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private addRunnerListeners;
+    /**
+     * Generate a unique identifier for a test
+     * @param {Test} test
+     * @returns {string}
+     * @private
+     */
+    private getTestIdentifier;
+    /**
+     * Mark a test as processed
+     * @param {Test} test
+     * @private
+     */
+    private markTestAsProcessed;
+    /**
+     * Check if a test was processed
+     * @param {Test} test
+     * @returns {boolean}
+     * @private
+     */
+    private isTestProcessed;
+    /**
+     * Handle skipped tests in a suite when beforeEach hook fails
+     * @param {Suite} suite
+     * @private
+     */
+    private handleSkippedTestsInSuite;
+    /**
+       * Add a test result for a skipped test (due to beforeEach failure)
+       * @param {Test} test
+       * @private
+       */
+    private addSkippedTestResult;
     /**
      * @param {Test} test
      * @private

package/dist/reporter.js

@@ -14,7 +14,7 @@ const manager_1 = require("./metadata/manager");
 const fileSearcher_1 = require("./fileSearcher");
 const tagParser_1 = require("./utils/tagParser");
 const resultsManager_1 = require("./metadata/resultsManager");
-const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, EVENT_TEST_BEGIN, } = mocha_1.Runner.constants;
+const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, EVENT_TEST_BEGIN, EVENT_SUITE_END } = mocha_1.Runner.constants;
 /**
  * @class CypressQaseReporter
  * @extends reporters.Base
@@ -57,6 +57,12 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
      */
     reporter;
     testBeginTime = Date.now();
+    /**
+     * Set to track processed tests to identify skipped tests when beforeEach fails
+     * @type {Set<string>}
+     * @private
+     */
+    processedTests = new Set();
     // private options: Omit<(FrameworkOptionsType<'cypress', ReporterOptionsType> & ConfigType & ReporterOptionsType & NonNullable<unknown>) | (null & ReporterOptionsType & NonNullable<unknown>), 'framework'>;
     /**
      * @param {Runner} runner
@@ -84,26 +90,161 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
      * @private
      */
     addRunnerListeners(runner) {
-        runner.on(EVENT_TEST_PASS, (test) => this.addTestResult(test));
-        runner.on(EVENT_TEST_PENDING, (test) => this.addTestResult(test));
-        runner.on(EVENT_TEST_FAIL, (test) => this.addTestResult(test));
+        runner.on(EVENT_TEST_PASS, (test) => {
+            this.markTestAsProcessed(test);
+            this.addTestResult(test);
+        });
+        runner.on(EVENT_TEST_PENDING, (test) => {
+            this.markTestAsProcessed(test);
+            this.addTestResult(test);
+        });
+        runner.on(EVENT_TEST_FAIL, (test) => {
+            this.markTestAsProcessed(test);
+            this.addTestResult(test);
+        });
         runner.on(EVENT_TEST_BEGIN, () => {
             this.testBeginTime = Date.now();
             manager_1.MetadataManager.clear();
         });
+        runner.on(EVENT_SUITE_END, (suite) => {
+            this.handleSkippedTestsInSuite(suite);
+        });
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
         runner.once(EVENT_RUN_END, () => {
             const results = this.reporter.getResults();
             resultsManager_1.ResultsManager.setResults(results);
-            // spawnSync('node', [`${__dirname}/child.js`], {
-            //   stdio: 'inherit',
-            //   env: Object.assign(process.env, {
-            //     reporterConfig: JSON.stringify(this.options),
-            //     results: JSON.stringify(results),
-            //   }),
-            // });
+            this.processedTests.clear();
         });
     }
+    /**
+     * Generate a unique identifier for a test
+     * @param {Test} test
+     * @returns {string}
+     * @private
+     */
+    getTestIdentifier(test) {
+        const file = test.parent ? this.getFile(test.parent) ?? '' : '';
+        const suitePath = test.parent ? test.parent.titlePath().join(' > ') : '';
+        let testTitle = test.fullTitle();
+        // Remove "before each" hook prefix and quotes if present (can be anywhere in the string)
+        testTitle = testTitle.replace(/"before each" hook for "/g, '');
+        // Remove trailing quote if present
+        if (testTitle.endsWith('"')) {
+            testTitle = testTitle.slice(0, -1);
+        }
+        return `${file}::${suitePath}::${testTitle}`;
+    }
+    /**
+     * Mark a test as processed
+     * @param {Test} test
+     * @private
+     */
+    markTestAsProcessed(test) {
+        const identifier = this.getTestIdentifier(test);
+        this.processedTests.add(identifier);
+    }
+    /**
+     * Check if a test was processed
+     * @param {Test} test
+     * @returns {boolean}
+     * @private
+     */
+    isTestProcessed(test) {
+        const identifier = this.getTestIdentifier(test);
+        return this.processedTests.has(identifier);
+    }
+    /**
+     * Handle skipped tests in a suite when beforeEach hook fails
+     * @param {Suite} suite
+     * @private
+     */
+    handleSkippedTestsInSuite(suite) {
+        // Get tests only from the current suite (not nested suites, they will be processed separately)
+        const tests = suite.tests ?? [];
+        // Find tests that were not processed (skipped due to beforeEach failure)
+        for (const test of tests) {
+            // Skip if test was already processed (e.g., first test that got EVENT_TEST_FAIL)
+            if (!this.isTestProcessed(test)) {
+                // Test was skipped due to beforeEach failure, report it as skipped
+                this.addSkippedTestResult(test);
+            }
+        }
+    }
+    /**
+       * Add a test result for a skipped test (due to beforeEach failure)
+       * @param {Test} test
+       * @private
+       */
+    addSkippedTestResult(test) {
+        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 testFileName = this.getTestFileName(test);
+        const files = this.screenshotsFolder ?
+            fileSearcher_1.FileSearcher.findFilesBeforeTime(this.screenshotsFolder, testFileName, new Date(start_time))
+            : [];
+        const attachments = files.map((file) => ({
+            content: '',
+            id: (0, uuid_1.v4)(),
+            mime_type: 'image/png',
+            size: 0,
+            file_name: path_1.default.basename(file),
+            file_path: file,
+        }));
+        let relations = {};
+        if (test.parent !== undefined) {
+            const data = [];
+            for (const suite of test.parent.titlePath()) {
+                data.push({
+                    title: suite,
+                    public_id: null,
+                });
+            }
+            relations = {
+                suite: {
+                    data: data,
+                },
+            };
+        }
+        // For skipped tests, we don't have metadata since the test never ran
+        // But we can still check for cucumber tags if the test has a parent with a file
+        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));
+            }
+        }
+        const result = {
+            attachments: attachments,
+            author: null,
+            fields: {},
+            message: null,
+            muted: false,
+            params: {},
+            group_params: {},
+            relations: relations,
+            run_id: null,
+            signature: this.getSignature(test, ids, {}),
+            steps: [],
+            id: (0, uuid_1.v4)(),
+            execution: {
+                status: qase_javascript_commons_1.TestStatusEnum.skipped,
+                start_time: this.testBeginTime / 1000,
+                end_time: end_time / 1000,
+                duration: duration,
+                stacktrace: null,
+                thread: null,
+            },
+            testops_id: ids.length > 0 ? ids : null,
+            title: this.removeQaseIdsFromTitle(test.title),
+            preparedAttachments: [],
+        };
+        void this.reporter.addTestResult(result);
+        // Mark as processed to avoid duplicate reporting
+        this.markTestAsProcessed(test);
+    }
     /**
      * @param {Test} test
      * @private
@@ -113,6 +254,8 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const duration = end_time - this.testBeginTime;
         const metadata = manager_1.MetadataManager.getMetadata();
         if (metadata?.ignore) {
+            // Mark as processed even if ignored to avoid duplicate reporting
+            this.markTestAsProcessed(test);
             manager_1.MetadataManager.clear();
             return;
         }
@@ -198,7 +341,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             steps: steps,
             id: (0, uuid_1.v4)(),
             execution: {
-                status: (0, qase_javascript_commons_1.determineTestStatus)(test.err || null, test.state || 'failed'),
+                status: (0, qase_javascript_commons_1.determineTestStatus)(test.err ?? null, test.state ?? 'failed'),
                 start_time: this.testBeginTime / 1000,
                 end_time: end_time / 1000,
                 duration: duration,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -51,19 +51,19 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.4.5",
+    "qase-javascript-commons": "~2.4.13",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
     "cypress": ">=8.0.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@types/jest": "^29.5.2",
-    "@types/mocha": "^10.0.1",
-    "ajv": "^8.12.0",
-    "jest": "^29.5.0",
-    "mocha": "^10.2.0",
-    "ts-jest": "^29.1.0"
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "@types/mocha": "^10.0.10",
+    "ajv": "^8.17.1",
+    "jest": "^29.7.0",
+    "mocha": "^10.8.2",
+    "ts-jest": "^29.4.5"
   }
 }

package/tsconfig.build.json

@@ -2,7 +2,9 @@
   "extends": "./tsconfig.json",
 
   "compilerOptions": {
-    "noEmit": false
+    "noEmit": false,
+    "skipLibCheck": true,
+    "types": []
   },
 
   "include": ["./src/**/*.ts", "./src/*.js"],