Changeset 58039

Timestamp:

04/23/2024 06:55:26 PM (11 days ago)

Author:

SergeyBiryukov

Message:

Tests: Add a $message parameter for a custom assertion in WP_Test_REST_TestCase.

All assertions in PHPUnit have a $message parameter. Setting this parameter allows to distinguish which assertion is failing when a test runs multiple assertions, making debugging of the tests easier.

This optional parameter is now added for WP_Test_REST_TestCase::assertErrorResponse().

Follow-up to [34928], [51478].

Props mykolashlyakhtun, antonvlasenko, swissspidy, SergeyBiryukov.
Fixes #60426.

File:

• trunk/tests/phpunit/includes/testcase-rest-api.php (modified) (2 diffs)

trunk/tests/phpunit/includes/testcase-rest-api.php

@@ -2 +2 @@
 
 abstract class WP_Test_REST_TestCase extends WP_UnitTestCase {
-    protected function assertErrorResponse( $code, $response, $status = null ) {
+
+    /**
+     * Asserts that the REST API response has the specified error.
+     *
+     * @since 4.4.0
+     * @since 6.6.0 Added the `$message` parameter.
+     *
+     * @param string|int                $code     Expected error code.
+     * @param WP_REST_Response|WP_Error $response REST API response.
+     * @param int                       $status   Optional. Status code.
+     * @param string                    $message  Optional. Message to display when the assertion fails.
+     */
+    protected function assertErrorResponse( $code, $response, $status = null, $message = '' ) {
 
         if ( $response instanceof WP_REST_Response ) {
@@ -8 +20 @@
         }
 
-        $this->assertWPError( $response );
-        $this->assertSame( $code, $response->get_error_code() );
+        $this->assertWPError( $response, $message );
+        $this->assertSame( $code, $response->get_error_code(), $message );
 
         if ( null !== $status ) {
             $data = $response->get_error_data();
-            $this->assertArrayHasKey( 'status', $data );
-            $this->assertSame( $status, $data['status'] );
+            $this->assertArrayHasKey( 'status', $data, $message );
+            $this->assertSame( $status, $data['status'], $message );
         }
     }