cypress-qase-reporter 2.3.0 → 3.0.0-beta.1

package/README.md

@@ -20,7 +20,7 @@ run the following steps:
    ```diff
    - import { qase } from 'cypress-qase-reporter/dist/mocha'
    + import { qase } from 'cypress-qase-reporter/mocha'
-   ```                                        
+   ```
 
 2. Update reporter configuration in `cypress.config.js` and/or environment variables —
    see the [configuration reference](#configuration) below.
@@ -76,6 +76,28 @@ run the following steps:
      }
      ...
 
+## Updating from v2.3.x to v3.0.0-beta.1
+
+To update an existing test project using Qase reporter from version 2.3.x to version 3.0.0-beta.1,
+run the following steps:
+
+1. Update reporter configuration in `cypress.config.js` file.
+
+    ```diff
+   +  import { afterSpecHook } from 'cypress-qase-reporter/hooks';
+     ...
+     e2e: {
+      setupNodeEvents(on, config) { 
+        require('cypress-qase-reporter/plugin')(on, config)
+        require('cypress-qase-reporter/metadata')(on)
+   +    on('after:spec', async (spec, results) => {
+   +      await afterSpecHook(spec, config);
+   +    });
+       }
+     }
+     ...
+   ```
+
 ## Getting started
 
 The Cypress reporter can auto-generate test cases
@@ -167,6 +189,7 @@ Example `cypress.config.js` config:
 
 ```javascript
 import cypress from 'cypress';
+import { afterSpecHook } from 'cypress-qase-reporter/hooks';
 
 module.exports = cypress.defineConfig({
   reporter: 'cypress-multi-reporters',
@@ -194,6 +217,7 @@ module.exports = cypress.defineConfig({
       framework: {
         cypress: {
           screenshotsFolder: 'cypress/screenshots',
+          videosFolder: 'cypress/videos',
         }
       }
     },
@@ -203,6 +227,9 @@ module.exports = cypress.defineConfig({
     setupNodeEvents(on, config) {
       require('cypress-qase-reporter/plugin')(on, config)
       require('cypress-qase-reporter/metadata')(on)
+      on('after:spec', async (spec, results) => {
+         await afterSpecHook(spec, config);
+       });
     },
   },
 });
@@ -215,6 +242,7 @@ If you use Cucumber, you need to add the following configuration in `cypress.con
 
 ```javascript
 import cypress from 'cypress';
+import { afterSpecHook } from 'cypress-qase-reporter/hooks';
 
 const cucumber = require('cypress-cucumber-preprocessor').default;
 
@@ -254,11 +282,14 @@ module.exports = cypress.defineConfig({
       on('file:preprocessor', cucumber());
       require('cypress-qase-reporter/plugin')(on, config);
       require('cypress-qase-reporter/metadata')(on);
+      on('after:spec', async (spec, results) => {
+         await afterSpecHook(spec, config);
+       });
     },
     specPattern: 'cypress/e2e/*.feature',
   },
 });
-``` 
+```
 
 And add the following lines in `support/e2e.js` file:
 
@@ -278,5 +309,3 @@ We maintain the reporter on [LTS versions of Node](https://nodejs.org/en/about/r
 `cypress >= 8.0.0`
 
 <!-- references -->
-
-[auth]: https://developers.qase.io/#authentication

package/changelog.md

@@ -1,3 +1,10 @@
+# cypress-qase-reporter@3.0.0-beta.1
+
+## What's new
+
+- Added support for video attachments.
+- Changed reporter configuration in `cypress.config.js` file.
+
 # cypress-qase-reporter@2.3.0
 
 ## What's new

package/dist/configSchema.js

@@ -16,7 +16,11 @@ exports.configSchema = {
                         screenshotsFolder: {
                             type: 'string',
                             nullable: true,
-                        }
+                        },
+                        videosFolder: {
+                            type: 'string',
+                            nullable: true,
+                        },
                     }
                 }
             }

package/dist/fileSearcher.d.ts

