add test for checking out licensed item

Author: bisgaard-itis

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

@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import NamedTuple
 
-from pydantic import BaseModel, PositiveInt
+from pydantic import BaseModel, ConfigDict, PositiveInt
 
 from ..licensed_items import LicensedItemID
 from ..products import ProductName
@@ -22,6 +22,22 @@ class LicensedItemCheckoutRpcGet(BaseModel):
     started_at: datetime
     stopped_at: datetime | None
     num_of_seats: int
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "licensed_item_checkout_id": "633ef980-6f3e-4b1a-989a-bd77bf9a5d6b",
+                    "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                    "wallet_id": 6,
+                    "user_id": 27845,
+                    "product_name": "osparc",
+                    "started_at": "2024-12-12 09:59:26.422140",
+                    "stopped_at": "2024-12-12 09:59:26.423540",
+                    "num_of_seats": 78,
+                }
+            ]
+        }
+    )
 
 
 class LicensedItemCheckoutRpcGetPage(NamedTuple):

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

@@ -15,6 +15,11 @@
 from models_library.api_schemas_webserver.licensed_items import (
     LicensedItemGetPage as _LicensedItemGetPage,
 )
+from models_library.api_schemas_webserver.licensed_items_checkouts import (
+    LicensedItemCheckoutRpcGet,
+)
+from models_library.licensed_items import LicensedItemID
+from models_library.services_types import ServiceRunID
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from pydantic import TypeAdapter
@@ -26,6 +31,9 @@
     get_wb_api_rpc_client,
 )
 from simcore_service_api_server.models.pagination import Page
+from simcore_service_api_server.models.schemas.licensed_items import (
+    LicensedItemCheckoutData,
+)
 from simcore_service_api_server.models.schemas.model_adapter import LicensedItemGet
 from simcore_service_api_server.services_rpc.wb_api_server import WbApiRpcClient
 
@@ -145,3 +153,55 @@ async def side_effect(
         f"{API_VTAG}/wallets/{_wallet_id}/licensed-items", auth=auth
     )
     assert resp.status_code == expected_api_server_status_code
+
+
+@pytest.mark.parametrize(
+    "exception_to_raise,expected_api_server_status_code",
+    [
+        (None, status.HTTP_200_OK),
+    ],
+)
+async def test_get_licensed_items_checkout(
+    mock_wb_api_server_rcp: MockerFixture,
+    client: AsyncClient,
+    auth: BasicAuth,
+    exception_to_raise: Exception | None,
+    expected_api_server_status_code: int,
+    faker: Faker,
+):
+    _wallet_id = faker.pyint(min_value=1)
+    _licensed_item_id = faker.uuid4()
+
+    async def side_effect(
+        rabbitmq_rpc_client: RabbitMQRPCClient,
+        product_name: str,
+        user_id: UserID,
+        wallet_id: WalletID,
+        licensed_item_id: LicensedItemID,
+        num_of_seats: int,
+        service_run_id: ServiceRunID,
+    ) -> LicensedItemCheckoutRpcGet:
+        if exception_to_raise is not None:
+            raise exception_to_raise
+        extra = LicensedItemCheckoutRpcGet.model_config.get("json_schema_extra")
+        assert isinstance(extra, dict)
+        examples = extra.get("examples")
+        assert isinstance(examples, list)
+        assert len(examples) > 0
+        example = examples[0]
+        assert isinstance(example, dict)
+        return LicensedItemCheckoutRpcGet.model_validate(example)
+
+    mock_wb_api_server_rcp.patch(
+        "simcore_service_api_server.services_rpc.wb_api_server._checkout_licensed_item_for_wallet",
+        side_effect,
+    )
+    body = LicensedItemCheckoutData(
+        number_of_seats=faker.pyint(min_value=1), service_run_id="myservice"
+    )
+    resp = await client.post(
+        f"{API_VTAG}/wallets/{_wallet_id}/licensed-items/{_licensed_item_id}/checkout",
+        auth=auth,
+        content=body.model_dump_json(),
+    )
+    assert resp.status_code == expected_api_server_status_code