@atomicsmash/init-testing 1.1.0 → 2.0.0-beta.1

package/dist/cli.js

@@ -5,16 +5,12 @@ import { resolve as pathResolve, relative as pathRelative } from "node:path";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 import { PackageManager } from "./utils.js";
-const packageManager = new PackageManager(await import(`${process.cwd()}/package.json`, {
-    with: { type: "json" },
-})
+const packageManager = new PackageManager(await import(`${process.cwd()}/package.json`, { with: { type: "json" } })
     .then((module) => module.default)
     .catch((error) => {
     console.log({ error });
     throw new Error("Unable to find package.json in your cwd. Make sure you're running this command in the right folder.");
-}), await import(`${process.cwd()}/package-lock.json`, {
-    with: { type: "json" },
-})
+}), await import(`${process.cwd()}/package-lock.json`, { with: { type: "json" } })
     .then((module) => module.default)
     .catch((error) => {
     console.log({ error });
@@ -60,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],
@@ -76,16 +72,33 @@ 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);
         }
         await mkdir(`${process.cwd()}/${relativePath}`.slice(0, -1), {
             recursive: true,
         });
-        await writeFile(`${process.cwd()}/${relativePath}${dirent.name}`, data, {
-            encoding: "utf8",
-            flag: argv.overwriteFiles ? "w" : "wx",
-        });
+        await writeFile(`${process.cwd()}/${relativePath}${dirent.name}`, data, { encoding: "utf8", flag: argv.overwriteFiles ? "w" : "wx" });
         return `${relativePath}${dirent.name} copied successfully.`;
     })
         .catch((error) => `${relativePath}${dirent.name} failed to copy. Error: ${error}`));
@@ -93,9 +106,10 @@ for (const dirent of copyFiles) {
 await Promise.all([
     Promise.allSettled([
         packageManager.ensurePackageIsInstalled("@atomicsmash/test-utils", {
-            packageConstraint: "^1.0.0",
+            packageConstraint: "^4.0.0",
             type: "dev",
         }),
+        packageManager.ensurePackageIsInstalled("@atomicsmash/wordpress-tests-helper", { packageConstraint: "^1.0.0", type: "dev" }),
         packageManager.ensurePackageIsInstalled("@playwright/test", {
             packageConstraint: "^1.0.0",
             type: "dev",
@@ -121,7 +135,7 @@ await Promise.all([
         },
         !hasRootTSConfig
             ? packageManager.ensurePackageIsInstalled("typescript", {
-                packageConstraint: "^5.4.0",
+                packageConstraint: "~5.8.0",
                 type: "dev",
             })
             : false,

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAqBA,qBAAa,cAAc;IAC1B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,eAAe,CAAkB;IACzC,QAAQ;QACP;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;MAEF;gBAEU,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAK1D;;OAEG;IACH,WAAW;IA2BX;;;;OAIG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM;;;;;;;;;IA2BrC;;;;;;;;OAQG;IACG,wBAAwB,CAC7B,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;QACT,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;KACxB;CAkGF"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAqBA,qBAAa,cAAc;IAC1B,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,eAAe,CAAkB;IACzC,QAAQ;QACP;;WAEG;eACU,MAAM,EAAE;QACrB;;WAEG;iBACY,MAAM,EAAE;QACvB;;WAEG;oBACe,MAAM,EAAE;MACzB;gBAEU,WAAW,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAK1D;;OAEG;IACH,WAAW;IA2BX;;;;OAIG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM;;;;;;;;;IA2BrC;;;;;;;;OAQG;IACG,wBAAwB,CAC7B,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;QACT,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;KACxB;CAkGF"}

package/package.json

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

package/toCopy/playwright.config.mts

@@ -1,8 +1,11 @@
-import { defineConfig } from "@playwright/test";
+import { defineConfig, devices, PlaywrightTestConfig } from "@playwright/test";
 import { playwrightConfig } from "@atomicsmash/test-utils";
+import { projects as authProjects } from "./tests/auth";%%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%%`,
-	},
+	use: { baseURL: `%%BASE_URL%%` },
 });

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

@@ -0,0 +1,17 @@
+import { test as setup } from "@playwright/test";
+import { storageState } from "./index.js";
+
+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.ts

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

package/toCopy/tests/auth/index.ts

@@ -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\.ts/,
+		teardown: "Admin teardown",
+	},
+	{
+		name: tearDownName,
+		use: { ...devices["Desktop Chrome"] },
+		testDir: "./tests/auth",
+		testMatch: /admin\.teardown\.ts/,
+	},
+] satisfies PlaywrightTestConfig["projects"];

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

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

package/toCopy/tests/e2e/{universal.spec.mts → universal/authenticated.test.mts}

@@ -1,15 +1,8 @@
 import {
 	doLighthouseTest,
-	checkPrivilegedPages,
-	checkForLoremIpsum,
+	lighthouseTest,
 } from "@atomicsmash/test-utils";
-import { test, lighthouseTest, 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));
+import { pagesToTest } from "../../playwright-utils.mjs";
 
 for (const pageToTest of pagesToTest) {
 	lighthouseTest(

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

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

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

@@ -0,0 +1,11 @@
+import {
+	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));

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

@@ -1,42 +1,29 @@
-import type {
-	AuthenticatePageFunction,
-	PageList,
-} from "@atomicsmash/test-utils";
-import type { Page } from "@playwright/test";
-import { getLighthouseTest } from "@atomicsmash/test-utils";
+import type { PageList } from "@atomicsmash/test-utils";
+import type { WordPressAdminInteraction } from "@atomicsmash/wordpress-tests-helper";
 import { test as base } from "@playwright/test";
 import { testData } from "./fixtures/testData.mjs";
 
-/**
- * Fixtures
- */
-const logInUser: AuthenticatePageFunction = async function ({ page }, use) {
-	// Do any actions here to log a user in so you can access logged in areas of the site.
-	// This is useful for testing my account pages, etc.
-	await use(page);
-};
-
-type CustomFixtures = {
-	testData: typeof testData;
-	authenticatedPage: Page;
-};
+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,
 	) => {
 		// Use the fixture value in the test.
 		await use(testData);
 	},
-	authenticatedPage: [logInUser, { scope: "test" }],
 });
 
-export const lighthouseTest = getLighthouseTest(logInUser);
-export const { expect } = test; // re-export expect to cleanup imports in tests
+export type TestFunctionType = Parameters<typeof base>[2];
 export { checkAccessibility } from "@atomicsmash/test-utils";
 
 export const pagesToTest = [
 	// 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<
+	typeof WordPressAdminInteraction
+>[2] = "6.7";