Changeset 55019 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

Timestamp:

12/28/2022 02:07:16 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Tests: Bring some consistency to creating and updating objects in factory classes.

In various unit test factory classes, some of the create_object() and update_object() methods returned a WP_Error object on failure, while a few others were documented to do so, but did not in practice, instead returning the value 0 or false, or not accounting for a failure at all.

This commit aims to handle this in a consistent way by updating the methods to always return the object ID on success and a WP_Error object on failure.

Includes:

• Updating and correcting the relevant documentation parts.
• Adding missing documentation and @since tags in some classes.
• Renaming some variables to clarify that it is the object ID which is passed around, not the object itself.

Follow-up to [760/tests], [838/tests], [922/tests], [948/tests], [985/tests], [27178], [32659], [34855], [37563], [40968], [44497], [46262].

See #56793.

File:

• trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php (modified) (7 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-term.php

@@ -7 +7 @@
  * as a way to indicate expected return values from the given factory methods.
  *
- * @method int create( $args = array(), $generation_definitions = null )
- * @method WP_Term create_and_get( $args = array(), $generation_definitions = null )
- * @method int[] create_many( $count, $args = array(), $generation_definitions = null )
+ * @method int|WP_Error          create( $args = array(), $generation_definitions = null )
+ * @method WP_Term|WP_Error|null create_and_get( $args = array(), $generation_definitions = null )
+ * @method (int|WP_Error)[]      create_many( $count, $args = array(), $generation_definitions = null )
  */
 class WP_UnitTest_Factory_For_Term extends WP_UnitTest_Factory_For_Thing {
@@ -29 +29 @@
          * Creates a term object.
          *
-         * @param array $args Array or string of arguments for inserting a term.
+         * @since UT (3.7.0)
          *
-         * @return array|WP_Error
+         * @param array $args Array of arguments for inserting a term.
+         *
+         * @return int|WP_Error The term ID on success, WP_Error object on failure.
          */
         public function create_object( $args ) {
                 $args         = array_merge( array( 'taxonomy' => $this->taxonomy ), $args );
                 $term_id_pair = wp_insert_term( $args['name'], $args['taxonomy'], $args );
+
                 if ( is_wp_error( $term_id_pair ) ) {
                         return $term_id_pair;
                 }
+
                 return $term_id_pair['term_id'];
         }
@@ -45 +49 @@
          * Updates the term.
          *
-         * @param int|object   $term   The term to update.
-         * @param array|string $fields The context in which to relate the term to the object.
+         * @since UT (3.7.0)
+         * @since 6.2.0 Returns a WP_Error object on failure.
          *
-         * @return int The term ID.
+         * @param int|object $term   The term to update.
+         * @param array      $fields Array of arguments for updating a term.
+         *
+         * @return int|WP_Error The term ID on success, WP_Error object on failure.
          */
         public function update_object( $term, $fields ) {
                 $fields = array_merge( array( 'taxonomy' => $this->taxonomy ), $fields );
+
                 if ( is_object( $term ) ) {
                         $taxonomy = $term->taxonomy;
                 }
+
                 $term_id_pair = wp_update_term( $term, $taxonomy, $fields );
+
+                if ( is_wp_error( $term_id_pair ) ) {
+                        return $term_id_pair;
+                }
+
                 return $term_id_pair['term_id'];
         }
@@ -61 +75 @@
         /**
          * Attach terms to the given post.
+         *
+         * @since UT (3.7.0)
          *
          * @param int          $post_id  The post ID.
@@ -80 +96 @@
          * Create a term and returns it as an object.
          *
+         * @since 4.3.0
+         *
          * @param array $args                   Array or string of arguments for inserting a term.
          * @param null  $generation_definitions The default values.
@@ -93 +111 @@
 
                 $taxonomy = isset( $args['taxonomy'] ) ? $args['taxonomy'] : $this->taxonomy;
+
                 return get_term( $term_id, $taxonomy );
         }
@@ -98 +117 @@
         /**
          * Retrieves the term by a given ID.
+         *
+         * @since UT (3.7.0)
          *
          * @param int $term_id ID of the term to retrieve.