跳到主要内容

持续集成

简介​

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

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

  1. 确保 CI 代理可以运行浏览器：在 Linux 代理中使用我们的 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 上运行。 workflow 将安装所有依赖项，安装 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 支持在容器中运行作业，通过使用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.50.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 定义的参考。

建议配置

  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 代理，您可以结合 Azure Pipelines 支持 运行容器化作业 使用我们的 Docker 容器。 或者，您可以使用命令行工具来安装所有必要的依赖项。

对于运行 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.50.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 镜像，只需在您的配置中使用 docker: 修改代理定义，如下所示

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

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

Jenkins​

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

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/dotnet:v1.50.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.50.0-noble

GitLab CI​

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

缓存浏览器​

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

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

调试浏览器启动​

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

DEBUG=pw:browser dotnet test

以 Headed 模式运行​

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

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

xvfb-run dotnet test