@uuv/runner-commons 2.16.3 → 2.17.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [2.17.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.16.4...runner-commons-v2.17.0) (2024-07-02)
+
+
+### Features
+
+* introduce ipc-server to send uuv event, [#664](https://github.com/Orange-OpenSource/uuv/issues/664) ([270ac38](https://github.com/Orange-OpenSource/uuv/commit/270ac388a7abf17b0c296d029d6e12bd66a4f521))
+
+## [2.16.4](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.16.3...runner-commons-v2.16.4) (2024-06-27)
+
+
+### Bug Fixes
+
+* **runner-cypress:** update testing-library monorepo ([bcedb57](https://github.com/Orange-OpenSource/uuv/commit/bcedb5749fd5f062cfb283bedabfe8ad87668c67))
+
 ## [2.16.3](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.16.2...runner-commons-v2.16.3) (2024-06-16)
 
 

package/dist/cli/engine.js

@@ -12,11 +12,13 @@ class UUVCliEngine {
         this.runner = runner;
     }
     async execute() {
+        let ipcServerProcess;
         try {
             helper_1.UUVCliHelper.printBanner(this.runner.name, this.runner.getCurrentVersion());
             this.checkArguments();
             const options = helper_1.UUVCliHelper.extractArgs(this.runner.projectDir, this.runner.defaultBrowser);
             helper_1.UUVCliHelper.printVariables(options);
+            ipcServerProcess = helper_1.UUVCliHelper.startIpcServer();
             await this.runner.prepare(options);
             console.info(chalk_1.default.blueBright(`Executing UUV command ${options.command}...`));
             switch (options.command) {
@@ -35,6 +37,11 @@ class UUVCliEngine {
             console.error(chalk_1.default.red(e));
             process.exit(1);
         }
+        finally {
+            if (ipcServerProcess) {
+                helper_1.UUVCliHelper.stopIpcServer(ipcServerProcess);
+            }
+        }
     }
     checkArguments() {
         helper_1.UUVCliHelper.checkTargetCommand();

package/dist/cli/helper.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { UUVCliOptions } from "./options";
+import cp from "child_process";
 export declare class UUVCliHelper {
     /**
      * Print runner banner
@@ -9,4 +11,6 @@ export declare class UUVCliHelper {
     private static getTargetCommand;
     static extractArgs(projectDir: string, defaultBrowser: any): Partial<UUVCliOptions>;
     static printVariables(options: Partial<UUVCliOptions>): void;
+    static startIpcServer(): cp.ChildProcess;
+    static stopIpcServer(ipcServerProcess: cp.ChildProcess): boolean;
 }

package/dist/cli/helper.js

@@ -9,6 +9,7 @@ const figlet_1 = __importDefault(require("figlet"));
 const minimist_1 = __importDefault(require("minimist"));
 const path_1 = __importDefault(require("path"));
 const lodash_1 = require("lodash");
+const child_process_1 = __importDefault(require("child_process"));
 class UUVCliHelper {
     /**
      * Print runner banner
@@ -50,6 +51,10 @@ class UUVCliHelper {
         const env = argv.env ? JSON.parse(argv.env.replace(/'/g, "\"")) : {};
         const targetTestFile = argv.targetTestFile ? argv.targetTestFile : null;
         const reportDir = path_1.default.join(projectDir, "reports");
+        // eslint-disable-next-line dot-notation
+        process.env["ENABLE_TEAMCITY_LOGGING"] = env.enableTeamcityLogging;
+        // eslint-disable-next-line dot-notation
+        process.env["ENABLE_VSCODE_LISTENER"] = env.enableVsCodeListener;
         return {
             // eslint-disable-next-line dot-notation
             baseUrl: process.env["UUV_BASE_URL"],
@@ -87,5 +92,11 @@ class UUVCliHelper {
         }
         console.debug("\n");
     }
+    static startIpcServer() {
+        return child_process_1.default.fork(path_1.default.join(__dirname, "start-ipc-server"));
+    }
+    static stopIpcServer(ipcServerProcess) {
+        return ipcServerProcess.kill();
+    }
 }
 exports.UUVCliHelper = UUVCliHelper;

package/dist/cli/start-ipc-server.d.ts

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

package/dist/cli/start-ipc-server.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const event_1 = require("../runner/event");
+async function createIPCServer() {
+    return new Promise((resolve) => {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const ipcServer = require("node-ipc").default;
+        ipcServer.config.id = event_1.UUV_IPC_SERVER_NAME;
+        ipcServer.config.retry = 1500;
+        ipcServer.config.silent = true;
+        ipcServer.serve(() => {
+            ipcServer.server.on("message", (message) => {
+                ipcServer.server.broadcast("message", message);
+            });
+            console.log("UUV Server Started");
+            resolve(ipcServer);
+        });
+        ipcServer.server.start();
+    });
+}
+createIPCServer();

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from "./step-definition-generator/generate-step-definitions";
 export * from "./step-definition-generator/generate-step-definitions-documentation";
 export * from "./runner/step-definitions/_constant";
 export * from "./runner/step-definitions/_i-context";
+export * from "./runner/event";
 import key from "./assets/i18n/web/template.json";
 export { key };
 export { AccessibleRole } from "./step-definition-generator/accessible-role";

package/dist/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./step-definition-generator/generate-step-definitions"), e
 __exportStar(require("./step-definition-generator/generate-step-definitions-documentation"), exports);
 __exportStar(require("./runner/step-definitions/_constant"), exports);
 __exportStar(require("./runner/step-definitions/_i-context"), exports);
+__exportStar(require("./runner/event"), exports);
 const template_json_1 = __importDefault(require("./assets/i18n/web/template.json"));
 exports.key = template_json_1.default;
 var accessible_role_1 = require("./step-definition-generator/accessible-role");

package/dist/runner/event/event-emitter.d.ts

@@ -0,0 +1,16 @@
+import { UUVEventTestFailed, UUVEventTestFinished, UUVEventTestIgnored, UUVEventTestStarted, UUVEventTestSuiteFinished, UUVEventTestSuiteStarted } from "./model";
+export declare class UUVEventEmitter {
+    private static instance;
+    ipc: any;
+    constructor();
+    static createInstance(): Promise<unknown>;
+    static getInstance(): UUVEventEmitter;
+    emitProgressStart(): void;
+    emitTestSuiteStarted(event: UUVEventTestSuiteStarted): void;
+    emitTestStarted(event: UUVEventTestStarted): void;
+    emitTestFailed(event: UUVEventTestFailed): void;
+    emitTestIgnored(event: UUVEventTestIgnored): void;
+    emitTestFinished(event: UUVEventTestFinished): void;
+    emitTestSuiteFinished(event: UUVEventTestSuiteFinished): void;
+    emitProgressFinish(): void;
+}

package/dist/runner/event/event-emitter.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUVEventEmitter = void 0;
+/* eslint-disable quotes */
+const model_1 = require("./model");
+class UUVEventEmitter {
+    static instance;
+    ipc;
+    constructor() {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        this.ipc = require('node-ipc').default;
+        this.ipc.config.id = model_1.UUV_IPC_PUBLISHER;
+        this.ipc.config.retry = 1500;
+        this.ipc.config.silent = true;
+    }
+    static async createInstance() {
+        return new Promise((resolve) => {
+            UUVEventEmitter.instance = new UUVEventEmitter();
+            UUVEventEmitter.instance.ipc.connectTo(model_1.UUV_IPC_SERVER_NAME, () => {
+                UUVEventEmitter.instance.ipc.of[model_1.UUV_IPC_SERVER_NAME].on('connect', () => {
+                    console.debug("Publisher connected to UUV Server");
+                    resolve("ok");
+                });
+            });
+        });
+    }
+    static getInstance() {
+        return UUVEventEmitter.instance;
+    }
+    emitProgressStart() {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.PROGRESS_START
+        });
+    }
+    emitTestSuiteStarted(event) {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.TEST_SUITE_STARTED,
+            data: event
+        });
+    }
+    emitTestStarted(event) {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.TEST_STARTED,
+            data: event
+        });
+    }
+    emitTestFailed(event) {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.TEST_FAILED,
+            data: event
+        });
+    }
+    emitTestIgnored(event) {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.TEST_IGNORED,
+            data: event
+        });
+    }
+    emitTestFinished(event) {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.TEST_FINISHED,
+            data: event
+        });
+    }
+    emitTestSuiteFinished(event) {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.TEST_SUITE_FINISHED,
+            data: event
+        });
+    }
+    emitProgressFinish() {
+        this.ipc.of[model_1.UUV_IPC_SERVER_NAME].emit('message', {
+            type: model_1.UUVEventType.PROGRESS_FINISH
+        });
+    }
+}
+exports.UUVEventEmitter = UUVEventEmitter;

