mocha-qase-reporter 1.0.0-beta.4 → 1.0.0

package/README.md

@@ -2,10 +2,10 @@
 
 Publish results simple and easy.
 
-To install the latest beta version, run:
+To install the latest version, run:
 
 ```sh
-npm install -D mocha-qase-reporter@beta
+npm install -D mocha-qase-reporter
 ```
 
 ## Getting started
@@ -23,15 +23,15 @@ parameterize your tests.
 For example:
 
 ```typescript
+import { qase } from 'mocha-qase-reporter/mocha';
+
 describe('My First Test', () => {
-  it('Several ids', () => {
-    this.qaseId(1);
+  it(qase(1,'Several ids'), () => {;
     expect(true).to.equal(true);
   });
 
   // a test can check multiple test cases
-  it('Correct test', () => {
-    this.qaseId([2, 3]);
+  it(qase([2,3],'Correct test'), () => {
     expect(true).to.equal(true);
   });
 
@@ -89,7 +89,7 @@ QASE_MODE=testops mocha --parallel
 After the tests are finished, you can complete the run:
 
 ```bash
-qli testops run complete --project DEMO --token token --run $(echo $QASE_TESTOPS_RUN_ID)
+qli testops run complete --project DEMO --token token --id $(echo $QASE_TESTOPS_RUN_ID)
 ```
 
 ## Configuration

package/changelog.md

@@ -1,3 +1,17 @@
+# qase-mocha@1.0.0
+
+## What's new
+
+Major release of the Cypress reporter package
+
+# qase-mocha@1.0.0-beta.5
+
+## What's new
+
+- Added a `qase` function to allow specifying QaseID for tests.
+- Marked the old syntax for QaseID as deprecated.
+- Implemented functionality to capture console logs and include them as attachments in tests.
+
 # qase-mocha@1.0.0-beta.4
 
 ## What's new

package/dist/interceptor.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Writable } from 'stream';
+export interface TestOutput {
+    stdout: string;
+    stderr: string;
+}
+export declare class StreamInterceptor extends Writable {
+    private readonly onWrite;
+    constructor(onWriteCallback: (data: string) => void);
+    _write(chunk: any, _encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
+}

package/dist/interceptor.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamInterceptor = void 0;
+const stream_1 = require("stream");
+class StreamInterceptor extends stream_1.Writable {
+    onWrite;
+    constructor(onWriteCallback) {
+        super();
+        this.onWrite = onWriteCallback;
+    }
+    _write(chunk, _encoding, callback) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-argument,@typescript-eslint/no-unsafe-call
+        this.onWrite(chunk.toString());
+        callback();
+    }
+}
+exports.StreamInterceptor = StreamInterceptor;

package/dist/mocha.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Set IDs for the test case
+ *
+ * @param caseId
+ * @param name
+ * @example
+ * it(qase(1, 'test'), function() => {
+ *  // test code
+ * });
+ * @returns {string}
+ */
+export declare const qase: (caseId: number | string | number[] | string[], name: string) => string;

package/dist/mocha.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qase = void 0;
+/**
+ * Set IDs for the test case
+ *
+ * @param caseId
+ * @param name
+ * @example
+ * it(qase(1, 'test'), function() => {
+ *  // test code
+ * });
+ * @returns {string}
+ */
+const qase = (caseId, name) => {
+    const caseIds = Array.isArray(caseId) ? caseId : [caseId];
+    const ids = [];
+    for (const id of caseIds) {
+        if (typeof id === 'number') {
+            ids.push(id);
+            continue;
+        }
+        const parsedId = parseInt(id);
+        if (!isNaN(parsedId)) {
+            ids.push(parsedId);
+            continue;
+        }
+        console.log(`qase: qase ID ${id} should be a number`);
+    }
+    return `${name} (Qase ID: ${caseIds.join(',')})`;
+};
+exports.qase = qase;

package/dist/reporter.d.ts

@@ -3,6 +3,9 @@ import { MochaOptions, reporters, Runner } from 'mocha';
 import { ConfigLoader, TestStatusEnum } from 'qase-javascript-commons';
 type MochaState = 'failed' | 'passed' | 'pending';
 export declare class MochaQaseReporter extends reporters.Base {
+    private originalStdoutWrite;
+    private originalStderrWrite;
+    private testOutputs;
     /**
      * @type {Record<CypressState, TestStatusEnum>}
      */
@@ -23,6 +26,7 @@ export declare class MochaQaseReporter extends reporters.Base {
     private applyListeners;
     private onStartRun;
     private onEndRun;
+    private addMethodsToContext;
     private addMethods;
     private onStartTest;
     private onEndTest;
@@ -63,5 +67,21 @@ export declare class MochaQaseReporter extends reporters.Base {
     }) => void;
     comment: (message: string) => void;
     step: (title: string, func: () => void) => void;
+    /**
+     * @param {string} title
+     * @returns {string}
+     * @private
+     */
+    private removeQaseIdsFromTitle;
+    /**
+     * @type {RegExp}
+     */
+    static qaseIdRegExp: RegExp;
+    /**
+     * @param {string} title
+     * @returns {number[]}
+     * @private
+     */
+    private static getCaseId;
 }
 export {};

package/dist/reporter.js

@@ -10,105 +10,41 @@ const qase_javascript_commons_1 = require("qase-javascript-commons");
 const deasync_promise_1 = __importDefault(require("deasync-promise"));
 const node_path_1 = require("node:path");
 const uuid_1 = require("uuid");
+const interceptor_1 = require("./interceptor");
 const Events = mocha_1.Runner.constants;
 class currentTest {
-    constructor() {
-        this.steps = [];
-        this.status = 'passed';
-        this.attachments = [];
-    }
+    steps = [];
+    status = 'passed';
+    attachments = [];
 }
 // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-return,@typescript-eslint/restrict-template-expressions
 const resolveParallelModeSetupFile = () => (0, node_path_1.join)(__dirname, `parallel${(0, node_path_1.extname)(__filename)}`);
 class MochaQaseReporter extends mocha_1.reporters.Base {
+    originalStdoutWrite;
+    originalStderrWrite;
+    testOutputs;
+    /**
+     * @type {Record<CypressState, TestStatusEnum>}
+     */
+    static statusMap = {
+        failed: qase_javascript_commons_1.TestStatusEnum.failed,
+        passed: qase_javascript_commons_1.TestStatusEnum.passed,
+        pending: qase_javascript_commons_1.TestStatusEnum.skipped,
+    };
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    reporter;
+    /**
+     * @type {Metadata}
+     * @private
+     */
+    metadata = new types_1.Metadata();
+    currentTest = new currentTest();
+    currentType = 'test';
     constructor(runner, options, configLoader = new qase_javascript_commons_1.ConfigLoader()) {
         super(runner, options);
-        /**
-         * @type {Metadata}
-         * @private
-         */
-        this.metadata = new types_1.Metadata();
-        this.currentTest = new currentTest();
-        this.currentType = 'test';
-        this.applyListeners = () => {
-            this.runner.on(Events.EVENT_RUN_BEGIN, () => this.onStartRun());
-            this.runner.on(Events.EVENT_RUN_END, () => this.onEndRun());
-            this.runner.on(Events.EVENT_TEST_BEGIN, (test) => this.addMethods(test.ctx));
-            this.runner.on(Events.EVENT_HOOK_BEGIN, (hook) => this.addMethods(hook.ctx));
-            this.runner.on(Events.EVENT_TEST_BEGIN, () => this.onStartTest());
-            // eslint-disable-next-line @typescript-eslint/no-misused-promises
-            this.runner.on(Events.EVENT_TEST_END, async (test) => await this.onEndTest(test));
-        };
-        this.qaseId = (id) => {
-            this.metadata.addQaseId(id);
-        };
-        this.title = (title) => {
-            this.metadata.title = title;
-        };
-        this.parameters = (values) => {
-            const stringRecord = {};
-            for (const [key, value] of Object.entries(values)) {
-                stringRecord[String(key)] = String(value);
-            }
-            this.metadata.parameters = stringRecord;
-        };
-        this.groupParameters = (values) => {
-            const stringRecord = {};
-            for (const [key, value] of Object.entries(values)) {
-                stringRecord[String(key)] = String(value);
-            }
-            this.metadata.groupParameters = stringRecord;
-        };
-        this.fields = (values) => {
-            const stringRecord = {};
-            for (const [key, value] of Object.entries(values)) {
-                stringRecord[String(key)] = String(value);
-            }
-            this.metadata.fields = stringRecord;
-        };
-        this.suite = (name) => {
-            this.metadata.suite = name;
-        };
-        this.ignore = () => {
-            this.metadata.ignore = true;
-        };
-        this.attach = (attach) => {
-            this.metadata.addAttachment(attach);
-        };
-        this.comment = (message) => {
-            this.metadata.addComment(message);
-        };
-        this.step = (title, func) => {
-            const previousType = this.currentType;
-            this.currentType = 'step';
-            const step = {
-                step_type: qase_javascript_commons_1.StepType.TEXT,
-                data: {
-                    action: title,
-                    expected_result: null,
-                },
-                execution: {
-                    start_time: Date.now(),
-                    status: qase_javascript_commons_1.StepStatusEnum.passed,
-                    end_time: null,
-                    duration: null,
-                },
-                id: '',
-                parent_id: null,
-                attachments: [],
-                steps: [],
-            };
-            try {
-                func();
-            }
-            catch (err) {
-                step.execution.status = qase_javascript_commons_1.StepStatusEnum.failed;
-                this.currentTest.status = 'failed';
-            }
-            step.execution.end_time = Date.now();
-            this.currentTest.steps.push(step);
-            this.currentType = previousType;
-        };
         const config = configLoader.load();
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...(0, qase_javascript_commons_1.composeOptions)(options, config),
@@ -123,14 +59,26 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
         else {
             this.applyListeners();
         }
+        this.originalStdoutWrite = process.stdout.write.bind(process.stdout);
+        this.originalStderrWrite = process.stderr.write.bind(process.stderr);
+        this.testOutputs = new Map();
     }
+    applyListeners = () => {
+        this.runner.on(Events.EVENT_RUN_BEGIN, () => this.onStartRun());
+        this.runner.on(Events.EVENT_RUN_END, () => this.onEndRun());
+        this.runner.on(Events.EVENT_TEST_BEGIN, (test) => this.addMethods(test));
+        this.runner.on(Events.EVENT_HOOK_BEGIN, (hook) => this.addMethodsToContext(hook.ctx));
+        this.runner.on(Events.EVENT_TEST_BEGIN, () => this.onStartTest());
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        this.runner.on(Events.EVENT_TEST_END, (test) => this.onEndTest(test));
+    };
     onStartRun() {
         this.reporter.startTestRun();
     }
     onEndRun() {
         (0, deasync_promise_1.default)(this.reporter.publish());
     }
-    addMethods(ctx) {
+    addMethodsToContext(ctx) {
         if (!ctx)
             return;
         ctx.qaseId = this.qaseId;
@@ -144,14 +92,50 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
         ctx.comment = this.comment;
         ctx.step = this.step;
     }
+    addMethods(test) {
+        const stdoutInterceptor = new interceptor_1.StreamInterceptor((data) => {
+            const output = this.testOutputs.get(test.title) ?? { stdout: '', stderr: '' };
+            output.stdout += data;
+            this.testOutputs.set(test.title, output);
+        });
+        const stderrInterceptor = new interceptor_1.StreamInterceptor((data) => {
+            const output = this.testOutputs.get(test.title) ?? { stdout: '', stderr: '' };
+            output.stderr += data;
+            this.testOutputs.set(test.title, output);
+        });
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        process.stdout.write = stdoutInterceptor.write.bind(stdoutInterceptor);
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        process.stderr.write = stderrInterceptor.write.bind(stderrInterceptor);
+        this.testOutputs.set(test.title, { stdout: '', stderr: '' });
+        this.addMethodsToContext(test.ctx);
+    }
     onStartTest() {
         this.currentType = 'test';
     }
-    async onEndTest(test) {
+    onEndTest(test) {
+        process.stdout.write = this.originalStdoutWrite;
+        process.stderr.write = this.originalStderrWrite;
+        if (this.reporter.isCaptureLogs()) {
+            const output = this.testOutputs.get(test.title);
+            if (output?.stdout) {
+                this.attach({ name: 'stdout.txt', content: output.stdout, contentType: 'text/plain' });
+            }
+            if (output?.stderr) {
+                this.attach({ name: 'stderr.txt', content: output.stderr, contentType: 'text/plain' });
+            }
+        }
         if (this.metadata.ignore) {
+            this.metadata.clear();
+            this.currentTest = new currentTest();
             return;
         }
         const ids = this.getQaseId();
+        if (ids.length === 0) {
+            ids.push(...MochaQaseReporter.getCaseId(test.title));
+        }
         const suites = this.getSuites(test);
         let relations = {};
         if (suites.length > 0) {
@@ -196,9 +180,9 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
                 thread: null,
             },
             testops_id: ids.length > 0 ? ids : null,
-            title: this.metadata.title && this.metadata.title != '' ? this.metadata.title : test.title,
+            title: this.metadata.title && this.metadata.title != '' ? this.metadata.title : this.removeQaseIdsFromTitle(test.title),
         };
-        await this.reporter.addTestResult(result);
+        (0, deasync_promise_1.default)(this.reporter.addTestResult(result));
         this.metadata.clear();
         this.currentTest = new currentTest();
     }
@@ -264,13 +248,100 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
         }
         return suites;
     }
+    qaseId = (id) => {
+        this.metadata.addQaseId(id);
+    };
+    title = (title) => {
+        this.metadata.title = title;
+    };
+    parameters = (values) => {
+        const stringRecord = {};
+        for (const [key, value] of Object.entries(values)) {
+            stringRecord[String(key)] = String(value);
+        }
+        this.metadata.parameters = stringRecord;
+    };
+    groupParameters = (values) => {
+        const stringRecord = {};
+        for (const [key, value] of Object.entries(values)) {
+            stringRecord[String(key)] = String(value);
+        }
+        this.metadata.groupParameters = stringRecord;
+    };
+    fields = (values) => {
+        const stringRecord = {};
+        for (const [key, value] of Object.entries(values)) {
+            stringRecord[String(key)] = String(value);
+        }
+        this.metadata.fields = stringRecord;
+    };
+    suite = (name) => {
+        this.metadata.suite = name;
+    };
+    ignore = () => {
+        this.metadata.ignore = true;
+    };
+    attach = (attach) => {
+        this.metadata.addAttachment(attach);
+    };
+    comment = (message) => {
+        this.metadata.addComment(message);
+    };
+    step = (title, func) => {
+        const previousType = this.currentType;
+        this.currentType = 'step';
+        const step = {
+            step_type: qase_javascript_commons_1.StepType.TEXT,
+            data: {
+                action: title,
+                expected_result: null,
+            },
+            execution: {
+                start_time: Date.now(),
+                status: qase_javascript_commons_1.StepStatusEnum.passed,
+                end_time: null,
+                duration: null,
+            },
+            id: '',
+            parent_id: null,
+            attachments: [],
+            steps: [],
+        };
+        try {
+            func();
+        }
+        catch (err) {
+            step.execution.status = qase_javascript_commons_1.StepStatusEnum.failed;
+            this.currentTest.status = 'failed';
+        }
+        step.execution.end_time = Date.now();
+        this.currentTest.steps.push(step);
+        this.currentType = previousType;
+    };
+    /**
+     * @param {string} title
+     * @returns {string}
+     * @private
+     */
+    removeQaseIdsFromTitle(title) {
+        const matches = title.match(MochaQaseReporter.qaseIdRegExp);
+        if (matches) {
+            return title.replace(matches[0], '').trimEnd();
+        }
+        return title;
+    }
+    /**
+     * @type {RegExp}
+     */
+    static qaseIdRegExp = /\(Qase ID: ([\d,]+)\)/;
+    /**
+     * @param {string} title
+     * @returns {number[]}
+     * @private
+     */
+    static getCaseId(title) {
+        const [, ids] = title.match(MochaQaseReporter.qaseIdRegExp) ?? [];
+        return ids ? ids.split(',').map((id) => Number(id)) : [];
+    }
 }
 exports.MochaQaseReporter = MochaQaseReporter;
-/**
- * @type {Record<CypressState, TestStatusEnum>}
- */
-MochaQaseReporter.statusMap = {
-    failed: qase_javascript_commons_1.TestStatusEnum.failed,
-    passed: qase_javascript_commons_1.TestStatusEnum.passed,
-    pending: qase_javascript_commons_1.TestStatusEnum.skipped,
-};

package/dist/types.d.ts

@@ -13,6 +13,10 @@ export interface Hook extends Mocha.Hook {
     ctx?: Context;
 }
 export interface Methods {
+    /**
+     * Set IDs for the test case
+     * Use `qase()` instead. This method is deprecated and kept for reverse compatibility.
+     */
     qaseId(id: number | number[]): void;
     title(title: string): void;
     parameters(values: Record<string, string>): void;

package/dist/types.js

@@ -7,6 +7,15 @@ exports.Metadata = void 0;
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const path_1 = __importDefault(require("path"));
 class Metadata {
+    ids;
+    title;
+    fields;
+    parameters;
+    groupParameters;
+    ignore;
+    suite;
+    comment;
+    attachments;
     constructor() {
         this.clear();
     }
@@ -31,6 +40,7 @@ class Metadata {
                     id: '',
                 });
             }
+            return;
         }
         this.attachments?.push({
             file_name: attach.name ?? '',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mocha-qase-reporter",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0",
   "description": "Mocha Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -9,7 +9,8 @@
   "exports": {
     ".": "./dist/index.js",
     "./reporter": "./dist/reporter.js",
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./mocha": "./dist/mocha.js"
   },
   "typesVersions": {
     "*": {