main.yml

---
name: Tests

on:
    push:
        branches: [ main, develop, wip ]
        paths-ignore:
            - .idea/**
            - docs/**
    pull_request:
        branches: [ develop ]
        paths-ignore:
            - .idea/**
            - docs/**
    schedule:
        # Every Monday at 00:00:00 UTC.
        # @see https://crontab.cronhub.io/
        -   cron: "0 0 * * 1"

jobs:
    quality_check:
        name: "Quality Check"
        runs-on: ubuntu-latest
        steps:
            -   name: "Set up PHP"
                uses: shivammathur/setup-php@v2 # https://github.com/marketplace/actions/setup-php-action
                with:
                    php-version: "8.1"

            -   name: "Checkout code"
                uses: actions/checkout@v3 # https://github.com/marketplace/actions/checkout

            -   name: "Install dependencies"
                uses: ramsey/composer-install@v2 # https://github.com/marketplace/actions/install-composer-dependencies

            -   name: "Run all quality checks"
                run: "composer static"

    tests:
        name: "${{ matrix.os }} / ${{ matrix.dependencies }} / ${{ matrix.php }}"
        runs-on: "${{ matrix.os }}"
        strategy:
            fail-fast: false
            matrix:
                os: [ ubuntu-latest, macos-latest, windows-latest ]
                php: [ "8.1" ]
                dependencies: [ lowest, highest ]
        steps:
            -   name: "Debugging info"
                run: "rsync --version | head -1"
                if: ${{ runner.os != 'Windows' }}

            -   name: "Set up PHP"
                uses: shivammathur/setup-php@v2 # https://github.com/marketplace/actions/setup-php-action
                with:
                    php-version: "${{ matrix.php }}"
                    ini-values: assert.active=1, assert.exception=1, zend.assertions=1

            -   name: "PHP info"
                run: "php -i"

            -   name: "Checkout code"
                uses: actions/checkout@v3 # https://github.com/marketplace/actions/checkout

            -   name: "Install dependencies"
                uses: ramsey/composer-install@v2 # https://github.com/marketplace/actions/install-composer-dependencies
                with:
                    dependency-versions: "${{ matrix.dependencies }}"

            -   name: "Run core tests with coverage"
                run: "composer test"
                if: ${{ matrix.os == 'ubuntu-latest' && matrix.dependencies == 'highest' }}

            # There's no reason to generate coverage data on multiple jobs--the result should be the same.
            -   name: "Run core tests without coverage"
                run: "./vendor/bin/phpunit --no-coverage --exclude-group=windows_only"
                if: ${{ runner.os != 'Windows' && !( matrix.os == 'ubuntu-latest' && matrix.dependencies == 'highest' ) }}

            -   name: "Run Windows tests"
                run: "./vendor/bin/phpunit --no-coverage --exclude-group=no_windows"
                if: ${{ runner.os == 'Windows' }}

    performance:
        name: "Performance"
        runs-on: ubuntu-latest
        steps:
            -   name: "Set up PHP"
                uses: shivammathur/setup-php@v2 # https://github.com/marketplace/actions/setup-php-action
                with:
                    php-version: "8.1"

            -   name: "Checkout code"
                uses: actions/checkout@v3 # https://github.com/marketplace/actions/checkout

            -   name: "Install dependencies"
                uses: ramsey/composer-install@v2 # https://github.com/marketplace/actions/install-composer-dependencies
                with:
                    # Disable Composer caching due to random failures it causes.
                    # @see https://github.com/ramsey/composer-install/issues/79
                    composer-options: "--no-cache"

            -   name: "Run performance tests"
                run: "composer phpbench -- --progress=plain --iterations=5 --ansi"