@sanderegg review: creates aioresponse_mocker and used to mock catalog service responses

Author: pcrespov

packages/pytest-simcore/src/pytest_simcore/services_api_mocks_for_aiohttp_clients.py

@@ -1,13 +1,23 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+
 import re
 from pathlib import Path
-from typing import Dict, List
+from typing import Any, Dict, List
 
 import pytest
-from aioresponses import aioresponses
+from aioresponses import aioresponses as AioResponsesMock
 from aioresponses.core import CallbackResult
 from models_library.projects_state import RunningState
 from yarl import URL
 
+# WARNING: any request done through the client will go through aioresponses. It is
+# unfortunate but that means any valid request (like calling the test server) prefix must be set as passthrough.
+# Other than that it seems to behave nicely
+PASSTHROUGH_REQUESTS_PREFIXES = ["http://127.0.0.1", "ws://"]
+
+
 # The adjacency list is defined as a dictionary with the key to the node and its list of successors
 FULL_PROJECT_PIPELINE_ADJACENCY: Dict[str, List[str]] = {
     "62bca361-8594-48c8-875e-b8577e868aec": [
@@ -21,7 +31,7 @@
     "e83a359a-1efe-41d3-83aa-a285afbfaf12": [],
 }
 
-FULL_PROJECT_NODE_STATES: Dict[str, Dict[str, str]] = {
+FULL_PROJECT_NODE_STATES: Dict[str, Dict[str, Any]] = {
     "62bca361-8594-48c8-875e-b8577e868aec": {"modified": True, "dependencies": []},
     "e0d7a1a5-0700-42c7-b033-97f72ac4a5cd": {
         "modified": True,
@@ -46,6 +56,25 @@
 }
 
 
+@pytest.fixture
+def aioresponses_mocker() -> AioResponsesMock:
+    """Generick aioresponses mock
+
+    SEE https://github.com/pnuckowski/aioresponses
+
+    Usage
+
+        async def test_this(aioresponses_mocker):
+            aioresponses_mocker.get("https://foo.io")
+
+            async with aiohttp.ClientSession() as session:
+                async with session.get("https://foo.aio") as response:
+                    assert response.status == 200
+    """
+    with AioResponsesMock(passthrough=PASSTHROUGH_REQUESTS_PREFIXES) as mock:
+        yield mock
+
+
 def creation_cb(url, **kwargs) -> CallbackResult:
 
     assert "json" in kwargs, f"missing body in call to {url}"
@@ -113,14 +142,10 @@ def get_computation_cb(url, **kwargs) -> CallbackResult:
 
 
 @pytest.fixture
-async def director_v2_service_mock() -> aioresponses:
-
-    """uses aioresponses to mock all calls of an aiohttpclient
-    WARNING: any request done through the client will go through aioresponses. It is
-    unfortunate but that means any valid request (like calling the test server) prefix must be set as passthrough.
-    Other than that it seems to behave nicely
-    """
-    PASSTHROUGH_REQUESTS_PREFIXES = ["http://127.0.0.1", "ws://"]
+async def director_v2_service_mock(
+    aioresponses_mocker: AioResponsesMock,
+) -> AioResponsesMock:
+    """mocks responses of director-v2"""
     create_computation_pattern = re.compile(
         r"^http://[a-z\-_]*director-v2:[0-9]+/v2/computations$"
     )
@@ -132,37 +157,33 @@ async def director_v2_service_mock() -> aioresponses:
         r"^http://[a-z\-_]*director-v2:[0-9]+/v2/computations/.*:stop$"
     )
     delete_computation_pattern = get_computation_pattern
-    with aioresponses(passthrough=PASSTHROUGH_REQUESTS_PREFIXES) as mock:
-        mock.post(
-            create_computation_pattern,
-            callback=creation_cb,
-            repeat=True,
-        )
-        mock.post(
-            stop_computation_pattern,
-            status=204,
-            repeat=True,
-        )
-        mock.get(
-            get_computation_pattern,
-            status=202,
-            callback=get_computation_cb,
-            repeat=True,
-        )
-        mock.delete(delete_computation_pattern, status=204, repeat=True)
 
-        yield mock
+    aioresponses_mocker.post(
+        create_computation_pattern,
+        callback=creation_cb,
+        repeat=True,
+    )
+    aioresponses_mocker.post(
+        stop_computation_pattern,
+        status=204,
+        repeat=True,
+    )
+    aioresponses_mocker.get(
+        get_computation_pattern,
+        status=202,
+        callback=get_computation_cb,
+        repeat=True,
+    )
+    aioresponses_mocker.delete(delete_computation_pattern, status=204, repeat=True)
 
+    return aioresponses_mocker
 
-@pytest.fixture
-async def storage_v0_service_mock() -> aioresponses:
 
-    """uses aioresponses to mock all calls of an aiohttpclient
-    WARNING: any request done through the client will go through aioresponses. It is
-    unfortunate but that means any valid request (like calling the test server) prefix must be set as passthrough.
-    Other than that it seems to behave nicely
-    """
-    PASSTHROUGH_REQUESTS_PREFIXES = ["http://127.0.0.1", "ws://"]
+@pytest.fixture
+async def storage_v0_service_mock(
+    aioresponses_mocker: AioResponsesMock,
+) -> AioResponsesMock:
+    """mocks responses of storage API"""
 
     def get_download_link_cb(url: URL, **kwargs) -> CallbackResult:
         file_id = url.path.rsplit("/files/")[1]
@@ -179,11 +200,12 @@ def get_download_link_cb(url: URL, **kwargs) -> CallbackResult:
         r"^http://[a-z\-_]*storage:[0-9]+/v0/locations.*$"
     )
 
-    with aioresponses(passthrough=PASSTHROUGH_REQUESTS_PREFIXES) as mock:
-        mock.get(get_download_link_pattern, callback=get_download_link_cb, repeat=True)
-        mock.get(
-            get_locations_link_pattern,
-            status=200,
-            payload={"data": [{"name": "simcore.s3", "id": "0"}]},
-        )
-        yield mock
+    aioresponses_mocker.get(
+        get_download_link_pattern, callback=get_download_link_cb, repeat=True
+    )
+    aioresponses_mocker.get(
+        get_locations_link_pattern,
+        status=200,
+        payload={"data": [{"name": "simcore.s3", "id": "0"}]},
+    )
+    return aioresponses_mocker

services/web/server/tests/unit/with_dbs/04/test_catalog_api.py

@@ -2,12 +2,12 @@
 # pylint:disable=unused-argument
 # pylint:disable=redefined-outer-name
 
+import re
 from copy import deepcopy
 
 import pytest
 from aiohttp import web
 from pytest_simcore.helpers.utils_assert import assert_status
-from pytest_simcore.helpers.utils_login import LoggedUser
 from simcore_service_webserver.application import (
     create_safe_application,
     setup_catalog,
@@ -18,6 +18,7 @@
     setup_security,
     setup_session,
 )
+from simcore_service_webserver.catalog_client import KCATALOG_ORIGIN
 from simcore_service_webserver.db_models import UserRole
 
 
@@ -49,36 +50,18 @@ def client(loop, app_cfg, aiohttp_client, postgres_db):
 
 
 @pytest.fixture
-def patch_app_client_session(client, mocker):
-    async def create_200_empty_response(*args, **kwargs):
-        # Mocks aiohttp.ClientResponse
-        # https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientResponse
-        resp = mocker.MagicMock(name="SuccessfulEmptyResponse")
+def mock_catalog_service_api_responses(client, aioresponses_mocker):
+    origin = client.app[KCATALOG_ORIGIN]
 
-        resp.json = mocker.AsyncMock(return_value={})
+    url_pattern = re.compile(f"^{origin}+/.*$")
 
-        p = mocker.PropertyMock(return_value=200)
-        type(resp).status = p
-        return resp
-
-    context_mock = mocker.Mock(name="Session Context Manager")
-    context_mock.__aenter__ = mocker.AsyncMock(
-        name="QueryResponse", side_effect=create_200_empty_response
-    )
-    context_mock.__aexit__ = mocker.AsyncMock(name="Exit", return_value=False)
-
-    client_session = mocker.Mock()
-    client_session.get.return_value = context_mock
-    client_session.post.return_value = context_mock
-    client_session.request.return_value = context_mock
-
-    mocker.patch(
-        "simcore_service_webserver.catalog_client.get_client_session",
-        return_value=client_session,
-    )
+    aioresponses_mocker.get(url_pattern, payload={"data": {}})
+    aioresponses_mocker.post(url_pattern, payload={"data": {}})
+    aioresponses_mocker.put(url_pattern, payload={"data": {}})
+    aioresponses_mocker.patch(url_pattern, payload={"data": {}})
+    aioresponses_mocker.delete(url_pattern)
 
 
-# TODO: with different user roles, i.e. access rights
 @pytest.mark.parametrize(
     "user_role,expected",
     [
@@ -89,7 +72,11 @@ async def create_200_empty_response(*args, **kwargs):
     ],
 )
 async def test_dag_entrypoints(
-    client, logged_user, api_version_prefix, patch_app_client_session, expected
+    client,
+    logged_user,
+    api_version_prefix,
+    mock_catalog_service_api_responses,
+    expected,
 ):
     vx = api_version_prefix