Changeset 51697

Timestamp:

08/30/2021 08:18:31 PM (3 years ago)

Author:

hellofromTonya

Message:

Tests: Test custom assertions parameter data type in WP_UnitTestCase_Base.

The following changes improve tests stability.

The assertEqualFields() method expects an object and a fields array as inputs and subsequently approaches the received parameters as such, but did not verify whether the received parameters are of the expected types.

Along the same lines, the assertSameSets(), assertEqualSets(), assertSameSetsWithIndex() and the assertEqualSetsWithIndex() methods all expect arrays for both the actual as well as the expected values and uses the array function [k]sort() on both, but never verified that the received inputs were actually arrays, which could lead to PHP errors on the sorting function calls.

Follow-up to [30687], [42343], [48937], [48939], [51480], [51481].

Props jrf.
See #53363.

File:

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

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

@@ -686 +686 @@
      */
     public function assertEqualFields( $object, $fields, $message = '' ) {
+        $this->assertIsObject( $object, $message . ' Passed $object is not an object.' );
+        $this->assertIsArray( $fields, $message . ' Passed $fields is not an array.' );
+        $this->assertNotEmpty( $fields, $message . ' Fields array is empty.' );
+
         foreach ( $fields as $field_name => $field_value ) {
             $this->assertObjectHasAttribute( $field_name, $object, $message . " Property $field_name does not exist on the object." );
@@ -761 +765 @@
      */
     public function assertSameSets( $expected, $actual, $message = '' ) {
+        $this->assertIsArray( $expected, $message . ' Expected value must be an array.' );
+        $this->assertIsArray( $actual, $message . ' Value under test is not an array.' );
+
         sort( $expected );
         sort( $actual );
@@ -777 +784 @@
      */
     public function assertEqualSets( $expected, $actual, $message = '' ) {
+        $this->assertIsArray( $expected, $message . ' Expected value must be an array.' );
+        $this->assertIsArray( $actual, $message . ' Value under test is not an array.' );
+
         sort( $expected );
         sort( $actual );
@@ -793 +803 @@
      */
     public function assertSameSetsWithIndex( $expected, $actual, $message = '' ) {
+        $this->assertIsArray( $expected, $message . ' Expected value must be an array.' );
+        $this->assertIsArray( $actual, $message . ' Value under test is not an array.' );
+
         ksort( $expected );
         ksort( $actual );
@@ -809 +822 @@
      */
     public function assertEqualSetsWithIndex( $expected, $actual, $message = '' ) {
+        $this->assertIsArray( $expected, $message . ' Expected value must be an array.' );
+        $this->assertIsArray( $actual, $message . ' Value under test is not an array.' );
+
         ksort( $expected );
         ksort( $actual );