Changeset 51415 for trunk/tests/phpunit/tests/image/functions.php

Timestamp:

07/13/2021 10:43:42 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Tests: Clean up skipping conditions and requirements for various tests.

This improves the consistency of test skipping and ensures that:

• The @requires annotations use the right condition and format, and are on the right level (class vs. function).
• Inline conditions with a markTestSkipped() call are only used when annotations cannot be used.
• All markTestSkipped() calls contain a verbose explanation of why the test is being skipped.

Props jrf, hellofromTonya.
Fixes #53009.

File:

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

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

@@ -173 +173 @@
      */
     public function test_wp_save_image_file() {
-        $classes = array( 'WP_Image_Editor_GD', 'WP_Image_Editor_Imagick' );
-
-        foreach ( $classes as $key => $class ) {
-            if ( ! call_user_func( array( $class, 'test' ) ) ) {
-                // If the image editor isn't available, skip it.
-                unset( $classes[ $key ] );
-            }
-        }
-
-        if ( ! $classes ) {
-            $this->markTestSkipped( sprintf( 'The image editor engine %s is not supported on this system.', 'WP_Image_Editor_GD' ) );
-        }
+        $classes = $this->get_image_editor_engine_classes();
 
         require_once ABSPATH . 'wp-admin/includes/image-edit.php';
@@ -234 +223 @@
      */
     public function test_mime_overrides_filename() {
-        $classes = array( 'WP_Image_Editor_GD', 'WP_Image_Editor_Imagick' );
-
-        foreach ( $classes as $key => $class ) {
-            if ( ! call_user_func( array( $class, 'test' ) ) ) {
-                // If the image editor isn't available, skip it.
-                unset( $classes[ $key ] );
-            }
-        }
-
-        if ( ! $classes ) {
-            $this->markTestSkipped( sprintf( 'The image editor engine %s is not supported on this system.', 'WP_Image_Editor_GD' ) );
-        }
+        $classes = $this->get_image_editor_engine_classes();
 
         // Test each image editor engine.
@@ -276 +254 @@
      */
     public function test_inferred_mime_types() {
-        $classes = array( 'WP_Image_Editor_GD', 'WP_Image_Editor_Imagick' );
-
-        foreach ( $classes as $key => $class ) {
-            if ( ! call_user_func( array( $class, 'test' ) ) ) {
-                // If the image editor isn't available, skip it.
-                unset( $classes[ $key ] );
-            }
-        }
-
-        if ( ! $classes ) {
-            $this->markTestSkipped( sprintf( 'The image editor engine %s is not supported on this system.', 'WP_Image_Editor_GD' ) );
-        }
+        $classes = $this->get_image_editor_engine_classes();
 
         // Mime types.
@@ -343 +310 @@
         $this->assertInstanceOf( 'WP_Error', $editor2 );
 
+        $classes = $this->get_image_editor_engine_classes();
+
+        // Then, test with editors.
+        foreach ( $classes as $class ) {
+            $editor = new $class( DIR_TESTDATA );
+            $loaded = $editor->load();
+
+            $this->assertInstanceOf( 'WP_Error', $loaded );
+            $this->assertSame( 'error_loading_image', $loaded->get_error_code() );
+        }
+    }
+
+    /**
+     * Get the available image editor engine class(es).
+     *
+     * @return string[] Available image editor classes; empty array when none are avaialble.
+     */
+    private function get_image_editor_engine_classes() {
         $classes = array( 'WP_Image_Editor_GD', 'WP_Image_Editor_Imagick' );
 
@@ -352 +337 @@
         }
 
-        if ( ! $classes ) {
-            $this->markTestSkipped( sprintf( 'The image editor engine %s is not supported on this system.', 'WP_Image_Editor_GD' ) );
-        }
-
-        // Then, test with editors.
-        foreach ( $classes as $class ) {
-            $editor = new $class( DIR_TESTDATA );
-            $loaded = $editor->load();
-
-            $this->assertInstanceOf( 'WP_Error', $loaded );
-            $this->assertSame( 'error_loading_image', $loaded->get_error_code() );
-        }
+        if ( empty( $classes ) ) {
+            $this->markTestSkipped( 'Image editor engines WP_Image_Editor_GD and WP_Image_Editor_Imagick are not supported on this system.' );
+        }
+
+        return $classes;
     }