jest-qase-reporter 2.1.3 → 2.1.4

package/changelog.md

@@ -1,3 +1,9 @@
+# jest-qase-reporter@2.1.4
+
+## What's new
+
+- Added support for expected results and data for steps.
+
 # jest-qase-reporter@2.1.3
 
 ## What's new

package/dist/jest.d.ts

@@ -1,98 +1,14 @@
 import { StepFunction } from 'qase-javascript-commons';
 export declare const qase: {
     (caseId: number | string | number[] | string[], name: string): string;
-    /**
-     * Set a title for the test case
-     * @param {string} value
-     * @example
-     * test('test', () => {
-     *    qase.title("Title");
-     *     expect(true).toBe(true);
-     * });
-     */
     title(value: string): void;
-    /**
-     * Ignore the test case
-     * @example
-     * test('test', () => {
-     *    qase.ignore();
-     *     expect(true).toBe(true);
-     * });
-     */
     ignore(): void;
-    /**
-     * Add a comment to the test case
-     * @param {string} value
-     * @example
-     * test('test', () => {
-     *    qase.comment("Comment");
-     *     expect(true).toBe(true);
-     * });
-     */
     comment(value: string): void;
-    /**
-     * Set a suite for the test case
-     * @param {string} value
-     * @example
-     * test('test', () => {
-     *    qase.suite("Suite");
-     *     expect(true).toBe(true);
-     * });
-     */
     suite(value: string): void;
-    /**
-     * Set fields for the test case
-     * @param {Record<string, string>} values
-     * @example
-     * test('test', () => {
-     *    qase.fields({field: "value"});
-     *     expect(true).toBe(true);
-     * });
-     */
     fields(values: Record<string, string>): void;
-    /**
-     * Set parameters for the test case
-     * @param {Record<string, string>} values
-     * @example
-     * test('test', () => {
-     *    qase.parameters({param: "value"});
-     *     expect(true).toBe(true);
-     * });
-     */
     parameters(values: Record<string, string>): void;
-    /**
-     * Set group params for the test case
-     * @param {Record<string, string>} values
-     * @example
-     * test('test', () => {
-     *    qase.groupParameters({param: "value"});
-     *     expect(true).toBe(true);
-     * });
-     */
     groupParameters(values: Record<string, string>): void;
-    /**
-     * Add a step to the test case
-     * @param name
-     * @param body
-     * @example
-     * test('test', () => {
-     *    qase.step("Step", () => {
-     *      expect(true).toBe(true);
-     *    });
-     *     expect(true).toBe(true);
-     * });
-     */
-    step(name: string, body: StepFunction): Promise<void>;
-    /**
-     * Add an attachment to the test case
-     * @param attach
-     * @example
-     * test('test', () => {
-     *   qase.attach({ name: 'attachment.txt', content: 'Hello, world!', type: 'text/plain' });
-     *   qase.attach({ paths: ['/path/to/file', '/path/to/another/file']});
-     *     expect(true).toBe(true);
-     * });
-     */
+    step(name: string, body: StepFunction, expectedResult?: string, data?: string): Promise<void>;
     attach(attach: {
         name?: string;
         type?: string;

package/dist/jest.js

@@ -22,6 +22,8 @@ exports.qase = qase;
  * });
  */
 exports.qase.title = (value) => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.title(value);
 };
 /**
@@ -33,6 +35,8 @@ exports.qase.title = (value) => {
  * });
  */
 exports.qase.ignore = () => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.ignore();
 };
 /**
@@ -45,6 +49,8 @@ exports.qase.ignore = () => {
  * });
  */
 exports.qase.comment = (value) => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.comment(value);
 };
 /**
@@ -57,6 +63,8 @@ exports.qase.comment = (value) => {
  * });
  */
 exports.qase.suite = (value) => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.suite(value);
 };
 /**
@@ -69,6 +77,8 @@ exports.qase.suite = (value) => {
  * });
  */
 exports.qase.fields = (values) => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.fields(values);
 };
 /**
@@ -81,6 +91,8 @@ exports.qase.fields = (values) => {
  * });
  */
 exports.qase.parameters = (values) => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.parameters(values);
 };
 /**
@@ -93,12 +105,16 @@ exports.qase.parameters = (values) => {
  * });
  */
 exports.qase.groupParameters = (values) => {
+    // @ts-expect-error - global.Qase is dynamically added at runtime
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.groupParams(values);
 };
 /**
  * Add a step to the test case
  * @param name
  * @param body
+ * @param expectedResult
+ * @param data
  * @example
  * test('test', () => {
  *    qase.step("Step", () => {
@@ -106,11 +122,25 @@ exports.qase.groupParameters = (values) => {
  *    });
  *     expect(true).toBe(true);
  * });
+ * @example
+ * test('test', () => {
+ *    qase.step("Step", () => {
+ *      expect(true).toBe(true);
+ *    }, "Expected result", "Input data");
+ *     expect(true).toBe(true);
+ * });
  */
