Changeset 51480

Timestamp:

07/22/2021 05:39:03 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Tests: Modernize the WP_UnitTestCase_Base::assertEqualFields() method:

• Use assertSame() instead of fail() to display a proper message in case of failure.
• Add an optional $message parameter for consistency with other assertions.

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

See #53363.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (1 diff)

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -656 +656 @@
          * Asserts that the given fields are present in the given object.
          *
-         * @param object $object The object to check.
-         * @param array  $fields The fields to check.
-         */
-        public function assertEqualFields( $object, $fields ) {
+         * @since UT (3.7.0)
+         * @since 5.9.0 Added the `$message` parameter.
+         *
+         * @param object $object  The object to check.
+         * @param array  $fields  The fields to check.
+         * @param string $message Optional. Message to display when the assertion fails.
+         */
+        public function assertEqualFields( $object, $fields, $message = '' ) {
                 foreach ( $fields as $field_name => $field_value ) {
-                        if ( $object->$field_name !== $field_value ) {
-                                $this->fail();
-                        }
+                        $this->assertSame( $object->$field_name, $field_value, $message . ' Field values do not match.' );
                 }
         }