tests.py

from unittest import TestCase
import mock

def mock_API():
    from van_api import API
    return mock.Mock(spec_set=API)

class TestCredentials(TestCase):

    def test_access_token(self):
        from van_api import Credentials
        one = Credentials()
        self.assertRaises(NotImplementedError, one.access_token, mock_API())

    def test_token(self):
        from van_api import Credentials, _HTTPConnection
        from mock import Mock
        one = Credentials()
        one.conn = Mock(set_spec=_HTTPConnection)
        api = mock_API()
        result = one._token(api, dict(param='param value'), )
        one.conn.http_retry.assert_called_once_with(
                'POST',
                '/oauth/token',
                body='param=param+value',
                headers={'Content-Type': 'application/x-www-form-urlencoded'},
                handler=api.handle
                )
        self.assertEqual(result, one.conn.http_retry())


class TestClientCredentialsGrant(TestCase):

    @mock.patch('van_api.Credentials._token')
    def test_access_token(self, token):
        from van_api import ClientCredentialsGrant
        creds = ClientCredentialsGrant('key', 'secret')
        creds.access_token('api')
        token.assert_called_once_with('api', dict(
                grant_type='client_credentials',
                api_key="key",
                api_secret="secret"))


class TestAPI(TestCase):

    def _one(self, host='apihost', response=None, **kw):
        try:
            from http.client import HTTPSConnection
        except ImportError:
            #python 2
            from httplib import HTTPSConnection
        from van_api import API
        conn = mock.Mock(spec_set=HTTPSConnection)
        if response is not None:
            resp = conn().getresponse()
            resp.getheaders.return_value = response['headers']
            resp.read.return_value = response['body']
            resp.status = response['status']
            resp.reason = response.get('reason', 'dummy reason')
            conn.reset_mock()
        return API(host, conn_factory=conn, **kw)

    def test_init_defaults(self):
        try:
            from http.client import HTTPSConnection
        except ImportError:
            #python 2
            from httplib import HTTPSConnection
        import logging
        from van_api import API
        one = API('host', 'creds')
        self.assertEqual(one.conn.host, 'host')
        self.assertEqual(one._creds, 'creds')
        self.assertEqual(one.conn._conn, None)
        self.assertEqual(one.logger, logging)
        self.assertEqual(one.conn.logger, logging)
        self.assertEqual(one.conn._conn_factory, HTTPSConnection)

    def test_get(self):
        one = self._one()
        one.request = mock.Mock()
        result = one.GET('/')
        one.request.assert_called_once_with('GET', '/')
        self.assertEqual(result, one.request())

    def test_get_with_outfile(self):
        one = self._one()
        one.request = mock.Mock()
        outfile = mock.Mock()
        result = one.GET('/', outfile=outfile)
        self.assertEqual(one.request.call_count, 1)
        self.assertTrue('http_handler' in one.request.call_args[1])
        self.assertEqual(result, one.request())

    def test_put(self):
        one = self._one()
        one.request = mock.Mock()
        result = one.PUT('/', 'data')
        one.request.assert_called_once_with('PUT', '/', 'data')
        self.assertEqual(result, one.request())

    def test_delete(self):
        one = self._one()
        one.request = mock.Mock()
        result = one.DELETE('/')
        one.request.assert_called_once_with('DELETE', '/')
        self.assertEqual(result, one.request())

    def test_patch(self):
        one = self._one()
        one.request = mock.Mock()
        result = one.PATCH('/', 'data')
        one.request.assert_called_once_with('PATCH', '/', 'data')
        self.assertEqual(result, one.request())

    def test_post(self):
        one = self._one()
        one.request = mock.Mock()
        result = one.POST('/', 'data')
        one.request.assert_called_once_with('POST', '/', 'data', content_type=None)
        self.assertEqual(result, one.request())

    def test_post_with_ct(self):
        one = self._one()
        one.request = mock.Mock()
        result = one.POST('/', 'data', content_type="image/jpeg")
        one.request.assert_called_once_with('POST', '/', 'data', content_type="image/jpeg")
        self.assertEqual(result, one.request())

    def test_handle_ok(self):
        one = self._one()
        result = one.handle('request', dict(
            headers=[],
            body='',
            status=200))
        self.assertEqual(result, None)

    def test_handle_ok_with_data(self):
        one = self._one()
        result = one.handle('request', dict(
            headers=[('content-type', 'application/json', )],
            body='123'.encode('ascii'),
            status=200))
        self.assertEqual(result, 123)

    def test_handle_ok_with_unicode_data(self):
        from van_api import _unicode
        one = self._one()
        result = one.handle('request', dict(
            headers=[('content-type', 'application/json', )],
            body='"unicode"'.encode('ascii'),
            status=200))
        self.assertTrue(isinstance(result, _unicode))
        self.assertEqual(result, _unicode('unicode'))

    def test_handle_error(self):
        from van_api import APIError
        one = self._one()
        self.assertRaises(APIError, one.handle, 'request', dict(
            headers=[],
            body='',
            status=500))

    def test_handle_error_with_data(self):
        from van_api import APIError
        try:
            import json
        except ImportError:
            import simplejson as json
        one = self._one()
        self.assertRaises(APIError, one.handle, 'request', dict(
            headers=[('content-type', 'application/json')],
            body=json.dumps({'error': 'bad_parameters',
                    'error_description': 'Developer description of error',
                    'error_uri': 'http://example.com/errorpage.html',
                    'error_info': {'key': 'value'}}).encode('ascii'),
            status=400))

    def test_handle_retry_on_503(self):
        from van_api import Retryable
        one = self._one()
        self.assertRaises(Retryable, one.handle, 'request', dict(
            headers=[('content-type', 'application/json', )],
            body='123',
            status=503))

    def test_handle_retry_on_401(self):
        from van_api import Retryable
        one = self._one()
        self.assertEqual(one._access_token, None)
        one._access_token = 'token'
        self.assertRaises(Retryable, one.handle, 'request', dict(
            headers=[('content-type', 'application/json', )],
            body='123',
            status=401))
        self.assertEqual(one._access_token, None)

    def test_get_access_token(self):
        from van_api import Credentials
        creds = mock.Mock(spec_set=Credentials)
        creds.access_token.return_value = {'token_type': 'bearer', 'access_token': 'my_token'}
        one = self._one(credentials=creds)
        self.assertEqual(one._access_token, None)
        result = one._get_access_token()
        one._creds.access_token.assert_called_once_with(one)
        self.assertEqual(one._access_token, result)
        self.assertEqual(one._access_token, one._creds.access_token())

    def test_get_access_token_cached(self):
        from van_api import Credentials
        creds = mock.Mock(spec_set=Credentials)
        creds.access_token.return_value = {'token_type': 'bearer', 'access_token': 'my_token'}
        one = self._one(credentials=creds)
        one._access_token = cached = {'token_type': 'bearer', 'access_token': 'cached'}
        result = one._get_access_token()
        self.assertFalse(one._creds.access_token.called)
        self.assertEqual(one._access_token, cached)

    def test_request_ok_data(self):
        one = self._one()
        one.conn.http_retry = retry = mock.Mock()
        result = one.request('PUT', '/', 123)
        retry.assert_called_once_with(
                'PUT',
                '/',
                body='123',
                headers={'Content-Type': 'application/json'},
                handler=one.handle,
                http_handler=None
                )
        self.assertEqual(result, retry())

    def test_request_ok_access_token(self):
        from van_api import Credentials
        creds = mock.Mock(spec_set=Credentials)
        creds.access_token.return_value = {'token_type': 'bearer', 'access_token': 'my_token'}
        one = self._one(credentials=creds)
        one.conn.http_retry = retry = mock.Mock()
        result = one.request('PUT', '/', 123)
        retry.assert_called_once_with(
                'PUT',
                '/',
                body='123',
                headers={'Content-Type': 'application/json',
                    'Authorization': 'bearer my_token'},
                handler=one.handle,
                http_handler=None
                )
        self.assertEqual(result, retry())

    def test_request_ok_default_headers(self):
        one = self._one(default_headers={'Cache-Control': 'no-cache'})
        one.conn.http_retry = retry = mock.Mock()
        result = one.request('GET', '/')
        retry.assert_called_once_with(
                'GET',
                '/',
                body=None,
                headers={'Cache-Control': 'no-cache'},
                handler=one.handle,
                http_handler=None
                )
        self.assertEqual(result, retry())

    def test_request_ok_no_data(self):
        one = self._one()
        one.conn.http_retry = retry = mock.Mock()
        result = one.request('GET', '/')
        retry.assert_called_once_with(
                'GET',
                '/',
                body=None,
                headers={},
                handler=one.handle,
                http_handler=None
                )
        self.assertEqual(result, retry())

    def test_deserialize_json(self):
        body = '{"abc": 1}'.encode('ascii')
        one = self._one()
        self.assertEqual(
                one._deserialize(body, 'application/json'),
                {'abc': 1})

