get_category_items and settings

Author: pcrespov

services/web/server/src/simcore_service_webserver/licenses/_itis_vip_service.py

@@ -1,23 +1,12 @@
 import re
 from typing import Annotated, Any, Literal
-from urllib.parse import urlparse
 
 import httpx
-import pytest
-from pydantic import BaseModel, BeforeValidator, Field, HttpUrl, ValidationError
-from servicelib.aiohttp import status
-from settings_library.base import BaseCustomSettings
+from pydantic import BaseModel, BeforeValidator, Field, HttpUrl
 
-
-class ItisVipSettings(BaseCustomSettings):
-    ITIS_VIP_API_URL: str
-    ITIS_VIP_CATEGORIES: list[str]
-
-    def get_urls(self) -> list[HttpUrl]:
-        return [
-            HttpUrl(self.ITIS_VIP_API_URL.format(category=category))
-            for category in self.ITIS_VIP_CATEGORIES
-        ]
+#
+#  MODELS
+#
 
 
 def _feature_descriptor_to_dict(descriptor: str) -> dict[str, Any]:
@@ -50,27 +39,22 @@ class ResponseData(BaseModel):
     ]
 
 
-async def get_downloadable_items(
+#
+# API
+#
+
+
+async def get_category_items(
     client: httpx.AsyncClient, url: HttpUrl
 ) -> list[AvailableDownload]:
+    """
+
+    Raises:
+        Any https://www.python-httpx.org/exceptions/
+        httpx.HTTPStatusCode:
+
+    """
     response = await client.post(f"{url}")
-    assert response.status_code == status.HTTP_200_OK
+    response.raise_for_status()
     validated_data = ResponseData.model_validate(**response.json())
     return validated_data.available_downloads
-
-
-async def fetch_vip_downloadables(settings: ItisVipSettings):
-    urls, categories = settings.get_urls(), settings.ITIS_VIP_CATEGORIES
-
-    base_url = f"{urls[0].scheme}://{urlparse(f'{urls[0]}').netloc}"
-
-    async with httpx.AsyncClient() as client:
-        for url in urls:
-            response = await client.post(url)
-            assert response.status_code == status.HTTP_200_OK
-            response_json = response.json()
-
-            try:
-                validated_data = ResponseData(**response_json)
-            except ValidationError as e:
-                pytest.fail(f"Response validation failed: {e}")

services/web/server/src/simcore_service_webserver/licenses/settings.py

@@ -0,0 +1,29 @@
+from typing import Annotated
+
+from pydantic import AfterValidator, Field, HttpUrl
+from settings_library.base import BaseCustomSettings
+
+
+def _validate_url_contains_category(url: str) -> str:
+    if "{category}" not in url:
+        msg = "URL must contain '{category}'"
+        raise ValueError(msg)
+    return url
+
+
+class ItisVipSettings(BaseCustomSettings):
+    ITIS_VIP_API_URL: Annotated[str, AfterValidator(_validate_url_contains_category)]
+    ITIS_VIP_CATEGORIES: list[str]
+
+    def get_urls(self) -> list[HttpUrl]:
+        return [
+            HttpUrl(self.ITIS_VIP_API_URL.format(category=category))
+            for category in self.ITIS_VIP_CATEGORIES
+        ]
+
+
+class LicensesSettings(BaseCustomSettings):
+    LICENSES_ITIS_VIP: Annotated[
+        ItisVipSettings | None, Field(description="Settings for VIP license models")
+    ]
+    # other licenses resources come here

services/web/server/tests/unit/with_dbs/04/licenses/test_itis_vip_service.py

@@ -11,13 +11,38 @@
 from faker import Faker
 from httpx import AsyncClient
 from pydantic import ValidationError
+from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
+from pytest_simcore.helpers.typing_env import EnvVarsDict
 from servicelib.aiohttp import status
+from simcore_service_webserver.licenses import _itis_vip_service
 from simcore_service_webserver.licenses._itis_vip_service import ResponseData
+from simcore_service_webserver.licenses.settings import ItisVipSettings
+
+
+@pytest.fixture(scope="session")
+def fake_api_base_url() -> str:
+    return "https://testserver"
 
 
 @pytest.fixture
-def mock_itis_vip_downloadables_api(faker: Faker) -> Iterator[respx.MockRouter]:
-    api_url = "http://testserver"
+def app_environment(
+    monkeypatch: pytest.MonkeyPatch,
+    app_environment: EnvVarsDict,
+    fake_api_base_url: str,
+):
+    return app_environment | setenvs_from_dict(
+        monkeypatch,
+        {
+            "ITIS_VIP_API_URL": f"{fake_api_base_url}/PD_DirectDownload/getDownloadableItems/{{category}}",
+            "ITIS_VIP_CATEGORIES": "ComputationalPantom,Foo,Bar",
+        },
+    )
+
+
+@pytest.fixture
+def mock_itis_vip_downloadables_api(
+    faker: Faker, fake_api_base_url: str
+) -> Iterator[respx.MockRouter]:
     response_data = {
         "msg": 0,
         "availableDownloads": [
@@ -37,17 +62,17 @@ def mock_itis_vip_downloadables_api(faker: Faker) -> Iterator[respx.MockRouter]:
         ],
     }
 
-    with respx.mock(base_url=api_url) as mock:
-        mock.post("getDownloadableItems/ComputationalPantom").respond(
+    with respx.mock(base_url=fake_api_base_url) as mock:
+        mock.post(path__regex=r"/getDownloadableItems/(?P<category>\d+)").respond(
             status_code=200, json=response_data
         )
         yield mock
 
 
-async def test_fetch_itis_vip_api(
-    mock_itis_vip_downloadables_api: respx.MockRouter,
+async def test_fetch_and_validate_itis_vip_api(
+    mock_itis_vip_downloadables_api: respx.MockRouter, fake_api_base_url: str
 ):
-    async with AsyncClient(base_url="http://testserver") as client:
+    async with AsyncClient(base_url=fake_api_base_url) as client:
         response = await client.post("getDownloadableItems/ComputationalPantom")
         assert response.status_code == status.HTTP_200_OK
         response_json = response.json()
@@ -65,3 +90,21 @@ async def test_fetch_itis_vip_api(
         )
 
         print(validated_data.model_dump_json(indent=1))
+
+
+async def test_get_category_items(
+    mock_itis_vip_downloadables_api: respx.MockRouter,
+    app_environment: EnvVarsDict,
+):
+    settings = ItisVipSettings.create_from_envs()
+    assert settings.ITIS_VIP_CATEGORIES
+
+    async with AsyncClient() as client:
+        for url, category in zip(
+            settings.get_urls(), settings.ITIS_VIP_CATEGORIES, strict=True
+        ):
+            assert f"{url}".endswith(category)
+
+            items = await _itis_vip_service.get_category_items(client, url)
+
+            assert items[0].features["functionality"] == "Posable"