Files
roboco/tests/unit/models/test_sandbox_engines_parity.py
T
8f6dde9a50 feat(sandbox): pluggable per-engine registry (postgres/redis/mongo) (#324)
* feat(sandbox): pluggable per-engine registry (postgres/redis/mongo)

Replaces the hardcoded postgres+redis branches in the provisioner and the
env emitter with a registry of SandboxEngine specs (image, run args,
readiness probe, connection, ROBOCO_TEST_* env) in a pure low module
(roboco/models/sandbox.py). VALID_SANDBOX_SERVICES is derived from the
registry — single source of truth — and the provisioner + orchestrator
iterate it, so adding an engine is one class + one registry line, not
another branch. Adds a mongo:8-alpine engine (ROBOCO_TEST_MONGO_*) as the
third service alongside postgres/redis.

Also fixes the cold-pull loop that stranded v0.19.0 board agents with
empty error strings: docker run pulled inline under a 20s deadline, so a
NAS cold pull was killed, cancelled, and re-pulled from scratch forever.
_ensure_image now inspects + pulls (300s) before run; provisioning errors
log type+message so a bare TimeoutError no longer shows as "".

Panel edit-project dialog: postgres/redis toggles -> a Set<string>
multi-select driven by a SANDBOX_SERVICES catalog, so new engines appear
in the UI by adding to the catalog.

Tests: engine parity (allowlist==registry, unique slugs/images, no None
leak in env, SandboxInfo aggregates every engine), mongo provision + env
injection, plus the existing postgres/redis provision/env/spawn/janitor
suite updated to the registry shape. 821 unit / 5 skip green; ruff + mypy
(360 files) clean.

* docs(sandbox): reflect pluggable engine registry + mongo across docs

CHANGELOG (0.19.0): Added entry for the pluggable sandbox engine registry
(postgres/redis/mongo) + Fixed entry for the cold-pull loop/empty-error
strand that boarded v0.19.0 board agents.

docs/map (9 files): sandbox subsystem blurbs, SandboxProvisioner rows,
_maybe_provision_sandbox/_append_sandbox_env rows, feature-flag rows, the
migration-057 row + v0.17.0 delta, and the models.md VALID_SANDBOX_SERVICES
note — all retitled to DB/Redis/Mongo via the engine registry
(roboco/models/sandbox.py), with the one-class-one-line extension story and
the _ensure_image cold-pull fix. Production-network (roboco_data) lines left
as postgres+redis — mongo is sandbox-only, not a prod service.

docs/rag (3 files): sandbox-db.md rewritten around the registry (engine list,
generic _provision_engine, image pre-pull, ROBOCO_TEST_DB_*/REDIS_*/MONGO_*
incl. MONGO_AUTH_DB=admin, single emit_env); config-reference sandbox flag
row + subsection retitled; db-network-isolation framing broadened to
postgres/redis/mongo. preconditions-and-rejections left untouched (its hit
was an unrelated gateway see-also link).

* test(e2e): harden umbrella close terminal reads with bounded wait-for-state

The MegaTask umbrella close test flaked once on CI (ceo-approve returned
200 but the re-fetch saw awaiting_pm_review) then passed on re-run. The
production path is deterministic: complete -> main_pm_complete ->
submit_pm_review -> escalate_to_ceo -> ceo_approve -> commit, all on one
session, all awaited; the fire-and-forget completion hooks are isolated
(own session, best-effort, never touch task.status or the request session).
20 local runs could not reproduce it.

The one real surface is the read pattern: the e2e stack commits on the
uvicorn thread's loop and reads via a separate loop (run_db -> asyncio.run
with a fresh engine), so a terminal single point-read can race a
still-draining completion hook on a contended runner. Replace the two
terminal point-reads with a bounded wait_for_status poll. Strictly better
than a one-shot read: absorbs the transient, and a genuine state bug still
surfaces via the timeout branch asserting against the last-read state.

---------

Co-authored-by: Renn F <rennf93@users.noreply.github.com>
2026-07-07 13:59:53 +02:00

53 lines
1.9 KiB
Python

"""Engine registry / allowlist parity + per-engine internal consistency.
The valid-service allowlist is derived from the registry
(``VALID_SANDBOX_SERVICES = frozenset(SANDBOX_ENGINES)``), so the two must stay
in lockstep — a drift guard against adding an engine class without registering
it (or vice versa). Each engine's emitted env must also reference only the
connection fields it actually populates (no ``None`` leaking into an env value).
"""
from __future__ import annotations
from roboco.models.sandbox import (
SANDBOX_ENGINES,
VALID_SANDBOX_SERVICES,
SandboxInfo,
)
_ENV_HOST_PREFIX = {
"postgres": "ROBOCO_TEST_DB_HOST",
"redis": "ROBOCO_TEST_REDIS_HOST",
"mongo": "ROBOCO_TEST_MONGO_HOST",
}
def test_allowlist_matches_registry() -> None:
assert frozenset(SANDBOX_ENGINES) == VALID_SANDBOX_SERVICES
assert set(SANDBOX_ENGINES) == {"postgres", "redis", "mongo"}
def test_each_engine_has_unique_container_slug_and_image() -> None:
slugs = {e.container_slug for e in SANDBOX_ENGINES.values()}
images = {e.image for e in SANDBOX_ENGINES.values()}
assert len(slugs) == len(SANDBOX_ENGINES)
assert len(images) == len(SANDBOX_ENGINES)
def test_each_engine_emit_env_references_only_populated_fields() -> None:
# An engine that does not set `user`/`database` must not emit a `None` value.
for engine in SANDBOX_ENGINES.values():
conn = engine.connection(host=f"h-{engine.name}", password="pw")
env = " ".join(engine.emit_env(conn))
assert "None" not in env, f"{engine.name} leaked None into env: {env}"
def test_sandbox_info_emit_env_aggregates_every_engine() -> None:
services = {
name: engine.connection(host=f"h-{name}", password="pw")
for name, engine in SANDBOX_ENGINES.items()
}
flat = " ".join(SandboxInfo(services=services).emit_env())
for name in SANDBOX_ENGINES:
assert _ENV_HOST_PREFIX[name] in flat