Changeset 63608

Timestamp:

09/13/2026 04:21:34 PM (7 hours ago)

Author:

lancewillett

Message:

Tests: Improve isolation of admin tests.

Reset menu registries and plugin-dependency static properties before and after tests. Remove the temporary MU-plugin directory after its fixture files are deleted.

Give list-table fixtures distinct screens and preserve whether the original hook suffix was set. Align the comments table's expected primary column with its declared default.

Allow updater tests to load Composer dependencies outside the checkout while exercising open_basedir restrictions.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/13181

Props jonsurrell, mindctrl.
See #65893.

Location:

trunk/tests/phpunit/tests/admin

Files:

• includesPlugin.php (modified) (2 diffs)
• plugin-dependencies/base.php (modified) (1 diff)
• wpAutomaticUpdater.php (modified) (3 diffs)
• wpListTable.php (modified) (4 diffs)

trunk/tests/phpunit/tests/admin/includesPlugin.php

@@ -12 +12 @@
          */
         public static $admin_id;
+
+        public function set_up() {
+                parent::set_up();
+                $this->reset_menu_globals();
+        }
+
+        public function tear_down() {
+                $this->reset_menu_globals();
+                parent::tear_down();
+        }
+
+        /**
+         * Resets the global menu registries modified by the menu API tests.
+         */
+        private function reset_menu_globals() {
+                global $menu, $submenu, $admin_page_hooks, $_registered_pages, $_parent_pages;
+
+                $menu              = array();
+                $submenu           = array();
+                $admin_page_hooks  = array();
+                $_registered_pages = array();
+                $_parent_pages     = array();
+        }
 
         public static function wpSetUpBeforeClass( $factory ) {
@@ -502 +525 @@
                 unlink( WPMU_PLUGIN_DIR . '/foo.php' );
                 unlink( WPMU_PLUGIN_DIR . '/bar.txt' );
+                rmdir( WPMU_PLUGIN_DIR );
 
                 $this->assertSame( array( 'foo.php' ), array_keys( $found ) );

trunk/tests/phpunit/tests/admin/plugin-dependencies/base.php

@@ -62 +62 @@
 
         /**
+         * Resets all static properties to a default value before each test.
+         */
+        public function set_up() {
+                parent::set_up();
+                $this->reset_static_properties();
+        }
+
+        /**
          * Resets all static properties to a default value after each test.
          */
         public function tear_down() {
+                $this->reset_static_properties();
+                parent::tear_down();
+        }
+
+        /**
+         * Resets all static properties to their default values.
+         */
+        private function reset_static_properties() {
                 foreach ( self::$static_properties as $name => $default_value ) {
                         $this->set_property_value( $name, $default_value );
                 }
-
-                parent::tear_down();
         }
 

trunk/tests/phpunit/tests/admin/wpAutomaticUpdater.php

@@ -39 +39 @@
                 parent::set_up();
                 add_filter( 'pre_wp_mail', '__return_false' );
+        }
+
+        /**
+         * Builds an open_basedir value that allows PHPUnit to load Composer dependencies.
+         *
+         * Composer dependencies may live outside a secondary worktree, and PHPUnit can
+         * load assertion-related classes after the restriction is set.
+         *
+         * @param string $abspath_grandparent Directory containing the repository.
+         * @return string The open_basedir value.
+         */
+        private function get_open_basedir_for_tests( $abspath_grandparent ) {
+                $composer_vendor_dir = dirname(
+                        ( new ReflectionClass( Composer\Autoload\ClassLoader::class ) )->getFileName(),
+                        2
+                );
+
+                return implode(
+                        PATH_SEPARATOR,
+                        array(
+                                sys_get_temp_dir(),
+                                wp_normalize_path( $abspath_grandparent ),
+                                wp_normalize_path( $composer_vendor_dir ),
+                        )
+                );
         }
 
@@ -613 +638 @@
 
                 $open_basedir_backup = ini_get( 'open_basedir' );
-                // Allow access to the directory one level above the repository.
-                ini_set( 'open_basedir', sys_get_temp_dir() . PATH_SEPARATOR . wp_normalize_path( $abspath_grandparent ) );
+                ini_set( 'open_basedir', $this->get_open_basedir_for_tests( $abspath_grandparent ) );
 
                 // Checking an allowed directory should succeed.
@@ -648 +672 @@
 
                 $open_basedir_backup = ini_get( 'open_basedir' );
-                // Allow access to the directory one level above the repository.
-                ini_set( 'open_basedir', sys_get_temp_dir() . PATH_SEPARATOR . wp_normalize_path( $abspath_grandparent ) );
+                ini_set( 'open_basedir', $this->get_open_basedir_for_tests( $abspath_grandparent ) );
 
                 // Checking a directory not within the allowed path should trigger an `open_basedir` warning.

trunk/tests/phpunit/tests/admin/wpListTable.php

@@ -18 +18 @@
          * Original value of $GLOBALS['hook_suffix'].
          *
-         * @var string
+         * @var string|null
          */
         private static $original_hook_suffix;
+
+        /**
+         * Whether $GLOBALS['hook_suffix'] existed before the test class ran.
+         *
+         * @var bool
+         */
+        private static $hook_suffix_was_set;
 
         public static function set_up_before_class() {
                 parent::set_up_before_class();
 
-                static::$original_hook_suffix = $GLOBALS['hook_suffix'];
+                static::$hook_suffix_was_set  = array_key_exists( 'hook_suffix', $GLOBALS );
+                static::$original_hook_suffix = $GLOBALS['hook_suffix'] ?? null;
 
                 require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
@@ -38 +46 @@
 
         public function clean_up_global_scope() {
-                global $hook_suffix;
-                $hook_suffix = static::$original_hook_suffix;
+                if ( static::$hook_suffix_was_set ) {
+                        $GLOBALS['hook_suffix'] = static::$original_hook_suffix;
+                } else {
+                        unset( $GLOBALS['hook_suffix'] );
+                }
+
                 parent::clean_up_global_scope();
         }
@@ -62 +74 @@
                 add_filter( 'list_table_primary_column', array( $hook, 'filter' ) );
 
-                /*
-                 * Set a dummy value for the current screen in the admin to prevent
-                 * `_get_list_table()` throwing.
-                 */
-                $GLOBALS['hook_suffix'] = 'my-hook';
-
-                $list_table = _get_list_table( $list_class );
+                $list_table = _get_list_table(
+                        $list_class,
+                        array( 'screen' => 'wp-list-table-test-' . sanitize_key( $list_class ) )
+                );
 
                 $column_headers = new ReflectionProperty( $list_table, '_column_headers' );
@@ -98 +107 @@
                 $list_primary_columns = array(
                         'WP_Application_Passwords_List_Table'         => 'name',
-                        'WP_Comments_List_Table'                      => 'author',
+                        'WP_Comments_List_Table'                      => 'comment',
                         'WP_Links_List_Table'                         => 'name',
                         'WP_Media_List_Table'                         => 'title',