@@ -9,5 +9,23 @@ export declare class FileSearcher {
      * @returns Array of absolute paths to the matching files.
      */
     static findFilesBeforeTime(screenshotFolderPath: string, specFileName: string, time: Date): string[];
+    /**
+     * Finds all mp4 video files in the given directory and its subdirectories
+     * that were created after the specified time.
+     *
+     * @param videoFolderPath Path to the folder with video files.
+     * @param specFileName Name of the spec file (without extension).
+     * @param time Time threshold as a Date object.
+     * @returns Array of absolute paths to the matching mp4 files.
+     */
+    static findVideoFilesBeforeTime(videoFolderPath: string, specFileName: string, time: Date): string[];
+    /**
+     * Finds all mp4 video files in the given directory and its subdirectories.
+     *
+     * @param videoFolderPath Path to the folder with video files.
+     * @param specFileName Name of the spec file (without extension).
+     * @returns Array of absolute paths to the matching mp4 files.
+     */
+    static findVideoFiles(videoFolderPath: string, specFileName: string): string[];
     private static findFolderByName;
 }

package/dist/fileSearcher.js

@@ -67,6 +67,74 @@ class FileSearcher {
         }
         return result;
     }
+    /**
+     * Finds all mp4 video files in the given directory and its subdirectories
+     * that were created after the specified time.
+     *
+     * @param videoFolderPath Path to the folder with video files.
+     * @param specFileName Name of the spec file (without extension).
+     * @param time Time threshold as a Date object.
+     * @returns Array of absolute paths to the matching mp4 files.
+     */
+    static findVideoFilesBeforeTime(videoFolderPath, specFileName, time) {
+        const absolutePath = path.resolve(process.cwd(), videoFolderPath);
+        const result = [];
+        const paths = this.findFolderByName(absolutePath, specFileName);
+        if (paths.length === 0) {
+            return result;
+        }
+        const searchVideoFiles = (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()) {
+                    searchVideoFiles(entryPath);
+                }
+                else if (entry.isFile()) {
+                    // Check if the file is an mp4 video file
+                    if (entry.name.toLowerCase().endsWith('.mp4')) {
+                        const stats = fs.statSync(entryPath);
+                        if (stats.birthtime > time) {
+                            result.push(entryPath);
+                        }
+                    }
+                }
+            }
+        };
+        for (const path of paths) {
+            searchVideoFiles(path);
+        }
+        return result;
+    }
+    /**
+     * Finds all mp4 video files in the given directory and its subdirectories.
+     *
+     * @param videoFolderPath Path to the folder with video files.
+     * @param specFileName Name of the spec file (without extension).
+     * @returns Array of absolute paths to the matching mp4 files.
+     */
+    static findVideoFiles(videoFolderPath, specFileName) {
+        const absolutePath = path.resolve(process.cwd(), videoFolderPath);
+        const result = [];
+        if (!fs.existsSync(absolutePath)) {
+            return result;
+        }
+        const entries = fs.readdirSync(absolutePath, { withFileTypes: true });
+        for (const entry of entries) {
+            if (entry.isFile()) {
+                const fileName = entry.name;
+                // Check if the file is an mp4 video file with the expected format: {specFileName}.cy.js.mp4
+                if (fileName.toLowerCase().endsWith('.mp4') && fileName.startsWith(specFileName)) {
+                    const entryPath = path.join(absolutePath, fileName);
+                    result.push(entryPath);
+                }
+            }
+        }
+        return result;
+    }
     static findFolderByName(startPath, folderName) {
         const result = [];
         function searchDirectory(currentPath) {

package/dist/hooks.js

@@ -1,8 +1,15 @@
 "use strict";
 /// <reference types="cypress" />
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const configSchema_1 = require("./configSchema");
+const resultsManager_1 = require("./metadata/resultsManager");
+const fileSearcher_1 = require("./fileSearcher");
+const uuid_1 = require("uuid");
+const path_1 = __importDefault(require("path"));
 async function beforeRunHook(options) {
     const configLoader = new qase_javascript_commons_1.ConfigLoader(configSchema_1.configSchema);
     const config = configLoader.load();
@@ -34,7 +41,50 @@ async function afterRunHook(options) {
     });
     await reporter.complete();
 }
+async function afterSpecHook(spec, options) {
+    const results = resultsManager_1.ResultsManager.getResults();
+    if (results) {
+        const configLoader = new qase_javascript_commons_1.ConfigLoader(configSchema_1.configSchema);
+        const config = configLoader.load();
+        const { reporterOptions } = options;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const { ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions['cypressQaseReporterReporterOptions'], config);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        const reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+            ...composedOptions,
+            frameworkPackage: 'cypress',
+            frameworkName: 'cypress',
+            reporterName: 'cypress-qase-reporter',
+        });
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+        const videosFolder = composedOptions.framework?.cypress?.videosFolder;
+        const specFileName = path_1.default.basename(spec.name, '.cy.js');
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        const videoFiles = videosFolder ? fileSearcher_1.FileSearcher.findVideoFiles(videosFolder, specFileName) : [];
+        if (videoFiles.length > 0) {
+            results.forEach((result) => {
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+                result.attachments = [...(result.attachments ?? []), ...videoFiles.map((file) => {
+                        const attachment = {
+                            content: '',
+                            id: (0, uuid_1.v4)(),
+                            mime_type: 'video/mp4',
+                            size: 0,
+                            file_name: path_1.default.basename(file),
+                            file_path: file,
+                        };
+                        return attachment;
+                    })];
+            });
+        }
+        // eslint-disable-next-line @typescript-eslint/await-thenable
+        await reporter.setTestResults(results);
+        await reporter.sendResults();
+    }
+    resultsManager_1.ResultsManager.clear();
+}
 module.exports = {
     beforeRunHook,
     afterRunHook,
+    afterSpecHook,
 };

