newman-reporter-qase 2.0.0-beta.1 → 2.0.0

package/README.md

@@ -1,8 +1,8 @@
-> # Qase TMS Newman reporter
->
-> Publish results simple and easy.
+# Qase TMS Newman reporter
 
-## How to integrate
+Publish results simple and easy.
+
+To install the latest version, run:
 
 ```bash
 npm install newman-reporter-qase

package/changelog.md

@@ -0,0 +1,23 @@
+# qase-newman@2.0.0
+
+## What's new
+
+This is the first release in the 2.x series of the Newman reporter.
+It brings new and more flexible configs, uploading results in parallel with running tests,
+and other powerful features.
+
+This changelog entry will be updated soon.
+For more information about the new features and a guide for migration from v1, refer to the
+[reporter documentation](https://github.com/qase-tms/qase-javascript/tree/main/qase-newman#readme)
+
+# qase-newman@2.0.0-beta.2
+
+## What's new
+
+Add support for suites in test results. 
+
+# qase-newman@2.0.0-beta.1
+
+## What's new
+
+First major beta release for the version 2 series of the Qase Newman reporter.

package/dist/reporter.js

@@ -35,14 +35,15 @@ class NewmanQaseReporter {
      * @returns {string[]}
      * @private
      */
-    static getParentTitles(item, titles = []) {
-        const parent = item.parent();
-        if (parent) {
-            NewmanQaseReporter.getParentTitles(parent, titles);
-        }
+    static getParentTitles(item) {
+        const titles = [];
         if ('name' in item) {
             titles.push(String(item.name));
         }
+        const parent = item.parent();
+        if (parent) {
+            titles.concat(NewmanQaseReporter.getParentTitles(parent));
+        }
         return titles;
     }
     /**
@@ -63,7 +64,7 @@ class NewmanQaseReporter {
          */
         this.timerMap = new Map();
         const config = configLoader.load();
-        this.reporter = new qase_javascript_commons_1.QaseReporter({
+        this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
             ...(0, qase_javascript_commons_1.composeOptions)(options, config),
             frameworkPackage: 'newman',
             frameworkName: 'newman',
@@ -76,16 +77,50 @@ class NewmanQaseReporter {
      * @private
      */
     addRunnerListeners(runner) {
+        runner.on('start', () => {
+            this.reporter.startTestRun();
+        });
         runner.on('beforeItem', (_err, exec) => {
             const { item } = exec;
             const parent = item.parent();
+            const suites = parent ? NewmanQaseReporter.getParentTitles(parent) : [];
+            let relation = null;
+            if (suites.length > 0) {
+                const data = 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: [],
+                author: null,
+                execution: {
+                    status: qase_javascript_commons_1.TestStatusEnum.passed,
+                    start_time: 0,
+                    end_time: 0,
+                    duration: 0,
+                    stacktrace: null,
+                    thread: null,
+                },
+                fields: {},
+                message: null,
+                muted: false,
+                params: {},
+                relations: relation,
+                run_id: null,
+                signature: '',
+                steps: [],
+                testops_id: ids.length > 0 ? ids : null,
                 id: item.id,
-                testOpsId: NewmanQaseReporter.getCaseIds(item.events),
                 title: item.name,
-                suiteTitle: parent ? NewmanQaseReporter.getParentTitles(parent) : [],
-                status: qase_javascript_commons_1.TestStatusEnum.passed,
-                duration: 0,
             });
             this.timerMap.set(item.id, Date.now());
         });
@@ -93,8 +128,9 @@ class NewmanQaseReporter {
             const { item } = exec;
             const pendingResult = this.pendingResultMap.get(item.id);
             if (pendingResult && err) {
-                pendingResult.status = qase_javascript_commons_1.TestStatusEnum.failed;
-                pendingResult.error = err;
+                pendingResult.execution.status = qase_javascript_commons_1.TestStatusEnum.failed;
+                pendingResult.execution.stacktrace = err.stack ?? null;
+                pendingResult.message = err.message;
             }
         });
         runner.on('item', (_err, exec) => {
@@ -104,11 +140,9 @@ class NewmanQaseReporter {
                 const timer = this.timerMap.get(item.id);
                 if (timer) {
                     const now = Date.now();
-                    pendingResult.startTime = timer;
-                    pendingResult.duration = now - timer;
-                    pendingResult.endTime = now;
+                    pendingResult.execution.duration = now - timer;
                 }
-                this.reporter.addTestResult(pendingResult);
+                void this.reporter.addTestResult(pendingResult);
             }
         });
         runner.on('beforeDone', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newman-reporter-qase",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0",
   "description": "Qase TMS Newman Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -36,10 +36,10 @@
     "test": "jest --passWithNoTests",
     "clean": "rm -rf dist"
   },
-  "author": "Parviz Khavari <havaripa@gmail.com>",
+  "author": "Qase Team <support@qase.io>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0-beta.1",
+    "qase-javascript-commons": "^2.0.9",
     "semver": "^7.5.1"
   },
   "devDependencies": {