Changeset 54058 for trunk/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php

Timestamp:

09/01/2022 10:54:19 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Tests: Explicitly mark empty REST API tests as not performing any assertions.

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.

As these tests are intentionally empty, they were previously marked as skipped, so that they are not reported as risky.

This commit aims to further reduce noise in the test suite and effectively ignores these empty tests altogether, which seems like a more appropriate option at this time.

The @doesNotPerformAssertions annotation 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], [53921].

See #40538, #41463, #55652.

File:

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

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

@@ -311 +311 @@
     }
 
+    /**
+     * @doesNotPerformAssertions
+     */
     public function test_get_item() {
-        $this->markTestSkipped( 'Controller does not implement get_item().' );
-    }
-
+        // Controller does not implement get_item().
+    }
+
+    /**
+     * @doesNotPerformAssertions
+     */
     public function test_create_item() {
-        $this->markTestSkipped( 'Controller does not implement create_item().' );
-    }
-
+        // Controller does not implement create_item().
+    }
+
+    /**
+     * @doesNotPerformAssertions
+     */
     public function test_update_item() {
-        $this->markTestSkipped( 'Controller does not implement update_item().' );
-    }
-
+        // Controller does not implement update_item().
+    }
+
+    /**
+     * @doesNotPerformAssertions
+     */
     public function test_delete_item() {
-        $this->markTestSkipped( 'Controller does not implement delete_item().' );
+        // Controller does not implement delete_item().
     }
 
@@ -403 +415 @@
      *
      * @since 5.8.0
+     *
+     * @doesNotPerformAssertions
      */
     public function test_get_item_schema() {
-        $this->markTestSkipped( "The controller's schema is hardcoded, so tests would not be meaningful." );
+        // The controller's schema is hardcoded, so tests would not be meaningful.
     }