package/dist/index.cjs.d.ts

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

package/dist/index.cjs.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableCucumberSupport = exports.qase = void 0;
+exports.ResultsManager = 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; } });
+var resultsManager_1 = require("./metadata/resultsManager");
+Object.defineProperty(exports, "ResultsManager", { enumerable: true, get: function () { return resultsManager_1.ResultsManager; } });

package/dist/metadata/resultsManager.d.ts

@@ -0,0 +1,8 @@
+import { TestResultType } from 'qase-javascript-commons';
+export declare class ResultsManager {
+    static resultsPath: string;
+    static getResults(): TestResultType[] | undefined;
+    static setResults(results: TestResultType[]): void;
+    static clear(): void;
+    private static isExists;
+}

package/dist/metadata/resultsManager.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultsManager = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+class ResultsManager {
+    static resultsPath = path_1.default.resolve(__dirname, 'qaseResults');
+    static getResults() {
+        if (!this.isExists()) {
+            return undefined;
+        }
+        let results = [];
+        try {
+            results = JSON.parse((0, fs_1.readFileSync)(this.resultsPath, 'utf8'));
+        }
+        catch (error) {
+            console.log('Error reading results file', error);
+        }
+        return results;
+    }
+    static setResults(results) {
+        try {
+            (0, fs_1.writeFileSync)(this.resultsPath, JSON.stringify(results));
+        }
+        catch (error) {
+            console.log('Error writing results file', error);
+        }
+    }
+    static clear() {
+        if (this.isExists()) {
+            try {
+                (0, fs_1.unlinkSync)(this.resultsPath);
+            }
+            catch (error) {
+                console.log('Error clearing results file', error);
+            }
+        }
+    }
+    static isExists() {
+        return (0, fs_1.existsSync)(this.resultsPath);
+    }
+}
+exports.ResultsManager = ResultsManager;

package/dist/options.d.ts

@@ -1,3 +1,4 @@
 export type ReporterOptionsType = {
     screenshotsFolder?: string;
+    videosFolder?: string;
 };

package/dist/reporter.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="cypress" />
 import { MochaOptions, reporters, Runner } from 'mocha';
