持續整合

簡介

Playwright 測試可以在 CI 環境中執行。我們已為常見的 CI 供應商建立範例設定。

讓您的測試在 CI 上運行的 3 個步驟

確保 CI 代理程式可以運行瀏覽器：在 Linux 代理程式中使用我們的 Docker 映像檔，或使用 CLI 安裝您的依賴項。

安裝 Playwright:

pip install playwright
playwright install --with-deps

執行您的測試:
```
pytest
```

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: 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.49.1-noble
      options: --user 1001
    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

在部署時

這將在 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-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 定義的參考。

建議的設定

使用 Chromium 時，也建議使用 --ipc=host。如果沒有它，Chromium 可能會耗盡記憶體並崩潰。在 Docker 文件中了解有關此選項的更多資訊。
啟動 Chromium 時看到其他奇怪的錯誤？在本地開發時，嘗試使用 docker run --cap-add=SYS_ADMIN 運行您的容器。
建議使用 --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 (容器化)

trigger:
- main

pool:
  vmImage: ubuntu-latest
container: mcr.microsoft.com/playwright/python:v1.49.1-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

在 CircleCI 上運行 Playwright 與在 GitHub Actions 上運行非常相似。為了指定預先建立的 Playwright Docker 映像檔，只需在您的設定中使用 docker: 修改代理程式定義，如下所示

executors:
  pw-noble-development:
    docker:
      - image: mcr.microsoft.com/playwright/python:v1.49.1-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.49.1-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.49.1-noble

GitLab CI

若要在 GitLab 上運行 Playwright 測試，請使用我們的公共 Docker 映像檔（請參閱 Dockerfile）。

stages:
  - test

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

快取瀏覽器

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

如果您仍然想要在 CI 運行之間快取瀏覽器二進位檔，請在您的 CI 設定中快取這些目錄，並針對 Playwright 版本的雜湊值進行快取。

偵錯瀏覽器啟動

Playwright 支援 DEBUG 環境變數，以在執行期間輸出偵錯日誌。將其設定為 pw:browser 在偵錯 Error: Failed to launch browser 錯誤時很有幫助。

DEBUG=pw:browser pytest

以 Headed 模式運行

預設情況下，Playwright 以 headless 模式啟動瀏覽器。請參閱我們的運行測試指南，了解如何在 headed 模式下運行測試。

在 Linux 代理程式上，headed 執行需要安裝 Xvfb。我們的 Docker 映像檔和 GitHub Action 已預先安裝 Xvfb。若要使用 Xvfb 在 headed 模式下運行瀏覽器，請在實際命令前新增 xvfb-run。

xvfb-run pytest

簡介​

CI 設定​

GitHub Actions​

在 push/pull_request 時​

透過容器​

在部署時​

Docker​

Azure Pipelines​

Azure Pipelines (容器化)​

CircleCI​

Jenkins​

Bitbucket Pipelines​

GitLab CI​

快取瀏覽器​

偵錯瀏覽器啟動​

以 Headed 模式運行​

簡介