Changeset 51478 for trunk/tests/phpunit/includes/abstract-testcase.php

Timestamp:

07/22/2021 05:14:44 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Tests: Add a $message parameter for custom assertions in WP_UnitTestCase_Base.

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 the assertion methods in the WP_UnitTestCase_Base class that were missing it.

Props jrf.
See #53363.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (9 diffs)

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

@@ -670 +670 @@
          * Asserts that two values are equal, with whitespace differences discarded.
          *
+         * @since UT (3.7.0)
+         * @since 5.9.0 Added the `$message` parameter.
+         *
          * @param string $expected The expected value.
          * @param string $actual   The actual value.
-         */
-        public function assertDiscardWhitespace( $expected, $actual ) {
-                $this->assertEquals( preg_replace( '/\s*/', '', $expected ), preg_replace( '/\s*/', '', $actual ) );
+         * @param string $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertDiscardWhitespace( $expected, $actual, $message = '' ) {
+                $this->assertEquals( preg_replace( '/\s*/', '', $expected ), preg_replace( '/\s*/', '', $actual, $message ) );
         }
 
@@ -682 +686 @@
          * @since 5.6.0
          * @since 5.8.0 Added support for nested arrays.
+         * @since 5.9.0 Added the `$message` parameter.
          *
          * @param string|array $expected The expected value.
          * @param string|array $actual   The actual value.
-         */
-        public function assertSameIgnoreEOL( $expected, $actual ) {
+         * @param string       $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertSameIgnoreEOL( $expected, $actual, $message = '' ) {
                 $expected = map_deep(
                         $expected,
@@ -701 +707 @@
                 );
 
-                $this->assertSame( $expected, $actual );
+                $this->assertSame( $expected, $actual, $message );
         }
 
@@ -709 +715 @@
          * @since 5.4.0
          * @since 5.6.0 Turned into an alias for `::assertSameIgnoreEOL()`.
+         * @since 5.9.0 Added the `$message` parameter.
          *
          * @param string $expected The expected value.
          * @param string $actual   The actual value.
-         */
-        public function assertEqualsIgnoreEOL( $expected, $actual ) {
-                $this->assertSameIgnoreEOL( $expected, $actual );
+         * @param string $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertEqualsIgnoreEOL( $expected, $actual, $message = '' ) {
+                $this->assertSameIgnoreEOL( $expected, $actual, $message );
         }
 
@@ -721 +729 @@
          *
          * @since 5.6.0
-         *
-         * @param array $expected Expected array.
-         * @param array $actual   Array to check.
-         */
-        public function assertSameSets( $expected, $actual ) {
+         * @since 5.9.0 Added the `$message` parameter.
+         *
+         * @param array  $expected Expected array.
+         * @param array  $actual   Array to check.
+         * @param string $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertSameSets( $expected, $actual, $message = '' ) {
                 sort( $expected );
                 sort( $actual );
-                $this->assertSame( $expected, $actual );
+                $this->assertSame( $expected, $actual, $message );
         }
 
@@ -735 +745 @@
          *
          * @since 3.5.0
-         *
-         * @param array $expected Expected array.
-         * @param array $actual   Array to check.
-         */
-        public function assertEqualSets( $expected, $actual ) {
+         * @since 5.9.0 Added the `$message` parameter.
+         *
+         * @param array  $expected Expected array.
+         * @param array  $actual   Array to check.
+         * @param string $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertEqualSets( $expected, $actual, $message = '' ) {
                 sort( $expected );
                 sort( $actual );
-                $this->assertEquals( $expected, $actual );
+                $this->assertEquals( $expected, $actual, $message );
         }
 
@@ -749 +761 @@
          *
          * @since 5.6.0
-         *
-         * @param array $expected Expected array.
-         * @param array $actual   Array to check.
-         */
-        public function assertSameSetsWithIndex( $expected, $actual ) {
+         * @since 5.9.0 Added the `$message` parameter.
+         *
+         * @param array  $expected Expected array.
+         * @param array  $actual   Array to check.
+         * @param string $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertSameSetsWithIndex( $expected, $actual, $message = '' ) {
                 ksort( $expected );
                 ksort( $actual );
-                $this->assertSame( $expected, $actual );
+                $this->assertSame( $expected, $actual, $message );
         }
 
@@ -763 +777 @@
          *
          * @since 4.1.0
-         *
-         * @param array $expected Expected array.
-         * @param array $actual   Array to check.
-         */
-        public function assertEqualSetsWithIndex( $expected, $actual ) {
+         * @since 5.9.0 Added the `$message` parameter.
+         *
+         * @param array  $expected Expected array.
+         * @param array  $actual   Array to check.
+         * @param string $message  Optional. Message to display when the assertion fails.
+         */
+        public function assertEqualSetsWithIndex( $expected, $actual, $message = '' ) {
                 ksort( $expected );
                 ksort( $actual );
-                $this->assertEquals( $expected, $actual );
+                $this->assertEquals( $expected, $actual, $message );
         }
 
@@ -777 +793 @@
          *
          * @since 4.8.0
-         *
-         * @param array $array Array to check.
-         */
-        public function assertNonEmptyMultidimensionalArray( $array ) {
-                $this->assertIsArray( $array );
-                $this->assertNotEmpty( $array );
+         * @since 5.9.0 Added the `$message` parameter.
+         *
+         * @param array  $array   Array to check.
+         * @param string $message Optional. Message to display when the assertion fails.
+         */
+        public function assertNonEmptyMultidimensionalArray( $array, $message = '' ) {
+                $this->assertIsArray( $array, $message . ' Value under test is not an array.' );
+                $this->assertNotEmpty( $array, $message . ' Array is empty.' );
 
                 foreach ( $array as $sub_array ) {
-                        $this->assertIsArray( $sub_array );
-                        $this->assertNotEmpty( $sub_array );
+                        $this->assertIsArray( $sub_array, $message . ' Subitem of the array is not an array.' );
+                        $this->assertNotEmpty( $sub_array, $message . ' Subitem of the array is empty.' );
                 }
         }