Changeset 54061 for trunk/tests/phpunit/tests/link/editTermLink.php

Timestamp:

09/02/2022 01:14:29 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Tests: Simplify and correct get_term_link() and get_edit_term_link() tests:

• Some assertions were unnecessarily duplicated. They aim to test the function behavior both when passing a term ID and term object, however that is already handled via the $use_id parameter of the get_term() helper in the same test class. The data providers already supply test cases both with a term ID and term object, so there is no need for a second assertion or a whole second test method with a term object.
• One get_term_feed_link() test was unnecessarily skipped half of the time, when term object was passed instead of term ID. Instead, it can use a dedicated data provider and avoid skipping.

Includes:

• Using more descriptive test method names to clarify the intention of the tests.
• Some documentation updates for clarity.

Follow-up to [52180], [52255], [52258], [52305], [53833], [53836].

See #55652.

File:

• trunk/tests/phpunit/tests/link/editTermLink.php (modified) (6 diffs)

trunk/tests/phpunit/tests/link/editTermLink.php

@@ -43 +43 @@
          *
          * @param string $taxonomy Taxonomy being tested (used for index of term keys).
-         * @param bool   $use_id   When true, pass term ID. Else, pass term object.
-         * @return WP_Term|int If $use_id is true, term ID is returned; else instance of WP_Term.
+         * @param bool   $use_id   Whether to return term ID or term object.
+         * @return WP_Term|int Term ID if `$use_id` is true, WP_Term instance otherwise.
          */
         private function get_term( $taxonomy, $use_id ) {
@@ -60 +60 @@
          * @ticket 50225
          *
-         * @param string $taxonomy Taxonomy being tested (used for index of term keys).
-         * @param bool   $use_id   When true, pass term ID. Else, pass term object.
-         * @param string $expected Expected URL within admin of edit link.
+         * @param string $taxonomy Taxonomy being tested.
+         * @param bool   $use_id   Whether to pass term ID or term object to `edit_term_link()`.
+         * @param string $expected Expected part of admin URL for the edit link.
          */
-        public function test_edit_term_link_for_permitted_user( $taxonomy, $use_id, $expected ) {
+        public function test_edit_term_link_should_return_the_link_for_permitted_user( $taxonomy, $use_id, $expected ) {
                 $term = $this->get_term( $taxonomy, $use_id );
 
@@ -72 +72 @@
 
                 $this->assertStringContainsString( $expected, edit_term_link( '', '', '', $term, false ) );
-                $this->assertStringContainsString( $expected, edit_term_link( '', '', '', get_term( $term, $taxonomy ), false ) );
         }
 
@@ -80 +79 @@
          * @ticket 50225
          *
-         * @param string $taxonomy Taxonomy being tested (used for index of term keys).
-         * @param bool   $use_id   When true, pass term ID. Else, pass term object.
+         * @param string $taxonomy Taxonomy being tested.
+         * @param bool   $use_id   Whether to pass term ID or term object to `edit_term_link()`.
          */
-        public function test_edit_term_link_for_denied_user( $taxonomy, $use_id ) {
+        public function test_edit_term_link_should_return_null_for_denied_user( $taxonomy, $use_id ) {
                 wp_set_current_user( self::$user_ids['subscriber'] );
                 $term = $this->get_term( $taxonomy, $use_id );
 
                 $this->assertNull( edit_term_link( '', '', '', $term, false ) );
-                $this->assertNull( edit_term_link( '', '', '', get_term( $term, $taxonomy ), false ) );
         }
 
@@ -96 +94 @@
          * @ticket 50225
          *
-         * @param string $taxonomy Taxonomy being tested (used for index of term keys).
-         * @param bool   $use_id   When true, pass term ID. Else, pass term object.
+         * @param string $taxonomy Taxonomy being tested.
+         * @param bool   $use_id   Whether to pass term ID or term object to `edit_term_link()`.
          */
-        public function test_edit_term_link_filter_is_int_by_term_id( $taxonomy, $use_id ) {
+        public function test_edit_term_link_filter_should_receive_term_id( $taxonomy, $use_id ) {
                 $term = $this->get_term( $taxonomy, $use_id );
 
@@ -112 +110 @@
 
                 edit_term_link( '', '', '', $term, false );
-        }
-
-        /**
-         * @dataProvider data_edit_term_link
-         *
-         * @ticket 50225
-         *
-         * @param string $taxonomy Taxonomy being tested (used for index of term keys).
-         * @param bool   $use_id   When true, pass term ID. Else, pass term object.
-         */
-        public function test_edit_term_link_filter_is_int_by_term_object( $taxonomy, $use_id ) {
-                $term = $this->get_term( $taxonomy, $use_id );
-
-                add_filter(
-                        'edit_term_link',
-                        function( $location, $term ) {
-                                $this->assertIsInt( $term );
-                        },
-                        10,
-                        2
-                );
-
-                edit_term_link( '', '', '', get_term( $term, $taxonomy ), false );
         }