Merge pull request #26 from cloudblue/LITE-20615-align-timeouts

LITE-20615: Align timeouts and force autoretry if 5xx error

Author: marcserrat

connect/client/fluent.py

@@ -30,6 +30,7 @@ def __init__(
         default_limit=100,
         max_retries=0,
         logger=None,
+        timeout=(180.0, 180.0),
     ):
         """
         Create a new instance of the ConnectClient.
@@ -63,6 +64,7 @@ def __init__(
         self.response = None
         self.logger = logger
         self._help_formatter = DefaultFormatter(self.specs)
+        self.timeout = timeout
 
     def __getattr__(self, name):
         """
@@ -137,7 +139,8 @@ def _prepare_call_kwargs(self, kwargs):
             kwargs['headers'].update(get_headers(self.api_key))
         else:
             kwargs['headers'] = get_headers(self.api_key)
-
+        if 'timeout' not in kwargs:
+            kwargs['timeout'] = self.timeout
         if self.default_headers:
             kwargs['headers'].update(self.default_headers)
         return kwargs

connect/client/mixins.py

@@ -82,7 +82,7 @@ def _execute_http_call(self, method, url, kwargs):
                 self.logger.log_response(self.response)
 
             if (  # pragma: no branch
-                self.response.status_code == 502
+                self.response.status_code >= 500
                 and retry_count < self.max_retries
             ):
                 retry_count += 1
@@ -159,7 +159,7 @@ async def _execute_http_call(self, method, url, kwargs):
                 self.logger.log_response(self.response)
 
             if (  # pragma: no branch
-                self.response.status_code == 502
+                self.response.status_code >= 500
                 and retry_count < self.max_retries
             ):
                 retry_count += 1

tests/client/test_fluent.py

@@ -244,23 +244,27 @@ def test_execute_retries(mocked_responses):
     assert results == expected
 
 
-def test_execute_max_retries_exceeded(mocked_responses):
+@pytest.mark.parametrize(
+    'code',
+    [500, 501, 502],
+)
+def test_execute_max_retries_exceeded(code, mocked_responses):
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=502,
+        status=code,
     )
 
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=502,
+        status=code,
     )
 
     mocked_responses.add(
         responses.GET,
         'https://localhost/resources',
-        status=502,
+        status=code,
     )
 
     c = ConnectClient(
@@ -323,6 +327,57 @@ def test_execute_with_kwargs(mocked_responses):
     assert 'X-Custom-Header' in headers and headers['X-Custom-Header'] == 'value'
 
 
+def test_execute_with_overwritten_timeout(mocked_responses, mocker):
+    http_call = mocker.patch(
+        'connect.client.mixins.SyncClientMixin._execute_http_call',
+        side_effect=RequestException(),
+    )
+
+    c = ConnectClient('API_KEY', endpoint='https://localhost', use_specs=False)
+    kwargs = {
+        'timeout': 500,
+    }
+
+    with pytest.raises(ClientError):
+        c.execute('post', 'resources', **kwargs)
+
+    http_call.assert_called_with(
+        'post',
+        'https://localhost/resources',
+        {
+            'timeout': 500,
+            'headers': {
+                'Authorization': 'API_KEY',
+                'User-Agent': mocker.ANY,
+            },
+        },
+    )
+
+
+def test_execute_with_default_timeout(mocked_responses, mocker):
+    http_call = mocker.patch(
+        'connect.client.mixins.SyncClientMixin._execute_http_call',
+        side_effect=RequestException(),
+    )
+
+    c = ConnectClient('API_KEY', endpoint='https://localhost', use_specs=False)
+
+    with pytest.raises(ClientError):
+        c.execute('post', 'resources')
+
+    http_call.assert_called_with(
+        'post',
+        'https://localhost/resources',
+        {
+            'timeout': (180.0, 180.0),
+            'headers': {
+                'Authorization': 'API_KEY',
+                'User-Agent': mocker.ANY,
+            },
+        },
+    )
+
+
 def test_execute_connect_error(mocked_responses):
     connect_error = {
         'error_code': 'code',