Merge pull request #60 from cloudblue/add_fixtures_for_mocking_other_calls

Add fixures for mocking http calls done with requests/httpx

Author: ffaraone

connect/client/testing/__init__.py

@@ -3,4 +3,9 @@
 #
 # Copyright (c) 2021 Ingram Micro. All Rights Reserved.
 #
-from connect.client.testing.fluent import AsyncConnectClientMocker, ConnectClientMocker  # noqa
+from connect.client.testing.fluent import (  # noqa
+    AsyncConnectClientMocker,
+    ConnectClientMocker,
+    get_httpx_mocker,
+    get_requests_mocker,
+)

connect/client/testing/fixtures.py

@@ -1,6 +1,11 @@
 import pytest
 
-from connect.client.testing import AsyncConnectClientMocker, ConnectClientMocker
+from connect.client.testing import (
+    AsyncConnectClientMocker,
+    ConnectClientMocker,
+    get_httpx_mocker,
+    get_requests_mocker,
+)
 
 
 @pytest.fixture
@@ -43,3 +48,25 @@ def _finalizer():
 
     request.addfinalizer(_finalizer)
     return _wrapper
+
+
+@pytest.fixture
+def requests_mocker():
+    """
+    This fixture allows you to mock http calls made using the `requests` library
+    when they are made in conjunction with calls made with the `ConnectClient`.
+    The returned mocker is the one provided by the
+    [responses](https://github.com/getsentry/responses) library.
+    """
+    return get_requests_mocker()
+
+
+@pytest.fixture
+def httpx_mocker():
+    """
+    This fixture allows you to mock http calls made using the `httpx` library
+    when they are made in conjunction with calls made with the `AsyncConnectClient`.
+    The returned mocker is the one provided by the
+    [pytest-httpx](https://colin-b.github.io/pytest_httpx/) library.
+    """
+    return get_httpx_mocker()

connect/client/testing/fluent.py

@@ -232,3 +232,23 @@ def mock(
                 kwargs['match_content'] = match_body
 
         _async_mocker.add_response(**kwargs)
+
+
+def get_requests_mocker():
+    """
+    Returns a mocker object to mock http calls made using the `requests` library
+    when they are made in conjunction with calls made with the `ConnectClient`.
+    The returned mocker is the one provided by the
+    [responses](https://github.com/getsentry/responses) library.
+    """
+    return _mocker
+
+
+def get_httpx_mocker():
+    """
+    Returns a mocker object to mock http calls made using the `httpx` library
+    when they are made in conjunction with calls made with the `AsyncConnectClient`.
+    The returned mocker is the one provided by the
+    [pytest-httpx](https://colin-b.github.io/pytest_httpx/) library.
+    """
+    return _async_mocker

tests/async_client/test_fixtures.py

@@ -1,3 +1,4 @@
+import httpx
 import pytest
 
 from connect.client import AsyncConnectClient
@@ -10,3 +11,21 @@ async def test_client_mocker_factory(async_client_mocker_factory):
 
     client = AsyncConnectClient('api_key', endpoint='http://example.com')
     assert await client.products.create(payload={}) == {'id': 'PRD-000'}
+
+
+@pytest.mark.asyncio
+async def test_httpx_mocker(async_client_mocker_factory, httpx_mocker):
+    mocker = async_client_mocker_factory('http://example.com')
+    mocker.products.create(return_value={'id': 'PRD-000'})
+    httpx_mocker.add_response(
+        method='GET',
+        url='https://test.com',
+        json=[{"key1": "value1", "key2": "value2"}],
+    )
+
+    client = AsyncConnectClient('api_key', endpoint='http://example.com')
+    assert await client.products.create(payload={}) == {'id': 'PRD-000'}
+
+    async with httpx.AsyncClient() as client:
+        response = await client.get('https://test.com')
+        assert response.json() == [{"key1": "value1", "key2": "value2"}]

tests/async_client/test_testing.py

@@ -5,7 +5,7 @@
 
 from connect.client import AsyncConnectClient, ClientError
 from connect.client.rql import R
-from connect.client.testing.fluent import AsyncConnectClientMocker
+from connect.client.testing.fluent import AsyncConnectClientMocker, _async_mocker, get_httpx_mocker
 
 
 @pytest.mark.asyncio
@@ -400,3 +400,7 @@ async def test_exclude(mocker, exclude):
         async with httpx.AsyncClient() as client:
             r = await client.get('https://www.google.com')
             assert r.status_code == 200
+
+
+def test_get_httpx_mocker():
+    assert get_httpx_mocker() == _async_mocker

tests/client/test_fixtures.py

@@ -1,3 +1,5 @@
+import requests
+
 from connect.client import ConnectClient
 
 
@@ -15,3 +17,13 @@ def test_client_mocker_factory_default_base_url(client_mocker_factory):
 
     client = ConnectClient('api_key', endpoint='https://example.org/public/v1')
     assert client.products.create(payload={}) == {'id': 'PRD-000'}
+
+
+def test_requests_mocker(client_mocker_factory, requests_mocker):
+    mocker = client_mocker_factory('http://example.com')
+    mocker.products.create(return_value={'id': 'PRD-000'})
+    requests_mocker.get('https://test.com', json={'a': 'b'})
+
+    client = ConnectClient('api_key', endpoint='http://example.com')
+    assert client.products.create(payload={}) == {'id': 'PRD-000'}
+    assert requests.get('https://test.com').json() == {'a': 'b'}

tests/client/test_testing.py

@@ -4,7 +4,7 @@
 
 from connect.client import ClientError, ConnectClient
 from connect.client.rql import R
-from connect.client.testing.fluent import ConnectClientMocker
+from connect.client.testing.fluent import ConnectClientMocker, _mocker, get_requests_mocker
 
 
 def test_create():
@@ -391,3 +391,7 @@ def test_exclude(mocker, exclude):
 
     for idx, item in enumerate(excluded):
         assert mocked_add_passthru.mock_calls[idx][1][0] == item
+
+
+def test_get_requests_mocker():
+    assert get_requests_mocker() == _mocker

tests/conftest.py

@@ -7,6 +7,8 @@
 from connect.client.testing.fixtures import (  # noqa
     async_client_mocker_factory,
     client_mocker_factory,
+    httpx_mocker,
+    requests_mocker,
 )
 from tests.fixtures.client_models import (  # noqa
     action_factory,