@uuv/runner-commons 2.10.1 → 2.12.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [2.12.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.11.0...runner-commons-v2.12.0) (2024-05-02)
+
+
+### Features
+
+* update package-lock for update dependency typescript to v5 ([f058481](https://github.com/Orange-OpenSource/uuv/commit/f058481e2ae75ba91e708a5c4dd8ce16c0f1a04f))
+
+# [2.11.0](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.10.1...runner-commons-v2.11.0) (2024-04-22)
+
+
+### Features
+
+* (refactor) introduce uuv-cli engine from runner-commons, [#576](https://github.com/Orange-OpenSource/uuv/issues/576) ([6de2feb](https://github.com/Orange-OpenSource/uuv/commit/6de2feb2b2d74eddf1244694dfb7d697af28baf8))
+* add unit tests for uuv-cli implementations, [#576](https://github.com/Orange-OpenSource/uuv/issues/576) ([7e67f13](https://github.com/Orange-OpenSource/uuv/commit/7e67f13b9929577162bce84c5e8b5c08a4396a09))
+
 ## [2.10.1](https://github.com/Orange-OpenSource/uuv/compare/runner-commons-v2.10.0...runner-commons-v2.10.1) (2024-04-14)
 
 

package/dist/cli/engine.d.ts

@@ -0,0 +1,7 @@
+import { UUVCliRunner } from "./runner";
+export declare class UUVCliEngine {
+    private runner;
+    constructor(runner: UUVCliRunner);
+    execute(): Promise<void>;
+    private checkArguments;
+}

package/dist/cli/engine.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUVCliEngine = void 0;
+const helper_1 = require("./helper");
+const chalk_1 = __importDefault(require("chalk"));
+class UUVCliEngine {
+    runner;
+    constructor(runner) {
+        this.runner = runner;
+    }
+    async execute() {
+        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);
+            await this.runner.prepare(options);
+            console.info(chalk_1.default.blueBright(`Executing UUV command ${options.command}...`));
+            switch (options.command) {
+                case "open":
+                    await this.runner.executeOpenCommand(options);
+                    break;
+                case "e2e":
+                    await this.runner.executeE2eCommand(options);
+                    break;
+                default:
+                    throw new Error("Unknown command");
+            }
+            console.info(`UUV command ${options.command} executed`);
+        }
+        catch (e) {
+            console.error(chalk_1.default.red(e));
+            process.exit(1);
+        }
+    }
+    checkArguments() {
+        helper_1.UUVCliHelper.checkTargetCommand();
+        helper_1.UUVCliHelper.checkTargetTestFiles();
+    }
+}
+exports.UUVCliEngine = UUVCliEngine;

package/dist/cli/helper.d.ts

@@ -0,0 +1,12 @@
+import { UUVCliOptions } from "./options";
+export declare class UUVCliHelper {
+    /**
+     * Print runner banner
+     */
+    static printBanner(runnerName: string, currentVersion: string): void;
+    static checkTargetCommand(): void;
+    static checkTargetTestFiles(): void;
+    private static getTargetCommand;
+    static extractArgs(projectDir: string, defaultBrowser: any): Partial<UUVCliOptions>;
+    static printVariables(options: Partial<UUVCliOptions>): void;
+}

package/dist/cli/helper.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUVCliHelper = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const figlet_1 = __importDefault(require("figlet"));
+const minimist_1 = __importDefault(require("minimist"));
+const path_1 = __importDefault(require("path"));
+const lodash_1 = require("lodash");
+class UUVCliHelper {
+    /**
+     * Print runner banner
+     */
+    static printBanner(runnerName, currentVersion) {
+        console.log(chalk_1.default.blueBright(figlet_1.default.textSync(`UUV - ${runnerName}`, {
+            font: "Big",
+            horizontalLayout: "default",
+            verticalLayout: "default",
+            width: 80,
+            whitespaceBreak: true
+        })));
+        console.info(chalk_1.default.blueBright(`Version: ${currentVersion}\n\n`));
+    }
+    static checkTargetCommand() {
+        const argv = (0, minimist_1.default)(process.argv.slice(2));
+        if (argv._.length < 1) {
+            throw new Error("No command specified");
+        }
+    }
+    static checkTargetTestFiles() {
+        const argv = (0, minimist_1.default)(process.argv.slice(2));
+        const targetTestFile = argv.targetTestFile;
+        if (!(0, lodash_1.isEmpty)(targetTestFile)) {
+            try {
+                new RegExp(targetTestFile, "gi");
+            }
+            catch (e) {
+                throw new Error("Invalid targetTestFile argument, this args should respect Glob pattern");
+            }
+        }
+    }
+    static getTargetCommand(argv) {
+        return argv._[0];
+    }
+    static extractArgs(projectDir, defaultBrowser) {
+        const argv = (0, minimist_1.default)(process.argv.slice(2));
+        const browser = argv.browser ? argv.browser : defaultBrowser;
+        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");
+        return {
+            // eslint-disable-next-line dot-notation
+            baseUrl: process.env["UUV_BASE_URL"],
+            browser,
+            extraArgs: env,
+            targetTestFile,
+            command: this.getTargetCommand(argv),
+            report: {
+                outputDir: reportDir,
+                a11y: {
+                    enabled: argv.generateA11yReport,
+                    outputFile: path_1.default.join(process.cwd(), reportDir, "a11y-report.json")
+                },
+                html: {
+                    enabled: argv.generateHtmlReport,
+                    outputDir: path_1.default.join(reportDir, "e2e/html")
+                },
+                junit: {
+                    enabled: argv.generateJunitReport,
+                    outputFile: path_1.default.join(reportDir, "e2e/junit-report.xml")
+                }
+            }
+        };
+    }
+    static printVariables(options) {
+        console.debug(chalk_1.default.yellowBright("Variables: "));
+        if (options.baseUrl) {
+            console.debug(`  -> baseUrl: ${options.baseUrl}`);
+        }
+        console.debug(`  -> browser: ${options.browser}`);
+        console.debug(`  -> report: ${JSON.stringify(options.report)}`);
+        console.debug(`  -> env: ${JSON.stringify(options.extraArgs)}`);
+        if (options.targetTestFile) {
+            console.debug(`  -> targetTestFile: ${options.targetTestFile}`);
+        }
+        console.debug("\n");
+    }
+}
+exports.UUVCliHelper = UUVCliHelper;

package/dist/cli/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./engine";
+export * from "./helper";
+export * from "./options";
+export * from "./runner";

package/dist/cli/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("./engine"), exports);
+__exportStar(require("./helper"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./runner"), exports);

package/dist/cli/options.d.ts

@@ -0,0 +1,22 @@
+export type UUVCliOptions = {
+    baseUrl: string;
+    command: "open" | "e2e";
+    browser: string;
+    targetTestFile: string;
+    report: {
+        outputDir: string;
+        a11y: {
+            enabled: boolean;
+            outputFile: string;
+        };
+        html: {
+            enabled: boolean;
+            outputDir: string;
+        };
+        junit: {
+            enabled: boolean;
+            outputFile: string;
+        };
+    };
+    extraArgs: any;
+};

package/dist/cli/options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cli/runner.d.ts

@@ -0,0 +1,34 @@
+import { UUVCliOptions } from "./options";
+export interface UUVCliRunner {
+    /**
+     * Runner name e.g: Cypress, Playwright
+     */
+    name: string;
+    /**
+     * Project directory
+     */
+    projectDir: string;
+    /**
+     * Default browser
+     */
+    defaultBrowser: string;
+    /**
+     * Return runner current version
+     */
+    getCurrentVersion(): string;
+    /**
+     * Prepare runner to execute command
+     * @param options
+     */
+    prepare(options: Partial<UUVCliOptions>): any;
+    /**
+     * Execute "e2e" command
+     * @param options
+     */
+    executeE2eCommand(options: Partial<UUVCliOptions>): any;
+    /**
+     * Execute "open" command
+     * @param options
+     */
+    executeOpenCommand(options: Partial<UUVCliOptions>): any;
+}

package/dist/cli/runner.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -7,3 +7,4 @@ import key from "./assets/i18n/web/template.json";
 export { key };
 export { AccessibleRole } from "./step-definition-generator/accessible-role";
 export * from "./assets/i18n/web/en";
+export * from "./cli";

package/dist/index.js

@@ -28,3 +28,4 @@ exports.key = template_json_1.default;
 var accessible_role_1 = require("./step-definition-generator/accessible-role");
 Object.defineProperty(exports, "AccessibleRole", { enumerable: true, get: function () { return accessible_role_1.AccessibleRole; } });
 __exportStar(require("./assets/i18n/web/en"), exports);
+__exportStar(require("./cli"), exports);

package/dist/step-definition-generator/common.d.ts

@@ -11,6 +11,7 @@
  * Software description: Make test writing fast, understandable by any human
  * understanding English or French.
  */
+/// <reference types="node" />
 import fs from "fs";
 import { AccessibleRole } from "./accessible-role";
 export { fs };
@@ -46,4 +47,5 @@ export declare class Common {
     static cleanGeneratedFilesIfExists(generatedFile: string): void;
     static cleanFolderIfExists(folder: string): void;
     static writeWordingFile(generatedFile: string, data: string): void;
+    static deleteAllFileOfDirectory(dirPath: any): void;
 }

package/dist/step-definition-generator/common.js

@@ -74,12 +74,12 @@ var TEST_RUNNER_ENUM;
 (function (TEST_RUNNER_ENUM) {
     TEST_RUNNER_ENUM["CYPRESS"] = "cypress";
     TEST_RUNNER_ENUM["PLAYWRIGHT"] = "playwright";
-})(TEST_RUNNER_ENUM = exports.TEST_RUNNER_ENUM || (exports.TEST_RUNNER_ENUM = {}));
+})(TEST_RUNNER_ENUM || (exports.TEST_RUNNER_ENUM = TEST_RUNNER_ENUM = {}));
 var STEP_DEFINITION_FILE_NAME;
 (function (STEP_DEFINITION_FILE_NAME) {
     STEP_DEFINITION_FILE_NAME["BASE"] = "base-check-engine";
     STEP_DEFINITION_FILE_NAME["BY_ROLE"] = "based-role-check-engine";
-})(STEP_DEFINITION_FILE_NAME = exports.STEP_DEFINITION_FILE_NAME || (exports.STEP_DEFINITION_FILE_NAME = {}));
+})(STEP_DEFINITION_FILE_NAME || (exports.STEP_DEFINITION_FILE_NAME = STEP_DEFINITION_FILE_NAME = {}));
 var KEY_PRESS;
 (function (KEY_PRESS) {
     KEY_PRESS["TAB"] = "{tab}";
@@ -88,7 +88,7 @@ var KEY_PRESS;
     KEY_PRESS["DOWN"] = "{down}";
     KEY_PRESS["LEFT"] = "{left}";
     KEY_PRESS["RIGHT"] = "{right}";
-})(KEY_PRESS = exports.KEY_PRESS || (exports.KEY_PRESS = {}));
+})(KEY_PRESS || (exports.KEY_PRESS = KEY_PRESS = {}));
 class Common {
     static buildDirIfNotExists(directory) {
         console.log(`[CREATE] ${directory} CREATE successfully`);
@@ -114,5 +114,13 @@ class Common {
         fs_1.default.writeFileSync(generatedFile, data);
         console.log(`[WRITE] ${generatedFile} written successfully`);
     }
+    static deleteAllFileOfDirectory(dirPath) {
+        for (const file of fs_1.default.readdirSync(dirPath)) {
+            const filePath = path.join(dirPath, file);
+            if (fs_1.default.lstatSync(filePath).isFile()) {
+                fs_1.default.rmSync(filePath);
+            }
+        }
+    }
 }
 exports.Common = Common;

package/dist/step-definition-generator/lang-enum.js

@@ -5,4 +5,4 @@ var LANG;
 (function (LANG) {
     LANG["FR"] = "fr";
     LANG["EN"] = "en";
-})(LANG = exports.LANG || (exports.LANG = {}));
+})(LANG || (exports.LANG = LANG = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/runner-commons",
-  "version": "2.10.1",
+  "version": "2.12.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A common lib for uuv",
@@ -32,7 +32,8 @@
   "scripts": {
     "package": "npm pack --pack-destination=\"../../dist/packages\"",
     "lint": "npx eslint . --ext .js,.ts,.feature --fix",
-    "test": "jest"
+    "test": "npm run unit-test --",
+    "unit-test": "jest --coverage"
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "5.62.0",
@@ -47,6 +48,7 @@
     "dist/assets/**/*",
     "src/assets/i18n/*/*/*.json",
     "dist/runner/**/*",
+    "dist/cli/**/*",
     "*.md"
   ],
   "exports": {
@@ -65,5 +67,11 @@
       "require": "./dist/assets/i18n/web/en/index.js",
       "types": "./dist/assets/i18n/web/en/index.d.ts"
     }
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "figlet": "1.7.0",
+    "lodash": "^4.17.21",
+    "minimist": "1.2.8"
   }
 }