Changeset 51581

Timestamp:

08/07/2021 02:45:08 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Build/Test Tools: Fix message display in test bootstrap.

Any messages to the user which are echo-ed out in the test bootstrap will generally display on a command-line interface.

The *nix specific "\n" line ending will be ignored on Windows, making the messages less readable.

For new lines in CLI messages, PHP_EOL should be used instead.

This was already done in a few places in the script, but not consistently so. Fixed now.

Follow-up to ​[UT882], ​[UT890], [44723], [45020], [48592], [49535], [51560].

Props jrf.
See #53363.

File:

• trunk/tests/phpunit/includes/bootstrap.php (modified) (6 diffs)

trunk/tests/phpunit/includes/bootstrap.php

@@ -24 +24 @@
 
 if ( ! is_readable( $config_file_path ) ) {
-    echo "Error: wp-tests-config.php is missing! Please use wp-tests-config-sample.php to create a config file.\n";
+    echo 'Error: wp-tests-config.php is missing! Please use wp-tests-config-sample.php to create a config file.' . PHP_EOL;
     exit( 1 );
 }
@@ -32 +32 @@
 
 if ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS && ! is_dir( ABSPATH ) ) {
-    echo "Error: The /build/ directory is missing! Please run `npm run build` prior to running PHPUnit.\n";
+    echo 'Error: The /build/ directory is missing! Please run `npm run build` prior to running PHPUnit.' . PHP_EOL;
     exit( 1 );
 }
@@ -40 +40 @@
 if ( version_compare( $phpunit_version, '5.7.21', '<' ) ) {
     printf(
-        "Error: Looks like you're using PHPUnit %s. WordPress requires at least PHPUnit 5.7.21.\n",
+        'Error: Looks like you’re using PHPUnit %s. WordPress requires at least PHPUnit 5.7.21.' . PHP_EOL,
         $phpunit_version
     );
-    echo "Please use the latest PHPUnit version supported for the PHP version you are running the tests on.\n";
+    echo 'Please use the latest PHPUnit version supported for the PHP version you are running the tests on.' . PHP_EOL;
     exit( 1 );
 }
@@ -50 +50 @@
 $phpunit_polyfills_autoloader = __DIR__ . '/../../../vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php';
 if ( ! file_exists( $phpunit_polyfills_autoloader ) ) {
-    echo "Error: You need to run `composer update` before running the tests.\n";
-    echo "You can still use a PHPUnit phar to run them, but the dependencies do need to be installed.\n";
+    echo 'Error: You need to run `composer update` before running the tests.' . PHP_EOL;
+    echo 'You can still use a PHPUnit phar to run them, but the dependencies do need to be installed.' . PHP_EOL;
     exit( 1 );
 }
@@ -70 +70 @@
     if ( $missing_extensions ) {
         printf(
-            "Error: The following required PHP extensions are missing from the testing environment: %s.\n",
+            'Error: The following required PHP extensions are missing from the testing environment: %s.' . PHP_EOL,
             implode( ', ', $missing_extensions )
         );
-        echo "Please make sure they are installed and enabled.\n",
+        echo 'Please make sure they are installed and enabled.' . PHP_EOL,
         exit( 1 );
     }
@@ -94 +94 @@
 if ( $missing_constants ) {
     printf(
-        "Error: The following required constants are not defined: %s.\n",
+        'Error: The following required constants are not defined: %s.' . PHP_EOL,
         implode( ', ', $missing_constants )
     );
-    echo "Please check out `wp-tests-config-sample.php` for an example.\n",
+    echo 'Please check out `wp-tests-config-sample.php` for an example.' . PHP_EOL,
     exit( 1 );
 }