vitest-qase-reporter 1.0.1 → 1.0.3

package/README.md

@@ -11,7 +11,7 @@ Testing frameworks that use Vitest as a test runner can also be used with Vitest
 To install the latest version, run:
 
 ```shell
-npm install --save-dev qase-vitest
+npm install vitest-qase-reporter
 ```
 
 # Contents
@@ -23,6 +23,7 @@ npm install --save-dev qase-vitest
     - [Metadata](#metadata)
     - [Advanced Usage with Annotations](#advanced-usage-with-annotations)
   - [Configuration](#configuration)
+  - [Documentation](#documentation)
   - [Requirements](#requirements)
 
 ## Getting started
@@ -94,22 +95,22 @@ existing test cases from TMS before the executing tests. For example:
 
 ```typescript
 import { describe, it, test, expect } from 'vitest';
-import { qase, withQase } from 'vitest-qase-reporter/vitest';
+import { addQaseId, withQase } from 'vitest-qase-reporter/vitest';
 
 describe('My First Test', () => {
-  test(qase([1, 2], 'Several ids'), () => {
+  test(addQaseId('Several ids', [1, 2]), () => {
     expect(true).toBe(true);
   });
 
-  test(qase(3, 'Correct test'), () => {
+  test(addQaseId('Correct test', [3]), () => {
     expect(true).toBe(true);
   });
 
-  test.skip(qase('4', 'Skipped test'), () => {
+  test.skip(addQaseId('Skipped test', [4]), () => {
     expect(true).toBe(true);
   });
 
-  test(qase(['5', '6'], 'Failed test'), () => {
+  test(addQaseId('Failed test', ['5', '6']), () => {
     expect(true).toBe(false);
   });
 });
@@ -119,10 +120,10 @@ describe('My First Test', () => {
 
 ```typescript
 import { describe, it, expect } from 'vitest';
-import { qase, withQase } from 'vitest-qase-reporter/vitest';
+import { addQaseId, withQase } from 'vitest-qase-reporter/vitest';
 
 describe('Qase Annotations Example', () => {
-  it(qase(20, 'Basic test with qase ID'), () => {
+  it(addQaseId(20, 'Basic test with qase ID'), () => {
     expect(1 + 1).toBe(2);
   });
 

package/changelog.md

@@ -1,3 +1,15 @@
+# qase-vitest@1.0.3
+
+## What's new
+
+- Added support for expected results and data for steps.
+
+# qase-vitest@1.0.2
+
+## What's new
+
+- Fixed an issue with attachments.
+
 # qase-vitest@1.0.1
 
 ## What's new

package/dist/index.d.ts

@@ -35,5 +35,6 @@ export declare class VitestQaseReporter implements Reporter {
     onTestSuiteReady?(testSuite: TestSuite): void;
     onTestSuiteResult?(): void;
     private extractSuiteFromTestCase;
+    private extractAndCleanStep;
 }
 export default VitestQaseReporter;

package/dist/index.js

@@ -126,10 +126,11 @@ class VitestQaseReporter {
                 testResult.steps = metadata.steps.map(step => {
                     const stepObj = new qase_javascript_commons_1.TestStepType();
                     stepObj.id = Math.random().toString(36).substr(2, 9);
+                    const stepData = this.extractAndCleanStep(step.name);
                     stepObj.data = {
-                        action: step.name,
-                        expected_result: null,
-                        data: null
+                        action: stepData.cleanedString,
+                        expected_result: stepData.expectedResult,
+                        data: stepData.data
                     };
                     stepObj.execution.status = step.status === 'failed' ? qase_javascript_commons_1.StepStatusEnum.failed : qase_javascript_commons_1.StepStatusEnum.passed;
                     return stepObj;
@@ -242,14 +243,20 @@ class VitestQaseReporter {
                 }
                 case 'step-end': {
                     if (metadata.currentStep) {
-                        metadata.steps.push({ name: metadata.currentStep, status: 'end' });
+                        metadata.steps.push({
+                            name: metadata.currentStep,
+                            status: 'end'
+                        });
                         delete metadata.currentStep;
                     }
                     break;
                 }
                 case 'step-failed': {
                     if (metadata.currentStep) {
-                        metadata.steps.push({ name: metadata.currentStep, status: 'failed' });
+                        metadata.steps.push({
+                            name: metadata.currentStep,
+                            status: 'failed'
+                        });
                         delete metadata.currentStep;
                     }
                     break;
@@ -295,6 +302,26 @@ class VitestQaseReporter {
         // The test will be assigned to the default suite
         return undefined;
     }
+    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.VitestQaseReporter = VitestQaseReporter;
 exports.default = VitestQaseReporter;

package/dist/vitest.d.ts

@@ -9,7 +9,7 @@ export interface QaseWrapper {
     fields(values: Record<string, string>): Promise<void>;
     parameters(values: Record<string, string>): Promise<void>;
     groupParameters(values: Record<string, string>): Promise<void>;
-    step(name: string, body: StepFunction): Promise<void>;
+    step(name: string, body: StepFunction, expectedResult?: string, data?: string): Promise<void>;
     attach(attach: {
         name?: string;
         type?: string;

package/dist/vitest.js

@@ -97,6 +97,8 @@ const createQaseWrapper = (annotate) => {
          * Add a step to the test case
          * @param name
          * @param body
+         * @param expectedResult
+         * @param data
          * @example
          * test('test', withQase(async ({ qase }) => {
          *    await qase.step("Step", () => {
@@ -104,20 +106,30 @@ const createQaseWrapper = (annotate) => {
          *    });
          *     expect(true).toBe(true);
          * }));
+         * @example
+         * test('test', withQase(async ({ qase }) => {
+         *    await qase.step("Step", () => {
+         *      expect(true).toBe(true);
+         *    }, "Expected result", "Input data");
+         *     expect(true).toBe(true);
+         * }));
          */
-        async step(name, body) {
-            await annotate(`Qase Step Start: ${name}`, { type: 'qase-step-start', body: name });
+        async step(name, body, expectedResult, data) {
+            const stepName = expectedResult || data
+                ? `${name} QaseExpRes:${expectedResult ? `: ${expectedResult}` : ''} QaseData:${data ? `: ${data}` : ''}`
+                : name;
+            await annotate(`Qase Step Start: ${stepName}`, { type: 'qase-step-start', body: stepName });
             try {
-                const runningStep = new qase_javascript_commons_1.QaseStep(name);
+                const runningStep = new qase_javascript_commons_1.QaseStep(stepName);
                 await runningStep.run(body, async (step) => {
                     const stepName = 'action' in step.data ? step.data.action : step.data.name;
                     await annotate(`Qase Step: ${stepName}`, { type: 'qase-step', body: stepName });
                 });
-                await annotate(`Qase Step End: ${name}`, { type: 'qase-step-end', body: name });
+                await annotate(`Qase Step End: ${stepName}`, { type: 'qase-step-end', body: stepName });
             }
             catch (error) {
                 const errorMessage = error instanceof Error ? error.message : String(error);
-                await annotate(`Qase Step Failed: ${name} - ${errorMessage}`, { type: 'qase-step-failed', body: `${name} - ${errorMessage}` });
+                await annotate(`Qase Step Failed: ${stepName} - ${errorMessage}`, { type: 'qase-step-failed', body: `${stepName} - ${errorMessage}` });
                 throw error;
             }
         },

package/docs/usage.md

@@ -66,6 +66,8 @@ The reporter uses the title from the `qase.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.
 
+You can also provide an expected result and input data for each step, which will be displayed in Qase.
+
 ```typescript
 it('A Test case with steps, updated from code', withQase(async ({ qase }) => {
   await qase.step('Initialize the environment', async () => {
@@ -80,6 +82,20 @@ it('A Test case with steps, updated from code', withQase(async ({ qase }) => {
   });
 }));
 ```
+
+#### Steps with Expected Result and Data
+
+```typescript
+it('A Test case with steps including expected results and data', withQase(async ({ qase }) => {
+  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": "vitest-qase-reporter",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Qase TMS Vitest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -40,18 +40,18 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.4.2"
+    "qase-javascript-commons": "~2.4.13"
   },
   "peerDependencies": {
     "vitest": ">=3.0.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@types/jest": "^29.5.2",
-    "@types/node": "^20.0.0",
-    "ajv": "^8.12.0",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0",
-    "typescript": "^5.0.0"
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.19.25",
+    "ajv": "^8.17.1",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3"
   }
 }

package/tsconfig.build.json

@@ -3,7 +3,8 @@
 
   "compilerOptions": {
     "noEmit": false,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "types": []
   },
 
   "include": ["./src/**/*.ts"]