cypress-qase-reporter 2.1.0-beta.1 → 2.1.0-beta.3

package/README.md

@@ -2,57 +2,70 @@
 
 Publish results simple and easy.
 
-To install the latest version, run:
+## Installation
+
+To install the latest release version (2.0.x), run:
 
 ```sh
 npm install -D cypress-qase-reporter
 ```
 
+<!-- if there's no current beta, comment the next block
+-->
+
+To install the latest beta version (2.1.x), run:
+
+```sh
+npm install -D cypress-qase-reporter@beta
+```
+
 ## Updating from v1 to v2.1
 
-You can update a test project from using version 1 to version 2.1 in several steps:
+To update an existing test project using Qase reporter from version 1 to version 2.1,
+run the following steps:
 
-1. Change import paths:
+1. Change import paths in your test files:
 
    ```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.
 
-3. Set the hooks in the `e2e` section in `cypress.config.js`:
+3. Add a hook in the `e2e` section of `cypress.config.js`:
 
    ```diff
-   ...
-   e2e: {
-        setupNodeEvents(on, config) { 
-          + require('cypress-qase-reporter/plugin')(on, config);
-        }
-   }
-   ...
+     ...
+     e2e: {
+   +   setupNodeEvents(on, config) { 
+   +     require('cypress-qase-reporter/plugin')(on, config)
+       }
+     }
+     ...
    ```
 
-   If you are override before:run or after:run hooks, use this:
+   If you already override `before:run` or `after:run` hooks in your `cypress.config.js`, use this instead:
 
    ```diff  
    const { beforeRunHook, afterRunHook } = require('cypress-qase-reporter/hooks');
     
    ...
