api tests passing

Author: sanderegg

services/director/src/simcore_service_director/api/rest/_services.py

@@ -5,6 +5,7 @@
 from models_library.generics import Envelope
 from models_library.services_enums import ServiceType
 from models_library.services_types import ServiceKey, ServiceVersion
+from pydantic import BaseModel
 from servicelib.fastapi.dependencies import get_app
 
 from ... import exceptions, registry_proxy
@@ -14,7 +15,24 @@
 log = logging.getLogger(__name__)
 
 
-@router.get("/services")
+class _ErrorMessage(BaseModel):
+    message: str
+
+
+@router.get(
+    "/services",
+    response_model=Envelope[list[dict[str, Any]]],
+    responses={
+        status.HTTP_401_UNAUTHORIZED: {
+            "model": _ErrorMessage,
+            "description": "Could not connect with Docker Registry",
+        },
+        status.HTTP_500_INTERNAL_SERVER_ERROR: {
+            "model": _ErrorMessage,
+            "description": "Unexpected error",
+        },
+    },
+)
 async def list_services(
     the_app: Annotated[FastAPI, Depends(get_app)],
     service_type: ServiceType | None = None,
@@ -29,11 +47,11 @@ async def list_services(
             services = await registry_proxy.list_services(
                 the_app, registry_proxy.ServiceType.ALL
             )
-        elif "computational" in service_type:
+        elif service_type is ServiceType.COMPUTATIONAL:
             services = await registry_proxy.list_services(
                 the_app, registry_proxy.ServiceType.COMPUTATIONAL
             )
-        elif "interactive" in service_type:
+        elif service_type is ServiceType.DYNAMIC:
             services = await registry_proxy.list_services(
                 the_app, registry_proxy.ServiceType.DYNAMIC
             )
@@ -47,56 +65,57 @@ async def list_services(
         ) from err
 
 
-@router.get("/services/{service_key:path}/{service_version}")
-async def get_service(
+# NOTE: be careful that /labels must be defined before the more generic get_service
+@router.get("/services/{service_key:path}/{service_version}/labels")
+async def list_service_labels(
     the_app: Annotated[FastAPI, Depends(get_app)],
     service_key: ServiceKey,
     service_version: ServiceVersion,
-) -> Envelope[list[dict[str, Any]]]:
+) -> Envelope[dict[str, Any]]:
     log.debug(
-        "Client does get_service with service_key %s, service_version %s",
+        "Retrieving service labels with service_key %s, service_version %s",
         service_key,
         service_version,
     )
     try:
-        services = [
-            await registry_proxy.get_image_details(
-                the_app, service_key, service_version
-            )
-        ]
-        return Envelope[list[dict[str, Any]]](data=services)
+        service_labels, _ = await registry_proxy.get_image_labels(
+            the_app, service_key, service_version
+        )
+        return Envelope[dict[str, Any]](data=service_labels)
+
     except exceptions.ServiceNotAvailableError as err:
         raise HTTPException(
             status_code=status.HTTP_404_NOT_FOUND, detail=f"{err}"
         ) from err
+
     except exceptions.RegistryConnectionError as err:
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED, detail=f"{err}"
         ) from err
 
 
-@router.get("/services/{service_key:path}/{service_version}/labels")
-async def list_service_labels(
+@router.get("/services/{service_key:path}/{service_version}")
+async def get_service(
     the_app: Annotated[FastAPI, Depends(get_app)],
     service_key: ServiceKey,
     service_version: ServiceVersion,
-) -> Envelope[dict[str, Any]]:
+) -> Envelope[list[dict[str, Any]]]:
     log.debug(
-        "Retrieving service labels with service_key %s, service_version %s",
+        "Client does get_service with service_key %s, service_version %s",
         service_key,
         service_version,
     )
     try:
-        service_labels, _ = await registry_proxy.get_image_labels(
-            the_app, service_key, service_version
-        )
-        return Envelope[dict[str, Any]](data=service_labels)
-
+        services = [
+            await registry_proxy.get_image_details(
+                the_app, service_key, service_version
+            )
+        ]
+        return Envelope[list[dict[str, Any]]](data=services)
     except exceptions.ServiceNotAvailableError as err:
         raise HTTPException(
             status_code=status.HTTP_404_NOT_FOUND, detail=f"{err}"
         ) from err
-
     except exceptions.RegistryConnectionError as err:
         raise HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED, detail=f"{err}"

services/director/tests/unit/api/test_rest_service_extras.py

@@ -33,7 +33,7 @@ async def test_get_services_extras_by_key_and_version_with_empty_registry(
     resp = await client.get(
         f"/{api_version_prefix}/service_extras/simcore/services/dynamic/something/someversion"
     )
-    assert resp.status_code == status.HTTP_404_NOT_FOUND, f"Got f{resp.text}"
+    assert resp.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY, f"Got f{resp.text}"
     resp = await client.get(
         f"/{api_version_prefix}/service_extras/simcore/services/dynamic/something/1.5.2"
     )

services/director/tests/unit/api/test_rest_services.py

@@ -94,9 +94,7 @@ async def test_get_service_bad_request(
     resp = await client.get(f"/{api_version_prefix}/services?service_type=blahblah")
     assert resp.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY, f"Got f{resp.text}"
 
-    services, error = _assert_response_and_unwrap_envelope(resp)
-    assert not services
-    assert error
+    # NOTE: only successful errors are enveloped
 
 
 async def test_list_services_by_service_type(
@@ -119,7 +117,7 @@ async def test_list_services_by_service_type(
     assert services
     assert len(services) == 3
 
-    resp = await client.get(f"/{api_version_prefix}/services?service_type=interactive")
+    resp = await client.get(f"/{api_version_prefix}/services?service_type=dynamic")
     assert resp.status_code == status.HTTP_200_OK, f"Got f{resp.text}"
 
     services, error = _assert_response_and_unwrap_envelope(resp)
@@ -137,12 +135,12 @@ async def test_get_services_by_key_and_version_with_empty_registry(
     assert resp.status_code == status.HTTP_422_UNPROCESSABLE_ENTITY, f"Got f{resp.text}"
 
     resp = await client.get(
-        f"/{api_version_prefix}/services/simcore/services/dynamic/something/someversion"
+        f"/{api_version_prefix}/simcore/services/dynamic/something/someversion"
     )
     assert resp.status_code == status.HTTP_404_NOT_FOUND, f"Got f{resp.text}"
 
     resp = await client.get(
-        f"/{api_version_prefix}/services/simcore/services/dynamic/something/1.5.2"
+        f"/{api_version_prefix}/simcore/services/dynamic/something/1.5.2"
     )
     assert resp.status_code == status.HTTP_404_NOT_FOUND, f"Got f{resp.text}"