ci.yml

name: "Continuous Integration"

on: [push, pull_request]

jobs:
  unittest:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        php:
          - version: 8.0
            coverage: false
          - version: 8.1
            coverage: false
          - version: 8.2
            coverage: true
          - version: 8.3
            coverage: false
        prefer-lowest: ["", "--prefer-lowest"]

    name: Unit Tests - PHP ${{ matrix.php.version }} ${{ matrix.prefer-lowest }}

    steps:
      - uses: actions/checkout@v3
        with:
          # Fetch 10 commits or Scrutinizer will throw ("Failed to retrieve commit parents. If you use a shallow git checkout, please checkout at least a depth of one."), see: RepositoryIntrospector at scrutinizer-ci/ocular GitHub repository
          # 10 commits is an arbitrary value that is more than 1 commit
          fetch-depth: 10

      - name: Install PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php.version }}
          extensions: mbstring

      - name: Validate composer.json and composer.lock
        run: composer validate --strict

      - name: Cache Composer packages
        id: composer-cache
        uses: actions/cache@v3
        with:
          path: vendor
          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-php-

      - name: Remove static analyse tools
        run: |
          composer remove --dev --with-all-dependencies --ignore-platform-reqs \
             squizlabs/php_codesniffer \
             vimeo/psalm \
             slevomat/coding-standard \
             laminas/laminas-coding-standard

      - name: Update dependencies
        run: composer update --prefer-dist --no-progress --with-all-dependencies ${{ matrix.prefer-lowest }}

      - name: Run test suite
        if: ${{ ! matrix.php.coverage }}
        run: ./vendor/bin/phpunit

      - name: Run test suite with code coverage
        if: ${{ matrix.php.coverage }}
        run: ./vendor/bin/phpunit --coverage-clover=build/logs/clover.xml
        env:
          XDEBUG_MODE: coverage

      - name: Upload Scrutinizer coverage
        if: ${{ matrix.php.coverage }}
        uses: sudo-bot/action-scrutinizer@latest
        with:
          cli-args: "--format=php-clover build/logs/clover.xml --revision=${{ github.event.pull_request.head.sha || github.sha }}"

  psalm:
    name: Psalm
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Psalm
        uses: docker://vimeo/psalm-github-actions
        with:
          security_analysis: true
          report_file: results.sarif
          composer_ignore_platform_reqs: true

      - name: Upload Security Analysis results to GitHub
        uses: github/codeql-action/upload-sarif@v2
        with:
          sarif_file: results.sarif

  phpcs:
    name: PHPCS
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Setup PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: "8.2"
          coverage: none
          tools: composer, cs2pr

      - name: Cache Composer packages
        id: composer-cache
        uses: actions/cache@v3
        with:
          path: vendor
          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
          restore-keys: |
            ${{ runner.os }}-php-

      - name: Install dependencies
        run: composer install --prefer-dist --no-suggest --no-progress

      - name: Detect coding standard violations (PR)
        run: ./vendor/bin/phpcs -q --report=checkstyle | cs2pr --graceful-warnings
        if: github.event_name == 'pull_request'

      - name: Detect coding standard violations
        run: ./vendor/bin/phpcs
        if: github.event_name != 'pull_request'