playwright-qase-reporter 2.1.0 → 2.1.1

package/changelog.md

@@ -1,3 +1,19 @@
+# playwright-qase-reporter@2.1.1
+
+## What's new
+
+Support specifying the test case suite in the `annotation`.
+
+```ts
+test('test',
+  {
+    annotation: { type: 'QaseSuite', description: 'My suite' },
+  },
+  async ({ page }) => {
+    await page.goto('https://example.com');
+  });
+```
+
 # playwright-qase-reporter@2.1.0
 
 ## What's new

package/dist/reporter.d.ts

@@ -103,6 +103,12 @@ export declare class PlaywrightQaseReporter implements Reporter {
      * @private
      */
     private extractQaseIdsFromAnnotation;
+    /**
+     * @param annotation
+     * @returns {string[]}
+     * @private
+     */
+    private extractSuiteFromAnnotation;
     /**
      * @param {TestStep[]} steps
      * @returns {boolean}

package/dist/reporter.js

@@ -282,7 +282,10 @@ class PlaywrightQaseReporter {
             return;
         }
         const error = result.error ? PlaywrightQaseReporter.transformError(result.errors) : null;
-        const suites = testCaseMetadata.suite != '' ? [testCaseMetadata.suite] : PlaywrightQaseReporter.transformSuiteTitle(test);
+        const extractedSuites = this.extractSuiteFromAnnotation(test.annotations);
+        const suites = extractedSuites.length > 0
+            ? extractedSuites
+            : (testCaseMetadata.suite ? [testCaseMetadata.suite] : PlaywrightQaseReporter.transformSuiteTitle(test));
         let message = null;
         if (testCaseMetadata.comment !== '') {
             message = testCaseMetadata.comment;
@@ -433,6 +436,20 @@ class PlaywrightQaseReporter {
         }
         return ids;
     }
+    /**
+     * @param annotation
+     * @returns {string[]}
+     * @private
+     */
+    extractSuiteFromAnnotation(annotation) {
+        const suites = [];
+        for (const item of annotation) {
+            if (item.type.toLowerCase() === 'qasesuite' && item.description) {
+                suites.push(item.description);
+            }
+        }
+        return suites;
+    }
     /**
      * @param {TestStep[]} steps
      * @returns {boolean}

package/docs/usage.md

@@ -13,61 +13,72 @@ Here is the complete list of syntax options available for the reporter:
 - [Attach](#attach)
 - [Ignore](#ignore)
 
-If you do not use any Qase syntax, the reporter uses the title from the `describe` and `test` functions as the Suite and Test case title respectively, when publishing results.
+If you do not use any Qase syntax, the reporter uses the title from the `describe` and `test` functions as the Suite and
+Test case title respectively, when publishing results.
 
 <br>
 
 ### Import Statement
+
 ---
 Add the following statement at the beginning of your spec file, before any tests.
 
 ```javascript
 import { qase } from 'playwright-qase-reporter';
 ```
+
 <br>
 
 ### Example Spec file
+
 ---
+
 ```javascript
 import { qase } from 'playwright-qase-reporter';
 
 describe('Suite title', () => {
 
-  test(qase(1, "This is the test name"), () => {
+  test(qase(1, "This is the test name"), async () => {
     qase.title("This overrides the test name");
     qase.suite("Suite name");
     qase.fields({ 'severity': 'high', 'priority': 'medium' });
     qase.attach({ paths: './tests/examples/attachments/test-file.txt' });
     qase.comment("A comment for this result");
     qase.ignore(); // doesn't report his result to Qase.
-    qase.parameters({ Username: "@test" }); 
+    qase.parameters({ Username: "@test" });
     qase.groupParameters({ Username: username, Password: "123" });
-    await test.step('Test step title', async () => // step logic });
+    await test.step('Test step title', async () => {
+      // step logic 
+    });
   });
-
+});
 ```
+
 <br>
 
 ### Qase ID
+
 ---
 
-Qase IDs can be defined using two different methods. It is best to select one method and consistently use it throughout your tests. The first method is recommended.
+Qase IDs can be defined using two different methods. It is best to select one method and consistently use it throughout
+your tests. The first method is recommended.
 
-Only one Qase Id can be linked to a test. 
+Only one Qase Id can be linked to a test.
 
-**Inline with the `test` Function**: 
+**Inline with the `test` Function**:
 
 ```javascript
 test(qase(1, 'A simple test'), () => {
-    ..
+  // Test logic here
+});
 ```
 
-**Inside the `test` Body**: 
+**Inside the `test` Body**:
 
 ```javascript
 test('A simple test', () => {
-    qase.id(1);
-    // Test logic here
+  qase.id(1);
+  // Test logic here
 });
 ```
 
@@ -75,19 +86,22 @@ test('A simple test', () => {
 
 ```js
 test('A simple test',
-{
-  annotation: { type: 'QaseID', description: '1' },
-},
+  {
+    annotation: { type: 'QaseID', description: '1' },
+  },
   async () => {
     // Test logic here
-});
+  });
 ```
+
 <br>
 
 ### Qase Title
---- 
 
-The `qase.title()` method is used to set the title of a test case, both when creating a new test case from the result, and when updating the title of an existing test case - *if used with `qase.id()`.*
+---
+
+The `qase.title()` method is used to set the title of a test case, both when creating a new test case from the result,
+and when updating the title of an existing test case - *if used with `qase.id()`.*
 
 ```javascript
 test("This won't appear in Qase", () => {
@@ -96,16 +110,21 @@ test("This won't appear in Qase", () => {
 });
 ```
 
-If you don’t explicitly set a title using this method, the title specified in the `test(..)` function will be used for creating new test cases. However, if this method is defined, it always takes precedence and overrides the title from the `test(..)` function.
+If you don’t explicitly set a title using this method, the title specified in the `test(..)` function will be used for
+creating new test cases. However, if this method is defined, it always takes precedence and overrides the title from the
+`test(..)` function.
 
 <br>
 
 ### Steps
---- 
 
-The reporter uses the title from the `test.step` function as the step title. By providing clear and descriptive step names, you make it easier to understand the test’s flow when reviewing the test case.
+---
+
+The reporter uses the title from the `test.step` function as the step title. By providing clear and descriptive step
+names, you make it easier to understand the test’s flow when reviewing the test case.
 
-Additionally, these steps get their own result in the Qase Test run, offering a well-organized summary of the test flow. This helps quickly identify the cause of any failures.
+Additionally, these steps get their own result in the Qase Test run, offering a well-organized summary of the test flow.
+This helps quickly identify the cause of any failures.
 
 ```javascript
 test('A Test case with steps, updated from code', async () => {
@@ -122,7 +141,8 @@ test('A Test case with steps, updated from code', async () => {
 });
 ```
 
-You also can use the `qase.step()` method to set the expected result and data of the step, which will be used in the Qase report.
+You also can use the `qase.step()` method to set the expected result and data of the step, which will be used in the
+Qase report.
 
 ```javascript
 test('A Test case with steps, updated from code', async () => {
@@ -142,53 +162,71 @@ test('A Test case with steps, updated from code', async () => {
 <br>
 
 ### Fields
+
 ---
 
-You can define the `description`, `pre-conditions`, `post-conditions`, and fields such as `severity`, `priority`, and `layer` using this method, which enables you to specify and maintain the context of the case directly within your code.
+You can define the `description`, `pre-conditions`, `post-conditions`, and fields such as `severity`, `priority`, and
+`layer` using this method, which enables you to specify and maintain the context of the case directly within your code.
 
 ```javascript
 test('Maintain your test meta-data from code', async () => {
   qase.fields({
-      severity: 'high',
-      priority: 'medium',
-      layer: 'api',
-      precondition: 'add your precondition'
-      postcondition: 'add your postcondition'
-      description: `Code it quick, fix it slow,
+    severity: 'high',
+    priority: 'medium',
+    layer: 'api',
+    precondition: 'add your precondition',
+    postcondition: 'add your postcondition',
+    description: `Code it quick, fix it slow,
                     Tech debt grows where shortcuts go,
                     Refactor later? Ha! We know.`
-    })
-    //  test logic here
+  })
+  //  test logic here
 });
 ```
 
 <br>
 
+### Suite
 
-### Suite 
 ---
 
-You can use this method to nest the resulting test cases in a particular suite. There's something to note here – suites, unlike test cases, are not identified uniquely by the Reporter. Therefore, when defining an existing suite - the title of the suite is used for matching.
+You can use this method to nest the resulting test cases in a particular suite. There's something to note here – suites,
+unlike test cases, are not identified uniquely by the Reporter. Therefore, when defining an existing suite - the title
+of the suite is used for matching.
 
 ```js
-test("Test with a defined suite", () => {
-  qase.suite("Suite defined with qase.suite()");
-    /*
-     *  Or, nest multiple levels of suites. 
-     *  `\t` is used for dividing each suite name.
-     */
-     
-test("Test with a nested suite", () => {
-  qase.suite("Application\tAuthentication\tLogin\tEdge_case");
+test('Test with a defined suite', () => {
+  qase.suite('Suite defined with qase.suite()');
+});
+
+/*
+ *  Or, nest multiple levels of suites. 
+ *  `\t` is used for dividing each suite name.
+ */
+test('Test with a nested suite', () => {
+  qase.suite('Application\tAuthentication\tLogin\tEdge_case');
   //  test logic here
 });
+
+test('Test with a suite from annotations',
+  {
+    annotation: {
+      type: 'QaseSuite', 
+      description: 'Suite defined in annotation',
+    },
+  },
+  async () => {
+    // Test logic here
+  });
 ```
+
 <br>
 
 ### Parameters
----
-Parameters are a great way to make your tests more dynamic, reusable, and data-driven. By defining parameters in this method, you can ensure only one test case with all the parameters is created in your Qase project, avoiding duplication.
 
+---
+Parameters are a great way to make your tests more dynamic, reusable, and data-driven. By defining parameters in this
+method, you can ensure only one test case with all the parameters is created in your Qase project, avoiding duplication.
 
 ```javascript
 const testCases = [
@@ -197,69 +235,83 @@ const testCases = [
   { browser: "Webkit", username: "@charlie", password: "789" },
 ];
 
-testCases.forEach(({ browser, username, password,  }) => {
+testCases.forEach(({ browser, username, password, }) => {
   test(`Test login with ${browser}`, async () => {
     qase.title("Verify if page loads on all browsers");
 
     qase.parameters({ Browser: browser });  // Single parameter
-  // test logic
-
-testCases.forEach(({ username, password }) => {
-  test(`Test login with ${username} using qase.groupParameters`, () => {
-    qase.title("Verify if user is able to login with their username.");
-
-    qase.groupParameters({  // Group parameters
-      Username: username,
-      Password: password,
+    // test logic
+
+    testCases.forEach(({ username, password }) => {
+      test(`Test login with ${username} using qase.groupParameters`, () => {
+        qase.title("Verify if user is able to login with their username.");
+
+        qase.groupParameters({  // Group parameters
+          Username: username,
+          Password: password,
+        });
+        // test logic
+      });
     });
-  // test logic
+  });
+});
 ```
+
 <br>
 
 ### Comment
+
 ---
-In addition to `test.step()`, this method can be used to provide any additional context to your test, it helps maintiain the code by clarifying the expected result of the test.
+In addition to `test.step()`, this method can be used to provide any additional context to your test, it helps maintiain
+the code by clarifying the expected result of the test.
 
 ```js
 test("A test case with qase.comment()", () => {
-    /*
-     * Please note, this comment is added to a Result, not to the Test case.
-     */
+  /*
+   * Please note, this comment is added to a Result, not to the Test case.
+   */
   qase.comment("This comment is added to the result");
   // test logic here
 });
 ```
+
 <br>
 
 ### Attach
+
 ---
-This method can help attach one, or more files to the test's result. You can also add the file's contents directly from code. For example: 
+This method can help attach one, or more files to the test's result. You can also add the file's contents directly from
+code. For example:
 
 ```js
 test('Test result with attachment', async () => {
 
-       // To attach a single file
-    qase.attach({
-      paths: "./tests/examples/attachments/test-file.txt",
-    });
+  // To attach a single file
+  qase.attach({
+    paths: "./tests/examples/attachments/test-file.txt",
+  });
 
-       // Add multiple attachments. 
-    qase.attach({ paths: ['/path/to/file', '/path/to/another/file'] });
+  // Add multiple attachments. 
+  qase.attach({ paths: ['/path/to/file', '/path/to/another/file'] });
 
 
-       // Upload file's contents directly from code.
-    qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
-      // test logic here
+  // Upload file's contents directly from code.
+  qase.attach({ name: 'attachment.txt', content: 'Hello, world!', contentType: 'text/plain' });
+  // test logic here
 });
 ```
+
 <br>
 
 ### Ignore
+
 ---
-If this method is added, the reporter will exclude the test’s result from the report sent to Qase. While the test will still executed by Playwright, its result will not be considered by the reporter.
+If this method is added, the reporter will exclude the test’s result from the report sent to Qase. While the test will
+still executed by Playwright, its result will not be considered by the reporter.
 
 ```js
-test("This test is executed using Playwright; however, it is NOT reported to Qase", () => {
+test('This test is executed using Playwright; however, it is NOT reported to Qase', () => {
   qase.ignore();
 //  test logic here
+});
 ```

package/package.json

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