メインコンテンツにスキップ

継続的インテグレーション

はじめに​

Playwright テストは CI 環境で実行できます。一般的な CI プロバイダー向けにサンプル設定を作成しました。

CI でテストを実行するための 3 つのステップ

  1. CI エージェントがブラウザを実行できることを確認する: Linux エージェントで当社の Docker イメージを使用するか、CLIを使用して依存関係をインストールします。

  2. Playwright をインストールする:

    mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"

  3. テストを実行する:

    mvn test

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
    - uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: '17'
    - name: Build & Install
      run: mvn -B install -D skipTests --no-transfer-progress
    - name: Ensure browsers are installed
      run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
    - name: Run tests
      run: mvn 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/java:v1.50.0-noble
      options: --user 1001
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v3
        with:
          distribution: 'temurin'
          java-version: '17'
      - name: Build & Install
        run: mvn -B install -D skipTests --no-transfer-progress
      - name: Run tests
        run: mvn 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
    - uses: actions/setup-java@v3
      with:
        distribution: 'temurin'
        java-version: '17'
    - name: Build & Install
      run: mvn -B install -D skipTests --no-transfer-progress
    - name: Install Playwright
      run: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
    - name: Run tests
      run: mvn 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 テストを実行するには、このパイプラインタスクを使用してください

trigger:
- main

pool:
  vmImage: ubuntu-latest

steps:
- task: JavaToolInstaller@0
  inputs:
    versionSpec: '17'
    jdkArchitectureOption: 'x64'
    jdkSourceOption: AzureStorage
- script: mvn -B install -D skipTests --no-transfer-progress
  displayName: 'Build and install'
- script: mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install --with-deps"
  displayName: 'Install Playwright browsers'
- script: mvn test
  displayName: 'Run tests'

Azure Pipelines (コンテナ化)​

trigger:
- main

pool:
  vmImage: ubuntu-latest
container: mcr.microsoft.com/playwright/java:v1.50.0-noble

steps:
- task: JavaToolInstaller@0
  inputs:
    versionSpec: '17'
    jdkArchitectureOption: 'x64'
    jdkSourceOption: AzureStorage

- script: mvn -B install -D skipTests --no-transfer-progress
  displayName: 'Build and install'
- script: mvn test
  displayName: 'Run tests'

CircleCI​

CircleCI での Playwright の実行は、GitHub Actions での実行と非常によく似ています。事前に構築された Playwright Docker イメージを指定するには、設定で docker: を使用してエージェント定義を次のように変更します。

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

注: docker エージェント定義を使用する場合、playwright が実行されるリソースクラスを「medium」ティアここに指定しています。Playwright のデフォルトの動作は、ワーカーの数を検出されたコア数 (medium ティアの場合は 2) に設定することです。ワーカーの数をこれより大きい数にオーバーライドすると、不要なタイムアウトと失敗が発生します。

Jenkins​

Jenkins はパイプライン用の Docker エージェントをサポートしています。Jenkins でテストを実行するには、Playwright Docker イメージを使用してください。

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/java:v1.50.0-noble' } }
   stages {
      stage('e2e-tests') {
         steps {
            sh 'mvn -B install -D skipTests --no-transfer-progress'
            sh 'mvn test'
         }
      }
   }
}

Bitbucket Pipelines​

Bitbucket Pipelines は、パブリックDocker イメージをビルド環境として使用できます。Bitbucket で Playwright テストを実行するには、当社のパブリック Docker イメージ (Dockerfile を参照) を使用してください。

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

GitLab CI​

GitLab で Playwright テストを実行するには、当社のパブリック Docker イメージ (Dockerfile を参照) を使用してください。

stages:
  - test

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

ブラウザのキャッシュ​

ブラウザバイナリのキャッシュは推奨されません。キャッシュの復元にかかる時間が、バイナリのダウンロードにかかる時間と同程度であるためです。特に Linux では、オペレーティングシステムの依存関係をインストールする必要がありますが、これらはキャッシュできません。

それでも CI 実行間でブラウザバイナリをキャッシュしたい場合は、CI 設定でこれらのディレクトリを Playwright バージョンのハッシュに対してキャッシュしてください。

ブラウザ起動のデバッグ​

Playwright は、実行中にデバッグログを出力するために DEBUG 環境変数をサポートしています。pw:browser に設定すると、Error: Failed to launch browser エラーのデバッグに役立ちます。

DEBUG=pw:browser mvn test

ヘッドレスモードの実行​

デフォルトでは、Playwright はブラウザをヘッドレスモードで起動します。ヘッドレスモードでテストを実行する方法については、テストの実行ガイドを参照してください。

Linux エージェントでは、ヘッドレスモードでの実行には Xvfb のインストールが必要です。当社のDocker イメージと GitHub Action には Xvfb がプリインストールされています。Xvfb を使用してヘッドレスモードでブラウザを実行するには、実際のコマンドの前に xvfb-run を追加します。

xvfb-run mvn test