release: qase-newman 2.0.0-beta.2

Added support suites for the Newman reporter
qase-tms · Jun 11, 2024 · 7914f09 · 7914f09
1 parent 8d59ec2
commit 7914f09
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 31 deletions.
diff --git a/qase-newman/changelog.md b/qase-newman/changelog.md
@@ -0,0 +1,11 @@
+# [email protected]
+
+## What's new
+
+Add support suites in test results. 
+
+# [email protected]
+
+## What's new
+
+First major beta release for the version 2 series of the Qase Newman reporter.
diff --git a/qase-newman/package.json b/qase-newman/package.json
@@ -39,7 +39,7 @@
   "author": "Parviz Khavari <[email protected]>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0-beta.8",
+    "qase-javascript-commons": "^2.0.8",
     "semver": "^7.5.1"
   },
   "devDependencies": {

diff --git a/qase-newman/src/reporter.ts b/qase-newman/src/reporter.ts
@@ -3,7 +3,7 @@ import { EventEmitter } from 'events';
 import semver from 'semver';
 import { NewmanRunExecution } from 'newman';
 import {
-  EventList,
+  EventList, PropertyBase, PropertyBaseDefinition,
 } from 'postman-collection';
 import {
   ConfigType,
@@ -13,7 +13,7 @@ import {
   TestResultType,
   getPackageVersion,
   ConfigLoader,
-  composeOptions,
+  composeOptions, Relation, SuiteData,
 } from 'qase-javascript-commons';
 
 export type NewmanQaseOptionsType = ConfigType;
@@ -50,28 +50,28 @@ export class NewmanQaseReporter {
     return ids;
   }
 
-  // /**
-  //  * @param {PropertyBase<PropertyBaseDefinition>} item
-  //  * @param {string[]} titles
-  //  * @returns {string[]}
-  //  * @private
-  //  */
-  // private static getParentTitles(
-  //   item: PropertyBase<PropertyBaseDefinition>,
-  //   titles: string[] = [],
-  // ) {
-  //   const parent = item.parent();
-  //
-  //   if (parent) {
-  //     NewmanQaseReporter.getParentTitles(parent, titles);
-  //   }
-  //
-  //   if ('name' in item) {
-  //     titles.push(String(item.name));
-  //   }
-  //
-  //   return titles;
-  // }
+  /**
+   * @param {PropertyBase<PropertyBaseDefinition>} item
+   * @param {string[]} titles
+   * @returns {string[]}
+   * @private
+   */
+  private static getParentTitles(
+    item: PropertyBase<PropertyBaseDefinition>,
+  ) {
+    const titles: string[] = [];
+
+    if ('name' in item) {
+      titles.push(String(item.name));
+    }
+
+    const parent = item.parent();
+    if (parent) {
+      titles.concat(NewmanQaseReporter.getParentTitles(parent));
+    }
+
+    return titles;
+  }
 
   /**
    * @type {ReporterInterface}
@@ -119,14 +119,29 @@ export class NewmanQaseReporter {
    */
   private addRunnerListeners(runner: EventEmitter) {
     runner.on('start', () => {
-      void this.reporter.startTestRun();
+      this.reporter.startTestRun();
     });
 
     runner.on(
       'beforeItem',
       (_err: Error | undefined, exec: NewmanRunExecution) => {
         const { item } = exec;
-        // const parent = item.parent();
+        const parent = item.parent();
+        const suites = parent ? NewmanQaseReporter.getParentTitles(parent) : [];
+        let relation: Relation | null = null;
+        if (suites.length > 0) {
+          const data: SuiteData[] = suites.map(title => {
+            return {
+              title: title,
+              public_id: null,
+            };
+          });
+          relation = {
+            suite: {
+              data: data,
+            },
+          };
+        }
         const ids = NewmanQaseReporter.getCaseIds(item.events);
         this.pendingResultMap.set(item.id, {
           attachments: [],
@@ -143,14 +158,13 @@ export class NewmanQaseReporter {
           message: null,
           muted: false,
           params: {},
-          relations: {},
+          relations: relation,
           run_id: null,
           signature: '',
           steps: [],
           testops_id: ids.length > 0 ? ids : null,
           id: item.id,
           title: item.name,
-          // suiteTitle: parent ? NewmanQaseReporter.getParentTitles(parent) : [],
         });
 
         this.timerMap.set(item.id, Date.now());
@@ -181,8 +195,6 @@ export class NewmanQaseReporter {
 
         if (timer) {
           const now = Date.now();
-          pendingResult.execution.start_time = timer;
-          pendingResult.execution.end_time = now;
           pendingResult.execution.duration = now - timer;
         }