File size: 13,494 Bytes
89419ea | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 | from types import SimpleNamespace
from contextlib import contextmanager
import pytest
from fastapi import FastAPI
from fastapi import HTTPException
from fastapi.testclient import TestClient
from src.core.external_batches.service import ExternalBatchCreateRequest, ExternalBatchService
from src.database import external_batch_crud
from src.database.models import Base, EmailService
from src.database.session import DatabaseSessionManager
import src.web.routes.external as external_router_package
import src.web.routes.external.capabilities as capabilities_routes
import src.web.routes.external.registration as registration_routes
import src.web.deps.external_auth as external_auth
def _settings(enabled: bool, api_key: str = "test-key"):
return SimpleNamespace(
external_api_enabled=enabled,
external_api_key=SimpleNamespace(get_secret_value=lambda: api_key),
)
def _client(monkeypatch):
monkeypatch.setattr(external_auth, "get_settings", lambda: _settings(True, "abc"))
app = FastAPI()
app.include_router(external_router_package.router, prefix="/external")
return TestClient(app)
def _make_db(name: str):
from pathlib import Path
runtime_dir = Path("tests_runtime")
runtime_dir.mkdir(exist_ok=True)
db_path = runtime_dir / name
if db_path.exists():
db_path.unlink()
manager = DatabaseSessionManager(f"sqlite:///{db_path}")
Base.metadata.create_all(bind=manager.engine)
return manager
def _seed_temp_mail(session):
session.add(EmailService(service_type="temp_mail", name="tm-1", config={"domain": "a.test"}, enabled=True, priority=0))
def test_external_auth_requires_api_key(monkeypatch):
monkeypatch.setattr(external_auth, "get_settings", lambda: _settings(True, "abc"))
with pytest.raises(HTTPException) as exc:
external_auth.require_external_api_key(x_api_key=None)
assert exc.value.status_code == 401
def test_external_auth_rejects_when_disabled(monkeypatch):
monkeypatch.setattr(external_auth, "get_settings", lambda: _settings(False, "abc"))
with pytest.raises(HTTPException) as exc:
external_auth.require_external_api_key(x_api_key="abc")
assert exc.value.status_code == 403
def test_external_auth_accepts_valid_api_key(monkeypatch):
monkeypatch.setattr(external_auth, "get_settings", lambda: _settings(True, "abc"))
assert external_auth.require_external_api_key(x_api_key="abc") is None
def test_external_capabilities_route_uses_adapter(monkeypatch):
monkeypatch.setattr(
capabilities_routes,
"_get_external_capabilities",
lambda: {"email_types": [{"type": "temp_mail", "available": True}], "upload_providers": []},
)
response = capabilities_routes.get_external_capabilities()
assert response["email_types"][0]["type"] == "temp_mail"
def test_external_registration_routes_use_service_adapter(monkeypatch):
created = {"batch_uuid": "b-1", "status": "pending", "requested_count": 2, "idempotent_replay": False}
monkeypatch.setattr(registration_routes, "_create_external_batch", lambda payload, background_tasks=None: created)
monkeypatch.setattr(registration_routes, "_get_external_batch", lambda batch_uuid: {"batch_uuid": batch_uuid, "status": "running"})
monkeypatch.setattr(registration_routes, "_cancel_external_batch", lambda batch_uuid: {"batch_uuid": batch_uuid, "status": "cancelled"})
request = registration_routes.ExternalBatchCreateRequest(
count=2,
email={"type": "temp_mail"},
upload={"enabled": False},
execution={"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 1},
)
create_resp = registration_routes.create_external_registration_batch(request)
status_resp = registration_routes.get_external_registration_batch("b-1")
cancel_resp = registration_routes.cancel_external_registration_batch("b-1")
assert create_resp["batch_uuid"] == "b-1"
assert status_resp["status"] == "running"
assert cancel_resp["status"] == "cancelled"
def test_external_registration_create_rejects_invalid_interval_bounds(monkeypatch):
client = _client(monkeypatch)
response = client.post(
"/external/registration/batches",
headers={"X-API-Key": "abc"},
json={
"count": 2,
"email": {"type": "temp_mail"},
"upload": {"enabled": False},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 5, "interval_max": 2},
},
)
assert response.status_code == 422
assert "interval_max" in response.text
def test_external_registration_create_requires_upload_provider_when_enabled(monkeypatch):
client = _client(monkeypatch)
response = client.post(
"/external/registration/batches",
headers={"X-API-Key": "abc"},
json={
"count": 1,
"email": {"type": "temp_mail"},
"upload": {"enabled": True},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 0},
},
)
assert response.status_code == 422
assert "upload.provider" in response.text
def test_external_registration_create_rejects_extra_fields(monkeypatch):
client = _client(monkeypatch)
response = client.post(
"/external/registration/batches",
headers={"X-API-Key": "abc"},
json={
"count": 1,
"email": {"type": "temp_mail", "unexpected": True},
"upload": {"enabled": False},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 0},
},
)
assert response.status_code == 422
assert "unexpected" in response.text
def test_external_registration_create_returns_200_for_idempotent_replay(monkeypatch):
monkeypatch.setattr(
registration_routes,
"_create_external_batch",
lambda payload, background_tasks=None: {
"batch_uuid": "b-1",
"status": "pending",
"requested_count": 1,
"idempotent_replay": True,
},
)
client = _client(monkeypatch)
response = client.post(
"/external/registration/batches",
headers={"X-API-Key": "abc"},
json={
"count": 1,
"idempotency_key": "same-batch",
"email": {"type": "temp_mail"},
"upload": {"enabled": False},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 0},
},
)
assert response.status_code == 200
assert response.json()["idempotent_replay"] is True
def test_external_registration_status_maps_batch_not_found_to_404(monkeypatch):
monkeypatch.setattr(registration_routes, "_get_external_batch", lambda batch_uuid: (_ for _ in ()).throw(ValueError("batch_not_found")))
client = _client(monkeypatch)
response = client.get("/external/registration/batches/missing", headers={"X-API-Key": "abc"})
assert response.status_code == 404
assert response.json()["detail"] == "batch_not_found"
def test_external_registration_create_maps_service_unavailable_to_503(monkeypatch):
monkeypatch.setattr(registration_routes, "_create_external_batch", lambda payload, background_tasks=None: (_ for _ in ()).throw(RuntimeError("external_batch_service_unavailable")))
client = _client(monkeypatch)
response = client.post(
"/external/registration/batches",
headers={"X-API-Key": "abc"},
json={
"count": 1,
"email": {"type": "temp_mail"},
"upload": {"enabled": False},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 0},
},
)
assert response.status_code == 503
assert response.json()["detail"] == "external_batch_service_unavailable"
def test_external_registration_cancel_maps_finished_batch_to_400(monkeypatch):
monkeypatch.setattr(registration_routes, "_cancel_external_batch", lambda batch_uuid: (_ for _ in ()).throw(ValueError("batch is already finished")))
client = _client(monkeypatch)
response = client.post("/external/registration/batches/b-1/cancel", headers={"X-API-Key": "abc"})
assert response.status_code == 400
assert response.json()["detail"] == "batch is already finished"
def test_external_registration_create_returns_failure_category(monkeypatch):
monkeypatch.setattr(
registration_routes,
"_create_external_batch",
lambda payload, background_tasks=None: {
"batch_uuid": "b-create",
"status": "pending",
"requested_count": 1,
"failure_category": None,
"idempotent_replay": False,
},
)
client = _client(monkeypatch)
response = client.post(
"/external/registration/batches",
headers={"X-API-Key": "abc"},
json={
"count": 1,
"email": {"type": "temp_mail"},
"upload": {"enabled": False},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 0},
},
)
assert response.status_code == 202
assert "failure_category" in response.json()
assert response.json()["failure_category"] is None
def test_external_registration_get_returns_failure_category(monkeypatch):
monkeypatch.setattr(
registration_routes,
"_get_external_batch",
lambda batch_uuid: {
"batch_uuid": batch_uuid,
"status": "failed",
"failure_category": "transient",
},
)
client = _client(monkeypatch)
batch_uuid = "b-get"
response = client.get(f"/external/registration/batches/{batch_uuid}", headers={"X-API-Key": "abc"})
assert response.status_code == 200
assert response.json()["batch_uuid"] == batch_uuid
assert "failure_category" in response.json()
assert response.json()["failure_category"] == "transient"
def test_external_registration_cancel_returns_failure_category(monkeypatch):
monkeypatch.setattr(
registration_routes,
"_cancel_external_batch",
lambda batch_uuid: {
"batch_uuid": batch_uuid,
"status": "cancelled",
"failure_category": None,
},
)
client = _client(monkeypatch)
batch_uuid = "b-cancel"
response = client.post(f"/external/registration/batches/{batch_uuid}/cancel", headers={"X-API-Key": "abc"})
assert response.status_code == 200
assert "failure_category" in response.json()
assert response.json()["failure_category"] is None
def test_external_registration_idempotent_replay_returns_failure_category(monkeypatch):
monkeypatch.setattr(
registration_routes,
"_create_external_batch",
lambda payload, background_tasks=None: {
"batch_uuid": "b-idempotent",
"status": "failed",
"requested_count": 1,
"failure_category": "transient",
"idempotent_replay": True,
},
)
client = _client(monkeypatch)
payload = {
"count": 1,
"idempotency_key": "unique-key",
"email": {"type": "temp_mail"},
"upload": {"enabled": False},
"execution": {"mode": "pipeline", "concurrency": 1, "interval_min": 0, "interval_max": 0},
}
response = client.post("/external/registration/batches", headers={"X-API-Key": "abc"}, json=payload)
assert response.status_code == 200
assert response.json()["idempotent_replay"] is True
assert response.json()["failure_category"] == "transient"
def test_external_registration_get_backfills_legacy_failed_batch_failure_category(monkeypatch):
manager = _make_db("external_api_routes_backfill_get.db")
service = ExternalBatchService()
with manager.session_scope() as session:
_seed_temp_mail(session)
request = ExternalBatchCreateRequest(
count=1,
idempotency_key=None,
email_type="temp_mail",
email_service_id=None,
upload_enabled=False,
upload_provider=None,
upload_service_id=None,
mode="pipeline",
concurrency=1,
interval_min=0,
interval_max=0,
)
with manager.session_scope() as session:
batch = service.create_batch(session, request)
item = external_batch_crud.list_batch_items(session, batch.batch_uuid)[0]
external_batch_crud.update_batch(
session,
batch.batch_uuid,
status="failed",
failure_reason=None,
failure_category=None,
)
external_batch_crud.update_batch_item(
session,
item.id,
status="failed",
failure_reason="no_available_email_service",
)
@contextmanager
def _db_context():
session = manager.SessionLocal()
try:
yield session
finally:
session.close()
monkeypatch.setattr("src.database.session.get_db", _db_context)
client = _client(monkeypatch)
response = client.get(f"/external/registration/batches/{batch.batch_uuid}", headers={"X-API-Key": "abc"})
with manager.session_scope() as session:
refreshed = external_batch_crud.get_batch_by_uuid(session, batch.batch_uuid)
assert response.status_code == 200
assert response.json()["failure_category"] == "transient"
assert refreshed.failure_category == "transient"
|