release: qase-playwright 2.0.3

Added new annotation `qase.suite()`.
Tests marked with it will be grouped in the Qase report by the specified suite name.

qase-playwright/changelog.md

@@ -1,3 +1,20 @@
+# [email protected]
+
+## What's new
+
+Added new annotation `qase.suite()`.
+Tests marked with it will be reported to the specified suite in the Qase.
+
+If you don't specify the suite name, the reporter will take a suites from the test file path.
+If you use the root suite, the reporter will take the root suite as the first level of the suite and your value of the `qase.suite()` as the second level.
+
+```js
+test('test', async ({ page }) => {
+  qase.suite("Custom suite");
+  await page.goto('https://example.com');
+});
+```
+
 # [email protected]
 
 ## What's new

qase-playwright/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-qase-reporter",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Qase TMS Playwright Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

qase-playwright/src/playwright.ts

@@ -13,6 +13,7 @@ export interface MetadataMessage {
   fields?: Record<string, string>;
   parameters?: Record<string, string>;
   ignore?: boolean;
+  suite?: string;
 }
 
 /**
@@ -182,6 +183,22 @@ qase.ignore = function() {
   return this;
 };
 
+/**
+ * Set a suite for the test case
+ * @param {string} value
+ * @example
+ * test('test', async ({ page }) => {
+ *    qase.suite("Suite");
+ *    await page.goto('https://example.com');
+ * });
+ */
+qase.suite = function(value: string) {
+  addMetadata({
+    suite: value,
+  });
+  return this;
+};
+
 const addMetadata = (metadata: MetadataMessage): void => {
   test.info().attach('qase-metadata.json', {
     contentType: ReporterContentType,

qase-playwright/src/reporter.ts

@@ -30,6 +30,7 @@ interface TestCaseMetadata {
   parameters: Record<string, string>;
   attachments: Attachment[];
   ignore: boolean;
+  suite: string;
 }
 
 export type PlaywrightQaseOptionsType = ConfigType;
@@ -98,6 +99,7 @@ export class PlaywrightQaseReporter implements Reporter {
       parameters: {},
       attachments: [],
       ignore: false,
+      suite: '',
     };
     const attachments: Attachment[] = [];
 
@@ -131,6 +133,10 @@ export class PlaywrightQaseReporter implements Reporter {
           metadata.ignore = message.ignore;
         }
 
+        if (message.suite) {
+          metadata.suite = message.suite;
+        }
+
         continue;
       }
 
@@ -307,7 +313,7 @@ export class PlaywrightQaseReporter implements Reporter {
     }
 
     const error = result.error ? PlaywrightQaseReporter.transformError(result.error) : null;
-    const suites = PlaywrightQaseReporter.transformSuiteTitle(test);
+    const suites = testCaseMetadata.suite != '' ? [testCaseMetadata.suite] : PlaywrightQaseReporter.transformSuiteTitle(test);
     const testResult: TestResultType = {
       attachments: testCaseMetadata.attachments,
       author: null,