Running in CI/CD

permissions:
  contents: read          # the job needs to read the repository, nothing more

concurrency:
  group: playwright-${{ github.ref }}
  cancel-in-progress: true   # a new push to a pull request cancels its older run

// playwright/playwright.config.ts
import { defineConfig, devices } from '@playwright/test';

const baseURL = process.env.BASE_URL ?? 'http://localhost:3000';

export default defineConfig({
  testDir: './tests',
  fullyParallel: true,
  forbidOnly: !!process.env.CI,      // fail the build if a test.only slipped in
  retries: process.env.CI ? 2 : 0,
  workers: process.env.CI ? 1 : undefined,
  // Stop the run itself so that reporters still produce a report.
  globalTimeout: 20 * 60 * 1000,
  // One blob per shard on CI (merged later), a readable list locally.
  reporter: process.env.CI
    ? [['blob'], ['github']]
    : [['list'], ['html', { open: 'never' }]],
  use: { baseURL, testIdAttribute: 'data-testid', trace: 'on-first-retry' },
  // Start the application only when no deployed URL is given.
  webServer: process.env.BASE_URL
    ? undefined
    : {
        command: 'npm start',
        cwd: '../app',
        url: 'http://localhost:3000',
        reuseExistingServer: !process.env.CI,
      },
  projects: [
    { name: 'chromium', use: { ...devices['Desktop Chrome'] } },
    { name: 'firefox', use: { ...devices['Desktop Firefox'] } },
  ],
});

name: Playwright

on:
  push:
    branches: [main]
  pull_request:

# Cancel the previous run of the same pull request when a new commit arrives.
concurrency:
  group: playwright-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  test:
    runs-on: ubuntu-24.04
    defaults:
      run:
        working-directory: playwright
    strategy:
      fail-fast: false # let every shard finish so the merged report is complete
      matrix:
        shardIndex: [1, 2]
        shardTotal: [2]
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-node@v7
        with:
          node-version: 24
          cache: npm
          cache-dependency-path: playwright/package-lock.json

      - run: npm ci

      # The browsers live outside node_modules; cache them per Playwright version.
      - name: Read the Playwright version
        id: playwright-version
        run: echo "version=$(npm ls @playwright/test --json | jq -r '.dependencies["@playwright/test"].version')" >> "$GITHUB_OUTPUT"

      - name: Cache the browsers
        id: browsers
        uses: actions/cache@v6
        with:
          path: ~/.cache/ms-playwright
          key: playwright-${{ runner.os }}-${{ steps.playwright-version.outputs.version }}

      - name: Install the browsers and their system libraries
        if: steps.browsers.outputs.cache-hit != 'true'
        run: npx playwright install --with-deps

      - name: Install the system libraries only (browsers restored from cache)
        if: steps.browsers.outputs.cache-hit == 'true'
        run: npx playwright install-deps

      - name: Run the tests of this shard
        run: npx playwright test --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
        env:
          BOOKSHELF_READER_PASSWORD: ${{ secrets.BOOKSHELF_READER_PASSWORD }}

      - name: Upload the blob report
        if: ${{ !cancelled() }}
        uses: actions/upload-artifact@v7
        with:
          name: blob-report-${{ matrix.shardIndex }}
          path: playwright/blob-report
          retention-days: 1

  merge-reports:
    if: ${{ !cancelled() }}
    needs: [test]
    runs-on: ubuntu-24.04
    defaults:
      run:
        working-directory: playwright
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: 24
          cache: npm
          cache-dependency-path: playwright/package-lock.json
      - run: npm ci

      - uses: actions/download-artifact@v8
        with:
          path: playwright/all-blob-reports
          pattern: blob-report-*
          merge-multiple: true

      - name: Merge into one HTML report and one summary
        run: npx playwright merge-reports --reporter=html,github ./all-blob-reports

      - uses: actions/upload-artifact@v7
        with:
          name: html-report--attempt-${{ github.run_attempt }}
          path: playwright/playwright-report
          retention-days: 14

