@uuv/cypress 2.9.1 → 2.10.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [2.10.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.9.1...runner-cypress-v2.10.0) (2024-02-25)
+
+
+### Features
+
+* add junit xml report option, [#491](https://github.com/Orange-OpenSource/uuv/issues/491) ([b64b0b2](https://github.com/Orange-OpenSource/uuv/commit/b64b0b2a60200269f558bcf7e0c75d8a74ffc226))
+
+
+### Bug Fixes
+
+* **runner-playwright:** update dependency @cucumber/tag-expressions to v6.1.0 ([47fb579](https://github.com/Orange-OpenSource/uuv/commit/47fb579ee50c26ed67af6390f4e678f8206b7226))
+
 ## [2.9.1](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.9.0...runner-cypress-v2.9.1) (2024-02-24)
 
 

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

@@ -13,4 +13,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): Promise<void>;

package/dist/lib/uuv-cli.js

@@ -26,12 +26,15 @@ 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");
-async function main() {
-    const REPORT_DIR = "./uuv/reports";
-    const JSON_REPORT_DIR = "./uuv/reports/e2e/json";
-    const HTML_REPORT_DIR = "./uuv/reports/e2e/html";
-    const CUCUMBER_MESSAGES_FILE = "./uuv/cucumber-messages.ndjson";
-    const PROJECT_DIR = "./uuv";
+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);
     const argv = (0, minimist_1.default)(process.argv.slice(2));
     const command = findTargetCommand(argv);
@@ -39,6 +42,9 @@ async function main() {
     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);
+    }
     switch (command) {
         case "open":
             await openCypress(argv);
@@ -55,8 +61,12 @@ async function main() {
         const browser = argv.browser ? argv.browser : "chrome";
         const env = argv.env ? JSON.parse(argv.env.replace(/'/g, "\"")) : {};
         const targetTestFile = argv.targetTestFile ? argv.targetTestFile : null;
-        env.uuvA11yReportFilePath = `${process.cwd()}/${REPORT_DIR}/a11y-report.json`;
-        env.generateA11yReport = argv.generateA11yReport;
+        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: ");
         console.debug(`  -> browser: ${browser}`);
         console.debug(`  -> env: ${JSON.stringify(env)}`);
@@ -68,17 +78,23 @@ async function main() {
     function openCypress(argv) {
         const { env } = extractArgs(argv);
         return cypress_1.default.open({
-            project: PROJECT_DIR,
+            project: projectDir,
             env,
         });
     }
     function runE2ETests(argv) {
         const { browser, env, targetTestFile } = extractArgs(argv);
         const options = {
-            project: PROJECT_DIR,
+            project: projectDir,
             browser,
             env
         };
+        if (env.generateJunitReport) {
+            options.reporter = "junit";
+            options.reporterOptions = {
+                mochaFile: "reports/e2e/junit-report-[hash].xml"
+            };
+        }
         if (targetTestFile) {
             options.spec = targetTestFile;
         }
@@ -86,8 +102,11 @@ async function main() {
         return cypress_1.default
             .run(options)
             .then(async (result) => {
-            if (argv.generateHtmlReport) {
-                console.info(chalk_1.default.blueBright("Generating Test Report..."));
+            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)) {
@@ -99,8 +118,11 @@ async function main() {
             }
             process.exit();
         })
-            .catch((err) => {
+            .catch(async (err) => {
             console.error(chalk_1.default.red(err));
+            if (env.generateJunitReport) {
+                await mergeJunitReport(CYPRESS_JUNIT_REPORT, JUNIT_UNIFIED_REPORT);
+            }
             process.exit(-1);
         });
     }
@@ -159,5 +181,19 @@ async function main() {
         });
         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);
+            }
+        }
+    }
 }
 exports.main = main;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/cypress",
-  "version": "2.9.1",
+  "version": "2.10.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,8 +36,8 @@
     "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 --run",
-    "test:open": "node test.js --open",
+    "test:run": "node test.js e2e",
+    "test:open": "node test.js open",
     "test": "npm run test:run",
     "lint": "eslint -c .eslintrc.json"
   },
@@ -45,8 +45,8 @@
     "@badeball/cypress-cucumber-preprocessor": "16.0.3",
     "@cypress/webpack-preprocessor": "5.17.1",
     "@testing-library/cypress": "9.0.0",
-    "@uuv/a11y": "1.0.0-beta.13",
-    "@uuv/runner-commons": "2.6.5",
+    "@uuv/a11y": "1.0.0-beta.14",
+    "@uuv/runner-commons": "2.7.0",
     "axe-core": "4.8.4",
     "chai-subset": "^1.6.0",
     "chalk": "4.1.2",
@@ -56,6 +56,7 @@
     "cypress-real-events": "^1.10.0",
     "figlet": "1.7.0",
     "is-admin": "2.1.1",
+    "junit-report-merger": "^6.0.3",
     "minimist": "1.2.8",
     "multiple-cucumber-html-reporter": "3.6.2",
     "path-browserify": "^1.0.1",