cypress-qase-reporter 2.2.3 → 2.2.4

package/changelog.md

@@ -1,3 +1,9 @@
+# cypress-qase-reporter@2.2.4
+
+## What's new
+
+Fixed an issue with screenshots not being uploaded to Qase for failed tests.
+
 # cypress-qase-reporter@2.2.3
 
 ## What's new

package/dist/fileSearcher.d.ts

@@ -0,0 +1,11 @@
+export declare class FileSearcher {
+    /**
+     * Finds all files in the given directory and its subdirectories
+     * that were created after the specified time.
+     *
+     * @param folderPath Relative path to the folder.
+     * @param time Time threshold as a Date object.
+     * @returns Array of absolute paths to the matching files.
+     */
+    static findFilesBeforeTime(folderPath: string, time: Date): string[];
+}

package/dist/fileSearcher.js

@@ -0,0 +1,63 @@
+"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.FileSearcher = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+class FileSearcher {
+    /**
+     * Finds all files in the given directory and its subdirectories
+     * that were created after the specified time.
+     *
+     * @param folderPath Relative path to the folder.
+     * @param time Time threshold as a Date object.
+     * @returns Array of absolute paths to the matching files.
+     */
+    static findFilesBeforeTime(folderPath, time) {
+        const absolutePath = path.resolve(process.cwd(), folderPath);
+        const result = [];
+        const searchFiles = (dir) => {
+            if (!fs.existsSync(dir)) {
+                return;
+            }
+            const entries = fs.readdirSync(dir, { withFileTypes: true });
+            for (const entry of entries) {
+                const entryPath = path.join(dir, entry.name);
+                if (entry.isDirectory()) {
+                    searchFiles(entryPath);
+                }
+                else if (entry.isFile()) {
+                    const stats = fs.statSync(entryPath);
+                    if (stats.birthtime > time) {
+                        result.push(entryPath);
+                    }
+                }
+            }
+        };
+        searchFiles(absolutePath);
+        return result;
+    }
+}
+exports.FileSearcher = FileSearcher;

package/dist/reporter.d.ts

@@ -25,13 +25,6 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private static getCaseId;
-    /**
-     * @param {number[]} ids
-     * @param {string} dir
-     * @returns {Attachment[]}
-     * @private
-     */
-    private static findAttachments;
     /**
      * @type {string | undefined}
      * @private
@@ -42,6 +35,7 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private reporter;
+    private testBeginTime;
     private options;
     /**
      * @param {Runner} runner
@@ -65,6 +59,7 @@ export declare class CypressQaseReporter extends reporters.Base {
      * @private
      */
     private getSignature;
+    private getTestFileName;
     /**
      * @param {Suite} suite
      * @private

package/dist/reporter.js

@@ -9,10 +9,10 @@ const uuid_1 = require("uuid");
 const child_process_1 = require("child_process");
 const mocha_1 = require("mocha");
 const qase_javascript_commons_1 = require("qase-javascript-commons");
-const traverse_dir_1 = require("./utils/traverse-dir");
 const configSchema_1 = require("./configSchema");
 const manager_1 = require("./metadata/manager");
-const { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, } = mocha_1.Runner.constants;
+const fileSearcher_1 = require("./fileSearcher");
+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
@@ -27,32 +27,6 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const [, ids] = title.match(CypressQaseReporter.qaseIdRegExp) ?? [];
         return ids ? ids.split(',').map((id) => Number(id)) : [];
     }
-    /**
-     * @param {number[]} ids
-     * @param {string} dir
-     * @returns {Attachment[]}
-     * @private
-     */
-    static findAttachments(ids, dir) {
-        const idSet = new Set(ids);
-        const attachments = [];
-        try {
-            (0, traverse_dir_1.traverseDir)(path_1.default.join(process.cwd(), dir), (filePath) => {
-                if (CypressQaseReporter.getCaseId(filePath).some((item) => idSet.has(item))) {
-                    attachments.push({
-                        content: '',
-                        id: (0, uuid_1.v4)(),
-                        mime_type: '', size: 0,
-                        file_name: path_1.default.basename(filePath),
-                        file_path: filePath,
-                    });
-                }
-            });
-        }
-        catch (error) { /* ignore */
-        }
-        return attachments;
-    }
     /**
      * @param {Runner} runner
      * @param {CypressQaseOptionsType} options
@@ -60,6 +34,7 @@ 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);
@@ -81,6 +56,9 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         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_BEGIN, () => {
+            this.testBeginTime = Date.now();
+        });
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
         runner.once(EVENT_RUN_END, () => {
             const results = this.reporter.getResults();
@@ -104,10 +82,19 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             return;
         }
         const ids = CypressQaseReporter.getCaseId(test.title);
-        const attachments = this.screenshotsFolder
-            ? CypressQaseReporter.findAttachments(ids, this.screenshotsFolder)
-            : undefined;
-        attachments?.push(...(metadata?.attachments ?? []));
+        const testFile = this.getTestFileName(test);
+        const files = this.screenshotsFolder ?
+            fileSearcher_1.FileSearcher.findFilesBeforeTime(path_1.default.join(this.screenshotsFolder, testFile), new Date(this.testBeginTime))
+            : [];
+        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,
+        }));
+        attachments.push(...(metadata?.attachments ?? []));
         let relations = {};
         if (test.parent !== undefined) {
             const data = [];
@@ -196,6 +183,18 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         }
         return signature;
     }
+    getTestFileName(test) {
+        if (!test.parent) {
+            return '';
+        }
+        const file = this.getFile(test.parent);
+        if (!file) {
+            return '';
+        }
+        const pathParts = file.split('/');
+        const fileName = pathParts[pathParts.length - 1];
+        return fileName ? fileName : '';
+    }
     /**
      * @param {Suite} suite
      * @private

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,