@stratawp/testing 0.1.1 → 0.2.0

package/dist/config.d.ts

@@ -0,0 +1,19 @@
+import { PlaywrightTestConfig } from '@playwright/test';
+
+type SmokeBrowser = 'chromium' | 'firefox' | 'webkit';
+
+interface SmokeConfigOptions {
+    /** Directory containing the smoke specs, relative to the config file. */
+    testDir: string;
+    /** Defaults to WP_BASE_URL, then the wp-env URL. */
+    baseURL?: string;
+    /** Engines to run; STRATAWP_E2E_BROWSERS overrides this. */
+    browsers?: SmokeBrowser[];
+}
+/**
+ * One Playwright definition shared by the monorepo and generated themes.
+ * Chromium locally for speed; Chromium + Firefox + WebKit in CI.
+ */
+declare function createSmokeConfig(options: SmokeConfigOptions): PlaywrightTestConfig;
+
+export { type SmokeBrowser, type SmokeConfigOptions, createSmokeConfig };

package/dist/config.js

@@ -0,0 +1,51 @@
+// src/config.ts
+import { defineConfig, devices } from "@playwright/test";
+import { fileURLToPath } from "url";
+
+// src/browsers.ts
+var ALL_BROWSERS = ["chromium", "firefox", "webkit"];
+function resolveBrowsers(env = process.env, explicit) {
+  const requested = env.STRATAWP_E2E_BROWSERS;
+  if (requested) {
+    const valid = requested.split(",").map((name) => name.trim()).filter((name) => ALL_BROWSERS.includes(name));
+    if (valid.length > 0) {
+      return [...new Set(valid)];
+    }
+  }
+  if (explicit && explicit.length > 0) {
+    return explicit;
+  }
+  return env.CI ? ALL_BROWSERS : ["chromium"];
+}
+
+// src/config.ts
+var DEVICES = {
+  chromium: devices["Desktop Chrome"],
+  firefox: devices["Desktop Firefox"],
+  webkit: devices["Desktop Safari"]
+};
+function createSmokeConfig(options) {
+  const baseURL = options.baseURL ?? process.env.WP_BASE_URL ?? "http://localhost:8888";
+  return defineConfig({
+    testDir: options.testDir,
+    timeout: 3e4,
+    forbidOnly: !!process.env.CI,
+    retries: process.env.CI ? 1 : 0,
+    workers: process.env.CI ? 1 : void 0,
+    reporter: process.env.CI ? [["github"], ["html", { open: "never" }]] : [["list"]],
+    globalSetup: fileURLToPath(new URL("./global-setup.js", import.meta.url)),
+    use: {
+      baseURL,
+      trace: "retain-on-failure",
+      screenshot: "only-on-failure"
+    },
+    projects: resolveBrowsers(process.env, options.browsers).map((name) => ({
+      name,
+      use: { ...DEVICES[name] }
+    }))
+  });
+}
+export {
+  createSmokeConfig
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/config.ts","../src/browsers.ts"],"sourcesContent":["import { defineConfig, devices } from '@playwright/test'\nimport type { PlaywrightTestConfig } from '@playwright/test'\nimport { fileURLToPath } from 'node:url'\nimport { resolveBrowsers } from './browsers'\nimport type { SmokeBrowser } from './browsers'\n\nexport type { SmokeBrowser } from './browsers'\n\nexport interface SmokeConfigOptions {\n  /** Directory containing the smoke specs, relative to the config file. */\n  testDir: string\n  /** Defaults to WP_BASE_URL, then the wp-env URL. */\n  baseURL?: string\n  /** Engines to run; STRATAWP_E2E_BROWSERS overrides this. */\n  browsers?: SmokeBrowser[]\n}\n\nconst DEVICES = {\n  chromium: devices['Desktop Chrome'],\n  firefox: devices['Desktop Firefox'],\n  webkit: devices['Desktop Safari'],\n} as const\n\n/**\n * One Playwright definition shared by the monorepo and generated themes.\n * Chromium locally for speed; Chromium + Firefox + WebKit in CI.\n */\nexport function createSmokeConfig(options: SmokeConfigOptions): PlaywrightTestConfig {\n  const baseURL = options.baseURL ?? process.env.WP_BASE_URL ?? 'http://localhost:8888'\n\n  return defineConfig({\n    testDir: options.testDir,\n    timeout: 30_000,\n    forbidOnly: !!process.env.CI,\n    retries: process.env.CI ? 1 : 0,\n    workers: process.env.CI ? 1 : undefined,\n    reporter: process.env.CI ? [['github'], ['html', { open: 'never' }]] : [['list']],\n    globalSetup: fileURLToPath(new URL('./global-setup.js', import.meta.url)),\n    use: {\n      baseURL,\n      trace: 'retain-on-failure',\n      screenshot: 'only-on-failure',\n    },\n    projects: resolveBrowsers(process.env, options.browsers).map((name) => ({\n      name,\n      use: { ...DEVICES[name] },\n    })),\n  })\n}\n","export type SmokeBrowser = 'chromium' | 'firefox' | 'webkit'\n\nexport const ALL_BROWSERS: SmokeBrowser[] = ['chromium', 'firefox', 'webkit']\n\n/**\n * Which engines the smoke suite runs on.\n * Precedence: STRATAWP_E2E_BROWSERS > explicit > (all three in CI, else chromium).\n */\nexport function resolveBrowsers(\n  env: NodeJS.ProcessEnv = process.env,\n  explicit?: SmokeBrowser[]\n): SmokeBrowser[] {\n  const requested = env.STRATAWP_E2E_BROWSERS\n  if (requested) {\n    const valid = requested\n      .split(',')\n      .map((name) => name.trim())\n      .filter((name): name is SmokeBrowser => ALL_BROWSERS.includes(name as SmokeBrowser))\n    if (valid.length > 0) {\n      return [...new Set(valid)]\n    }\n  }\n  if (explicit && explicit.length > 0) {\n    return explicit\n  }\n  return env.CI ? ALL_BROWSERS : ['chromium']\n}\n"],"mappings":";AAAA,SAAS,cAAc,eAAe;AAEtC,SAAS,qBAAqB;;;ACAvB,IAAM,eAA+B,CAAC,YAAY,WAAW,QAAQ;AAMrE,SAAS,gBACd,MAAyB,QAAQ,KACjC,UACgB;AAChB,QAAM,YAAY,IAAI;AACtB,MAAI,WAAW;AACb,UAAM,QAAQ,UACX,MAAM,GAAG,EACT,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,EACzB,OAAO,CAAC,SAA+B,aAAa,SAAS,IAAoB,CAAC;AACrF,QAAI,MAAM,SAAS,GAAG;AACpB,aAAO,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC;AAAA,IAC3B;AAAA,EACF;AACA,MAAI,YAAY,SAAS,SAAS,GAAG;AACnC,WAAO;AAAA,EACT;AACA,SAAO,IAAI,KAAK,eAAe,CAAC,UAAU;AAC5C;;;ADTA,IAAM,UAAU;AAAA,EACd,UAAU,QAAQ,gBAAgB;AAAA,EAClC,SAAS,QAAQ,iBAAiB;AAAA,EAClC,QAAQ,QAAQ,gBAAgB;AAClC;AAMO,SAAS,kBAAkB,SAAmD;AACnF,QAAM,UAAU,QAAQ,WAAW,QAAQ,IAAI,eAAe;AAE9D,SAAO,aAAa;AAAA,IAClB,SAAS,QAAQ;AAAA,IACjB,SAAS;AAAA,IACT,YAAY,CAAC,CAAC,QAAQ,IAAI;AAAA,IAC1B,SAAS,QAAQ,IAAI,KAAK,IAAI;AAAA,IAC9B,SAAS,QAAQ,IAAI,KAAK,IAAI;AAAA,IAC9B,UAAU,QAAQ,IAAI,KAAK,CAAC,CAAC,QAAQ,GAAG,CAAC,QAAQ,EAAE,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;AAAA,IAChF,aAAa,cAAc,IAAI,IAAI,qBAAqB,YAAY,GAAG,CAAC;AAAA,IACxE,KAAK;AAAA,MACH;AAAA,MACA,OAAO;AAAA,MACP,YAAY;AAAA,IACd;AAAA,IACA,UAAU,gBAAgB,QAAQ,KAAK,QAAQ,QAAQ,EAAE,IAAI,CAAC,UAAU;AAAA,MACtE;AAAA,MACA,KAAK,EAAE,GAAG,QAAQ,IAAI,EAAE;AAAA,IAC1B,EAAE;AAAA,EACJ,CAAC;AACH;","names":[]}

package/dist/global-setup.d.ts

@@ -0,0 +1,10 @@
+import { FullConfig } from '@playwright/test';
+
+/**
+ * Fail fast, once, with an actionable message if WordPress is not answering,
+ * instead of letting every test time out separately.
+ */
+declare function checkSiteReachable(url: string, fetchImpl?: typeof fetch): Promise<void>;
+declare function globalSetup(config: FullConfig): Promise<void>;
+
+export { checkSiteReachable, globalSetup as default };

package/dist/global-setup.js

@@ -0,0 +1,29 @@
+// src/global-setup.ts
+async function checkSiteReachable(url, fetchImpl = fetch) {
+  let detail;
+  try {
+    const response = await fetchImpl(url, { signal: AbortSignal.timeout(1e4) });
+    if (response.ok) {
+      return;
+    }
+    detail = `HTTP ${response.status}`;
+  } catch (error) {
+    const message = error instanceof Error ? error.message : String(error);
+    const code = error?.cause?.code;
+    detail = code ? `${message}, ${code}` : message;
+  }
+  throw new Error(
+    `StrataWP smoke tests: ${url} is not reachable (${detail}). Start WordPress first (for example: pnpm exec wp-env start) or set WP_BASE_URL.`
+  );
+}
+async function globalSetup(config) {
+  const baseURL = config.projects[0]?.use.baseURL;
+  if (baseURL) {
+    await checkSiteReachable(baseURL);
+  }
+}
+export {
+  checkSiteReachable,
+  globalSetup as default
+};
+//# sourceMappingURL=global-setup.js.map

package/dist/global-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/global-setup.ts"],"sourcesContent":["import type { FullConfig } from '@playwright/test'\n\n/**\n * Fail fast, once, with an actionable message if WordPress is not answering,\n * instead of letting every test time out separately.\n */\nexport async function checkSiteReachable(\n  url: string,\n  fetchImpl: typeof fetch = fetch\n): Promise<void> {\n  let detail: string\n  try {\n    const response = await fetchImpl(url, { signal: AbortSignal.timeout(10_000) })\n    if (response.ok) {\n      return\n    }\n    detail = `HTTP ${response.status}`\n  } catch (error) {\n    const message = error instanceof Error ? error.message : String(error)\n    const code = (error as { cause?: { code?: string } } | null)?.cause?.code\n    detail = code ? `${message}, ${code}` : message\n  }\n  throw new Error(\n    `StrataWP smoke tests: ${url} is not reachable (${detail}). ` +\n      `Start WordPress first (for example: pnpm exec wp-env start) or set WP_BASE_URL.`\n  )\n}\n\nexport default async function globalSetup(config: FullConfig): Promise<void> {\n  const baseURL = config.projects[0]?.use.baseURL\n  if (baseURL) {\n    await checkSiteReachable(baseURL)\n  }\n}\n"],"mappings":";AAMA,eAAsB,mBACpB,KACA,YAA0B,OACX;AACf,MAAI;AACJ,MAAI;AACF,UAAM,WAAW,MAAM,UAAU,KAAK,EAAE,QAAQ,YAAY,QAAQ,GAAM,EAAE,CAAC;AAC7E,QAAI,SAAS,IAAI;AACf;AAAA,IACF;AACA,aAAS,QAAQ,SAAS,MAAM;AAAA,EAClC,SAAS,OAAO;AACd,UAAM,UAAU,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AACrE,UAAM,OAAQ,OAAgD,OAAO;AACrE,aAAS,OAAO,GAAG,OAAO,KAAK,IAAI,KAAK;AAAA,EAC1C;AACA,QAAM,IAAI;AAAA,IACR,yBAAyB,GAAG,sBAAsB,MAAM;AAAA,EAE1D;AACF;AAEA,eAAO,YAAmC,QAAmC;AAC3E,QAAM,UAAU,OAAO,SAAS,CAAC,GAAG,IAAI;AACxC,MAAI,SAAS;AACX,UAAM,mBAAmB,OAAO;AAAA,EAClC;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stratawp/testing",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Comprehensive testing utilities for StrataWP themes",
   "author": "Jon Imms",
   "license": "GPL-3.0-or-later",
@@ -31,6 +31,10 @@
     "./playwright": {
       "types": "./dist/playwright.d.ts",
       "import": "./dist/playwright.js"
+    },
+    "./config": {
+      "types": "./dist/config.d.ts",
+      "import": "./dist/config.js"
     }
   },
   "files": [
@@ -57,9 +61,15 @@
     "typescript": "^5.3.3"
   },
   "peerDependencies": {
+    "@playwright/test": ">=1.40.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
+  "peerDependenciesMeta": {
+    "@playwright/test": {
+      "optional": true
+    }
+  },
   "scripts": {
     "dev": "tsup --watch",
     "build": "tsup",

package/playwright.config.ts

@@ -1,84 +1,3 @@
-import { defineConfig, devices } from '@playwright/test'
+import { createSmokeConfig } from '@stratawp/testing/config'
 
-/**
- * Playwright E2E Test Configuration
- * See https://playwright.dev/docs/test-configuration
- */
-export default defineConfig({
-  testDir: './e2e',
-
-  /* Maximum time one test can run for */
-  timeout: 30 * 1000,
-
-  /* Run tests in files in parallel */
-  fullyParallel: true,
-
-  /* Fail the build on CI if you accidentally left test.only */
-  forbidOnly: !!process.env.CI,
-
-  /* Retry on CI only */
-  retries: process.env.CI ? 2 : 0,
-
-  /* Opt out of parallel tests on CI */
-  workers: process.env.CI ? 1 : undefined,
-
-  /* Reporter to use */
-  reporter: [
-    ['html'],
-    ['json', { outputFile: 'test-results/results.json' }],
-    ['junit', { outputFile: 'test-results/junit.xml' }],
-  ],
-
-  /* Shared settings for all the projects below */
-  use: {
-    /* Base URL for WordPress */
-    baseURL: process.env.WP_BASE_URL || 'http://localhost:8888',
-
-    /* Collect trace when retrying the failed test */
-    trace: 'on-first-retry',
-
-    /* Screenshot on failure */
-    screenshot: 'only-on-failure',
-
-    /* Video on failure */
-    video: 'retain-on-failure',
-  },
-
-  /* Configure projects for major browsers */
-  projects: [
-    {
-      name: 'chromium',
-      use: { ...devices['Desktop Chrome'] },
-    },
-
-    {
-      name: 'firefox',
-      use: { ...devices['Desktop Firefox'] },
-    },
-
-    {
-      name: 'webkit',
-      use: { ...devices['Desktop Safari'] },
-    },
-
-    /* Test against mobile viewports */
-    {
-      name: 'Mobile Chrome',
-      use: { ...devices['Pixel 5'] },
-    },
-    {
-      name: 'Mobile Safari',
-      use: { ...devices['iPhone 12'] },
-    },
-  ],
-
-  /* Run your local dev server before starting the tests */
-  webServer: process.env.CI
-    ? undefined
-    : {
-        command: 'npm run dev',
-        url: 'http://localhost:3000',
-        reuseExistingServer: !process.env.CI,
-        timeout: 120 * 1000,
-      },
-})
+export default createSmokeConfig({ testDir: './e2e' })