Changeset 59085

Timestamp:

09/24/2024 06:09:41 PM (4 months ago)

Author:

SergeyBiryukov

Message:

Build/Test Tools: Check if the WordPress Importer plugin is installed in test bootstrap.

If a hard requirement for the test suite is not fulfilled, running the tests should be blocked from the test bootstrap. A test should only fail when it doesn't produce the expected result.

Since the WordPress Importer plugin is considered a hard requirement for the test suite at this time, this commit moves the check whether the plugin is installed from individual tests to the test bootstrap.

Includes defining a global constant for the path to the file for reuse in the tests.

Reference: ​Core Contributor Handbook: The Code Repository (Git): Unit Tests.

Follow-up to [40531], [40532], [41090], [41169], [48592], [49535], [49571].

Props jrf, hellofromTonya.
See #61530.

Location:

trunk/tests/phpunit

Files:

• includes/bootstrap.php (modified) (1 diff)
• tests/import/import.php (modified) (2 diffs)
• tests/import/parser.php (modified) (1 diff)
• tests/import/postmeta.php (modified) (1 diff)

trunk/tests/phpunit/includes/bootstrap.php

@@ -215 +215 @@
 define( 'DIR_TESTDATA', __DIR__ . '/../data' );
 define( 'DIR_TESTROOT', realpath( dirname( __DIR__ ) ) );
+define( 'IMPORTER_PLUGIN_FOR_TESTS', DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php' );
+
+if ( ! file_exists( IMPORTER_PLUGIN_FOR_TESTS ) ) {
+    echo 'The test suite requires the WordPress Importer plugin to be available in the `/data/plugins/` directory.'
+        . ' See: https://make.wordpress.org/core/handbook/contribute/git/#unit-tests' . PHP_EOL,
+    exit( 1 );
+}
 
 define( 'WP_LANG_DIR', realpath( DIR_TESTDATA . '/languages' ) );

trunk/tests/phpunit/tests/import/import.php

@@ -8 +8 @@
 class Tests_Import_Import extends WP_Import_UnitTestCase {
     public function set_up() {
+        global $wpdb;
+
         parent::set_up();
 
@@ -20 +22 @@
         add_filter( 'import_allow_create_users', '__return_true' );
 
-        if ( ! file_exists( DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php' ) ) {
-            $this->fail( 'This test requires the WordPress Importer plugin to be installed in the test suite. See: https://make.wordpress.org/core/handbook/contribute/git/#unit-tests' );
-        }
-
-        require_once DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php';
-
-        global $wpdb;
+        require_once IMPORTER_PLUGIN_FOR_TESTS;
+
         // Crude but effective: make sure there's no residual data in the main tables.
         foreach ( array( 'posts', 'postmeta', 'comments', 'terms', 'term_taxonomy', 'term_relationships', 'users', 'usermeta' ) as $table ) {

trunk/tests/phpunit/tests/import/parser.php

@@ -18 +18 @@
         }
 
-        if ( ! file_exists( DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php' ) ) {
-            $this->fail( 'This test requires the WordPress Importer plugin to be installed in the test suite. See: https://make.wordpress.org/core/handbook/contribute/git/#unit-tests' );
-        }
-
-        require_once DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php';
+        require_once IMPORTER_PLUGIN_FOR_TESTS;
     }
 

trunk/tests/phpunit/tests/import/postmeta.php

@@ -20 +20 @@
         }
 
-        if ( ! file_exists( DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php' ) ) {
-            $this->fail( 'This test requires the WordPress Importer plugin to be installed in the test suite. See: https://make.wordpress.org/core/handbook/contribute/git/#unit-tests' );
-        }
-
-        require_once DIR_TESTDATA . '/plugins/wordpress-importer/wordpress-importer.php';
+        require_once IMPORTER_PLUGIN_FOR_TESTS;
     }