Files
vmware-api-simulator/app/web/routes.py
T
inecs 229a705987 Add SemVer VERSION, Jenkins CI/CD, and release 0.1.1.
Ship Harbor/Hub push with latest+version tags, deploy to vmware.devops.org.ru, and show the package version badge in Help → About.
2026-07-28 00:57:11 +03:00

377 lines
14 KiB
Python

"""Browser console for exercising the simulator API."""
from __future__ import annotations
from pathlib import Path
from typing import Annotated
from asyncpg import Pool # type: ignore[import-untyped]
from fastapi import APIRouter, HTTPException, Query, Request
from fastapi.responses import HTMLResponse, JSONResponse
from app.api.registry import HandlerRegistry
from app.config import Settings
from app.contracts.runtime import apply_runtime_contract_locked, contract_store_root
from app.contracts.source import SourceError
from app.db.pool import AsyncpgDatabase
from app.dependencies import get_database
from app.simulation.seed import apply_seed, build_profile, simulation_state_summary
from app.web.assets import compact_console_html, console_html
from app.web.compatibility_catalog import compatibility_payload
from app.version import get_app_version
from app.web.contract_catalog import catalog_payload, list_majors, load_snapshot, method_payload
router = APIRouter(tags=["Simulator"])
@router.get("/", response_class=HTMLResponse, include_in_schema=True)
async def console() -> HTMLResponse:
"""Interactive API console and cluster overview."""
return HTMLResponse(
console_html(),
headers={"Cache-Control": "no-store"},
)
@router.get("/console.html", response_class=HTMLResponse, include_in_schema=False)
async def compact_console() -> HTMLResponse:
"""Compact session console for quick REST smoke."""
return HTMLResponse(
compact_console_html(),
headers={"Cache-Control": "no-store"},
)
def _use_vsphere_plane(request: Request) -> bool:
settings = _settings(request)
return settings is None or not bool(getattr(settings, "enable_pve_stub", False))
@router.get("/ui/api/versions", include_in_schema=False)
async def ui_versions(request: Request) -> JSONResponse:
settings = _settings(request)
runtime_version = _runtime_version(request)
if _use_vsphere_plane(request):
from app.vsphere.contracts.catalog import list_vsphere_majors
payload = list_vsphere_majors(runtime_version=runtime_version)
else:
payload = list_majors(runtime_version=runtime_version, settings=settings)
if isinstance(payload, dict):
payload = {**payload, "app_version": get_app_version()}
return JSONResponse(payload)
@router.get("/ui/api/catalog", include_in_schema=False)
async def ui_catalog(
request: Request,
major: Annotated[int, Query(ge=6, le=9)],
) -> JSONResponse:
if _use_vsphere_plane(request):
from app.vsphere.contracts.catalog import vsphere_catalog_payload
return JSONResponse(vsphere_catalog_payload(major))
settings = _settings(request)
try:
snapshot = await load_snapshot(major, _store_root(request), settings=settings)
except SourceError as error:
raise HTTPException(status_code=503, detail=str(error)) from error
implemented = getattr(request.app.state, "implemented_methods", None)
return JSONResponse(
catalog_payload(snapshot, major, implemented_methods=implemented, settings=settings)
)
@router.get("/ui/api/method", include_in_schema=False)
async def ui_method(
request: Request,
major: Annotated[int, Query(ge=6, le=9)],
path: Annotated[str, Query(min_length=1)],
verb: Annotated[str, Query(min_length=1)],
) -> JSONResponse:
if _use_vsphere_plane(request):
from app.vsphere.contracts.catalog import vsphere_method_payload
return JSONResponse(
vsphere_method_payload(
major=major,
path=path,
verb=verb,
runtime_version=_runtime_version(request),
)
)
settings = _settings(request)
try:
snapshot = await load_snapshot(major, _store_root(request), settings=settings)
except SourceError as error:
raise HTTPException(status_code=503, detail=str(error)) from error
runtime_version = _runtime_version(request)
implemented = getattr(request.app.state, "implemented_methods", None)
try:
payload = method_payload(
snapshot,
major=major,
path=path,
verb=verb,
runtime_version=runtime_version,
implemented_methods=implemented,
)
except KeyError as error:
raise HTTPException(status_code=404, detail=f"unknown contract method: {error}") from error
return JSONResponse(payload)
@router.get("/ui/api/compatibility", include_in_schema=False)
async def ui_compatibility(
request: Request,
major: Annotated[int, Query(ge=6, le=9)],
) -> JSONResponse:
if _use_vsphere_plane(request):
from app.vsphere.contracts.compatibility import vsphere_compatibility_payload
return JSONResponse(
vsphere_compatibility_payload(
major,
runtime_version=_runtime_version(request),
)
)
settings = _settings(request)
try:
snapshot = await load_snapshot(major, _store_root(request), settings=settings)
except SourceError as error:
raise HTTPException(status_code=503, detail=str(error)) from error
implemented = getattr(request.app.state, "implemented_methods", None)
runtime_report = getattr(request.app.state, "compatibility_report", None)
runtime_version = _runtime_version(request)
return JSONResponse(
compatibility_payload(
snapshot,
major,
implemented_methods=implemented,
runtime_report=runtime_report,
runtime_version=runtime_version,
settings=settings,
)
)
@router.post("/ui/api/contract/apply", include_in_schema=False)
async def ui_contract_apply(
request: Request,
major: Annotated[int, Query(ge=6, le=9)],
) -> JSONResponse:
"""Hot-swap the in-memory runtime contract to a catalog major (memory-only)."""
if _use_vsphere_plane(request):
from app.vsphere.contracts.matrix import VERSIONS, catalog_entries_for_major
meta = VERSIONS.get(major) or VERSIONS[9]
entries = catalog_entries_for_major(major)
request.app.state.vsphere_contract_major = major
request.app.state.runtime_source_version = meta["version"]
request.app.state.vsphere_implemented_methods = {(e["verb"], e["path"]) for e in entries}
return JSONResponse(
{
"ok": True,
"major": major,
"runtime_version": meta["version"],
"plane": "vsphere-rest",
"path_count": len({e["path"] for e in entries}),
"method_count": len(entries),
}
)
settings = _settings(request)
handlers = getattr(request.app.state, "handlers", None)
if (
settings is None
or settings.contract_snapshot is None
or not isinstance(handlers, HandlerRegistry)
):
raise HTTPException(status_code=503, detail="runtime contract is not available")
store_root = _store_root(request)
try:
snapshot = await load_snapshot(major, store_root, settings=settings)
except SourceError as error:
raise HTTPException(status_code=503, detail=str(error)) from error
await apply_runtime_contract_locked(
request.app,
snapshot,
handlers=handlers,
store_root=store_root,
fallback=settings.contract_fallback,
settings=settings,
require_evidence_match=False,
register_admin=True,
)
method_count = sum(len(path.methods) for path in snapshot.paths)
return JSONResponse(
{
"ok": True,
"major": major,
"runtime_version": snapshot.source_version,
"path_count": len(snapshot.paths),
"method_count": method_count,
}
)
@router.get("/ui/api/demo/state", include_in_schema=False)
async def ui_demo_state(request: Request) -> JSONResponse:
from app.vsphere.seed import vsphere_state_summary
settings = _settings(request)
try:
vsphere = await vsphere_state_summary(get_database(request))
except Exception as error:
raise HTTPException(status_code=503, detail=f"database is not ready: {error}") from error
if settings is not None and getattr(settings, "enable_pve_stub", False):
try:
pool = _database_pool(request)
except Exception as error:
raise HTTPException(status_code=503, detail=str(error)) from error
async with pool.acquire() as connection:
pve = await simulation_state_summary(connection)
profile = vsphere.get("profile_hint") or "minimal"
loaded = profile in {"small", "large", "big", "demo-cluster", "demo", "enterprise"}
return JSONResponse(
{
"vsphere": vsphere,
"proxmox_stub": pve,
"loaded": loaded,
"label": f"{vsphere.get('hosts', 0)} hosts · {vsphere.get('vms', 0)} VMs",
"profile": profile,
}
)
profile = vsphere.get("profile_hint") or "minimal"
loaded = profile in {"small", "large", "big", "demo-cluster", "demo", "enterprise"}
return JSONResponse(
{
"vsphere": vsphere,
"loaded": loaded,
"label": f"{vsphere.get('hosts', 0)} hosts · {vsphere.get('vms', 0)} VMs",
"profile": profile,
}
)
@router.post("/ui/api/demo/load", include_in_schema=False)
async def ui_demo_load(request: Request) -> JSONResponse:
from app.vsphere.seed import seed_vsphere_inventory
settings = _settings(request)
summary: dict = {}
size_raw = request.query_params.get("size") or request.query_params.get("profile")
if not size_raw:
try:
body = await request.json()
except Exception:
body = {}
if isinstance(body, dict):
size_raw = body.get("size") or body.get("profile")
profile_name = str(size_raw or "large").strip().lower() or "large"
if profile_name in {"demo-cluster", "demo", "enterprise"}:
profile_name = "big"
if profile_name not in {"small", "large", "big"}:
raise HTTPException(
status_code=400,
detail=f"unknown size {profile_name!r}; sizes: small, large, big",
)
if settings is not None and getattr(settings, "enable_pve_stub", False):
pool = _database_pool(request)
pve_name = "demo-cluster" if profile_name == "big" else profile_name
try:
profile = build_profile(pve_name)
except Exception:
profile = build_profile("demo-cluster")
async with pool.acquire() as connection:
await apply_seed(connection, profile)
summary = await simulation_state_summary(connection)
try:
vsphere = await seed_vsphere_inventory(
get_database(request), force=True, profile=profile_name
)
except Exception as error:
raise HTTPException(status_code=503, detail=f"database is not ready: {error}") from error
return JSONResponse(
{"ok": True, "profile": profile_name, "summary": summary, "vsphere": vsphere}
)
@router.post("/ui/api/demo/unload", include_in_schema=False)
async def ui_demo_unload(request: Request) -> JSONResponse:
"""Reset seed, wiping API-created state first."""
from app.vsphere.seed import seed_vsphere_inventory
settings = _settings(request)
summary: dict = {}
profile_name = "minimal"
try:
if settings is not None and getattr(settings, "enable_pve_stub", False):
pool = _database_pool(request)
profile = build_profile("minimal")
async with pool.acquire() as connection:
await apply_seed(connection, profile)
summary = await simulation_state_summary(connection)
profile_name = profile.name
vsphere = await seed_vsphere_inventory(get_database(request), force=True, profile="minimal")
except HTTPException:
raise
except Exception as error:
raise HTTPException(
status_code=503, detail=f"failed to remove demo data: {error}"
) from error
return JSONResponse(
{"ok": True, "profile": profile_name, "summary": summary, "vsphere": vsphere}
)
@router.post("/ui/api/vsphere/seed", include_in_schema=False)
async def ui_vsphere_seed(request: Request) -> JSONResponse:
"""(Re)seed native vSphere inventory used by /api and /sdk."""
from app.vsphere.seed import seed_vsphere_inventory
profile = request.query_params.get("profile") or "large"
try:
result = await seed_vsphere_inventory(get_database(request), force=True, profile=profile)
except Exception as error:
raise HTTPException(status_code=500, detail=str(error)) from error
return JSONResponse({"ok": True, **result})
def _database_pool(request: Request) -> Pool:
database = get_database(request)
if not isinstance(database, AsyncpgDatabase):
raise HTTPException(status_code=503, detail="database is not available")
return database.pool
def _settings(request: Request) -> Settings | None:
return getattr(request.app.state, "settings", None)
def _runtime_version(request: Request) -> str | None:
active = getattr(request.app.state, "runtime_source_version", None)
if isinstance(active, str) and active:
return active
settings = _settings(request)
if settings is None or settings.contract_snapshot is None:
return None
from app.contracts.model import Snapshot
snapshot = Snapshot.model_validate_json(settings.contract_snapshot.read_bytes())
return snapshot.source_version
def _store_root(request: Request) -> Path:
stored = getattr(request.app.state, "contract_store_root", None)
if isinstance(stored, Path):
return stored
settings = _settings(request)
if settings is not None:
return contract_store_root(settings)
return Path("contracts")