feat: add /health endpoint for microservice monitoring
Checks database, background workers (ingestion, collector, attacker, sniffer), and Docker daemon. Reports healthy/degraded/unhealthy status with per-component details. Returns 503 when required services fail, 200 for healthy or degraded (only optional services down).
This commit is contained in:
0
tests/api/health/__init__.py
Normal file
0
tests/api/health/__init__.py
Normal file
158
tests/api/health/test_get_health.py
Normal file
158
tests/api/health/test_get_health.py
Normal file
@@ -0,0 +1,158 @@
|
||||
import asyncio
|
||||
from unittest.mock import AsyncMock, MagicMock, patch
|
||||
|
||||
import httpx
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_requires_auth(client: httpx.AsyncClient) -> None:
|
||||
resp = await client.get("/api/v1/health")
|
||||
assert resp.status_code == 401
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_response_schema(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker:
|
||||
# All workers running
|
||||
for name in ("ingestion_worker", "collector_worker", "attacker_worker", "sniffer_worker"):
|
||||
task = MagicMock(spec=asyncio.Task)
|
||||
task.done.return_value = False
|
||||
mock_tasks.return_value = {name: task for name in
|
||||
("ingestion_worker", "collector_worker", "attacker_worker", "sniffer_worker")}
|
||||
mock_client = MagicMock()
|
||||
mock_docker.return_value = mock_client
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
data = resp.json()
|
||||
assert "status" in data
|
||||
assert data["status"] in ("healthy", "degraded", "unhealthy")
|
||||
assert "components" in data
|
||||
expected_components = {"database", "ingestion_worker", "collector_worker",
|
||||
"attacker_worker", "sniffer_worker", "docker"}
|
||||
assert set(data["components"].keys()) == expected_components
|
||||
for comp in data["components"].values():
|
||||
assert comp["status"] in ("ok", "failing")
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_database_ok(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker:
|
||||
_make_all_running(mock_tasks)
|
||||
mock_docker.return_value = MagicMock()
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
assert resp.json()["components"]["database"]["status"] == "ok"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_all_healthy(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker:
|
||||
_make_all_running(mock_tasks)
|
||||
mock_docker.return_value = MagicMock()
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
assert resp.status_code == 200
|
||||
assert resp.json()["status"] == "healthy"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_degraded_sniffer_only(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker:
|
||||
tasks = _make_running_tasks()
|
||||
tasks["sniffer_worker"] = None # sniffer not started
|
||||
mock_tasks.return_value = tasks
|
||||
mock_docker.return_value = MagicMock()
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
assert resp.status_code == 200
|
||||
assert resp.json()["status"] == "degraded"
|
||||
assert resp.json()["components"]["sniffer_worker"]["status"] == "failing"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_unhealthy_returns_503(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker:
|
||||
tasks = _make_running_tasks()
|
||||
tasks["ingestion_worker"] = None # required worker down
|
||||
mock_tasks.return_value = tasks
|
||||
mock_docker.return_value = MagicMock()
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
assert resp.status_code == 503
|
||||
assert resp.json()["status"] == "unhealthy"
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_docker_failing(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env", side_effect=Exception("connection refused")):
|
||||
_make_all_running(mock_tasks)
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
comp = resp.json()["components"]["docker"]
|
||||
assert comp["status"] == "failing"
|
||||
assert "connection refused" in comp["detail"]
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_database_failing(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
from decnet.web.dependencies import repo as real_repo
|
||||
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker, \
|
||||
patch.object(real_repo, "get_total_logs", new=AsyncMock(side_effect=Exception("disk full"))):
|
||||
_make_all_running(mock_tasks)
|
||||
mock_docker.return_value = MagicMock()
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
comp = resp.json()["components"]["database"]
|
||||
assert comp["status"] == "failing"
|
||||
assert "disk full" in comp["detail"]
|
||||
|
||||
|
||||
@pytest.mark.anyio
|
||||
async def test_health_worker_exited_with_exception(client: httpx.AsyncClient, auth_token: str) -> None:
|
||||
with patch("decnet.web.api.get_background_tasks") as mock_tasks, \
|
||||
patch("docker.from_env") as mock_docker:
|
||||
tasks = _make_running_tasks()
|
||||
dead_task = MagicMock(spec=asyncio.Task)
|
||||
dead_task.done.return_value = True
|
||||
dead_task.cancelled.return_value = False
|
||||
dead_task.exception.return_value = RuntimeError("segfault")
|
||||
tasks["collector_worker"] = dead_task
|
||||
mock_tasks.return_value = tasks
|
||||
mock_docker.return_value = MagicMock()
|
||||
|
||||
resp = await client.get("/api/v1/health", headers={"Authorization": f"Bearer {auth_token}"})
|
||||
|
||||
comp = resp.json()["components"]["collector_worker"]
|
||||
assert comp["status"] == "failing"
|
||||
assert "segfault" in comp["detail"]
|
||||
|
||||
|
||||
# ── Helpers ──────────────────────────────────────────────────────────────────
|
||||
|
||||
def _make_running_tasks() -> dict[str, MagicMock]:
|
||||
tasks = {}
|
||||
for name in ("ingestion_worker", "collector_worker", "attacker_worker", "sniffer_worker"):
|
||||
t = MagicMock(spec=asyncio.Task)
|
||||
t.done.return_value = False
|
||||
tasks[name] = t
|
||||
return tasks
|
||||
|
||||
|
||||
def _make_all_running(mock_tasks: MagicMock) -> None:
|
||||
mock_tasks.return_value = _make_running_tasks()
|
||||
Reference in New Issue
Block a user