Playwright E2E Setup

# Install Playwright
npm init playwright@latest
 
# Or install manually
npm install -D @playwright/test
npx playwright install

// playwright.config.ts
import { defineConfig, devices } from "@playwright/test";
 
export default defineConfig({
  testDir: "./e2e",
  fullyParallel: true,
  forbidOnly: !!process.env.CI,
  retries: process.env.CI ? 2 : 0,
  workers: process.env.CI ? 1 : undefined,
  reporter: process.env.CI ? "github" : "html",
  use: {
    baseURL: "http://localhost:3000",
    trace: "on-first-retry",
    screenshot: "only-on-failure",
  },
  projects: [
    { name: "chromium", use: { ...devices["Desktop Chrome"] } },
    { name: "firefox", use: { ...devices["Desktop Firefox"] } },
    { name: "webkit", use: { ...devices["Desktop Safari"] } },
  ],
  webServer: {
    command: "npm run dev",
    url: "http://localhost:3000",
    reuseExistingServer: !process.env.CI,
    timeout: 120_000,
  },
});

# Run all tests
npx playwright test
 
# Run in headed mode (see the browser)
npx playwright test --headed
 
# Run with Playwright UI
npx playwright test --ui
 
# Run a specific file
npx playwright test e2e/home.spec.ts
 
# Debug mode (step through)
npx playwright test --debug
 
# Show HTML report
npx playwright show-report

// e2e/home.spec.ts
import { test, expect } from "@playwright/test";
 
test.describe("Home Page", () => {
  test("has correct title", async ({ page }) => {
    await page.goto("/");
    await expect(page).toHaveTitle(/My App/);
  });
 
  test("navigates to about page", async ({ page }) => {
    await page.goto("/");
    await page.getByRole("link", { name: /about/i }).click();
    await expect(page).toHaveURL("/about");
    await expect(page.getByRole("heading", { level: 1 })).toHaveText("About Us");
  });
 
  test("search works", async ({ page }) => {
    await page.goto("/");
    await page.getByRole("searchbox").fill("react testing");
    await page.getByRole("button", { name: /search/i }).click();
 
    await expect(page).toHaveURL(/q=react\+testing/);
    await expect(page.getByRole("heading")).toContainText("Search Results");
  });
 
  test("responsive navigation", async ({ page }) => {
    // Set mobile viewport
    await page.setViewportSize({ width: 375, height: 667 });
    await page.goto("/");
 
    // Mobile menu should be hidden initially
    await expect(page.getByRole("navigation")).not.toBeVisible();
 
    // Open mobile menu
    await page.getByRole("button", { name: /menu/i }).click();
    await expect(page.getByRole("navigation")).toBeVisible();
  });
});

// playwright.config.ts
webServer: {
  command: "npm run build && npm run start",
  url: "http://localhost:3000",
  reuseExistingServer: !process.env.CI,
  timeout: 120_000,
},

# .github/workflows/e2e.yml
name: E2E Tests
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
 
jobs:
  e2e:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
 
      - run: npm ci
      - run: npx playwright install --with-deps chromium
 
      - run: npx playwright test --project=chromium
        env:
          CI: true
 
      - uses: actions/upload-artifact@v4
        if: ${{ !cancelled() }}
        with:
          name: playwright-report
          path: playwright-report/
          retention-days: 7

// playwright.config.ts
projects: process.env.CI
  ? [{ name: "chromium", use: { ...devices["Desktop Chrome"] } }]
  : [
      { name: "chromium", use: { ...devices["Desktop Chrome"] } },
      { name: "firefox", use: { ...devices["Desktop Firefox"] } },
      { name: "webkit", use: { ...devices["Desktop Safari"] } },
    ],

// Playwright tests use TypeScript natively -- no extra config needed
// The @playwright/test package includes all types
 
import { test, expect, Page } from "@playwright/test";
 
// Typed page fixture
test("example", async ({ page }: { page: Page }) => {
  // page is fully typed with all Playwright methods
});