Changeset 53556

Timestamp:

06/22/2022 04:50:14 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Tests: Improve the test for sticky posts not being moved to the front in sitemaps.

• Give the test method a most descriptive name.
• Use a single assertion for the URL list instead of a foreach loop to provide more context in case of failure.
• Add a failure message to each assertion, as there are multiple assertions used in the test.

Follow-up to [53548].

See #55633.

File:

• trunk/tests/phpunit/tests/sitemaps/wpSitemapsPosts.php (modified) (2 diffs)

trunk/tests/phpunit/tests/sitemaps/wpSitemapsPosts.php

@@ -64 +64 @@
 
         /**
+         * Callback for 'wp_sitemaps_posts_show_on_front_entry' filter.
+         */
+        public function _show_on_front_entry( $sitemap_entry ) {
+                $sitemap_entry['lastmod'] = wp_date( DATE_W3C, time() );
+
+                return $sitemap_entry;
+        }
+
+        /**
          * Tests that sticky posts are not moved to the front of the first page of the post sitemap.
          *
          * @ticket 55633
          */
-        public function test_posts_sticky_posts() {
+        public function test_posts_sticky_posts_not_moved_to_front() {
                 $factory = self::factory();
 
@@ -80 +89 @@
                 $url_list = $posts_provider->get_url_list( 1, 'post' );
 
-                $this->assertCount( count( $post_ids ), $url_list );
+                $this->assertCount( count( $post_ids ), $url_list, 'The post count did not match.' );
+
+                $expected = array();
+
+                foreach ( $post_ids as $post_id ) {
+                        $expected[] = array( 'loc' => home_url( "?p={$post_id}" ) );
+                }
+
                 // Check that the URL list is still in the order of the post IDs (i.e., sticky post wasn't moved to the front).
-                foreach ( $post_ids as $idx => $post_id ) {
-                        $this->assertSame( array( 'loc' => home_url( "?p={$post_id}" ) ), $url_list[ $idx ] );
-                }
-        }
-
-        /**
-         * Callback for 'wp_sitemaps_posts_show_on_front_entry' filter.
-         */
-        public function _show_on_front_entry( $sitemap_entry ) {
-                $sitemap_entry['lastmod'] = wp_date( DATE_W3C, time() );
-
-                return $sitemap_entry;
+                $this->assertSame( $expected, $url_list, 'The post order did not match.' );
         }
 }