cucumberjs-qase-reporter 2.1.7 → 2.1.9

package/changelog.md

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

package/dist/models.d.ts

@@ -5,6 +5,7 @@ export interface TestMetadata {
     isIgnore: boolean;
     parameters: Record<string, string>;
     group_params: Record<string, string>;
+    suite: string | null;
 }
 export interface ScenarioData {
     name: string;

package/dist/storage.d.ts

@@ -105,6 +105,14 @@ export declare class Storage {
      */
     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

@@ -10,6 +10,7 @@ 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 qaseSuiteRegExp = /^@[Qq]ase[Ss]uite=(.+)$/;
 const qaseIgnoreRegExp = /^@[Qq]ase[Ii][Gg][Nn][Oo][Rr][Ee]$/;
 class Storage {
     /**
@@ -198,7 +199,20 @@ class Storage {
         let relations = null;
         let params = {};
         const nodeId = pickle.astNodeIds[0];
-        if (nodeId != undefined && this.scenarios[nodeId] != undefined) {
+        // If suite is specified in metadata, use it (split by tab for sub-suites)
+        if (metadata.suite) {
+            const suiteParts = metadata.suite.split('\t').filter(part => part.trim().length > 0);
+            relations = {
+                suite: {
+                    data: suiteParts.map((suite) => ({
+                        title: suite.trim(),
+                        public_id: null,
+                    })),
+                },
+            };
+        }
+        else if (nodeId != undefined && this.scenarios[nodeId] != undefined) {
+            // Otherwise, use feature name as suite
             relations = {
                 suite: {
                     data: [
@@ -209,6 +223,9 @@ class Storage {
                     ],
                 },
             };
+        }
+        // Extract parameters from Gherkin examples
+        if (nodeId != undefined && this.scenarios[nodeId] != undefined) {
             for (const id of pickle.astNodeIds) {
                 if (this.scenarios[nodeId]?.parameters[id] != undefined) {
                     params = { ...params, ...this.scenarios[nodeId]?.parameters[id] };
@@ -316,6 +333,7 @@ class Storage {
             isIgnore: false,
             parameters: {},
             group_params: {},
+            suite: null,
         };
         for (const tag of tags) {
             if (qaseIdRegExp.test(tag.name)) {
@@ -334,7 +352,7 @@ 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) {
@@ -345,7 +363,7 @@ class Storage {
                 const value = tag.name.replace(/^@[Qq]ase[Pp]arameters=/, '');
                 try {
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-                    const record = JSON.parse(value);
+                    const record = JSON.parse(this.normalizeJsonString(value));
                     metadata.parameters = { ...metadata.parameters, ...record };
                 }
                 catch (e) {
@@ -356,13 +374,17 @@ class Storage {
                 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(value);
+                    const record = JSON.parse(this.normalizeJsonString(value));
                     metadata.group_params = { ...metadata.group_params, ...record };
                 }
                 catch (e) {
                     // do nothing
                 }
             }
+            if (qaseSuiteRegExp.test(tag.name)) {
+                metadata.suite = tag.name.replace(/^@[Qq]ase[Ss]uite=/, '');
+                continue;
+            }
             if (qaseIgnoreRegExp.test(tag.name)) {
                 metadata.isIgnore = true;
             }
@@ -390,6 +412,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.7",
+  "version": "2.1.9",
   "description": "Qase TMS CucumberJS Reporter",
   "homepage": "https://github.com/qase-tms/qase-javascript",
   "main": "./dist/index.js",