Changeset 51563

Timestamp:

08/06/2021 09:38:45 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Tests: Replace expectException() for PHP native errors with calls to the dedicated PHPUnit 8.4+ methods.

The old manner of testing these is soft deprecated as of PHPUnit 8.4, hard deprecated as of PHPUnit 9.0 and will be removed in PHPUnit 10.0.

These dedicated methods introduced in PHPUnit 8.4 should be used as an alternative:

• expectDeprecation()
• expectDeprecationMessage()
• expectDeprecationMessageMatches()
• expectNotice()
• expectNoticeMessage()
• expectNoticeMessageMatches()
• expectWarning()
• expectWarningMessage()
• expectWarningMessageMatches()
• expectError()
• expectErrorMessage()
• expectErrorMessageMatches()

These new PHPUnit methods are all polyfilled by the PHPUnit Polyfills and switching to these will future-proof the tests some more.

References:

• ​https://github.com/sebastianbergmann/phpunit/blob/8.4.3/ChangeLog-8.4.md#840---2019-10-04
• ​https://github.com/sebastianbergmann/phpunit/issues/3775

Follow-up to [51559-51562].

Props jrf.
See #46149.

Location:

trunk/tests/phpunit/tests

Files:

• compat.php (modified) (1 diff)
• dependencies/scripts.php (modified) (1 diff)
• locale.php (modified) (1 diff)
• rest-api/rest-block-directory-controller.php (modified) (1 diff)
• rest-api/rest-plugins-controller.php (modified) (1 diff)
• rest-api/rest-schema-sanitization.php (modified) (1 diff)
• rest-api/rest-schema-validation.php (modified) (1 diff)

trunk/tests/phpunit/tests/compat.php

@@ -181 +181 @@
 
     function test_json_encode_decode() {
-        $this->expectException( 'PHPUnit_Framework_Error_Deprecated' );
+        $this->expectDeprecation();
 
         require_once ABSPATH . WPINC . '/class-json.php';

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -1425 +1425 @@
         if ( $warning ) {
             if ( PHP_VERSION_ID < 80000 ) {
-                $this->expectException( 'PHPUnit_Framework_Error_Warning' );
+                $this->expectWarning();
             } else {
-                // As this exception will only be set on PHP 8 in combination with PHPUnit 7, this will work (for now).
+                /*
+                 * As this exception will only be set on PHP 8 in combination with PHPUnit 7, this will work (for now).
+                 * Once the PHPUnit version constraints have been widened and a _supported_ PHPUnit version is
+                 * used to run the tests on PHP 8.x, this should be changed to `$this->expectError()`.
+                 */
                 $this->expectException( 'Error' );
             }

trunk/tests/phpunit/tests/locale.php

@@ -28 +28 @@
     public function test_get_weekday_undefined_index() {
         if ( PHP_VERSION_ID >= 80000 ) {
-            $this->expectException( 'PHPUnit_Framework_Error_Warning' );
+            $this->expectWarning();
         } else {
-            $this->expectException( 'PHPUnit_Framework_Error_Notice' );
+            $this->expectNotice();
         }
 

trunk/tests/phpunit/tests/rest-api/rest-block-directory-controller.php

@@ -90 +90 @@
         $this->prevent_requests_to_host( 'api.wordpress.org' );
 
-        $this->expectException( 'PHPUnit_Framework_Error_Warning' );
+        $this->expectWarning();
         $response = rest_do_request( $request );
         $this->assertErrorResponse( 'plugins_api_failed', $response, 500 );

trunk/tests/phpunit/tests/rest-api/rest-plugins-controller.php

@@ -537 +537 @@
         $this->prevent_requests_to_host( 'api.wordpress.org' );
 
-        $this->expectException( 'PHPUnit_Framework_Error_Warning' );
+        $this->expectWarning();
         $response = rest_do_request( $request );
         $this->assertErrorResponse( 'plugins_api_failed', $response, 500 );

trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

@@ -458 +458 @@
     public function test_format_validation_is_applied_if_missing_type() {
         if ( PHP_VERSION_ID >= 80000 ) {
-            $this->expectException( 'PHPUnit_Framework_Error_Warning' ); // For the undefined index.
+            $this->expectWarning(); // For the undefined index.
         } else {
-            $this->expectException( 'PHPUnit_Framework_Error_Notice' );
+            $this->expectNotice(); // For the undefined index.
         }
 

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -158 +158 @@
     public function test_format_validation_is_applied_if_missing_type() {
         if ( PHP_VERSION_ID >= 80000 ) {
-            $this->expectException( 'PHPUnit_Framework_Error_Warning' ); // For the undefined index.
+            $this->expectWarning(); // For the undefined index.
         } else {
-            $this->expectException( 'PHPUnit_Framework_Error_Notice' );
+            $this->expectNotice(); // For the undefined index.
         }