upgrading requests and urllib3 libraries to better support retries

Author: allmightyspiff

SoftLayer/fixtures/SoftLayer_Account.py

@@ -266,7 +266,8 @@
             "statusId": 4,
             "accountId": 1234
         }
-    ]
+    ],
+    'accountId': 1234
 }
 
 getRwhoisData = {

SoftLayer/transports.py

@@ -12,7 +12,7 @@
 
 import requests
 from requests.adapters import HTTPAdapter
-from requests.packages.urllib3.util.retry import Retry
+from urllib3.util.retry import Retry
 
 from SoftLayer import consts
 from SoftLayer import exceptions
@@ -41,6 +41,8 @@
 
 
 def get_session(user_agent):
+    """Sets up urllib sessions"""
+
     client = requests.Session()
     client.headers.update({
         'Content-Type': 'application/json',
@@ -121,10 +123,13 @@ def __init__(self, endpoint_url=None, timeout=None, proxy=None, user_agent=None,
         self.proxy = proxy
         self.user_agent = user_agent or consts.USER_AGENT
         self.verify = verify
+        self._client = None
 
     @property
     def client(self):
-        if not hasattr(self, '_client'):
+        """Returns client session object"""
+
+        if self._client is None:
             self._client = get_session(self.user_agent)
         return self._client
 
@@ -228,10 +233,13 @@ def __init__(self, endpoint_url=None, timeout=None, proxy=None, user_agent=None,
         self.proxy = proxy
         self.user_agent = user_agent or consts.USER_AGENT
         self.verify = verify
+        self._client = None
 
     @property
     def client(self):
-        if not hasattr(self, '_client'):
+        """Returns client session object"""
+
+        if self._client is None:
             self._client = get_session(self.user_agent)
         return self._client
 
@@ -362,13 +370,11 @@ def __call__(self, call):
             module_path = 'SoftLayer.fixtures.%s' % call.service
             module = importlib.import_module(module_path)
         except ImportError:
-            raise NotImplementedError('%s fixture is not implemented'
-                                      % call.service)
+            raise NotImplementedError('%s fixture is not implemented' % call.service)
         try:
             return getattr(module, call.method)
         except AttributeError:
-            raise NotImplementedError('%s::%s fixture is not implemented'
-                                      % (call.service, call.method))
+            raise NotImplementedError('%s::%s fixture is not implemented' % (call.service, call.method))
 
 
 def _proxies_dict(proxy):

setup.py

@@ -33,9 +33,10 @@
         'six >= 1.7.0',
         'prettytable >= 0.7.0',
         'click >= 5',
-        'requests >= 2.7.0',
+        'requests >= 2.18.4',
         'prompt_toolkit >= 0.53',
         'pygments >= 2.0.0',
+        'urllib3 >= 1.22'
     ],
     keywords=['softlayer', 'cloud'],
     classifiers=[

tests/decoration_tests.py

@@ -7,7 +7,6 @@
 
 import logging
 import mock
-import unittest
 
 from SoftLayer.decoration import retry
 from SoftLayer import exceptions
@@ -89,7 +88,3 @@ def raise_unexpected_error():
             raise TypeError('unexpected error')
 
         self.assertRaises(TypeError, raise_unexpected_error)
-
-if __name__ == '__main__':
-
-    unittest.main()

tests/transport_tests.py

@@ -523,3 +523,81 @@ def test_unknown_error(self, request):
         req.method = 'getObject'
 
         self.assertRaises(SoftLayer.TransportError, self.transport, req)
+
+    @mock.patch('SoftLayer.transports.requests.Session.request')
+    def test_with_limits(self, request):
+        request().text = '{}'
+
+        req = transports.Request()
+        req.service = 'SoftLayer_Service'
+        req.method = 'getObject'
+        req.limit = 10
+        req.offset = 10
+
+        resp = self.transport(req)
+
+        self.assertEqual(resp, {})
+        request.assert_called_with(
+            'GET',
+            'http://something.com/SoftLayer_Service/getObject.json',
+            headers=mock.ANY,
+            auth=None,
+            data=None,
+            params={'limit': 10, 'offset': 10},
+            verify=True,
+            cert=None,
+            proxies=None,
+            timeout=None)
+
+    @mock.patch('SoftLayer.transports.requests.Session.request')
+    def test_with_username(self, request):
+        request().text = '{}'
+
+        req = transports.Request()
+        req.service = 'SoftLayer_Service'
+        req.method = 'getObject'
+        req.transport_user = 'Bob'
+        req.transport_password = '123456'
+        auth = requests.auth.HTTPBasicAuth(req.transport_user, req.transport_password)
+
+        resp = self.transport(req)
+
+        self.assertEqual(resp, {})
+        request.assert_called_with(
+            'GET',
+            'http://something.com/SoftLayer_Service/getObject.json',
+            headers=mock.ANY,
+            auth=auth,
+            data=None,
+            params={},
+            verify=True,
+            cert=None,
+            proxies=None,
+            timeout=None)
+
+
+class TestFixtureTransport(testing.TestCase):
+
+    def set_up(self):
+        transport = testing.MockableTransport(SoftLayer.FixtureTransport())
+        self.env.client = SoftLayer.BaseClient(transport=transport)
+
+    def test_base_case(self):
+        result = self.env.client.call('SoftLayer_Account', 'getObject')
+        self.assertEqual(result['accountId'], 1234)
+
+    def test_Import_Service_Error(self):
+        # assertRaises doesn't work here for some reason
+        try:
+            self.env.client.call('FAKE', 'getObject')
+            self.assertTrue(False)
+        except NotImplementedError:
+            self.assertTrue(True)
+
+    def test_Import_Method_Error(self):
+        # assertRaises doesn't work here for some reason
+        try:
+            self.env.client.call('SoftLayer_Account', 'getObject111')
+            self.assertTrue(False)
+        except NotImplementedError:
+            self.assertTrue(True)

tools/requirements.txt

@@ -3,3 +3,4 @@ click >= 5
 prettytable >= 0.7.0
 six >= 1.7.0
 prompt_toolkit
+urllib3

tools/test-requirements.txt

@@ -4,3 +4,4 @@ pytest-cov
 mock
 sphinx
 testtools
+urllib3