@atomicsmash/test-utils 3.0.0 → 4.0.0-beta.1

package/dist/index.d.ts

@@ -1,11 +1,15 @@
-import type { Page, BrowserContext, PlaywrightTestConfig } from "@playwright/test";
+import type { Page, Browser, PlaywrightTestConfig, PlaywrightTestArgs, PlaywrightTestOptions } from "@playwright/test";
 import type { SerialFrameSelector } from "axe-core";
+export type WordPressUserRole = "unauthenticated" | "subscriber" | "contributor" | "author" | "editor" | "admin" | "super-admin";
+export type WooCommerceUserRole = "customer" | "shop-manager";
+export type UserRole = WordPressUserRole | WooCommerceUserRole;
 export type PageList = {
     url: string;
     name: string;
     slug?: string;
-    restrictedAccess?: boolean;
+    minimumUserPrivilege?: UserRole;
 }[];
+export declare function doesRoleHaveHighEnoughPermissions(userRole: WordPressUserRole | WooCommerceUserRole, minimumRolePermission: WordPressUserRole | WooCommerceUserRole): boolean;
 export type AuthenticatePageFunction = ({ page }: {
     page: Page;
 }, use: (r: Page) => Promise<void>) => Promise<void>;
@@ -27,14 +31,16 @@ export declare const playwrightConfig: {
     snapshotDir: string;
     snapshotPathTemplate: string;
 };
-export declare const getLighthouseTest: (logInUser: AuthenticatePageFunction) => import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
-    authenticatedPage: Page;
-    context: BrowserContext;
-}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & {
+export declare const lighthouseTest: import("playwright/test").TestType<PlaywrightTestArgs & PlaywrightTestOptions, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & {
     port: number;
+    browser: Browser;
 }>;
-type LighthouseTestFunction = Parameters<ReturnType<typeof getLighthouseTest>>[2];
-export declare const doLighthouseTest: (pageToTest: PageList[number], type: "desktop" | "mobile", disableAuditLogs?: boolean) => LighthouseTestFunction;
+type LighthouseTestFunction = Parameters<typeof lighthouseTest>[2];
+export declare const doLighthouseTest: (pageToTest: {
+    url: string | (() => string | Promise<string>);
+    name: string;
+    slug?: string;
+}, type: "desktop" | "mobile", disableAuditLogs?: boolean) => LighthouseTestFunction;
 export declare function checkAccessibility(page: Page, { includes, excludes, }?: {
     includes?: SerialFrameSelector[];
     excludes?: SerialFrameSelector[];
@@ -42,10 +48,10 @@ export declare function checkAccessibility(page: Page, { includes, excludes, }?:
 export declare const checkPrivilegedPages: (pagesToTest: PageList) => ({ page }: {
     page: Page;
 }) => Promise<void>;
-export declare const checkForLoremIpsum: (pagesToTest: PageList) => ({ authenticatedPage }: {
-    authenticatedPage: Page;
+export declare const checkForLoremIpsum: (pagesToTest: PageList) => ({ page }: {
+    page: Page;
 }) => Promise<void>;
 export declare function slugify(stringToSlugify: string): string;
-export declare function generateProjectsForAllBrowsers(baseProject: NonNullable<PlaywrightTestConfig["projects"]>[number]): import("@playwright/test").Project<import("@playwright/test").PlaywrightTestOptions & {}, import("@playwright/test").PlaywrightWorkerOptions & {}>[];
+export declare function generateProjectsForAllBrowsers(baseProject: NonNullable<PlaywrightTestConfig["projects"]>[number]): import("playwright/test").Project<PlaywrightTestOptions & {}, import("playwright/test").PlaywrightWorkerOptions & {}>[];
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,IAAI,EACJ,cAAc,EACd,oBAAoB,EACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAapD,MAAM,MAAM,QAAQ,GAAG;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC3B,EAAE,CAAC;AAEJ,MAAM,MAAM,wBAAwB,GAAG,CACtC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,EACxB,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,KAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;CAkBG,CAAC;AAEjC,eAAO,MAAM,iBAAiB,cAAe,wBAAwB;uBAE9C,IAAI;aAAW,cAAc;;UAC1C,MAAM;EA0Bf,CAAC;AAEF,KAAK,sBAAsB,GAAG,UAAU,CACvC,UAAU,CAAC,OAAO,iBAAiB,CAAC,CACpC,CAAC,CAAC,CAAC,CAAC;AAEL,eAAO,MAAM,gBAAgB,EAAE,CAC9B,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC5B,IAAI,EAAE,SAAS,GAAG,QAAQ,EAC1B,gBAAgB,CAAC,EAAE,OAAO,KACtB,sBA+BH,CAAC;AAEH,wBAAsB,kBAAkB,CACvC,IAAI,EAAE,IAAI,EACV,EACC,QAAQ,EACR,QAAQ,GACR,GAAE;IACF,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC5B,iBAiCN;AAED,eAAO,MAAM,oBAAoB,wCAEf;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,kBAS9B,CAAC;AACH,eAAO,MAAM,kBAAkB,qDAEA;IAAE,iBAAiB,EAAE,IAAI,CAAA;CAAE,kBASxD,CAAC;AAEH,wBAAgB,OAAO,CAAC,eAAe,EAAE,MAAM,UAU9C;AAED,wBAAgB,8BAA8B,CAC7C,WAAW,EAAE,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,wJAqDlE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,IAAI,EACJ,OAAO,EACP,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAWpD,MAAM,MAAM,iBAAiB,GAC1B,iBAAiB,GACjB,YAAY,GACZ,aAAa,GACb,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,aAAa,CAAC;AACjB,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,cAAc,CAAC;AAC9D,MAAM,MAAM,QAAQ,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;AAC/D,MAAM,MAAM,QAAQ,GAAG;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,QAAQ,CAAC;CAChC,EAAE,CAAC;AAEJ,wBAAgB,iCAAiC,CAChD,QAAQ,EAAE,iBAAiB,GAAG,mBAAmB,EACjD,qBAAqB,EAAE,iBAAiB,GAAG,mBAAmB,GAC5D,OAAO,CAiDT;AAED,MAAM,MAAM,wBAAwB,GAAG,CACtC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,EACxB,GAAG,EAAE,CAAC,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,KAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;CAkBG,CAAC;AAEjC,eAAO,MAAM,cAAc;UAElB,MAAM;aAAW,OAAO;EAqB/B,CAAC;AAEH,KAAK,sBAAsB,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnE,eAAO,MAAM,gBAAgB,EAAE,CAC9B,UAAU,EAAE;IACX,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,EACD,IAAI,EAAE,SAAS,GAAG,QAAQ,EAC1B,gBAAgB,CAAC,EAAE,OAAO,KACtB,sBAkCH,CAAC;AAEH,wBAAsB,kBAAkB,CACvC,IAAI,EAAE,IAAI,EACV,EACC,QAAQ,EACR,QAAQ,GACR,GAAE;IACF,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAC5B,iBAiCN;AAED,eAAO,MAAM,oBAAoB,gBAClB,QAAQ,gBACL;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,kBAO9B,CAAC;AACH,eAAO,MAAM,kBAAkB,gBAChB,QAAQ,gBACL;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,kBAO9B,CAAC;AAEH,wBAAgB,OAAO,CAAC,eAAe,EAAE,MAAM,UAU9C;AAED,wBAAgB,8BAA8B,CAC7C,WAAW,EAAE,WAAW,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,2HAqDlE"}

package/dist/index.js

@@ -1,5 +1,3 @@
-import os from "node:os";
-import path from "node:path";
 import { AxeBuilder } from "@axe-core/playwright";
 import { test as base, chromium, devices } from "@playwright/test";
 import getPort from "get-port";
@@ -7,6 +5,52 @@ import lighthouseDesktopConfig from "lighthouse/core/config/lr-desktop-config.js
 import lighthouseMobileConfig from "lighthouse/core/config/lr-mobile-config.js";
 import { playAudit } from "playwright-lighthouse";
 const { expect } = base;
+export function doesRoleHaveHighEnoughPermissions(userRole, minimumRolePermission) {
+    if (userRole === minimumRolePermission) {
+        return true;
+    }
+    switch (userRole) {
+        case "super-admin":
+            return true;
+        case "admin":
+            return minimumRolePermission !== "super-admin";
+        case "shop-manager":
+            return !["super-admin", "admin"].includes(minimumRolePermission);
+        case "editor":
+            return !["super-admin", "admin", "shop-manager"].includes(minimumRolePermission);
+        case "author":
+            return !["super-admin", "admin", "shop-manager", "editor"].includes(minimumRolePermission);
+        case "contributor":
+            return ![
+                "super-admin",
+                "admin",
+                "shop-manager",
+                "editor",
+                "author",
+            ].includes(minimumRolePermission);
+        case "customer":
+            return ![
+                "super-admin",
+                "admin",
+                "shop-manager",
+                "editor",
+                "author",
+                "contributor",
+            ].includes(minimumRolePermission);
+        case "subscriber":
+            return ![
+                "super-admin",
+                "admin",
+                "shop-manager",
+                "editor",
+                "author",
+                "contributor",
+                "customer",
+            ].includes(minimumRolePermission);
+        case "unauthenticated":
+            return minimumRolePermission === "unauthenticated";
+    }
+}
 export const playwrightConfig = {
     testDir: "./tests/e2e",
     timeout: 30 * 1000,
@@ -25,44 +69,39 @@ export const playwrightConfig = {
     snapshotDir: "./screenshots",
     snapshotPathTemplate: "{snapshotDir}/{platform}/{testFileName}-snapshots/{arg}{ext}",
 };
-export const getLighthouseTest = (logInUser) => {
-    const lighthouseTest = base.extend({
-        port: [
-            async (_unused, use) => {
-                // Assign a unique port for each playwright worker to support parallel tests
-                const port = await getPort();
-                await use(port);
-            },
-            { scope: "worker" },
-        ],
-        context: [
-            async ({ port }, use) => {
-                const userDataDir = path.join(os.tmpdir(), "pw", String(Math.random()));
-                const context = await chromium.launchPersistentContext(userDataDir, {
-                    args: [`--remote-debugging-port=${port}`],
-                });
-                await use(context);
-                await context.close();
-            },
-            { scope: "test" },
-        ],
-        authenticatedPage: [logInUser, { scope: "test" }],
-    });
-    lighthouseTest.describe.configure({ mode: "parallel", retries: 3 });
-    return lighthouseTest;
-};
-export const doLighthouseTest = (pageToTest, type, disableAuditLogs = false) => async function ({ port, authenticatedPage }) {
-    await authenticatedPage.goto(pageToTest.url);
+export const lighthouseTest = base.extend({
+    port: [
+        // eslint-disable-next-line no-empty-pattern -- destructure pattern is required by playwright
+        async ({}, use) => {
+            // Assign a unique port for each playwright worker to support parallel tests
+            const port = await getPort();
+            await use(port);
+        },
+        { scope: "worker" },
+    ],
+    browser: [
+        async ({ port }, use) => {
+            const browser = await chromium.launch({
+                args: [`--remote-debugging-port=${port}`],
+            });
+            await use(browser);
+        },
+        { scope: "worker" },
+    ],
+});
+export const doLighthouseTest = (pageToTest, type, disableAuditLogs = false) => async function ({ page, port }) {
+    await page.goto(typeof pageToTest.url === "string"
+        ? pageToTest.url
+        : await pageToTest.url());
     await playAudit({
-        // TODO: Wait for playwright-lighthouse to update dependency constraint, then remove this "as" declaration.
-        page: authenticatedPage,
+        page,
+        port,
         thresholds: {
             performance: 85,
             accessibility: 85,
             "best-practices": 85,
             seo: 85,
         },
-        port: port,
         reports: {
             formats: {
                 html: true,
@@ -76,7 +115,7 @@ export const doLighthouseTest = (pageToTest, type, disableAuditLogs = false) =>
         ignoreError: true,
         disableLogs: disableAuditLogs,
     });
-    await authenticatedPage.goto(`file://${process.cwd()}/lighthouse/latest-lighthouse-report/${pageToTest.slug ?? slugify(pageToTest.name)}-${type}.html`);
+    await page.goto(`file://${process.cwd()}/lighthouse/latest-lighthouse-report/${pageToTest.slug ?? slugify(pageToTest.name)}-${type}.html`);
 };
 export async function checkAccessibility(page, { includes, excludes, } = {}) {
     let builder;
@@ -105,17 +144,17 @@ export async function checkAccessibility(page, { includes, excludes, } = {}) {
     })).toEqual([]);
 }
 export const checkPrivilegedPages = (pagesToTest) => async ({ page }) => {
-    for (const pageToTest of pagesToTest.filter((page) => page.restrictedAccess)) {
+    for (const pageToTest of pagesToTest) {
         const response = await page.goto(pageToTest.url);
         expect(response).not.toBeNull();
         const nonNullResponse = response;
         expect(nonNullResponse.status()).toBe(401);
     }
 };
-export const checkForLoremIpsum = (pagesToTest) => async ({ authenticatedPage }) => {
+export const checkForLoremIpsum = (pagesToTest) => async ({ page }) => {
     for (const pageToTest of pagesToTest) {
-        await authenticatedPage.goto(pageToTest.url);
-        await expect(authenticatedPage.getByText("Lorem ipsum")).not.toBeAttached({
+        await page.goto(pageToTest.url);
+        await expect(page.getByText("Lorem ipsum")).not.toBeAttached({
             timeout: 100,
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atomicsmash/test-utils",
-	"version": "3.0.0",
+	"version": "4.0.0-beta.1",
 	"type": "module",
 	"description": "A collection of helper functions for automated testing with Playwright.",
 	"keywords": [