newman-reporter-qase 2.0.0-beta.0 → 2.0.0-beta.2

package/README.md

@@ -1,11 +1,12 @@
-> # Qase TMS Newman reporter
->
-> Publish results simple and easy.
+# Qase TMS Newman reporter
 
-## How to integrate
+Publish results simple and easy.
+
+The Newman reporter is currently in the closed beta stage.
+To install the latest beta version, run:
 
 ```bash
-npm install newman-reporter-qase
+npm install newman-reporter-qase@beta
 ```
 
 ## Example of usage

package/changelog.md

@@ -0,0 +1,11 @@
+# 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/index.d.ts

@@ -0,0 +1,2 @@
+import { NewmanQaseReporter } from './reporter';
+export = NewmanQaseReporter;

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+const reporter_1 = require("./reporter");
+module.exports = reporter_1.NewmanQaseReporter;

package/dist/reporter.d.ts

@@ -0,0 +1,57 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { ConfigType, ConfigLoader } from 'qase-javascript-commons';
+export type NewmanQaseOptionsType = ConfigType;
+/**
+ * @class NewmanQaseReporter
+ */
+export declare class NewmanQaseReporter {
+    /**
+     * @type {RegExp}
+     */
+    static qaseIdRegExp: RegExp;
+    /**
+     * @param {EventList} eventList
+     * @returns {number[]}
+     * @private
+     */
+    private static getCaseIds;
+    /**
+     * @param {PropertyBase<PropertyBaseDefinition>} item
+     * @param {string[]} titles
+     * @returns {string[]}
+     * @private
+     */
+    private static getParentTitles;
+    /**
+     * @type {ReporterInterface}
+     * @private
+     */
+    private reporter;
+    /**
+     * @type {Map<string, TestResultType>}
+     * @private
+     */
+    private pendingResultMap;
+    /**
+     * @type {Map<string, number>}
+     * @private
+     */
+    private timerMap;
+    /**
+     * @param {EventEmitter} emitter
+     * @param {NewmanQaseOptionsType} options
+     * @param {unknown} _
+     * @param {ConfigLoaderInterface} configLoader
+     */
+    constructor(emitter: EventEmitter, options: NewmanQaseOptionsType, _: unknown, configLoader?: ConfigLoader<Partial<ConfigType> & Record<string, unknown>>);
+    /**
+     * @param {EventEmitter} runner
+     * @private
+     */
+    private addRunnerListeners;
+    /**
+     * @private
+     */
+    private preventExit;
+}

package/dist/reporter.js

@@ -0,0 +1,175 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NewmanQaseReporter = void 0;
+const semver_1 = __importDefault(require("semver"));
+const qase_javascript_commons_1 = require("qase-javascript-commons");
+/**
+ * @class NewmanQaseReporter
+ */
+class NewmanQaseReporter {
+    /**
+     * @param {EventList} eventList
+     * @returns {number[]}
+     * @private
+     */
+    static getCaseIds(eventList) {
+        const ids = [];
+        eventList.each((event) => {
+            if (event.listen === 'test' && event.script.exec) {
+                event.script.exec.forEach((line) => {
+                    const [, match] = line.match(NewmanQaseReporter.qaseIdRegExp) ?? [];
+                    if (match) {
+                        ids.push(...match.split(',').map((id) => Number(id)));
+                    }
+                });
+            }
+        });
+        return ids;
+    }
+    /**
+     * @param {PropertyBase<PropertyBaseDefinition>} item
+     * @param {string[]} titles
+     * @returns {string[]}
+     * @private
+     */
+    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;
+    }
+    /**
+     * @param {EventEmitter} emitter
+     * @param {NewmanQaseOptionsType} options
+     * @param {unknown} _
+     * @param {ConfigLoaderInterface} configLoader
+     */
+    constructor(emitter, options, _, configLoader = new qase_javascript_commons_1.ConfigLoader()) {
+        /**
+         * @type {Map<string, TestResultType>}
+         * @private
+         */
+        this.pendingResultMap = new Map();
+        /**
+         * @type {Map<string, number>}
+         * @private
+         */
+        this.timerMap = new Map();
+        const config = configLoader.load();
+        this.reporter = qase_javascript_commons_1.QaseReporter.getInstance({
+            ...(0, qase_javascript_commons_1.composeOptions)(options, config),
+            frameworkPackage: 'newman',
+            frameworkName: 'newman',
+            reporterName: 'newman-reporter-qase',
+        });
+        this.addRunnerListeners(emitter);
+    }
+    /**
+     * @param {EventEmitter} runner
+     * @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,
+                title: item.name,
+            });
+            this.timerMap.set(item.id, Date.now());
+        });
+        runner.on('assertion', (err, exec) => {
+            const { item } = exec;
+            const pendingResult = this.pendingResultMap.get(item.id);
+            if (pendingResult && 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) => {
+            const { item } = exec;
+            const pendingResult = this.pendingResultMap.get(item.id);
+            if (pendingResult) {
+                const timer = this.timerMap.get(item.id);
+                if (timer) {
+                    const now = Date.now();
+                    pendingResult.execution.duration = now - timer;
+                }
+                void this.reporter.addTestResult(pendingResult);
+            }
+        });
+        runner.on('beforeDone', () => {
+            void this.reporter.publish();
+        });
+        runner.on('done', () => {
+            this.preventExit();
+        });
+    }
+    /**
+     * @private
+     */
+    preventExit() {
+        const newmanVersion = (0, qase_javascript_commons_1.getPackageVersion)('newman');
+        if (!newmanVersion || semver_1.default.lt(newmanVersion, '5.3.2')) {
+            // eslint-disable-next-line @typescript-eslint/unbound-method
+            const _exit = process.exit;
+            const mutableProcess = process;
+            mutableProcess.exit = (code) => {
+                process.exitCode = code;
+                process.exit = _exit;
+            };
+        }
+    }
+}
+exports.NewmanQaseReporter = NewmanQaseReporter;
+/**
+ * @type {RegExp}
+ */
+NewmanQaseReporter.qaseIdRegExp = /\/\/\s*?[qQ]ase:\s?((?:[\d]+[\s,]{0,})+)/;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newman-reporter-qase",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.2",
   "description": "Qase TMS Newman Reporter",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -39,7 +39,7 @@
   "author": "Parviz Khavari <havaripa@gmail.com>",
   "license": "Apache-2.0",
   "dependencies": {
-    "qase-javascript-commons": "^2.0.0-beta.0",
+    "qase-javascript-commons": "^2.0.8",
     "semver": "^7.5.1"
   },
   "devDependencies": {