Add Playwright for End to End Testing

.github/workflows/playwright.yml

@@ -0,0 +1,25 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [main]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: CI=1 npx playwright test
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

.gitignore

@@ -37,3 +37,7 @@ next-env.d.ts
 
 # uswds
 public/uswds
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

README.md

@@ -29,3 +29,11 @@ Ensure to review the coverage directory for code coverage details.
 ```sh
 npm run test:coverage
 ```
+
+## Running End to End (E2E) Tests
+
+Note: running E2E tests requires the app to be running as well, run the following:
+
+```sh
+npm run e2e
+```

e2e/home.spec.ts

@@ -0,0 +1,9 @@
+import { test, expect } from "@playwright/test";
+
+test("navigates to home", async ({ page }) => {
+  // Navigate to Homepage
+  await page.goto("/");
+
+  // Expect a title "to contain" a substring.
+  await expect(page.getByText(/Welcome Guest/)).toBeTruthy();
+});

package.json

@@ -7,6 +7,8 @@
     "test": "vitest --run",
     "test:coverage": "vitest --run --coverage",
     "test:ui": "vitest --ui",
+    "e2e": "npx playwright test",
+    "e2e:ui": "npx playwright test --ui",
     "postinstall": "node ./scripts/postinstall.js"
   },
   "dependencies": {
@@ -27,6 +29,7 @@
     "recoil": "0.7.7"
   },
   "devDependencies": {
+    "@playwright/test": "^1.45.3",
     "@svgr/webpack": "^8.1.0",
     "@testing-library/jest-dom": "^6.4.6",
     "@testing-library/react": "^16.0.0",

playwright.config.ts

@@ -0,0 +1,81 @@
+import { defineConfig, devices } from "@playwright/test";
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./e2e",
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  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. See https://playwright.dev/docs/test-reporters */
+  reporter: "html",
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL:
+      process.env.CI === "1"
+        ? "https://comet-starter-next.vercel.app"
+        : "http://localhost:3000",
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: "on-first-retry",
+  },
+
+  /* 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'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

vitest.config.ts

@@ -1,17 +1,18 @@
-import { defineConfig } from 'vitest/config';
-import react from '@vitejs/plugin-react';
-import tsconfigPaths from 'vite-tsconfig-paths';
-import path from 'path';
+import { defineConfig } from "vitest/config";
+import react from "@vitejs/plugin-react";
+import tsconfigPaths from "vite-tsconfig-paths";
+import path from "path";
 
 export default defineConfig({
   plugins: [react(), tsconfigPaths()],
   test: {
     globals: true,
-    environment: 'jsdom',
-    setupFiles: './vitest.setup.ts',
+    environment: "jsdom",
+    setupFiles: "./vitest.setup.ts",
+    exclude: ["**/node_modules/**", "**/dist/**", "**/e2e/**"],
     coverage: {
       all: false,
-      provider: 'v8',
+      provider: "v8",
       thresholds: {
         global: {
           statements: 95,
@@ -23,10 +24,18 @@ export default defineConfig({
     },
     css: false,
     alias: {
-      '@metrostar/comet-uswds': path.resolve(__dirname, 'node_modules/@metrostar/comet-uswds/dist/esm/index.js'),
-      '@metrostar/comet-extras': path.resolve(__dirname, 'node_modules/@metrostar/comet-extras/dist/esm/index.js'),
-      '@components/comet': path.resolve(__dirname, 'node_modules/@metrostar/comet-uswds/dist/esm/index.js'), // This is necessary to prevent cjs/esm conflicts
+      "@metrostar/comet-uswds": path.resolve(
+        __dirname,
+        "node_modules/@metrostar/comet-uswds/dist/esm/index.js"
+      ),
+      "@metrostar/comet-extras": path.resolve(
+        __dirname,
+        "node_modules/@metrostar/comet-extras/dist/esm/index.js"
+      ),
+      "@components/comet": path.resolve(
+        __dirname,
+        "node_modules/@metrostar/comet-uswds/dist/esm/index.js"
+      ), // This is necessary to prevent cjs/esm conflicts
     },
   },
 });
-