-   e2e: {
+     e2e: {
        setupNodeEvents(on, config) {
-           + on('before:run', async () => {
-               + console.log('override before:run');
-               + await beforeRunHook(config);
-           + });
-
-           + on('after:run', async () => {
-               + console.log('override after:run');
-               + await afterRunHook(config);
-           + });
+   +     on('before:run', async () => {
+   +       console.log('override before:run');
+   +       await beforeRunHook(config);
+   +     });
+     
+   +     on('after:run', async () => {
+   +       console.log('override after:run');
+   +       await afterRunHook(config);
+   +     });
        },
-   },
-   ...
+     },
+     ...
    ```
 
 ## Getting started

package/changelog.md

@@ -0,0 +1,68 @@
+# cypress-qase-reporter@2.1.0-beta.3
+
+## What's new
+
+Fixed an issue with the reporter completing the test run after each file with tests.
+
+# cypress-qase-reporter@2.1.0-beta.1
+
+## What's new
+
+- fixed an issue with the reporter completing the test run before all results are sent to Qase
+- fixed an issue with the reporter not sending all results to Qase
+
+Need to add the following to the `cypress.config.js` file:
+
+```diff
+...
+  e2e: {
+    setupNodeEvents(on, config) {
++      require('cypress-qase-reporter/plugin')(on, config);
+    }
+  }
+...
+```
+
+# cypress-qase-reporter@2.0.3
+
+## What's new
+
+Cypress doesn't finish the process after the last test.
+The reporter will wait for all results to be sent to Qase and will not block the process after sending.
+
+# cypress-qase-reporter@2.0.2
+
+## What's new
+
+1. Cypress kills the process after the last tests. 
+The reporter will wait for all results to be sent to Qase and will not block the process after sending.
+
+2. The reporter will collect suites and add them to results.
+
+# cypress-qase-reporter@2.0.1
+
+## What's new
+
+The reporter would mark the test as blocked if the test was skipped in Cypress.
+Now, the reporter will mark the test as skipped.
+
+# cypress-qase-reporter@2.0.0
+
+## What's new
+
+This is the first release in the 2.x series of the Cypress reporter.
+It brings new and more flexible configs, uploading results in parallel with running tests,
+and other powerful features.
+
+This changelog entry will be updated soon.
+For more information about the new features and a guide for migration from v1, refer to the
+[reporter documentation](https://github.com/qase-tms/qase-javascript/tree/main/qase-cypress#readme)
+
+# cypress-qase-reporter@2.0.0-beta.3
+
+Fixed an issue with multiple test runs created when Cypress is running 
+multiple tests in parallel.
+
+# cypress-qase-reporter@2.0.0-beta.2
+
+First major beta release for the version 2 series of the Qase Cypress reporter.

package/dist/child.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/child.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const qase_javascript_commons_1 = require("qase-javascript-commons");
+const options = JSON.parse(process.env?.reporterConfig);
+const results = JSON.parse(process.env?.results);
+const runChild = async () => {
+    const reporter = qase_javascript_commons_1.QaseReporter.getInstance(options);
+    reporter.setTestResults(results);
+    await reporter.sendResults();
+};
+runChild();

package/dist/configSchema.d.ts

@@ -0,0 +1,4 @@
+import { JSONSchemaType } from 'ajv';
+import { FrameworkOptionsType } from 'qase-javascript-commons';
+import { ReporterOptionsType } from './options';
+export declare const configSchema: JSONSchemaType<FrameworkOptionsType<'cypress', ReporterOptionsType>>;

package/dist/configSchema.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configSchema = void 0;
+exports.configSchema = {
+    type: 'object',
+    nullable: true,
+    properties: {
+        framework: {
+            type: 'object',
+            nullable: true,
+            properties: {
+                cypress: {
+                    type: 'object',
+                    nullable: true,
+                    properties: {
+                        screenshotsFolder: {
+                            type: 'string',
+                            nullable: true,
+                        }
+                    }
+                }
+            }
+        }
+    }
+};

package/dist/hooks.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks.js

@@ -0,0 +1,40 @@
+"use strict";
+/// <reference types="cypress" />
+Object.defineProperty(exports, "__esModule", { value: true });
+const qase_javascript_commons_1 = require("qase-javascript-commons");
+const configSchema_1 = require("./configSchema");
+async function beforeRunHook(options) {
+    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-call
+    await reporter.startTestRunAsync();
+}
+async function afterRunHook(options) {
+    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',
+    });
+    await reporter.complete();
+}
+module.exports = {
+    beforeRunHook,
+    afterRunHook,
+};

package/dist/index.cjs.d.ts

@@ -0,0 +1 @@
+export { qase } from './mocha';

package/dist/index.cjs.js

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

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { CypressQaseReporter } from './reporter';
+export = CypressQaseReporter;

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+const reporter_1 = require("./reporter");
+module.exports = reporter_1.CypressQaseReporter;

package/dist/mocha.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="cypress" />
+import { Test } from 'mocha';
+export declare const qase: (caseId: number | string | number[] | string[], test: Test) => Test;

package/dist/mocha.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qase = void 0;
+const qase = (caseId, test) => {
+    const caseIds = Array.isArray(caseId) ? caseId : [caseId];
+    test.title = `${test.title} (Qase ID: ${caseIds.join(',')})`;
+    return test;
+};
+exports.qase = qase;

package/dist/options.d.ts

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

package/dist/options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/plugin.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugin.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const hooks_1 = require("./hooks");
+module.exports = function (on, config) {
+    on('before:run', async () => {
+        await (0, hooks_1.beforeRunHook)(config);
+    });
+    on('after:run', async () => {
+        await (0, hooks_1.afterRunHook)(config);
+    });
+};

package/dist/reporter.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="cypress" />
+import { MochaOptions, reporters, Runner } from 'mocha';
+import { ConfigLoader, TestStatusEnum, FrameworkOptionsType } from 'qase-javascript-commons';
+import { ReporterOptionsType } from './options';
+type CypressState = 'failed' | 'passed' | 'pending';
+export type CypressQaseOptionsType = Omit<MochaOptions, 'reporterOptions'> & {
+    reporterOptions: ReporterOptionsType;
+};
+/**
+ * @class CypressQaseReporter
+ * @extends reporters.Base
+ */
+export declare class CypressQaseReporter extends reporters.Base {
+    /**
+     * @type {RegExp}
+     */
+    static qaseIdRegExp: RegExp;
+    /**
+     * @type {Record<CypressState, TestStatusEnum>}
+     */
+    static statusMap: Record<CypressState, TestStatusEnum>;
+    /**
+     * @param {string} title
+     * @returns {number[]}
+     * @private
+     */
+    private static getCaseId;
+    /**
+     * @param {number[]} ids
+     * @param {string} dir
+     * @returns {Attachment[]}
+     * @private
+     */
+    private static findAttachments;
+    /**
+     * @type {string | undefined}
+     * @private
+     */
+    private screenshotsFolder;
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    private reporter;
+    private options;
+    /**
+     * @param {Runner} runner
+     * @param {CypressQaseOptionsType} options
+     * @param {ConfigLoaderInterface} configLoader
+     */
+    constructor(runner: Runner, options: CypressQaseOptionsType, configLoader?: ConfigLoader<FrameworkOptionsType<"cypress", ReporterOptionsType>>);
+    /**
+     * @param {Runner} runner
+     * @private
+     */
+    private addRunnerListeners;
+    /**
+     * @param {Test} test
+     * @private
+     */
+    private addTestResult;
+    /**
+     * @param {Test} test
+     * @param {number[]} ids
+     * @private
+     */
+    private getSignature;
+    /**
+     * @param {Suite} suite
+     * @private
+     */
+    private getFile;
+}
+export {};

package/dist/reporter.js

@@ -0,0 +1,194 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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");
+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 { EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING, EVENT_RUN_END, } = mocha_1.Runner.constants;
+/**
+ * @class CypressQaseReporter
+ * @extends reporters.Base
+ */
+class CypressQaseReporter extends mocha_1.reporters.Base {
+    /**
+     * @param {string} title
+     * @returns {number[]}
+     * @private
+     */
+    static getCaseId(title) {
+        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
+     * @param {ConfigLoaderInterface} configLoader
+     */
+    constructor(runner, options, configLoader = new qase_javascript_commons_1.ConfigLoader(configSchema_1.configSchema)) {
+        super(runner, options);
+        const { reporterOptions } = options;
+        const config = configLoader.load();
+        const { framework, ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(reporterOptions, config);
+        this.screenshotsFolder = framework?.cypress?.screenshotsFolder;
+        this.options = composedOptions;
+        this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+            ...composedOptions,
+            frameworkPackage: 'cypress',
+            frameworkName: 'cypress',
+            reporterName: 'cypress-qase-reporter',
+        });
+        this.addRunnerListeners(runner);
+    }
+    /**
+     * @param {Runner} runner
+     * @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));
+        // 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),
+                }),
+            });
+        });
+    }
+    /**
+     * @param {Test} test
+     * @private
+     */
+    addTestResult(test) {
+        const ids = CypressQaseReporter.getCaseId(test.title);
+        const attachments = this.screenshotsFolder
+            ? CypressQaseReporter.findAttachments(ids, this.screenshotsFolder)
+            : undefined;
+        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,
+                },
+            };
+        }
+        const result = {
+            attachments: attachments ?? [],
+            author: null,
+            fields: {},
+            message: test.err?.message ?? null,
+            muted: false,
+            params: {},
+            relations: relations,
+            run_id: null,
+            signature: this.getSignature(test, ids),
+            steps: [],
+            id: (0, uuid_1.v4)(),
+            execution: {
+                status: test.state
+                    ? CypressQaseReporter.statusMap[test.state]
+                    : qase_javascript_commons_1.TestStatusEnum.invalid,
+                start_time: null,
+                end_time: null,
+                duration: test.duration ?? 0,
+                stacktrace: test.err?.stack ?? null,
+                thread: null,
+            },
+            testops_id: ids.length > 0 ? ids : null,
+            title: test.title,
+        };
+        void this.reporter.addTestResult(result);
+    }
+    /**
+     * @param {Test} test
+     * @param {number[]} ids
+     * @private
+     */
+    getSignature(test, ids) {
+        let signature = '';
+        const file = test.parent ? this.getFile(test.parent) : undefined;
+        if (file) {
+            signature = file.split('/').join('::');
+        }
+        if (test.parent) {
+            for (const suite of test.parent.titlePath()) {
+                signature += '::' + suite.toLowerCase().replace(/\s/g, '_');
+            }
+        }
+        signature += '::' + test.title.toLowerCase().replace(/\s/g, '_');
+        if (ids.length > 0) {
+            signature += '::' + ids.join('::');
+        }
+        return signature;
+    }
+    /**
+     * @param {Suite} suite
+     * @private
+     */
+    getFile(suite) {
+        if (suite.file) {
+            return suite.file;
+        }
+        if (suite.parent) {
+            return this.getFile(suite.parent);
+        }
+        return undefined;
+    }
+}
+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/traverse-dir.d.ts

@@ -0,0 +1 @@
+export declare const traverseDir: (dirPath: string, callback: (filePath: string) => void) => void;

package/dist/utils/traverse-dir.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traverseDir = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+// TODO: get rid of recursion
+const traverseDir = (dirPath, callback) => {
+    const items = (0, fs_1.readdirSync)(dirPath, { withFileTypes: true });
+    items.forEach((item) => {
+        const itemPath = path_1.default.join(dirPath, item.name);
+        if (item.isFile()) {
+            callback(itemPath);
+        }
+        else if (item.isDirectory()) {
+            try {
+                (0, exports.traverseDir)(itemPath, callback);
+            }
+            catch (error) { /* ignore */ }
+        }
+    });
+};
+exports.traverseDir = traverseDir;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.1.0-beta.1",
+  "version": "2.1.0-beta.3",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -11,7 +11,8 @@
     "./mocha": "./dist/mocha.js",
     "./reporter": "./dist/reporter.js",
     "./package.json": "./package.json",
-    "./plugin": "./dist/plugin.js"
+    "./plugin": "./dist/plugin.js",
+    "./hooks": "./dist/hooks.js"
   },
   "typesVersions": {
     "*": {
@@ -59,8 +60,5 @@
     "jest": "^29.5.0",
     "mocha": "^10.2.0",
     "ts-jest": "^29.1.0"
-  },
-  "files": [
-    "plugin.js"
-  ]
+  }
 }

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+
+  "compilerOptions": {
+    "noEmit": false
+  },
+
+  "include": ["./src/**/*.ts", "./src/*.js"],
+}