持续集成

简介

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

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

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

安装 Playwright:

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

运行您的测试:
```
mvn test
```

CI 配置

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

GitHub Actions

在 push/pull_request 上

测试将在 main/master 分支上的 push 或 pull request 时运行。工作流将安装所有依赖项、安装 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@v5
    - uses: actions/setup-java@v5
      with:
        distribution: 'temurin'
        java-version: '25'
    - 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.58.0-noble
      options: --user 1001
    steps:
      - uses: actions/checkout@v5
      - uses: actions/setup-java@v5
        with:
          distribution: 'temurin'
          java-version: '25'
      - 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@v5
    - uses: actions/setup-java@v5
      with:
        distribution: 'temurin'
        java-version: '25'
    - 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 定义的参考。请务必遵循推荐的 Docker 配置，以确保最佳性能。

Azure Pipelines

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

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

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

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- task: JavaToolInstaller@1
  inputs:
    versionSpec: '25'
    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.58.0-noble

steps:
- task: JavaToolInstaller@1
  inputs:
    versionSpec: '25'
    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-noble-development:
    docker:
      - image: mcr.microsoft.com/playwright/java:v1.58.0-noble

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

Jenkins

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

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

GitLab CI

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

stages:
  - test

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

缓存浏览器

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

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

调试浏览器启动

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

DEBUG=pw:browser mvn test

有头模式运行

默认情况下，Playwright 以无头（headless）模式启动浏览器。请参阅我们的运行测试指南，了解如何以有头（headed）模式运行测试。

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

xvfb-run mvn test

简介​

CI 配置​

GitHub Actions​

在 push/pull_request 上​

通过容器​

在部署上​

Docker​

Azure Pipelines​

Azure Pipelines（容器化）​

CircleCI​

Jenkins​

Bitbucket Pipelines​

GitLab CI​

缓存浏览器​

调试浏览器启动​

有头模式运行​

简介