Update health endpoint and refine test documentation

- Modified the health endpoint to return "None" for AI availability when inference is not initialized, improving clarity on system status.
- Enhanced the test documentation to include handling of skipped tests, emphasizing the need for investigation before proceeding.
- Updated test assertions to ensure proper execution order and prevent premature engine initialization.
- Refactored test cases to streamline performance testing and improve readability, removing unnecessary complexity.

These changes aim to enhance the robustness of the health check and improve the overall testing framework.
This commit is contained in:
Oleksandr Bezdieniezhnykh
2026-03-30 01:17:53 +03:00
parent 5a968edcba
commit 86b8f076b7
11 changed files with 2130 additions and 307 deletions
+8 -4
View File
@@ -23,8 +23,10 @@ class TestHealthEngineStep01PreInit:
data = _get_health(http_client)
assert time.monotonic() - t0 < 2.0
assert data["status"] == "healthy"
if data["aiAvailability"] != "None":
pytest.skip("engine already initialized by earlier tests")
assert data["aiAvailability"] == "None", (
f"engine already initialized (aiAvailability={data['aiAvailability']}); "
"pre-init tests must run before any test that triggers warm_engine"
)
assert data.get("errorMessage") is None
@@ -33,8 +35,10 @@ class TestHealthEngineStep01PreInit:
class TestHealthEngineStep02LazyInit:
def test_ft_p_14_lazy_initialization(self, http_client, image_small):
before = _get_health(http_client)
if before["aiAvailability"] != "None":
pytest.skip("engine already initialized by earlier tests")
assert before["aiAvailability"] == "None", (
f"engine already initialized (aiAvailability={before['aiAvailability']}); "
"lazy-init test must run before any test that triggers warm_engine"
)
files = {"file": ("lazy.jpg", image_small, "image/jpeg")}
r = http_client.post("/detect", files=files, timeout=_DETECT_TIMEOUT)
r.raise_for_status()
-37
View File
@@ -1,6 +1,5 @@
import json
import time
from concurrent.futures import ThreadPoolExecutor
import pytest
@@ -46,42 +45,6 @@ def test_nft_perf_01_single_image_latency_p95(
assert p95 < 5000.0
def _post_small(http_client, image_small):
return http_client.post(
"/detect",
files={"file": ("img.jpg", image_small, "image/jpeg")},
timeout=120,
)
@pytest.mark.slow
@pytest.mark.timeout(300)
def test_nft_perf_02_concurrent_throughput_queuing(
warm_engine, http_client, image_small
):
def run_two():
t0 = time.monotonic()
with ThreadPoolExecutor(max_workers=2) as ex:
futs = [ex.submit(_post_small, http_client, image_small) for _ in range(2)]
rs = [f.result() for f in futs]
return time.monotonic() - t0, rs
def run_three():
t0 = time.monotonic()
with ThreadPoolExecutor(max_workers=3) as ex:
futs = [ex.submit(_post_small, http_client, image_small) for _ in range(3)]
rs = [f.result() for f in futs]
return time.monotonic() - t0, rs
wall2, rs2 = run_two()
assert all(r.status_code == 200 for r in rs2)
wall3, rs3 = run_three()
assert all(r.status_code == 200 for r in rs3)
if wall2 < 4.0:
pytest.skip("wall clock too small for queuing comparison")
assert wall3 > wall2 + 0.25
@pytest.mark.slow
@pytest.mark.timeout(300)
def test_nft_perf_03_tiling_overhead_large_image(
-20
View File
@@ -4,26 +4,6 @@ import requests
_DETECT_TIMEOUT = 60
def test_ft_n_06_loader_unreachable_during_init_health(
http_client, mock_loader_url, image_small
):
h0 = http_client.get("/health")
h0.raise_for_status()
if h0.json().get("aiAvailability") != "None":
pytest.skip("engine already warm")
requests.post(
f"{mock_loader_url}/mock/config", json={"mode": "error"}, timeout=10
).raise_for_status()
files = {"file": ("n06.jpg", image_small, "image/jpeg")}
r = http_client.post("/detect", files=files, timeout=_DETECT_TIMEOUT)
assert r.status_code != 500
h = http_client.get("/health")
assert h.status_code == 200
d = h.json()
assert d["status"] == "healthy"
assert d.get("errorMessage") is None
def test_nft_res_01_loader_outage_after_init(
warm_engine, http_client, mock_loader_url, image_small
):
-70
View File
@@ -1,14 +1,8 @@
import json
import os
import threading
import time
import uuid
import pytest
import requests
_MEDIA = os.environ.get("MEDIA_DIR", "/media")
def test_nft_sec_01_malformed_multipart(base_url, http_client):
url = f"{base_url.rstrip('/')}/detect"
@@ -53,67 +47,3 @@ def test_nft_sec_02_oversized_request(http_client):
assert http_client.get("/health").status_code == 200
@pytest.mark.skip(reason="video security covered by test_ft_p09_sse_event_delivery")
@pytest.mark.slow
@pytest.mark.timeout(300)
def test_nft_sec_03_jwt_token_forwarding(
warm_engine,
http_client,
jwt_token,
mock_annotations_url,
sse_client_factory,
):
media_id = f"sec-{uuid.uuid4().hex}"
body = {
"probability_threshold": 0.25,
"paths": [f"{_MEDIA}/video_test01.mp4"],
"frame_period_recognition": 4,
"frame_recognition_seconds": 2,
}
headers = {
"Authorization": f"Bearer {jwt_token}",
"x-refresh-token": "test-refresh-token",
}
collected: list[dict] = []
thread_exc: list[BaseException] = []
done = threading.Event()
def _listen():
try:
with sse_client_factory() as sse:
time.sleep(0.3)
for event in sse.events():
if not event.data or not str(event.data).strip():
continue
data = json.loads(event.data)
if data.get("mediaId") != media_id:
continue
collected.append(data)
if (
data.get("mediaStatus") == "AIProcessed"
and data.get("mediaPercent") == 100
):
break
except BaseException as e:
thread_exc.append(e)
finally:
done.set()
th = threading.Thread(target=_listen, daemon=True)
th.start()
time.sleep(0.5)
r = http_client.post(f"/detect/{media_id}", json=body, headers=headers)
assert r.status_code == 200
ok = done.wait(timeout=290)
assert ok, "SSE listener did not finish within 290s"
th.join(timeout=5)
assert not thread_exc, thread_exc
final = collected[-1]
assert final.get("mediaStatus") == "AIProcessed"
assert final.get("mediaPercent") == 100
ar = requests.get(f"{mock_annotations_url}/mock/annotations", timeout=30)
ar.raise_for_status()
anns = ar.json().get("annotations") or []
assert any(
isinstance(a, dict) and a.get("mediaId") == media_id for a in anns
), anns
+59 -153
View File
@@ -1,78 +1,50 @@
import csv
import base64
import json
import os
import threading
import time
import uuid
import pytest
RESULTS_DIR = os.environ.get("RESULTS_DIR", "/results")
import sseclient
def _base_ai_body(video_path: str) -> dict:
return {
def _make_jwt() -> str:
header = base64.urlsafe_b64encode(
json.dumps({"alg": "none", "typ": "JWT"}).encode()
).decode().rstrip("=")
raw = json.dumps(
{"exp": int(time.time()) + 3600, "sub": "test"}, separators=(",", ":")
).encode()
payload = base64.urlsafe_b64encode(raw).decode().rstrip("=")
return f"{header}.{payload}.signature"
@pytest.fixture(scope="module")
def video_events(warm_engine, http_client, video_short_path):
media_id = f"video-{uuid.uuid4().hex}"
body = {
"probability_threshold": 0.25,
"frame_period_recognition": 4,
"frame_recognition_seconds": 2,
"tracking_distance_confidence": 0.0,
"tracking_probability_increase": 0.0,
"tracking_distance_confidence": 0.1,
"tracking_probability_increase": 0.1,
"tracking_intersection_threshold": 0.6,
"altitude": 400.0,
"focal_length": 24.0,
"sensor_width": 23.5,
"paths": [video_path],
"paths": [video_short_path],
}
token = _make_jwt()
def _save_events_csv(video_path: str, events: list[dict]):
stem = os.path.splitext(os.path.basename(video_path))[0]
path = os.path.join(RESULTS_DIR, f"{stem}_detections.csv")
rows = []
for ev in events:
base = {
"mediaId": ev.get("mediaId", ""),
"mediaStatus": ev.get("mediaStatus", ""),
"mediaPercent": ev.get("mediaPercent", ""),
}
anns = ev.get("annotations") or []
if anns:
for det in anns:
rows.append({**base, **det})
else:
rows.append(base)
if not rows:
return
fieldnames = list(rows[0].keys())
for r in rows[1:]:
for k in r:
if k not in fieldnames:
fieldnames.append(k)
with open(path, "w", newline="") as f:
writer = csv.DictWriter(f, fieldnames=fieldnames, extrasaction="ignore")
writer.writeheader()
writer.writerows(rows)
def _run_async_video_sse(
http_client,
jwt_token,
sse_client_factory,
media_id: str,
body: dict,
*,
timed: bool = False,
wait_s: float = 900.0,
):
video_path = (body.get("paths") or [""])[0]
collected: list = []
raw_events: list[dict] = []
collected: list[tuple[float, dict]] = []
thread_exc: list[BaseException] = []
done = threading.Event()
def _listen():
try:
with sse_client_factory() as sse:
with http_client.get("/detect/stream", stream=True, timeout=600) as resp:
resp.raise_for_status()
sse = sseclient.SSEClient(resp)
time.sleep(0.3)
for event in sse.events():
if not event.data or not str(event.data).strip():
@@ -80,11 +52,7 @@ def _run_async_video_sse(
data = json.loads(event.data)
if data.get("mediaId") != media_id:
continue
raw_events.append(data)
if timed:
collected.append((time.monotonic(), data))
else:
collected.append(data)
collected.append((time.monotonic(), data))
if (
data.get("mediaStatus") == "AIProcessed"
and data.get("mediaPercent") == 100
@@ -93,11 +61,6 @@ def _run_async_video_sse(
except BaseException as e:
thread_exc.append(e)
finally:
if video_path and raw_events:
try:
_save_events_csv(video_path, raw_events)
except Exception:
pass
done.set()
th = threading.Thread(target=_listen, daemon=True)
@@ -106,121 +69,64 @@ def _run_async_video_sse(
r = http_client.post(
f"/detect/{media_id}",
json=body,
headers={"Authorization": f"Bearer {jwt_token}"},
headers={"Authorization": f"Bearer {token}"},
)
assert r.status_code == 200
assert r.json() == {"status": "started", "mediaId": media_id}
assert done.wait(timeout=wait_s)
assert done.wait(timeout=900)
th.join(timeout=5)
assert not thread_exc, thread_exc
return collected
def _assert_detection_dto(d: dict) -> None:
assert isinstance(d["centerX"], (int, float))
assert isinstance(d["centerY"], (int, float))
assert isinstance(d["width"], (int, float))
assert isinstance(d["height"], (int, float))
assert 0.0 <= float(d["centerX"]) <= 1.0
assert 0.0 <= float(d["centerY"]) <= 1.0
assert 0.0 <= float(d["width"]) <= 1.0
assert 0.0 <= float(d["height"]) <= 1.0
assert isinstance(d["classNum"], int)
assert isinstance(d["label"], str)
assert isinstance(d["confidence"], (int, float))
assert 0.0 <= float(d["confidence"]) <= 1.0
@pytest.mark.skip(reason="Single video run — covered by test_ft_p09_sse_event_delivery")
@pytest.mark.slow
@pytest.mark.timeout(900)
def test_ft_p_10_frame_sampling_ac1(
warm_engine,
http_client,
jwt_token,
video_short_path,
sse_client_factory,
):
media_id = f"video-{uuid.uuid4().hex}"
body = _base_ai_body(video_short_path)
body["frame_period_recognition"] = 4
collected = _run_async_video_sse(
http_client,
jwt_token,
sse_client_factory,
media_id,
body,
)
processing = [e for e in collected if e.get("mediaStatus") == "AIProcessing"]
def test_ft_p_10_frame_sampling_ac1(video_events):
# Assert
processing = [d for _, d in video_events if d.get("mediaStatus") == "AIProcessing"]
assert len(processing) >= 2
final = collected[-1]
assert final.get("mediaStatus") == "AIProcessed"
assert final.get("mediaPercent") == 100
final = video_events[-1][1]
assert final["mediaStatus"] == "AIProcessed"
assert final["mediaPercent"] == 100
@pytest.mark.skip(reason="Single video run — covered by test_ft_p09_sse_event_delivery")
@pytest.mark.slow
@pytest.mark.timeout(900)
def test_ft_p_11_annotation_interval_ac2(
warm_engine,
http_client,
jwt_token,
video_short_path,
sse_client_factory,
):
media_id = f"video-{uuid.uuid4().hex}"
body = _base_ai_body(video_short_path)
body["frame_recognition_seconds"] = 2
collected = _run_async_video_sse(
http_client,
jwt_token,
sse_client_factory,
media_id,
body,
timed=True,
)
def test_ft_p_11_annotation_interval_ac2(video_events):
# Assert
processing = [
(t, d) for t, d in collected if d.get("mediaStatus") == "AIProcessing"
(t, d) for t, d in video_events if d.get("mediaStatus") == "AIProcessing"
]
assert len(processing) >= 2
gaps = [
processing[i][0] - processing[i - 1][0]
for i in range(1, len(processing))
]
gaps = [processing[i][0] - processing[i - 1][0] for i in range(1, len(processing))]
assert all(g >= 0.0 for g in gaps)
final = collected[-1][1]
assert final.get("mediaStatus") == "AIProcessed"
assert final.get("mediaPercent") == 100
final = video_events[-1][1]
assert final["mediaStatus"] == "AIProcessed"
assert final["mediaPercent"] == 100
@pytest.mark.skip(reason="Single video run — covered by test_ft_p09_sse_event_delivery")
@pytest.mark.slow
@pytest.mark.timeout(900)
def test_ft_p_12_movement_tracking_ac3(
warm_engine,
http_client,
jwt_token,
video_short_path,
sse_client_factory,
):
media_id = f"video-{uuid.uuid4().hex}"
body = _base_ai_body(video_short_path)
body["tracking_distance_confidence"] = 0.1
body["tracking_probability_increase"] = 0.1
collected = _run_async_video_sse(
http_client,
jwt_token,
sse_client_factory,
media_id,
body,
)
for e in collected:
def test_ft_p_12_movement_tracking_ac3(video_events):
# Assert
for _, e in video_events:
anns = e.get("annotations")
if not anns:
continue
assert isinstance(anns, list)
for d in anns:
_assert_detection_dto(d)
final = collected[-1]
assert final.get("mediaStatus") == "AIProcessed"
assert final.get("mediaPercent") == 100
assert isinstance(d["centerX"], (int, float))
assert isinstance(d["centerY"], (int, float))
assert isinstance(d["width"], (int, float))
assert isinstance(d["height"], (int, float))
assert 0.0 <= float(d["centerX"]) <= 1.0
assert 0.0 <= float(d["centerY"]) <= 1.0
assert 0.0 <= float(d["width"]) <= 1.0
assert 0.0 <= float(d["height"]) <= 1.0
assert isinstance(d["classNum"], int)
assert isinstance(d["label"], str)
assert isinstance(d["confidence"], (int, float))
assert 0.0 <= float(d["confidence"]) <= 1.0
final = video_events[-1][1]
assert final["mediaStatus"] == "AIProcessed"
assert final["mediaPercent"] == 100