✨ Refactor dependency injection in SolverService and add mocked_app_dependencies fixture for improved testability and clarity

Author: pcrespov

services/api-server/src/simcore_service_api_server/_service_solvers.py

@@ -1,7 +1,4 @@
-from typing import Annotated
-
 from common_library.pagination_tools import iter_pagination_params
-from fastapi import Depends
 from models_library.basic_types import VersionStr
 from models_library.products import ProductName
 from models_library.projects_nodes import Node
@@ -16,7 +13,6 @@
 from models_library.users import UserID
 from packaging.version import Version
 
-from .api.dependencies.webserver_rpc import get_wb_api_rpc_client
 from .models.api_resources import compose_resource_name
 from .models.schemas.jobs import Job, JobInputs
 from .models.schemas.solvers import Solver, SolverKeyId
@@ -35,8 +31,8 @@ class SolverService:
 
     def __init__(
         self,
-        catalog_service: Annotated[CatalogService, Depends()],
-        webserver_client: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
+        catalog_service: CatalogService,
+        webserver_client: WbApiRpcClient,
     ):
         self._catalog_service = catalog_service
         self._webserver_client = webserver_client

services/api-server/src/simcore_service_api_server/api/routes/solvers.py

@@ -17,7 +17,7 @@
 from ...services_http.catalog import CatalogApi
 from ..dependencies.application import get_reverse_url_mapper
 from ..dependencies.authentication import get_current_user_id, get_product_name
-from ..dependencies.services import get_api_client
+from ..dependencies.services import get_api_client, get_solver_service
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ._common import API_SERVER_DEV_FEATURES_ENABLED
 from ._constants import (
@@ -153,7 +153,7 @@ async def get_solvers_releases_page(
 async def get_solver(
     solver_key: SolverKeyId,
     user_id: Annotated[int, Depends(get_current_user_id)],
-    solver_service: Annotated[SolverService, Depends(SolverService)],
+    solver_service: Annotated[SolverService, Depends(get_solver_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
 ):
@@ -232,10 +232,10 @@ async def get_solver_release(
     solver_key: SolverKeyId,
     version: VersionStr,
     user_id: Annotated[int, Depends(get_current_user_id)],
-    solver_service: Annotated[SolverService, Depends(SolverService)],
+    solver_service: Annotated[SolverService, Depends(get_solver_service)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
-) -> Solver:
+):
     """Gets a specific release of a solver"""
     try:
         solver: Solver = await solver_service.get_solver(

services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs.py

@@ -35,7 +35,7 @@
 from ...services_rpc.wb_api_server import WbApiRpcClient
 from ..dependencies.application import get_reverse_url_mapper
 from ..dependencies.authentication import get_current_user_id, get_product_name
-from ..dependencies.services import get_api_client
+from ..dependencies.services import get_api_client, get_solver_service
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ..dependencies.webserver_rpc import (
     get_wb_api_rpc_client,
@@ -95,7 +95,7 @@ async def create_solver_job(
     version: VersionStr,
     inputs: JobInputs,
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
-    solver_service: Annotated[SolverService, Depends()],
+    solver_service: Annotated[SolverService, Depends(get_solver_service)],
     job_service: Annotated[JobService, Depends()],
     wb_api_rpc: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],

services/api-server/tests/unit/_with_db/test_product.py

@@ -33,10 +33,10 @@ async def test_product_webserver(
     assert client
 
     wallet_to_api_keys_map: dict[int, ApiKeyInDB] = {}
-    wallet_id: int = faker.pyint(min_value=1)
+    wid: int = faker.pyint(min_value=1)
     async for api_key in create_fake_api_keys(2):
-        wallet_id += faker.pyint(min_value=1)
-        wallet_to_api_keys_map[wallet_id] = api_key
+        wid += faker.pyint(min_value=1)
+        wallet_to_api_keys_map[wid] = api_key
 
     def _check_key_product_compatibility(request: httpx.Request, **kwargs):
         assert (

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

@@ -458,7 +458,38 @@ def mocked_catalog_rest_api_base(
 
 
 @pytest.fixture
-def mocked_catalog_rpc_api(mocker: MockerFixture) -> dict[str, MockType]:
+def mocked_app_dependencies(app: FastAPI, mocker: MockerFixture) -> Iterator[None]:
+    """
+    Mocks some dependency overrides for the FastAPI app.
+    """
+    from simcore_service_api_server.api.dependencies.rabbitmq import (
+        get_rabbitmq_rpc_client,
+    )
+    from simcore_service_api_server.api.dependencies.webserver_rpc import (
+        get_wb_api_rpc_client,
+    )
+
+    def _get_rabbitmq_rpc_client_override(app: FastAPI):
+        return mocker.MagicMock()
+
+    async def _get_wb_api_rpc_client_override(app: FastAPI):
+        return mocker.MagicMock()
+
+    app.dependency_overrides[get_rabbitmq_rpc_client] = (
+        _get_rabbitmq_rpc_client_override
+    )
+    app.dependency_overrides[get_wb_api_rpc_client] = _get_wb_api_rpc_client_override
+
+    yield
+
+    app.dependency_overrides.pop(get_wb_api_rpc_client, None)
+    app.dependency_overrides.pop(get_rabbitmq_rpc_client, None)
+
+
+@pytest.fixture
+def mocked_catalog_rpc_api(
+    mocked_app_dependencies: None, mocker: MockerFixture
+) -> dict[str, MockType]:
     """
     Mocks the catalog's simcore service RPC API for testing purposes.
     """