-import { ConfigLoader, FrameworkOptionsType, TestStatusEnum } from 'qase-javascript-commons';
+import { ConfigLoader, TestStatusEnum } from 'qase-javascript-commons';
 import { ReporterOptionsType } from './options';
 type CypressState = 'failed' | 'passed' | 'pending';
 export type CypressQaseOptionsType = Omit<MochaOptions, 'reporterOptions'> & {
@@ -36,13 +36,12 @@ export declare class CypressQaseReporter extends reporters.Base {
      */
     private reporter;
     private testBeginTime;
-    private options;
     /**
      * @param {Runner} runner
      * @param {CypressQaseOptionsType} options
      * @param {ConfigLoaderInterface} configLoader
      */
-    constructor(runner: Runner, options: CypressQaseOptionsType, configLoader?: ConfigLoader<FrameworkOptionsType<"cypress", ReporterOptionsType>>);
+    constructor(runner: Runner, options: CypressQaseOptionsType, configLoader?: ConfigLoader<import("qase-javascript-commons").FrameworkOptionsType<"cypress", ReporterOptionsType>>);
     /**
      * @param {Runner} runner
      * @private

package/dist/reporter.js

@@ -6,13 +6,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CypressQaseReporter = void 0;
 const path_1 = __importDefault(require("path"));
 const uuid_1 = require("uuid");
-const child_process_1 = require("child_process");
+// import { spawnSync } from 'child_process';
 const mocha_1 = require("mocha");
 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 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;
 /**
  * @class CypressQaseReporter
@@ -45,13 +46,18 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
      * @private
      */
     screenshotsFolder;
+    // /**
+    //  * @type {string | undefined}
+    //  * @private
+    //  */
+    // private videosFolder: string | undefined;
     /**
      * @type {ReporterInterface}
      * @private
      */
     reporter;
     testBeginTime = Date.now();
-    options;
+    // private options: Omit<(FrameworkOptionsType<'cypress', ReporterOptionsType> & ConfigType & ReporterOptionsType & NonNullable<unknown>) | (null & ReporterOptionsType & NonNullable<unknown>), 'framework'>;
     /**
      * @param {Runner} runner
      * @param {CypressQaseOptionsType} options
@@ -63,7 +69,8 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const config = configLoader.load();
         const { framework, ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions, config);
         this.screenshotsFolder = framework?.cypress?.screenshotsFolder;
-        this.options = composedOptions;
+        // this.videosFolder = framework?.cypress?.videosFolder;
+        // this.options = composedOptions;
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...composedOptions,
             frameworkPackage: 'cypress',
@@ -87,13 +94,14 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
         runner.once(EVENT_RUN_END, () => {
             const results = this.reporter.getResults();
-            (0, child_process_1.spawnSync)('node', [`${__dirname}/child.js`], {
-                stdio: 'inherit',
-                env: Object.assign(process.env, {
-                    reporterConfig: JSON.stringify(this.options),
-                    results: JSON.stringify(results),
-                }),
-            });
+            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),
+            //   }),
+            // });
         });
     }
     /**
@@ -113,6 +121,9 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
         const files = this.screenshotsFolder ?
             fileSearcher_1.FileSearcher.findFilesBeforeTime(this.screenshotsFolder, testFileName, new Date(this.testBeginTime))
             : [];
+        // const videos = this.videosFolder ?
+        //   FileSearcher.findVideoFiles(this.videosFolder, testFileName)
+        //   : [];
         const attachments = files.map((file) => ({
             content: '',
             id: (0, uuid_1.v4)(),
@@ -121,6 +132,14 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             file_name: path_1.default.basename(file),
             file_path: file,
         }));
+        // const videoAttachments = videos.map((file) => ({
+        //   content: '',
+        //   id: uuidv4(),
+        //   mime_type: 'video/mp4',
+        //   size: 0,
+        //   file_name: path.basename(file),
+        //   file_path: file,
+        // } as Attachment));
         attachments.push(...(metadata?.attachments ?? []));
         let relations = {};
         if (test.parent !== undefined) {
@@ -175,7 +194,7 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
             group_params: metadata?.groupParams ?? {},
             relations: relations,
             run_id: null,
-            signature: this.getSignature(test, ids),
+            signature: this.getSignature(test, ids, metadata?.parameters ?? {}),
             steps: steps,
             id: (0, uuid_1.v4)(),
             execution: {
@@ -199,22 +218,19 @@ class CypressQaseReporter extends mocha_1.reporters.Base {
      * @param {number[]} ids
      * @private
      */
-    getSignature(test, ids) {
-        let signature = '';
+    getSignature(test, ids, params) {
+        const suites = [];
         const file = test.parent ? this.getFile(test.parent) : undefined;
         if (file) {
-            signature = file.split(path_1.default.sep).join('::');
+            suites.push(file.split(path_1.default.sep).join('::'));
         }
         if (test.parent) {
             for (const suite of test.parent.titlePath()) {
-                signature += '::' + suite.toLowerCase().replace(/\s/g, '_');
+                suites.push(suite.toLowerCase().replace(/\s/g, '_'));
             }
         }
-        signature += '::' + test.title.toLowerCase().replace(/\s/g, '_');
-        if (ids.length > 0) {
-            signature += '::' + ids.join('::');
-        }
-        return signature;
+        suites.push(test.title.toLowerCase().replace(/\s/g, '_'));
+        return (0, qase_javascript_commons_1.generateSignature)(ids, suites, params);
     }
     getTestFileName(test) {
         if (!test.parent) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.3.0",
+  "version": "3.0.0-beta.1",
   "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.3.0",
+    "qase-javascript-commons": "~2.3.3",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {