@atomicsmash/test-utils 2.0.0-beta.0 → 3.0.0-beta.0

package/dist/index.d.ts

@@ -9,7 +9,6 @@ export type PageList = {
 export type AuthenticatePageFunction = ({ page }: {
     page: Page;
 }, use: (r: Page) => Promise<void>) => Promise<void>;
-export declare const playwrightProjectsConfig: PlaywrightTestConfig["projects"];
 export declare const playwrightConfig: {
     testDir: string;
     timeout: number;
@@ -20,12 +19,13 @@ export declare const playwrightConfig: {
     forbidOnly: boolean;
     retries: number;
     workers: number | undefined;
-    reporter: "dot";
-    projects: import("@playwright/test").Project<import("@playwright/test").PlaywrightTestOptions & {}, import("@playwright/test").PlaywrightWorkerOptions & {}>[];
+    reporter: "github" | "dot";
     use: {
         actionTimeout: number;
         trace: "on-first-retry";
     };
+    snapshotDir: string;
+    snapshotPathTemplate: string;
 };
 export declare const getLighthouseTest: (logInUser: AuthenticatePageFunction) => import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
     authenticatedPage: Page;
@@ -45,5 +45,7 @@ export declare const checkPrivilegedPages: (pagesToTest: PageList) => ({ page }:
 export declare const checkForLoremIpsum: (pagesToTest: PageList) => ({ authenticatedPage }: {
     authenticatedPage: 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 {};
 //# 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,wBAAwB,EAAE,oBAAoB,CAAC,UAAU,CA2BrE,CAAC;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;CAiBG,CAAC;AAEjC,eAAO,MAAM,iBAAiB,cAAe,wBAAwB;uBAE9C,IAAI;aAAW,cAAc;;UAC1C,MAAM;EA2Bf,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"}
+{"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"}

package/dist/index.js

@@ -7,34 +7,6 @@ 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 const playwrightProjectsConfig = [
-    {
-        name: "chromium",
-        use: { ...devices["Desktop Chrome"] },
-        grepInvert: /@mobile @lighthouse/,
-    },
-    {
-        name: "firefox",
-        use: { ...devices["Desktop Firefox"] },
-        grepInvert: /@lighthouse/,
-    },
-    {
-        name: "webkit",
-        use: { ...devices["Desktop Safari"] },
-        grepInvert: /@lighthouse/,
-    },
-    /* Test against mobile viewports. */
-    {
-        name: "Mobile Chrome",
-        use: { ...devices["Pixel 5"] },
-        grepInvert: /@desktop @lighthouse/,
-    },
-    {
-        name: "Mobile Safari",
-        use: { ...devices["iPhone 12"] },
-        grepInvert: /@lighthouse/,
-    },
-];
 export const playwrightConfig = {
     testDir: "./tests/e2e",
     timeout: 30 * 1000,
@@ -45,19 +17,18 @@ export const playwrightConfig = {
     forbidOnly: !!process.env.CI,
     retries: process.env.CI ? 2 : 0,
     workers: process.env.CI ? 1 : undefined,
-    reporter: "dot",
-    /* Configure projects for major browsers */
-    projects: playwrightProjectsConfig,
+    reporter: process.env.CI ? "github" : "dot",
     use: {
         actionTimeout: 0,
         trace: "on-first-retry",
     },
+    snapshotDir: "./screenshots",
+    snapshotPathTemplate: "{snapshotDir}/{platform}/{testFileName}-snapshots/{arg}{ext}",
 };
 export const getLighthouseTest = (logInUser) => {
     const lighthouseTest = base.extend({
         port: [
-            // eslint-disable-next-line no-empty-pattern
-            async ({}, use) => {
+            async (_unused, use) => {
                 // Assign a unique port for each playwright worker to support parallel tests
                 const port = await getPort();
                 await use(port);
@@ -149,7 +120,7 @@ export const checkForLoremIpsum = (pagesToTest) => async ({ authenticatedPage })
         });
     }
 };
-function slugify(stringToSlugify) {
+export function slugify(stringToSlugify) {
     // REGEX_1: Match any character that isn't alphanumeric, underscore, whitespace and underscore
     // REGEX_2: Match any character that is underscore, whitespace and underscore
     // REGEX_3: Match any hyphens at the start or the end of the string
@@ -160,3 +131,56 @@ function slugify(stringToSlugify) {
         .replace(/[\s_-]+/g, "-")
         .replace(/^-+|(?<!-)-+$/g, "");
 }
+export function generateProjectsForAllBrowsers(baseProject) {
+    const projects = [];
+    for (const browser of [
+        {
+            name: `Chrome`,
+            use: {
+                ...devices["Desktop Chrome"],
+                viewport: { width: 2566, height: 1080 },
+            },
+            grepInvert: /@mobile/, // i.e. don't run tests with these tags
+        },
+        {
+            name: `Firefox`,
+            use: {
+                ...devices["Desktop Firefox"],
+                viewport: { width: 1920, height: 1080 },
+            },
+            grepInvert: /@mobile|@lighthouse/,
+        },
+        {
+            name: `Safari`,
+            use: {
+                ...devices["Desktop Safari"],
+                viewport: { width: 1280, height: 720 },
+            },
+            grepInvert: /@mobile|@lighthouse/,
+        },
+        {
+            name: `Chrome_mobile`,
+            use: { ...devices["Pixel 5"] },
+            grepInvert: /@desktop/,
+        },
+        {
+            name: `Safari_mobile`,
+            use: { ...devices["iPhone 12"] },
+            grepInvert: /@desktop|@lighthouse/,
+        },
+    ]) {
+        projects.push({
+            ...baseProject,
+            name: `${baseProject.name}__${browser.name}`,
+            use: {
+                ...baseProject.use,
+                ...browser.use,
+            },
+            grepInvert: [
+                ...[baseProject.grepInvert].flat(1),
+                ...[browser.grepInvert].flat(1),
+            ].filter((value) => value !== undefined),
+        });
+    }
+    return projects;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atomicsmash/test-utils",
-	"version": "2.0.0-beta.0",
+	"version": "3.0.0-beta.0",
 	"type": "module",
 	"description": "A collection of helper functions for automated testing with Playwright.",
 	"keywords": [
@@ -42,11 +42,11 @@
 		"lint:types": "tsc"
 	},
 	"peerDependencies": {
-		"@playwright/test": "^1.46.0",
+		"@playwright/test": "^1.48.2",
 		"cross-env": "^7.0.3"
 	},
 	"dependencies": {
-		"@axe-core/playwright": "^4.9.1",
+		"@axe-core/playwright": "^4.10.0",
 		"get-port": "^7.1.0",
 		"playwright-lighthouse": "^4.0.0"
 	}