CI のセットアップ
はじめに
Playwright のテストは、あらゆる CI プロバイダーで実行できます。このセクションでは、GitHub Actions を使用して GitHub でテストを実行する方法について説明します。他の CI プロバイダーを構成する方法については、継続的インテグレーションに関する詳細なドキュメントをご覧ください。
学習内容
GitHub Actions の設定
GitHub Actions ファイルを追加するには、まず .github/workflows フォルダーを作成し、その中に以下の例のコードを含む playwright.yml ファイルを追加します。これにより、main/master ブランチへのプッシュおよびプルリクエストごとにテストが実行されます。
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/
これについて詳しく知るには、「Understanding GitHub Actions」を参照してください。
jobs.test.steps のステップのリストを見ると、ワークフローが次のステップを実行していることがわかります。
- リポジトリをクローンする
- 言語の依存関係をインストールする
- プロジェクトの依存関係をインストールしてビルドする
- Playwright ブラウザをインストールする
- テストを実行する
リポジトリを作成して GitHub にプッシュする
GitHub Actions ワークフローを設定したら、あとはGitHub にリポジトリを作成するか、既存のリポジトリにコードをプッシュするだけです。GitHub の指示に従い、git init コマンドを使用してgit リポジトリを初期化することを忘れないでください。これにより、コードを追加、コミット、およびプッシュできます。
ワークフローを開く
Actions タブをクリックしてワークフローを表示します。ここでは、テストが合格したか失敗したかを確認できます。
テストログの表示
ワークフローの実行をクリックすると、GitHub が実行したすべてのアクションが表示され、Run Playwright tests をクリックすると、エラーメッセージ、期待されたものと受け取られたもの、およびコールログが表示されます。
トレースの表示
trace.playwright.dev は、Trace Viewer の静的にホストされたバリアントです。ドラッグアンドドロップでトレースファイルをアップロードできます。
シークレットの適切な処理
トレースファイルやコンソールログなどのアーティファクトには、テスト実行に関する情報が含まれています。これらには、テストユーザーのユーザー資格情報、ステージングバックエンドへのアクセストークン、テストソースコード、あるいはアプリケーションのソースコードなどの機密データが含まれる場合があります。これらのファイルは、機密データを扱うのと同じくらい慎重に扱ってください。CI ワークフローの一部としてレポートとトレースをアップロードする場合は、信頼できるアーティファクトストアにのみアップロードするか、アップロードする前にファイルを暗号化するようにしてください。チームメンバーとアーティファクトを共有する場合も同様です。信頼できるファイル共有を使用するか、共有する前にファイルを暗号化してください。