Build/Test Tools: Allow the desired version of PHPUnit to be passed to the local Docker environment.

This introduces the `LOCAL_PHPUNIT` environment variable, which allows the desired version of PHPUnit to be specified when running the PHP tests within the local Docker environment.

Because support for newer versions of PHPUnit is not backported, some versions of PHP need the ability to run multiple versions of PHPUnit for different branches. This adds the flexibility needed to use the Docker environment within those older branches to run the PHP tests.

Props johnbillion, SergeyBiryukov.
Merges [49362] to the 5.3 branch.
Fixes #50042.

git-svn-id: https://develop.svn.wordpress.org/branches/5.3@49366 602fd350-edb4-49c9-b593-d223f7449a82

.env

@@ -3,6 +3,10 @@
 #
 # All of these options can be overriden by setting them as environment variables before starting
 # the environment. You will need to restart your environment when changing any of these.
+#
+# Below, the following substitutions can be made:
+# - '{version}': any major.minor PHP version from 5.2 onwards.
+# - '{phpunit_version}': any major PHPUnit version starting with 4.
 ##
 
 # The site will be available at http://localhost:LOCAL_PORT
@@ -11,10 +15,30 @@ LOCAL_PORT=8889
 # Where to run WordPress from. Valid options are 'src' and 'build'.
 LOCAL_DIR=src
 
-# The PHP version to use. Valid options are 'latest', and '{version}-fpm', where '{version}' is any
-# x.y PHP version from 5.2 onwards.
+# The PHP version to use. Valid options are 'latest', and '{version}-fpm'.
 LOCAL_PHP=latest
 
+##
+# The PHPUnit version to use when running tests.
+#
+# Support for new PHPUnit versions is not backported to past versions, so some old WordPress branches require an older
+# version to run tests.
+#
+# Valid versions are:
+# - 'latest' for the highest version of PHPUnit supported on the highest version of PHP supported.
+# - '{version}-fpm' for the highest version of PHPUnit supported on the specified version of PHP.
+# - '{phpunit_version}-php-{version}-fpm' for a specific version of PHPUnit on the specified version of PHP. This format
+# is only available for PHP versions 5.6 and higher.
+#
+# For the full list of available options, see https://hub.docker.com/r/wordpressdevelop/phpunit/tags.
+#
+# For full documentation on PHPUnit compatibility and WordPress versions, see
+# https://make.wordpress.org/core/handbook/references/phpunit-compatibility-and-wordpress-versions/.
+#
+# This defaults to the value assigned to the value of LOCAL_PHP.
+##
+LOCAL_PHPUNIT=${LOCAL_PHP}
+
 # Whether or not to enable XDebug.
 LOCAL_PHP_XDEBUG=false
 

.travis.yml

@@ -25,7 +25,7 @@ env:
 
 matrix:
   include:
-  - env: WP_TRAVISCI=test:e2e
+  - env: WP_TRAVISCI=test:e2e LOCAL_PHPUNIT=7.4-fpm
     name: E2E Tests
   - env: WP_TRAVISCI=lint:php COMPOSER_INSTALL=true NPM_INSTALL=false WP_INSTALL=false
     name: PHP Linting
@@ -33,25 +33,25 @@ matrix:
     name: JS Tests
   - env: WP_TRAVISCI=test:compat COMPOSER_INSTALL=true NPM_INSTALL=false WP_INSTALL=false
     name: "PHP Compatibility Check"
