feat: add support for specifying expected result and data for steps

gibiw · gibiw · commit d23618396d54 · 2025-03-07T05:38:23.000-08:00
- Implemented the ability to define expected results and associated data for each step.
- Enhanced flexibility and precision in defining step behavior and validation.
diff --git a/package-lock.json b/package-lock.json
diff --git a/qase-cucumberjs/package.json b/qase-cucumberjs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cucumberjs-qase-reporter",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "Qase TMS CucumberJS Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "main": "./dist/index.js",
@@ -40,7 +40,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@cucumber/messages": "^22.0.0",
-    "qase-javascript-commons": "^2.2.0"
+    "qase-javascript-commons": "^2.2.14"
   },
   "peerDependencies": {
     "@cucumber/cucumber": ">=7.0.0"
diff --git a/qase-cypress/package.json b/qase-cypress/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.2.8",
+  "version": "2.2.9",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -51,7 +51,7 @@
   "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.2.3",
+    "qase-javascript-commons": "~2.2.14",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {
diff --git a/qase-cypress/src/reporter.ts b/qase-cypress/src/reporter.ts
@@ -362,6 +362,7 @@ export class CypressQaseReporter extends reporters.Base {
       step.data = {
         action: message.name,
         expected_result: null,
+        data: null,
       };
 
       if (lastIndex === messages.indexOf(message) && testStatus !== 'passed') {
@@ -388,6 +389,7 @@ export class CypressQaseReporter extends reporters.Base {
         newStep.data = {
           action: step.name,
           expected_result: null,
+          data: null,
         };
 
         if (attachments[step.id]) {
diff --git a/qase-javascript-commons/package.json b/qase-javascript-commons/package.json
@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.2.13",
+  "version": "2.2.14",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
diff --git a/qase-javascript-commons/src/models/step-data.ts b/qase-javascript-commons/src/models/step-data.ts
@@ -1,6 +1,7 @@
 export interface StepTextData {
   action: string;
   expected_result: string | null;
+  data: string | null;
 }
 
 export interface StepGherkinData {
diff --git a/qase-javascript-commons/src/models/test-step.ts b/qase-javascript-commons/src/models/test-step.ts
@@ -29,6 +29,7 @@ export class TestStepType {
       this.data = {
         action: '',
         expected_result: null,
+        data: null,
       };
     } else {
       this.data = {
diff --git a/qase-javascript-commons/src/reporters/testops-reporter.ts b/qase-javascript-commons/src/reporters/testops-reporter.ts
@@ -625,6 +625,14 @@ export class TestOpsReporter extends AbstractReporter {
             resultStep.data.action = step.data.action;
           }
         }
+
+        if ('expected_result' in step.data && resultStep.data != undefined && step.data.expected_result != null) {
+          resultStep.data.expected_result = step.data.expected_result;
+        }
+
+        if ('data' in step.data && resultStep.data != undefined && step.data.data != null) {
+          resultStep.data.input_data = step.data.data;
+        }
       }
 
       if (step.step_type === StepType.GHERKIN) {
diff --git a/qase-javascript-commons/src/steps/step.ts b/qase-javascript-commons/src/steps/step.ts
@@ -70,6 +70,7 @@ export class QaseStep {
     step.data = {
       action: this.name,
       expected_result: null,
+      data: null,
     };
 
     try {
diff --git a/qase-jest/package.json b/qase-jest/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Qase TMS Jest Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -45,7 +45,7 @@
   "dependencies": {
     "lodash.get": "^4.4.2",
     "lodash.has": "^4.5.2",
-    "qase-javascript-commons": "~2.2.1",
+    "qase-javascript-commons": "~2.2.14",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
diff --git a/qase-jest/src/step.ts b/qase-jest/src/step.ts
@@ -71,6 +71,7 @@ export class QaseStep {
     step.data = {
       action: this.name,
       expected_result: null,
+      data: null,
     };
 
     try {
diff --git a/qase-mocha/package.json b/qase-mocha/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mocha-qase-reporter",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Mocha Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -43,7 +43,7 @@
   "dependencies": {
     "mocha": "^10.2.0",
     "deasync-promise": "^1.0.1",
-    "qase-javascript-commons": "~2.2.0",
+    "qase-javascript-commons": "~2.2.14",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
diff --git a/qase-mocha/src/reporter.ts b/qase-mocha/src/reporter.ts
@@ -370,6 +370,7 @@ export class MochaQaseReporter extends reporters.Base {
       data: {
         action: title,
         expected_result: null,
+        data: null,
       },
       execution: {
         start_time: Date.now(),
diff --git a/qase-playwright/changelog.md b/qase-playwright/changelog.md
@@ -1,3 +1,9 @@
+# playwright-qase-reporter@2.0.17
+
+## What's new
+
+Introduced the ability to specify expected results and data for each step, improving step validation and customization.
+
 # playwright-qase-reporter@2.0.16
 
 ## What's new
diff --git a/qase-playwright/docs/usage.md b/qase-playwright/docs/usage.md
@@ -121,6 +121,24 @@ test('A Test case with steps, updated from code', async () => {
   });
 });
 ```
+
+You also can use the `qase.step()` method to set the expected result and data of the step, which will be used in the Qase report.
+
+```javascript
+test('A Test case with steps, updated from code', async () => {
+  await test.step(qase.step('Initialize the environment'), async () => {
+    // Set up test environment
+  });
+  await test.step(qase.step('Test Core Functionality of the app', 'expected result'), async () => {
+    // Exercise core functionality
+  });
+
+  await test.step(qase.step('Verify Expected Behavior of the app', 'expected result', 'data'), async () => {
+    // Assert expected behavior
+  });
+});
+```
+
 <br>
 
 ### Fields
diff --git a/qase-playwright/package.json b/qase-playwright/package.json
@@ -1,6 +1,6 @@
 {
   "name": "playwright-qase-reporter",
-  "version": "2.0.16",
+  "version": "2.0.17",
   "description": "Qase TMS Playwright Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -44,7 +44,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "chalk": "^4.1.2",
-    "qase-javascript-commons": "~2.2.0",
+    "qase-javascript-commons": "~2.2.14",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
diff --git a/qase-playwright/src/playwright.ts b/qase-playwright/src/playwright.ts
@@ -245,6 +245,23 @@ qase.comment = function(value: string) {
   return this;
 };
 
+/**
+ * Set a expected result and data for the test step
+ * @param action
+ * @param expectedResult
+ * @param data
+ * @example
+ * test('test', async ({ page }) => {
+ *    await test.step(qase.step('action', 'expected result', 'data'), async () => {
+ *      await page.goto('https://example.com');
+ *    });
+ * });
+ */
+qase.step = function(action: string, expectedResult: string | undefined, data: string | undefined): string {
+  return `${action} QaseExpRes:${expectedResult ? `: ${expectedResult}` : ''} QaseData:${data ? `: ${data}` : ''}`;
+};
+
+
 const addMetadata = (metadata: MetadataMessage): void => {
   test.info().attach('qase-metadata.json', {
     contentType: ReporterContentType,
@@ -273,3 +290,4 @@ const addAttachment = (name: string, contentType: string, filePath?: string, bod
   }).catch(() => {/**/
   });
 };
+
diff --git a/qase-playwright/src/reporter.ts b/qase-playwright/src/reporter.ts
@@ -257,13 +257,16 @@ export class PlaywrightQaseReporter implements Reporter {
 
       const attachments = this.stepAttachments.get(testStep);
 
+      const stepData = this.extractAndCleanStep(testStep.title);
+
       const id = uuidv4();
       const step: TestStepType = {
         id: id,
         step_type: StepType.TEXT,
         data: {
-          action: testStep.title,
-          expected_result: null,
+          action: stepData.cleanedString,
+          expected_result: stepData.expectedResult,
+          data: stepData.data,
         },
         parent_id: parentId,
         execution: {
@@ -530,4 +533,30 @@ export class PlaywrightQaseReporter implements Reporter {
     return true;
   }
 
+  private extractAndCleanStep(input: string): { expectedResult: string | null; data: string | null; cleanedString: string } {
+    let expectedResult: string | null = null;
+    let data: string | null = null;
+    let cleanedString = input;
+
+    const hasExpectedResult = /QaseExpRes:/.test(input);
+    const hasData = /QaseData:/.test(input);
+
+    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 };
+  }
+
 }
diff --git a/qase-testcafe/package.json b/qase-testcafe/package.json
diff --git a/qase-wdio/package.json b/qase-wdio/package.json
diff --git a/qase-wdio/src/reporter.ts b/qase-wdio/src/reporter.ts
diff --git a/qase-wdio/src/step.ts b/qase-wdio/src/step.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "qase-javascript-commons",`
`3`		`- "version": "2.2.13",`
	`3`	`+ "version": "2.2.14",`
`4`	`4`	`"description": "Qase JS Reporters",`
`5`	`5`	`"main": "./dist/index.js",`
`6`	`6`	`"types": "./dist/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`export interface StepTextData {`
`2`	`2`	`action: string;`
`3`	`3`	`expected_result: string \| null;`
	`4`	`+ data: string \| null;`
`4`	`5`	`}`
`5`	`6`
`6`	`7`	`export interface StepGherkinData {`
Original file line number	Diff line number	Diff line change
`@@ -625,6 +625,14 @@ export class TestOpsReporter extends AbstractReporter {`
`625`	`625`	`resultStep.data.action = step.data.action;`
`626`	`626`	`}`
`627`	`627`	`}`
	`628`	`+`
	`629`	`+ if ('expected_result' in step.data && resultStep.data != undefined && step.data.expected_result != null) {`
	`630`	`+ resultStep.data.expected_result = step.data.expected_result;`
	`631`	`+ }`
	`632`	`+`
	`633`	`+ if ('data' in step.data && resultStep.data != undefined && step.data.data != null) {`
	`634`	`+ resultStep.data.input_data = step.data.data;`
	`635`	`+ }`
`628`	`636`	`}`
`629`	`637`
`630`	`638`	`if (step.step_type === StepType.GHERKIN) {`