cypress-qase-reporter 2.0.0-beta.0 → 2.0.0-beta.1

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/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,2 @@
+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/reporter.d.ts

@@ -0,0 +1,65 @@
+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 {string[]}
+     * @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

@@ -0,0 +1,130 @@
+"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 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 {string[]}
+     * @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(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 = new qase_javascript_commons_1.QaseReporter({
+            ...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, 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;
+        const result = {
+            id: test.id,
+            testOpsId: ids,
+            title: test.title,
+            suiteTitle: test.parent?.titlePath(),
+            status: test.state
+                ? CypressQaseReporter.statusMap[test.state]
+                : qase_javascript_commons_1.TestStatusEnum.invalid,
+            duration: test.duration ?? 0,
+            error: test.err,
+            attachments,
+        };
+        this.reporter.addTestResult(result);
+    }
+    /**
+     * @private
+     */
+    preventExit() {
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        const _exit = process.exit;
+        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.blocked,
+};

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.0.0-beta.0",
+  "version": "2.0.0-beta.1",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -44,7 +44,7 @@
   "author": "Nikita Fedorov <nik333r@gmail.com>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0-beta.0"
+    "qase-javascript-commons": "^2.0.0-beta.1"
   },
   "peerDependencies": {
     "cypress": ">=8.0.0"