@uuv/cypress 2.15.1 → 2.17.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [2.17.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.16.0...runner-cypress-v2.17.0) (2024-05-02)
+
+
+### Features
+
+* **runner-playwright:** update dependency typescript to v5 ([05eaf55](https://github.com/Orange-OpenSource/uuv/commit/05eaf55924ef481abe9f9442c33458b1f2d4bb02))
+* update package-lock for update dependency typescript to v5 ([f058481](https://github.com/Orange-OpenSource/uuv/commit/f058481e2ae75ba91e708a5c4dd8ce16c0f1a04f))
+
+# [2.16.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.15.1...runner-cypress-v2.16.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.15.1](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.15.0...runner-cypress-v2.15.1) (2024-04-14)
 
 

package/dist/cucumber/step_definitions/cypress/_.common.js

@@ -14,16 +14,15 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.uuvFoundedElement = exports.uuvFindByTestId = exports.uuvFindByText = exports.uuvFindByLabelText = exports.uuvFindByRole = exports.uuvFindAllByRole = exports.uuvPatchContext = exports.uuvCheckContextWithinFocusedElement = exports.uuvGetContext = exports.getA11yResultFilePath = exports.shouldGenerateA11yReport = void 0;
-const ENV_GENERATE_A11_REPORT = "generateA11yReport";
 const contextAlias = "context";
 const foundedChildElementAlias = "foundedChildElement";
 const shouldGenerateA11yReport = () => {
-    const generateA11yReport = Cypress.env(ENV_GENERATE_A11_REPORT);
+    const generateA11yReport = Cypress.env("uuvOptions").report.a11y.enabled;
     return generateA11yReport === true;
 };
 exports.shouldGenerateA11yReport = shouldGenerateA11yReport;
 const getA11yResultFilePath = () => {
-    return Cypress.env("uuvA11yReportFilePath");
+    return Cypress.env("uuvOptions").report.a11y.outputFile;
 };
 exports.getA11yResultFilePath = getA11yResultFilePath;
 const uuvGetContext = () => {

package/dist/cypress/cypress.config.js

@@ -72,9 +72,9 @@ async function setupNodeEvents(on, config) {
     on("before:run", async () => {
         await (0, cypress_cucumber_preprocessor_1.beforeRunHandler)(config);
         // eslint-disable-next-line dot-notation
-        const a11yReportFilePath = config.env["uuvA11yReportFilePath"];
+        const a11yReportFilePath = config.env["uuvOptions"].report.a11y.outputFile;
         // eslint-disable-next-line dot-notation
-        const generateA11yReport = config.env["generateA11yReport"];
+        const generateA11yReport = config.env["uuvOptions"].report.a11y.enabled;
         clearA11yReport(a11yReportFilePath);
         if (generateA11yReport === true) {
             initA11yReport(a11yReportFilePath);

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

@@ -0,0 +1,22 @@
+import { UUVCliOptions, UUVCliRunner } from "@uuv/runner-commons";
+export declare class UUVCliCypressRunner implements UUVCliRunner {
+    projectDir: any;
+    name: string;
+    defaultBrowser: string;
+    private E2E_REPORT_DIR;
+    private JSON_REPORT_DIR;
+    private CYPRESS_JUNIT_REPORT;
+    private CUCUMBER_MESSAGES_FILE;
+    constructor(projectDir: any);
+    getCurrentVersion(): string;
+    prepare(options: Partial<UUVCliOptions>): void;
+    executeE2eCommand(options: Partial<UUVCliOptions>): Promise<void>;
+    executeOpenCommand(options: Partial<UUVCliOptions>): Promise<void>;
+    private createReportDirectories;
+    private terminateProcess;
+    private mergeJunitReport;
+    private generateHtmlReport;
+    private formatCucumberMessageFile;
+    private generateHtmlReportFromJson;
+    private getCypress;
+}

package/dist/lib/runner-cypress.js

@@ -0,0 +1,150 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UUVCliCypressRunner = void 0;
+const runner_commons_1 = require("@uuv/runner-commons");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const junit_report_merger_1 = require("junit-report-merger");
+const uuv_custom_formatter_1 = require("../cucumber/uuv-custom-formatter");
+const multiple_cucumber_html_reporter_1 = __importDefault(require("multiple-cucumber-html-reporter"));
+const cypress_1 = __importDefault(require("cypress"));
+class UUVCliCypressRunner {
+    projectDir;
+    name = "Cypress";
+    defaultBrowser = "chrome";
+    E2E_REPORT_DIR;
+    JSON_REPORT_DIR;
+    CYPRESS_JUNIT_REPORT;
+    CUCUMBER_MESSAGES_FILE;
+    constructor(projectDir) {
+        this.projectDir = projectDir;
+    }
+    getCurrentVersion() {
+        const pJsonStr = fs_1.default.readFileSync(`${__dirname}/../../package.json`, {
+            encoding: "utf8", flag: "r"
+        });
+        return JSON.parse(pJsonStr).version;
+    }
+    prepare(options) {
+        if (options.baseUrl) {
+            // eslint-disable-next-line dot-notation
+            process.env["CYPRESS_BASE_URL"] = options.baseUrl;
+        }
+        if (options.report) {
+            this.E2E_REPORT_DIR = path_1.default.join(options.report.outputDir, "e2e");
+            this.JSON_REPORT_DIR = path_1.default.join(this.E2E_REPORT_DIR, "json");
+            this.CYPRESS_JUNIT_REPORT = [`${this.projectDir}/reports/e2e/junit-report-*.xml`];
+            this.CUCUMBER_MESSAGES_FILE = path_1.default.join(this.projectDir, "cucumber-messages.ndjson");
+            this.createReportDirectories({ report: options.report });
+        }
+    }
+    executeE2eCommand(options) {
+        const cypressOptions = {
+            project: this.projectDir,
+            browser: options.browser,
+            env: {
+                uuvOptions: options,
+                ...options.extraArgs
+            }
+        };
+        if (options.report?.junit.enabled) {
+            cypressOptions.reporter = "junit";
+            cypressOptions.reporterOptions = {
+                mochaFile: "reports/e2e/junit-report-[hash].xml"
+            };
+        }
+        if (options.targetTestFile) {
+            cypressOptions.spec = options.targetTestFile;
+        }
+        // Running Tests
+        return this.getCypress()
+            .run(cypressOptions)
+            .then(async (result) => {
+            if (options.report?.junit.enabled) {
+                await this.mergeJunitReport(this.CYPRESS_JUNIT_REPORT, options.report.junit.outputFile);
+            }
+            if (options.report?.html.enabled) {
+                await this.generateHtmlReport(options, options.report.html.outputDir);
+            }
+            if (fs_1.default.existsSync(this.CUCUMBER_MESSAGES_FILE)) {
+                fs_1.default.rmSync(this.CUCUMBER_MESSAGES_FILE);
+            }
+            if ("totalFailed" in result) {
+                console.log(`Status ${result.totalFailed ? chalk_1.default.red("failed") : chalk_1.default.green("success")}`);
+                this.terminateProcess(result.totalFailed === 0 ? 0 : 2);
+            }
+            this.terminateProcess(0);
+        })
+            .catch(async (err) => {
+            console.error(chalk_1.default.red(err));
+            if (options.report?.junit.enabled) {
+                await this.mergeJunitReport(this.CYPRESS_JUNIT_REPORT, options.report.junit.outputFile);
+            }
+            this.terminateProcess(2);
+        });
+    }
+    executeOpenCommand(options) {
+        return this.getCypress().open({
+            project: this.projectDir,
+            env: options.extraArgs,
+        });
+    }
+    createReportDirectories(options) {
+        if (!fs_1.default.existsSync(options.report.outputDir)) {
+            fs_1.default.mkdirSync(options.report.outputDir);
+        }
+        if (fs_1.default.existsSync(this.E2E_REPORT_DIR)) {
+            runner_commons_1.Common.deleteAllFileOfDirectory(this.E2E_REPORT_DIR);
+        }
+        else {
+            fs_1.default.mkdirSync(this.E2E_REPORT_DIR, { recursive: true });
+        }
+        if (!fs_1.default.existsSync(this.JSON_REPORT_DIR)) {
+            fs_1.default.mkdirSync(this.JSON_REPORT_DIR, { recursive: true });
+        }
+    }
+    terminateProcess(exitCode) {
+        process.exit(exitCode);
+    }
+    async mergeJunitReport(inputFiles, outputFile) {
+        console.info(chalk_1.default.blueBright("Generating Junit Test Report..."));
+        await (0, junit_report_merger_1.mergeFiles)(outputFile, inputFiles);
+        console.info(chalk_1.default.blueBright(`Junit Test Report generated: ${outputFile}\n`));
+    }
+    async generateHtmlReport(options, reportDir) {
+        console.info(chalk_1.default.blueBright("Generating Html Test Report..."));
+        await this.formatCucumberMessageFile(this.JSON_REPORT_DIR, this.CUCUMBER_MESSAGES_FILE);
+        this.generateHtmlReportFromJson(options, this.JSON_REPORT_DIR, reportDir);
+    }
+    async formatCucumberMessageFile(jsonReportDir, cucumberMessageFile) {
+        const formatter = new uuv_custom_formatter_1.UuvCustomFormatter();
+        const outputFile = `${jsonReportDir}/cucumber-report.json`;
+        await formatter.parseCucumberJson(cucumberMessageFile, outputFile);
+    }
+    generateHtmlReportFromJson(options, jsonReportDir, htmlReportDir) {
+        const UNKNOWN_VALUE = "unknown";
+        multiple_cucumber_html_reporter_1.default.generate({
+            jsonDir: jsonReportDir,
+            reportPath: htmlReportDir,
+            metadata: {
+                browser: {
+                    name: options.browser,
+                    version: options.extraArgs?.browserVersion ? options.extraArgs.browserVersion : "",
+                },
+                device: options.extraArgs?.device ? options.extraArgs.device : UNKNOWN_VALUE,
+                platform: {
+                    name: options.extraArgs?.platformName ? options.extraArgs.platformName : UNKNOWN_VALUE,
+                    version: options.extraArgs?.platformVersion ? options.extraArgs.platformVersion : "",
+                },
+            },
+        });
+    }
+    getCypress() {
+        return cypress_1.default;
+    }
+}
+exports.UUVCliCypressRunner = UUVCliCypressRunner;

package/dist/lib/uuv-cli.js

@@ -1,5 +1,9 @@
 #!/usr/bin/env node
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const runner_commons_1 = require("@uuv/runner-commons");
+const runner_cypress_1 = require("./runner-cypress");
 /**
  * Software Name : UUV
  *
@@ -13,206 +17,8 @@
  * 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 multiple_cucumber_html_reporter_1 = __importDefault(require("multiple-cucumber-html-reporter"));
-const chalk_1 = __importDefault(require("chalk"));
-const figlet_1 = __importDefault(require("figlet"));
-const minimist_1 = __importDefault(require("minimist"));
-const fs_1 = __importDefault(require("fs"));
-const cypress_1 = __importDefault(require("cypress"));
-const uuv_custom_formatter_1 = require("../cucumber/uuv-custom-formatter");
-const path_1 = __importDefault(require("path"));
 async function main(projectDir = "./uuv") {
-    const REPORT_DIR = path_1.default.join(projectDir, "reports");
-    const E2E_REPORT_DIR = path_1.default.join(projectDir, "reports/e2e");
-    const JSON_REPORT_DIR = path_1.default.join(projectDir, "reports/e2e/json");
-    const HTML_REPORT_DIR = path_1.default.join(projectDir, "reports/e2e/html");
-    const CYPRESS_JUNIT_REPORT = [`${projectDir}/reports/e2e/junit-report-*.xml`];
-    const JUNIT_UNIFIED_REPORT = `${projectDir}/reports/e2e/junit-report.xml`;
-    const CUCUMBER_MESSAGES_FILE = path_1.default.join(projectDir, "cucumber-messages.ndjson");
-    printBanner(getCurrentVersion);
-    setBaseUrl();
-    const argv = (0, minimist_1.default)(process.argv.slice(2));
-    const command = findTargetCommand(argv);
-    console.info(chalk_1.default.blueBright(`Executing UUV command ${command}...`));
-    createReportDirectories();
-    await executeCommand();
-    console.info(`UUV command ${command} executed`);
-    function setBaseUrl() {
-        // eslint-disable-next-line dot-notation
-        const baseUrl = process.env["UUV_BASE_URL"];
-        if (baseUrl) {
-            // eslint-disable-next-line dot-notation
-            process.env["CYPRESS_BASE_URL"] = process.env["UUV_BASE_URL"];
-        }
-    }
-    function createReportDirectories() {
-        if (!fs_1.default.existsSync(REPORT_DIR)) {
-            fs_1.default.mkdirSync(REPORT_DIR);
-        }
-        if (fs_1.default.existsSync(E2E_REPORT_DIR)) {
-            deleteAllFileOfDirectory(E2E_REPORT_DIR);
-        }
-    }
-    async function executeCommand() {
-        switch (command) {
-            case "open":
-                await openCypress(argv);
-                break;
-            case "e2e":
-                await runE2ETests(argv);
-                break;
-            default:
-                console.error(chalk_1.default.red("Unknown command"));
-                process.exit(1);
-        }
-    }
-    function extractArgs(argv) {
-        const browser = argv.browser ? argv.browser : "chrome";
-        const env = argv.env ? JSON.parse(argv.env.replace(/'/g, "\"")) : {};
-        const targetTestFile = argv.targetTestFile ? argv.targetTestFile : null;
-        if (argv.generateA11yReport) {
-            env.uuvA11yReportFilePath = `${process.cwd()}/${REPORT_DIR}/a11y-report.json`;
-            env.generateA11yReport = argv.generateA11yReport;
-        }
-        env.generateJunitReport = argv.generateJunitReport;
-        env.generateHtmlReport = argv.generateHtmlReport;
-        console.debug("Variables: ");
-        // eslint-disable-next-line dot-notation
-        const baseUrl = process.env["CYPRESS_BASE_URL"];
-        if (baseUrl) {
-            console.debug(`  -> baseUrl: ${baseUrl}`);
-        }
-        console.debug(`  -> browser: ${browser}`);
-        console.debug(`  -> env: ${JSON.stringify(env)}`);
-        if (targetTestFile) {
-            console.debug(`  -> targetTestFile: ${targetTestFile}`);
-        }
-        return { browser, env, targetTestFile };
-    }
-    function openCypress(argv) {
-        const { env } = extractArgs(argv);
-        return cypress_1.default.open({
-            project: projectDir,
-            env,
-        });
-    }
-    function runE2ETests(argv) {
-        const { browser, env, targetTestFile } = extractArgs(argv);
-        const options = {
-            project: projectDir,
-            browser,
-            env
-        };
-        if (env.generateJunitReport) {
-            options.reporter = "junit";
-            options.reporterOptions = {
-                mochaFile: "reports/e2e/junit-report-[hash].xml"
-            };
-        }
-        if (targetTestFile) {
-            options.spec = targetTestFile;
-        }
-        // Running Tests
-        return cypress_1.default
-            .run(options)
-            .then(async (result) => {
-            if (env.generateJunitReport) {
-                await mergeJunitReport(CYPRESS_JUNIT_REPORT, JUNIT_UNIFIED_REPORT);
-            }
-            if (env.generateHtmlReport) {
-                console.info(chalk_1.default.blueBright("Generating Html Test Report..."));
-                await generateHtmlReport(browser, argv);
-            }
-            if (fs_1.default.existsSync(CUCUMBER_MESSAGES_FILE)) {
-                fs_1.default.rmSync(CUCUMBER_MESSAGES_FILE);
-            }
-            if ("totalFailed" in result) {
-                console.log(`Status ${result.totalFailed ? chalk_1.default.red("failed") : chalk_1.default.green("success")}`);
-                process.exit(result.totalFailed);
-            }
-            process.exit();
-        })
-            .catch(async (err) => {
-            console.error(chalk_1.default.red(err));
-            if (env.generateJunitReport) {
-                await mergeJunitReport(CYPRESS_JUNIT_REPORT, JUNIT_UNIFIED_REPORT);
-            }
-            process.exit(-1);
-        });
-    }
-    async function formatCucumberMessageFile() {
-        // Creating needed dirs
-        if (!fs_1.default.existsSync(JSON_REPORT_DIR)) {
-            fs_1.default.mkdirSync(JSON_REPORT_DIR, { recursive: true });
-        }
-        const formatter = new uuv_custom_formatter_1.UuvCustomFormatter();
-        const outputFile = `${JSON_REPORT_DIR}/cucumber-report.json`;
-        await formatter.parseCucumberJson(CUCUMBER_MESSAGES_FILE, outputFile);
-    }
-    function generateHtmlReportFromJson(browser, argv) {
-        const UNKNOWN_VALUE = "unknown";
-        multiple_cucumber_html_reporter_1.default.generate({
-            jsonDir: JSON_REPORT_DIR,
-            reportPath: HTML_REPORT_DIR,
-            metadata: {
-                browser: {
-                    name: browser,
-                    version: argv.browserVersion ? argv.browserVersion : "",
-                },
-                device: argv.device ? argv.device : UNKNOWN_VALUE,
-                platform: {
-                    name: argv.platformName ? argv.platformName : UNKNOWN_VALUE,
-                    version: argv.platformVersion ? argv.platformVersion : "",
-                },
-            },
-        });
-    }
-    async function generateHtmlReport(browser, argv) {
-        await formatCucumberMessageFile();
-        generateHtmlReportFromJson(browser, argv);
-    }
-    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 - Cypress", {
-            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 mergeJunitReport(inputFiles, outputFile) {
-        const { mergeFiles } = require("junit-report-merger");
-        console.info(chalk_1.default.blueBright("Generating Junit Test Report..."));
-        await mergeFiles(outputFile, inputFiles);
-        console.info(chalk_1.default.blueBright(`Junit Test Report generated: ${outputFile}`));
-    }
-    function deleteAllFileOfDirectory(dirPath) {
-        for (const file of fs_1.default.readdirSync(dirPath)) {
-            const filePath = path_1.default.join(dirPath, file);
-            if (fs_1.default.lstatSync(filePath).isFile()) {
-                fs_1.default.rmSync(filePath);
-            }
-        }
-    }
+    const engine = new runner_commons_1.UUVCliEngine(new runner_cypress_1.UUVCliCypressRunner(projectDir));
+    engine.execute();
 }
 exports.main = main;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/cypress",
-  "version": "2.15.1",
+  "version": "2.17.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 cypress",
@@ -36,32 +36,30 @@
     "generate:step-definitions": "ts-node generate-step-definitions.ts",
     "package": "npm pack --pack-destination=\"../../dist/packages\"",
     "postinstall": "node postinstall.js",
-    "test:run": "node test.js e2e",
-    "test:open": "node test.js open",
-    "test": "npm run test:run",
+    "unit-test": "jest --runInBand --coverage --config=./jest.config.ts",
+    "e2e-test:run": "node test.js e2e",
+    "e2e-test:open": "node test.js open --",
+    "test": "npm run unit-test && npm run e2e-test:run",
     "lint": "eslint -c .eslintrc.json"
   },
   "dependencies": {
     "@badeball/cypress-cucumber-preprocessor": "16.0.3",
     "@cypress/webpack-preprocessor": "6.0.1",
     "@testing-library/cypress": "10.0.1",
-    "@uuv/a11y": "1.0.0-beta.22",
-    "@uuv/runner-commons": "2.10.1",
+    "@uuv/a11y": "1.0.0-beta.24",
+    "@uuv/runner-commons": "2.12.0",
     "axe-core": "4.9.0",
     "chai-subset": "^1.6.0",
-    "chalk": "4.1.2",
     "cucumber-json-report-formatter": "0.1.4",
     "cypress": "12.17.4",
     "cypress-axe": "1.5.0",
     "cypress-real-events": "^1.10.0",
-    "figlet": "1.7.0",
     "is-admin": "4.0.0",
     "junit-report-merger": "^6.0.3",
-    "minimist": "1.2.8",
     "multiple-cucumber-html-reporter": "3.6.2",
     "path-browserify": "^1.0.1",
     "ts-node": "10.9.2",
-    "typescript": "4.9.5",
+    "typescript": "5.4.5",
     "webpack": "5.90.3"
   },
   "types": "./dist/index.d.ts",
@@ -102,9 +100,10 @@
   },
   "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-cypress": "2.15.1",
+    "eslint-plugin-cypress": "2.15.2",
     "ts-loader": "9.4.2",
     "tsconfig-paths": "4.2.0"
   }