GitHub Actions での CI

ubuntu-latest のランナーイメージには Chrome と、それに合った chromedriver が含まれています。 vendor/bin/bdi detect drivers で確実に合わせます。End-to-End テストは専用のジョブで実行し、テスト報告書をアップロードして、それへのリンクを含むジョブサマリーを追加します (docs/examples/end-to-end.yml)。

yaml

# .github/workflows/end-to-end.yml
name: End-to-End

on:
  push:
  pull_request:

permissions:
  contents: read

jobs:
  end-to-end:
    runs-on: ubuntu-latest

    services:
      mysql:
        image: mysql:8.4
        env:
          MYSQL_ROOT_PASSWORD: root
          MYSQL_DATABASE: test_app
        ports:
          - 3306:3306
        options: >-
          --health-cmd="mysqladmin ping -proot"
          --health-interval=10s
          --health-timeout=5s
          --health-retries=10

    steps:
      - uses: actions/checkout@v7
        with:
          persist-credentials: false

      - uses: shivammathur/setup-php@v2
        with:
          php-version: '8.4'
          extensions: pdo_mysql
          coverage: none

      - name: Install Composer packages
        run: composer install --no-interaction --no-progress

      - name: Install chromedriver for the installed Chrome
        run: vendor/bin/bdi detect drivers

      # The runners have no Japanese fonts; without them Japanese text is drawn as boxes in the screenshots
      - name: Install Japanese fonts
        run: sudo apt-get update -qq && sudo apt-get install -y -qq fonts-noto-cjk

      - name: Run End-to-End tests
        env:
          DATABASE_URL: mysql://root:root@127.0.0.1:3306/test_app
          PANTHER_NO_SANDBOX: 1
          PANTHER_REPORT_PDF: tmp/end-to-end-report.pdf
        run: vendor/bin/phpunit --testsuite EndToEnd --log-junit end-to-end-junit.xml

      # The test report of every run, passed or not; one file is uploaded as it is, without a zip
      - name: Upload the test report
        id: report
        if: ${{ !cancelled() }}
        uses: actions/upload-artifact@v7
        with:
          path: tmp/end-to-end-report.pdf
          archive: false
          retention-days: 30
          if-no-files-found: error

      - name: End-to-End summary
        if: ${{ !cancelled() }}
        uses: pieceofcake2/ci-summary@v1
        with:
          type: junit
          title: End-to-End
          file: end-to-end-junit.xml
          artifact-name: end-to-end-report.pdf
          artifact-url: ${{ steps.report.outputs.artifact-url }}
          artifact-note: The test report is {artifact}.

PANTHER_REPORT_PDF で実行のテスト報告書を書き出し、次のステップでアップロードします。 archive: false (actions/upload-artifact v7) により、Artifact は zip ではなく PDF そのもので、名前はファイル名になります。if-no-files-found: error で、報告書が書き出されなかったときにジョブを失敗にします。

bdi は dbrekelmans/bdi です。 composer require --dev dbrekelmans/bdi で追加してください。GitHub のランナーでは PANTHER_NO_SANDBOX=1 が必要です。ランナーには日本語 (CJK) のフォントが無いので、例では fonts-noto-cjk を入れています。入れないと、スクリーンショットの日本語が四角 (豆腐) で表示されます。ページに CJK の文字が無ければ、このステップは不要です。 DATABASE_URL は実際の環境変数なので、テストでも、それを引き継ぐ Web サーバーでも、 pieceofcake2/app の config/.env.test より優先されます ('dsn' キーには pieceofcake2/cakephp 2.12.7 以降が必要です)。テスト用データベースをご覧ください。

GitHub Actions での CI ​

GitHub Actions での CI