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

Timestamp:

12/28/2022 02:07:16 PM (3 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-attachment.php (modified) (5 diffs)

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

@@ -1 +1 @@
 <?php
 
+/**
+ * Unit test factory for attachments.
+ *
+ * Note: The below @method notations are defined solely for the benefit of IDEs,
+ * as a way to indicate expected return values from the given factory methods.
+ *
+ * @method int|WP_Error     create( $args = array(), $generation_definitions = null )
+ * @method WP_Post|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_Attachment extends WP_UnitTest_Factory_For_Post {
 
     /**
      * Create an attachment fixture.
+     *
+     * @since UT (3.7.0)
+     * @since 6.2.0 Returns a WP_Error object on failure.
      *
      * @param array $args {
@@ -15 +28 @@
      * @param array $legacy_args   Deprecated.
      *
-     * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
+     * @return int|WP_Error The attachment ID on success, WP_Error object on failure.
      */
     public function create_object( $args, $legacy_parent = 0, $legacy_args = array() ) {
@@ -34 +47 @@
         );
 
-        return wp_insert_attachment( $r, $r['file'], $r['post_parent'] );
+        return wp_insert_attachment( $r, $r['file'], $r['post_parent'], true );
     }
 
@@ -40 +53 @@
      * Saves an attachment.
      *
+     * @since 4.4.0
+     * @since 6.2.0 Returns a WP_Error object on failure.
+     *
      * @param string $file   The file name to create attachment object for.
      * @param int    $parent ID of the post to attach the file to.
      *
-     * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
+     * @return int|WP_Error The attachment ID on success, WP_Error object on failure.
      */
     public function create_upload_object( $file, $parent = 0 ) {
@@ -69 +85 @@
 
         // Save the data.
-        $id = wp_insert_attachment( $attachment, $upload['file'], $parent );
-        wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
+        $attachment_id = wp_insert_attachment( $attachment, $upload['file'], $parent, true );
 
-        return $id;
+        if ( is_wp_error( $attachment_id ) ) {
+            return $attachment_id;
+        }
+
+        wp_update_attachment_metadata(
+            $attachment_id,
+            wp_generate_attachment_metadata( $attachment_id, $upload['file'] )
+        );
+
+        return $attachment_id;
     }
 }