Changeset 51845 for branches/5.3/tests/phpunit/includes/bootstrap.php

Timestamp:

09/21/2021 11:58:31 PM (3 years ago)

Author:

hellofromTonya

Message:

Build/Test Tools: Introduce the PHPUnit Polyfills package for easier cross branch testing.

This backports the PHPUnit Polyfills package and related test infrastructure changes to make it easier for developers to continue testing on multiple versions WordPress while adding tests for newer versions of PHP, which require more modern PHPUnit practices.

One of the changes included is the addition of wrappers for the new snake_case fixture methods in PHPUnit. This allows the native camelCase standard in PHPUnit to be used, but allows for developers to transition to the new naming conventions.

Props hellofromTonya, jrf, SergeyBiryukov, johnbillion, netweb, schlessera, jeherve, lucatume, desrosj.
Merges [51559,51560,51810-51813,51828] to the 5.3 branch.
See #53911.

File:

• branches/5.3/tests/phpunit/includes/bootstrap.php (modified) (1 diff)

branches/5.3/tests/phpunit/includes/bootstrap.php

@@ -51 +51 @@
     exit( 1 );
 }
+
+/*
+ * Load the PHPUnit Polyfills autoloader.
+ *
+ * The PHPUnit Polyfills are a requirement for the WP test suite.
+ *
+ * For running the Core tests, the Make WordPress Core handbook contains step-by-step instructions
+ * on how to get up and running for a variety of supported workflows:
+ * {@link https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/#test-running-workflow-options}
+ *
+ * Plugin/theme integration tests can handle this in any of the following ways:
+ * - When using a full WP install: run `composer install` for the WP install prior to running the tests.
+ * - When using a partial WP test suite install:
+ *   - Add a `yoast/phpunit-polyfills` (dev) requirement to the plugin/theme's own `composer.json` file.
+ *   - And then:
+ *     - Either load the PHPUnit Polyfills autoload file prior to running the WP core bootstrap file.
+ *     - Or declare a `WP_TESTS_PHPUNIT_POLYFILLS_PATH` constant containing the absolute path to the
+ *       root directory of the PHPUnit Polyfills installation.
+ *       If the constant is used, it is strongly recommended to declare this constant in the plugin/theme's
+ *       own test bootstrap file.
+ *       The constant MUST be declared prior to calling this file.
+ */
+if ( ! class_exists( 'Yoast\PHPUnitPolyfills\Autoload' ) ) {
+    // Default location of the autoloader for WP core test runs.
+    $phpunit_polyfills_autoloader = dirname( dirname( dirname( __DIR__ ) ) ) . '/vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php';
+    $phpunit_polyfills_error      = false;
+
+    // Allow for a custom installation location to be provided for plugin/theme integration tests.
+    if ( defined( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH' ) ) {
+        $phpunit_polyfills_path = WP_TESTS_PHPUNIT_POLYFILLS_PATH;
+
+        if ( is_string( WP_TESTS_PHPUNIT_POLYFILLS_PATH )
+            && '' !== WP_TESTS_PHPUNIT_POLYFILLS_PATH
+        ) {
+            // Be tolerant to the path being provided including the filename.
+            if ( substr( $phpunit_polyfills_path, -29 ) !== 'phpunitpolyfills-autoload.php' ) {
+                $phpunit_polyfills_path = rtrim( $phpunit_polyfills_path, '/\\' );
+                $phpunit_polyfills_path = $phpunit_polyfills_path . '/phpunitpolyfills-autoload.php';
+            }
+
+            $phpunit_polyfills_autoloader = $phpunit_polyfills_path;
+        } else {
+            $phpunit_polyfills_error = true;
+        }
+    }
+
+    if ( $phpunit_polyfills_error || ! file_exists( $phpunit_polyfills_autoloader ) ) {
+        echo 'Error: The PHPUnit Polyfills library is a requirement for running the WP test suite.' . PHP_EOL;
+        if ( defined( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH' ) ) {
+            printf(
+                'The PHPUnit Polyfills autoload file was not found in "%s"' . PHP_EOL,
+                WP_TESTS_PHPUNIT_POLYFILLS_PATH
+            );
+            echo 'Please verify that the file path provided in the WP_TESTS_PHPUNIT_POLYFILLS_PATH constant is correct.' . PHP_EOL;
+            echo 'The WP_TESTS_PHPUNIT_POLYFILLS_PATH constant should contain an absolute path to the root directory'
+                . ' of the PHPUnit Polyfills library.' . PHP_EOL;
+        } elseif ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS ) {
+            echo 'You need to run `composer install` before running the tests.' . PHP_EOL;
+            echo 'Once the dependencies are installed, you can run the tests using the Composer-installed version'
+                . ' of PHPUnit or using a PHPUnit phar file, but the dependencies do need to be installed'
+                . ' whichever way the tests are run.' . PHP_EOL;
+        } else {
+            echo 'If you are trying to run plugin/theme integration tests, make sure the PHPUnit Polyfills library'
+                . ' (https://github.com/Yoast/PHPUnit-Polyfills) is available and either load the autoload file'
+                . ' of this library in your own test bootstrap before calling the WP Core test bootstrap file;'
+                . ' or set the absolute path to the PHPUnit Polyfills library in a "WP_TESTS_PHPUNIT_POLYFILLS_PATH"'
+                . ' constant to allow the WP Core bootstrap to load the Polyfills.' . PHP_EOL . PHP_EOL;
+            echo 'If you are trying to run the WP Core tests, make sure to set the "WP_RUN_CORE_TESTS" constant'
+                . ' to 1 and run `composer install` before running the tests.' . PHP_EOL;
+            echo 'Once the dependencies are installed, you can run the tests using the Composer-installed'
+                . ' version of PHPUnit or using a PHPUnit phar file, but the dependencies do need to be'
+                . ' installed whichever way the tests are run.' . PHP_EOL;
+        }
+        exit( 1 );
+    }
+
+    require_once $phpunit_polyfills_autoloader;
+}
+unset( $phpunit_polyfills_autoloader, $phpunit_polyfills_error, $phpunit_polyfills_path );
+
+/*
+ * Minimum version of the PHPUnit Polyfills package as declared in `composer.json`.
+ * Only needs updating when new polyfill features start being used in the test suite.
+ */
+$phpunit_polyfills_minimum_version = '1.0.1';
+if ( class_exists( '\Yoast\PHPUnitPolyfills\Autoload' )
+    && ( defined( '\Yoast\PHPUnitPolyfills\Autoload::VERSION' ) === false
+        || version_compare( Yoast\PHPUnitPolyfills\Autoload::VERSION, $phpunit_polyfills_minimum_version, '<' ) )
+) {
+    printf(
+        'Error: Version mismatch detected for the PHPUnit Polyfills.'
+        . ' Please ensure that PHPUnit Polyfills %s or higher is loaded. Found version: %s' . PHP_EOL,
+        $phpunit_polyfills_minimum_version,
+        defined( '\Yoast\PHPUnitPolyfills\Autoload::VERSION' ) ? Yoast\PHPUnitPolyfills\Autoload::VERSION : '1.0.0 or lower'
+    );
+    if ( defined( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH' ) ) {
+        printf(
+            'Please ensure that the PHPUnit Polyfill installation in "%s" is updated to version %s or higher.' . PHP_EOL,
+            WP_TESTS_PHPUNIT_POLYFILLS_PATH,
+            $phpunit_polyfills_minimum_version
+        );
+    } elseif ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS ) {
+        echo 'Please run `composer install` to install the latest version.' . PHP_EOL;
+    }
+    exit( 1 );
+}
+unset( $phpunit_polyfills_minimum_version );
 
 tests_reset__SERVER();