mock backend with pydantic model example

Author: bisgaard-itis

packages/models-library/src/models_library/api_schemas_webserver/licensed_items.py

@@ -3,7 +3,7 @@
 
 from models_library.licensed_items import LicensedItemID, LicensedResourceType
 from models_library.resource_tracker import PricingPlanId
-from pydantic import PositiveInt
+from pydantic import ConfigDict, PositiveInt
 
 from ._base import OutputSchema
 
@@ -15,6 +15,20 @@ class LicensedItemGet(OutputSchema):
     pricing_plan_id: PricingPlanId
     created_at: datetime
     modified_at: datetime
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                    "name": "best-model",
+                    "licensed_resource_type": f"{LicensedResourceType.VIP_MODEL}",
+                    "pricing_plan_id": "15",
+                    "created_at": "2024-12-12 09:59:26.422140",
+                    "modified_at": "2024-12-12 09:59:26.422140",
+                }
+            ]
+        }
+    )
 
 
 class LicensedItemGetPage(NamedTuple):

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

@@ -1,34 +1,66 @@
 import pytest
 from fastapi import status
 from httpx import AsyncClient, BasicAuth
-from models_library.api_schemas_webserver.licensed_items import LicensedItemGetPage
+from models_library.api_schemas_webserver.licensed_items import (
+    LicensedItemGet as _LicensedItemGet,
+)
+from models_library.api_schemas_webserver.licensed_items import (
+    LicensedItemGetPage as _LicensedItemGetPage,
+)
+from pydantic import TypeAdapter
 from pytest_mock import MockerFixture
 from servicelib.rabbitmq._client_rpc import RabbitMQRPCClient
 from simcore_service_api_server._meta import API_VTAG
+from simcore_service_api_server.models.pagination import Page
+from simcore_service_api_server.models.schemas.model_adapter import LicensedItemGet
 
 
 @pytest.fixture
-async def mock_wb_api_server_rcp(mocker: MockerFixture) -> MockerFixture:
+async def mock_rabbitmq_rpc_client(mocker: MockerFixture) -> MockerFixture:
+    class DummyRabbitMqRpcClient:
+        pass
+
+    def _get_dummy_rpc_client():
+        return DummyRabbitMqRpcClient
+
+    mocker.patch(
+        "simcore_service_api_server.core.application.get_rabbitmq_rpc_client",
+        sideeffect=_get_dummy_rpc_client,
+    )
+    return mocker
+
+
+@pytest.fixture
+async def mock_wb_api_server_rcp(
+    mock_rabbitmq_rpc_client: MockerFixture,
+) -> MockerFixture:
     async def _get_backend_licensed_items(
         rabbitmq_rpc_client: RabbitMQRPCClient,
         *,
         product_name: str,
         offset: int,
         limit: int,
-    ) -> LicensedItemGetPage:
-        return None
+    ) -> _LicensedItemGetPage:
+        extra = _LicensedItemGet.model_config.get("json_schema_extra")
+        assert isinstance(extra, dict)
+        examples = extra.get("examples")
+        assert isinstance(examples, list)
+        return _LicensedItemGetPage(
+            items=[_LicensedItemGet.model_validate(ex) for ex in examples],
+            total=len(examples),
+        )
 
-    mocker.patch(
-        "servicelib.rabbitmq.rpc_interfaces.webserver.licenses.licensed_items.get_licensed_items",
+    mock_rabbitmq_rpc_client.patch(
+        "simcore_service_api_server.services_rpc.wb_api_server._get_licensed_items",
         _get_backend_licensed_items,
     )
 
-    return mocker
+    return mock_rabbitmq_rpc_client
 
 
 async def test_get_licensed_items(
     mock_wb_api_server_rcp: MockerFixture, client: AsyncClient, auth: BasicAuth
 ):
-
-    resp = await client.get(f"{API_VTAG}/credits/price", auth=auth)
+    resp = await client.get(f"{API_VTAG}/licensed-items/page", auth=auth)
     assert resp.status_code == status.HTTP_200_OK
+    TypeAdapter(Page[LicensedItemGet]).validate_json(resp.text)