Changeset 57531

Timestamp:

02/04/2024 10:02:02 PM (3 years ago)

Author:

peterwilsoncc

Message:

Build/Test Tools: Mock plugin API response in WP_REST_Plugins_Controller_Test.

Avoid false test failures due to network conditions in the WP_REST_Plugins_Controller_Test class. This mocks HTTP responses from the plugin information endpoint for the link-manager plugin.

Props: peterwilsoncc, costdev.
See #59647.

Location:

trunk/tests/phpunit

Files:

• data/plugins/link-manager.json (added)
• tests/rest-api/rest-plugins-controller.php (modified) (4 diffs)

trunk/tests/phpunit/tests/rest-api/rest-plugins-controller.php

@@ -42 +42 @@
 
         /**
+         * JSON decoded response from the WordPress.org plugin API.
+         *
+         * @var stdClass
+         */
+        private static $plugin_api_decoded_response;
+
+        /**
          * Set up class test fixtures.
          *
@@ -68 +75 @@
                         grant_super_admin( self::$super_admin );
                 }
+
+                self::$plugin_api_decoded_response = json_decode( file_get_contents( DIR_TESTDATA . '/plugins/link-manager.json' ) );
         }
 
@@ -1018 +1027 @@
 
         /**
-         * Sets up the plugin download to come locally instead of downloading it from .org
+         * Sets up the plugin repository requests to use local data.
+         *
+         * Requests to the plugin repository are mocked to avoid external HTTP requests so
+         * the test suite does not produce false negatives due to network failures.
+         *
+         * Both the plugin ZIP file and the plugin API response are mocked.
          *
          * @since 5.5.0
@@ -1037 +1051 @@
                 );
 
-                // Remove upgrade hooks which are not required for plugin installation tests
-                // and may interfere with the results due to a timeout in external HTTP requests.
+                add_filter(
+                        'plugins_api',
+                        function ( $bypass, $action, $args ) {
+                                // Only mock the plugin_information (link-manager) request.
+                                if ( 'plugin_information' !== $action || 'link-manager' !== $args->slug ) {
+                                        return $bypass;
+                                }
+                                return self::$plugin_api_decoded_response;
+                        },
+                        10,
+                        3
+                );
+
+                /*
+                 * Remove upgrade hooks which are not required for plugin installation tests
+                 * and may interfere with the results due to a timeout in external HTTP requests.
+                 */
                 remove_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
                 remove_action( 'upgrader_process_complete', 'wp_version_check' );