package/dist/runner/event/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./model";
+export * from "./event-emitter";
+export * from "./listener/event-listener-helper";
+export * from "./listener/teamcity-listener";

package/dist/runner/event/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./model"), exports);
+__exportStar(require("./event-emitter"), exports);
+__exportStar(require("./listener/event-listener-helper"), exports);
+__exportStar(require("./listener/teamcity-listener"), exports);

package/dist/runner/event/listener/event-listener-helper.d.ts

@@ -0,0 +1,3 @@
+export declare class UUVListenerHelper {
+    static build(): Promise<void>;
+}

package/dist/runner/event/listener/event-listener-helper.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUVListenerHelper = void 0;
+const event_emitter_1 = require("../event-emitter");
+const teamcity_listener_1 = require("./teamcity-listener");
+class UUVListenerHelper {
+    static async build() {
+        await event_emitter_1.UUVEventEmitter.createInstance();
+        // eslint-disable-next-line dot-notation
+        if (process.env["ENABLE_TEAMCITY_LOGGING"] === "true") {
+            await new teamcity_listener_1.TeamCityUUVEventListener();
+        }
+    }
+}
+exports.UUVListenerHelper = UUVListenerHelper;

package/dist/runner/event/listener/teamcity-listener.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Listener that write teamcity log
+ */
+export declare class TeamCityUUVEventListener {
+    constructor();
+    logTeamCity(line: any): void;
+    teamcityFlowId(name: any): string;
+    teamcityFlowIdAndParentFlowId(name: any, parentName: any): string;
+    teamcityAddName(name: any): string;
+    teamcityAddDuration(duration: any): string;
+    teamcityAddCustomField(fieldName: any, value: any): string;
+}

