Changeset 53921 for trunk/tests/phpunit/tests/rest-api/rest-widgets-controller.php

Timestamp:

08/22/2022 10:42:59 PM (15 months ago)

Author:

SergeyBiryukov

Message:

Tests: Consistently skip tests for non-implemented methods in REST API test classes.

WordPress core test suite uses PHPUnit's beStrictAboutTestsThatDoNotTestAnything option set to true, which marks a test as risky when no assertions are performed.

REST API test classes have some empty tests for non-implemented methods because these test classes extend the abstract WP_Test_REST_Controller_Testcase class, which requires several methods to be implemented that don't necessarily make sense for all REST API routes.

Some of these empty tests were already marked as skipped, but not in a consistent manner. Since skipping these tests is intentional for the time being, this commit aims to bring some consistency and adjust them all to be more accurately reported as skipped instead of risky.

The skipping can be reconsidered in the future when the tests are either removed as unnecessary or updated to actually perform assertions related to their behavior.

Follow-up to [40534], [41176], [41228].

Props Mte90, tomepajk, johnbillion, zieladam, SergeyBiryukov.
See #40538, #41463, #55652.

File:

• trunk/tests/phpunit/tests/rest-api/rest-widgets-controller.php (modified) (2 diffs)

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

@@ -218 +218 @@
      */
     public function test_context_param() {
+        $this->markTestSkipped( 'Controller does not use get_context_param().' );
     }
 
@@ -1509 +1510 @@
 
     /**
-     * The test_prepare_item() method does not exist for sidebar.
+     * The prepare_item() method does not exist for sidebar.
      */
     public function test_prepare_item() {
+        $this->markTestSkipped( 'Controller does not implement prepare_item().' );
     }