class Test_HTTPConnection(TestCase):

    def _conn_factory(self):
        try:
            from http.client import HTTPSConnection
        except ImportError:
            #python 2
            from httplib import HTTPSConnection
        return mock.Mock(spec_set=HTTPSConnection)

    def _one(self, host='example.org', conn_factory=None, logger=None):
        from van_api import _HTTPConnection
        if conn_factory is None:
            conn_factory = self._conn_factory()
        return _HTTPConnection(host, conn_factory=conn_factory, logger=logger)

    def test_http_connect(self):
        one = self._one('example.com')
        self.assertEqual(one._conn, None)
        one.http('GET', '/')
        one._conn_factory.assert_called_once_with('example.com')
        self.assertEqual(one._conn, one._conn_factory())

    def test_retry_retryable_wrapping_other_exception(self):
        import sys
        from van_api import Retryable
        from mock import call
        func = mock.Mock()
        class MyException(Exception):
            pass
        def side_effect(one, a=0):
            try:
                raise MyException()
            except:
                raise Retryable("A retryable error", exc_info=sys.exc_info())
        func.side_effect = side_effect
        conn = self._one()
        conn.http = func
        self.assertRaises(MyException, conn.http_retry, 55, a=42)
        self.assertEqual(func.call_args_list, [call(55, a=42)] * 5)

    def test_retry_retryable_exception_third_time_lucky(self):
        from van_api import Retryable
        from mock import call
        class MyException(Retryable):
            pass
        return_val = [MyException('oops'), MyException('oops')]
        def side_effect(b, a=0):
            if return_val:
                raise return_val.pop()
            return a + b
        func = mock.Mock()
        func.side_effect = side_effect
        conn = self._one()
        conn.http = func
        self.assertEqual(42, conn.http_retry(2, a=40))
        self.assertEqual(func.call_args_list, [call(2, a=40)] * 3)

    def test_retry_bad_retryable_exception(self):
        from van_api import Retryable
        from mock import call
        func = mock.Mock()
        class MyException(Retryable):
            def reraise(self):
                pass # should raise
        func.side_effect = MyException('oops')
        conn = self._one()
        conn.http = func
        # no infinite loops here
        self.assertRaises(AssertionError, conn.http_retry, 55, a=42)

    def test_retry_retryable_exception_exhausted(self):
        from van_api import Retryable
        from mock import call
        func = mock.Mock()
        class MyException(Retryable):
            pass
        func.side_effect = MyException('oops')
        conn = self._one()
        conn.http = func
        self.assertRaises(MyException, conn.http_retry, 55, a=42)
        self.assertEqual(func.call_args_list, [call(55, a=42)] * 5)

    def test_http_retryable_error_raised(self):
        from van_api import Retryable
        class Error(Exception):
            pass
        one = self._one()
        one._conn_factory().request.side_effect = Error('boom')
        try:
            one.http('GET', '/')
        except Retryable:
            import sys
            e = sys.exc_info()[1]
            self.assertTrue(isinstance(e.exc_info[1], Error))
            self.assertEqual(e.exc_info[0], Error)
        else:
            self.fail('Exceptiong not raised')

    def test_http_disconnect_on_error(self):
        from mock import Mock
        one = self._one()
        conn = Mock()
        class Boom(Exception):
            pass
        conn.request.side_effect = Boom
        one._conn = conn
        # A connection error, so retryable
        from van_api import Retryable
        self.assertRaises(Retryable, one.http, 'GET', '/')
        self.assertEqual(one._conn, None)
        conn.close.assert_called_once_with()

    def test_http_log_on_error(self):
        import logging
        logger = mock.Mock(spec_set=logging.Logger)
        one = self._one()
        one.logger = logger
        one._conn_factory().request.side_effect = Exception('boom')
        one._conn_factory.reset_mock()
        self.assertRaises(Exception, one.http, 'GET', '/')
        logger.info.assert_called_once_with('HTTP Connection Error', exc_info=True)

    def test_retry_no_exception(self):
        func = mock.Mock()
        conn = self._one()
        conn.http = func
        result = conn.http_retry(55, a=42)
        func.assert_called_once_with(55, a=42)
        self.assertEqual(func(), result)

    def test_retry_logging(self):
        from van_api import Retryable
        import logging
        from mock import call
        func = mock.Mock()
        logger = mock.Mock(spec_set=logging.Logger)
        class MyException(Retryable):
            pass
        func.side_effect = MyException('oops')
        conn = self._one(logger=logger)
        conn.http = func
        result = self.assertRaises(Exception, conn.http_retry, 55, a=42)
        expected = [call('Attempt %s failed', n + 1, exc_info=True) for n
                in range(5)]
        self.assertEqual(
                logger.warn.call_args_list,
                expected)

    def test_retry_non_retryable_exception(self):
        func = mock.Mock()
        class MyException(Exception):
            pass
        func.side_effect = MyException('oops')
        conn = self._one()
        conn.http = func
        self.assertRaises(MyException, conn.http_retry, 55, a=42)
        func.assert_called_once_with(55, a=42)

    def test_http_calls_handle(self):
        conn_factory = self._conn_factory()
        resp = conn_factory().getresponse()
        resp.getheaders.return_value = [('Header1', 'value'), ]
        resp.read.return_value = ''
        resp.status = 200
        resp.reason = 'OK'
        one = self._one('www.example.com', conn_factory=conn_factory)
        handle = mock.Mock()
        result = one.http('POST', '/', handler=handle)
        handle.assert_called_once_with(
                {'body': None, 'headers': None, 'host': 'www.example.com', 'url': '/', 'method': 'POST'},
                {'body': '', 'headers': [('Header1', 'value'), ], 'reason': 'OK', 'status': 200})
        self.assertEqual(result, handle())

    def test_http_with_http_handler(self):
        conn_factory = self._conn_factory()
        one = self._one('www.example.com', conn_factory=conn_factory)
        my_http_handler = mock.Mock()
        result = one.http('GET', '/', http_handler=my_http_handler)
        my_http_handler.assert_called_once_with(
            {'body': None, 'headers': None, 'host': 'www.example.com', 'url': '/', 'method': 'GET'},
            conn_factory().getresponse()
            )
        self.assertEqual(result, my_http_handler())

    def test_http_absolute_url(self):
        one = self._one('www.example.com')
        result = one.http('GET', 'https://www.example.com/a/b/c')
        request = one._conn_factory().request
        request.assert_called_once_with('GET', '/a/b/c', body=None, headers=None)

    def test_get_path_assertion_error(self):
        from van_api import _HTTPConnection
        one = _HTTPConnection(host='ex.example.com')
        self.assertRaises(AssertionError, one._get_path, 'http://ex.example.com/abc?x=55')
        self.assertRaises(AssertionError, one._get_path, 'https://exe.example.com/abc?x=55')
        path = one._get_path('https://ex.example.com/abc?x=55')
        self.assertEqual(path, '/abc?x=55')

class Test_write_body_to_file(TestCase):

    def test_it(self):
        from van_api import write_body_to_file
        resp = mock.Mock()
        data = ['abc', 'def', '']
        read_called = []
        def read(size=None):
            read_called.append(size)
            return data.pop(0)
        resp.read.side_effect = read
        outfile = mock.Mock()
        write_body_to_file(resp, outfile)
        self.assertEqual(read_called, [8192, 8192, 8192])
        outfile.seek.assert_called_once_with(0)
        outfile.truncate.assert_called_once_with(0)
        outfile.write.assert_has_calls([
                mock.call('abc'),
                mock.call('def')])