test_urllib3_mock.py

import inspect
import re
from inspect import (
    getargspec,
    getfullargspec,
)

import pytest
import requests
from requests.exceptions import ConnectionError
from requests.packages.urllib3.exceptions import ProtocolError, HTTPError

from urllib3_mock import Responses

responses = Responses('requests.packages.urllib3')


def assert_reset():
    assert len(responses._urls) == 0
    assert len(responses.calls) == 0


def assert_response(resp, body=None):
    assert resp.status_code == 200
    assert resp.reason == 'OK'
    assert resp.headers['Content-Type'] == 'text/plain'
    assert resp.text == body


def test_response():
    @responses.activate
    def run():
        responses.add(responses.GET, '/', body=b'test')
        resp = requests.get('http://example.com')
        assert_response(resp, 'test')
        assert len(responses.calls) == 1
        req = responses.calls[0].request
        assert req.method == 'GET'
        assert req.url == '/'
        assert req.scheme == 'http'
        assert req.host == 'example.com'
        assert req.port == 80
        assert 'Accept' in req.headers
        assert req.headers['Connection'] == 'keep-alive'
        assert req.body is None

        resp = requests.get('http://example.com?foo=bar')
        assert_response(resp, 'test')
        assert len(responses.calls) == 2
        assert responses.calls[-1].request.url == '/?foo=bar'

        # With HTTPS too
        resp = requests.get('https://example.com')
        assert_response(resp, 'test')
        assert len(responses.calls) == 3
        assert responses.calls[-1].request.url == '/'
        assert responses.calls[-1].request.scheme == 'https'

    run()
    assert_reset()


def test_connection_error():
    @responses.activate
    def run():
        responses.add(responses.GET, '/')

        with pytest.raises(ConnectionError):
            requests.get('http://example.com/foo')

        assert len(responses.calls) == 1
        assert responses.calls[0].request.url == '/foo'
        assert type(responses.calls[0].response) is ProtocolError

    run()
    assert_reset()


def test_match_querystring():
    @responses.activate
    def run():
        url = '/?test=1&foo=bar'
        responses.add(
            responses.GET, url,
            match_querystring=True, body=b'test')
        resp = requests.get('http://example.com?test=1&foo=bar')
        assert_response(resp, 'test')
        resp = requests.get('http://example.com?foo=bar&test=1')
        assert_response(resp, 'test')

    run()
    assert_reset()


def test_match_querystring_error():
    @responses.activate
    def run():
        responses.add(
            responses.GET, '/?test=1',
            match_querystring=True)

        with pytest.raises(ConnectionError):
            requests.get('http://example.com/foo/?test=2')

    run()
    assert_reset()


def test_match_querystring_regex():
    @responses.activate
    def run():
        """Note that `match_querystring` value shouldn't matter when passing a
        regular expression"""

        responses.add(
            responses.GET, re.compile(r'/foo/\?test=1'),
            body='test1', match_querystring=True)

        resp = requests.get('http://example.com/foo/?test=1')
        assert_response(resp, 'test1')

        responses.add(
            responses.GET, re.compile(r'/foo/\?test=2'),
            body='test2', match_querystring=False)

        resp = requests.get('http://example.com/foo/?test=2')
        assert_response(resp, 'test2')

    run()
    assert_reset()


def test_match_querystring_error_regex():
    @responses.activate
    def run():
        """Note that `match_querystring` value shouldn't matter when passing a
        regular expression"""

        responses.add(
            responses.GET, re.compile(r'/foo/\?test=1'),
            match_querystring=True)

        with pytest.raises(ConnectionError):
            requests.get('http://example.com/foo/?test=3')

        responses.add(
            responses.GET, re.compile(r'/foo/\?test=2'),
            match_querystring=False)

        with pytest.raises(ConnectionError):
            requests.get('http://example.com/foo/?test=4')

    run()
    assert_reset()


def test_accept_string_body():
    @responses.activate
    def run():
        url = 'http://example.com/'
        responses.add(
            responses.GET, '/', body='test')
        resp = requests.get(url)
        assert_response(resp, 'test')

    run()
    assert_reset()