package/dist/runner/event/listener/teamcity-listener.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TeamCityUUVEventListener = void 0;
+const model_1 = require("../model");
+/**
+ * Listener that write teamcity log
+ */
+class TeamCityUUVEventListener {
+    constructor() {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const ipc = require("node-ipc").default;
+        ipc.config.id = "uuvIpcTeamcity";
+        ipc.config.retry = 1500;
+        ipc.config.silent = true;
+        ipc.connectTo(model_1.UUV_IPC_SERVER_NAME, () => {
+            ipc.of[model_1.UUV_IPC_SERVER_NAME].on("connect", () => {
+                console.log("Teamcity connected to UUV Server");
+            });
+            ipc.of[model_1.UUV_IPC_SERVER_NAME].on("message", (message) => {
+                let data;
+                switch (message.type) {
+                    case model_1.UUVEventType.PROGRESS_START:
+                        this.logTeamCity("##teamcity[progressStart 'Running UUV Tests']");
+                        break;
+                    case model_1.UUVEventType.TEST_SUITE_STARTED:
+                        data = message.data;
+                        this.logTeamCity(`##teamcity[testSuiteStarted ${this.teamcityAddName(data.testSuiteName)} ${this.teamcityFlowId(data.testSuiteName)}  ${this.teamcityAddCustomField("locationHint", "suite://" + data.testSuitelocation)} ]`);
+                        break;
+                    case model_1.UUVEventType.TEST_STARTED:
+                        data = message.data;
+                        this.logTeamCity(`##teamcity[testStarted ${this.teamcityAddName(data.testName)} ${this.teamcityFlowIdAndParentFlowId(data.testName, data.testSuiteName)} ${this.teamcityAddCustomField("locationHint", "test://" + data.testSuitelocation)} ]`);
+                        break;
+                    case model_1.UUVEventType.TEST_FINISHED:
+                        data = message.data;
+                        // eslint-disable-next-line max-len
+                        this.logTeamCity(`##teamcity[testFinished ${this.teamcityAddName(data.testName)} ${this.teamcityFlowIdAndParentFlowId(data.testName, data.testSuiteName)} ${this.teamcityAddDuration(data.duration)} ]`);
+                        break;
+                    case model_1.UUVEventType.TEST_FAILED:
+                        data = message.data;
+                        // eslint-disable-next-line max-len
+                        this.logTeamCity(`##teamcity[testFailed ${this.teamcityAddName(data.testName)} ${this.teamcityFlowIdAndParentFlowId(data.testName, data.testSuiteName)} type='comparisonFailure' message='Test failed' ]`);
+                        // eslint-disable-next-line max-len
+                        this.logTeamCity(`##teamcity[testFinished ${this.teamcityAddName(data.testName)} ${this.teamcityFlowIdAndParentFlowId(data.testName, data.testSuiteName)} ${this.teamcityAddDuration(data.duration)} ]`);
+                        break;
+                    case model_1.UUVEventType.TEST_IGNORED:
+                        data = message.data;
+                        // eslint-disable-next-line max-len
+                        this.logTeamCity(`##teamcity[testIgnored ${this.teamcityAddName(data.testName)} ${this.teamcityFlowIdAndParentFlowId(data.testName, data.testSuiteName)} ]`);
+                        break;
+                    case model_1.UUVEventType.TEST_SUITE_FINISHED:
+                        data = message.data;
+                        // eslint-disable-next-line max-len
+                        this.logTeamCity(`##teamcity[testSuiteFinished ${this.teamcityAddName(data.testSuiteName)} ${this.teamcityFlowId(data.testSuiteName)}]`);
+                        break;
+                    case model_1.UUVEventType.PROGRESS_FINISH:
+                        this.logTeamCity("##teamcity[progressFinish 'Running UUV Tests']");
+                        break;
+                }
+            });
+        });
+    }
+    logTeamCity(line) {
+        console.log("newReal" + line);
+    }
+    teamcityFlowId(name) {
+        return "flowId='" + name.replaceAll("'", "|'") + "'";
+    }
+    teamcityFlowIdAndParentFlowId(name, parentName) {
+        return "flowId='" + name.replaceAll("'", "|'") + "' parent='" + parentName.replaceAll("'", "|'") + "'";
+    }
+    teamcityAddName(name) {
+        return "name='" + name.replaceAll("'", "|'") + "'";
+    }
+    teamcityAddDuration(duration) {
+        return `duration='${duration}'`;
+    }
+    teamcityAddCustomField(fieldName, value) {
+        return `${fieldName}='${value}'`;
+    }
+}
+exports.TeamCityUUVEventListener = TeamCityUUVEventListener;

