WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
01/29/2025 06:17:34 PM (21 months ago)
Author:
johnbillion
Message:

Build/Test Tools: Add a retry mechanism for tests that perform external HTTP requests.

While the skipTestOnTimeout() method will catch a timeout and prevent it from causing a test to fail, other errors such as a failed DNS lookup or HTTPS handshake can still cause a test to unnecessarily fail. This introduces a simple retry mechanism that will hopefully further reduce the flakiness of tests that perform HTTP API requests.

Fixes #62830

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/tests/phpunit/tests/http/base.php

    r58108 r59729  
    4545        public function test_redirect_on_301() {
    4646                // 5 : 5 & 301.
    47                 $res = wp_remote_request( $this->redirection_script . '?code=301&rt=' . 5, array( 'redirection' => 5 ) );
    48 
    49                 $this->skipTestOnTimeout( $res );
     47                $res = $this->wp_remote_request( $this->redirection_script . '?code=301&rt=' . 5, array( 'redirection' => 5 ) );
     48
    5049                $this->assertNotWPError( $res );
    5150                $this->assertSame( 200, (int) $res['response']['code'] );
    … …  
    5756        public function test_redirect_on_302() {
    5857                // 5 : 5 & 302.
    59                 $res = wp_remote_request( $this->redirection_script . '?code=302&rt=' . 5, array( 'redirection' => 5 ) );
    60 
    61                 $this->skipTestOnTimeout( $res );
     58                $res = $this->wp_remote_request( $this->redirection_script . '?code=302&rt=' . 5, array( 'redirection' => 5 ) );
     59
    6260                $this->assertNotWPError( $res );
    6361                $this->assertSame( 200, (int) $res['response']['code'] );
    … …  
    7169        public function test_redirect_on_301_no_redirect() {
    7270                // 5 > 0 & 301.
    73                 $res = wp_remote_request( $this->redirection_script . '?code=301&rt=' . 5, array( 'redirection' => 0 ) );
    74 
    75                 $this->skipTestOnTimeout( $res );
     71                $res = $this->wp_remote_request( $this->redirection_script . '?code=301&rt=' . 5, array( 'redirection' => 0 ) );
     72
    7673                $this->assertNotWPError( $res );
    7774                $this->assertSame( 301, (int) $res['response']['code'] );
    … …  
    8582        public function test_redirect_on_302_no_redirect() {
    8683                // 5 > 0 & 302.
    87                 $res = wp_remote_request( $this->redirection_script . '?code=302&rt=' . 5, array( 'redirection' => 0 ) );
    88 
    89                 $this->skipTestOnTimeout( $res );
     84                $res = $this->wp_remote_request( $this->redirection_script . '?code=302&rt=' . 5, array( 'redirection' => 0 ) );
     85
    9086                $this->assertNotWPError( $res );
    9187                $this->assertSame( 302, (int) $res['response']['code'] );
    … …  
    9793        public function test_redirections_equal() {
    9894                // 5 - 5.
    99                 $res = wp_remote_request( $this->redirection_script . '?rt=' . 5, array( 'redirection' => 5 ) );
    100 
    101                 $this->skipTestOnTimeout( $res );
     95                $res = $this->wp_remote_request( $this->redirection_script . '?rt=' . 5, array( 'redirection' => 5 ) );
     96
    10297                $this->assertNotWPError( $res );
    10398                $this->assertSame( 200, (int) $res['response']['code'] );
    … …  
    109104        public function test_no_head_redirections() {
    110105                // No redirections on HEAD request.
    111                 $res = wp_remote_request( $this->redirection_script . '?code=302&rt=' . 1, array( 'method' => 'HEAD' ) );
    112 
    113                 $this->skipTestOnTimeout( $res );
     106                $res = $this->wp_remote_request( $this->redirection_script . '?code=302&rt=' . 1, array( 'method' => 'HEAD' ) );
     107
    114108                $this->assertNotWPError( $res );
    115109                $this->assertSame( 302, (int) $res['response']['code'] );
    … …  
    123117        public function test_redirect_on_head() {
    124118                // Redirections on HEAD request when Requested.
    125                 $res = wp_remote_request(
     119                $res = $this->wp_remote_request(
    126120                        $this->redirection_script . '?rt=' . 5,
    127121                        array(
    … …  
    131125                );
    132126
    133                 $this->skipTestOnTimeout( $res );
    134127                $this->assertNotWPError( $res );
    135128                $this->assertSame( 200, (int) $res['response']['code'] );
    … …  
    141134        public function test_redirections_greater() {
    142135                // 10 > 5.
    143                 $res = wp_remote_request( $this->redirection_script . '?rt=' . 10, array( 'redirection' => 5 ) );
    144 
    145                 $this->skipTestOnTimeout( $res );
     136                $res = $this->wp_remote_request( $this->redirection_script . '?rt=' . 10, array( 'redirection' => 5 ) );
     137
    146138                $this->assertWPError( $res );
    147139        }
    … …  
    152144        public function test_redirections_greater_edgecase() {
    153145                // 6 > 5 (close edge case).
    154                 $res = wp_remote_request( $this->redirection_script . '?rt=' . 6, array( 'redirection' => 5 ) );
    155 
    156                 $this->skipTestOnTimeout( $res );
     146                $res = $this->wp_remote_request( $this->redirection_script . '?rt=' . 6, array( 'redirection' => 5 ) );
     147
    157148                $this->assertWPError( $res );
    158149        }
    … …  
    163154        public function test_redirections_less_edgecase() {
    164155                // 4 < 5 (close edge case).
    165                 $res = wp_remote_request( $this->redirection_script . '?rt=' . 4, array( 'redirection' => 5 ) );
    166 
    167                 $this->skipTestOnTimeout( $res );
     156                $res = $this->wp_remote_request( $this->redirection_script . '?rt=' . 4, array( 'redirection' => 5 ) );
     157
    168158                $this->assertNotWPError( $res );
    169159        }
    … …  
    176166        public function test_redirections_zero_redirections_specified() {
    177167                // 0 redirections asked for, should return the document?
    178                 $res = wp_remote_request( $this->redirection_script . '?code=302&rt=' . 5, array( 'redirection' => 0 ) );
    179 
    180                 $this->skipTestOnTimeout( $res );
     168                $res = $this->wp_remote_request( $this->redirection_script . '?code=302&rt=' . 5, array( 'redirection' => 0 ) );
     169
    181170                $this->assertNotWPError( $res );
    182171                $this->assertSame( 302, (int) $res['response']['code'] );
    … …  
    192181        public function test_location_header_on_201() {
    193182                // Prints PASS on initial load, FAIL if the client follows the specified redirection.
    194                 $res = wp_remote_request( $this->redirection_script . '?201-location=true' );
    195 
    196                 $this->skipTestOnTimeout( $res );
     183                $res = $this->wp_remote_request( $this->redirection_script . '?201-location=true' );
     184
    197185                $this->assertNotWPError( $res );
    198186                $this->assertSame( 'PASS', $res['body'] );
    … …  
    211199
    212200                // Test 301 - POST to POST.
    213                 $res = wp_remote_request(
     201                $res = $this->wp_remote_request(
    214202                        $url,
    215203                        array(
    … …  
    219207                );
    220208
    221                 $this->skipTestOnTimeout( $res );
    222209                $this->assertNotWPError( $res );
    223210                $this->assertSame( 'PASS', wp_remote_retrieve_body( $res ) );
    … …  
    237224                        'test3' => '',
    238225                );
    239                 $res     = wp_remote_request( $this->redirection_script . '?header-check', array( 'headers' => $headers ) );
    240 
    241                 $this->skipTestOnTimeout( $res );
     226                $res     = $this->wp_remote_request( $this->redirection_script . '?header-check', array( 'headers' => $headers ) );
     227
    242228                $this->assertNotWPError( $res );
    243229
    … …  
    268254                $url  = $this->file_stream_url;
    269255                $size = 153204;
    270                 $res  = wp_remote_request(
     256                $res  = $this->wp_remote_request(
    271257                        $url,
    272258                        array(
    … …  
    282268                }
    283269
    284                 $this->skipTestOnTimeout( $res );
    285270                $this->assertNotWPError( $res );
    286271                $this->assertSame( '', $res['body'] ); // The body should be empty.
    … …  
    298283                $url  = $this->file_stream_url;
    299284                $size = 10000;
    300                 $res  = wp_remote_request(
     285                $res  = $this->wp_remote_request(
    301286                        $url,
    302287                        array(
    … …  
    313298                }
    314299
    315                 $this->skipTestOnTimeout( $res );
    316300                $this->assertNotWPError( $res );
    317301                $this->assertSame( $size, $filesize ); // Check that the file is written to disk correctly without any extra characters.
    … …  
    329313                $size = 10000;
    330314
    331                 $res = wp_remote_request(
     315                $res = $this->wp_remote_request(
    332316                        $url,
    333317                        array(
    … …  
    337321                );
    338322
    339                 $this->skipTestOnTimeout( $res );
    340323                $this->assertNotWPError( $res );
    341324                $this->assertSame( $size, strlen( $res['body'] ) );
    … …  
    355338                $url = 'http://api.wordpress.org/core/tests/1.0/redirection.php?post-redirect-to-method=1';
    356339
    357                 $res = wp_remote_post( add_query_arg( 'response_code', $response_code, $url ), array( 'timeout' => 30 ) );
    358 
    359                 $this->skipTestOnTimeout( $res );
     340                $res = $this->wp_remote_post( add_query_arg( 'response_code', $response_code, $url ), array( 'timeout' => 30 ) );
     341
    360342                $this->assertNotWPError( $res );
    361343                $this->assertSame( $method, wp_remote_retrieve_body( $res ) );
    … …  
    406388                );
    407389
    408                 $res = wp_remote_get( $url, $args );
    409 
    410                 $this->skipTestOnTimeout( $res );
     390                $res = $this->wp_remote_get( $url, $args );
     391
    411392                $this->assertNotWPError( $res );
    412393                $this->assertSame( 'PASS', wp_remote_retrieve_body( $res ) );
    … …  
    428409                add_filter( 'http_request_args', array( $this, 'filter_http_request_args' ) );
    429410
    430                 $res = wp_remote_head( $url, $args );
     411                $res = $this->wp_remote_head( $url, $args );
    431412
    432413                remove_filter( 'http_request_args', array( $this, 'filter_http_request_args' ) );
    433414
    434                 $this->skipTestOnTimeout( $res );
    435415                $this->assertNotEmpty( $this->http_request_args['sslcertificates'] );
    436416                $this->assertNotWPError( $res );
    … …  
    448428                $url = 'http://api.wordpress.org/core/tests/1.0/redirection.php?cookie-test=1';
    449429
    450                 $res = wp_remote_get( $url );
    451 
    452                 $this->skipTestOnTimeout( $res );
     430                $res = $this->wp_remote_get( $url );
     431
    453432                $this->assertNotWPError( $res );
    454433                $this->assertSame( 'PASS', wp_remote_retrieve_body( $res ) );
    … …  
    468447                }
    469448
    470                 $res = wp_remote_get( 'https://wordpress.org/' );
    471 
    472                 $this->skipTestOnTimeout( $res );
     449                $res = $this->wp_remote_get( 'https://wordpress.org/' );
     450
    473451                $this->assertNotWPError( $res );
    474452        }
    … …  
    485463                $url  = str_replace( $path, '/' . $path, $url );
    486464
    487                 $res = wp_remote_request( $url );
    488 
    489                 $this->skipTestOnTimeout( $res );
     465                $res = $this->wp_remote_request( $url );
     466
    490467                $this->assertNotWPError( $res );
    491468        }
Note: See TracChangeset for help on using the changeset viewer.