@uuv/playwright 1.3.0

package/dist/cucumber/step_definitions/playwright/generated/enriched/fr/_fr-generated-steps-definition_window.js

@@ -0,0 +1,40 @@
+"use strict";
+/*******************************
+NE PAS MODIFIER, FICHIER GENERE
+*******************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const cucumber_1 = require("@cucumber/cucumber");
+const core_engine_1 = require("../../../core-engine");
+(0, cucumber_1.When)(`je vais à l'intérieur de fenêtre nommé(e) {string}`, async function (name) {
+    return await (0, core_engine_1.withinRoleAndName)(this, "window", name);
+});
+(0, cucumber_1.Then)(`je dois voir un(e) fenêtre nommé(e) {string}`, async function (name) {
+    await (0, core_engine_1.findWithRoleAndName)(this, "window", name);
+});
+(0, cucumber_1.Then)(`je ne dois pas voir un(e) fenêtre nommé(e) {string}`, async function (name) {
+    await (0, core_engine_1.notFoundWithRoleAndName)(this, "window", name);
+});
+(0, cucumber_1.Then)(`je dois voir un(e) fenêtre nommé(e) {string} et contenant {string}`, async function (name, expectedTextContent) {
+    await (0, core_engine_1.findWithRoleAndNameAndContent)(this, "window", name, expectedTextContent);
+});
+(0, cucumber_1.Then)(`je dois voir un(e) fenêtre nommé(e) {string} et contenant {string} inactif`, async function (name, expectedTextContent) {
+    await (0, core_engine_1.findWithRoleAndNameAndContentDisable)(this, "window", name, expectedTextContent);
+});
+(0, cucumber_1.Then)(`je dois voir un(e) fenêtre nommé(e) {string} et contenant {string} actif`, async function (name, expectedTextContent) {
+    await (0, core_engine_1.findWithRoleAndNameAndContentEnable)(this, "window", name, expectedTextContent);
+});

package/dist/cucumber/step_definitions/playwright/unsafe/custom_selector.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/cucumber/step_definitions/playwright/unsafe/custom_selector.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const cucumber_1 = require("@cucumber/cucumber");
+(0, cucumber_1.When)("je suis une phrase custom qui vérifie l'existence d'un noeud par le sélecteur {string}", async function (selector) {
+    await this.page.locator(selector);
+});

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./cucumber/preprocessor";

package/dist/index.js

@@ -0,0 +1,17 @@
+"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("./cucumber/preprocessor"), exports);

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

@@ -0,0 +1,21 @@
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface UUVPlaywrightCucumberMapItem {
+    originalFile: string;
+    generatedFile: string;
+}
+export declare const UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
+export declare function run(mode: "open" | "e2e", tempDir?: string, configDir?: string, generateHtmlReport?: boolean): Promise<void>;

package/dist/lib/runner-playwright.js

@@ -0,0 +1,115 @@
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = exports.UUVPlaywrightCucumberMapFile = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const gen_1 = require("../cucumber/preprocessor/gen");
+const fs_1 = __importDefault(require("fs"));
+const child_process_1 = require("child_process");
+const uuv_playwright_reporter_helper_1 = require("../reporter/uuv-playwright-reporter-helper");
+exports.UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
+async function bddGen(tempDir) {
+    try {
+        const mapOfFile = await (0, gen_1.generateTestFiles)({
+            outputDir: tempDir,
+        });
+        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.log("bddgen executed");
+    }
+    catch (err) {
+        console.error(chalk_1.default.red("Something went wrong..."));
+        console.dir(err);
+        process.exit(-1);
+    }
+}
+function translateFeatures(tempDir, configDir) {
+    const FEATURE_DIR = `${tempDir}/${configDir !== "." ? configDir + "/e2e" : "e2e"}`;
+    const filenames = fs_1.default.readdirSync(FEATURE_DIR, { encoding: "utf8" });
+    filenames.forEach(file => {
+        const generatedFile = `${FEATURE_DIR}/${file}`;
+        let data = fs_1.default.readFileSync(generatedFile, { encoding: "utf8" });
+        data = data
+            .replaceAll("Soit", "Given")
+            .replaceAll("Sachant que", "Given")
+            .replaceAll("Sachant qu'", "Given")
+            .replaceAll("Sachant", "Given")
+            .replaceAll("Etant donné que", "Given")
+            .replaceAll("Étant donné que", "Given")
+            .replaceAll("Étant donné qu'", "Given")
+            .replaceAll("Etant donné qu'", "Given")
+            .replaceAll("Etant données", "Given")
+            .replaceAll("Étant données", "Given")
+            .replaceAll("Etant donnés", "Given")
+            .replaceAll("Étant donnés", "Given")
+            .replaceAll("Etant donnée", "Given")
+            .replaceAll("Étant donnée", "Given")
+            .replaceAll("Etant donné", "Given")
+            .replaceAll("Étant donné", "Given")
+            .replaceAll("Quand", "When")
+            .replaceAll("Lorsque", "When")
+            .replaceAll("Lorsqu'", "When")
+            .replaceAll("Alors", "Then")
+            .replaceAll("Donc", "Then")
+            .replaceAll("Et que", "And")
+            .replaceAll("Et qu'", "And")
+            .replaceAll("Et", "And")
+            .replaceAll("Mais que", "But")
+            .replaceAll("Mais qu'", "But")
+            .replaceAll("Mais", "But");
+        data = "/*******************************\n" +
+            "NE PAS MODIFIER, FICHIER GENERE\n" +
+            "*******************************/\n\n" +
+            data;
+        fs_1.default.writeFileSync(generatedFile, data);
+        console.log(`[WRITE] ${generatedFile} written successfully`);
+    });
+}
+function runPlaywright(mode, configDir, generateHtmlReport = false) {
+    const configFile = `${configDir}/playwright.config.ts`;
+    const reportType = generateHtmlReport ? uuv_playwright_reporter_helper_1.GeneratedReportType.HTML : uuv_playwright_reporter_helper_1.GeneratedReportType.CONSOLE;
+    try {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        process.env.REPORT_TYPE = reportType;
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        process.env.CONFIG_DIR = configDir;
+        console.log(`Running: npx playwright test --project=chromium -c ${configFile} ${mode === "open" ? "--ui" : ""}`);
+        (0, child_process_1.execSync)(`npx playwright test --project=chromium -c ${configFile} ${mode === "open" ? "--ui" : ""}`, { stdio: "inherit" });
+    }
+    catch (err) {
+        process.exit(-1);
+    }
+}
+async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", generateHtmlReport = false) {
+    await bddGen(tempDir);
+    translateFeatures(tempDir, configDir);
+    runPlaywright(mode, configDir, generateHtmlReport);
+}
+exports.run = run;

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

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function main(): Promise<void>;

