73 lines
2.4 KiB
Python
73 lines
2.4 KiB
Python
"""Unit contracts for secret-safe logs and bounded API metrics."""
|
|
|
|
import json
|
|
import logging
|
|
|
|
from fastapi.testclient import TestClient
|
|
from pydantic import SecretStr
|
|
|
|
from ekp_api.main import create_app
|
|
from ekp_core.config import Settings
|
|
from ekp_core.observability import JsonLogFormatter, bind_request_id, reset_request_id
|
|
|
|
|
|
def _settings() -> Settings:
|
|
"""Use an isolated test database while exercising provider-free endpoints."""
|
|
return Settings(
|
|
app_env="test",
|
|
database_url=SecretStr("sqlite+pysqlite:///:memory:"),
|
|
)
|
|
|
|
|
|
def test_json_formatter_keeps_allowlisted_context_and_drops_arbitrary_fields() -> None:
|
|
"""Structured events must not serialize provider exception or custom secrets."""
|
|
record = logging.LogRecord(
|
|
name="ekp.test",
|
|
level=logging.ERROR,
|
|
pathname=__file__,
|
|
lineno=1,
|
|
msg="safe failure",
|
|
args=(),
|
|
exc_info=None,
|
|
)
|
|
record.event = "safe_event"
|
|
record.job_id = "job-1"
|
|
record.provider_secret = "must-not-appear"
|
|
token = bind_request_id("request-1")
|
|
try:
|
|
payload = json.loads(JsonLogFormatter().format(record))
|
|
finally:
|
|
reset_request_id(token)
|
|
|
|
assert payload["event"] == "safe_event"
|
|
assert payload["job_id"] == "job-1"
|
|
assert payload["request_id"] == "request-1"
|
|
assert "provider_secret" not in payload
|
|
assert "must-not-appear" not in json.dumps(payload)
|
|
|
|
|
|
def test_api_exposes_low_cardinality_metrics_and_request_correlation() -> None:
|
|
"""Metrics use route templates, and callers receive a safe correlation id."""
|
|
client = TestClient(create_app(_settings()))
|
|
|
|
response = client.get("/healthz", headers={"x-request-id": "acceptance-request-1"})
|
|
metrics = client.get("/metrics")
|
|
|
|
assert response.status_code == 200
|
|
assert response.headers["x-request-id"] == "acceptance-request-1"
|
|
assert metrics.status_code == 200
|
|
assert "ekp_process_uptime_seconds " in metrics.text
|
|
assert 'path="/healthz",status="200"' in metrics.text
|
|
assert "?" not in metrics.text
|
|
|
|
|
|
def test_api_replaces_unsafe_request_identifier() -> None:
|
|
"""Untrusted correlation headers cannot inject log structure or new lines."""
|
|
client = TestClient(create_app(_settings()))
|
|
|
|
response = client.get("/healthz", headers={"x-request-id": "unsafe\nvalue"})
|
|
|
|
request_id = response.headers["x-request-id"]
|
|
assert request_id != "unsafe\nvalue"
|
|
assert len(request_id) == 32
|