Changeset 53935 for trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

Timestamp:

08/24/2022 01:09:03 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Remove dynamic properties in WP_Test_REST_Posts_Controller.

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 this particular case, the test_create_update_post_with_featured_media() method creates an attachment and writes the ID of the attachment to a dynamic (undeclared) property to be used as a flag to determine whether attachments need to be cleaned up after the test in the tear_down() method.

As the actual value of the property is irrelevant for the cleaning up and the property is realistically being used as a “flag”, this is now fixed as follows:

• Have an actual “flag” property declared with a descriptive name — $attachments_created — to make the code in the tear_down() more easily understandable.
• As for the actual ID of the attachment, save that to a test method local variable as that is the only place where it has any relevance.

Includes moving the tear_down() method up to be directly below the set_up() method.

Follow-up to [38832], [53557], [53558], [53850], [53851], [53852], [53853], [53854], [53856], [53916].

Props jrf.
See #56033.

File:

• trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (7 diffs)

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -26 +26 @@
     protected $forbidden_cat;
     protected $posts_clauses;
+
+    private $attachments_created = false;
 
     public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
@@ -114 +116 @@
         add_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
         add_filter( 'posts_clauses', array( $this, 'save_posts_clauses' ), 10, 2 );
+    }
+
+    public function tear_down() {
+        if ( true === $this->attachments_created ) {
+            $this->remove_added_uploads();
+            $this->attachments_created = false;
+        }
+
+        parent::tear_down();
     }
 
@@ -2772 +2783 @@
     public function test_create_update_post_with_featured_media() {
 
-        $file                = DIR_TESTDATA . '/images/canola.jpg';
-        $this->attachment_id = $this->factory->attachment->create_object(
+        $file          = DIR_TESTDATA . '/images/canola.jpg';
+        $attachment_id = $this->factory->attachment->create_object(
             $file,
             0,
@@ -2782 +2793 @@
         );
 
+        $this->attachments_created = true;
+
         wp_set_current_user( self::$editor_id );
 
@@ -2787 +2800 @@
         $params  = $this->set_post_data(
             array(
-                'featured_media' => $this->attachment_id,
+                'featured_media' => $attachment_id,
             )
         );
@@ -2794 +2807 @@
         $data     = $response->get_data();
         $new_post = get_post( $data['id'] );
-        $this->assertSame( $this->attachment_id, $data['featured_media'] );
-        $this->assertSame( $this->attachment_id, (int) get_post_thumbnail_id( $new_post->ID ) );
+        $this->assertSame( $attachment_id, $data['featured_media'] );
+        $this->assertSame( $attachment_id, (int) get_post_thumbnail_id( $new_post->ID ) );
 
         $request = new WP_REST_Request( 'POST', '/wp/v2/posts/' . $new_post->ID );
@@ -5278 +5291 @@
     }
 
-    public function tear_down() {
-        if ( isset( $this->attachment_id ) ) {
-            $this->remove_added_uploads();
-        }
-
-        parent::tear_down();
-    }
-
     /**
      * Internal function used to disable an insert query which