playwright-qase-reporter 2.1.1 → 2.1.3

package/README.md

@@ -18,11 +18,13 @@ npm install -D playwright-qase-reporter
 
 # Contents
 
-- [Getting started](#getting-started)
-- [Updating from v1](#updating-from-v1)
-- [Example of usage](#example-of-usage)
-- [Configuration](#configuration)
-- [Requirements](#requirements)
+- [Qase TMS Playwright reporter](#qase-tms-playwright-reporter)
+- [Contents](#contents)
+  - [Getting started](#getting-started)
+  - [Updating from v1](#updating-from-v1)
+  - [Example of usage](#example-of-usage)
+  - [Configuration](#configuration)
+  - [Requirements](#requirements)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -172,6 +174,8 @@ Reporter options (\* - required):
 - `testops.run.title` - Set custom Run name, when new run is created
 - `testops.run.description` - Set custom Run description, when new run is created
 - `testops.run.complete` - Whether the run should be completed
+- `framework.browser.addAsParameter` - Whether to add the browser name as a parameter, default - `false`
+- `framework.browser.parameterName` - The name of the parameter to add the browser name to, default - `browser`
 
 Example `playwright.config.js` config:
 
@@ -197,6 +201,12 @@ const config = {
             complete: true,
           },
         },
+        framework: {
+          browser: {
+            addAsParameter: true,
+            parameterName: 'Browser Name',
+          },
+        },
       },
     ],
   ],

package/changelog.md

@@ -1,3 +1,28 @@
+# playwright-qase-reporter@2.1.3
+
+## What's new
+
+Support specifying the browser name as a parameter.
+New section `framework` was added to the playwright config.
+
+```ts
+[
+  'playwright-qase-reporter',
+   {
+     debug: true,
+     testops: {
+      ...
+     },
+     framework: {
+      browser: {
+       addAsParameter: true,
+       parameterName: 'Browser Name',
+      },
+    },
+  },
+],
+```
+
 # playwright-qase-reporter@2.1.1
 
 ## What's new

package/dist/configSchema.d.ts

@@ -0,0 +1,4 @@
+import { JSONSchemaType } from 'ajv';
+import { FrameworkOptionsType } from 'qase-javascript-commons';
+import { ReporterOptionsType } from './options';
+export declare const configSchema: JSONSchemaType<FrameworkOptionsType<'playwright', ReporterOptionsType>>;

package/dist/configSchema.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configSchema = void 0;
+exports.configSchema = {
+    type: 'object',
+    nullable: true,
+    properties: {
+        framework: {
+            type: 'object',
+            nullable: true,
+            properties: {
+                playwright: {
+                    type: 'object',
+                    nullable: true,
+                    properties: {
+                        browser: {
+                            type: 'object',
+                            nullable: true,
+                            properties: {
+                                addAsParameter: {
+                                    type: 'boolean',
+                                    nullable: true,
+                                },
+                                parameterName: {
+                                    type: 'string',
+                                    nullable: true,
+                                },
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+};

package/dist/options.d.ts

@@ -0,0 +1,6 @@
+export type ReporterOptionsType = {
+    browser?: {
+        addAsParameter?: boolean;
+        parameterName?: string;
+    };
+};

package/dist/options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/reporter.d.ts

@@ -1,6 +1,9 @@
 import { Reporter, TestCase, TestResult, TestStatus, TestStep } from '@playwright/test/reporter';
 import { ConfigLoader, ConfigType, TestStatusEnum } from 'qase-javascript-commons';
-export type PlaywrightQaseOptionsType = ConfigType;
+import { ReporterOptionsType } from './options';
+export type PlaywrightQaseOptionsType = Omit<ConfigType, 'reporterOptions'> & {
+    framework: ReporterOptionsType;
+};
 /**
  * @class PlaywrightQaseReporter
  * @implements Reporter
@@ -55,6 +58,7 @@ export declare class PlaywrightQaseReporter implements Reporter {
      * @private
      */
     private reporter;
+    private options;
     /**
      * @param {PlaywrightQaseOptionsType} options
      * @param {ConfigLoaderInterface} configLoader
@@ -84,13 +88,6 @@ export declare class PlaywrightQaseReporter implements Reporter {
      * @private
      */
     private convertLogsToAttachments;
-    /**
-     * @param {string[]} suites
-     * @param {Record<string, string>} parameters
-     * @param {number[]} ids
-     * @private
-     */
-    private getSignature;
     /**
      * @param {string} title
      * @returns {string}

package/dist/reporter.js

@@ -242,14 +242,17 @@ class PlaywrightQaseReporter {
      * @private
      */
     reporter;
+    options;
     /**
      * @param {PlaywrightQaseOptionsType} options
      * @param {ConfigLoaderInterface} configLoader
      */
     constructor(options, configLoader = new qase_javascript_commons_1.ConfigLoader()) {
         const config = configLoader.load();
+        const { framework, ...composedOptions } = (0, qase_javascript_commons_1.composeOptions)(options, config);
+        this.options = options.framework ?? {};
         this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
-            ...(0, qase_javascript_commons_1.composeOptions)(options, config),
+            ...composedOptions,
             frameworkPackage: '@playwright/test',
             frameworkName: 'playwright',
             reporterName: 'playwright-qase-reporter',
@@ -283,7 +286,7 @@ class PlaywrightQaseReporter {
         }
         const error = result.error ? PlaywrightQaseReporter.transformError(result.errors) : null;
         const extractedSuites = this.extractSuiteFromAnnotation(test.annotations);
-        const suites = extractedSuites.length > 0
+        let suites = extractedSuites.length > 0
             ? extractedSuites
             : (testCaseMetadata.suite ? [testCaseMetadata.suite] : PlaywrightQaseReporter.transformSuiteTitle(test));
         let message = null;
@@ -299,6 +302,15 @@ class PlaywrightQaseReporter {
             }
             message += error.message;
         }
+        if (this.options.browser?.addAsParameter) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access
+            const browser = test._projectId ?? null;
+            if (browser) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                testCaseMetadata.parameters[this.options.browser?.parameterName ?? 'browser'] = browser;
+                suites = suites.filter(suite => suite !== browser);
+            }
+        }
         const testTitle = this.removeQaseIdsFromTitle(test.title);
         const testResult = {
             attachments: testCaseMetadata.attachments,
@@ -355,7 +367,7 @@ class PlaywrightQaseReporter {
         else {
             testResult.testops_id = PlaywrightQaseReporter.qaseIds.get(test.title) ?? null;
         }
-        testResult.signature = this.getSignature(suites, testCaseMetadata.parameters, testResult.testops_id ?? []);
+        testResult.signature = (0, qase_javascript_commons_1.generateSignature)(testResult.testops_id, suites, testCaseMetadata.parameters);
         await this.reporter.addTestResult(testResult);
     }
     /**
@@ -385,27 +397,6 @@ class PlaywrightQaseReporter {
             content: content,
         };
     }
-    /**
-     * @param {string[]} suites
-     * @param {Record<string, string>} parameters
-     * @param {number[]} ids
-     * @private
-     */
-    getSignature(suites, parameters, ids) {
-        let signature = suites.map(suite => suite.toLowerCase()
-            .replace('/', '::')
-            .replace(/\s/g, '_')).join('::');
-        if (ids.length > 0) {
-            signature += '::' + ids.join('::');
-        }
-        if (Object.keys(parameters).length !== 0) {
-            signature += '::';
-        }
-        signature += Object.entries(parameters)
-            .map(([key, value]) => `{${key}:${value}}`)
-            .join('::');
-        return signature;
-    }
     /**
      * @param {string} title
      * @returns {string}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-qase-reporter",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "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.3.0",
+    "qase-javascript-commons": "~2.3.3",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
@@ -53,6 +53,7 @@
   "devDependencies": {
     "@jest/globals": "^29.5.0",
     "@types/jest": "^29.5.2",
+    "ajv": "^8.12.0",
     "jest": "^29.5.0",
     "ts-jest": "^29.1.0"
   }