cucumberjs-qase-reporter 2.1.6 → 2.1.8

package/changelog.md

@@ -1,3 +1,15 @@
+# qase-cucumberjs@2.1.8
+
+## What's new
+
+- Improved support for QaseParameters and QaseGroupParameters tags.
+
+# qase-cucumberjs@2.1.7
+
+## What's new
+
+- Added support for QaseParameters and QaseGroupParameters tags.
+
 # qase-cucumberjs@2.1.6
 
 ## Bug fixes

package/dist/models.d.ts

@@ -3,6 +3,8 @@ export interface TestMetadata {
     fields: Record<string, string>;
     title: string | null;
     isIgnore: boolean;
+    parameters: Record<string, string>;
+    group_params: Record<string, string>;
 }
 export interface ScenarioData {
     name: string;

package/dist/storage.d.ts

@@ -100,10 +100,19 @@ export declare class Storage {
     /**
      * @param {Pickle} pickle
      * @param {number[]} ids
+     * @param {Record<string, string>} parameters
      * @private
      */
     private getSignature;
     private getError;
+    /**
+     * Normalize JSON string by converting single quotes to double quotes
+     * This allows parsing JSON-like strings with single quotes
+     * @param {string} jsonString
+     * @returns {string}
+     * @private
+     */
+    private normalizeJsonString;
     private getFileNameFromMediaType;
 }
 export {};

package/dist/storage.js

@@ -8,6 +8,8 @@ const qaseIdRegExp = /^@[Qq]-?(\d+)$/;
 const newQaseIdRegExp = /^@[Qq]ase[Ii][Dd]=(\d+(?:,\s*\d+)*)$/;
 const qaseTitleRegExp = /^@[Qq]ase[Tt]itle=(.+)$/;
 const qaseFieldsRegExp = /^@[Qq]ase[Ff]ields=(.+)$/;
+const qaseParametersRegExp = /^@[Qq]ase[Pp]arameters=(.+)$/;
+const qaseGroupParametersRegExp = /^@[Qq]ase[Gg]roup[Pp]arameters=(.+)$/;
 const qaseIgnoreRegExp = /^@[Qq]ase[Ii][Gg][Nn][Oo][Rr][Ee]$/;
 class Storage {
     /**
@@ -213,6 +215,9 @@ class Storage {
                 }
             }
         }
+        // Merge parameters from tags with parameters from Gherkin examples
+        // Parameters from tags take precedence over Gherkin examples
+        params = { ...params, ...metadata.parameters };
         const steps = this.convertSteps(pickle.steps, tc);
         return {
             attachments: this.attachments[testCase.testCaseStartedId] ?? [],
@@ -229,10 +234,10 @@ class Storage {
             message: error?.message ?? null,
             muted: false,
             params: params,
-            group_params: {},
+            group_params: metadata.group_params,
             relations: relations,
             run_id: null,
-            signature: this.getSignature(pickle, metadata.ids),
+            signature: this.getSignature(pickle, metadata.ids, params),
             steps: steps,
             testops_id: metadata.ids.length > 0 ? metadata.ids : null,
             id: tcs.id,
@@ -309,6 +314,8 @@ class Storage {
             fields: {},
             title: null,
             isIgnore: false,
+            parameters: {},
+            group_params: {},
         };
         for (const tag of tags) {
             if (qaseIdRegExp.test(tag.name)) {
@@ -327,13 +334,35 @@ class Storage {
                 const value = tag.name.replace(/^@[Qq]ase[Ff]ields=/, '');
                 try {
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                    const record = JSON.parse(value);
+                    const record = JSON.parse(this.normalizeJsonString(value));
                     metadata.fields = { ...metadata.fields, ...record };
                 }
                 catch (e) {
                     // do nothing
                 }
             }
+            if (qaseParametersRegExp.test(tag.name)) {
+                const value = tag.name.replace(/^@[Qq]ase[Pp]arameters=/, '');
+                try {
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    const record = JSON.parse(this.normalizeJsonString(value));
+                    metadata.parameters = { ...metadata.parameters, ...record };
+                }
+                catch (e) {
+                    // do nothing
+                }
+            }
+            if (qaseGroupParametersRegExp.test(tag.name)) {
+                const value = tag.name.replace(/^@[Qq]ase[Gg]roup[Pp]arameters=/, '');
+                try {
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    const record = JSON.parse(this.normalizeJsonString(value));
+                    metadata.group_params = { ...metadata.group_params, ...record };
+                }
+                catch (e) {
+                    // do nothing
+                }
+            }
             if (qaseIgnoreRegExp.test(tag.name)) {
                 metadata.isIgnore = true;
             }
@@ -343,10 +372,11 @@ class Storage {
     /**
      * @param {Pickle} pickle
      * @param {number[]} ids
+     * @param {Record<string, string>} parameters
      * @private
      */
-    getSignature(pickle, ids) {
-        return (0, qase_javascript_commons_1.generateSignature)(ids, [...pickle.uri.split('/'), pickle.name], {});
+    getSignature(pickle, ids, parameters = {}) {
+        return (0, qase_javascript_commons_1.generateSignature)(ids, [...pickle.uri.split('/'), pickle.name], parameters);
     }
     getError(testCaseId) {
         const testErrors = this.testCaseStartedErrors[testCaseId];
@@ -360,6 +390,22 @@ class Storage {
         });
         return error;
     }
+    /**
+     * Normalize JSON string by converting single quotes to double quotes
+     * This allows parsing JSON-like strings with single quotes
+     * @param {string} jsonString
+     * @returns {string}
+     * @private
+     */
+    normalizeJsonString(jsonString) {
+        // If the string contains single quotes, convert them to double quotes
+        // This handles cases like {'key':'value'} which should be {"key":"value"}
+        if (jsonString.includes("'")) {
+            return jsonString.replace(/'/g, '"');
+        }
+        // If no single quotes, return as-is (already valid JSON or will fail with proper error)
+        return jsonString;
+    }
     getFileNameFromMediaType(mediaType) {
         const extensions = {
             'text/plain': 'txt',

package/docs/usage.md

@@ -8,7 +8,7 @@ fields, suites, comments, and file attachments to your test cases.
 ## Adding QaseID to a Test
 
 To associate a QaseID with a test in Cucumber.js, use the `@QaseId` tag in your Gherkin feature files. This tag accepts
-a single integer or multiple integers separated by commas representing the test's ID(s) in Qase.
+a single integer or multiple integers separated by commas representing the test"s ID(s) in Qase.
 
 ### Example
 
@@ -33,7 +33,7 @@ Feature: User Authentication
 ## Adding a Title to a Test
 
 You can provide a custom title for your test using the `@Title` tag. The tag accepts a string, which will be used as
-the test's title in Qase. If no title is provided, the scenario name will be used by default.
+the test"s title in Qase. If no title is provided, the scenario name will be used by default.
 
 ### Example
 
@@ -70,7 +70,7 @@ enhance test case information in Qase.
 Feature: User Authentication
 
   @QaseId=1
-  @QaseFields={'severity':'high','priority':'medium','description':'Login functionality test'}
+  @QaseFields={"severity":"high","priority":"medium","description":"Login functionality test"}
   Scenario: Successful login
     Given I am on the login page
     When I enter valid credentials
@@ -136,7 +136,7 @@ parameter names and values.
 Feature: User Authentication
 
   @QaseId=1
-  @QaseParameters={'browser':'chrome','environment':'staging'}
+  @QaseParameters={"browser":"chrome","environment":"staging"}
   Scenario: Successful login
     Given I am on the login page
     When I enter valid credentials
@@ -156,8 +156,8 @@ group parameter names and values.
 Feature: User Authentication
 
   @QaseId=1
-  @QaseParameters={'browser':'chrome','environment':'staging'}
-  @QaseGroupParameters={'test_group':'authentication','test_type':'smoke'}
+  @QaseParameters={"browser":"chrome","environment":"staging"}
+  @QaseGroupParameters={"test_group":"authentication","test_type":"smoke"}
   Scenario: Successful login
     Given I am on the login page
     When I enter valid credentials
@@ -185,23 +185,23 @@ Feature: User Authentication
 
 ```javascript
 // step_definitions/login_steps.js
-const { Given, When, Then } = require('@cucumber/cucumber');
+const { Given, When, Then } = require("@cucumber/cucumber");
 
-Given('I am on the login page', async function() {
+Given("I am on the login page", async function() {
   // Step implementation
-  await this.page.goto('https://example.com/login');
+  await this.page.goto("https://example.com/login");
 });
 
-When('I enter valid credentials', async function() {
+When("I enter valid credentials", async function() {
   // Step implementation
-  await this.page.fill('#username', 'testuser');
-  await this.page.fill('#password', 'password');
-  await this.page.click('#login-button');
+  await this.page.fill("#username", "testuser");
+  await this.page.fill("#password", "password");
+  await this.page.click("#login-button");
 });
 
-Then('I should be logged in', async function() {
+Then("I should be logged in", async function() {
   // Step implementation
-  await this.page.waitForSelector('.dashboard');
+  await this.page.waitForSelector(".dashboard");
 });
 ```
 
@@ -216,32 +216,32 @@ attaching files with content, paths, or media types.
 
 ```javascript
 // step_definitions/login_steps.js
-const { Given, When, Then } = require('@cucumber/cucumber');
+const { Given, When, Then } = require("@cucumber/cucumber");
 
-Given('I am on the login page', async function() {
-  await this.page.goto('https://example.com/login');
+Given("I am on the login page", async function() {
+  await this.page.goto("https://example.com/login");
   
   // Attach screenshot
   const screenshot = await this.page.screenshot();
-  await this.attach(screenshot, 'image/png');
+  await this.attach(screenshot, "image/png");
 });
 
-When('I enter valid credentials', async function() {
-  await this.page.fill('#username', 'testuser');
-  await this.page.fill('#password', 'password');
+When("I enter valid credentials", async function() {
+  await this.page.fill("#username", "testuser");
+  await this.page.fill("#password", "password");
   
   // Attach text content
-  await this.attach('Credentials entered successfully', 'text/plain');
+  await this.attach("Credentials entered successfully", "text/plain");
   
-  await this.page.click('#login-button');
+  await this.page.click("#login-button");
 });
 
-Then('I should be logged in', async function() {
-  await this.page.waitForSelector('.dashboard');
+Then("I should be logged in", async function() {
+  await this.page.waitForSelector(".dashboard");
   
   // Attach JSON data
-  const userData = { username: 'testuser', status: 'logged_in' };
-  await this.attach(JSON.stringify(userData, null, 2), 'application/json');
+  const userData = { username: "testuser", status: "logged_in" };
+  await this.attach(JSON.stringify(userData, null, 2), "application/json");
 });
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cucumberjs-qase-reporter",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "Qase TMS CucumberJS Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "main": "./dist/index.js",
@@ -40,16 +40,16 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@cucumber/messages": "^22.0.0",
-    "qase-javascript-commons": "~2.4.8"
+    "qase-javascript-commons": "~2.4.16"
   },
   "peerDependencies": {
     "@cucumber/cucumber": ">=7.0.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@types/jest": "^29.5.2",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0",
-    "uuid": "^9.0.0"
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.5",
+    "uuid": "^9.0.1"
   }
 }

package/tsconfig.build.json

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