Add proxy testing

.travis.yml

@@ -14,23 +14,40 @@ matrix:
 # Use new container infrastructure
 sudo: false
 
-before_script:
+cache:
+  directories:
+    - $HOME/.cache/pip
+    - $HOME/.composer/cache
+    - vendor
+
+install:
  # Setup the test server
  - phpenv local 5.5
  - composer install --dev --no-interaction
-
  - TESTPHPBIN=$(phpenv which php)
+ - phpenv local --unset
+
+ # Setup the proxy
+ - pip install --user mitmproxy
+
+before_script:
  - PHPBIN=$TESTPHPBIN PORT=8080 vendor/bin/start.sh
  - export REQUESTS_TEST_HOST_HTTP="localhost:8080"
- - phpenv local --unset
 
  # Work out of the tests directory
  - cd tests
+ - PROXYBIN="$HOME/.local/bin/mitmdump" PORT=9002 utils/proxy/start.sh
+ - PROXYBIN="$HOME/.local/bin/mitmdump" PORT=9003 AUTH="test:pass" utils/proxy/start.sh
+ - export REQUESTS_HTTP_PROXY="localhost:9002"
+ - export REQUESTS_HTTP_PROXY_AUTH="localhost:9003"
+ - export REQUESTS_HTTP_PROXY_AUTH_USER="test"
+ - export REQUESTS_HTTP_PROXY_AUTH_PASS="pass"
 
 script:
  - phpunit --coverage-clover clover.xml
 
 after_script:
+ - utils/proxy/stop.sh
  - cd ..
  - phpenv local 5.5
  - PATH=$PATH vendor/bin/stop.sh

tests/Proxy/HTTP.php

@@ -0,0 +1,131 @@
+<?php
+
+class RequestsTest_Proxy_HTTP extends PHPUnit_Framework_TestCase {
+	protected function checkProxyAvailable($type = '') {
+		switch ($type) {
+			case 'auth':
+				$has_proxy = defined('REQUESTS_HTTP_PROXY_AUTH') && REQUESTS_HTTP_PROXY_AUTH;
+				break;
+
+			default:
+				$has_proxy = defined('REQUESTS_HTTP_PROXY') && REQUESTS_HTTP_PROXY;
+				break;
+		}
+
+		if (!$has_proxy) {
+			$this->markTestSkipped('Proxy not available');
+		}
+	}
+
+	public function transportProvider() {
+		return array(
+			array('Requests_Transport_cURL'),
+			array('Requests_Transport_fsockopen'),
+		);
+	}
+
+	/**
+	 * @dataProvider transportProvider
+	 */
+	public function testConnectWithString($transport) {
+		$this->checkProxyAvailable();
+
+		$options = array(
+			'proxy' => REQUESTS_HTTP_PROXY,
+			'transport' => $transport,
+		);
+		$response = Requests::get(httpbin('/get'), array(), $options);
+		$this->assertEquals('http', $response->headers['x-requests-proxied']);
+
+		$data = json_decode($response->body, true);
+		$this->assertEquals('http', $data['headers']['x-requests-proxy']);
+	}
+
+	/**
+	 * @dataProvider transportProvider
+	 */
+	public function testConnectWithArray($transport) {
+		$this->checkProxyAvailable();
+
+		$options = array(
+			'proxy' => array(REQUESTS_HTTP_PROXY),
+			'transport' => $transport,
+		);
+		$response = Requests::get(httpbin('/get'), array(), $options);
+		$this->assertEquals('http', $response->headers['x-requests-proxied']);
+
+		$data = json_decode($response->body, true);
+		$this->assertEquals('http', $data['headers']['x-requests-proxy']);
+	}
+
+	/**
+	 * @dataProvider transportProvider
+	 * @expectedException Requests_Exception
+	 */
+	public function testConnectInvalidParameters($transport) {
+		$this->checkProxyAvailable();
+
+		$options = array(
+			'proxy' => array(REQUESTS_HTTP_PROXY, 'testuser', 'password', 'something'),
+			'transport' => $transport,
+		);
+		$response = Requests::get(httpbin('/get'), array(), $options);
+	}
+
+	/**
+	 * @dataProvider transportProvider
+	 */
+	public function testConnectWithInstance($transport) {
+		$this->checkProxyAvailable();
+
+		$options = array(
+			'proxy' => REQUESTS_HTTP_PROXY,
+			'transport' => $transport,
+		);
+		$response = Requests::get(httpbin('/get'), array(), $options);
+		$this->assertEquals('http', $response->headers['x-requests-proxied']);
+
+		$data = json_decode($response->body, true);
+		$this->assertEquals('http', $data['headers']['x-requests-proxy']);
+	}
+
+	/**
+	 * @dataProvider transportProvider
+	 */
+	public function testConnectWithAuth($transport) {
+		$this->checkProxyAvailable('auth');
+
+		$options = array(
+			'proxy' => array(
+				REQUESTS_HTTP_PROXY_AUTH,
+				REQUESTS_HTTP_PROXY_AUTH_USER,
+				REQUESTS_HTTP_PROXY_AUTH_PASS
+			),
+			'transport' => $transport,
+		);
+		$response = Requests::get(httpbin('/get'), array(), $options);
+		$this->assertEquals(200, $response->status_code);
+		$this->assertEquals('http', $response->headers['x-requests-proxied']);
+
+		$data = json_decode($response->body, true);
+		$this->assertEquals('http', $data['headers']['x-requests-proxy']);
+	}
+
+	/**
+	 * @dataProvider transportProvider
+	 */
+	public function testConnectWithInvalidAuth($transport) {
+		$this->checkProxyAvailable('auth');
+
+		$options = array(
+			'proxy' => array(
+				REQUESTS_HTTP_PROXY_AUTH,
+				REQUESTS_HTTP_PROXY_AUTH_USER . '!',
+				REQUESTS_HTTP_PROXY_AUTH_PASS . '!'
+			),
+			'transport' => $transport,
+		);
+		$response = Requests::get(httpbin('/get'), array(), $options);
+		$this->assertEquals(407, $response->status_code);
+	}
+}

