vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Code Modernization: Explicitly declare all properties in various tests.

Browse Source 
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.

In each of the cases included in this commit, one or more individual tests set a property to allow a filter or action access to certain information.

This commit:
* Explicitly declares these properties and documents in which tests they are being used.
* Adds a reset to the default value of the property to a pre-existing `tear_down()` method or adds that method specifically for that purpose. This ensures that tests do not accidentally “taint” each other.

As these properties are being declared on test classes, they are marked as private. Even though the original dynamic property was public, this should not be considered a backward compatibility break as this only involves test classes.

Includes:
* In the `Tests_Post_Query` class, there were two tests assigning a value to an undeclared `$post_id` property, but subsequently not using the property, so those assignments should have been to a local variable (if they should be assignments at all).
* In the `Test_User_Capabilities` class, the property name had a leading `_` underscore. This is an outdated PHP 4 practice to indicate a private property. As PHP 4 is no longer supported, the leading underscore is removed from the property name.
* In the `Tests_User_Capabilities` class, an unused `$_role_test_wp_roles_role` property was declared somewhere in the middle of the class. That property is now removed in favor of `$_role_test_wp_roles_init`, which appears to be the intended name, previously misspelled.

Follow-up to [27294], [36277], [36750], [37712], [38571], [39082], [40290], [43049], [44628], [48328], [53557], [53558], [53850], [53851], [53852], [53853], [53854], [53856], [53916], [53935], [53936], [53937], [53938].

Props jrf.
See #56033.

git-svn-id: https://develop.svn.wordpress.org/trunk@53942 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2022-08-25 15:34:24 +00:00
parent 7f7d616d82
commit dfb4737c43
9 changed files with 177 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
tests/phpunit/tests/actions.php
View File

@ -7,6 +7,35 @@
*/
class Tests_Actions extends WP_UnitTestCase {
/**
* Flag to keep track whether a certain filter has been applied.
*
* Used in the `test_doing_filter_real()` test method.
*
* @var bool
*/
private $apply_testing_filter = false;
/**
* Flag to keep track whether a certain filter has been applied.
*
* Used in the `test_doing_filter_real()` test method.
*
* @var bool
*/
private $apply_testing_nested_filter = false;
/**
* Clean up after each test.
*/
public function tear_down() {
// Make sure potentially changed properties are reverted to their default value.
$this->apply_testing_filter = false;
$this->apply_testing_nested_filter = false;
parent::tear_down();
}
/**
* @covers ::do_action
*/

19
tests/phpunit/tests/admin/wpPrivacyRequestsTable.php
View File

@ -16,6 +16,25 @@
* @since 5.1.0
*/
class Tests_Admin_wpPrivacyRequestsTable extends WP_UnitTestCase {
/**
* Temporary storage for SQL to allow a filter to access it.
*
* Used in the `test_columns_should_be_sortable()` test method.
*
* @var string
*/
private $sql;
/**
* Clean up after each test.
*/
public function tear_down() {
unset( $this->sql );
parent::tear_down();
}
/**
* Get instance for mocked class.
*

20
tests/phpunit/tests/comment/query.php
View File

@ -9,10 +9,26 @@ class Tests_Comment_Query extends WP_UnitTestCase {
protected static $post_id;
protected $comment_id;
/**
* Temporary storage for comment exclusions to allow a filter to access these.
*
* Used in the following tests:
* - `test_comment_clauses_prepend_callback_should_be_respected_when_filling_descendants()`
* - `test_comment_clauses_append_callback_should_be_respected_when_filling_descendants()`
*
* @var array
*/
private $to_exclude;
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$post_id = $factory->post->create();
}
public function tear_down() {
unset( $this->to_exclude );
parent::tear_down();
}
/**
* @covers WP_Comment_Query::query
*/
@ -4301,8 +4317,6 @@ class Tests_Comment_Query extends WP_UnitTestCase {
);
remove_filter( 'comments_clauses', array( $this, 'prepend_exclusions' ) );
unset( $this->to_exclude );
$this->assertEqualSets( array( $top_level_0, $child1_of_0, $top_level_comments[0], $top_level_comments[2] ), wp_list_pluck( $q->comments, 'comment_ID' ) );
}
@ -4360,8 +4374,6 @@ class Tests_Comment_Query extends WP_UnitTestCase {
);
remove_filter( 'comments_clauses', array( $this, 'append_exclusions' ) );
unset( $this->to_exclude );
$this->assertEqualSets( array( $top_level_0, $child1_of_0, $top_level_comments[0], $top_level_comments[2] ), wp_list_pluck( $q->comments, 'comment_ID' ) );
}