[Playwright/test-1]   | Running 3 tests using 1 worker, shard 1 of 2
[Playwright/test-1]   ❓  ::notice title=🎭 Playwright Run Summary::  3 passed (2.3s)
[Playwright/test-2]   | Running 3 tests using 1 worker, shard 2 of 2
[Playwright/test-2]   ❓  ::notice title=🎭 Playwright Run Summary::  3 passed (5.1s)
[Playwright/merge-reports]   | merging reports from ...
[Playwright/merge-reports]   | extracting: all-blob-reports/report-1.zip
[Playwright/merge-reports]   | extracting: all-blob-reports/report-2.zip
[Playwright/merge-reports]   ❓  ::notice title=🎭 Playwright Run Summary::  6 passed (49.0s)

npx playwright show-report path/to/extracted-html-report

    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0   # a shallow clone cannot be compared to the base branch
      # ... setup, npm ci, playwright install ...
      - name: Run changed Playwright tests
        if: github.event_name == 'pull_request'
        run: npx playwright test --only-changed=origin/$GITHUB_BASE_REF
      - name: Run Playwright tests
        run: npx playwright test

docker run --rm --init --ipc=host \
  -e CI=1 \
  -e BASE_URL=http://host.docker.internal:3965 \
  -v "$PWD":/work -w /work \
  mcr.microsoft.com/playwright:v1.64.1-noble \
  sh -c 'npm ci && npx playwright test --reporter=list'

docker run -it --rm --ipc=host --user pwuser \
  --security-opt seccomp=seccomp_profile.json \
  mcr.microsoft.com/playwright:v1.64.1-noble /bin/bash

name: Playwright in a container

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read

jobs:
  e2e:
    runs-on: ubuntu-24.04
    container:
      # Pin the image to the exact version of @playwright/test in package-lock.json.
      image: mcr.microsoft.com/playwright:v1.64.1-noble
      options: --init --ipc=host --user 1001
    defaults:
      run:
        working-directory: playwright
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-node@v7
        with:
          node-version: 24
          cache: npm
          cache-dependency-path: playwright/package-lock.json

      - run: npm ci

      # No "playwright install": the browsers and their libraries are in the image.
      - run: npx playwright test

      - uses: actions/upload-artifact@v7
        if: ${{ !cancelled() }}
        with:
          name: playwright-report
          path: playwright/playwright-report
          retention-days: 14

name: Cypress

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read

jobs:
  cypress:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7

      # Installs with "npm ci", restores and saves ~/.cache/Cypress and ~/.npm,
      # starts the application, waits for it, runs "cypress run" and writes a job summary.
      - uses: cypress-io/github-action@v7
        with:
          working-directory: cypress
          start: npm --prefix ../app start
          wait-on: 'http://localhost:3000'
          wait-on-timeout: 60
          browser: chrome

      - uses: actions/upload-artifact@v7
        if: failure()
        with:
          name: cypress-screenshots
          path: cypress/cypress/screenshots
          if-no-files-found: ignore
          retention-days: 7

Browser:        Chrome 156 (headless)
Specs:          1 found (smoke.cy.ts)
Running:  smoke.cy.ts                                                (1 of 1)
  2 passing (325ms)
✔  All specs passed!                        326ms        2        2        -        -

name: Cypress in a container

on:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  cypress:
    runs-on: ubuntu-24.04
    container:
      # Node.js and the browsers are fixed by the image tag, not by the runner image.
      image: cypress/browsers:24.22.1
      options: --user 1001
    steps:
      - uses: actions/checkout@v7

      - uses: cypress-io/github-action@v7
        with:
          working-directory: cypress
          start: npm --prefix ../app start
          wait-on: 'http://localhost:3000'
          browser: firefox

name: Selenium

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read

