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

package/README.md

@@ -2,27 +2,58 @@
 
 Publish results simple and easy.
 
-## How to install
-
 To install the latest version, run:
 
 ```sh
 npm install -D cypress-qase-reporter
 ```
 
-## Updating from v1
+## Updating from v1 to v2.1
+
+You can update a test project from using version 1 to version 2.1 in several steps:
 
-You can update a test project from using version 1 to version 2 in several steps:
+1. Change import paths:
 
-1.  Change import paths:
+   ```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.
 
-    ```diff
-    - import { qase } from 'cypress-qase-reporter/dist/mocha'
-    + import { qase } from 'cypress-qase-reporter/mocha'
-    ```
+3. Set the hooks in the `e2e` section in `cypress.config.js`:
 
-2.  Update reporter configuration in `cypress.config.js` and/or environment variables —
-    see the [configuration reference](#configuration) below.
+   ```diff
+   ...
+   e2e: {
+        setupNodeEvents(on, config) { 
+          + require('cypress-qase-reporter/plugin')(on, config);
+        }
+   }
+   ...
+   ```
+
+   If you are override before:run or after:run hooks, use this:
+
+   ```diff  
+   const { beforeRunHook, afterRunHook } = require('cypress-qase-reporter/hooks');
+    
+   ...
+   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);
+           + });
+       },
+   },
+   ...
+   ```
 
 ## Getting started
 
@@ -43,20 +74,20 @@ import { qase } from 'cypress-qase-reporter/mocha';
 
 describe('My First Test', () => {
   qase(1,
-          it('Several ids', () => {
-            expect(true).to.equal(true);
-          })
+    it('Several ids', () => {
+      expect(true).to.equal(true);
+    })
   );
   // a test can check multiple test cases
   qase([2, 3],
-          it('Correct test', () => {
-            expect(true).to.equal(true);
-          })
+    it('Correct test', () => {
+      expect(true).to.equal(true);
+    })
   );
   qase(4,
-          it.skip('Skipped test', () => {
-            expect(true).to.equal(true);
-          })
+    it.skip('Skipped test', () => {
+      expect(true).to.equal(true);
+    })
   );
 });
 ```
@@ -88,11 +119,13 @@ https://app.qase.io/run/QASE_PROJECT_CODE
 ## Configuration
 
 Qase Cypress reporter can be configured in multiple ways:
+
 - by adding configuration block in `cypress.config.js`,
 - using a separate config file `qase.config.json`,
 - using environment variables (they override the values from the configuration files).
 
-For a full list of configuration options, see the [Configuration reference](../qase-javascript-commons/README.md#configuration).
+For a full list of configuration options, see
+the [Configuration reference](../qase-javascript-commons/README.md#configuration).
 
 Example `cypress.config.js` config:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.0.2",
+  "version": "2.1.0-beta.1",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -10,7 +10,8 @@
     ".": "./dist/index.js",
     "./mocha": "./dist/mocha.js",
     "./reporter": "./dist/reporter.js",
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./plugin": "./dist/plugin.js"
   },
   "typesVersions": {
     "*": {
@@ -44,7 +45,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0",
+    "qase-javascript-commons": "~2.1.0-beta.1",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
@@ -58,5 +59,8 @@
     "jest": "^29.5.0",
     "mocha": "^10.2.0",
     "ts-jest": "^29.1.0"
-  }
+  },
+  "files": [
+    "plugin.js"
+  ]
 }

package/changelog.md

@@ -1,36 +0,0 @@
-# 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/configSchema.d.ts

@@ -1,4 +0,0 @@
-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

@@ -1,25 +0,0 @@
-"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/index.cjs.d.ts

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

package/dist/index.cjs.js

@@ -1,5 +0,0 @@
-"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

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

package/dist/index.js

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

package/dist/mocha.d.ts

@@ -1,2 +0,0 @@
-import { Test } from 'mocha';
-export declare const qase: (caseId: number | string | number[] | string[], test: Test) => Test;

package/dist/mocha.js

@@ -1,9 +0,0 @@
-"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

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

package/dist/options.js

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

package/dist/reporter.d.ts

@@ -1,65 +0,0 @@
-import { MochaOptions, reporters, Runner } from 'mocha';
-import { ConfigLoader, TestStatusEnum } 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;
-    /**
-     * @param {Runner} runner
-     * @param {CypressQaseOptionsType} options
-     * @param {ConfigLoaderInterface} configLoader
-     */
-    constructor(runner: Runner, options: CypressQaseOptionsType, configLoader?: ConfigLoader<import("qase-javascript-commons").FrameworkOptionsType<"cypress", ReporterOptionsType>>);
-    /**
-     * @param {Runner} runner
-     * @private
-     */
-    private addRunnerListeners;
-    /**
-     * @param {Test} test
-     * @private
-     */
-    private addTestResult;
-    /**
-     * @private
-     */
-    private preventExit;
-}
-export {};

package/dist/reporter.js

@@ -1,168 +0,0 @@
-"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 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, EVENT_RUN_BEGIN, } = mocha_1.Runner.constants;
-// eslint-disable-next-line @typescript-eslint/unbound-method
-const _exit = process.exit;
-/**
- * @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.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.on(EVENT_RUN_BEGIN, () => this.reporter.startTestRun());
-        // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        runner.once(EVENT_RUN_END, async () => {
-            this.preventExit();
-            await this.reporter.publish();
-            if (process.exitCode !== undefined) {
-                process.exit(process.exitCode);
-            }
-        });
-    }
-    /**
-     * @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: '',
-            steps: [],
-            id: test.id,
-            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);
-    }
-    /**
-     * @private
-     */
-    preventExit() {
-        const mutableProcess = process;
-        mutableProcess.exit = (code) => {
-            process.exitCode = code || 0;
-            process.exit = _exit;
-        };
-    }
-}
-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

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

package/dist/utils/traverse-dir.js

@@ -1,25 +0,0 @@
-"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/tsconfig.build.json

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