roboco/tests/unit/runtime/test_secretary_spawn_shutdown.py

"""The Secretary non-blocking spawn registers the instance in ``_instances``
only at the END of ``docker run``; if shutdown arrives mid-spawn the container
must be removed and the registration aborted, or ``stop()`` (which iterates only
``_instances``) leaks an orphaned container into a shutting-down registry.
"""

from __future__ import annotations

import asyncio
from pathlib import Path
from types import SimpleNamespace
from typing import TYPE_CHECKING, Any
from unittest.mock import patch
from uuid import UUID

import pytest
from roboco.runtime.orchestrator import (
    SECRETARY_AGENT_ID,
    AgentOrchestrator,
)
from roboco.services import prompter_live

if TYPE_CHECKING:
    from collections.abc import Iterator


def _make_orchestrator() -> AgentOrchestrator:
    """AgentOrchestrator with constructor I/O skipped; a RUNNING minimal one."""
    with patch.object(AgentOrchestrator, "__init__", return_value=None):
        orch = AgentOrchestrator.__new__(AgentOrchestrator)
    orch._instances = {}
    orch._bg_tasks = set()
    orch._running = True
    # Concurrent secretary starts serialize on this lock; the constructor
    # (skipped here) initializes it.
    orch._secretary_spawn_lock = asyncio.Lock()
    return orch


def _wire_secretary_spawn_mocks(
    monkeypatch: pytest.MonkeyPatch,
    orch: AgentOrchestrator,
    removed: list[str],
    *,
    flip_running_on_run: bool,
) -> None:
    """Patch every external boundary _spawn_secretary_container touches."""

    async def _noop(*_a: Any, **_k: Any) -> None:
        return None

    async def _route(_aid: str) -> Any:
        return SimpleNamespace(
            provider_type=SimpleNamespace(value="anthropic"),
            model_name="opus",
            base_url=None,
            auth_token=None,
        )

    async def _run(_cmd: list[str]) -> str:
        if flip_running_on_run:
            # Shutdown arrives AFTER docker run started the container but BEFORE
            # the registration line runs.
            orch._running = False
        return "containerid0123456789"

    async def _remove(name: str, **_kw: Any) -> None:
        removed.append(name)

    monkeypatch.setattr(
        orch,
        "_generate_composed_prompt",
        lambda *_a, **_k: Path("/tmp/secretary-prompt.md"),
    )
    monkeypatch.setattr(orch, "_resolve_agent_route", _route)
    monkeypatch.setattr(orch, "_ensure_agent_image", _noop)
    monkeypatch.setattr(orch, "_remove_container", _remove)
    monkeypatch.setattr(orch, "_run_container_cmd", _run)
    monkeypatch.setattr(
        orch,
        "_resolve_secretary_host_paths",
        lambda: {"claude": "/h/.claude", "prompt": "/h/p.md"},
    )
    monkeypatch.setattr(orch, "_record_spawn_session", _noop)
    monkeypatch.setattr(orch, "_fire_audit", lambda **_k: None)
    # issue_agent_token + AGENTS are imported INSIDE _spawn_secretary_container;
    # patch them at their source so the spec construction doesn't touch crypto /
    # the real agent table.
    monkeypatch.setattr(
        "roboco.agents_config.issue_agent_token", lambda *_a, **_k: "tok"
    )
    monkeypatch.setattr(
        "roboco.foundation.identity.AGENTS",
        {
            SECRETARY_AGENT_ID: SimpleNamespace(
                uuid=UUID("00000000-0000-0000-0000-000000000001"),
                team=SimpleNamespace(value="board"),
            )
        },
    )


@pytest.fixture(autouse=True)
def _fresh_registry() -> Iterator[None]:
    """Isolate the process-wide live registry per test."""
    prev = prompter_live._RegistryHolder.instance
    prompter_live._RegistryHolder.instance = prompter_live.PrompterLiveRegistry()
    yield
    prompter_live._RegistryHolder.instance = prev


