跳到主要内容

持续集成

简介​

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

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

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

  2. 安装 Playwright：

    pip install playwright
    playwright install --with-deps

  3. 运行你的测试：

    pytest

CI 配置​

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

GitHub Actions​

push/pull_request 时触发​

在 main/master 分支上 push 或 pull request 时会运行测试。工作流会安装所有依赖、安装 Playwright，然后运行测试。

.github/workflows/playwright.yml
name: Playwright 测试
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: 设置 Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'
    - name: 安装依赖
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: 确保浏览器已安装
      run: python -m playwright install --with-deps
    - name: 运行你的测试
      run: pytest --tracing=retain-on-failure
    - uses: actions/upload-artifact@v4
      if: ${{ !cancelled() }}
      with:
        name: playwright-traces
        path: test-results/

通过容器​

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/python:v1.51.0-noble
      options: --user 1001
    steps:
      - uses: actions/checkout@v4
      - name: 设置 Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'
      - name: 安装依赖
        run: |
          python -m pip install --upgrade pip
          pip install -r local-requirements.txt
          pip install -e .
      - name: 运行你的测试
        run: pytest

部署时触发​

在 GitHub Deployment 进入 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-python@v4
      with:
        python-version: '3.11'
    - name: 安装依赖
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: 确保浏览器已安装
      run: python -m playwright install --with-deps
    - name: 运行测试
      run: pytest
      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 测试可以使用如下 pipeline 任务：

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.11'
  displayName: '使用 Python'
- script: |
    python -m pip install --upgrade pip
    pip install -r requirements.txt
  displayName: '安装依赖'
- script: playwright install --with-deps
  displayName: '安装 Playwright 浏览器'
- script: pytest
  displayName: '运行 Playwright 测试'

Azure Pipelines（容器化）​

trigger:
- main

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

steps:
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.11'
  displayName: '使用 Python'

- script: |
    python -m pip install --upgrade pip
    pip install -r requirements.txt
  displayName: '安装依赖'
- script: pytest
  displayName: '运行测试'

CircleCI​

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

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

注意：当使用 docker 代理定义时，你将 playwright 运行的资源等级指定为 这里的 'medium' 层。Playwright 的默认行为是将 worker 数量设置为检测到的核心数（medium 层为 2）。将 worker 数量设置得比这个数字更大，会导致不必要的超时和失败。

Jenkins​

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

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/python:v1.51.0-noble' } }
   stages {
      stage('e2e-tests') {
         steps {
            sh 'pip install -r requirements.txt'
            sh 'pytest'
         }
      }
   }
}

Bitbucket Pipelines​

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

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

GitLab CI​

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

stages:
  - test

tests:
  stage: test
  image: mcr.microsoft.com/playwright/python:v1.51.0-noble
  script:
  ...

浏览器缓存​

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

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

调试浏览器启动​

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

DEBUG=pw:browser pytest

以有界面模式运行​

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

在 Linux 代理上，有界面模式需要安装 Xvfb。我们的 Docker 镜像 和 GitHub Action 已预装 Xvfb。要在有界面模式下配合 Xvfb 运行浏览器，只需在实际命令前加上 xvfb-run。

xvfb-run pytest