-exports.qase.step = async (name, body) => {
-    const runningStep = new qase_javascript_commons_1.QaseStep(name);
+exports.qase.step = async (name, body, expectedResult, data) => {
+    const stepName = expectedResult || data
+        ? `${name} QaseExpRes:${expectedResult ? `: ${expectedResult}` : ''} QaseData:${data ? `: ${data}` : ''}`
+        : name;
+    const runningStep = new qase_javascript_commons_1.QaseStep(stepName);
     // eslint-disable-next-line @typescript-eslint/require-await
-    await runningStep.run(body, async (step) => global.Qase.step(step));
+    await runningStep.run(body, async (step) => {
+        // @ts-expect-error - global.Qase is dynamically added at runtime
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return
+        return global.Qase.step(step);
+    });
 };
 /**
  * Add an attachment to the test case
@@ -127,6 +157,8 @@ exports.qase.attach = (attach) => {
         for (const file of attach.paths) {
             const attachmentName = path_1.default.basename(file);
             const contentType = (0, qase_javascript_commons_1.getMimeTypes)(file);
+            // @ts-expect-error - global.Qase is dynamically added at runtime
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
             global.Qase.attachment({
                 file_path: file,
                 size: 0,
@@ -139,6 +171,8 @@ exports.qase.attach = (attach) => {
         return;
     }
     if (attach.content) {
+        // @ts-expect-error - global.Qase is dynamically added at runtime
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
         global.Qase.attachment({
             file_path: null,
             size: attach.content.length,

package/dist/reporter.d.ts

@@ -103,5 +103,12 @@ export declare class JestQaseReporter implements Reporter {
      * @private
      */
     private removeQaseIdsFromTitle;
+    /**
+     * 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;
     onRunnerEnd(): Promise<void>;
 }

package/dist/reporter.js

@@ -63,6 +63,7 @@ class JestQaseReporter {
             frameworkName: 'jest',
             reporterName: 'jest-qase-reporter',
         });
+        // @ts-expect-error - global.Qase is dynamically added at runtime
         global.Qase = new global_1.Qase(this);
         this.metadata = this.createEmptyMetadata();
     }
@@ -208,6 +209,17 @@ class JestQaseReporter {
         this.metadata.ignore = true;
     }
     addStep(step) {
+        // Parse expectedResult and data from step name if present
+        // Only process text steps (not gherkin steps)
+        // Check if step is a text step (either explicitly TEXT type, undefined, or string 'text')
+        const isTextStep = (qase_javascript_commons_1.StepType && step.step_type === qase_javascript_commons_1.StepType.TEXT) || step.step_type === undefined || step.step_type === 'text';
+        if (isTextStep && step.data && 'action' in step.data) {
+            const stepTextData = step.data;
+            const stepData = this.extractAndCleanStep(stepTextData.action);
+            stepTextData.action = stepData.cleanedString;
+            stepTextData.expected_result = stepData.expectedResult;
+            stepTextData.data = stepData.data;
+        }
         this.metadata.steps.push(step);
     }
     addAttachment(attachment) {
@@ -236,7 +248,7 @@ class JestQaseReporter {
         const ids = JestQaseReporter.getCaseId(value.title);
         const filePath = this.getCurrentTestPath(path);
         // Determine status based on error type
-        const testStatus = (0, qase_javascript_commons_1.determineTestStatus)(error || null, value.status);
+        const testStatus = (0, qase_javascript_commons_1.determineTestStatus)(error ?? null, value.status);
         return {
             attachments: [],
             author: null,
@@ -291,6 +303,32 @@ class JestQaseReporter {
         }
         return title;
     }
+    /**
+     * 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 };
+    }
     async onRunnerEnd() {
         await this.reporter.publish();
     }

package/docs/usage.md

@@ -65,19 +65,37 @@ The reporter uses the title from the `test.step` function as the step title. By
 Additionally, these steps get their own result in the Qase Test run, offering a well-organized summary of the test flow. This helps quickly identify the cause of any failures.
 
 ```javascript
+const { qase } = require("jest-qase-reporter/jest");
+
 test('A Test case with steps, updated from code', async () => {
-  await test.step('Initialize the environment', async () => {
+  await qase.step('Initialize the environment', async () => {
     // Set up test environment
   });
-  await test.step('Test Core Functionality of the app', async () => {
+  await qase.step('Test Core Functionality of the app', async () => {
     // Exercise core functionality
   });
 
-  await test.step('Verify Expected Behavior of the app', async () => {
+  await qase.step('Verify Expected Behavior of the app', async () => {
     // Assert expected behavior
   });
 });
 ```
+
+#### Steps with Expected Result and Data
+
+```javascript
+const { qase } = require("jest-qase-reporter/jest");
+
+test('A Test case with steps including expected results and data', async () => {
+  await qase.step('Click button', async () => {
+    // Click action
+  }, 'Button should be clicked', 'Button data');
+  
+  await qase.step('Fill form', async () => {
+    // Form filling action
+  }, 'Form should be filled', 'Form input data');
+});
+```
 <br>
 
 ### Fields

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Qase TMS Jest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -45,18 +45,18 @@
   "dependencies": {
     "lodash.get": "^4.4.2",
     "lodash.has": "^4.5.2",
-    "qase-javascript-commons": "~2.4.2",
-    "uuid": "^9.0.0"
+    "qase-javascript-commons": "~2.4.13",
+    "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@jest/reporters": "^29.5.0",
-    "@jest/test-result": "^29.5.0",
-    "@types/jest": "^29.5.2",
-    "@types/lodash.get": "^4.4.7",
-    "@types/lodash.has": "^4.5.7",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0"
+    "@jest/globals": "^29.7.0",
+    "@jest/reporters": "^29.7.0",
+    "@jest/test-result": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "@types/lodash.get": "^4.4.9",
+    "@types/lodash.has": "^4.5.9",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.5"
   },
   "peerDependencies": {
     "jest": ">=28.0.0"

package/tsconfig.build.json

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