tests/bootstrap.php

@@ -2,13 +2,28 @@
 
 date_default_timezone_set('UTC');
 
+function define_from_env($name, $default = false) {
+	$env = getenv($name);
+	if ($env) {
+		define($name, $env);
+	}
+	else {
+		define($name, $default);
+	}
+}
+
 $host = getenv('REQUESTS_TEST_HOST');
 if (empty($host)) {
 	$host = 'httpbin.org';
 }
-define('REQUESTS_TEST_HOST',       getenv('REQUESTS_TEST_HOST') ? getenv('REQUESTS_TEST_HOST') : 'httpbin.org');
-define('REQUESTS_TEST_HOST_HTTP',  getenv('REQUESTS_TEST_HOST_HTTP') ? getenv('REQUESTS_TEST_HOST_HTTP') : REQUESTS_TEST_HOST);
-define('REQUESTS_TEST_HOST_HTTPS', getenv('REQUESTS_TEST_HOST_HTTPS') ? getenv('REQUESTS_TEST_HOST_HTTPS'): REQUESTS_TEST_HOST);
+define_from_env('REQUESTS_TEST_HOST', 'httpbin.org');
+define_from_env('REQUESTS_TEST_HOST_HTTP', REQUESTS_TEST_HOST);
+define_from_env('REQUESTS_TEST_HOST_HTTPS', REQUESTS_TEST_HOST);
+
+define_from_env('REQUESTS_HTTP_PROXY');
+define_from_env('REQUESTS_HTTP_PROXY_AUTH');
+define_from_env('REQUESTS_HTTP_PROXY_AUTH_USER');
+define_from_env('REQUESTS_HTTP_PROXY_AUTH_PASS');
 
 include(dirname(dirname(__FILE__)) . '/library/Requests.php');
 Requests::register_autoloader();

tests/phpunit.xml.dist

@@ -7,6 +7,9 @@
 		<testsuite name="Transports">
 			<directory suffix=".php">Transport</directory>
 		</testsuite>
+		<testsuite name="Proxies">
+			<directory suffix=".php">Proxy</directory>
+		</testsuite>
 		<testsuite name="General">
 			<file>ChunkedEncoding.php</file>
 			<file>Cookies.php</file>

tests/utils/proxy/proxy.py

@@ -0,0 +1,5 @@
+def request(context, flow):
+	flow.request.headers["x-requests-proxy"] = ["http"]
+
+def response(context, flow):
+	flow.response.headers["x-requests-proxied"] = ["http"]

tests/utils/proxy/start.sh

@@ -0,0 +1,11 @@
+PROXYDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+PORT=${PORT:-9000}
+
+PROXYBIN=${PROXYBIN:-"$(which mitmdump)"}
+ARGS="-s '$PROXYDIR/proxy.py' -p $PORT"
+if [[ ! -z "$AUTH" ]]; then
+	ARGS="$ARGS --singleuser=$AUTH"
+fi
+PIDFILE="$PROXYDIR/proxy.pid"
+
+start-stop-daemon --start --background --pidfile $PIDFILE --make-pidfile --exec $PROXYBIN -- $ARGS

tests/utils/proxy/stop.sh

@@ -0,0 +1,5 @@
+PROXYDIR="$PWD/$(dirname $0)"
+
+PIDFILE="$PROXYDIR/proxy.pid"
+
+start-stop-daemon --stop --pidfile $PIDFILE --make-pidfile && rm $PROXYDIR/proxy.pid