jest-qase-reporter 2.2.2 → 2.4.0

package/changelog.md

@@ -1,3 +1,17 @@
+# jest-qase-reporter@2.4.0
+
+## Changed
+
+- Bumped `qase-javascript-commons` to `~2.7.0`.
+- Internal: replaced local copies of `removeQaseIdsFromTitle`, `extractAndCleanStep`, and the suite-part normalizer with imports from `qase-javascript-commons/internal`. Note: `removeQaseIdsFromTitle` is now case-insensitive and also accepts `(Qase ID 1)` without colon (previously rejected).
+
+# jest-qase-reporter@2.3.0
+
+## What's new
+
+- Added `qase.tags()` method to assign tag titles to test cases.
+- Updated `qase-javascript-commons` dependency to `~2.6.0`.
+
 # jest-qase-reporter@2.2.2
 
 ## Bug fixes

package/dist/global.d.ts

@@ -17,6 +17,7 @@ export declare class Qase {
     fields(values: Record<string, string>): void;
     parameters(values: Record<string, string>): void;
     groupParams(values: Record<string, string>): void;
+    tags(values: string[]): void;
     step(step: TestStepType): void;
     attachment(attachment: Attachment): void;
 }

package/dist/global.js

@@ -39,6 +39,9 @@ class Qase {
         }
         this.reporter.addGroupParams(stringRecord);
     }
+    tags(values) {
+        this.reporter.addTags(values);
+    }
     step(step) {
         this.reporter.addStep(step);
     }

package/dist/jest.d.ts

@@ -11,6 +11,7 @@ export declare const qase: {
     fields(values: Record<string, string>): void;
     parameters(values: Record<string, string>): void;
     groupParameters(values: Record<string, string>): void;
+    tags(...values: string[]): void;
     step(name: string, body: StepFunction, expectedResult?: string, data?: string): Promise<void>;
     attach(attach: {
         name?: string;

package/dist/jest.js

@@ -118,6 +118,20 @@ exports.qase.groupParameters = (values) => {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
     global.Qase.groupParams(values);
 };
+/**
+ * Set tags for the test case
+ * @param {...string} values
+ * @example
+ * test('test', () => {
+ *    qase.tags('smoke', 'regression');
+ *     expect(true).toBe(true);
+ * });
+ */
+exports.qase.tags = (...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.tags(values);
+};
 /**
  * Add a step to the test case
  * @param name

package/dist/models.d.ts

@@ -7,6 +7,7 @@ export interface Metadata {
     fields: Record<string, string>;
     parameters: Record<string, string>;
     groupParams: Record<string, string>;
+    tags: string[];
     steps: TestStepType[];
     attachments: Attachment[];
 }

package/dist/reporter.d.ts

@@ -91,6 +91,7 @@ export declare class JestQaseReporter implements Reporter {
     addFields(fields: Record<string, string>): void;
     addParameters(parameters: Record<string, string>): void;
     addGroupParams(groupParams: Record<string, string>): void;
+    addTags(tags: string[]): void;
     addIgnore(): void;
     addStep(step: TestStepType): void;
     addAttachment(attachment: Attachment): void;
@@ -107,18 +108,5 @@ export declare class JestQaseReporter implements Reporter {
      * @private
      */
     private createEmptyMetadata;
-    /**
-     * @param {string} title
-     * @returns {string}
-     * @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

@@ -9,6 +9,7 @@ const lodash_get_1 = __importDefault(require("lodash.get"));
 const uuid_1 = require("uuid");
 const qase_javascript_commons_1 = require("qase-javascript-commons");
 const profilers_1 = require("qase-javascript-commons/profilers");
+const internal_1 = require("qase-javascript-commons/internal");
 const global_1 = require("./global");
 /**
  * @class JestQaseReporter
@@ -126,6 +127,9 @@ class JestQaseReporter {
         if (Object.keys(this.metadata.groupParams).length > 0) {
             result.group_params = this.metadata.groupParams;
         }
+        if (this.metadata.tags.length > 0) {
+            result.tags = this.metadata.tags;
+        }
         if (this.metadata.steps.length > 0) {
             result.steps = this.metadata.steps;
         }
@@ -182,7 +186,7 @@ class JestQaseReporter {
      */
     getSignature(filePath, fullName, ids, parameters = {}) {
         const suites = filePath.split('/');
-        suites.push(fullName.toLowerCase().replace(/\s/g, '_'));
+        suites.push((0, internal_1.normalizeSuitePart)(fullName));
         return (0, qase_javascript_commons_1.generateSignature)(ids, suites, parameters);
     }
     /**
@@ -236,6 +240,9 @@ class JestQaseReporter {
     addGroupParams(groupParams) {
         this.metadata.groupParams = groupParams;
     }
+    addTags(tags) {
+        this.metadata.tags.push(...tags);
+    }
     addIgnore() {
         this.metadata.ignore = true;
     }
@@ -246,7 +253,7 @@ class JestQaseReporter {
         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);
+            const stepData = (0, internal_1.extractAndCleanStep)(stepTextData.action);
             stepTextData.action = stepData.cleanedString;
             stepTextData.expected_result = stepData.expectedResult;
             stepTextData.data = stepData.data;
@@ -307,7 +314,7 @@ class JestQaseReporter {
                 : null,
             testops_project_mapping: hasProjectMapping ? parsed.projectMapping : null,
             id: (0, uuid_1.v4)(),
-            title: parsed.cleanedTitle || this.removeQaseIdsFromTitle(value.title),
+            title: parsed.cleanedTitle || (0, internal_1.removeQaseIdsFromTitle)(value.title),
         };
         return result;
     }
@@ -324,48 +331,11 @@ class JestQaseReporter {
             fields: {},
             parameters: {},
             groupParams: {},
+            tags: [],
             steps: [],
             attachments: [],
         };
     }
-    /**
-     * @param {string} title
-     * @returns {string}
-     * @private
-     */
-    removeQaseIdsFromTitle(title) {
-        const matches = title.match(/\(Qase ID: ([0-9,]+)\)$/i);
-        if (matches) {
-            return title.replace(matches[0], '').trimEnd();
-        }
-        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

@@ -12,6 +12,7 @@ This guide provides comprehensive instructions for integrating Qase with Jest.
 - [Adding Title](#adding-title)
 - [Adding Fields](#adding-fields)
 - [Adding Suite](#adding-suite)
+- [Tags](#tags)
 - [Ignoring Tests](#ignoring-tests)
 - [Muting Tests](#muting-tests)
 - [Working with Attachments](#working-with-attachments)
@@ -142,6 +143,35 @@ test('Login test', () => {
 
 ---
 
+## Tags
+
+Assign tags to test cases. Tags help categorize and filter tests in Qase.
+
+```typescript
+test(qase(1, 'Login test'), () => {
+  qase.tags('smoke', 'regression');
+  expect(true).toBe(true);
+});
+```
+
+Multiple `qase.tags()` calls accumulate:
+
+```typescript
+test('test', () => {
+  qase.tags('smoke');
+  qase.tags('regression', 'e2e');
+  // Result: tags = ['smoke', 'regression', 'e2e']
+});
+```
+
+Alternative using fields:
+
+```typescript
+qase.fields({ tags: 'smoke,regression' });
+```
+
+---
+
 ## Ignoring Tests
 
 Exclude a test from Qase reporting. The test still executes, but results are not sent to Qase:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-qase-reporter",
-  "version": "2.2.2",
+  "version": "2.4.0",
   "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.5.7",
+    "qase-javascript-commons": "~2.7.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {