Changeset 50814

Timestamp:

05/05/2021 05:06:17 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Media: Some documentation and test improvements for WebP support:

• Document that WebP constants are only defined in PHP 7.1+.
• Correct the $filename parameter type in wp_get_webp_info().
• Use a consistent message when skipping tests due to the lack of WebP support.
• Remove unnecessary else branches after markTestSkipped().
• Replace assertEquals() with more appropriate assertions.

Follow-up to [50810].

See #35725.

Location:

trunk

Files:

• src/wp-includes/compat.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (1 diff)
• src/wp-includes/media.php (modified) (6 diffs)
• tests/phpunit/tests/functions.php (modified) (3 diffs)
• tests/phpunit/tests/image/editor.php (modified) (1 diff)
• tests/phpunit/tests/image/functions.php (modified) (1 diff)
• tests/phpunit/tests/image/resize.php (modified) (1 diff)

trunk/src/wp-includes/compat.php

@@ -372 +372 @@
 }
 
-// WebP constants may not be defined, even in cases where the format is supported.
+// WebP constants are only defined in PHP 7.1+.
 if ( ! defined( 'IMAGETYPE_WEBP' ) ) {
         define( 'IMAGETYPE_WEBP', 18 );

trunk/src/wp-includes/functions.php

@@ -3080 +3080 @@
                 }
 
-                // Add WebP fallback detection when image library doesn't support WebP.
-                // Note: detection values come from LibWebP, see
-                // https://github.com/webmproject/libwebp/blob/master/imageio/image_dec.c#L30
+                /*
+                 * Add WebP fallback detection when image library doesn't support WebP.
+                 * Note: detection values come from LibWebP, see
+                 * https://github.com/webmproject/libwebp/blob/master/imageio/image_dec.c#L30
+                 */
                 $magic = bin2hex( $magic );
                 if (

trunk/src/wp-includes/media.php

@@ -5025 +5025 @@
  * @since 5.8.0
  *
- * @param [type] $filename Path to a WebP file.
+ * @param string $filename Path to a WebP file.
  * @return array $webp_info {
  *     An array of WebP image information.
@@ -5039 +5039 @@
         $height = false;
         $type   = false;
+
         if ( ! 'image/webp' === wp_get_image_mime( $filename ) ) {
                 return compact( 'width', 'height', 'type' );
         }
+
         try {
                 $handle = fopen( $filename, 'rb' );
@@ -5084 +5086 @@
         } catch ( Exception $e ) {
         }
+
         return compact( 'width', 'height', 'type' );
 }
@@ -5098 +5101 @@
         $webp_info = wp_get_webp_info( $filename );
         $type      = $webp_info['type'];
+
         return $type && 'lossy' === $type;
 }
@@ -5114 +5118 @@
         // Try getimagesize() first.
         $info = getimagesize( $filename, $imageinfo );
+
         if ( false !== $info ) {
                 return $info;
         }
-        // For PHP versions that don't support WebP images, extract the image
-        // size info from the file headers.
+
+        // For PHP versions that don't support WebP images,
+        // extract the image size info from the file headers.
         if ( 'image/webp' === wp_get_image_mime( $filename ) ) {
                 $webp_info = wp_get_webp_info( $filename );
@@ -5124 +5130 @@
                 $height    = $webp_info['height'];
 
-                        // Mimic the native return format.
+                // Mimic the native return format.
                 if ( $width && $height ) {
                         return array(

trunk/tests/phpunit/tests/functions.php

@@ -1241 +1241 @@
                 if ( is_array( $expected ) ) {
                         foreach ( $expected as $k => $v ) {
-                                $this->assertEquals( true, isset( $result[ $k ] ) );
-                                $this->assertEquals( $expected[ $k ], $result[ $k ] );
+                                $this->assertArrayHasKey( $k, $result );
+                                $this->assertSame( $expected[ $k ], $result[ $k ] );
                         }
                 } else {
-                        $this->assertEquals( $expected, $result );
+                        $this->assertSame( $expected, $result );
                 }
         }
@@ -1313 +1313 @@
 
         /**
-         * Data provider for test_wp_get_image_mime();
+         * Data provider for test_wp_get_image_mime().
          */
         public function _wp_get_image_mime() {
@@ -1368 +1368 @@
 
         /**
-         * Data profider for test_wp_getimagesize();
+         * Data profider for test_wp_getimagesize().
          */
         public function data_wp_getimagesize() {

trunk/tests/phpunit/tests/image/editor.php

@@ -206 +206 @@
         public function test_wp_get_webp_info( $file, $expected ) {
                 $editor = wp_get_image_editor( $file );
+
                 if ( is_wp_error( $editor ) || ! $editor->supports_mime_type( 'image/webp' ) ) {
-                        $this->markTestSkipped( sprintf( 'Skipping test: no WebP support in the editor engine %s on this system.', $this->editor_engine ) );
-                } else {
-                        $file_data = wp_get_webp_info( $file );
-                        $this->assertSame( $file_data, $expected );
+                        $this->markTestSkipped( sprintf( 'No WebP support in the editor engine %s on this system.', $this->editor_engine ) );
                 }
-        }
-
-        /**
-         * Data provider for test_wp_get_webp_info();
+
+                $file_data = wp_get_webp_info( $file );
+                $this->assertSame( $file_data, $expected );
+        }
+
+        /**
+         * Data provider for test_wp_get_webp_info().
          */
         public function _test_wp_get_webp_info() {

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

@@ -100 +100 @@
                 $file   = DIR_TESTDATA . '/images/test-image.webp';
                 $editor = wp_get_image_editor( $file );
-                if ( ( ! is_wp_error( $editor ) ) && $editor->supports_mime_type( 'image/webp' ) ) {
+
+                if ( ! is_wp_error( $editor ) && $editor->supports_mime_type( 'image/webp' ) ) {
                         $files = array_merge(
                                 $files,

trunk/tests/phpunit/tests/image/resize.php

@@ -71 +71 @@
                 // Check if the editor supports the webp mime type.
                 if ( is_wp_error( $editor ) || ! $editor->supports_mime_type( 'image/webp' ) ) {
-                        $this->markTestSkipped( sprintf( 'Skipping test: no WebP support in the editor engine %s on this system.', $this->editor_engine ) );
-                } else {
-                        $image = $this->resize_helper( $file, 25, 25 );
-                        $this->assertSame( 'test-image-25x25.webp', wp_basename( $image ) );
-                        list($w, $h, $type) = wp_getimagesize( $image );
-                        $this->assertSame( 25, $w );
-                        $this->assertSame( 25, $h );
-                        $this->assertSame( IMAGETYPE_WEBP, $type );
-                        unlink( $image );
-                }
+                        $this->markTestSkipped( sprintf( 'No WebP support in the editor engine %s on this system.', $this->editor_engine ) );
+                }
+
+                $image = $this->resize_helper( $file, 25, 25 );
+                $this->assertSame( 'test-image-25x25.webp', wp_basename( $image ) );
+                list($w, $h, $type) = wp_getimagesize( $image );
+                $this->assertSame( 25, $w );
+                $this->assertSame( 25, $h );
+                $this->assertSame( IMAGETYPE_WEBP, $type );
+                unlink( $image );
         }