Changeset 50384

Timestamp:

02/18/2021 12:02:42 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Tests: Rename stick_post() and unstick_post() tests for a bit more clarity.

Add missing DocBlock for test_unstick_post_updates_option().

Follow-up to [50380].

See #52007.

File:

• trunk/tests/phpunit/tests/post.php (modified) (13 diffs)

trunk/tests/phpunit/tests/post.php

@@ -1640 +1640 @@
 
     /**
-     * Ensure sticking post updates option.
+     * Ensure sticking a post updates the `sticky_posts` option.
      *
      * @covers ::stick_post
      */
-    function test_sticky_posts() {
+    function test_stick_post_updates_option() {
         stick_post( 1 );
         $this->assertSameSets( array( 1 ), get_option( 'sticky_posts' ) );
@@ -1653 +1653 @@
 
     /**
-     * Ensure sticking posts can not duplicate options.
+     * Ensure sticking a post does not duplicate post IDs in the option.
      *
      * @ticket 52007
      * @covers ::stick_post
-     * @dataProvider data_sticky_posts_not_duplicate_with_the_same_value
+     * @dataProvider data_stick_post_does_not_duplicate_post_ids
      *
      * @param mixed $stick Value to pass to stick_post().
      */
-    function test_sticky_posts_not_duplicate_with_the_same_value( $stick ) {
+    function test_stick_post_does_not_duplicate_post_ids( $stick ) {
         update_option( 'sticky_posts', array( 1, 2 ) );
 
@@ -1669 +1669 @@
 
     /**
-     * Data provider for test_sticky_posts_not_duplicate_with_the_same_value().
+     * Data provider for test_stick_post_does_not_duplicate_post_ids().
      *
      * @return array[] {
@@ -1677 +1677 @@
      * }
      */
-    function data_sticky_posts_not_duplicate_with_the_same_value() {
+    function data_stick_post_does_not_duplicate_post_ids() {
         return array(
             array( 1 ),
@@ -1686 +1686 @@
 
     /**
-     * Ensure sticking post removes other duplicates.
+     * Ensure sticking a post removes other duplicate post IDs from the option.
      *
      * @ticket 52007
@@ -1693 +1693 @@
      * @param mixed $stick Value to pass to stick_post().
      */
-    function test_sticky_posts_remove_duplicate_ids_when_add_new_value() {
+    function test_stick_post_removes_duplicate_post_ids_when_adding_new_value() {
         update_option( 'sticky_posts', array( 1, 1, 2, 2 ) );
 
@@ -1700 +1700 @@
     }
 
-    function test_unsticky_posts() {
+    /**
+     * Ensure unsticking a post updates the `sticky_posts` option.
+     *
+     * @covers ::unstick_post
+     */
+    function test_unstick_post_updates_option() {
         update_option( 'sticky_posts', array( 1 ) );
         unstick_post( 1 );
@@ -1711 +1716 @@
 
     /**
-     * Ensure duplicates removed when unsticking posts.
+     * Ensure unsticking a post removes duplicate post IDs from the option.
      *
      * @ticket 52007
      * @covers ::unstick_post
      *
-     * @dataProvider data_unstick_posts_with_duplicate_id
+     * @dataProvider data_unstick_post_removes_duplicate_post_ids
      *
      * @param array $starting_option Original value of `sticky_posts` option.
@@ -1722 +1727 @@
      * @param array $expected
      */
-    function test_unstick_posts_with_duplicate_id( $starting_option, $unstick, $expected ) {
+    function test_unstick_post_removes_duplicate_post_ids( $starting_option, $unstick, $expected ) {
         update_option( 'sticky_posts', $starting_option );
         unstick_post( $unstick );
@@ -1729 +1734 @@
 
     /**
-     * Data provider for test_unstick_posts_with_duplicate_id
+     * Data provider for test_unstick_post_removes_duplicate_post_ids().
      *
      * @return array[] {
@@ -1739 +1744 @@
      * }
      */
-    function data_unstick_posts_with_duplicate_id() {
+    function data_unstick_post_removes_duplicate_post_ids() {
         return array(
             array(
@@ -1770 +1775 @@
 
     /**
-     * Ensure sticking duplicate does not trigger db update.
+     * Ensure sticking a duplicate post does not update the `sticky_posts` option.
      *
      * @ticket 52007
      * @covers ::stick_post
      */
-    function test_sticking_dupes_does_not_trigger_update() {
+    function test_stick_post_with_duplicate_post_id_does_not_update_option() {
         update_option( 'sticky_posts', array( 1, 2, 2 ) );
         stick_post( 2 );
@@ -1782 +1787 @@
 
     /**
-     * Ensure unsticking unstuck post does not trigger db update.
+     * Ensure unsticking a non-sticky post does not update the `sticky_posts` option.
      *
      * @ticket 52007
      * @covers ::unstick_post
      */
-    function test_unsticking_unstuck_post_does_not_trigger_update() {
+    function test_unstick_post_with_non_sticky_post_id_does_not_update_option() {
         update_option( 'sticky_posts', array( 1, 2, 2 ) );
         unstick_post( 3 );