@atomicsmash/init-testing 2.0.0-beta.0 → 2.0.0-beta.2

package/dist/cli.js

@@ -56,13 +56,13 @@ for (const dirent of copyFiles) {
     if (!dirent.isFile()) {
         continue;
     }
-    if (argv.noExample && dirent.name === "example.spec.ts") {
+    if (argv.noExample && dirent.name.includes("example")) {
         continue;
     }
-    if (argv.noUniversal && dirent.name === "universal.spec.ts") {
+    if (argv.noUniversal && dirent.name.includes("universal")) {
         continue;
     }
-    fileCopies.push(readFile(`${dirent.path}/${dirent.name}`, "utf8")
+    fileCopies.push(readFile(`${dirent.parentPath}/${dirent.name}`, "utf8")
         .then(async (data) => {
         for (const [search, replace] of [
             ["%%BASE_URL%%", argv.baseUrl],
@@ -72,6 +72,26 @@ for (const dirent of copyFiles) {
                     ? "../tsconfig.json"
                     : "@atomicsmash/coding-standards/typescript/base",
             ],
+            [
+                "%%EXAMPLE_TEST_IMPORT%%",
+                argv.noExample
+                    ? ""
+                    : '\nimport { projects as exampleProjects } from "./tests/e2e/example/index.mjs";',
+            ],
+            [
+                "%%EXAMPLE_TEST_PROJECTS%%",
+                argv.noExample ? "" : "\n	...exampleProjects,",
+            ],
+            [
+                "%%UNIVERSAL_TEST_IMPORT%%",
+                argv.noUniversal
+                    ? ""
+                    : '\nimport { projects as universalProjects } from "./tests/e2e/universal/index.mjs";',
+            ],
+            [
+                "%%UNIVERSAL_TEST_PROJECTS%%",
+                argv.noUniversal ? "" : "\n	...universalProjects,",
+            ],
         ]) {
             data = data.replace(search, replace);
         }
@@ -158,6 +178,7 @@ await Promise.all([
             "/blob-report/",
             "/playwright/.cache/",
             "/lighthouse/",
+            "/tests/.tmp/",
         ];
         const linesToAddToGitignore = [];
         for (const line of linesToCheck) {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atomicsmash/init-testing",
 	"type": "module",
-	"version": "2.0.0-beta.0",
+	"version": "2.0.0-beta.2",
 	"description": "Allow us to easily add automated testing setup to any npm setup.",
 	"keywords": [
 		"atomic",

package/toCopy/playwright.config.mts

@@ -1,8 +1,13 @@
-import { defineConfig } from "@playwright/test";
+import { defineConfig, PlaywrightTestConfig } from "@playwright/test";
 import { playwrightConfig } from "@atomicsmash/test-utils";
+import { projects as authProjects } from "./tests/auth/index.mjs";%%EXAMPLE_TEST_IMPORT%%%%UNIVERSAL_TEST_IMPORT%%
+
+const playwrightProjectsConfig = [
+	...authProjects,%%EXAMPLE_TEST_PROJECTS%%%%UNIVERSAL_TEST_PROJECTS%%
+] satisfies PlaywrightTestConfig["projects"];
 
 export default defineConfig(playwrightConfig, {
-	use: {
-		baseURL: `%%BASE_URL%%`,
-	},
+	testDir: "./tests",
+	use: { baseURL: `%%BASE_URL%%` },
+	projects: playwrightProjectsConfig,
 });

package/toCopy/tests/auth/admin.setup.mts

@@ -0,0 +1,17 @@
+import { test as setup } from "@playwright/test";
+import { storageState } from "./index.mjs";
+
+setup("Login as admin", async ({ page }) => {
+	await page.goto("/wp/wp-admin/");
+
+	await page
+		.getByLabel("Username or Email Address", { exact: true })
+		.fill("Bot");
+	await page.getByLabel("Password", { exact: true }).fill("password");
+
+	await page.getByRole("button", { name: "Log In", exact: true }).click();
+
+	await page.waitForURL("/wp/wp-admin/");
+
+	await page.context().storageState({ path: storageState });
+});

package/toCopy/tests/auth/admin.teardown.mts

@@ -0,0 +1,7 @@
+import { unlink } from "node:fs/promises";
+import { test as teardown } from "@playwright/test";
+import { storageState } from "./index.mjs";
+
+teardown("Login as admin teardown", async () => {
+	await unlink(storageState);
+});

package/toCopy/tests/auth/index.mts

@@ -0,0 +1,20 @@
+import { devices, PlaywrightTestConfig } from "@playwright/test";
+
+export const setupName = "Admin login";
+export const tearDownName = "Admin teardown";
+export const storageState = "tests/.tmp/admin.auth.json";
+export const projects = [
+	{
+		name: setupName,
+		use: { ...devices["Desktop Chrome"] },
+		testDir: "./tests/auth",
+		testMatch: /admin\.setup\.mts/,
+		teardown: "Admin teardown",
+	},
+	{
+		name: tearDownName,
+		use: { ...devices["Desktop Chrome"] },
+		testDir: "./tests/auth",
+		testMatch: /admin\.teardown\.mts/,
+	},
+] satisfies PlaywrightTestConfig["projects"];

package/toCopy/tests/e2e/example/index.mts

@@ -0,0 +1,10 @@
+import { generateProjectsForAllBrowsers } from "@atomicsmash/test-utils";
+import { PlaywrightTestConfig } from "@playwright/test";
+
+export const projects = [
+	...generateProjectsForAllBrowsers({
+		name: "example_tests",
+		testDir: "./tests/e2e/example",
+		testMatch: /.*example\.test\.mts/,
+	}),
+] satisfies PlaywrightTestConfig["projects"];

package/toCopy/tests/e2e/universal/authenticated.test.mts

@@ -0,0 +1,28 @@
+import {
+	doLighthouseTest,
+	lighthouseTest,
+	doesRoleHaveHighEnoughPermissions,
+} from "@atomicsmash/test-utils";
+import { pagesToTest } from "../../playwright-utils.mjs";
+
+lighthouseTest.describe.configure({ mode: "parallel", retries: 3 });
+for (const pageToTest of pagesToTest) {
+	if (
+		// If a page requires any kind of login
+		!doesRoleHaveHighEnoughPermissions(
+			"unauthenticated",
+			pageToTest.minimumUserPrivilege ?? "unauthenticated",
+		)
+	) {
+		lighthouseTest.describe(`${pageToTest.name} Lighthouse tests`, () => {
+			lighthouseTest(
+				`${pageToTest.name} @desktop @lighthouse`,
+				doLighthouseTest(pageToTest, "desktop", true),
+			);
+			lighthouseTest(
+				`${pageToTest.name} @mobile @lighthouse`,
+				doLighthouseTest(pageToTest, "mobile", true),
+			);
+		});
+	}
+}

package/toCopy/tests/e2e/universal/index.mts

@@ -0,0 +1,18 @@
+import { generateProjectsForAllBrowsers } from "@atomicsmash/test-utils";
+import { PlaywrightTestConfig } from "@playwright/test";
+import { setupName, storageState } from "../../auth/index.mjs";
+
+export const projects = [
+	...generateProjectsForAllBrowsers({
+		name: "universal_tests_unauthenticated",
+		testDir: "./tests/e2e/universal",
+		testMatch: /.*unauthenticated\.test\.mts/,
+	}),
+	...generateProjectsForAllBrowsers({
+		name: "universal_tests_authenticated",
+		testDir: "./tests/e2e/universal",
+		testMatch: /.*authenticated\.test\.mts/,
+		dependencies: [setupName],
+		use: { storageState },
+	}),
+] satisfies PlaywrightTestConfig["projects"];

package/toCopy/tests/e2e/universal/unauthenticated.test.mts

@@ -0,0 +1,48 @@
+import {
+	doLighthouseTest,
+	lighthouseTest,
+	checkPrivilegedPages,
+	checkForLoremIpsum,
+	doesRoleHaveHighEnoughPermissions,
+} from "@atomicsmash/test-utils";
+import { test, pagesToTest } from "../../playwright-utils.mjs";
+
+const pagesRequiringAuthentication = pagesToTest.filter(
+	(page) =>
+		// If a page requires any kind of login
+		!doesRoleHaveHighEnoughPermissions(
+			"unauthenticated",
+			page.minimumUserPrivilege ?? "unauthenticated",
+		),
+);
+
+if (pagesRequiringAuthentication.length) {
+	test(
+		"privileged pages of the site to ensure non-logged in users can't access them",
+		checkPrivilegedPages(pagesRequiringAuthentication),
+	);
+}
+test("No lingering lorem ipsum on the site", checkForLoremIpsum(pagesToTest));
+
+lighthouseTest.describe.configure({ mode: "parallel", retries: 3 });
+for (const pageToTest of pagesToTest) {
+	if (
+		// If a page requires any kind of login
+		!doesRoleHaveHighEnoughPermissions(
+			"unauthenticated",
+			pageToTest.minimumUserPrivilege ?? "unauthenticated",
+		)
+	) {
+		continue;
+	}
+	lighthouseTest.describe(`${pageToTest.name} Lighthouse tests`, () => {
+		lighthouseTest(
+			`${pageToTest.name} @desktop @lighthouse`,
+			doLighthouseTest(pageToTest, "desktop", true),
+		);
+		lighthouseTest(
+			`${pageToTest.name} @mobile @lighthouse`,
+			doLighthouseTest(pageToTest, "mobile", true),
+		);
+	});
+}

package/toCopy/tests/mocks/index.mts

@@ -8,7 +8,6 @@ const handlers: RequestHandler[] = [];
 const server = setupServer(...handlers);
 
 server.listen({ onUnhandledRequest: "warn" });
-// eslint-disable-next-line no-console
 console.info("🔶 Mock server installed");
 
 closeWithGrace({ delay: 1000 }, () => {

package/toCopy/tests/playwright-utils.mts

@@ -7,7 +7,7 @@ type CustomFixtures = { testData: typeof testData };
 
 export const test = base.extend<CustomFixtures>({
 	testData: async (
-		// eslint-disable-next-line @typescript-eslint/no-unused-vars
+		// eslint-disable-next-line @typescript-eslint/no-unused-vars -- Playwright requires destructuring of the page variable even when not used.
 		{ page },
 		use,
 	) => {
@@ -19,9 +19,9 @@ export const test = base.extend<CustomFixtures>({
 export type TestFunctionType = Parameters<typeof base>[2];
 export { checkAccessibility } from "@atomicsmash/test-utils";
 
-export const pagesToTest = [
+export const pagesToTest: PageList = [
 	// hover over PageList to see the format required for each page
-] satisfies PageList;
+];
 
 // Used to set the WP version for WordPressAdminInteraction. Supports major dot minor syntax, or "latest"
 export const CURRENT_WORDPRESS_VERSION: ConstructorParameters<

package/toCopy/tests/e2e/universal.spec.mts

@@ -1,24 +0,0 @@
-import {
-	doLighthouseTest,
-	lighthouseTest,
-	checkPrivilegedPages,
-	checkForLoremIpsum,
-} from "@atomicsmash/test-utils";
-import { test, pagesToTest } from "../playwright-utils.mjs";
-
-test(
-	"privileged pages of the site to ensure non-logged in users can't access them",
-	checkPrivilegedPages(pagesToTest),
-);
-test("No lingering lorem ipsum on the site", checkForLoremIpsum(pagesToTest));
-
-for (const pageToTest of pagesToTest) {
-	lighthouseTest(
-		`${pageToTest.name} @desktop @lighthouse`,
-		doLighthouseTest(pageToTest, "desktop", true),
-	);
-	lighthouseTest(
-		`${pageToTest.name} @mobile @lighthouse`,
-		doLighthouseTest(pageToTest, "mobile", true),
-	);
-}