feature: add group parameters

Add support the group parameters in the JS reporters
qase-tms · Aug 27, 2024 · 09bc0c8 · 09bc0c8
1 parent 07bf11f
commit 09bc0c8
Show file tree

Hide file tree

Showing 29 changed files with 252 additions and 57 deletions.
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.0",
+  "version": "2.0.1",
   "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.0.0-beta.8"
+    "qase-javascript-commons": "^2.2.0"
   },
   "peerDependencies": {
     "@cucumber/cucumber": ">=7.0.0"

diff --git a/qase-cucumberjs/src/storage.ts b/qase-cucumberjs/src/storage.ts
@@ -232,6 +232,7 @@ export class Storage {
       message: null,
       muted: false,
       params: {},
+      group_params: {},
       relations: relations,
       run_id: null,
       signature: this.getSignature(pickle, metadata.ids),

diff --git a/qase-cypress/package.json b/qase-cypress/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cypress-qase-reporter",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Qase Cypress Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "sideEffects": false,
@@ -46,7 +46,7 @@
   "author": "Qase Team <[email protected]>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "~2.1.0",
+    "qase-javascript-commons": "~2.2.0",
     "uuid": "^9.0.1"
   },
   "peerDependencies": {

diff --git a/qase-cypress/src/reporter.ts b/qase-cypress/src/reporter.ts
@@ -196,6 +196,7 @@ export class CypressQaseReporter extends reporters.Base {
       message: test.err?.message ?? null,
       muted: false,
       params: {},
+      group_params: {},
       relations: relations,
       run_id: null,
       signature: this.getSignature(test, ids),

diff --git a/qase-javascript-commons/package.json b/qase-javascript-commons/package.json
@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -33,7 +33,7 @@
     "lodash.merge": "^4.6.2",
     "lodash.mergewith": "^4.6.2",
     "mime-types": "^2.1.33",
-    "qaseio": "~2.2.0",
+    "qaseio": "~2.3.0",
     "strip-ansi": "^6.0.1",
     "uuid": "^9.0.0"
   },

diff --git a/qase-javascript-commons/src/models/test-result.ts b/qase-javascript-commons/src/models/test-result.ts
@@ -13,6 +13,7 @@ export class TestResultType {
   attachments: Attachment[];
   steps: TestStepType[];
   params: Record<string, string>;
+  group_params: Record<string, string>;
   author: string | null;
   relations: Relation | null;
   muted: boolean;
@@ -29,6 +30,7 @@ export class TestResultType {
     this.attachments = [];
     this.steps = [];
     this.params = {};
+    this.group_params = {};
     this.author = null;
     this.relations = null;
     this.muted = false;

diff --git a/qase-javascript-commons/src/reporters/testops-reporter.ts b/qase-javascript-commons/src/reporters/testops-reporter.ts
@@ -36,30 +36,30 @@ import { StateManager } from '../state/state';
 
 const defaultChunkSize = 200;
 
-export type TestOpsRunType = {
+export interface TestOpsRunType {
   id?: number | undefined;
   title: string;
   description: string;
   complete?: boolean | undefined;
-};
+}
 
-export type TestOpsPlanType = {
+export interface TestOpsPlanType {
   id?: number | undefined;
-};
+}
 
-export type TestOpsBatchType = {
+export interface TestOpsBatchType {
   size?: number | undefined;
 }
 
-export type TestOpsOptionsType = {
+export interface TestOpsOptionsType {
   project: string;
   uploadAttachments?: boolean | undefined;
   run: TestOpsRunType;
   plan: TestOpsPlanType;
   batch?: TestOpsBatchType;
   defect?: boolean | undefined;
   useV2?: boolean | undefined;
-};
+}
 
 /**
  * @class TestOpsReporter
@@ -401,11 +401,38 @@ export class TestOpsReporter extends AbstractReporter {
     const attachments = await this.uploadAttachments(result.attachments);
     const steps = await this.transformStepsV1(result.steps, result.title);
 
+    const param: Record<string, string> = {};
+
+    for (const key in result.params) {
+      const value = result.params[key];
+      if (!value) {
+        continue;
+      }
+      param[key] = value;
+    }
+
+    const group_params: string[][] = [];
+
+    const keys = Object.keys(result.group_params);
+    if (keys.length > 0) {
+      group_params.push(keys);
+    }
+
+    for (const key in result.group_params) {
+      const value = result.group_params[key];
+      if (!value) {
+        continue;
+      }
+      param[key] = value;
+    }
+
+
     const resultCreate: ResultCreate = {
       attachments: attachments,
       comment: result.message,
       defect: this.defect,
-      param: result.params,
+      param: param,
+      param_groups: group_params,
       stacktrace: result.execution.stacktrace,
       start_time: result.execution.start_time ? result.execution.start_time | 0 : null,
       status: result.execution.status,
@@ -422,7 +449,7 @@ export class TestOpsReporter extends AbstractReporter {
     const rootSuite = this.rootSuite ? `${this.rootSuite}\t` : '';
     resultCreate.case = {
       title: result.title,
-      suite_title: result.relations?.suite ? `${rootSuite}${result.relations?.suite?.data.map((suite) => suite.title).join('\t')}` : rootSuite,
+      suite_title: result.relations?.suite ? `${rootSuite}${result.relations.suite.data.map((suite) => suite.title).join('\t')}` : rootSuite,
       description: result.fields['description'] ?? null,
       postconditions: result.fields['postconditions'] ?? null,
       preconditions: result.fields['preconditions'] ?? null,

diff --git a/qase-jest/package.json b/qase-jest/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "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.0.0",
+    "qase-javascript-commons": "~2.2.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {

diff --git a/qase-jest/src/reporter.ts b/qase-jest/src/reporter.ts
@@ -133,6 +133,7 @@ export class JestQaseReporter implements Reporter {
           message: error?.message ?? null,
           muted: false,
           params: {},
+          group_params: {},
           relations: this.getRelations(filePath, ancestorTitles),
           run_id: null,
           signature: this.getSignature(filePath, fullName, ids),

diff --git a/qase-mocha/changelog.md b/qase-mocha/changelog.md
@@ -1,3 +1,16 @@
+# [email protected]
+
+## What's new
+
+Support group parameters for test cases. You can specify the group parameters in the test case using the following format: 
+
+```ts
+  it('test', () => {
+    this.groupParameters({ param1: 'value1', param2: 'value2' });
+    expect(true).to.equal(true);
+  });
+```
+
 # [email protected]
 
 ## What's new