Merge pull request #1053 from 10up/update/phpunit-workflow

Update how we run PHPUnit

Author: peterwilsoncc

.github/workflows/phpunit.yml

@@ -15,45 +15,68 @@ on:
 
 jobs:
   phpunit:
-    name: ${{ matrix.php }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+    name: Test PHP ${{ matrix.php }} WP ${{ matrix.wp }}
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:
-        php: [ '7.4', '8.0', '8.1' ]
-        os: [ ubuntu-latest ]
+        php: [ '8.4', '8.3', '8.2', '8.1', '8.0', '7.4' ]
+        wp: [ latest, trunk ]
+    env:
+      WP_ENV_PHP_VERSION: ${{ matrix.php }}
+      WP_ENV_CORE: ${{ matrix.wp == 'trunk' && 'WordPress/WordPress' || format( 'https://wordpress.org/wordpress-{0}.zip', matrix.wp ) }}
 
     steps:
-    - name: Checkout
-      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-
-    - name: Get composer cache directory
-      id: composer-cache
-      run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-
-    - name: Cache dependencies
-      id: cache-composer
-      uses: actions/cache@d4323d4df104b026a6aa633fdb11d772146be0bf # v4.2.2
-      env:
-        cache-name: cache-composer
-      with:
-        path: ${{ steps.composer-cache.outputs.dir }}
-        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/composer.lock') }}
-
-    - uses: getong/mariadb-action@d6d2ec41fd5588f369be4c9398ce77ee725ca9ea # v1.11
-
-    - name: Set PHP version
-      uses: shivammathur/setup-php@9e72090525849c5e82e596468b86eb55e9cc5401 # v2.32.0
-      with:
-        php-version: ${{ matrix.php }}
-        coverage: none
-        tools: phpunit-polyfills, composer:v2
-
-    - name: Install dependencies
-      run: composer update -W
-
-    - name: Setup WP Tests
-      run: bash bin/install-wp-tests.sh wordpress_test root '' 127.0.0.1
-
-    - name: PHPUnit
-      run: './vendor/bin/phpunit'
+      - name: Configure environment variables
+        run: |
+          echo "PHP_FPM_UID=$(id -u)" >> "$GITHUB_ENV"
+          echo "PHP_FPM_GID=$(id -g)" >> "$GITHUB_ENV"
+
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          show-progress: ${{ runner.debug == '1' && 'true' || 'false' }}
+          persist-credentials: false
+
+      ##
+      # 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@ec406be512d7077f68eed36e63f4d91bc006edc4 # v2.35.4
+        with:
+          php-version: '${{ matrix.php }}'
+          coverage: none
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@3cf229dc2919194e9e36783941438d17239e8520 # v3.1.1
+
+      - name: Setup Node
+        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+        with:
+          cache: 'npm'
+          node-version-file: '.nvmrc'
+
+      - name: Install NPM dependencies
+        run: npm ci
+
+      - name: Start the Docker testing environment
+        uses: nick-fields/retry@ce71cc2ab81d554ebbe88c79ab5975992d79ba08 # v3.0.2
+        with:
+          timeout_minutes: 10
+          max_attempts: 3
+          command: |
+            npm run env start
+
+      - name: Log versions
+        run: |
+          npm run env -- run cli php -- -v
+          npm run env -- run cli wp core version
+
+      - name: Run PHPUnit tests
+        id: phpunit
+        run: |
+          npm run test:php

.gitignore

@@ -44,11 +44,13 @@ Desktop.ini
 
 config.local.php
 
-# cypress.
+# Tests.
 tests/cypress/downloads
 tests/cypress/screenshots
 tests/cypress/videos
 tests/cypress/reports
+/tests/_output/*
+!/tests/_output/.gitkeep
 .wp-env.override.json
 
 # docs

.wp-env.json

@@ -1,7 +1,21 @@
 {
+  "$schema": "https://schemas.wp.org/trunk/wp-env.json",
+  "core": null,
   "plugins": [".", "./tests/test-plugin", "https://downloads.wordpress.org/plugin/classic-editor.zip", "https://downloads.wordpress.org/plugin/elasticpress.zip", "https://downloads.wordpress.org/plugin/woocommerce.zip"],
   "env": {
+    "development": {
+      "config": {
+        "WP_DEVELOPMENT_MODE": "plugin",
+        "WP_ENVIRONMENT_TYPE": "development",
+        "WP_DEBUG": true,
+        "WP_DEBUG_LOG": "/var/www/html/wp-content/plugins/classifai/tests/_output/debug.log"
+      }
+    },
     "tests": {
+      "config": {
+        "WP_DEBUG": true,
+        "FS_METHOD": "direct"
+      },
       "mappings": {
         "wp-cli.yml": "./tests/bin/wp-cli.yml"
       }

bin/install-wp-tests.sh

@@ -33,7 +33,8 @@
     "phpstan/phpstan-deprecation-rules": "2.0.3",
     "sirbrillig/phpcs-changed": "^2.12.0",
     "szepeviktor/phpstan-wordpress": "^2.0.3",
-    "yoast/phpunit-polyfills": "^1.0.0"
+    "wp-phpunit/wp-phpunit": "^6.9",
+    "yoast/phpunit-polyfills": "^4.0"
   },
   "scripts": {
     "lint": "phpcs -s . --runtime-set testVersion 7.4-",