Skip to content

Tests: Improve isolation for randomized admin tests #13181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sirreal wants to merge 1 commit into
base: trunk
Choose a base branch
from
+88 −12
Draft

Tests: Improve isolation for randomized admin tests #13181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions tests/phpunit/tests/admin/includesPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,29 @@ class Tests_Admin_IncludesPlugin extends WP_UnitTestCase {
*/
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 ) {
self::$admin_id = $factory->user->create( array( 'role' => 'administrator' ) );
self::_back_up_mu_plugins();
Expand Down Expand Up @@ -501,6 +524,7 @@ public function test_get_mu_plugins_should_ignore_files_without_php_extensions()
// Clean up.
unlink( WPMU_PLUGIN_DIR . '/foo.php' );
unlink( WPMU_PLUGIN_DIR . '/bar.txt' );
rmdir( WPMU_PLUGIN_DIR );

$this->assertSame( array( 'foo.php' ), array_keys( $found ) );
}
Expand Down
18 changes: 16 additions & 2 deletions tests/phpunit/tests/admin/plugin-dependencies/base.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,29 @@ public static function tear_down_after_class() {
parent::tear_down_after_class();
}

/**
* 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();
}

/**
Expand Down
31 changes: 27 additions & 4 deletions tests/phpunit/tests/admin/wpAutomaticUpdater.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,31 @@ public function 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 ),
)
);
}

/**
* Tests that `WP_Automatic_Updater::send_plugin_theme_email()` appends
* plugin URLs.
Expand Down Expand Up @@ -612,8 +637,7 @@ public function test_is_allowed_dir_should_return_true_if_open_basedir_is_set_an
$abspath_grandparent = trailingslashit( dirname( $abspath_parent ) );

$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.
$actual = self::$updater->is_allowed_dir( wp_normalize_path( ABSPATH ) );
Expand Down Expand Up @@ -647,8 +671,7 @@ public function test_is_allowed_dir_should_return_false_if_open_basedir_is_set_a
$abspath_grandparent = trailingslashit( dirname( $abspath_parent ) );

$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.
$actual = self::$updater->is_allowed_dir( '/.git' );
Expand Down
27 changes: 21 additions & 6 deletions tests/phpunit/tests/admin/wpListTable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,22 @@ class Tests_Admin_WpListTable extends WP_UnitTestCase {
/**
* 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';
}
Expand All @@ -37,8 +45,12 @@ public function set_up() {
}

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();
}

Expand Down Expand Up @@ -67,7 +79,10 @@ public function test_should_only_add_primary_column_when_needed( $list_class, $h
*/
$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' );
if ( PHP_VERSION_ID < 80100 ) {
Expand Down Expand Up @@ -97,7 +112,7 @@ public function data_should_only_add_primary_column_when_needed() {
*/
$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',
'WP_MS_Sites_List_Table' => 'blogname',
Expand Down
Loading