持续集成

简介

Playwright 测试可以在 CI 环境中执行。我们创建了针对常用 CI 提供商的示例配置。

在 CI 上运行测试的 3 个步骤

1. **确保 CI 代理可以运行浏览器**：在 Linux 代理中使用 我们的 Docker 镜像，或使用 CLI 安装依赖项。

2. 安装 Playwright:

   mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"

3. 运行测试:

   mvn test

CI 配置

可以使用 命令行工具 在 CI 中安装所有操作系统依赖项。

GitHub Actions

在推送/拉取请求中

测试将在主/master 分支上的推送或拉取请求时运行。该 工作流 将安装所有依赖项，安装 Playwright，然后运行测试。

.github/workflows/playwright.yml

name: Playwright Tests
on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: '17'
    - name: Build & Install
      run: mvn -B install -D skipTests --no-transfer-progress
    - name: Ensure browsers are installed
      run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
    - name: Run tests
      run: mvn test

通过容器

GitHub Actions 支持 在容器中运行作业，方法是使用 jobs.<job_id>.container 选项。这对于不使用依赖项污染主机环境以及在不同操作系统上为屏幕截图/视觉回归测试提供一致的环境很有用。

.github/workflows/playwright.yml

name: Playwright Tests
on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  playwright:
    name: 'Playwright Tests'
    runs-on: ubuntu-latest
    container:
      image: mcr.microsoft.com/playwright/java:v1.48.0-jammy
      options: --user 1001
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v3
        with:
          distribution: 'temurin'
          java-version: '17'
      - name: Build & Install
        run: mvn -B install -D skipTests --no-transfer-progress
      - name: Run tests
        run: mvn test

在部署时

这将在 GitHub 部署 进入 success 状态后开始测试。像 Vercel 这样的服务使用这种模式，以便您可以在其部署的环境中运行端到端测试。

.github/workflows/playwright.yml

name: Playwright Tests
on:
  deployment_status:
jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    if: github.event.deployment_status.state == 'success'
    steps:
    - uses: actions/checkout@v4
    - uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: '17'
    - name: Build & Install
      run: mvn -B install -D skipTests --no-transfer-progress
    - name: Install Playwright
      run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
    - name: Run tests
      run: mvn test
      env:
        # This might depend on your test-runner
        PLAYWRIGHT_TEST_BASE_URL: ${{ github.event.deployment_status.target_url }}

Docker

我们有一个 预构建的 Docker 镜像，可以直接使用，也可以作为参考来更新现有的 Docker 定义。

建议的配置

1. 在使用 Chromium 时，也建议使用 --ipc=host。如果没有它，Chromium 会耗尽内存并崩溃。在 Docker 文档 中了解更多有关此选项的信息。
2. 在启动 Chromium 时遇到其他奇怪的错误？在本地开发时尝试使用 docker run --cap-add=SYS_ADMIN 运行容器。
3. 建议使用 --init Docker 标志或 dumb-init 来避免对 PID=1 的进程进行特殊处理。这是导致僵尸进程的常见原因。

Azure Pipelines

对于 Windows 或 macOS 代理，无需任何额外的配置，只需安装 Playwright 并运行您的测试即可。

对于 Linux 代理，可以使用 我们的 Docker 容器，Azure Pipelines 支持 运行容器化作业。或者，可以使用 命令行工具 安装所有必要的依赖项。

要运行 Playwright 测试，请使用此管道任务

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- task: JavaToolInstaller@0
  inputs:
    versionSpec: '17'
    jdkArchitectureOption: 'x64'
    jdkSourceOption: AzureStorage
- script: mvn -B install -D skipTests --no-transfer-progress
  displayName: 'Build and install'
- script: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
  displayName: 'Install Playwright browsers'
- script: mvn test
  displayName: 'Run tests'

Azure Pipelines（容器化）

trigger:
- main

pool:
  vmImage: ubuntu-latest
container: mcr.microsoft.com/playwright/java:v1.48.0-noble

steps:
- task: JavaToolInstaller@0
  inputs:
    versionSpec: '17'
    jdkArchitectureOption: 'x64'
    jdkSourceOption: AzureStorage

- script: mvn -B install -D skipTests --no-transfer-progress
  displayName: 'Build and install'
- script: mvn test
  displayName: 'Run tests'

CircleCI

在 CircleCI 上运行 Playwright 与在 GitHub Actions 上运行非常相似。为了指定预构建的 Playwright Docker 镜像，只需使用 docker: 修改配置中的代理定义，如下所示

executors:
  pw-jammy-development:
    docker:
      - image: mcr.microsoft.com/playwright/java:v1.48.0-noble

注意：当使用 docker 代理定义时，您将指定 Playwright 运行所在资源类为 'medium' 层 此处。Playwright 的默认行为是将工作程序数量设置为检测到的核心数量（'medium' 层的情况下为 2）。将工作程序数量覆盖为大于此数量会导致不必要的超时和失败。

Jenkins

Jenkins 支持用于管道的 Docker 代理。使用 Playwright Docker 镜像 在 Jenkins 上运行测试。

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/java:v1.48.0-noble' } }
   stages {
      stage('e2e-tests') {
         steps {
            sh 'mvn -B install -D skipTests --no-transfer-progress'
            sh 'mvn test'
         }
      }
   }
}

Bitbucket Pipelines

Bitbucket Pipelines 可以使用公共 Docker 镜像作为构建环境。要在 Bitbucket 上运行 Playwright 测试，请使用我们的公共 Docker 镜像（查看 Dockerfile）。

image: mcr.microsoft.com/playwright/java:v1.48.0-noble

GitLab CI

要在 GitLab 上运行 Playwright 测试，请使用我们的公共 Docker 镜像（查看 Dockerfile）。

stages:
  - test

tests:
  stage: test
  image: mcr.microsoft.com/playwright/java:v1.48.0-noble
  script:
  ...

缓存浏览器

不建议缓存浏览器二进制文件，因为恢复缓存所需的时间与下载二进制文件所需的时间相当。尤其是在 Linux 下，需要安装 操作系统依赖项，而这些依赖项是不可缓存的。

如果您仍然想在 CI 运行之间缓存浏览器二进制文件，请在 CI 配置中缓存 这些目录，并针对 Playwright 版本的哈希值。

调试浏览器启动

Playwright 支持 DEBUG 环境变量以在执行期间输出调试日志。在调试 Error: Failed to launch browser 错误时，将其设置为 pw:browser 会很有帮助。

DEBUG=pw:browser mvn test

以有头模式运行

默认情况下，Playwright 以无头模式启动浏览器。请查看我们的 运行测试 指南，了解如何在有头模式下运行测试。

在 Linux 代理上，有头执行需要安装 Xvfb。我们的 Docker 镜像 和 GitHub Action 已预安装 Xvfb。要在有头模式下使用 Xvfb 运行浏览器，请在实际命令之前添加 xvfb-run。

xvfb-run mvn test