package/dist/runner/event/model.d.ts

@@ -0,0 +1,47 @@
+export declare const UUV_IPC_SERVER_NAME = "uuvIpcServer";
+export declare const UUV_IPC_PUBLISHER = "uuvIpcPublisher";
+export interface UUVEvent {
+    type: UUVEventType;
+    data: UUVEventProgressStart | UUVEventTestSuiteStarted | UUVEventTestStarted | UUVEventTestFinished | UUVEventTestFailed | UUVEventTestIgnored | UUVEventTestSuiteFinished | UUVEventProgressFinish;
+}
+export declare enum UUVEventType {
+    PROGRESS_START = "progressStart",
+    TEST_SUITE_STARTED = "testSuiteStarted",
+    TEST_STARTED = "testStarted",
+    TEST_FINISHED = "testFinished",
+    TEST_FAILED = "testFailed",
+    TEST_IGNORED = "testIgnored",
+    TEST_SUITE_FINISHED = "testSuiteFinished",
+    PROGRESS_FINISH = "progressFinish"
+}
+export interface UUVEventProgressStart {
+}
+export interface UUVEventTestSuiteStarted {
+    testSuiteName: string;
+    testSuitelocation: string;
+}
+export interface UUVEventTestStarted {
+    testName: string;
+    testSuiteName: string;
+    testSuitelocation: string;
+}
+export interface UUVEventTestFinished {
+    testName: string;
+    testSuiteName: string;
+    duration: number;
+}
+export interface UUVEventTestFailed {
+    testName: string;
+    testSuiteName: string;
+    duration: number;
+}
+export interface UUVEventTestIgnored {
+    testName: string;
+    testSuiteName: string;
+    duration?: number;
+}
+export interface UUVEventTestSuiteFinished {
+    testSuiteName: string;
+}
+export interface UUVEventProgressFinish {
+}

package/dist/runner/event/model.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUVEventType = exports.UUV_IPC_PUBLISHER = exports.UUV_IPC_SERVER_NAME = void 0;
+exports.UUV_IPC_SERVER_NAME = "uuvIpcServer";
+exports.UUV_IPC_PUBLISHER = "uuvIpcPublisher";
+var UUVEventType;
+(function (UUVEventType) {
+    UUVEventType["PROGRESS_START"] = "progressStart";
+    UUVEventType["TEST_SUITE_STARTED"] = "testSuiteStarted";
+    UUVEventType["TEST_STARTED"] = "testStarted";
+    UUVEventType["TEST_FINISHED"] = "testFinished";
+    UUVEventType["TEST_FAILED"] = "testFailed";
+    UUVEventType["TEST_IGNORED"] = "testIgnored";
+    UUVEventType["TEST_SUITE_FINISHED"] = "testSuiteFinished";
+    UUVEventType["PROGRESS_FINISH"] = "progressFinish";
+})(UUVEventType || (exports.UUVEventType = UUVEventType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/runner-commons",
-  "version": "2.16.3",
+  "version": "2.17.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A common lib for uuv",
@@ -72,6 +72,7 @@
     "chalk": "^4.1.2",
     "figlet": "1.7.0",
     "lodash": "^4.17.21",
-    "minimist": "1.2.8"
+    "minimist": "1.2.8",
+    "node-ipc": "^11.1.0"
   }
 }