def test_custom_http_status():
    @responses.activate
    def run():
        responses.add(
            responses.GET, '/', '', status="418 I'm a teapot")
        resp = requests.get('http://example.com')
        assert resp.status_code == 418
        assert resp.reason == "I'm a teapot"

    run()
    assert_reset()


def test_throw_connection_error_explicit():
    @responses.activate
    def run():
        url = 'http://example.com'
        exception = HTTPError('HTTP Error')
        responses.add(
            responses.GET, '/', exception)

        with pytest.raises(HTTPError) as HE:
            requests.get(url)

        assert str(HE.value) == 'HTTP Error'

    run()
    assert_reset()


def test_callback():
    body = b'test callback'
    status = '400 Broken Stuff'
    headers = {'foo': 'bar', 'content-type': 'text/nonsense'}
    url = 'http://example.com/'

    def request_callback(request):
        assert request.url == '/'
        assert request.scheme == 'http'
        assert request.host == 'example.com'
        assert request.port == 80
        return (status, headers, body)

    @responses.activate
    def run():
        responses.add_callback(responses.GET, '/', request_callback)
        resp = requests.get(url)
        assert resp.text == "test callback"
        assert resp.status_code == 400
        assert resp.reason == 'Broken Stuff'
        assert 'foo' in resp.headers
        assert resp.headers['foo'] == 'bar'
        assert resp.headers['Content-Type'] == 'text/nonsense'
        assert len(resp.raw._original_response.msg) == 2

    run()
    assert_reset()


def test_callback_noheaders():
    body = 'test no additional header'
    status = 200
    url = 'http://example.com/'

    def request_callback(request):
        return (status, None, body)

    @responses.activate
    def run():
        responses.add_callback(responses.GET, '/', request_callback)
        resp = requests.get(url)
        assert resp.text == "test no additional header"
        assert resp.status_code == status
        assert resp.reason == 'OK'
        assert 'content-type' in resp.headers
        assert resp.headers['content-type'] == 'text/plain'

    run()
    assert_reset()


def test_regular_expression_url():
    @responses.activate
    def run():
        url = re.compile(r'/(.*\.)?examples?')
        responses.add(responses.GET, url, body=b'test')

        resp = requests.get('http://nowhere.invalid/example')
        assert_response(resp, 'test')

        resp = requests.get('https://nowhere.invalid/examples')
        assert_response(resp, 'test')

        resp = requests.get('http://nowhere.invalid/uk.example')
        assert_response(resp, 'test')

        with pytest.raises(ConnectionError):
            requests.get('http://nowhere.invalid/uk.exaaample')

    run()
    assert_reset()


def test_catchall():
    status = 400
    headers = {'foo': 'bar'}

    def request_callback(request):
        body = str(request)
        return (status, headers, body)

    @responses.activate
    def run():
        responses.add_callback(responses.GET, responses.ANY, request_callback)
        resp0 = requests.get('http://example.com/')
        resp1 = requests.get('https://example.com/')
        resp2 = requests.get('http://example.com/rabbit')
        resp3 = requests.get('https://example.com?bar=foo#123')
        assert resp0.status_code == status
        assert resp0.reason == 'Bad Request'
        assert 'foo' in resp1.headers
        assert resp3.headers['foo'] == 'bar'
        assert "host='example.com'" in resp0.text
        assert "scheme='https'" in resp1.text
        assert "url='/rabbit'" in resp2.text
        assert "url='/?bar=foo'" in resp3.text

        with pytest.raises(ConnectionError):
            requests.post('http://example.com/')
        assert len(responses.calls) == 5

        responses.reset()
        responses.add_callback(responses.ANY, '/', request_callback)
        resp0 = requests.get('http://example.com')
        resp1 = requests.head('http://example.com')
        resp2 = requests.post('http://example.com')
        assert "method='GET'" in resp0.text
        assert "method='HEAD'" in resp1.text
        assert "method='POST'" in resp2.text

        with pytest.raises(ConnectionError):
            requests.post('http://example.com/rabbit')
        assert len(responses.calls) == 4

    run()
    assert_reset()


