Changeset 53529

Timestamp:

06/19/2022 04:39:15 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Tests: Refactor Tests_Image_Functions::test_wp_save_image_file() to use a data provider.

Using a data provider has a number of advantages:

1. If the first test case fails, it won't prevent the other test cases from being tested.
2. The output from PHPUnit will be more descriptive in case of failure when using a data provider.
3. Using named test cases in the data provider will also make the --testdox output much more descriptive and informative.

The actual cases being tested, or the test itself have not been changed.

Includes:

• Adding a @covers annotation.
• Adding a skip annotation for unsupported mime types.
• Adding a failure message to each assertion.

Follow-up to [1061/tests], [53495], [53497], [53521], [53523], [53524], [53525], [53526].

Props jrf.
See #55652.

File:

• trunk/tests/phpunit/tests/image/functions.php (modified) (2 diffs)

trunk/tests/phpunit/tests/image/functions.php

@@ -241 +241 @@
 
     /**
-     * Test save image file and mime_types
+     * Test wp_save_image_file() and mime types.
+     *
+     * @dataProvider data_wp_save_image_file
      *
      * @ticket 6821
+     * @covers ::wp_save_image_file
      * @requires extension fileinfo
-     */
-    public function test_wp_save_image_file() {
+     *
+     * @param string $class_name Name of the image editor engine class to be tested.
+     * @param string $mime_type  The mime type to test.
+     */
+    public function test_wp_save_image_file( $class_name, $mime_type ) {
+        require_once ABSPATH . 'wp-admin/includes/image-edit.php';
+
+        $img    = new $class_name( DIR_TESTDATA . '/images/canola.jpg' );
+        $loaded = $img->load();
+
+        if ( ! $img->supports_mime_type( $mime_type ) ) {
+            $this->markTestSkipped(
+                sprintf(
+                    'The %s mime type is not supported by the %s engine',
+                    $mime_type,
+                    str_replace( 'WP_Image_Editor_', '', $class_name )
+                )
+            );
+        }
+
+        $file = wp_tempnam();
+        $ret  = wp_save_image_file( $file, $img, $mime_type, 1 );
+
+        $this->assertNotEmpty( $ret, 'Image failed to save - "empty" response returned' );
+        $this->assertNotWPError( $ret, 'Image failed to save - WP_Error returned' );
+        $this->assertSame( $mime_type, $this->get_mime_type( $ret['path'] ), 'Mime type of the saved image does not match' );
+
+        // Clean up.
+        unlink( $file );
+        unlink( $ret['path'] );
+        unset( $img );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_wp_save_image_file() {
         $classes = $this->get_image_editor_engine_classes();
-
-        require_once ABSPATH . 'wp-admin/includes/image-edit.php';
 
         // Mime types.
@@ -260 +298 @@
         // Include WebP in tests when platform supports it.
         if ( function_exists( 'imagewebp' ) ) {
-            array_push( $mime_types, 'image/webp' );
-        }
-
-        // Test each image editor engine.
+            $mime_types[] = 'image/webp';
+        }
+
+        $data = array();
+
         foreach ( $classes as $class ) {
-            $img    = new $class( DIR_TESTDATA . '/images/canola.jpg' );
-            $loaded = $img->load();
-
-            // Save a file as each mime type, assert it works.
             foreach ( $mime_types as $mime_type ) {
-                if ( ! $img->supports_mime_type( $mime_type ) ) {
-                    continue;
-                }
-
-                $file = wp_tempnam();
-                $ret  = wp_save_image_file( $file, $img, $mime_type, 1 );
-                $this->assertNotEmpty( $ret );
-                $this->assertNotWPError( $ret );
-                $this->assertSame( $mime_type, $this->get_mime_type( $ret['path'] ) );
-
-                // Clean up.
-                unlink( $file );
-                unlink( $ret['path'] );
+                $data[ $class . '; ' . $mime_type ] = array(
+                    'class_name' => $class,
+                    'mime_type'  => $mime_type,
+                );
             }
-
-            // Clean up.
-            unset( $img );
-        }
+        }
+
+        return $data;
     }