跳到主要内容

持续集成

简介​

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​

在 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@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.49.0-noble
      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.49.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-noble-development:
    docker:
      - image: mcr.microsoft.com/playwright/java:v1.49.0-noble

注意：当使用 docker 代理定义时，你正在指定 playwright 运行的资源类到“medium”层级 这里。 Playwright 的默认行为是将 worker 的数量设置为检测到的核心数（在 medium 层级的情况下为 2）。 将 worker 的数量覆盖为大于此数字将导致不必要的超时和失败。

Jenkins​

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

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

GitLab CI​

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

stages:
  - test

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

缓存浏览器​

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

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

调试浏览器启动​

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

DEBUG=pw:browser mvn test

运行有头模式​

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

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

xvfb-run mvn test