def test_responses_as_context_manager():
    def run():
        with responses as d2r2:
            assert responses is d2r2
            responses.add(responses.GET, '/', body=b'test')
            resp = requests.get('http://example.com')
            assert_response(resp, 'test')
            assert len(responses.calls) == 1
            assert responses.calls[0].request.url == '/'

            resp = requests.get('http://example.com?foo=bar')
            assert_response(resp, 'test')
            assert len(responses.calls) == 2
            assert responses.calls[1].request.url == '/?foo=bar'

    run()
    assert_reset()


def test_activate_doesnt_change_signature():
    def test_function(a, b=None):
        return (a, b)

    decorated_test_function = responses.activate(test_function)
    assert inspect.signature(test_function) == inspect.signature(decorated_test_function)
    assert decorated_test_function(1, 2) == test_function(1, 2)
    assert decorated_test_function(3) == test_function(3)


def test_activate_doesnt_change_signature_for_method():
    class TestCase(object):

        def test_function(self, a, b=None):
            return (self, a, b)

    test_case = TestCase()
    signature = inspect.signature(test_case.test_function)
    decorated_test_function = responses.activate(test_case.test_function)
    assert signature == inspect.signature(decorated_test_function)
    assert decorated_test_function(1, 2) == test_case.test_function(1, 2)
    assert decorated_test_function(3) == test_case.test_function(3)


def test_response_cookies():
    body = b'test callback'
    status = 200
    headers = {'set-cookie': 'session_id=12345; a=b; c=d'}
    url = 'http://example.com/'

    def request_callback(request):
        return (status, headers, body)

    @responses.activate
    def run():
        responses.add_callback(responses.GET, '/', request_callback)
        resp = requests.get(url)
        assert resp.text == "test callback"
        assert resp.status_code == status
        assert 'session_id' in resp.cookies
        assert resp.cookies['session_id'] == '12345'
        for cookie in resp.cookies:
            if cookie.name == 'session_id':
                break
        assert cookie.get_nonstandard_attr('a') == 'b'
        assert cookie.get_nonstandard_attr('c') == 'd'

    run()
    assert_reset()


def test_response_multiple_cookies():
    body = b'test multiple cookies'
    headers = [('set-cookie', 'session_id=12345'),
               ('set-cookie', 'username=john john')]
    url = 'http://example.com/'

    @responses.activate
    def run():
        responses.add(responses.GET, '/', body=body, adding_headers=headers)
        resp = requests.get(url)
        assert 'session_id' in resp.cookies
        assert 'username' in resp.cookies
        assert 'password' not in resp.cookies
        assert resp.cookies['session_id'] == '12345'
        assert resp.cookies['username'] == 'john john'

    run()
    assert_reset()


def test_allow_redirects_samehost():
    redirecting_url = 'http://example.com'
    final_url_path = '/1'
    final_url = '{0}{1}'.format(redirecting_url, final_url_path)
    url_re = re.compile(r'^/(\d+)?$')

    def request_callback(request):
        # endpoint of chained redirect
        if request.url.endswith(final_url_path):
            return 200, (), b'test'
        # otherwise redirect to an integer path
        else:
            if request.url.endswith('/0'):
                n = 1
            else:
                n = 0
            redirect_headers = {'location': '/{0!s}'.format(n)}
            return 301, redirect_headers, None

    def run():
        # setup redirect
        with responses:
            responses.add_callback(responses.GET, url_re, request_callback)
            resp_no_redirects = requests.get(redirecting_url,
                                             allow_redirects=False)
            assert resp_no_redirects.status_code == 301
            assert len(responses.calls) == 1  # 1x300
            assert responses.calls[0][1].status == 301
        assert_reset()

        with responses:
            responses.add_callback(responses.GET, url_re, request_callback)
            resp_yes_redirects = requests.get(redirecting_url,
                                              allow_redirects=True)
            assert len(responses.calls) == 3  # 2x300 + 1x200
            assert len(resp_yes_redirects.history) == 2
            assert resp_yes_redirects.status_code == 200
            assert final_url == resp_yes_redirects.url
            status_codes = [call[1].status for call in responses.calls]
            assert status_codes == [301, 301, 200]
        assert_reset()

    run()
    assert_reset()