Changeset 52235

Timestamp:

11/23/2021 06:55:23 PM (5 years ago)

Author:

hellofromTonya

Message:

Build/Test Tools: Fix warnings from stdClass::__invoke() callback mocks in REST API tests.

When running core tests on PHPUnit 8.x and 9.x, four non-blocking warnings were displayed for the REST API tests:

There were 4 warnings:

1) Tests_REST_Request::test_route_level_validate_callback
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.

2) Tests_REST_Request::test_route_level_validate_callback_no_parameter_callbacks
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.

3) Tests_REST_Request::test_route_level_validate_callback_is_not_executed_if_parameter_validation_fails
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.

4) Tests_REST_Server::test_callbacks_are_not_executed_if_request_validation_fails
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.

These warnings are due to the PHP native stdClass not having a __invoke() method declared.

This commit adds a Mock_Invokable reusable class and replaces the stdClass with this new class.

Follow-up to [48945], [48947].

Props sourovroy, jrf.
Fixes #53844.

Location:

trunk

Files:

• phpcs.xml.dist (modified) (1 diff)
• tests/phpunit/includes/mock-invokable.php (added)
• tests/phpunit/tests/rest-api/rest-request.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (2 diffs)

trunk/phpcs.xml.dist

@@ -250 +250 @@
                                 <element value="WP_Image_Editor_Mock"/>
                                 <element value="WP_Filesystem_MockFS"/>
+                                <element value="Mock_Invokable"/>
                                 <element value="MockPHPMailer"/>
                                 <element value="MockAction"/>

trunk/tests/phpunit/tests/rest-api/rest-request.php

@@ -17 +17 @@
 
                 $this->request = new WP_REST_Request();
+        }
+
+        /**
+         * Called before setting up all tests.
+         */
+        public static function set_up_before_class() {
+                parent::set_up_before_class();
+
+                // Require files that need to load once.
+                require_once DIR_TESTROOT . '/includes/mock-invokable.php';
         }
 
@@ -1015 +1025 @@
 
                 $error    = new WP_Error( 'error_code', __( 'Error Message' ), array( 'status' => 400 ) );
-                $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
+                $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
                 $callback->expects( self::once() )->method( '__invoke' )->with( self::identicalTo( $request ) )->willReturn( $error );
                 $request->set_attributes(
@@ -1039 +1049 @@
 
                 $error    = new WP_Error( 'error_code', __( 'Error Message' ), array( 'status' => 400 ) );
-                $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
+                $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
                 $callback->expects( self::once() )->method( '__invoke' )->with( self::identicalTo( $request ) )->willReturn( $error );
                 $request->set_attributes(
@@ -1057 +1067 @@
                 $request->set_query_params( array( 'test' => 'value' ) );
 
-                $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
+                $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
                 $callback->expects( self::never() )->method( '__invoke' );
                 $request->set_attributes(

trunk/tests/phpunit/tests/rest-api/rest-server.php

@@ -34 +34 @@
 
                 parent::tear_down();
+        }
+
+        /**
+         * Called before setting up all tests.
+         */
+        public static function set_up_before_class() {
+                parent::set_up_before_class();
+
+                // Require files that need to load once.
+                require_once DIR_TESTROOT . '/includes/mock-invokable.php';
         }
 
@@ -1631 +1641 @@
          */
         public function test_callbacks_are_not_executed_if_request_validation_fails() {
-                $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
+                $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
                 $callback->expects( self::never() )->method( '__invoke' );
-                $permission_callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
+                $permission_callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
                 $permission_callback->expects( self::never() )->method( '__invoke' );