mocha-qase-reporter 1.1.6 → 1.1.8

package/changelog.md

@@ -1,3 +1,9 @@
+# qase-mocha@1.1.8
+
+## What's new
+
+- Added support for expected results and data for steps.
+
 # qase-mocha@1.1.6
 
 ## What's new

package/dist/extraReporters.js

@@ -83,19 +83,14 @@ function createExtraReporters(runner, options, extraReportersConfig) {
                 // Create reporter instance with clean options (without main reporter options)
                 const cleanOptions = {
                     ...options,
-                    // Remove main reporter specific options
+                    // Remove main reporter property
                     reporter: undefined,
-                    reporterOptions: undefined,
-                    'reporter-option': undefined,
-                    reporterOption: undefined,
-                    // Add extra reporter specific options
-                    ...reporterOptions
+                    // Add extra reporter specific options to all reporter option properties
+                    // This ensures compatibility with different reporters that may expect different property names
+                    reporterOptions,
+                    reporterOption: reporterOptions,
+                    'reporter-option': reporterOptions
                 };
-                // Special handling for JSON reporter
-                if (reporterName === 'json' && reporterOptions['output']) {
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                    cleanOptions.reporterOption = { output: reporterOptions['output'] };
-                }
                 const reporter = new ReporterClass(runner, cleanOptions);
                 reporters.push(reporter);
             }

package/dist/reporter.d.ts

@@ -66,7 +66,7 @@ export declare class MochaQaseReporter extends reporters.Base {
         contentType?: string;
     }) => void;
     comment: (message: string) => void;
-    step: (title: string, func: () => void) => void;
+    step: (title: string, func: () => void, expectedResult?: string, data?: string) => void;
     /**
      * @param {string} title
      * @returns {string}
@@ -83,5 +83,12 @@ export declare class MochaQaseReporter extends reporters.Base {
      * @private
      */
     private static getCaseId;
+    /**
+     * Extract expected result and data from step title and return cleaned string
+     * @param {string} input
+     * @returns {{expectedResult: string | null, data: string | null, cleanedString: string}}
+     * @private
+     */
+    private extractAndCleanStep;
 }
 export {};

package/dist/reporter.js

@@ -129,11 +129,9 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
             output.stderr += data;
             this.testOutputs.set(test.title, output);
         });
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-expect-error
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment,@typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call
         process.stdout.write = stdoutInterceptor.write.bind(stdoutInterceptor);
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-expect-error
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment,@typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call
         process.stderr.write = stderrInterceptor.write.bind(stderrInterceptor);
         this.testOutputs.set(test.title, { stdout: '', stderr: '' });
         this.addMethodsToContext(test.ctx);
@@ -311,15 +309,19 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
     comment = (message) => {
         this.metadata.addComment(message);
     };
-    step = (title, func) => {
+    step = (title, func, expectedResult, data) => {
         const previousType = this.currentType;
         this.currentType = 'step';
+        const stepTitle = expectedResult || data
+            ? `${title} QaseExpRes:${expectedResult ? `: ${expectedResult}` : ''} QaseData:${data ? `: ${data}` : ''}`
+            : title;
+        const stepData = this.extractAndCleanStep(stepTitle);
         const step = {
             step_type: qase_javascript_commons_1.StepType.TEXT,
             data: {
-                action: title,
-                expected_result: null,
-                data: null,
+                action: stepData.cleanedString,
+                expected_result: stepData.expectedResult,
+                data: stepData.data,
             },
             execution: {
                 start_time: Date.now(),
@@ -368,5 +370,31 @@ class MochaQaseReporter extends mocha_1.reporters.Base {
         const [, ids] = title.match(MochaQaseReporter.qaseIdRegExp) ?? [];
         return ids ? ids.split(',').map((id) => Number(id)) : [];
     }
+    /**
+     * Extract expected result and data from step title and return cleaned string
+     * @param {string} input
+     * @returns {{expectedResult: string | null, data: string | null, cleanedString: string}}
+     * @private
+     */
+    extractAndCleanStep(input) {
+        let expectedResult = null;
+        let data = null;
+        let cleanedString = input;
+        const hasExpectedResult = input.includes('QaseExpRes:');
+        const hasData = input.includes('QaseData:');
+        if (hasExpectedResult || hasData) {
+            const regex = /QaseExpRes:\s*:?\s*(.*?)\s*(?=QaseData:|$)QaseData:\s*:?\s*(.*)?/;
+            const match = input.match(regex);
+            if (match) {
+                expectedResult = match[1]?.trim() ?? null;
+                data = match[2]?.trim() ?? null;
+                cleanedString = input
+                    .replace(/QaseExpRes:\s*:?\s*.*?(?=QaseData:|$)/, '')
+                    .replace(/QaseData:\s*:?\s*.*/, '')
+                    .trim();
+            }
+        }
+        return { expectedResult, data, cleanedString };
+    }
 }
 exports.MochaQaseReporter = MochaQaseReporter;

package/dist/types.d.ts

@@ -29,7 +29,7 @@ export interface Methods {
         contentType?: string;
     }): void;
     comment(message: string): void;
-    step(title: string, func: () => void): void;
+    step(title: string, func: () => void, expectedResult?: string, data?: string): void;
 }
 export declare class Metadata {
     ids?: number[];

package/docs/usage.md

@@ -184,7 +184,7 @@ describe('User Authentication', function() {
 ## Adding Steps to a Test
 
 You can add custom steps to your test cases using the `this.step()` method. Each step should
-have a title and optionally a function.
+have a title and optionally a function. You can also provide an expected result and input data for each step, which will be displayed in Qase.
 
 ### Example
 
@@ -210,6 +210,26 @@ describe('User Authentication', function() {
 });
 ```
 
+### Example with Expected Result and Data
+
+```javascript
+const { qase } = require('mocha-qase-reporter/mocha');
+
+describe('User Authentication', function() {
+  it('test with steps including expected results and data', function() {
+    this.step('Click button', function() {
+      // Click action
+    }, 'Button should be clicked', 'Button data');
+    
+    this.step('Fill form', function() {
+      // Form filling action
+    }, 'Form should be filled', 'Form input data');
+    
+    expect(true).to.equal(true);
+  });
+});
+```
+
 ---
 
 ## Attaching Files to a Test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mocha-qase-reporter",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "Mocha Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -41,19 +41,19 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "mocha": "^11.0.0",
+    "mocha": "^11.7.5",
     "deasync-promise": "^1.0.1",
-    "qase-javascript-commons": "~2.4.8",
+    "qase-javascript-commons": "~2.4.13",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@types/deasync-promise": "^1.0.2",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.2.4",
-    "@types/request": "^2.48.8",
-    "@typescript-eslint/eslint-plugin": "^5.59.7",
-    "@typescript-eslint/parser": "^5.59.7",
-    "eslint": "^8.41.0",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20.19.25",
+    "@types/request": "^2.48.13",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "eslint": "^8.57.1",
     "prettier": "^2.8.8"
   }
 }

package/tsconfig.build.json

@@ -2,7 +2,9 @@
   "extends": "./tsconfig.json",
 
   "compilerOptions": {
-    "noEmit": false
+    "noEmit": false,
+    "skipLibCheck": true,
+    "types": []
   },
 
   "include": ["./src/**/*.ts"]