Health indictor should return 503 when status is DOWN

See https://docs.spring.io/spring-boot/docs/2.7.0/reference/htmlsingle/#actuator.endpoints.health.writing-custom-health-indicators

Author: michael.yak

pyctuator/health/health_provider.py

@@ -1,6 +1,7 @@
 from abc import ABC
 from dataclasses import dataclass
 from enum import Enum
+from http import HTTPStatus
 
 from typing import Mapping
 
@@ -27,6 +28,11 @@ class HealthSummary:
     status: Status
     details: Mapping[str, HealthStatus]
 
+    def http_status(self) -> int:
+        if self.status == Status.DOWN:
+            return HTTPStatus.SERVICE_UNAVAILABLE
+        return HTTPStatus.OK
+
 
 class HealthProvider(ABC):
     def is_supported(self) -> bool:

pyctuator/impl/aiohttp_pyctuator.py

@@ -37,7 +37,8 @@ async def get_info(request: web.Request) -> web.Response:
             return web.json_response(pyctuator_impl.get_app_info(), dumps=custom_dumps)
 
         async def get_health(request: web.Request) -> web.Response:
-            return web.json_response(pyctuator_impl.get_health(), dumps=custom_dumps)
+            health = pyctuator_impl.get_health()
+            return web.json_response(health, status=health.http_status(), dumps=custom_dumps)
 
         async def get_metric_names(request: web.Request) -> web.Response:
             return web.json_response(pyctuator_impl.get_metric_names(), dumps=custom_dumps)

pyctuator/impl/fastapi_pyctuator.py

@@ -74,8 +74,10 @@ def get_info() -> Dict:
             return pyctuator_impl.get_app_info()
 
         @router.get("/health", include_in_schema=include_in_openapi_schema, tags=["pyctuator"])
-        def get_health() -> HealthSummary:
-            return pyctuator_impl.get_health()
+        def get_health(response: Response) -> HealthSummary:
+            health = pyctuator_impl.get_health()
+            response.status_code = health.http_status()
+            return health
 
         @router.get("/metrics", include_in_schema=include_in_openapi_schema, tags=["pyctuator"])
         def get_metric_names() -> MetricNames:

pyctuator/impl/flask_pyctuator.py

@@ -85,7 +85,8 @@ def get_info() -> Any:
 
         @flask_blueprint.route("/health")
         def get_health() -> Any:
-            return jsonify(pyctuator_impl.get_health())
+            health = pyctuator_impl.get_health()
+            return jsonify(health), health.http_status()
 
         @flask_blueprint.route("/metrics")
         def get_metric_names() -> Any:

pyctuator/impl/tornado_pyctuator.py

@@ -58,7 +58,9 @@ class HealthHandler(AbstractPyctuatorHandler):
     def get(self) -> None:
         assert self.pyctuator_router is not None
         assert self.dumps is not None
-        self.write(self.dumps(self.pyctuator_router.pyctuator_impl.get_health()))
+        health = self.pyctuator_router.pyctuator_impl.get_health()
+        self.set_status(health.http_status())
+        self.write(self.dumps(health))
 
 
 # GET /metrics

tests/test_pyctuator_e2e.py

@@ -132,7 +132,7 @@ def mock_disk_usage(path: str) -> MockDiskUsage:
 
     monkeypatch.setattr(psutil, "disk_usage", mock_disk_usage)
     response = requests.get(endpoints.health, timeout=REQUEST_TIMEOUT)
-    assert response.status_code == HTTPStatus.OK
+    assert response.status_code == HTTPStatus.SERVICE_UNAVAILABLE
     assert response.json()["status"] == "DOWN"
     disk_space_health = response.json()["details"]["diskSpace"]
     assert disk_space_health["status"] == "DOWN"