tests api-health

Author: pcrespov

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

@@ -23,7 +23,12 @@ async def check_service_health():
     return f"{__name__}@{datetime.datetime.now(tz=datetime.timezone.utc).isoformat()}"
 
 
-@router.get("/state", include_in_schema=False)
+@router.get(
+    "/state",
+    include_in_schema=False,
+    response_model=AppStatusCheck,
+    response_model_exclude_unset=True,
+)
 async def get_service_state(
     catalog_client: Annotated[CatalogApi, Depends(get_api_client(CatalogApi))],
     director2_api: Annotated[DirectorV2Api, Depends(get_api_client(DirectorV2Api))],
@@ -42,18 +47,14 @@ async def get_service_state(
         return_exceptions=False,
     )
 
-    current_status = AppStatusCheck(
+    return AppStatusCheck(
         app_name=PROJECT_NAME,
         version=API_VERSION,
         services={
             api.service_name: {
                 "healthy": bool(is_healty),
-                "url": str(api.client.base_url) + api.health_check_path.lstrip("/"),
             }
             for api, is_healty in zip(apis, healths, strict=True)
         },
         url=url_for("get_service_state"),
     )
-    resp = current_status.dict(exclude_unset=True)
-    resp.update(docs_dev_url=url_for("swagger_ui_html"))
-    return resp

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

@@ -211,18 +211,27 @@ def mocked_directorv2_service_api_base(
 
     # pylint: disable=not-context-manager
     with respx.mock(
-        base_url=settings.API_SERVER_DIRECTOR_V2.api_base_url,
+        base_url=settings.API_SERVER_DIRECTOR_V2.base_url,
         assert_all_called=False,
         assert_all_mocked=True,  # IMPORTANT: KEEP always True!
     ) as respx_mock:
+
         assert openapi
+        assert (
+            openapi["paths"]["/"]["get"]["operationId"] == "check_service_health__get"
+        )
+
+        respx_mock.get(path="/", name="check_service_health__get").respond(
+            status.HTTP_200_OK,
+            json=openapi["components"]["schemas"]["HealthCheckGet"]["example"],
+        )
 
         yield respx_mock
 
 
 @pytest.fixture
 def mocked_webserver_service_api_base(
-    app: FastAPI, storage_service_openapi_specs: dict[str, Any]
+    app: FastAPI, webserver_service_openapi_specs: dict[str, Any]
 ) -> Iterator[MockRouter]:
     """
     Creates a respx.mock to capture calls to webserver API
@@ -232,7 +241,7 @@ def mocked_webserver_service_api_base(
     settings: ApplicationSettings = app.state.settings
     assert settings.API_SERVER_WEBSERVER
 
-    openapi = deepcopy(storage_service_openapi_specs)
+    openapi = deepcopy(webserver_service_openapi_specs)
     assert Version(openapi["info"]["version"]).major == 0
 
     # pylint: disable=not-context-manager
@@ -251,10 +260,10 @@ def mocked_webserver_service_api_base(
             ]["schema"]["properties"]["data"]["example"]
         }
 
-        respx_mock.get(path="/v0/", name="healthcheck_readiness_probe").respond(
+        respx_mock.get(path="/", name="healthcheck_readiness_probe").respond(
             status.HTTP_200_OK, json=response_body
         )
-        respx_mock.get(path="/v0/health", name="healthcheck_liveness_probe").respond(
+        respx_mock.get(path="/health", name="healthcheck_liveness_probe").respond(
             status.HTTP_200_OK, json=response_body
         )
 
@@ -328,6 +337,12 @@ def mocked_catalog_service_api_base(
         assert_all_called=False,
         assert_all_mocked=True,
     ) as respx_mock:
-        respx_mock.get("/v0/meta").respond(200, json=schemas["Meta"]["example"])
+        respx_mock.get("/v0/").respond(
+            status.HTTP_200_OK,
+            text="simcore_service_catalog.api.routes.health@2023-07-03T12:59:12.024551+00:00",
+        )
+        respx_mock.get("/v0/meta").respond(
+            status.HTTP_200_OK, json=schemas["Meta"]["example"]
+        )
 
         yield respx_mock

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

@@ -10,7 +10,7 @@
 from models_library.app_diagnostics import AppStatusCheck
 from pydantic import parse_obj_as
 from respx import MockRouter
-from simcore_service_api_server._meta import API_VERSION, API_VTAG
+from simcore_service_api_server._meta import API_VTAG
 
 
 async def test_check_service_health(client: AsyncClient):
@@ -21,14 +21,24 @@ async def test_check_service_health(client: AsyncClient):
 
 async def test_get_service_state(
     client: AsyncClient,
-    mocked_directorv2_service_api_base: MockRouter,
-    mocked_webserver_service_api_base: MockRouter,
     mocked_catalog_service_api_base: MockRouter,
+    mocked_directorv2_service_api_base: MockRouter,
     mocked_storage_service_api_base: MockRouter,
+    mocked_webserver_service_api_base: MockRouter,
 ):
-    response = await client.get(f"{API_VTAG}/meta")
+    response = await client.get(f"{API_VTAG}/state")
     assert response.status_code == status.HTTP_200_OK
 
-    app_status_check = parse_obj_as(AppStatusCheck, response.json())
-    print(app_status_check.json(indent=1))
-    assert app_status_check.version == API_VERSION
+    assert response.json() == {
+        "app_name": "simcore-service-api-server",
+        "version": "0.4.5",
+        "services": {
+            "catalog": {"healthy": True},
+            "director_v2": {"healthy": True},
+            "storage": {"healthy": True},
+            "webserver": {"healthy": True},
+        },
+        "url": "http://api.testserver.io/state",
+    }
+
+    assert parse_obj_as(AppStatusCheck, response.json())