-  - env: LOCAL_PHP=7.4-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=7.4-fpm LOCAL_PHPUNIT=7.4-fpm WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 7.4"
-  - env: LOCAL_PHP=7.3-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=7.3-fpm LOCAL_PHPUNIT=7.3-fpm WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 7.3"
-  - env: LOCAL_PHP=7.3-fpm LOCAL_PHP_MEMCACHED=true WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=7.3-fpm LOCAL_PHPUNIT=7.3-fpm LOCAL_PHP_MEMCACHED=true WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 7.3 with Memcached"
-  - env: LOCAL_PHP=7.2-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=7.2-fpm LOCAL_PHPUNIT=7.2-fpm WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 7.2"
-  - env: LOCAL_PHP=7.1-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=7.1-fpm LOCAL_PHPUNIT=7.1-fpm WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 7.1"
-  - env: LOCAL_PHP=7.0-fpm WP_TEST_REPORTER=true WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=7.0-fpm LOCAL_PHPUNIT=7.0-fpm WP_TEST_REPORTER=true WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 7.0"
-  - env: LOCAL_PHP=5.6-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=5.6-fpm LOCAL_PHPUNIT=5.6-fpm WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 5.6"
-  - env: LOCAL_PHP=8.0-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=8.0-fpm LOCAL_PHPUNIT=8.0-fpm WP_TRAVISCI=test:php
     name: "PHPUnit Tests: PHP 8.0"
   allow_failures:
   - env: WP_TRAVISCI=test:compat COMPOSER_INSTALL=true NPM_INSTALL=false WP_INSTALL=false
-  - env: LOCAL_PHP=8.0-fpm WP_TRAVISCI=test:php
+  - env: LOCAL_PHP=8.0-fpm LOCAL_PHPUNIT=8.0-fpm WP_TRAVISCI=test:php
   fast_finish: true
 
 before_install:

docker-compose.yml

@@ -93,7 +93,7 @@ services:
   # The PHPUnit container.
   ##
   phpunit:
-    image: wordpressdevelop/phpunit:${LOCAL_PHP-latest}
+    image: wordpressdevelop/phpunit:${LOCAL_PHPUNIT-latest}
 
     networks:
       - wpdevnet

package-lock.json

@@ -7193,9 +7193,9 @@
 			}
 		},
 		"dotenv": {
-			"version": "8.1.0",
-			"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.1.0.tgz",
-			"integrity": "sha512-GUE3gqcDCaMltj2++g6bRQ5rBJWtkWTmqmD0fo1RnnMuUqHNCt2oTPeDnS9n6fKYvlhn7AeBkb38lymBtWBQdA==",
+			"version": "8.2.0",
+			"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.2.0.tgz",
+			"integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==",
 			"dev": true
 		},
 		"dotenv-expand": {

package.json

@@ -33,7 +33,7 @@
 		"check-node-version": "4.0.1",
 		"copy-webpack-plugin": "^5.0.4",
 		"cssnano": "4.1.10",
-		"dotenv": "8.1.0",
+		"dotenv": "8.2.0",
 		"dotenv-expand": "5.1.0",
 		"grunt": "~1.0.4",
 		"grunt-banner": "^0.6.0",

tools/local-env/scripts/docker.js

@@ -1,6 +1,8 @@
-const dotenv = require( 'dotenv' );
+const dotenv       = require( 'dotenv' );
+const dotenvExpand = require( 'dotenv-expand' );
 const { execSync } = require( 'child_process' );
-dotenv.config();
+
+dotenvExpand( dotenv.config() );
 
 // Execute any docker-compose command passed to this script.
 execSync( 'docker-compose ' + process.argv.slice( 2 ).join( ' ' ), { stdio: 'inherit' } );

tools/local-env/scripts/install.js

@@ -1,9 +1,10 @@
-const dotenv = require( 'dotenv' );
+const dotenv       = require( 'dotenv' );
+const dotenvExpand = require( 'dotenv-expand' );
 const wait_on = require( 'wait-on' );
 const { execSync } = require( 'child_process' );
 const { renameSync, readFileSync, writeFileSync } = require( 'fs' );
 
-dotenv.config();
+dotenvExpand( dotenv.config() );
 
 // Create wp-config.php.
 wp_cli( 'config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --path=/var/www/src --force' );

tools/local-env/scripts/start.js

@@ -1,7 +1,8 @@
-const dotenv = require( 'dotenv' );
+const dotenv       = require( 'dotenv' );
+const dotenvExpand = require( 'dotenv-expand' );
 const { execSync } = require( 'child_process' );
 
-dotenv.config();
+dotenvExpand( dotenv.config() );
 
 // Start the local-env containers.
 execSync( 'docker-compose up -d wordpress-develop', { stdio: 'inherit' } );