Changeset 55019 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.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-network.php (modified) (3 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-network.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_Network 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_Network|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_Network extends WP_UnitTest_Factory_For_Thing {
@@ -24 +24 @@
         }
 
+        /**
+         * Creates a network object.
+         *
+         * @since 3.9.0
+         * @since 6.2.0 Returns a WP_Error object on failure.
+         *
+         * @param array $args Arguments for the network object.
+         *
+         * @return int|WP_Error The network ID on success, WP_Error object on failure.
+         */
         public function create_object( $args ) {
                 require_once ABSPATH . 'wp-admin/includes/upgrade.php';
@@ -33 +43 @@
                 }
 
-                populate_network( $args['network_id'], $args['domain'], $email, $args['title'], $args['path'], $args['subdomain_install'] );
+                $result = populate_network(
+                        $args['network_id'],
+                        $args['domain'],
+                        $email,
+                        $args['title'],
+                        $args['path'],
+                        $args['subdomain_install']
+                );
+
+                if ( is_wp_error( $result ) ) {
+                        return $result;
+                }
+
                 return (int) $args['network_id'];
         }
 
+        /**
+         * Updates a network object. Not implemented.
+         *
+         * @since 3.9.0
+         *
+         * @param int   $network_id ID of the network to update.
+         * @param array $fields  The fields to update.
+         *
+         * @return void
+         */
         public function update_object( $network_id, $fields ) {}
 
+        /**
+         * Retrieves a network by a given ID.
+         *
+         * @since 3.9.0
+         *
+         * @param int $network_id ID of the network to retrieve.
+         *
+         * @return WP_Network|null The network object on success, null on failure.
+         */
         public function get_object_by_id( $network_id ) {
                 return get_network( $network_id );