allow passing custom HTTP adapter to BaseClient (#115)

Author: lime-green

.github/workflows/python-test.yml

@@ -1,6 +1,13 @@
 name: Python Tests
 
-on: [push]
+on:
+  # This should run the workflow for all non-forked pushes
+  push:
+  pull_request:
+    branches:
+    # This should run the workflow for forked PRs
+    - '**:**'
+
 
 jobs:
 

src/commercetools/base_client.py

@@ -8,7 +8,7 @@
 from oauthlib.oauth2 import BackendApplicationClient
 from requests.adapters import HTTPAdapter
 from requests_oauthlib import OAuth2Session
-from urllib3.util.retry import Retry
+from urllib3 import Retry
 
 from commercetools.constants import HEADER_CORRELATION_ID
 from commercetools.exceptions import CommercetoolsError
@@ -37,6 +37,8 @@ class BaseClient:
      path to the token url.
     :param token_saver: optional custom token saver to store and retrieve the
      oauth2 tokens.
+    :param http_adapter: optional custom http adapter, useful for settings
+     custom timeouts, custom retries, or for testing.
 
     """
 
@@ -49,6 +51,7 @@ def __init__(
         url: str = None,
         token_url: str = None,
         token_saver: BaseTokenSaver = None,
+        http_adapter: HTTPAdapter = None,
     ) -> None:
 
         # Use environment variables as fallback
@@ -88,11 +91,12 @@ def __init__(
             token_updater=self._save_token,
         )
 
-        # Register retry handling for Connection errors and 502, 503, 504.
-        retry = Retry(status=3, connect=3, status_forcelist=[502, 503, 504])
-        adapter = HTTPAdapter(max_retries=retry)
-        self._http_client.mount("http://", adapter)
-        self._http_client.mount("https://", adapter)
+        if not http_adapter:
+            # Register retry handling for Connection errors and 502, 503, 504.
+            retry = Retry(status=3, connect=3, status_forcelist=[502, 503, 504])
+            http_adapter = HTTPAdapter(max_retries=retry)
+        self._http_client.mount("http://", http_adapter)
+        self._http_client.mount("https://", http_adapter)
 
         if token:
             self._http_client.token = token

tests/platform/test_client.py

@@ -2,6 +2,7 @@
 import uuid
 
 import pytest
+from requests_mock.adapter import Adapter
 
 from commercetools import CommercetoolsError
 from commercetools.client import Client
@@ -69,6 +70,24 @@ def test_cache_token(commercetools_api):
     assert len(commercetools_api.requests_mock.request_history) == 1
 
 
+def test_allows_passing_custom_http_adapter():
+    my_adapter = Adapter()
+    my_adapter.register_uri(
+        "POST",
+        "https://auth.sphere.io/oauth/token",
+        json=dict(access_token="my_mock_access_token"),
+    )
+    Client(
+        client_id="unittest",
+        client_secret="none",
+        project_key="test",
+        url="https://api.sphere.io",
+        token_url="https://auth.sphere.io/oauth/token",
+        http_adapter=my_adapter,
+    )
+    assert len(my_adapter.request_history) == 1
+
+
 def test_resource_update_conflict(old_client):
     """Test the return value of the update methods.
 
@@ -124,9 +143,9 @@ def test_resource_update_conflict(old_client):
 
 
 def test_resource_delete_conflict(old_client):
-    """Test the return value of the update methods.
+    """Test the return value of the delete methods.
 
-    It doesn't test the actual update itself.
+    It doesn't test the actual delete itself.
     TODO: See if this is worth testing since we're using a mocking backend
     """
     product = old_client.products.create(