Changeset 54047 for trunk/tests/phpunit/tests/site-health.php

Timestamp:

09/01/2022 03:26:29 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Site Health: Some documentation and test improvements for WP_Site_Health:

• Add a @coversDefaultClass annotation to address @covers ::get_test_page_cache" is invalid notices.
• Rename data providers to start with the data_ prefix and match the test method names, for consistency.
• Move data providers next to the test methods they are used in.
• Move ::get_test_page_cache() closer to ::get_test_persistent_object_cache(), for a bit more predictable placement.
• Fix a typo in ::get_test_persistent_object_cache() description.

Follow-up to [53955], [54043], [54044], [54045].

See #56041.

File:

• trunk/tests/phpunit/tests/site-health.php (modified) (4 diffs)

trunk/tests/phpunit/tests/site-health.php

@@ -3 +3 @@
 /**
  * @group site-health
+ *
+ * @coversDefaultClass WP_Site_Health
  */
 class Tests_Site_Health extends WP_UnitTestCase {
@@ -111 +113 @@
     /**
      * @ticket 56041
-     * @dataProvider data_page_cache_test
+     * @dataProvider data_get_page_cache
      * @covers ::get_test_page_cache()
      * @covers ::get_page_cache_detail()
@@ -203 +205 @@
 
     /**
-     * @group ms-excluded
-     * @ticket 56040
-     */
-    public function test_object_cache_default_thresholds() {
-        $wp_site_health = new WP_Site_Health();
-
-        $this->assertFalse(
-            $wp_site_health->should_suggest_persistent_object_cache()
-        );
-    }
-
-
-    /**
-     * @group ms-required
-     * @ticket 56040
-     */
-    public function test_object_cache_default_thresholds_on_multisite() {
-        $wp_site_health = new WP_Site_Health();
-        $this->assertTrue(
-            $wp_site_health->should_suggest_persistent_object_cache()
-        );
-    }
-
-    /**
-     * @ticket 56040
-     */
-    public function test_object_cache_thresholds_check_can_be_bypassed() {
-        $wp_site_health = new WP_Site_Health();
-        add_filter( 'site_status_should_suggest_persistent_object_cache', '__return_true' );
-
-        $this->assertTrue(
-            $wp_site_health->should_suggest_persistent_object_cache()
-        );
-    }
-
-    /**
-     * @dataProvider thresholds
-     * @ticket 56040
-     */
-    public function test_object_cache_thresholds( $threshold, $count ) {
-        $wp_site_health = new WP_Site_Health();
-        add_filter(
-            'site_status_persistent_object_cache_thresholds',
-            function ( $thresholds ) use ( $threshold, $count ) {
-                return array_merge( $thresholds, array( $threshold => $count ) );
-            }
-        );
-
-        $this->assertTrue(
-            $wp_site_health->should_suggest_persistent_object_cache()
-        );
-    }
-
-    /**
-     * Gets response data for get_test_page_cache().
+     * Data provider for test_get_page_cache().
+     *
+     * Gets response data for WP_Site_Health::get_test_page_cache().
+     *
      * @ticket 56041
      *
      * @return array[]
      */
-    public function data_page_cache_test() {
+    public function data_get_page_cache() {
         $recommended_label = 'Page cache is not detected but the server response time is OK';
         $good_label        = 'Page cache is detected and the server response time is good';
@@ -409 +360 @@
 
     /**
-     * Data provider.
-     *
+     * @group ms-excluded
      * @ticket 56040
      */
-    public function thresholds() {
+    public function test_object_cache_default_thresholds() {
+        $wp_site_health = new WP_Site_Health();
+
+        $this->assertFalse(
+            $wp_site_health->should_suggest_persistent_object_cache()
+        );
+    }
+
+
+    /**
+     * @group ms-required
+     * @ticket 56040
+     */
+    public function test_object_cache_default_thresholds_on_multisite() {
+        $wp_site_health = new WP_Site_Health();
+        $this->assertTrue(
+            $wp_site_health->should_suggest_persistent_object_cache()
+        );
+    }
+
+    /**
+     * @ticket 56040
+     */
+    public function test_object_cache_thresholds_check_can_be_bypassed() {
+        $wp_site_health = new WP_Site_Health();
+        add_filter( 'site_status_should_suggest_persistent_object_cache', '__return_true' );
+
+        $this->assertTrue(
+            $wp_site_health->should_suggest_persistent_object_cache()
+        );
+    }
+
+    /**
+     * @dataProvider data_object_cache_thresholds
+     * @ticket 56040
+     */
+    public function test_object_cache_thresholds( $threshold, $count ) {
+        $wp_site_health = new WP_Site_Health();
+        add_filter(
+            'site_status_persistent_object_cache_thresholds',
+            function ( $thresholds ) use ( $threshold, $count ) {
+                return array_merge( $thresholds, array( $threshold => $count ) );
+            }
+        );
+
+        $this->assertTrue(
+            $wp_site_health->should_suggest_persistent_object_cache()
+        );
+    }
+
+    /**
+     * Data provider for test_object_cache_thresholds().
+     *
+     * @ticket 56040
+     */
+    public function data_object_cache_thresholds() {
         return array(
             array( 'comments_count', 0 ),