ci.yml

name: CI

on: [push, pull_request]

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

      - 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@v3
        with:
          sarif_file: results.sarif

      # we may use whatever way to install phpcs, just specify the path on the next step
      # however, curl seems to be the fastest
      - name: Install PHP_CodeSniffer
        run: |
          curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
          php phpcs.phar --version

      - uses: tinovyatkin/action-php-codesniffer@v1
        with:
          files: "**.php" # you may customize glob as needed
          phpcs_path: php phpcs.phar
          standard: phpcs.xml

  integrationtest:
    runs-on: ubuntu-latest
    name: Behat
    steps:
    - uses: actions/checkout@v4

    - name: Install PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: 8.2

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

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

    - name: Run containers
      run: docker compose up -d --quiet-pull

    - name: Wait for XMPP to become available
      uses: iFaxity/wait-on-action@v1
      with:
        resource: tcp:localhost:15222
        timeout: 1800000
        interval: 10000
        delay: 60000
        log: true

    - name: Wait for second XMPP to become available
      uses: iFaxity/wait-on-action@v1
      with:
        resource: tcp:localhost:25222
        timeout: 1800000
        interval: 10000
        delay: 60000
        log: true

    - name: Run test suite
      run: ./vendor/bin/behat

    - name: Stop containers
      if: always()
      run: docker compose down --volumes

  unittest:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        php:
        - version: 8.2
          phpunit: 10.0
          coverage: true
        - version: 8.3
          phpunit: 10.0
          coverage: false
        - version: 8.4
          phpunit: 11.0
          coverage: false
        prefer-lowest: ['', '--prefer-lowest']

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

    steps:
    - uses: actions/checkout@v4

    - 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@v4
      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

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

    - name: Require compatible PHPUnit version
      run: composer require --dev --with-all-dependencies "phpunit/phpunit:^${{ matrix.php.phpunit }}"

    - name: Make Unit tests compatible
      if: ${{ matrix.php.compat }}
      run: /bin/bash tests/compat.sh

    - name: Run test suite
      if: ${{ ! matrix.php.coverage }}
      run: |
        ./vendor/bin/phpunit \
          --no-configuration \
          --display-skipped \
          --display-deprecations \
          --display-errors \
          --display-notices \
          --display-warnings \
          tests/src/

    - name: Run test suite with code coverage
      if: ${{ matrix.php.coverage }}
      run: |
        ./vendor/bin/phpunit \
          --no-configuration \
          --display-skipped \
          --display-deprecations \
          --display-errors \
          --display-notices \
          --display-warnings \
          --coverage-clover build/logs/clover.xml \
          --coverage-filter src/ \
          tests/src/
      env:
        XDEBUG_MODE: coverage

    - name: Run Scrutinizer
      if: ${{ matrix.php.coverage }}
      run: |
        wget -q https://scrutinizer-ci.com/ocular.phar
        php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml || true