跳到主内容

持续集成

简介​

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

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

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

  2. 安装 Playwright:

    dotnet build
    pwsh bin/Debug/netX/playwright.ps1 install --with-deps

  3. 运行你的测试:

    dotnet 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
    - name: Setup dotnet
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: 8.0.x
    - name: Build & Install
      run: dotnet build
    - name: Ensure browsers are installed
      run: pwsh bin/Debug/net8.0/playwright.ps1 install --with-deps
    - name: Run your tests
      run: dotnet test

通过容器​

GitHub Actions 支持 在容器中运行 Job，通过使用 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/dotnet:v1.51.0-noble
      options: --user 1001
    steps:
      - uses: actions/checkout@v4
      - name: Setup dotnet
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: 8.0.x
      - run: dotnet build
      - name: Run your tests
        run: dotnet test

在部署时​

这将在一个 GitHub Deployment 进入 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
    - name: Setup dotnet
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: 8.0.x
    - run: dotnet build
    - name: Ensure browsers are installed
      run: pwsh bin/Debug/net8.0/playwright.ps1 install --with-deps
    - name: Run tests
      run: dotnet 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 Agent，无需额外配置，只需安装 Playwright 并运行你的测试即可。

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

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

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- task: UseDotNet@2
  inputs:
    packageType: sdk
    version: '8.0.x'
  displayName: 'Use .NET SDK'
- script: dotnet build --configuration Release
  displayName: 'Build'
- script: pwsh bin/Release/net8.0/playwright.ps1 install --with-deps
  displayName: 'Install Playwright browsers'
- script: dotnet test --configuration Release
  displayName: 'Run tests'

Azure Pipelines（容器化）​

trigger:
- main

pool:
  vmImage: ubuntu-latest
container: mcr.microsoft.com/playwright/dotnet:v1.51.0-noble

steps:
- task: UseDotNet@2
  inputs:
    packageType: sdk
    version: '8.0.x'
  displayName: 'Use .NET SDK'

- script: dotnet build --configuration Release
  displayName: 'Build'
- script: dotnet test --configuration Release
  displayName: 'Run tests'

CircleCI​

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

executors:
  pw-noble-development:
    docker:
      - image: mcr.microsoft.com/playwright/dotnet:v1.51.0-noble

注意：使用 docker Agent 定义时，你将 Playwright 运行所在的资源类别指定为“medium”层级在此处。Playwright 的默认行为是将 worker 数量设置为检测到的核心数量（在 medium 层级中为 2）。将 worker 数量覆盖为大于此数字将导致不必要的超时和失败。

Jenkins​

Jenkins 支持在 Pipeline 中使用 Docker Agent。使用 Playwright Docker 镜像在 Jenkins 上运行测试。

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/dotnet:v1.51.0-noble' } }
   stages {
      stage('e2e-tests') {
         steps {
            sh 'dotnet build'
            sh 'dotnet test'
         }
      }
   }
}

Bitbucket Pipelines​

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

image: mcr.microsoft.com/playwright/dotnet:v1.51.0-noble

GitLab CI​

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

缓存浏览器​

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

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

调试浏览器启动​

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

DEBUG=pw:browser dotnet test

运行在有头模式下​

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

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

xvfb-run dotnet test