tests.yml

name: Unit Tests

on:
  pull_request:
  push:
    branches:
      - master
  # 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:
  compute-previous-wordpress-version:
    name: Compute previous WordPress version
    runs-on: ubuntu-latest
    outputs:
      previous-wordpress-version: ${{ steps.get-previous-wordpress-version.outputs.previous-wordpress-version }}

    steps:
      - name: Get previous WordPress version
        id: get-previous-wordpress-version
        run: |
          curl \
            -H "Accept: application/json" \
            -o versions.json \
            "http://api.wordpress.org/core/stable-check/1.0/"
          LATEST_WP_VERSION=$(jq --raw-output 'with_entries(select(.value=="latest"))|keys[]' versions.json)
          IFS='.' read LATEST_WP_MAJOR LATEST_WP_MINOR LATEST_WP_PATCH <<< "${LATEST_WP_VERSION}"
          if [[ ${LATEST_WP_MINOR} == "0" ]]; then
            PREVIOUS_WP_SERIES="$((LATEST_WP_MAJOR - 1)).9"
          else
            PREVIOUS_WP_SERIES="${LATEST_WP_MAJOR}.$((LATEST_WP_MINOR - 1))"
          fi
          PREVIOUS_WP_VERSION=$(jq --raw-output --arg series "${PREVIOUS_WP_SERIES}" 'with_entries(select(.key|startswith($series)))|keys[-1]' versions.json)
          echo "previous-wordpress-version=${PREVIOUS_WP_VERSION}" >> $GITHUB_OUTPUT
          rm versions.json

  test-php:
    name: PHP ${{ matrix.php }}${{ matrix.wordpress != '' && format( ' (WP {0}) ', matrix.wordpress ) || '' }} on ubuntu-latest
    needs: compute-previous-wordpress-version
    runs-on: ubuntu-latest
    timeout-minutes: 20
    if: ${{ github.repository == 'nk-crew/visual-portfolio' || github.event_name == 'pull_request' }}
    strategy:
      fail-fast: true
      matrix:
        php:
          - '7.4'
          - '8.0'
          - '8.1'
          - '8.2'
        wordpress: [''] # Latest WordPress version.
        include:
          # Test with the previous WP version.
          - php: '7.4'
            wordpress: ${{ needs.compute-previous-wordpress-version.outputs.previous-wordpress-version }}
          - php: '8.2'
            wordpress: ${{ needs.compute-previous-wordpress-version.outputs.previous-wordpress-version }}

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

      - name: Setup Node.js and install dependencies
        uses: ./.github/setup-node

      ##
      # This allows Composer dependencies to be installed using a single step.
      #
      # Since the tests are currently run within the Docker containers where the PHP version varies,
      # the same PHP version needs to be configured for the action runner machine so that the correct
      # dependency versions are installed and cached.
      ##
      - name: Set up PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '${{ matrix.php }}'
          ini-file: development
          coverage: none

      # Ensure that Composer installs the correct versions of packages.
      - name: Override PHP version in composer.json
        run: composer config platform.php ${{ matrix.php }}

      # Since Composer dependencies are installed using `composer update` and no lock file is in version control,
      # passing a custom cache suffix ensures that the cache is flushed at least once per week.
      - name: Install Composer dependencies
        uses: ramsey/composer-install@v3
        with:
          custom-cache-suffix: $(/bin/date -u --date='last Mon' "+%F")

      - name: Npm build
        run: npm run build

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

      - name: General debug information
        run: |
          npm --version
          node --version
          curl --version
          git --version
          svn --version
          locale -a

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

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

      - name: Docker container debug information
        run: |
          npm run wp-env run tests-mysql mysql -- --version
          npm run wp-env run tests-wordpress php -- --version
          npm run wp-env run tests-wordpress php -m
          npm run wp-env run tests-wordpress php -i
          npm run wp-env run tests-wordpress /var/www/html/wp-content/plugins/visual-portfolio/vendor/bin/phpunit -- --version
          npm run wp-env run tests-wordpress locale -a

      - name: Running unit tests
        run: |
          set -o pipefail
          npm run test:unit:php | tee phpunit.log

      # Verifies that PHPUnit actually runs in the first place. We want visibility
      # into issues which can cause it to fail silently, so we check the output
      # to verify that at least 5 tests have passed. This is an arbitrary
      # number, but makes sure a drastic change doesn't happen without us noticing.
      - name: Check number of passed tests
        run: |
          # Note: relies on PHPUnit execution to fail on test failure.
          # Extract the number of executed tests from the log file.
          if ! num_tests=$(grep -Eo 'OK \([0-9]+ tests' phpunit.log) ; then
            if ! num_tests=$(grep -Eo 'Tests: [0-9]+, Assertions:' phpunit.log) ; then
              echo "PHPUnit failed or did not run. Check the PHPUnit output in the previous step to debug." && exit 1
            fi
          fi
          # Extract just the number of tests from the string.
          num_tests=$(echo "$num_tests" | grep -Eo '[0-9]+')
          if [ $num_tests -lt 5 ] ; then
            echo "Only $num_tests tests passed, which is much fewer than expected." && exit 1
          fi
          echo "$num_tests tests passed."

  lint:
    name: Lint JS + CSS
    runs-on: ubuntu-latest
    timeout-minutes: 20
    if: ${{ github.repository == 'nk-crew/visual-portfolio' || github.event_name == 'pull_request' }}

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js and install dependencies
        uses: ./.github/setup-node

      - name: Npm build
        run: npm run build

      - name: Running the lint
        run: npm run lint

  phpcs:
    name: PHP coding standards
    runs-on: ubuntu-latest
    timeout-minutes: 20
    if: ${{ github.repository == 'nk-crew/visual-portfolio' || github.event_name == 'pull_request' }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: '7.4'
          coverage: none
          tools: cs2pr

      # This date is used to ensure that the PHPCS cache is cleared at least once every week.
      # http://man7.org/linux/man-pages/man1/date.1.html
      - name: "Get last Monday's date"
        id: get-date
        run: echo "date=$(/bin/date -u --date='last Mon' "+%F")" >> $GITHUB_OUTPUT

      - name: Cache PHPCS scan cache
        uses: actions/cache@v4
        with:
          path: .cache/phpcs.json
          key: ${{ runner.os }}-date-${{ steps.get-date.outputs.date }}-phpcs-cache-${{ hashFiles('**/composer.json', 'phpcs.xml.dist') }}

      # Since Composer dependencies are installed using `composer update` and no lock file is in version control,
      # passing a custom cache suffix ensures that the cache is flushed at least once per week.
      - name: Install Composer dependencies
        uses: ramsey/composer-install@v3
        with:
          custom-cache-suffix: ${{ steps.get-date.outputs.date }}

      - name: Make Composer packages available globally
        run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH

      - name: Run PHPCS on all Visual Portfolio files
        id: phpcs-visual-portfolio
        run: phpcs --report-full --report-checkstyle=./.cache/phpcs-report.xml

      - name: Show PHPCS results in PR
        if: ${{ always() && steps.phpcs-visual-portfolio.outcome == 'failure' }}
        run: cs2pr ./.cache/phpcs-report.xml

      - name: Ensure version-controlled files are not modified during the tests
        run: git diff --exit-code