@pytest.mark.asyncio
async def test_shutdown_mid_spawn_removes_container_and_skips_registration(
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    """docker run completes, THEN ``_running`` flips to False before the
    registration line. The just-started Secretary container must be removed and
    NOT registered — otherwise it is orphaned (live, untracked by stop())."""
    orch = _make_orchestrator()
    removed: list[str] = []
    _wire_secretary_spawn_mocks(monkeypatch, orch, removed, flip_running_on_run=True)

    registry = prompter_live.get_live_registry()
    pushed: list[tuple[str, dict[str, Any]]] = []
    closed: list[str] = []
    monkeypatch.setattr(registry, "push", lambda sid, ev: pushed.append((sid, ev)))
    monkeypatch.setattr(registry, "close", closed.append)
    registry.open("sess-sec-orphan", SECRETARY_AGENT_ID)

    await orch._spawn_secretary_container_guarded(
        "sess-sec-orphan", initial_message=None
    )

    # Two removes: the pre-spawn reap of any stale container, then the
    # post-docker-run shutdown guard reaping the just-started one. Without the
    # guard there is only ONE remove and the just-started container is orphaned.
    assert removed == [
        f"roboco-agent-{SECRETARY_AGENT_ID}",
        f"roboco-agent-{SECRETARY_AGENT_ID}",
    ]
    # No instance registered — stop()'s _instances iteration has already run.
    assert SECRETARY_AGENT_ID not in orch._instances
    # Shutdown is not a user-facing failure: relay closes silently, no error.
    assert pushed == []
    assert closed == ["sess-sec-orphan"]


@pytest.mark.asyncio
async def test_secretary_spawn_adds_compose_labels_before_image(
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    """When the orchestrator resolves its own compose project, the persistent
    Secretary container carries it too — spliced in right before the
    trailing image element (docker run flags must precede the image)."""
    orch = _make_orchestrator()
    removed: list[str] = []
    _wire_secretary_spawn_mocks(monkeypatch, orch, removed, flip_running_on_run=False)

    captured: list[list[str]] = []

    async def _run_capture(cmd: list[str]) -> str:
        captured.append(cmd)
        return "containerid0123456789"

    monkeypatch.setattr(orch, "_run_container_cmd", _run_capture)

    async def _fake_label_args(service: str) -> list[str]:
        return ["--label", f"com.docker.compose.service={service}"]

    monkeypatch.setattr(
        "roboco.runtime.orchestrator.compose_label_args", _fake_label_args
    )

    await orch.spawn_secretary_session("sess-labels", initial_message=None)

    assert len(captured) == 1
    cmd = captured[0]
    assert cmd[-3] == "--label"
    assert cmd[-2] == f"com.docker.compose.service={SECRETARY_AGENT_ID}"


@pytest.mark.asyncio
async def test_secretary_spawn_omits_compose_labels_outside_compose(
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    """The real helper returns [] outside a compose stack — the cmd shape
    (image last) is byte-for-byte unchanged from today."""
    orch = _make_orchestrator()
    removed: list[str] = []
    _wire_secretary_spawn_mocks(monkeypatch, orch, removed, flip_running_on_run=False)

    captured: list[list[str]] = []

    async def _run_capture(cmd: list[str]) -> str:
        captured.append(list(cmd))
        return "containerid0123456789"

    monkeypatch.setattr(orch, "_run_container_cmd", _run_capture)

    async def _no_labels(_service: str) -> list[str]:
        return []

    monkeypatch.setattr("roboco.runtime.orchestrator.compose_label_args", _no_labels)

    await orch.spawn_secretary_session("sess-no-labels", initial_message=None)

    assert len(captured) == 1
    assert not any(a.startswith("com.docker.compose.") for a in captured[0])


@pytest.mark.asyncio
async def test_running_spawn_registers_normally(
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    """Sanity: when the orchestrator stays running, the Secretary spawn
    registers the instance as before — the shutdown guard does not fire."""
    orch = _make_orchestrator()
    removed: list[str] = []
    _wire_secretary_spawn_mocks(monkeypatch, orch, removed, flip_running_on_run=False)

    instance = await orch.spawn_secretary_session("sess-sec-ok", initial_message=None)

    assert orch._instances[SECRETARY_AGENT_ID] is instance
    # Only the pre-spawn reap remove — the shutdown guard did NOT remove the
    # just-started container (the orchestrator stayed running).
    assert removed == [f"roboco-agent-{SECRETARY_AGENT_ID}"]


# ---------------------------------------------------------------------------
# Concurrent Secretary starts must serialize — the single fixed Secretary agent
# id makes two concurrent ``spawn_secretary_session`` calls race on the container
# name and the ``_instances[SECRETARY_AGENT_ID]`` write. The spawn body runs
# under ``_secretary_spawn_lock`` so the second start only begins once the first
# has fully registered.
# ---------------------------------------------------------------------------


@pytest.mark.asyncio
async def test_concurrent_secretary_spawns_do_not_interleave(
    monkeypatch: pytest.MonkeyPatch,
) -> None:
    orch = _make_orchestrator()
    removed: list[str] = []
    _wire_secretary_spawn_mocks(monkeypatch, orch, removed, flip_running_on_run=False)

    # Reap the prior instance on a concurrent start: mock stop_agent so the
    # second spawn's reap doesn't need the real self._lock (not set on the
    # minimal orchestrator).
    reaped: list[str] = []

    async def _stop(aid: str, **_kw: Any) -> None:
        reaped.append(aid)

    monkeypatch.setattr(orch, "stop_agent", _stop)

    # Instrument the first await inside the spawn body (route resolution) to
    # measure how many spawns are inside the body at once. With a serializing
    # lock the second spawn is parked on lock.acquire() and can't reach the
    # route call until the first releases -> max depth 1. Without the lock both
    # spawns reach it concurrently -> max depth 2.
    in_route = 0
    max_depth = 0

    async def _route(_aid: str) -> Any:
        nonlocal in_route, max_depth
        in_route += 1
        max_depth = max(max_depth, in_route)
        await asyncio.sleep(0)  # yield so the other spawn may enter if not locked
        in_route -= 1
        return SimpleNamespace(
            provider_type=SimpleNamespace(value="anthropic"),
            model_name="opus",
            base_url=None,
            auth_token=None,
        )

    monkeypatch.setattr(orch, "_resolve_agent_route", _route)

    await asyncio.gather(
        orch.spawn_secretary_session("sess-a", initial_message=None),
        orch.spawn_secretary_session("sess-b", initial_message=None),
    )

    assert max_depth == 1  # serialized: never two spawns in the body at once
    # The second start reaped the first's registered instance (ran in order).
    assert reaped == [SECRETARY_AGENT_ID]