php.yml

name: "Integrate"

# Run this workflow every time a new commit pushed to your repository
on:
  push:
    paths-ignore:
      - '**/*.md'
  pull_request:
    paths-ignore:
      - '**/*.md'
  # Allow manually triggering the workflow.
  workflow_dispatch:

jobs:
  kill_previous:
    name: "0️⃣ Kill previous runs"
    runs-on: "ubuntu-latest"
    # We want to run on external PRs, but not on our own internal PRs as they'll be run by the push to the branch.
    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
    steps:
      - name: Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.12.1
        with:
          access_token: ${{ github.token }}

  php_syntax_errors:
    name: "1️⃣ PHP: Syntax errors"
    runs-on: "ubuntu-latest"
    needs:
      - "kill_previous"
    steps:
      - name: "Set up PHP"
        uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0
        with:
          php-version: "latest"

      - name: "Checkout code"
        uses: "actions/checkout@v4.2.2"

      - name: "Install dependencies"
        uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # 3.1.0

      - name: Validate files
        run: composer validate-files

  code_style_errors:
    name: "1️⃣ PHP: Code Style errors"
    runs-on: "ubuntu-latest"
    needs:
      - "kill_previous"
    steps:
      - name: "Set up PHP"
        uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0
        with:
          php-version: "latest"

      - name: "Checkout code"
        uses: "actions/checkout@v4.2.2"

      - name: "Install dependencies"
        uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # 3.1.0

      - name: Check Style
        run: composer check-code-style

  phpstan:
    name: "2️⃣ PHP: PHPStan"
    runs-on: "ubuntu-latest"
    needs:
      - "php_syntax_errors"
    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Setup PHP
        uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0
        with:
          php-version: "latest"
          coverage: none
          tools: phpstan

      - name: Install Composer dependencies
        uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # 3.1.0

      - name: Run PHPStan
        run: vendor/bin/phpstan analyze

  tests:
    name: "2️⃣ PHP ${{ matrix.php-version }}: Tests"
    needs:
      - "php_syntax_errors"
    runs-on: "ubuntu-latest"
    strategy:
      fail-fast: false
      matrix:
        php-version:
          - "8.3"
          - "8.4"
    env:
      extensions: curl, dom, imagick, json, libxml, mbstring

    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: Set Up Imagick, FFmpeg & Exiftools
        run: |
          sudo apt-get update
          sudo apt-get --fix-broken install
          sudo apt-get -y install ffmpeg libimage-exiftool-perl libmagickwand-dev

      - name: Setup PHP Action
        uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # 2.32.0
        with:
          php-version: ${{ matrix.php-version }}
          extensions: ${{ env.extensions }}
          coverage: xdebug
          tools: pecl, composer

      # Install dependencies and handle caching in one go.
      # Dependencies need to be installed to make sure the PHPUnit classes are recognized.
      # @link https://github.com/marketplace/actions/install-php-dependencies-with-composer
      - name: Install Composer dependencies
        uses: ramsey/composer-install@a2636af0004d1c0499ffca16ac0b4cc94df70565 # 3.1.0

      # - name: boot test server
      #   run: vendor/bin/http_test_server > /dev/null 2>&1 &

      - name: Prepare log directory
        run: mkdir -p build/logs

      - name: Validate files
        run: composer validate-files

      - name: Check Style
        run: composer check-code-style

      - name: Run tests
        run: composer run-tests

      - name: Codecov
        uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  # support for mutation testing.
  #
  # This section is disabled because Mutation testing is a rather slow process
  # and furthermore adds lots of noise into the pull request review panel by Github.
  # While it is an intersting set of tests to have, this does not constitute major
  # improvements to the full code base.
  #
  # TODO: This section can be uncommented once ALL the code paths are evaluted.
  # This unfortunately includes changes such as in_array(...,..., true) into in_array(...,..., false)
  # and other behaviours which are very edge cases
  #
  # infection:
  #   name: "3️⃣ PHP: Mutation testing"
  #   runs-on: "ubuntu-latest"
  #   needs:
  #   - "tests"
  #   steps:
  #     - name: Checkout code
  #       uses: actions/checkout@v4.2.2

  #     - name: Set Up Imagick, FFmpeg & Exiftools
  #       run: |
  #         sudo apt-get update
  #         sudo apt-get --fix-broken install
  #         sudo apt-get -y install ffmpeg libimage-exiftool-perl libmagickwand-dev

  #     - name: Setup PHP
  #       uses: shivammathur/setup-php@2.32.0
  #       with:
  #         php-version: "latest"
  #         coverage: xdebug

  #     - name: Install Composer dependencies
  #       uses: "ramsey/composer-install@v2"

  #     - name: Run Infection
  #       run: vendor/bin/infection