@uuv/playwright 1.8.2 → 1.10.0

package/dist/cucumber/step_definitions/playwright/base-check-engine.js

@@ -29,9 +29,15 @@ const cucumber_1 = require("@cucumber/cucumber");
     await (0, core_engine_1.deleteCookieByName)(this, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT);
     await this.page.goto(`${siteUrl}`);
 });
-(0, cucumber_1.When)(`${runner_commons_1.key.when.click}`, async function () {
+(0, cucumber_1.When)(`${runner_commons_1.key.when.click.withContext}`, async function () {
     await (0, core_engine_1.getPageOrElement)(this).then((element) => element.click({ timeout: runner_commons_1.DEFAULT_TIMEOUT }));
 });
+(0, cucumber_1.When)(`${runner_commons_1.key.when.click.button}`, async function (name) {
+    await click(this, "button", name);
+});
+(0, cucumber_1.When)(`${runner_commons_1.key.when.click.withRole}`, async function (role, name) {
+    await click(this, role, name);
+});
 // TODO : permet de gérer les label accessibles donc pas que les aria : https://playwright.dev/docs/api/class-locator#locator-get-by-label
 (0, cucumber_1.When)(`${runner_commons_1.key.when.withinElement.ariaLabel}`, async function (expectedAriaLabel) {
     const sanitizedExpectedAriaLabel = encodeURIComponent(expectedAriaLabel).replaceAll("%20", " ");
@@ -269,3 +275,11 @@ async function pressKey(world, element, key) {
     await (0, core_engine_1.deleteCookieByName)(world, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT);
     await (0, core_engine_1.addCookieWhenValueIsList)(world, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT, { name: core_engine_1.FILTER_TYPE.SELECTOR_PARENT, value: "*:focus" });
 }
+async function click(world, role, name) {
+    await (0, core_engine_1.getPageOrElement)(world).then(async (element) => {
+        const byRole = await element.getByRole(role, { name: name, includeHidden: true, exact: true });
+        await (0, test_1.expect)(byRole).toHaveCount(1);
+        await byRole.click({ timeout: runner_commons_1.DEFAULT_TIMEOUT });
+        await world.context.clearCookies();
+    });
+}

package/dist/cucumber/step_definitions/playwright/core-engine.d.ts

@@ -43,10 +43,10 @@ export declare function addCookieWhenValueIsList(world: World, cookieName: COOKI
 export declare function getCookie(world: World, cookieName: COOKIE_NAME): Promise<Cookie>;
 export declare function deleteCookieByValue(world: World, cookieName: COOKIE_NAME, node: any): Promise<void>;
 export declare function deleteCookieByName(world: World, cookieName: COOKIE_NAME): Promise<void>;
-export declare function findWithRoleAndName(world: World, role: string, name: string): Promise<void>;
+export declare function findWithRoleAndName(world: World, role: string, name: string): Promise<any>;
 export declare function withinRoleAndName(world: World, role: string, name: string): Promise<void>;
 export declare function notFoundWithRoleAndName(world: World, role: string, name: string): Promise<void>;
-export declare function findWithRoleAndNameAndContent(world: World, expectedRole: string, name: string, expectedTextContent?: string | undefined): Promise<void>;
+export declare function findWithRoleAndNameAndContent(world: World, expectedRole: string, name: string, expectedTextContent?: string | undefined): Promise<any>;
 export declare function findWithRoleAndNameAndContentDisable(world: World, expectedRole: string, name: string, expectedTextContent: string): Promise<void>;
 export declare function findWithRoleAndNameAndContentEnable(world: World, expectedRole: string, name: string, expectedTextContent: string): Promise<void>;
 export declare function showAttributesInLocator(element: any): Promise<void>;

package/dist/cucumber/step_definitions/playwright/generated/_en-generated-cucumber-steps-definition.js

@@ -35,6 +35,12 @@ const cucumber_1 = require("@cucumber/cucumber");
 (0, cucumber_1.When)(`I click`, async function () {
     await (0, core_engine_1.getPageOrElement)(this).then((element) => element.click({ timeout: runner_commons_1.DEFAULT_TIMEOUT }));
 });
+(0, cucumber_1.When)(`I click on button named {string}`, async function (name) {
+    await click(this, "button", name);
+});
+(0, cucumber_1.When)(`I click on element with role {string} and name {string}`, async function (role, name) {
+    await click(this, role, name);
+});
 // TODO : permet de gérer les label accessibles donc pas que les aria : https://playwright.dev/docs/api/class-locator#locator-get-by-label
 (0, cucumber_1.When)(`Within the element with aria-label {string}`, async function (expectedAriaLabel) {
     const sanitizedExpectedAriaLabel = encodeURIComponent(expectedAriaLabel).replaceAll("%20", " ");
@@ -272,3 +278,11 @@ async function pressKey(world, element, key) {
     await (0, core_engine_1.deleteCookieByName)(world, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT);
     await (0, core_engine_1.addCookieWhenValueIsList)(world, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT, { name: core_engine_1.FILTER_TYPE.SELECTOR_PARENT, value: "*:focus" });
 }
+async function click(world, role, name) {
+    await (0, core_engine_1.getPageOrElement)(world).then(async (element) => {
+        const byRole = await element.getByRole(role, { name: name, includeHidden: true, exact: true });
+        await (0, test_1.expect)(byRole).toHaveCount(1);
+        await byRole.click({ timeout: runner_commons_1.DEFAULT_TIMEOUT });
+        await world.context.clearCookies();
+    });
+}

package/dist/cucumber/step_definitions/playwright/generated/_fr-generated-cucumber-steps-definition.js

@@ -35,6 +35,12 @@ const cucumber_1 = require("@cucumber/cucumber");
 (0, cucumber_1.When)(`je clique`, async function () {
     await (0, core_engine_1.getPageOrElement)(this).then((element) => element.click({ timeout: runner_commons_1.DEFAULT_TIMEOUT }));
 });
+(0, cucumber_1.When)(`je clique sur le bouton nommé {string}`, async function (name) {
+    await click(this, "button", name);
+});
+(0, cucumber_1.When)(`je clique sur l'élément avec le rôle {string} et le nom {string}`, async function (role, name) {
+    await click(this, role, name);
+});
 // TODO : permet de gérer les label accessibles donc pas que les aria : https://playwright.dev/docs/api/class-locator#locator-get-by-label
 (0, cucumber_1.When)(`je vais à l'intérieur de l'élément ayant pour aria-label {string}`, async function (expectedAriaLabel) {
     const sanitizedExpectedAriaLabel = encodeURIComponent(expectedAriaLabel).replaceAll("%20", " ");
@@ -272,3 +278,11 @@ async function pressKey(world, element, key) {
     await (0, core_engine_1.deleteCookieByName)(world, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT);
     await (0, core_engine_1.addCookieWhenValueIsList)(world, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT, { name: core_engine_1.FILTER_TYPE.SELECTOR_PARENT, value: "*:focus" });
 }
+async function click(world, role, name) {
+    await (0, core_engine_1.getPageOrElement)(world).then(async (element) => {
+        const byRole = await element.getByRole(role, { name: name, includeHidden: true, exact: true });
+        await (0, test_1.expect)(byRole).toHaveCount(1);
+        await byRole.click({ timeout: runner_commons_1.DEFAULT_TIMEOUT });
+        await world.context.clearCookies();
+    });
+}

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

@@ -17,4 +17,5 @@ export interface UUVPlaywrightCucumberMapItem {
     generatedFile: string;
 }
 export declare const UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
+export declare function executePreprocessor(tempDir: string, configDir: string): Promise<void>;
 export declare function run(mode: "open" | "e2e", tempDir?: string, configDir?: string, generateHtmlReport?: boolean, env?: any, targetTestFile?: string): Promise<void>;

package/dist/lib/runner-playwright.js

@@ -13,16 +13,40 @@
 * 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);
+    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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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;
+exports.run = exports.executePreprocessor = 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 child_process_1 = __importStar(require("child_process"));
 const uuv_playwright_reporter_helper_1 = require("../reporter/uuv-playwright-reporter-helper");
+const path_1 = __importDefault(require("path"));
 exports.UUVPlaywrightCucumberMapFile = ".uuv-playwright-cucumber-map.json";
 async function bddGen(tempDir) {
     try {
@@ -123,8 +147,12 @@ async function executePreprocessor(tempDir, configDir) {
     translateFeatures(tempDir, configDir);
     console.log("preprocessor executed");
 }
+exports.executePreprocessor = executePreprocessor;
 async function run(mode, tempDir = "uuv/.features-gen/e2e", configDir = "uuv", generateHtmlReport = false, env, targetTestFile) {
     await executePreprocessor(tempDir, configDir);
+    if (mode === "open") {
+        child_process_1.default.fork(path_1.default.join(__dirname, "watch-test-files"), [tempDir, configDir]);
+    }
     runPlaywright(mode, configDir, generateHtmlReport, env, targetTestFile);
 }
 exports.run = run;

package/dist/lib/watch-test-files.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Software Name : UUV
+ *
+ * SPDX-FileCopyrightText: Copyright (c) 2022-2023 Orange
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT License,
+ * the text of which is available at https://spdx.org/licenses/MIT.html
+ * or see the "LICENSE" file for more details.
+ *
+ * Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+ * Software description: Make test writing fast, understandable by any human
+ * understanding English or French.
+ */
+export {};

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

@@ -0,0 +1,46 @@
+/**
+ * Software Name : UUV
+ *
+ * SPDX-FileCopyrightText: Copyright (c) 2022-2023 Orange
+ * SPDX-License-Identifier: MIT
+ *
+ * This software is distributed under the MIT License,
+ * the text of which is available at https://spdx.org/licenses/MIT.html
+ * or see the "LICENSE" file for more details.
+ *
+ * Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+ * Software description: Make test writing fast, understandable by any human
+ * understanding English or French.
+ */
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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];
+if (!tempDir || !configDir) {
+    console.log(chalk_1.default.redBright("An error occurred during test files watching"));
+    process.exit(-1);
+}
+chokidar_1.default.watch(`${configDir}/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);
+    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);
+    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);
+    console.log(chalk_1.default.yellowBright("Test files refreshed\n"));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/playwright",
-  "version": "1.8.2",
+  "version": "1.10.0",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to run E2E tests written in cucumber(BDD) with playwright.",
@@ -46,11 +46,12 @@
   "dependencies": {
     "@cucumber/cucumber": "9.3.0",
     "@playwright/test": "1.33.0",
-    "@uuv/runner-commons": "1.6.5",
+    "@uuv/runner-commons": "1.8.0",
     "axe-core": "4.7.2",
     "axe-playwright": "1.2.3",
     "chalk": "4.1.2",
     "chalk-table": "^1.0.2",
+    "chokidar": "3.5.3",
     "cucumber-json-report-formatter": "0.1.4",
     "figlet": "1.6.0",
     "minimist": "1.2.8",
@@ -89,7 +90,7 @@
   },
   "devDependencies": {
     "@types/minimist": "1.2.2",
-    "@types/node": "16.18.39",
+    "@types/node": "16.18.50",
     "cross-env": "7.0.3",
     "eslint-plugin-cucumber": "2.0.0",
     "eslint-plugin-jest": "27.2.3",

package/src/cucumber/step_definitions/playwright/generated/_en-generated-cucumber-steps-definition.ts

@@ -24,7 +24,7 @@ import { devices, expect } from "@playwright/test";
 import { Page } from "playwright";
 import { DataTable } from "@cucumber/cucumber";
 import {
-  addCookieWhenValueIsList,
+  addCookieWhenValueIsList, checkTextContentLocator,
   COOKIE_NAME, deleteCookieByName,
   deleteCookieByValue,
   FILTER_TYPE,
@@ -63,6 +63,15 @@ When(`I click`, async function(this: World) {
   await getPageOrElement(this).then((element: Locator) => element.click({ timeout: DEFAULT_TIMEOUT }));
 });
 
+
+When(`I click on button named {string}`, async function(this: World, name: string) {
+  await click(this, "button", name);
+});
+
+When(`I click on element with role {string} and name {string}`, async function(this: World, role: string, name: string) {
+  await click(this, role, name);
+});
+
 // TODO : permet de gérer les label accessibles donc pas que les aria : https://playwright.dev/docs/api/class-locator#locator-get-by-label
 When(`Within the element with aria-label {string}`, async function(this: World, expectedAriaLabel: string) {
   const sanitizedExpectedAriaLabel = encodeURIComponent(expectedAriaLabel).replaceAll("%20", " ");
@@ -381,4 +390,13 @@ async function pressKey(world: World, element: Locator, key: string) {
   await addCookieWhenValueIsList(world, COOKIE_NAME.SELECTED_ELEMENT, { name: FILTER_TYPE.SELECTOR_PARENT, value: "*:focus" });
 }
 
+async function click(world: World, role: any, name: string) {
+  await getPageOrElement(world).then(async (element) => {
+      const byRole = await element.getByRole(role, { name: name, includeHidden: true, exact: true });
+      await expect(byRole).toHaveCount(1);
+      await byRole.click({ timeout: DEFAULT_TIMEOUT });
+      await world.context.clearCookies();
+  });
+}
+
 

package/src/cucumber/step_definitions/playwright/generated/_fr-generated-cucumber-steps-definition.ts

@@ -24,7 +24,7 @@ import { devices, expect } from "@playwright/test";
 import { Page } from "playwright";
 import { DataTable } from "@cucumber/cucumber";
 import {
-  addCookieWhenValueIsList,
+  addCookieWhenValueIsList, checkTextContentLocator,
   COOKIE_NAME, deleteCookieByName,
   deleteCookieByValue,
   FILTER_TYPE,
@@ -63,6 +63,15 @@ When(`je clique`, async function(this: World) {
   await getPageOrElement(this).then((element: Locator) => element.click({ timeout: DEFAULT_TIMEOUT }));
 });
 
+
+When(`je clique sur le bouton nommé {string}`, async function(this: World, name: string) {
+  await click(this, "button", name);
+});
+
+When(`je clique sur l'élément avec le rôle {string} et le nom {string}`, async function(this: World, role: string, name: string) {
+  await click(this, role, name);
+});
+
 // TODO : permet de gérer les label accessibles donc pas que les aria : https://playwright.dev/docs/api/class-locator#locator-get-by-label
 When(`je vais à l'intérieur de l'élément ayant pour aria-label {string}`, async function(this: World, expectedAriaLabel: string) {
   const sanitizedExpectedAriaLabel = encodeURIComponent(expectedAriaLabel).replaceAll("%20", " ");
@@ -381,4 +390,13 @@ async function pressKey(world: World, element: Locator, key: string) {
   await addCookieWhenValueIsList(world, COOKIE_NAME.SELECTED_ELEMENT, { name: FILTER_TYPE.SELECTOR_PARENT, value: "*:focus" });
 }
 
+async function click(world: World, role: any, name: string) {
+  await getPageOrElement(world).then(async (element) => {
+      const byRole = await element.getByRole(role, { name: name, includeHidden: true, exact: true });
+      await expect(byRole).toHaveCount(1);
+      await byRole.click({ timeout: DEFAULT_TIMEOUT });
+      await world.context.clearCookies();
+  });
+}
+