tests.yml

name: Tests

on:
  push:
    branches: [ main ]
  pull_request:
  schedule:
    # The dependencies aren't locked: a release of one of them may break the tests of an unchanged main.
    - cron: '23 5 * * 1'

permissions:
  contents: read

jobs:
  verify-fixture:
    name: Verify Test Fixture Bundle
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Verify fixture bundle integrity, refs and size
        run: tests/fixtures/verify-bundle.sh

  check-cs:
    name: Check Coding Standards
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Setup PHP
        uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
        with:
          php-version: '8.4'

      - name: Setup Castor
        uses: castor-php/setup-castor@2a495b8c91f00be6768ad8a040ba8634c797d386 # v1.1.0

      - name: Run CS check
        run: castor cs --dry-run

  check-archive:
    name: Check the Archive
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Ship only the code, the docs and the license
        run: diff <(git archive HEAD | tar -t | cut -d/ -f1 | sort -u) <(printf '%s\n' CHANGELOG.md LICENSE README.md UPGRADE-2.0.md composer.json doc src | sort)

  phpstan:
    name: Static Analysis
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Setup PHP
        uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
        with:
          php-version: '8.4'

      - name: Setup Castor
        uses: castor-php/setup-castor@2a495b8c91f00be6768ad8a040ba8634c797d386 # v1.1.0

      - name: Install dependencies
        run: castor install

      - name: Run PHPStan
        run: castor phpstan

  tests:
    name: Test PHP ${{ matrix.php }} ${{ matrix.name }}
    runs-on: ubuntu-24.04
    # The next version of PHP may fail, without failing the workflow.
    continue-on-error: ${{ matrix.php == 'nightly' }}
    strategy:
      fail-fast: false
      matrix:
        php: ['8.4', '8.5']
        composer-flags: ['']
        name: ['']
        include:
          - php: '8.4'
            composer-flags: '--prefer-lowest'
            name: '(prefer lowest dependencies)'
          # Between 6.4, of the lowest dependencies, and 8.x, of the other jobs.
          - php: '8.4'
            composer-flags: '--with=symfony/process:^7.4.5'
            name: '(symfony/process 7.4)'
          - php: 'nightly'
            # The dependencies may not allow this version of PHP yet.
            composer-flags: '--ignore-platform-req=php+'
            name: '(allowed to fail)'

    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Setup PHP
        uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
        with:
          php-version: ${{ matrix.php }}

      - name: Setup Problem Matchers
        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

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

      - name: Install Composer dependencies
        run: |
            composer update --prefer-dist --no-interaction ${{ matrix.composer-flags }}

      - name: Execute PHPUnit
        run: vendor/bin/phpunit

  tests-git:
    name: Test git ${{ matrix.git }}
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        # The oldest supported git, and the one of Ubuntu 20.04: the other jobs test the latest one.
        include:
          - git: '1.8.4'
            sha256: '5e0efe7cd30e258bc3be9ae023790743974e76eb1b24ecac24de6fc2af2b2786'
          - git: '2.25.1'
            sha256: 'aaef0cd609a7730cfbae530d7c91214a941d7e26054d2314cc99794880156b33'
    env:
      GIT_CFLAGS: '-std=gnu17 -O2'
      GIT_MAKE_FLAGS: 'NO_OPENSSL=1 NO_CURL=1 NO_EXPAT=1 NO_GETTEXT=1 NO_PERL=1 NO_PYTHON=1 NO_TCLTK=1'

    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Cache git
        id: cache-git
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: ~/git
          key: git-${{ matrix.git }}-${{ env.GIT_CFLAGS }}-${{ env.GIT_MAKE_FLAGS }}-ubuntu-24.04

      - name: Build git
        if: steps.cache-git.outputs.cache-hit != 'true'
        run: |
          curl -fsSL "https://github.com/git/git/archive/refs/tags/v${{ matrix.git }}.tar.gz" -o git.tar.gz
          echo "${{ matrix.sha256 }}  git.tar.gz" | sha256sum --check
          tar xzf git.tar.gz
          make -C "git-${{ matrix.git }}" prefix="$HOME/git" CFLAGS="$GIT_CFLAGS" $GIT_MAKE_FLAGS --jobs="$(nproc)" install

      - name: Setup PHP
        uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
        with:
          php-version: '8.4'

      - name: Setup Problem Matchers
        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

      - name: Install Composer dependencies
        run: composer update --prefer-dist --no-interaction

      - name: Execute PHPUnit
        run: GIT_COMMAND="$HOME/git/bin/git" vendor/bin/phpunit

  tests-ffi:
    name: Test PHP ${{ matrix.php }} (LibGit2Driver${{ matrix.name }})
    runs-on: ubuntu-24.04
    strategy:
      fail-fast: false
      matrix:
        php: ['8.4', '8.5']
        composer-flags: ['']
        name: ['']
        include:
          - php: '8.4'
            composer-flags: '--prefer-lowest'
            name: ', prefer lowest dependencies'
    env:
      # LibGit2Driver only supports libgit2 1.9, which Ubuntu 24.04 doesn't ship.
      LIBGIT2_VERSION: '1.9.1'
      LIBGIT2_SHA256: '14cab3014b2b7ad75970ff4548e83615f74d719afe00aa479b4a889c1e13fc00'
      LIBGIT2_CMAKE_FLAGS: '-DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=OFF -DBUILD_CLI=OFF -DUSE_HTTPS=OFF -DUSE_SSH=OFF'

    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Cache libgit2
        id: cache-libgit2
        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
        with:
          path: ~/libgit2
          key: libgit2-${{ env.LIBGIT2_VERSION }}-${{ env.LIBGIT2_CMAKE_FLAGS }}-ubuntu-24.04

      - name: Build libgit2
        if: steps.cache-libgit2.outputs.cache-hit != 'true'
        run: |
          curl -fsSL "https://github.com/libgit2/libgit2/archive/refs/tags/v${LIBGIT2_VERSION}.tar.gz" -o libgit2.tar.gz
          echo "${LIBGIT2_SHA256}  libgit2.tar.gz" | sha256sum --check
          tar xzf libgit2.tar.gz
          cmake -S "libgit2-${LIBGIT2_VERSION}" -B libgit2-build -DCMAKE_INSTALL_PREFIX="$HOME/libgit2" -DCMAKE_INSTALL_LIBDIR=lib $LIBGIT2_CMAKE_FLAGS
          cmake --build libgit2-build --parallel
          cmake --install libgit2-build

      - name: Setup PHP
        uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
        with:
          php-version: ${{ matrix.php }}
          extensions: ffi

      - name: Setup Problem Matchers
        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

      - name: Install Composer dependencies
        run: composer update --prefer-dist --no-interaction ${{ matrix.composer-flags }}

      - name: Execute PHPUnit
        run: LD_LIBRARY_PATH="$HOME/libgit2/lib" vendor/bin/phpunit
        env:
          GITLIB_DRIVER: ffi

  tests-os:
    name: Test ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: ['macos-latest', 'windows-latest']
    defaults:
      run:
        shell: bash

    steps:
      - name: Checkout Code
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - name: Setup PHP
        uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0
        with:
          php-version: '8.4'
          # Not all enabled by default on Windows.
          extensions: fileinfo, zlib

      - name: Setup Problem Matchers
        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

      - name: Install Composer dependencies
        run: composer update --prefer-dist --no-interaction

      - name: Execute PHPUnit
        run: php vendor/bin/phpunit