Skip to main content

持續整合

簡介​

Playwright 測試可以在 CI 環境中執行。我們已經為常見的 CI 提供者建立了範例配置。

3 步驟讓你的測試在 CI 上執行:

  1. 確保 CI 代理可以執行瀏覽器: 在 Linux 代理中使用我們的 Docker 映像或使用CLI安裝您的相依套件。

  2. 安裝 Playwright:

    pip install playwright
    playwright install --with-deps

  3. 執行您的測試:

    pytest

CI configurations​

命令列工具 可以用來在 CI 中安裝所有作業系統相依套件。

GitHub Actions​

在 push/pull_request​

測試將在 push 或 pull request 到 main/master 分支時執行。 工作流程 會安裝所有相依套件，安裝 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: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: Ensure browsers are installed
      run: python -m playwright install --with-deps
    - name: Run your tests
      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 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/python:v1.46.0-jammy
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r local-requirements.txt
          pip install -e .
      - name: Run your tests
        run: pytest
        env:
          HOME: /root

部署​

這將在 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
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt
    - name: Ensure browsers are installed
      run: python -m playwright install --with-deps
    - name: Run tests
      run: pytest
      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 docs。
  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: UsePythonVersion@0
  inputs:
    versionSpec: '3.11'
  displayName: 'Use Python'
- script: |
    python -m pip install --upgrade pip
    pip install -r requirements.txt
  displayName: 'Install dependencies'
- script: playwright install --with-deps
  displayName: 'Install Playwright browsers'
- script: pytest
  displayName: 'Run Playwright tests'

Azure Pipelines (containerized)​

trigger:
- main

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

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

- script: |
    python -m pip install --upgrade pip
    pip install -r requirements.txt
  displayName: 'Install dependencies'
- script: pytest
  displayName: 'Run tests'

CircleCI​

執行 Playwright 在 CircleCI 上與在 GitHub Actions 上非常相似。為了指定預建的 Playwright Docker image，只需在你的配置中用 docker: 修改代理定義，如下所示:

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

注意: 當使用 docker 代理定義時，你正在將 Playwright 執行的資源類別指定為 'medium' 級別 此處。Playwright 的預設行為是將工作者數量設置為檢測到的核心數量（在 medium 級別的情況下為 2）。將工作者數量覆蓋設定為大於這個數字將導致不必要的超時和失敗。

Jenkins​

Jenkins 支援 Docker 代理用於管線。使用 Playwright Docker 映像 在 Jenkins 上執行測試。

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

Bitbucket Pipelines​

Bitbucket Pipelines 可以使用公共 Docker images as build environments。要在 Bitbucket 上執行 Playwright 測試，請使用我們的公共 Docker image (see Dockerfile)。

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

GitLab CI​

要在 GitLab 上執行 Playwright 測試，請使用我們的公共 Docker 映像(see Dockerfile)。

stages:
  - test

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

快取瀏覽器​

快取瀏覽器二進位檔案並不建議，因為還原快取所需的時間與下載二進位檔案所需的時間相當。特別是在 Linux 下，需要安裝作業系統相依套件，這些是無法快取的。

如果你仍然想在 CI 執行之間快取瀏覽器二進位檔，請在你的 CI 設定中，根據 Playwright 版本的雜湊值快取這些目錄。

偵錯瀏覽器啟動​

Playwright 支援 DEBUG 環境變數來在執行期間輸出除錯日誌。將其設置為 pw:browser 在除錯 Error: Failed to launch browser 錯誤時非常有幫助。

DEBUG=pw:browser pytest

執行有頭瀏覽器 (Running headed)​

預設情況下，Playwright 會在無頭模式下啟動瀏覽器。請參閱我們的執行測試指南，了解如何在有頭模式下執行測試。

在 Linux 代理上，帶頭執行需要安裝 Xvfb。我們的 Docker image 和 GitHub Action 已經預先安裝了 Xvfb。要在帶頭模式下使用 Xvfb 執行瀏覽器，請在實際命令前添加 xvfb-run。

xvfb-run pytest