Merge pull request #59 from cloudblue/add_mockers_passthrough

allow mockers passthrough

Author: ffaraone

connect/client/testing/fixtures.py

@@ -11,8 +11,8 @@ def client_mocker_factory(request):
     """
     mocker = None
 
-    def _wrapper(base_url='https://example.org/public/v1'):
-        mocker = ConnectClientMocker(base_url)
+    def _wrapper(base_url='https://example.org/public/v1', exclude=None):
+        mocker = ConnectClientMocker(base_url, exclude=exclude)
         mocker.start()
         return mocker
 
@@ -32,8 +32,8 @@ def async_client_mocker_factory(request):
     """
     mocker = None
 
-    def _wrapper(base_url='https://example.org/public/v1'):
-        mocker = AsyncConnectClientMocker(base_url)
+    def _wrapper(base_url='https://example.org/public/v1', exclude=None):
+        mocker = AsyncConnectClientMocker(base_url, exclude=exclude)
         mocker.start()
         return mocker
 

connect/client/testing/fluent.py

@@ -4,6 +4,7 @@
 # Copyright (c) 2021 Ingram Micro. All Rights Reserved.
 #
 import json
+import re
 
 import httpx
 import responses
@@ -36,8 +37,13 @@ def match(request):
 
 
 class ConnectClientMocker(_ConnectClientBase):
-    def __init__(self, base_url):
+    def __init__(self, base_url, exclude=None):
         super().__init__('api_key', endpoint=base_url)
+        if exclude:
+            if not isinstance(exclude, (list, tuple, set)):
+                exclude = [exclude]
+            for item in exclude:
+                _mocker.add_passthru(item)
 
     def get(
         self,
@@ -169,14 +175,27 @@ def _get_namespace_class(self):
 
 
 class AsyncConnectClientMocker(ConnectClientMocker):
-    def __init__(self, base_url):
+    def __init__(self, base_url, exclude=None):
         super().__init__(base_url)
+        self.exclude = exclude or []
 
     def start(self):
+        patterns = self.exclude if isinstance(self.exclude, (list, tuple, set)) else [self.exclude]
+        real_async_transport = httpx.AsyncClient._transport_for_url
+
+        def transport_for_url(self, url):
+            for pattern in patterns:
+                if (
+                    (isinstance(pattern, re.Pattern) and pattern.match(str(url)))
+                    or (isinstance(pattern, str) and str(url).startswith(pattern))
+                ):
+                    return real_async_transport(self, url)
+            return _PytestAsyncTransport(_async_mocker)
+
         _monkeypatch.setattr(
             httpx.AsyncClient,
             '_transport_for_url',
-            lambda self, url: _PytestAsyncTransport(_async_mocker),
+            transport_for_url,
         )
 
     def reset(self, success=True):

docs/testing.md

@@ -48,6 +48,11 @@ async def test_get_all_products():
         assert [item async for item in client.products.all()] == expected_response
 ```
 
+Both the `ConnectClientMocker` and the `AsyncConnectClientMocker` constructors
+accept an extra keywork argument `exclude` to exclude urls from mocking.
+the exclude argument can be a string, a `re.Pattern` object or a list, tuple or set which elements
+can be strings or `re.Pattern`.
+
 Both mockers are also available as pytest fixtures:
 
 ``` {.python}
@@ -62,5 +67,8 @@ def test_get_all_products(client_mocker_factory):
     assert list(client.products.all()) == expected_response
 ```
 
+Also the fixtures accept an extra keyword argument `exclude` that is passed
+to the underlying mocker constructor.
+
 For more example on how to use the client mocker see the
 `tests/client/test_testing.py` file in the github repository.

tests/async_client/test_testing.py

@@ -1,3 +1,6 @@
+import re
+
+import httpx
 import pytest
 
 from connect.client import AsyncConnectClient, ClientError
@@ -377,3 +380,23 @@ async def inner_mocking():
         mocker.products.all().mock(return_value=[{'id': 'OBJ-0'}])
 
         await inner_mocking()
+
+
+@pytest.mark.parametrize(
+    'exclude',
+    (
+        'https://www.google.com',
+        ['https://www.google.com', 'https://youtube.com'],
+        re.compile(r'https://www.google.com(/\w*)?'),
+        [re.compile(r'https://www.google.com(/\w*)?'), 'https://youtube.com'],
+    ),
+)
+@pytest.mark.asyncio
+async def test_exclude(mocker, exclude):
+    with AsyncConnectClientMocker('http://localhost', exclude=exclude) as mocker:
+        mocker.products.create(return_value={'test': 'data'})
+        client = AsyncConnectClient('api_key', endpoint='http://localhost')
+        assert await client.products.create(payload={}) == {'test': 'data'}
+        async with httpx.AsyncClient() as client:
+            r = await client.get('https://www.google.com')
+            assert r.status_code == 200

tests/client/test_testing.py

@@ -1,3 +1,5 @@
+import re
+
 import pytest
 
 from connect.client import ClientError, ConnectClient
@@ -370,3 +372,22 @@ def inner_mocking():
         mocker.products.all().mock(return_value=[{'id': 'OBJ-0'}])
 
         inner_mocking()
+
+
+@pytest.mark.parametrize(
+    'exclude',
+    (
+        'https://www.google.com',
+        ['https://www.google.com', 'https://youtube.com'],
+        re.compile(r'https://www.google.com/\w*'),
+        [re.compile(r'https://www.google.com/\w*'), 'https://youtube.com'],
+    ),
+)
+def test_exclude(mocker, exclude):
+    mocked_add_passthru = mocker.patch('connect.client.testing.fluent._mocker.add_passthru')
+    mocker = ConnectClientMocker('http://localhost', exclude=exclude)
+
+    excluded = exclude if isinstance(exclude, list) else [exclude]
+
+    for idx, item in enumerate(excluded):
+        assert mocked_add_passthru.mock_calls[idx][1][0] == item