testit-adapter-mocha 2.1.8 → 2.2.1

package/README.md

@@ -21,7 +21,7 @@ module.exports = {
 
 ## Configuration
 
-| Description                                                                                                                                                | Property                   | Environment variable              |
+| Description                                                                                                                                                | File property              | Environment variable              |
 |------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-----------------------------------|
 | Location of the TMS instance                                                                                                                               | url                        | TMS_URL                           |
 | API secret key <br/>[How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken)                           | privateToken               | TMS_PRIVATE_TOKEN                 |
@@ -89,6 +89,26 @@ TMS_CONFIG_FILE=pathToAnotherConfigFile; #optional
 TMS_AUTOMATIC_CREATION_TEST_CASES=false; # or true, optional
 ```
 
+#### Parallel run
+To create and complete TestRun you can use the Test IT CLI (use adapterMode 1 for parallel run):
+
+```
+$ export TMS_TOKEN=<YOUR_TOKEN>
+$ testit testrun create
+  --url https://tms.testit.software \
+  --project-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
+  --testrun-name "New test run" \
+  --output tmp/output.txt
+
+$ export TMS_TEST_RUN_ID=$(cat tmp/output.txt)
+
+$ npx mocha --parallel
+
+$ testit testrun complete
+  --url https://tms.testit.software \
+  --testrun-id $(cat tmp/output.txt)
+```
+
 ## Usage
 
 Methods and properties can be used to specify information about autotest.

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const reporter_js_1 = require("./reporter.js");
+module.exports = reporter_js_1.TmsReporter;

package/lib/reporter.d.ts

@@ -1 +1,34 @@
+import { reporters, Runner } from "mocha";
+import { Attachment, Link } from "testit-js-commons";
+import { ReporterOptions, Context, Test } from "./types";
+import { ITestStep } from "./step";
+declare const Reporter: typeof reporters.Base;
+export declare class TmsReporter extends Reporter {
+    private readonly strategy;
+    private readonly additions;
+    private attachmentsQueue;
+    private autotestsQueue;
+    private autotestsForTestRun;
+    private currentType?;
+    private currentTest;
+    private currentStep;
+    constructor(runner: Runner, options: ReporterOptions);
+    private applyListeners;
+    onStartRun: () => void;
+    onEndRun: () => void;
+    private teardown;
+    clearContext(ctx: Context): void;
+    addMethods(context?: Context): void;
+    onStartTest(): void;
+    onEndTest(test: Test): void;
+    resetTest(test: Test): void;
+    addAttachments: (pathsOrContent: string | string[], fileName?: string) => Promise<Attachment[]>;
+    addLinks: (links: Link | Link[]) => void;
+    addMessage: (message: string) => void;
+    addSteps: (title: string, stepConstructor?: (step: ITestStep) => void) => void;
+    private _getNameSpace;
+    private _getClassName;
+    private _getOutcome;
+    private _getDuration;
+}
 export {};

package/lib/reporter.js

@@ -8,12 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TmsReporter = void 0;
 const mocha_1 = require("mocha");
+const deasync_promise_1 = __importDefault(require("deasync-promise"));
 const testit_js_commons_1 = require("testit-js-commons");
 const step_1 = require("./step");
 const utils_1 = require("./utils");
-const Reporter = mocha_1.reporters.List;
+const Reporter = mocha_1.reporters.Base;
 const Events = mocha_1.Runner.constants;
 const emptyTest = () => ({
     autoTestExternalId: "",
@@ -33,27 +38,29 @@ const StateConstants = {
     STATE_PASSED: 'passed',
     STATE_PENDING: 'pending',
 };
-module.exports = class extends Reporter {
+class TmsReporter extends Reporter {
     constructor(runner, options) {
+        var _a;
         super(runner, options);
         this.attachmentsQueue = [];
         this.autotestsQueue = [];
         this.autotestsForTestRun = [];
         this.currentTest = emptyTest();
         this.currentStep = emptyStep();
-        this.onStartRun = () => __awaiter(this, void 0, void 0, function* () {
+        this.applyListeners = () => {
+            this.runner.on(Events.EVENT_RUN_BEGIN, () => this.onStartRun());
+            this.runner.on(Events.EVENT_RUN_END, () => this.onEndRun());
+            this.runner.on(Events.EVENT_TEST_BEGIN, (test) => this.addMethods(test.ctx));
+            this.runner.on(Events.EVENT_HOOK_BEGIN, (hook) => this.addMethods(hook.ctx));
+            this.runner.on(Events.EVENT_TEST_BEGIN, () => this.onStartTest());
+            this.runner.on(Events.EVENT_TEST_END, (test) => this.onEndTest(test));
+        };
+        this.onStartRun = () => {
             this.strategy.setup();
-        });
-        this.onEndRun = () => __awaiter(this, void 0, void 0, function* () {
-            yield Promise.all(this.attachmentsQueue).catch((err) => {
-                console.log("Error loading attachments. \n", err.body);
-            });
-            yield Promise.all(this.autotestsQueue);
-            yield this.strategy.loadTestRun(this.autotestsForTestRun).catch((err) => {
-                console.log("Error load test run. \n", err.body);
-            });
-            yield this.strategy.teardown();
-        });
+        };
+        this.onEndRun = () => {
+            (0, deasync_promise_1.default)(this.teardown());
+        };
         this.addAttachments = (pathsOrContent, fileName) => {
             const target = this.currentType === "test" ? this.currentTest : this.currentStep;
             const promise = typeof pathsOrContent === "string"
@@ -101,12 +108,24 @@ module.exports = class extends Reporter {
         const client = new testit_js_commons_1.Client(config);
         this.strategy = testit_js_commons_1.StrategyFactory.create(client, config);
         this.additions = new testit_js_commons_1.Additions(client);
-        this.runner.on(Events.EVENT_RUN_BEGIN, () => this.onStartRun());
-        this.runner.on(Events.EVENT_RUN_END, () => this.onEndRun());
-        this.runner.on(Events.EVENT_TEST_BEGIN, (test) => this.addMethods(test.ctx));
-        this.runner.on(Events.EVENT_HOOK_BEGIN, (hook) => this.addMethods(hook.ctx));
-        this.runner.on(Events.EVENT_TEST_BEGIN, () => this.onStartTest());
-        this.runner.on(Events.EVENT_TEST_END, (test) => this.onEndTest(test));
+        if (options.parallel) {
+            options.require = [...((_a = options.require) !== null && _a !== void 0 ? _a : []), (0, utils_1.resolveParallelModeSetupFile)()];
+        }
+        else {
+            this.applyListeners();
+        }
+    }
+    teardown() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield Promise.all(this.attachmentsQueue).catch((err) => {
+                console.log("Error loading attachments. \n", err.body);
+            });
+            yield Promise.all(this.autotestsQueue);
+            yield this.strategy.loadTestRun(this.autotestsForTestRun).catch((err) => {
+                console.log("Error load test run. \n", err.body);
+            });
+            yield this.strategy.teardown();
+        });
     }
     clearContext(ctx) {
         ctx.externalId = undefined;
@@ -200,4 +219,6 @@ module.exports = class extends Reporter {
             ? Date.now() - this.currentTest.startedOn.getTime()
             : 0;
     }
-};
+}
+exports.TmsReporter = TmsReporter;
+;

package/lib/setupTmsMochaParallel.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/setupTmsMochaParallel.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-ignore
+const parallel_buffered_js_1 = __importDefault(require("mocha/lib/nodejs/reporters/parallel-buffered.js"));
+const reporter_js_1 = require("./reporter.js");
+const originalCreateListeners = parallel_buffered_js_1.default.prototype.createListeners;
+parallel_buffered_js_1.default.prototype.createListeners = function (runner) {
+    new reporter_js_1.TmsReporter(runner, this.options);
+    return originalCreateListeners.call(this, runner);
+};

package/lib/utils.d.ts

@@ -8,3 +8,4 @@ export declare function extractHooks(suite?: Suite): {
     afterEach: Step[];
     beforeEach: Step[];
 };
+export declare const resolveParallelModeSetupFile: () => string;

package/lib/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractHooks = exports.hookToStep = void 0;
+exports.resolveParallelModeSetupFile = exports.extractHooks = exports.hookToStep = void 0;
+const path_1 = require("path");
 function hookToStep(hook) {
     var _a;
     return {
@@ -23,3 +24,5 @@ function extractHooks(suite) {
     };
 }
 exports.extractHooks = extractHooks;
+const resolveParallelModeSetupFile = () => (0, path_1.join)(__dirname, `setupTmsMochaParallel${(0, path_1.extname)(__filename)}`);
+exports.resolveParallelModeSetupFile = resolveParallelModeSetupFile;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "testit-adapter-mocha",
-  "version": "2.1.8",
+  "version": "2.2.1",
   "description": "Mocha adapter for Test IT",
-  "main": "lib/reporter.js",
+  "main": "lib/index.js",
   "types": "lib/types.d.ts",
   "scripts": {
     "prebuild": "npm --prefix ../testit-js-commons run build && npm link ../testit-js-commons",
@@ -15,6 +15,7 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
+    "@types/deasync-promise": "^1.0.2",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.2.4",
     "@types/request": "^2.48.8",
@@ -25,7 +26,8 @@
   },
   "dependencies": {
     "mocha": "^10.2.0",
-    "testit-js-commons": "~2.1.8"
+    "deasync-promise": "^1.0.1",
+    "testit-js-commons": "~2.2.1"
   },
   "files": [
     "lib"