Skip to content

http_request: add url to error msgs, only re-try if local CACert issue. #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gitlost wants to merge 3 commits into
base: master
Choose a base branch
from
Open

http_request: add url to error msgs, only re-try if local CACert issue. #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5731941
http_request: add url to error msgs, only re-try if local CACert prob…
gitlost Aug 25, 2017
d0971b2
Require class-wp-cli.php.
gitlost Aug 25, 2017
0c8a1ce
Use 77 for CURLE_SSL_CACERT_BADFILE for PHP < 7.
gitlost Aug 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions php/utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,13 +580,16 @@ function http_request( $method, $url, $data = null, $headers = array(), $options
$request = \Requests::request( $url, $headers, $data, $method, $options );
return $request;
} catch( \Requests_Exception $ex ) {
if ( 'curlerror' !== $ex->getType() || ! in_array( curl_errno( $ex->getData() ), array( CURLE_SSL_CONNECT_ERROR, CURLE_SSL_CERTPROBLEM, 77 /*CURLE_SSL_CACERT_BADFILE*/ ), true ) ) {
\WP_CLI::error( sprintf( "Failed to get url '%s': %s.", $url, $ex->getMessage() ) );
}
// Handle SSL certificate issues gracefully
\WP_CLI::warning( $ex->getMessage() );
\WP_CLI::warning( sprintf( "Re-trying without verify after failing to get verified url '%s' %s.", $url, $ex->getMessage() ) );
$options['verify'] = false;
try {
return \Requests::request( $url, $headers, $data, $method, $options );
} catch( \Requests_Exception $ex ) {
\WP_CLI::error( $ex->getMessage() );
\WP_CLI::error( sprintf( "Failed to get non-verified url '%s' %s.", $url, $ex->getMessage() ) );
}
}
}
Expand Down
91 changes: 91 additions & 0 deletions tests/test-utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

use WP_CLI\Utils;

require_once dirname( __DIR__ ) . '/php/class-wp-cli.php';

class UtilsTest extends PHPUnit_Framework_TestCase {

function testIncrementVersion() {
Expand Down Expand Up @@ -352,4 +354,93 @@ public function testLaunchEditorForInputProcDisabled() {
$this->assertTrue( false !== strpos( trim( $output[0] ), $err_msg ) );
}

public function testHttpRequestBadAddress() {
// Save WP_CLI state.
$class_wp_cli_logger = new \ReflectionProperty( 'WP_CLI', 'logger' );
$class_wp_cli_logger->setAccessible( true );
$class_wp_cli_capture_exit = new \ReflectionProperty( 'WP_CLI', 'capture_exit' );
$class_wp_cli_capture_exit->setAccessible( true );

$prev_logger = $class_wp_cli_logger->getValue();
$prev_capture_exit = $class_wp_cli_capture_exit->getValue();

// Enable exit exception.
$class_wp_cli_capture_exit->setValue( true );

$logger = new \WP_CLI\Loggers\Execution;
WP_CLI::set_logger( $logger );

$exception = null;
try {
Utils\http_request( 'GET', 'https://nosuchhost_asdf_asdf_asdf.com' );
} catch ( \WP_CLI\ExitException $ex ) {
$exception = $ex;
}
$this->assertTrue( null !== $exception );
$this->assertTrue( 1 === $exception->getCode() );
$this->assertTrue( empty( $logger->stdout ) );
$this->assertTrue( 0 === strpos( $logger->stderr, 'Error: Failed to get url' ) );

// Restore.
$class_wp_cli_logger->setValue( $prev_logger );
$class_wp_cli_capture_exit->setValue( $prev_capture_exit );
}

public function testHttpRequestBadCAcert() {
// Save WP_CLI state.
$class_wp_cli_logger = new \ReflectionProperty( 'WP_CLI', 'logger' );
$class_wp_cli_logger->setAccessible( true );

$prev_logger = $class_wp_cli_logger->getValue();

$have_bad_cacert = false;
$created_dirs = array();

$vendor_dir = WP_CLI_ROOT . '/../../../vendor';
$cert_path = '/rmccue/requests/library/Requests/Transport/cacert.pem';
$bad_cacert_path = $vendor_dir . $cert_path;
if ( ! file_exists( $bad_cacert_path ) ) {
// Capture any directories created so can clean up.
$dirs = array_merge( array( 'vendor' ), array_filter( explode( '/', dirname( $cert_path ) ) ) );
$current_dir = dirname( $vendor_dir );
foreach ( $dirs as $dir ) {
if ( ! file_exists( $current_dir . '/' . $dir ) ) {
if ( ! @mkdir( $current_dir . '/' . $dir ) ) {
break;
}
$created_dirs[] = $current_dir . '/' . $dir;
}
$current_dir .= '/' . $dir;
}
if ( $current_dir === dirname( $bad_cacert_path ) && file_put_contents( $bad_cacert_path, "-----BEGIN CERTIFICATE-----\nasdfasdf\n-----END CERTIFICATE-----\n" ) ) {
$have_bad_cacert = true;
}
}

if ( ! $have_bad_cacert ) {
foreach ( array_reverse( $created_dirs ) as $created_dir ) {
rmdir( $created_dir );
}
$this->markTestSkipped( 'Unable to create bad CAcert.' );
}

$logger = new \WP_CLI\Loggers\Execution;
WP_CLI::set_logger( $logger );

Utils\http_request( 'GET', 'https://example.com' );

// Undo bad CAcert stuff before asserting.
unlink( $bad_cacert_path );
foreach ( array_reverse( $created_dirs ) as $created_dir ) {
rmdir( $created_dir );
}

$this->assertTrue( empty( $logger->stdout ) );
$this->assertTrue( 0 === strpos( $logger->stderr, 'Warning: Re-trying without verify after failing to get verified url' ) );
$this->assertFalse( strpos( $logger->stderr, 'Error' ) );

// Restore.
$class_wp_cli_logger->setValue( $prev_logger );
}

}