@uuv/playwright 1.15.0 → 2.0.0

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

@@ -1,292 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const runner_commons_1 = require("@uuv/runner-commons");
-const axe_playwright_1 = require("axe-playwright");
-const test_1 = require("@playwright/test");
-const core_engine_1 = require("./core-engine");
-const cucumber_1 = require("@cucumber/cucumber");
-const path_1 = __importDefault(require("path"));
-(0, cucumber_1.Given)(`${runner_commons_1.key.given.viewport.preset}`, async function (viewportPreset) {
-    await this.page.setViewportSize(test_1.devices[viewportPreset].viewport);
-});
-(0, cucumber_1.Given)(`${runner_commons_1.key.given.viewport.withWidthAndHeight}`, async function (width, height) {
-    await this.page.setViewportSize({ width: width, height: height });
-});
-(0, cucumber_1.Given)(`${runner_commons_1.key.when.visit}`, { timeout: 60 * 1000 }, async function (siteUrl) {
-    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.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", " ");
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByLabel(sanitizedExpectedAriaLabel, { exact: true })).toHaveCount(1));
-    await (0, core_engine_1.addCookieWhenValueIsList)(this, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT, { name: core_engine_1.FILTER_TYPE.ARIA_LABEL, value: sanitizedExpectedAriaLabel });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.resetContext}`, async function () {
-    await this.context.clearCookies();
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.withinElement.selector}`, async function (selector) {
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.locator(selector)).toHaveCount(1));
-    await (0, core_engine_1.addCookieWhenValueIsList)(this, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT, { name: core_engine_1.FILTER_TYPE.SELECTOR, value: selector });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.type}`, async function (textToType) {
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-        await element.focus({ timeout: 10000 });
-        await element.type(textToType);
-        // console.debug(await showAttributesInLocator(element));
-    });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.keyboard.multiplePress}`, async function (nbTimes, key) {
-    for (let i = 1; i <= nbTimes; i++) {
-        await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-            await element.focus({ timeout: 10000 });
-            await pressKey(this, element, key);
-        });
-    }
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.keyboard.press}`, async function (key) {
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-        await element.focus({ timeout: 10000 });
-        await pressKey(this, element, key);
-    });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.timeout}`, async function (newTimeout) {
-    await this.testInfo.setTimeout(newTimeout);
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.withinElement.roleAndName}`, async function (role, name) {
-    await (0, core_engine_1.withinRoleAndName)(this, role, name);
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.withinElement.testId}`, async function (testId) {
-    testId = encodeURIComponent(testId);
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => await (0, test_1.expect)(element.getByTestId(testId)).toHaveCount(1));
-    await (0, core_engine_1.addCookieWhenValueIsList)(this, core_engine_1.COOKIE_NAME.SELECTED_ELEMENT, { name: core_engine_1.FILTER_TYPE.TEST_ID, value: testId });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.mock.withBody}`, async function (verb, url, name, body) {
-    await (0, core_engine_1.addCookieWhenValueIsList)(this, core_engine_1.COOKIE_NAME.MOCK_URL, { name: name, url: url });
-    await this.page.route(url, async (route) => {
-        const json = body;
-        await route.fulfill({ json });
-    });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.mock.withStatusCode}`, async function (verb, url, name, statusCode) {
-    await (0, core_engine_1.addCookieWhenValueIsList)(this, core_engine_1.COOKIE_NAME.MOCK_URL, { name: name, url: url });
-    await this.page.route(url, async (route) => {
-        await route.fulfill({ status: statusCode });
-    });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.mock.withFixture}`, async function (verb, url, name, fixture) {
-    await (0, core_engine_1.addCookieWhenValueIsList)(this, core_engine_1.COOKIE_NAME.MOCK_URL, { name: name, url: url });
-    const data = await runner_commons_1.fs.readFileSync(path_1.default.join(getConfigDir(), `playwright/fixtures/${fixture}`));
-    await this.page.route(url, async (route) => {
-        await route.fulfill({ body: data });
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withSelector}`, async function (selector) {
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.locator(selector)).toHaveCount(1));
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.headers.forUriAndMethod}`, async function (url, method, headersToSet) {
-    await this.page.route(url, async (route) => {
-        const headers = route.request().headers();
-        await route.continue({ headers: { ...headers, ...headersToSet.rowsHash() } });
-    });
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.headers.forUri}`, async function (url, headersToSet) {
-    await this.page.route(url, async (route) => {
-        const headers = route.request().headers();
-        await route.continue({ headers: { ...headers, ...headersToSet.rowsHash() } });
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndName}`, async function (role, name) {
-    await (0, core_engine_1.findWithRoleAndName)(this, role, name);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withContent}`, async function (textContent) {
-    // TODO partie pris de faire en exactitude. A voir si on doit faire 2 phrases https://playwright.dev/docs/api/class-locator#locator-get-by-text
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByText(textContent, { exact: true })).toHaveCount(1));
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.not.withContent}`, async function (textContent) {
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByText(textContent, { exact: true })).toHaveCount(0));
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withTestId}`, async function (testId) {
-    testId = encodeURIComponent(testId);
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByTestId(testId, { exact: true })).toHaveCount(1));
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.not.withTestId}`, async function (testId) {
-    testId = encodeURIComponent(testId);
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByTestId(testId, { exact: true })).toHaveCount(0));
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.a11y.check.default}`, async function () {
-    await (0, axe_playwright_1.injectAxe)(this.page);
-    await (0, axe_playwright_1.checkA11y)(this.page);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.a11y.check.withFixtureOption}`, async function (option) {
-    await (0, axe_playwright_1.injectAxe)(this.page);
-    const optionFile = await runner_commons_1.fs.readFileSync(path_1.default.join(getConfigDir(), `playwright/fixtures/${option}`));
-    const optionJson = JSON.parse(optionFile.toString());
-    await (0, axe_playwright_1.checkA11y)(this.page, undefined, {
-        axeOptions: optionJson
-    });
-});
-function getConfigDir() {
-    return process.env["CONFIG_DIR"] ? process.env["CONFIG_DIR"] : "";
-}
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.a11y.check.withFixtureContextAndFixtureOption}`, async function (context, option) {
-    await (0, axe_playwright_1.injectAxe)(this.page);
-    const contextFile = await runner_commons_1.fs.readFileSync(path_1.default.join(getConfigDir(), `playwright/fixtures/${context}`));
-    const optionFile = await runner_commons_1.fs.readFileSync(path_1.default.join(getConfigDir(), `playwright/fixtures/${option}`));
-    const optionJson = JSON.parse(optionFile.toString());
-    await (0, axe_playwright_1.checkA11y)(this.page, JSON.parse(contextFile.toString()), {
-        axeOptions: optionJson
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.a11y.check.onlyCritical}`, async function () {
-    await (0, axe_playwright_1.injectAxe)(this.page);
-    await (0, axe_playwright_1.checkA11y)(this.page, undefined, {
-        includedImpacts: ["critical"]
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.a11y.check.withImpacts}`, async function (impacts) {
-    await (0, axe_playwright_1.injectAxe)(this.page);
-    await (0, axe_playwright_1.checkA11y)(this.page, undefined, {
-        includedImpacts: [impacts]
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.a11y.check.withTags}`, async function (tags) {
-    await (0, axe_playwright_1.injectAxe)(this.page);
-    await (0, axe_playwright_1.checkA11y)(this.page, undefined, {
-        axeOptions: {
-            runOnly: {
-                type: "tag",
-                values: [tags]
-            }
-        }
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.not.withRoleAndName}`, async function (role, name) {
-    await (0, core_engine_1.notFoundWithRoleAndName)(this, role, name);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndNameAndContent}`, async function (expectedRole, name, expectedTextContent) {
-    await (0, core_engine_1.findWithRoleAndNameAndContent)(this, expectedRole, name, expectedTextContent);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndNameAndContentDisabled}`, async function (expectedRole, name, expectedTextContent) {
-    await (0, core_engine_1.findWithRoleAndNameAndContentDisable)(this, expectedRole, name, expectedTextContent);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndNameAndContentEnabled}`, async function (expectedRole, name, expectedTextContent) {
-    await (0, core_engine_1.findWithRoleAndNameAndContentEnable)(this, expectedRole, name, expectedTextContent);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withAriaLabel}`, async function (expectedAriaLabel) {
-    expectedAriaLabel = encodeURIComponent(expectedAriaLabel);
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByLabel(expectedAriaLabel, { exact: true })).toHaveCount(1));
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.not.withAriaLabel}`, async function (expectedAriaLabel) {
-    expectedAriaLabel = encodeURIComponent(expectedAriaLabel);
-    await (0, core_engine_1.getPageOrElement)(this).then((element) => (0, test_1.expect)(element.getByLabel(expectedAriaLabel, { exact: true })).toHaveCount(0));
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withAriaLabelAndContent}`, async function (expectedAriaLabel, expectedTextContent) {
-    expectedAriaLabel = encodeURIComponent(expectedAriaLabel);
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-        const byLabel = await element.getByLabel(expectedAriaLabel, { exact: true });
-        await (0, test_1.expect)(byLabel).toHaveCount(1);
-        await (0, test_1.expect)(byLabel.filter({ hasText: expectedTextContent })).toHaveCount(1);
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.wait.mock}`, async function (name) {
-    const cookie = await (0, core_engine_1.getCookie)(this, core_engine_1.COOKIE_NAME.MOCK_URL);
-    const mockUrls = JSON.parse(cookie.value);
-    const mockUrl = mockUrls.find(mock => mock.name === name);
-    await (0, test_1.expect)(mockUrl).not.toBeUndefined();
-    const requestPromise = await this.page.waitForResponse(mockUrl?.url);
-    const request = await requestPromise;
-    await (0, core_engine_1.deleteCookieByValue)(this, core_engine_1.COOKIE_NAME.MOCK_URL, mockUrl);
-    // console.debug("request: ", request);
-});
-//
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.wait.milliSeconds}`, async function (ms) {
-    await this.page.waitForTimeout(ms);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.attributes.withValues}`, async function (expectedAttributeList) {
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-        // console.debug("expectedAttributeList.raw(),", expectedAttributeList.raw())
-        for (const expectedAttribute of expectedAttributeList.raw()) {
-            const attributeName = expectedAttribute[0];
-            const attributeValue = expectedAttribute[1];
-            // await showAttributesInLocator(element);
-            (0, test_1.expect)(await element.getAttribute(attributeName)).toEqual(attributeValue);
-        }
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.list.withNameAndContent}`, async function (expectedListName, expectedElementsOfList) {
-    await (0, core_engine_1.withinRoleAndName)(this, "list", expectedListName);
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-        const listitem = await element.getByRole("listitem", { exact: true }).all();
-        const foundedElement = [];
-        for (const element of listitem) {
-            const textContent = await element.textContent();
-            foundedElement.push([textContent]);
-        }
-        await (0, test_1.expect)(foundedElement.length).toBeGreaterThan(0);
-        // console.debug(`expected [${expectedElementsOfList.raw()}] to be [${foundedElement}]`);
-        await (0, test_1.expect)(listitem.length).toEqual(expectedElementsOfList.raw().length);
-        await (0, test_1.expect)(foundedElement).toEqual(expectedElementsOfList.raw());
-    });
-});
-async function pressKey(world, element, key) {
-    switch (key) {
-        case runner_commons_1.KEY_PRESS.TAB:
-            await element.press("Tab");
-            break;
-        case runner_commons_1.KEY_PRESS.REVERSE_TAB:
-            await element.press("ShiftLeft+Tab");
-            break;
-        case runner_commons_1.KEY_PRESS.UP:
-            await element.press("ArrowUp");
-            break;
-        case runner_commons_1.KEY_PRESS.DOWN:
-            await element.press("ArrowDown");
-            break;
-        case runner_commons_1.KEY_PRESS.LEFT:
-            await element.press("ArrowLeft");
-            break;
-        case runner_commons_1.KEY_PRESS.RIGHT:
-            await element.press("ArrowRight");
-            break;
-        default:
-            console.error("the command" + key + " is unrecognized.");
-            break;
-    }
-    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/based-role-check-engine.d.ts

@@ -1,15 +0,0 @@
-/**
-* 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/cucumber/step_definitions/playwright/based-role-check-engine.js

@@ -1,46 +0,0 @@
-"use strict";
-/**
-* 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.
-*/
-Object.defineProperty(exports, "__esModule", { value: true });
-const runner_commons_1 = require("@uuv/runner-commons");
-const cucumber_1 = require("@cucumber/cucumber");
-const core_engine_1 = require("./core-engine");
-const test_1 = require("@playwright/test");
-(0, cucumber_1.When)(`${runner_commons_1.key.when.withinElement.roleAndName}`, async function (name) {
-    return await (0, core_engine_1.withinRoleAndName)(this, "$roleId", name);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndName}`, async function (name) {
-    await (0, core_engine_1.findWithRoleAndName)(this, "$roleId", name);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.not.withRoleAndName}`, async function (name) {
-    await (0, core_engine_1.notFoundWithRoleAndName)(this, "$roleId", name);
-});
-(0, cucumber_1.When)(`${runner_commons_1.key.when.type}`, async function (textToType, name) {
-    await (0, core_engine_1.getPageOrElement)(this).then(async (element) => {
-        const byRole = await element.getByRole("$roleId", { name: name, includeHidden: true, exact: true });
-        await (0, test_1.expect)(byRole).toHaveCount(1);
-        await byRole.type(textToType);
-        await this.context.clearCookies();
-    });
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndNameAndContent}`, async function (name, expectedTextContent) {
-    await (0, core_engine_1.findWithRoleAndNameAndContent)(this, "$roleId", name, expectedTextContent);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndNameAndContentDisabled}`, async function (name, expectedTextContent) {
-    await (0, core_engine_1.findWithRoleAndNameAndContentDisable)(this, "$roleId", name, expectedTextContent);
-});
-(0, cucumber_1.Then)(`${runner_commons_1.key.then.element.withRoleAndNameAndContentEnabled}`, async function (name, expectedTextContent) {
-    await (0, core_engine_1.findWithRoleAndNameAndContentEnable)(this, "$roleId", name, expectedTextContent);
-});