jobs:
  grid:
    runs-on: ubuntu-24.04
    services:
      # The browser runs in this container; the tests run on the runner.
      selenium:
        image: selenium/standalone-chrome:4.51.0
        ports:
          - 4444:4444
        options: >-
          --shm-size=2g
          --health-cmd "/opt/bin/check-grid.sh --host 0.0.0.0 --port 4444"
          --health-interval 5s
          --health-timeout 5s
          --health-retries 12
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-node@v7
        with:
          node-version: 24

      - uses: actions/setup-python@v7
        with:
          python-version: '3.13'
          cache: pip
          cache-dependency-path: selenium-python/requirements.txt

      - run: pip install -r selenium-python/requirements.txt

      - name: Start the application
        run: |
          npm --prefix app start &
          for i in $(seq 1 30); do
            curl --silent --fail --output /dev/null http://localhost:3000/api/books && exit 0
            sleep 1
          done
          exit 1

      - name: Find an address of the runner that the Grid container can reach
        run: echo "APP_HOST=$(hostname -I | awk '{print $1}')" >> "$GITHUB_ENV"

      - name: Run the tests through the Grid
        working-directory: selenium-python
        run: python -m pytest tests
        env:
          SELENIUM_REMOTE_URL: http://localhost:4444
          # The browser is in another container: give it an address that reaches the runner.
          BASE_URL: http://${{ env.APP_HOST }}:3000
          API_URL: http://localhost:3000
          BOOKSHELF_READER_PASSWORD: ${{ secrets.BOOKSHELF_READER_PASSWORD }}

# selenium-python/tests/conftest.py
import os
import urllib.request

import pytest
from selenium import webdriver

# Where the browser opens the application, and (optionally) where the Grid is.
BASE_URL = os.environ.get("BASE_URL", "http://localhost:3000")
GRID_URL = os.environ.get("SELENIUM_REMOTE_URL")


@pytest.fixture(autouse=True)
def reset_data():
    # Always reset through the address the test runner can reach.
    api = os.environ.get("API_URL", BASE_URL)
    urllib.request.urlopen(urllib.request.Request(f"{api}/api/test/reset", method="POST"))


@pytest.fixture
def driver():
    options = webdriver.ChromeOptions()
    if GRID_URL:
        driver = webdriver.Remote(command_executor=GRID_URL, options=options)
    else:
        options.add_argument("--headless=new")
        driver = webdriver.Chrome(options=options)
    yield driver
    driver.quit()

name: Selenium on the runner

on:
  workflow_dispatch:

permissions:
  contents: read

jobs:
  local-chrome:
    runs-on: ubuntu-24.04
    env:
      SE_CACHE_PATH: ${{ github.workspace }}/.selenium-cache
      SE_AVOID_STATS: 'true'
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-node@v7
        with:
          node-version: 24

      - uses: actions/setup-python@v7
        with:
          python-version: '3.13'
          cache: pip
          cache-dependency-path: selenium-python/requirements.txt

      - run: pip install -r selenium-python/requirements.txt

      # chromedriver and the version metadata are downloaded once per week.
      - uses: actions/cache@v6
        with:
          path: ${{ env.SE_CACHE_PATH }}
          key: selenium-manager-${{ runner.os }}-${{ hashFiles('selenium-python/requirements.txt') }}

      - run: npm --prefix app start &

      - name: Run the tests with the Chrome of the runner
        working-directory: selenium-python
        run: python -m pytest tests
        env:
          BOOKSHELF_READER_PASSWORD: ${{ secrets.BOOKSHELF_READER_PASSWORD }}

$ SE_CACHE_PATH=/tmp/se-cache SE_OFFLINE=true python -m pytest tests -x -q
WARNING  selenium.webdriver.common.selenium_manager: Unable to discover proper chromedriver version in offline mode
E   selenium.common.exceptions.NoSuchDriverException: Message: Unable to obtain driver for chrome; ...

$ SE_CACHE_PATH=/tmp/se-cache python -m pytest tests -q
..                                                                       [100%]
2 passed in 3.62s
$ SE_CACHE_PATH=/tmp/se-cache SE_OFFLINE=true python -m pytest tests -q
..                                                                       [100%]
2 passed in 1.28s

$ SE_CACHE_PATH=/tmp/se-cache2 SE_PROXY=http://127.0.0.1:9 SE_TIMEOUT=5 python -m pytest tests -x -q
E   {'code': 65, 'message': 'error sending request for url (https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json)', 'driver_path': '', 'browser_path': ''}