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

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

はじめに​

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​

プッシュ/プルリクエスト時​

テストは、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
    - 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.54.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エージェントの場合、弊社のDockerコンテナをAzure Pipelinesでサポートされているコンテナ化されたジョブの実行と組み合わせて使用​​できます。または、コマンドラインツールを使用して必要なすべての依存関係をインストールすることもできます。

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.54.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.54.0-noble

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

Jenkins​

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

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

GitLab CI​

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

stages:
  - test

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

ブラウザのキャッシュ​

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

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

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

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

DEBUG=pw:browser mvn test

ヘッダー付きで実行​

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

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

xvfb-run mvn test