php_unit.yml

name: Unit Tests

# Since Unit Tests are required to pass for each PR,
# we cannot disable them for documentation-only changes.
on:
  pull_request:
  push:
  # Allow manually triggering the workflow.
  workflow_dispatch:

# Cancels all previous workflow runs for pull requests that have not completed.
concurrency:
  # The concurrency group contains the workflow name and the branch name for pull requests
  # or the commit hash for any other events.
  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
  cancel-in-progress: true

jobs:
  test-php:
    name: PHP ${{ matrix.php }}${{ matrix.wordpress != '' && format( ' (WP {0}) ', matrix.wordpress ) || '' }} on ubuntu-latest
    runs-on: ubuntu-latest
    timeout-minutes: 20
    strategy:
      fail-fast: false
      matrix:
        php:
          - '8.2'
          - '8.3'
          - '8.4'
          - '8.5'
        wordpress:
          - '6.6'
          - '6.7'
          - '6.8'
          - '6.9'
          - '7.0'

    env:
      WP_ENV_PHP_VERSION: ${{ matrix.php }}
      WP_ENV_CORE: ${{ matrix.wordpress == '' && 'WordPress/WordPress' || format( 'https://wordpress.org/wordpress-{0}.zip', matrix.wordpress ) }}

    steps:
      - uses: actions/checkout@v5.0.0

      - name: Install Dependencies
        run: npm ci

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

      - name: Install PHP Dependencies
        run: composer install --no-interaction --no-progress --no-suggest --optimize-autoloader

      - name: Docker debug information
        run: |
          docker -v

      - name: General debug information
        run: |
          npm --version
          node --version
          php --version
          curl --version
          git --version
          locale -a
          echo "PHP version: ${WP_ENV_PHP_VERSION}"
          echo "WordPress version: ${WP_ENV_CORE}"

      - name: Start Docker environment
        run: npm run wp-env start

      - name: Log running Docker containers
        run: docker ps -a

      - name: Running unit tests
        run: |
          set -o pipefail
          npm run test

      # ------------------------------------------------ #
      # Build Plugin and Run Tests on Built Distribution #
      # ------------------------------------------------ #

      - name: Stop Docker environment
        run: npm run wp-env stop

      - name: Build Plugin
        run: bin/build.sh

      - name: Copy Test Files
        run: |
          cp .wp-env.json dist/.wp-env.json
          cp package.json dist/package.json
          cp package-lock.json dist/package-lock.json
          cp phpcs.xml dist/phpcs.xml
          cp phpunit.xml dist/phpunit.xml
          cp -r tests dist/tests
          cp -r utils dist/utils

      - name: Install Dist Composer Dependencies
        working-directory: dist
        run: composer install --no-interaction --no-progress --no-suggest --optimize-autoloader

      - name: Build Conflict Plugin
        working-directory: dist
        run: npm run build-conflict

      - name: Start Dist Docker environment
        working-directory: dist
        run: npm run wp-env start

      - name: Install Conflict Plugin
        working-directory: dist
        run: npm run install-conflict

      - name: Log running Dist Docker containers
        working-directory: dist
        run: docker ps -a

      - name: Running Dist unit tests
        working-directory: dist
        # We don't run phpcs here because the dist files are modified by the build script.
        run: |
          set -o pipefail
          npm run test:php