@uuv/playwright 2.11.1 → 2.12.0

package/dist/lib/runner-playwright.d.ts

@@ -11,10 +11,26 @@
  * Software description: Make test writing fast, understandable by any human
  * understanding English or French.
  */
+import { UUVCliOptions, UUVCliRunner } from "@uuv/runner-commons";
 export interface UUVPlaywrightCucumberMapItem {
     originalFile: string;
     generatedFile: string;
 }
 export declare const UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
-export declare function executePreprocessor(tempDir: string, configDir: string, env: any): Promise<void>;
-export declare function run(mode: "open" | "e2e", tempDir: string | undefined, configDir: string | undefined, argv: any): Promise<void>;
+export declare class UUVCliPlaywrightRunner implements UUVCliRunner {
+    projectDir: any;
+    private tempDir;
+    name: string;
+    defaultBrowser: string;
+    constructor(projectDir: any, tempDir: any);
+    getCurrentVersion(): string;
+    prepare(options: Partial<UUVCliOptions>): Promise<void>;
+    private setEnvironmentVariables;
+    executeE2eCommand(options: Partial<UUVCliOptions>): void;
+    executeOpenCommand(options: Partial<UUVCliOptions>): void;
+    private getTargetTestFileForPlaywright;
+    private runPlaywright;
+    private executeSystemCommand;
+    private buildCommand;
+}
+export declare function executePreprocessor(tempDir: string, tags: string): Promise<void>;

package/dist/lib/runner-playwright.js

@@ -1,3 +1,4 @@
+"use strict";
 /**
  * Software Name : UUV
  *
@@ -11,7 +12,6 @@
  * Software description: Make test writing fast, understandable by any human
  * understanding English or French.
  */
-"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);
@@ -39,106 +39,127 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = exports.executePreprocessor = exports.UUVPlaywrightCucumberMapFile = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const gen_1 = require("../cucumber/preprocessor/gen");
+exports.executePreprocessor = exports.UUVCliPlaywrightRunner = exports.UUVPlaywrightCucumberMapFile = void 0;
 const fs_1 = __importDefault(require("fs"));
-const child_process_1 = __importStar(require("child_process"));
+const gen_1 = require("../cucumber/preprocessor/gen");
+const chalk_1 = __importDefault(require("chalk"));
 const uuv_playwright_reporter_helper_1 = require("../reporter/uuv-playwright-reporter-helper");
 const path_1 = __importDefault(require("path"));
+const child_process_1 = __importStar(require("child_process"));
+const lodash_1 = __importDefault(require("lodash"));
 exports.UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
