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

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

はじめに​

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.51.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定義を更新するための参照として使用することもできます。最高のパフォーマンスを確保するために、推奨されるDocker構成に従ってください。

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.51.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.51.0-noble

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

Jenkins​

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

pipeline {
   agent { docker { image 'mcr.microsoft.com/playwright/java:v1.51.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.51.0-noble

GitLab CI​

GitLabでPlaywrightテストを実行するには、弊社の公開Dockerイメージ（Dockerfileを参照）を使用します。

stages:
  - test

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

ブラウザのキャッシュ​

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

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

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

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