26
tests/phpunit/tests/hooks/addFilter.php
View File

@ -11,6 +11,23 @@ class Tests_Hooks_AddFilter extends WP_UnitTestCase {
public $hook;
/**
* Temporary storage for action output.
*
* Used in the following tests:
* - `test_remove_and_add_action()`
* - `test_remove_and_add_last_action()`
* - `test_remove_and_recurse_and_add_action()`
*
* @var array
*/
private $action_output = '';
public function tear_down() {
$this->action_output = '';
parent::tear_down();
}
public function test_add_filter_with_function() {
$callback = '__return_null';
$hook = new WP_Hook();
@ -202,8 +219,7 @@ class Tests_Hooks_AddFilter extends WP_UnitTestCase {
}
public function test_remove_and_add_action() {
$this->hook = new WP_Hook();
$this->action_output = '';
$this->hook = new WP_Hook();
$this->hook->add_filter( 'remove_and_add_action', '__return_empty_string', 10, 0 );
@ -217,8 +233,7 @@ class Tests_Hooks_AddFilter extends WP_UnitTestCase {
}
public function test_remove_and_add_last_action() {
$this->hook = new WP_Hook();
$this->action_output = '';
$this->hook = new WP_Hook();
$this->hook->add_filter( 'remove_and_add_action', '__return_empty_string', 10, 0 );
@ -232,8 +247,7 @@ class Tests_Hooks_AddFilter extends WP_UnitTestCase {
}
public function test_remove_and_recurse_and_add_action() {
$this->hook = new WP_Hook();
$this->action_output = '';
$this->hook = new WP_Hook();
$this->hook->add_filter( 'remove_and_add_action', '__return_empty_string', 10, 0 );

23
tests/phpunit/tests/post/query.php
View File

@ -5,6 +5,25 @@
* @group post
*/
class Tests_Post_Query extends WP_UnitTestCase {
/**
* Temporary storage for a post ID for tests using filter callbacks.
*
* Used in the `test_posts_pre_query_filter_should_respect_set_found_posts()` method.
*
* @var int
*/
private $post_id;
/**
* Clean up after each test.
*/
public function tear_down() {
unset( $this->post_id );
parent::tear_down();
}
/**
* @group taxonomy
*/
@ -729,7 +748,7 @@ class Tests_Post_Query extends WP_UnitTestCase {
* @ticket 42469
*/
public function test_found_posts_should_be_integer_not_string() {
$this->post_id = self::factory()->post->create();
$post_id = self::factory()->post->create();
$q = new WP_Query(
array(
@ -744,7 +763,7 @@ class Tests_Post_Query extends WP_UnitTestCase {
* @ticket 42469
*/
public function test_found_posts_should_be_integer_even_if_found_posts_filter_returns_string_value() {
$this->post_id = self::factory()->post->create();
$post_id = self::factory()->post->create();
add_filter( 'found_posts', '__return_empty_string' );

10
tests/phpunit/tests/rewrite.php
View File

@ -8,6 +8,15 @@
class Tests_Rewrite extends WP_UnitTestCase {
private $home_url;
/**
* Temporary storage for blog id for use with filters.
*
* Used in the `test_url_to_postid_of_http_site_when_current_site_uses_https()` method.
*
* @var int
*/
private $blog_id_35531;
public function set_up() {
parent::set_up();
@ -22,6 +31,7 @@ class Tests_Rewrite extends WP_UnitTestCase {
$wp_rewrite->init();
update_option( 'home', $this->home_url );
unset( $this->blog_id_35531 );
parent::tear_down();
}

21
tests/phpunit/tests/term/query.php
View File

@ -4,6 +4,27 @@
* @group taxonomy
*/
class Tests_Term_Query extends WP_UnitTestCase {
/**
* Temporary storage for a term ID for tests using filter callbacks.
*
* Used in the following tests:
* - `test_null_term_object_should_be_discarded()`
* - `test_error_term_object_should_be_discarded()`
*
* @var int
*/
private $term_id;
/**
* Clean up after each test.
*/
public function tear_down() {
unset( $this->term_id );
parent::tear_down();
}
/**
* @ticket 37545
*/

18
tests/phpunit/tests/term/wpGetObjectTerms.php
View File

@ -7,11 +7,29 @@
class Tests_Term_WpGetObjectTerms extends WP_UnitTestCase {
private $taxonomy = 'wptests_tax';
/**
* Temporary storage for taxonomies for tests using filter callbacks.
*
* Used in the `test_taxonomies_passed_to_wp_get_object_terms_filter_should_be_quoted()` method.
*
* @var array
*/
private $taxonomies;
public function set_up() {
parent::set_up();
register_taxonomy( 'wptests_tax', 'post' );
}
/**
* Clean up after each test.
*/
public function tear_down() {
unset( $this->taxonomies );
parent::tear_down();
}
public function test_get_object_terms_by_slug() {
$post_id = self::factory()->post->create();

30
tests/phpunit/tests/user/capabilities.php
View File

@ -30,6 +30,15 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
*/
protected static $block_id;
/**
* Temporary storage for roles for tests using filter callbacks.
*
* Used in the `test_wp_roles_init_action()` method.
*
* @var array
*/
private $role_test_wp_roles_init;
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$users = array(
'anonymous' => new WP_User( 0 ),
@ -60,6 +69,15 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
}
/**
* Clean up after each test.
*/
public function tear_down() {
unset( $this->role_test_wp_roles_init );
parent::tear_down();
}
public static function wpTearDownAfterClass() {
wp_delete_post( self::$block_id, true );
}
@ -1996,13 +2014,11 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
}
protected $_role_test_wp_roles_role;
/**
* @ticket 23016
*/
public function test_wp_roles_init_action() {
$this->_role_test_wp_roles_init = array(
$this->role_test_wp_roles_init = array(
'role' => 'test_wp_roles_init',
'info' => array(
'name' => 'Test WP Roles Init',
@ -2015,16 +2031,16 @@ class Tests_User_Capabilities extends WP_UnitTestCase {
remove_action( 'wp_roles_init', array( $this, '_hook_wp_roles_init' ) );
$expected = new WP_Role( $this->_role_test_wp_roles_init['role'], $this->_role_test_wp_roles_init['info']['capabilities'] );
$expected = new WP_Role( $this->role_test_wp_roles_init['role'], $this->role_test_wp_roles_init['info']['capabilities'] );
$role = $wp_roles->get_role( $this->_role_test_wp_roles_init['role'] );
$role = $wp_roles->get_role( $this->role_test_wp_roles_init['role'] );
$this->assertEquals( $expected, $role );
$this->assertContains( $this->_role_test_wp_roles_init['info']['name'], $wp_roles->role_names );
$this->assertContains( $this->role_test_wp_roles_init['info']['name'], $wp_roles->role_names );
}
public function _hook_wp_roles_init( $wp_roles ) {
$wp_roles->add_role( $this->_role_test_wp_roles_init['role'], $this->_role_test_wp_roles_init['info']['name'], $this->_role_test_wp_roles_init['info']['capabilities'] );
$wp_roles->add_role( $this->role_test_wp_roles_init['role'], $this->role_test_wp_roles_init['info']['name'], $this->role_test_wp_roles_init['info']['capabilities'] );
}
/**