-async function bddGen(tempDir, env) {
-    try {
-        const mapOfFile = await (0, gen_1.generateTestFiles)({
-            outputDir: tempDir,
-            tags: env.TAGS
-        });
-        const content = [];
-        mapOfFile.forEach((value, key) => {
-            if (value.uri) {
-                content.push({
-                    originalFile: value.uri,
-                    generatedFile: key
-                });
-            }
+class UUVCliPlaywrightRunner {
+    projectDir;
+    tempDir;
+    name = "Playwright";
+    defaultBrowser = "chromium";
+    constructor(projectDir, tempDir) {
+        this.projectDir = projectDir;
+        this.tempDir = tempDir;
+    }
+    getCurrentVersion() {
+        const pJsonStr = fs_1.default.readFileSync(`${__dirname}/../../package.json`, {
+            encoding: "utf8", flag: "r"
         });
-        fs_1.default.writeFileSync(`${tempDir}/${exports.UUVPlaywrightCucumberMapFile}`, JSON.stringify(content, null, 4), { encoding: "utf8" });
+        return JSON.parse(pJsonStr).version;
     }
-    catch (err) {
-        console.error(chalk_1.default.red("Something went wrong..."));
-        console.dir(err);
-        process.exit(-1);
+    async prepare(options) {
+        await executePreprocessor(this.tempDir, options.extraArgs.TAGS);
+        this.setEnvironmentVariables(options);
     }
-}
-function runPlaywright(mode, configDir, browser = "chromium", generateHtmlReport = false, generateJunitReport = false, env, targetTestFile) {
-    const configFile = `${configDir}/playwright.config.ts`;
-    const reportType = generateHtmlReport ? uuv_playwright_reporter_helper_1.GeneratedReportType.HTML : uuv_playwright_reporter_helper_1.GeneratedReportType.CONSOLE;
-    try {
+    setEnvironmentVariables(options) {
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        process.env.REPORT_TYPE = reportType;
+        process.env.REPORT_TYPE = options.report?.html.enabled ? uuv_playwright_reporter_helper_1.GeneratedReportType.HTML : uuv_playwright_reporter_helper_1.GeneratedReportType.CONSOLE;
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        process.env.CONFIG_DIR = configDir;
+        process.env.CONFIG_DIR = this.projectDir;
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        process.env.browser = browser;
-        if (env) {
-            Object.keys(env).forEach(key => process.env[key] = env[key]);
+        process.env.browser = options.browser;
+        if (options.extraArgs) {
+            Object.keys(options.extraArgs).forEach(key => process.env[key] = options.extraArgs[key]);
         }
-        let reporter = " --reporter=@uuv/playwright/uuv-playwright-reporter";
-        if (generateJunitReport) {
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore
-            process.env.PLAYWRIGHT_JUNIT_OUTPUT_NAME = `${configDir}/reports/e2e/junit-report.xml`;
-            reporter = `${reporter},junit`;
+    }
+    executeE2eCommand(options) {
+        this.runPlaywright(options);
+    }
+    executeOpenCommand(options) {
+        child_process_1.default.fork(path_1.default.join(__dirname, "watch-test-files"), [this.tempDir, this.projectDir, options.extraArgs.TAGS]);
+        this.runPlaywright(options);
+    }
+    getTargetTestFileForPlaywright(targetTestFile) {
+        if (!targetTestFile) {
+            return "";
         }
-        // eslint-disable-next-line max-len
-        const command = `npx playwright test --project=${browser} -c ${configFile} ${mode === "open" ? "--ui" : ""}${reporter}${getTargetTestFileForPlawright(targetTestFile)}`;
-        console.log(chalk_1.default.gray(`Running ${command}`));
-        (0, child_process_1.execSync)(command, { stdio: "inherit" });
+        return `${targetTestFile
+            .replaceAll("uuv/e2e/", ".uuv-features-gen/uuv/e2e/")
+            .replaceAll(".feature", ".feature.spec.js")}`;
     }
-    catch (err) {
-        process.exit(-1);
+    runPlaywright(options) {
+        const configFile = `${this.projectDir}/playwright.config.ts`;
+        try {
+            let reporter = "--reporter=@uuv/playwright/uuv-playwright-reporter";
+            if (options.report?.junit.enabled) {
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                process.env.PLAYWRIGHT_JUNIT_OUTPUT_NAME = options.report?.junit.outputFile;
+                reporter = `${reporter},junit`;
+            }
+            const command = this.buildCommand(options, configFile, reporter);
+            this.executeSystemCommand(command);
+        }
+        catch (err) {
+            process.exit(2);
+        }
     }
-}
-function getTargetTestFileForPlawright(targetTestFile) {
-    if (!targetTestFile) {
-        return "";
+    executeSystemCommand(command) {
+        console.log(chalk_1.default.gray(`Running command: ${command}`));
+        (0, child_process_1.execSync)(command, { stdio: "inherit" });
+    }
+    buildCommand(options, configFile, reporter) {
+        return lodash_1.default.trimEnd([
+            "npx",
+            "playwright",
+            "test",
+            `--project=${options.browser}`,
+            "-c",
+            configFile,
+            lodash_1.default.trimStart([
+                options.command === "open" ? "--ui" : "",
+                reporter
+            ].join(" ")),
+            this.getTargetTestFileForPlaywright(options.targetTestFile)
+        ].join(" "));
     }
-    return ` ${targetTestFile
-        .replaceAll("uuv/e2e/", ".uuv-features-gen/uuv/e2e/")
-        .replaceAll(".feature", ".feature.spec.js")}`;
 }
-async function executePreprocessor(tempDir, configDir, env) {
+exports.UUVCliPlaywrightRunner = UUVCliPlaywrightRunner;
+async function executePreprocessor(tempDir, tags) {
     console.log("running preprocessor...");
-    await bddGen(tempDir, env);
-    console.log("preprocessor executed");
+    await bddGen(tempDir, tags);
+    console.log("preprocessor executed\n");
 }
 exports.executePreprocessor = executePreprocessor;
-async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", argv) {
-    const { browser, env, targetTestFile } = extractArgs(argv);
-    await executePreprocessor(tempDir, configDir, env);
-    if (mode === "open") {
-        child_process_1.default.fork(path_1.default.join(__dirname, "watch-test-files"), [tempDir, configDir, env]);
-    }
-    runPlaywright(mode, configDir, browser, argv.generateHtmlReport, argv.generateJunitReport, env, targetTestFile);
-}
-exports.run = run;
-function extractArgs(argv) {
-    const browser = argv.browser;
-    const env = argv.env ? JSON.parse(argv.env.replace(/'/g, "\"")) : {};
-    const targetTestFile = argv.targetTestFile ? argv.targetTestFile : null;
-    console.debug("Variables: ");
-    // eslint-disable-next-line dot-notation
-    const baseUrl = process.env["UUV_BASE_URL"];
-    if (baseUrl) {
-        console.debug(`  -> baseUrl: ${baseUrl}`);
+async function bddGen(tempDir, tags) {
+    try {
+        const mapOfFile = await (0, gen_1.generateTestFiles)({
+            outputDir: tempDir,
+            tags
+        });
+        const content = [];
+        mapOfFile.forEach((value, key) => {
+            if (value.uri) {
+                content.push({
+                    originalFile: value.uri,
+                    generatedFile: key
+                });
+            }
+        });
+        fs_1.default.writeFileSync(`${tempDir}/${exports.UUVPlaywrightCucumberMapFile}`, JSON.stringify(content, null, 4), { encoding: "utf8" });
     }
-    console.debug(`  -> browser: ${browser}`);
-    console.debug(`  -> env: ${JSON.stringify(env)}`);
-    if (targetTestFile) {
-        console.debug(`  -> targetTestFile: ${targetTestFile}`);
+    catch (err) {
+        console.error(chalk_1.default.red("Something went wrong..."));
+        console.dir(err);
+        process.exit(2);
     }
-    return { browser, env, targetTestFile };
 }

package/dist/lib/uuv-cli.d.ts

@@ -12,4 +12,4 @@
  * Software description: Make test writing fast, understandable by any human
  * understanding English or French.
  */
-export declare function main(): Promise<void>;
+export declare function main(projectDir?: string, tempDir?: string): Promise<void>;

package/dist/lib/uuv-cli.js

@@ -13,72 +13,12 @@
  * Software description: Make test writing fast, understandable by any human
  * understanding English or French.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const figlet_1 = __importDefault(require("figlet"));
-const minimist_1 = __importDefault(require("minimist"));
+const runner_commons_1 = require("@uuv/runner-commons");
 const runner_playwright_1 = require("./runner-playwright");
-const fs_1 = __importDefault(require("fs"));
-async function main() {
-    const PROJECT_DIR = "uuv";
-    const FEATURE_GEN_DIR = `${PROJECT_DIR}/.uuv-features-gen`;
-    printBanner(getCurrentVersion);
-    const argv = (0, minimist_1.default)(process.argv.slice(2));
-    const command = findTargetCommand(argv);
-    console.info(chalk_1.default.blueBright(`Executing UUV command ${command}...`));
-    switch (command) {
-        case "open":
-            await openPlaywright(argv);
-            break;
-        case "e2e":
-            await runE2ETests(argv);
-            break;
-        default:
-            console.error(chalk_1.default.red("Unknown command"));
-            process.exit(1);
-    }
-    console.info(`UUV command ${command} executed`);
-    function openPlaywright(argv) {
-        return (0, runner_playwright_1.run)("open", FEATURE_GEN_DIR, PROJECT_DIR, argv);
-    }
-    function runE2ETests(argv) {
-        // Running Tests
-        return (0, runner_playwright_1.run)("e2e", FEATURE_GEN_DIR, PROJECT_DIR, argv)
-            .then(async (result) => {
-            console.log(`Status ${chalk_1.default.green("success")}`);
-        })
-            .catch((err) => {
-            console.error(chalk_1.default.red(err));
-            process.exit(-1);
-        });
-    }
-    function findTargetCommand(argv) {
-        if (argv._.length < 1) {
-            console.error(chalk_1.default.red("No command specified"));
-            process.exit(1);
-        }
-        const command = argv._[0];
-        return command;
-    }
-    function printBanner(getCurrentVersion) {
-        console.log(chalk_1.default.blueBright(figlet_1.default.textSync("UUV - Playwright", {
-            font: "Big",
-            horizontalLayout: "default",
-            verticalLayout: "default",
-            width: 80,
-            whitespaceBreak: true
-        })));
-        console.info(chalk_1.default.blueBright(`Version: ${getCurrentVersion()}\n\n`));
-    }
-    function getCurrentVersion() {
-        const pJsonStr = fs_1.default.readFileSync(`${__dirname}/../../package.json`, {
-            encoding: "utf8", flag: "r"
-        });
-        return JSON.parse(pJsonStr).version;
-    }
+async function main(projectDir = "./uuv", tempDir = "uuv/.uuv-features-gen") {
+    const engine = new runner_commons_1.UUVCliEngine(new runner_playwright_1.UUVCliPlaywrightRunner(projectDir, tempDir));
+    engine.execute();
 }
 exports.main = main;

package/dist/lib/watch-test-files.js

@@ -20,27 +20,27 @@ const runner_playwright_1 = require("./runner-playwright");
 const chokidar_1 = __importDefault(require("chokidar"));
 const chalk_1 = __importDefault(require("chalk"));
 const tempDir = process.argv[2];
-const configDir = process.argv[3];
-const env = process.argv[4];
-if (!tempDir || !configDir) {
+const projectDir = process.argv[3];
+const tags = process.argv[4];
+if (!tempDir || !projectDir) {
     console.log(chalk_1.default.redBright("An error occurred during test files watching"));
     process.exit(-1);
 }
-chokidar_1.default.watch(`${configDir}/e2e/**/*.feature`, {
+chokidar_1.default.watch(`${projectDir}/e2e/**/*.feature`, {
     ignoreInitial: true
 })
     .on("change", async (event, path) => {
     console.log(chalk_1.default.yellowBright("\nRefreshing test files..."));
-    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir, env);
+    await (0, runner_playwright_1.executePreprocessor)(tempDir, tags);
     console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
 })
     .on("add", async (path) => {
     console.log(chalk_1.default.yellowBright(`\nFile ${path} has been added`));
-    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir, env);
+    await (0, runner_playwright_1.executePreprocessor)(tempDir, tags);
     console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
 })
     .on("unlink", async (path) => {
     console.log(chalk_1.default.yellowBright(`\nFile ${path} has been removed`));
-    await (0, runner_playwright_1.executePreprocessor)(tempDir, configDir, env);
+    await (0, runner_playwright_1.executePreprocessor)(tempDir, tags);
     console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/playwright",
-  "version": "2.11.1",
+  "version": "2.12.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to facilitate the writing and execution of E2E tests understandable by any human being using cucumber(BDD) and playwright",
@@ -36,23 +36,22 @@
     "generate:step-definitions": "ts-node generate-step-definitions.ts",
     "package": "npm pack --pack-destination=\"../../dist/packages\"",
     "postinstall": "node postinstall.js",
-    "test:run": "ts-node test.ts run",
-    "test:open": "ts-node test.ts open --",
-    "test": "npm run test:run --"
+    "unit-test": "jest --runInBand --coverage --config=./jest.config.ts",
+    "e2e-test:run": "ts-node test.ts e2e",
+    "e2e-test:open": "ts-node test.ts open --",
+    "test": "npm run unit-test && npm run e2e-test:run"
   },
   "dependencies": {
     "@cucumber/cucumber": "9.6.0",
     "@cucumber/tag-expressions": "^6.0.0",
     "@playwright/test": "1.43.1",
-    "@uuv/runner-commons": "2.10.1",
+    "@uuv/runner-commons": "2.11.0",
     "axe-core": "4.9.0",
     "axe-playwright": "2.0.1",
-    "chalk": "4.1.2",
     "chalk-table": "^1.0.2",
     "chokidar": "3.5.3",
     "cucumber-json-report-formatter": "0.1.4",
-    "figlet": "1.7.0",
-    "minimist": "1.2.8",
+    "lodash": "^4.17.21",
     "multiple-cucumber-html-reporter": "3.6.2",
     "nanoid": "^3.3.7",
     "ts-node": "10.9.2",
@@ -88,7 +87,8 @@
   },
   "devDependencies": {
     "@types/minimist": "1.2.5",
-    "@types/node": "20.11.30",
+    "@types/node": "20.12.7",
+    "chalk": "^4.1.2",
     "cross-env": "7.0.3",
     "eslint-plugin-cucumber": "2.0.0",
     "eslint-plugin-jest": "27.9.0",