Перейти к основному содержимому

Непрерывная интеграция

Введение​

Тесты Playwright могут выполняться в средах CI. Мы создали примерные конфигурации для распространенных провайдеров CI.

3 шага для запуска ваших тестов на CI:

  1. Убедитесь, что агент CI может запускать браузеры: Используйте наш Docker-образ в Linux-агентах или установите ваши зависимости с помощью CLI.

  2. Установите Playwright:

    pip install playwright
    playwright install --with-deps

  3. Запустите ваши тесты:

    pytest

Конфигурации CI​

Командные инструменты могут быть использованы для установки всех зависимостей операционной системы в 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.50.0-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, используют этот шаблон, чтобы вы могли запускать свои end-to-end тесты в их развернутой среде.

.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:
        # Это может зависеть от вашего тестового раннера
        PLAYWRIGHT_TEST_BASE_URL: ${{ github.event.deployment_status.target_url }}

Docker​

У нас есть предварительно собранный Docker-образ, который можно использовать напрямую или в качестве примера для обновления ваших существующих Docker-определений.

Рекомендуемая конфигурация

  1. Использование --ipc=host также рекомендуется при использовании Chromium. Без этого Chromium может закончиться память и он может аварийно завершиться. Узнайте больше об этой опции в документации Docker.
  2. Видите другие странные ошибки при запуске Chromium? Попробуйте запустить ваш контейнер с docker run --cap-add=SYS_ADMIN при локальной разработке.
  3. Использование флага Docker --init или 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.50.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. Чтобы указать предварительно собранный Docker-образ Playwright, просто измените определение агента с docker: в вашей конфигурации следующим образом:

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

Примечание: При использовании определения агента docker вы указываете класс ресурсов, где Playwright запускается на уровне 'medium' здесь. Поведение Playwright по умолчанию - устанавливать количество рабочих процессов в соответствии с обнаруженным количеством ядер (2 в случае уровня medium). Переопределение количества рабочих процессов на большее значение приведет к ненужным тайм-аутам и сбоям.

Jenkins​

Jenkins поддерживает Docker-агенты для конвейеров. Используйте Docker-образ Playwright для запуска тестов на Jenkins.

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

Bitbucket Pipelines​

Bitbucket Pipelines может использовать публичные Docker-образы как среды сборки. Чтобы запустить тесты Playwright на Bitbucket, используйте наш публичный Docker-образ (см. Dockerfile).

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

GitLab CI​

Чтобы запустить тесты Playwright на GitLab, используйте наш публичный Docker-образ (см. Dockerfile).

stages:
  - test

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

Кэширование браузеров​

Кэширование бинарных файлов браузеров не рекомендуется, так как время, необходимое для восстановления кэша, сопоставимо с временем, необходимым для загрузки бинарных файлов. Особенно в Linux необходимо установить зависимости операционной системы, которые не подлежат кэшированию.

Если вы все же хотите кэшировать бинарные файлы браузеров между запусками CI, кэшируйте эти директории в вашей конфигурации CI, используя хэш версии Playwright.

Отладка запусков браузера​

Playwright поддерживает переменную окружения DEBUG для вывода отладочных логов во время выполнения. Установка ее в pw:browser полезна при отладке ошибок Error: Failed to launch browser.

DEBUG=pw:browser pytest

Запуск в режиме с интерфейсом​

По умолчанию Playwright запускает браузеры в безголовом режиме. См. в нашем руководстве Запуск тестов, как запускать тесты в режиме с интерфейсом.

На Linux-агентах выполнение в режиме с интерфейсом требует установки Xvfb. Наш Docker-образ и GitHub Action имеют предустановленный Xvfb. Чтобы запустить браузеры в режиме с интерфейсом с Xvfb, добавьте xvfb-run перед фактической командой.

xvfb-run pytest