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

Timestamp:

12/28/2022 02:07:16 PM (2 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-user.php (modified) (4 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-user.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_User 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_User|WP_Error 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_User extends WP_UnitTest_Factory_For_Thing {
@@ -25 +25 @@
      * Inserts an user.
      *
+     * @since UT (3.7.0)
+     *
      * @param array $args The user data to insert.
      *
@@ -35 +37 @@
     /**
      * Updates the user data.
+     *
+     * @since UT (3.7.0)
      *
      * @param int   $user_id ID of the user to update.
@@ -49 +53 @@
      * Retrieves the user for a given ID.
      *
+     * @since UT (3.7.0)
+     *
      * @param int $user_id ID of the user ID to retrieve.
      *