持续集成

简介

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

在推送/拉取请求时

测试将在 main/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: 构建并安装
      run: mvn -B install -D skipTests --no-transfer-progress
    - name: 确保安装浏览器
      run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
    - name: 运行测试
      run: mvn test

通过容器

GitHub Actions 支持使用jobs.<job_id>.container选项在容器中运行作业。这样做很有用，既不会让依赖项污染主机环境，又能为不同操作系统上的截图/视觉回归测试等提供一致的环境。

.github/workflows/playwright.yml

name: Playwright 测试
on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  playwright:
    name: 'Playwright 测试'
    runs-on: ubuntu-latest
    container:
      image: mcr.microsoft.com/playwright/java:v1.52.0-noble
      options: --user 1001
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v3
        with:
          distribution: 'temurin'
          java-version: '17'
      - name: 构建并安装
        run: mvn -B install -D skipTests --no-transfer-progress
      - name: 运行测试
        run: mvn test

部署时

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

.github/workflows/playwright.yml

name: Playwright 测试
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: 构建并安装
      run: mvn -B install -D skipTests --no-transfer-progress
    - name: 安装 Playwright
      run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
    - name: 运行测试
      run: mvn test
      env:
        # 这可能取决于你的测试运行器
        PLAYWRIGHT_TEST_BASE_URL: ${{ github.event.deployment_status.target_url }}

Docker

我们有一个 预构建的 Docker 镜像，既可以直接使用，也可以作为更新现有 Docker 定义的参考。请务必遵循 推荐的 Docker 配置 以确保最佳性能。

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: '构建并安装'
- script: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
  displayName: '安装 Playwright 浏览器'
- script: mvn test
  displayName: '运行测试'

Azure Pipelines（容器化）

trigger:
- main

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

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

- script: mvn -B install -D skipTests --no-transfer-progress
  displayName: '构建并安装'
- script: mvn test
  displayName: '运行测试'

CircleCI

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

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

注意：使用 docker 代理定义时，你将 Playwright 的运行资源类别指定为 此处 的 “中等” 层级。Playwright 的默认行为是将工作线程数设置为检测到的核心数（中等层级为 2 个）。将工作线程数覆盖为大于此数量的值将导致不必要的超时和失败。

Jenkins

Jenkins 支持在流水线中使用 Docker 代理。使用 Playwright Docker 镜像 在 Jenkins 上运行测试。

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/java:v1.52.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.52.0-noble

GitLab CI

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

stages:
  - test

tests:
  stage: test
  image: mcr.microsoft.com/playwright/java:v1.52.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