feat: add HandlerMockFactory for improved mock handling in tests

Author: pcrespov

packages/pytest-simcore/src/pytest_simcore/helpers/typing_mock.py

@@ -0,0 +1,14 @@
+from collections.abc import Callable
+from typing import Any, Protocol
+
+from pytest_mock import MockType
+
+
+class HandlerMockFactory(Protocol):
+    def __call__(
+        self,
+        handler_name: str,
+        return_value: Any = None,
+        exception: Exception | None = None,
+        side_effect: Callable | None = None,
+    ) -> MockType: ...

services/api-server/tests/unit/api_functions/conftest.py

@@ -37,6 +37,7 @@
 from pytest_mock import MockerFixture, MockType
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from pytest_simcore.helpers.typing_env import EnvVarsDict
+from pytest_simcore.helpers.typing_mock import HandlerMockFactory
 from servicelib.rabbitmq._client_rpc import RabbitMQRPCClient
 from simcore_service_api_server.api.dependencies import services
 from simcore_service_api_server.api.dependencies.services import get_rabbitmq_rpc_client
@@ -273,7 +274,7 @@ def fake_registered_function_job_collection(
 def mock_handler_in_functions_rpc_interface(
     mock_get_wb_api_rpc_client: None,
     mocker: MockerFixture,
-) -> Callable[[str, Any, Exception | None, Callable | None], MockType]:
+) -> HandlerMockFactory:
     def _create(
         handler_name: str = "",
         return_value: Any = None,

services/api-server/tests/unit/api_functions/test_api_routers_function_jobs.py

@@ -241,7 +241,6 @@ def mocked_list_function_jobs(offset: int, limit: int):
             auth=auth,
         )
         mock_list_function_jobs.assert_called_with(
-            ANY,  # Dummy rpc client
             filter_by_function_job_ids=[fake_registered_project_function_job.uid],
             filter_by_function_job_collection_id=None,
             filter_by_function_id=None,

services/api-server/tests/unit/api_solvers/test_api_routers_solvers_jobs_delete.py

@@ -287,4 +287,8 @@ async def test_delete_job_assets_endpoint(
     assert storage_rest["delete_project_s3_assets"].called
 
     webserver_rpc = mocked_backend_services_apis_for_delete_job_assets["webserver_rpc"]
-    assert webserver_rpc["mark_project_as_job"].called
+    assert webserver_rpc["mocked_rabbit_rpc_client"].request.called
+    assert webserver_rpc["mocked_rabbit_rpc_client"].request.call_args.args == (
+        "wb-api-server",
+        "mark_project_as_job",
+    )

services/api-server/tests/unit/test_licensed_items.py

@@ -6,7 +6,7 @@
 
 import asyncio
 from collections.abc import Callable
-from typing import Any, Protocol, cast
+from typing import Any, cast
 from uuid import UUID
 
 import pytest
@@ -32,6 +32,7 @@
 from models_library.wallets import WalletID
 from pydantic import TypeAdapter
 from pytest_mock import MockerFixture, MockType
+from pytest_simcore.helpers.typing_mock import HandlerMockFactory
 from servicelib.rabbitmq._client_rpc import RabbitMQRPCClient
 from servicelib.rabbitmq._errors import RemoteMethodNotRegisteredError
 from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
@@ -79,16 +80,6 @@ async def mock_rut_rpc(app: FastAPI, mocker: MockerFixture) -> None:
     )
 
 
-class HandlerMockFactory(Protocol):
-    def __call__(
-        self,
-        handler_name: str = "",
-        return_value: Any = None,
-        exception: Exception | None = None,
-        side_effect: Callable | None = None,
-    ) -> MockType: ...
-
-
 @pytest.fixture()
 def mock_handler_in_licenses_rpc_interface(
     mock_wb_api_server_rcp: None,