Changeset 53942 for trunk/tests/phpunit/tests/user/capabilities.php

Timestamp:

08/25/2022 03:34:24 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Explicitly declare all properties in various tests.

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.

File:

• trunk/tests/phpunit/tests/user/capabilities.php (modified) (4 diffs)

trunk/tests/phpunit/tests/user/capabilities.php

@@ -31 +31 @@
     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(
@@ -59 +68 @@
         $this->flush_roles();
 
+    }
+
+    /**
+     * Clean up after each test.
+     */
+    public function tear_down() {
+        unset( $this->role_test_wp_roles_init );
+
+        parent::tear_down();
     }
 
@@ -1997 +2015 @@
     }
 
-
-    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(
@@ -2016 +2032 @@
         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'] );
-
-        $role = $wp_roles->get_role( $this->_role_test_wp_roles_init['role'] );
+        $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'] );
 
         $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'] );
     }