package/dist/lib/uuv-cli.js

@@ -0,0 +1,102 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * Copyright UUV.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+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_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 extractArgs(argv) {
+        const browser = argv.browser ? argv.browser : "chrome";
+        const env = argv.env ? JSON.parse(argv.env.replace(/'/g, "\"")) : {};
+        console.debug("Variables: ");
+        console.debug(`  -> browser: ${browser}`);
+        console.debug(`  -> env: ${JSON.stringify(env)}`);
+        return { browser, env };
+    }
+    function openPlaywright(argv) {
+        // TODO Implementer les paramètres env en json
+        //const { env } = extractArgs(argv);
+        return (0, runner_playwright_1.run)("open", FEATURE_GEN_DIR, PROJECT_DIR);
+    }
+    function runE2ETests(argv) {
+        const { browser, env } = extractArgs(argv);
+        // TODO Manage HTML Report
+        // Creating needed dirs
+        // if (!fs.existsSync(JSON_REPORT_DIR)) {
+        //   fs.mkdirSync(JSON_REPORT_DIR, { recursive: true });
+        // }
+        // Running Tests
+        return (0, runner_playwright_1.run)("e2e", FEATURE_GEN_DIR, PROJECT_DIR, argv.generateHtmlReport)
+            .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", {
+            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;
+    }
+}
+exports.main = main;

package/dist/reporter/uuv-playwright-reporter-helper.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+import { FullConfig, FullResult, Suite, TestCase, TestResult } from "@playwright/test/reporter";
+import { Envelope } from "@cucumber/messages";
+import { TestStep } from "@playwright/test/types/testReporter";
+export declare enum GeneratedReportType {
+    CONSOLE = "console",
+    HTML = "html"
+}
+interface TestError {
+    scenario: string;
+    error: string | Buffer;
+}
+declare class UuvPlaywrightReporterHelper {
+    private UUVPlaywrightCucumberMap;
+    testDir: string;
+    private queries;
+    envelopes: Envelope[];
+    private testCasesAndTestCasesStartedIdMap;
+    private testCasesAndPickleIdMap;
+    private testCasesTestStepStartedIdMap;
+    private testStepLocationAndTestStepIdMap;
+    private consoleReportMap;
+    private errors;
+    createTestRunStartedEnvelope(config: FullConfig, suite: Suite, startTimestamp: {
+        seconds: number;
+        nanos: number;
+    }): void;
+    createTestCaseStartedEnvelope(test: TestCase, result: TestResult, featureFile: string, startTimestamp: {
+        seconds: number;
+        nanos: number;
+    }): void;
+    createTestStepStartedEnvelope(test: TestCase, step: TestStep, featureFile: string, startTimestamp: {
+        seconds: number;
+        nanos: number;
+    }): void;
+    private createTestStepSkippedEnvelope;
+    createTestStepFinishedEnvelope(test: TestCase, step: TestStep, result: TestResult, featureFile: string, startTimestamp: {
+        seconds: number;
+        nanos: number;
+    }): void;
+    private getTestStepKey;
+    createTestCaseFinishedEnvelope(test: TestCase, result: TestResult, featureFile: string, endTimestamp: any): void;
+    private initConsoleReportIfNotExists;
+    private updateConsoleReport;
+    createTestRunFinishedEnvelope(result: FullResult): void;
+    generateReport(reportType: GeneratedReportType): Promise<void>;
+    getTimestamp(inpuDate?: Date): {
+        seconds: number;
+        nanos: number;
+    };
+    getOriginalFeatureFile(generateFile: string): string | undefined;
+    getCurrentRunningScenario(test: TestCase, featureFile: string): string;
+    addError(newError: TestError): void;
+    private getStatus;
+    private createEnvelope;
+    private createCucumberNdJsonFile;
+    private loadUUVPlaywrightCucumberMap;
+    private initializeCucumberReportNdJson;
+    private populateTestCasesAndPickleIdMap;
+    private generateTestStep;
+    private createStepDefinitionEnvelope;
+    private getFeatureFiles;
+    private formatCucumberMessageFile;
+    private generateHtmlReportFromJson;
+    private generateHtmlReport;
+    private createdDirIfNeeded;
+    private displayConsoleReport;
+}
+export default UuvPlaywrightReporterHelper;