mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-30 06:41:51 +00:00
b044c1ac29
PR #30136 review caught: `hermes gateway start` (no `-p`) inside the container resolves `_profile_suffix() == ""` → service name `gateway-default`, but no such slot was ever registered. The Phase 4 profile-create hook only fired on `hermes profile create <name>`, and the root profile (which lives at the top of $HERMES_HOME, not under `profiles/`) was never one of those. So bare `hermes gateway start` landed on `s6-svc -u /run/service/gateway-default` → uncaught `CalledProcessError` → traceback to the user. Changes: 1. `reconcile_profile_gateways` now always registers a `gateway-default` slot before iterating named profiles. Its prior state is read from `$HERMES_HOME/gateway_state.json` (sibling to the profile root, not under `profiles/`); stale runtime files there are swept the same way. Auto-up only if the prior state was `running` — same rule as named profiles. 2. `S6ServiceManager._render_run_script` special-cases `profile == "default"` to emit `hermes gateway run` with NO `-p` flag. Passing `-p default` would resolve to `$HERMES_HOME/profiles/default/` — a different profile that almost certainly doesn't exist. The empty profile-suffix convention is the dispatcher's contract and the run script has to match. 3. A user-created `profiles/default/` collides with the reserved root-profile slot; the reconciler now skips it with a warning rather than producing two registrations of the same service name. Action-list ordering is stable: `default` first, then named profiles in directory order. Boot-log readers can rely on this. Tests: 8 new dedicated default-slot tests plus updates to every existing test that asserted against the action list (via the new `_named_actions` helper that drops the always-present default entry).
421 lines
15 KiB
Python
421 lines
15 KiB
Python
"""Tests for hermes_cli.container_boot — the cont-init.d-time
|
|
reconciliation that recreates per-profile gateway s6 service slots
|
|
from the persistent profiles directory.
|
|
|
|
These tests run against a fake $HERMES_HOME under tmp_path; no real
|
|
s6 supervision tree is required. The in-container integration test
|
|
covering end-to-end "docker restart" survival lives in
|
|
tests/docker/test_container_restart.py.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from hermes_cli.container_boot import (
|
|
ReconcileAction,
|
|
reconcile_profile_gateways,
|
|
)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Fixtures + helpers
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _make_profile(
|
|
hermes_home: Path,
|
|
name: str,
|
|
*,
|
|
state: str | None,
|
|
with_pid: bool = False,
|
|
config: bool = True,
|
|
) -> Path:
|
|
"""Create a fake profile directory under hermes_home/profiles/<name>/."""
|
|
p = hermes_home / "profiles" / name
|
|
p.mkdir(parents=True)
|
|
if config:
|
|
# SOUL.md is what the reconciler keys on — it's always seeded by
|
|
# `hermes profile create`. See container_boot._render_run_script.
|
|
(p / "SOUL.md").write_text("# fake profile\n")
|
|
if state is not None:
|
|
(p / "gateway_state.json").write_text(json.dumps({
|
|
"gateway_state": state, "timestamp": 1234567890,
|
|
}))
|
|
if with_pid:
|
|
(p / "gateway.pid").write_text(json.dumps(
|
|
{"pid": 99999, "host": "old-container"},
|
|
))
|
|
(p / "processes.json").write_text("[]")
|
|
return p
|
|
|
|
|
|
def _seed_default_root(
|
|
hermes_home: Path,
|
|
*,
|
|
state: str | None = None,
|
|
with_pid: bool = False,
|
|
) -> None:
|
|
"""Populate gateway_state.json / stale runtime files at the
|
|
HERMES_HOME root (the implicit default profile)."""
|
|
if state is not None:
|
|
(hermes_home / "gateway_state.json").write_text(json.dumps({
|
|
"gateway_state": state, "timestamp": 1234567890,
|
|
}))
|
|
if with_pid:
|
|
(hermes_home / "gateway.pid").write_text(json.dumps(
|
|
{"pid": 99999, "host": "old-container"},
|
|
))
|
|
(hermes_home / "processes.json").write_text("[]")
|
|
|
|
|
|
def _named_actions(actions: list[ReconcileAction]) -> list[ReconcileAction]:
|
|
"""Drop the always-present default-profile action so tests that
|
|
only care about named profiles can assert against a clean list."""
|
|
return [a for a in actions if a.profile != "default"]
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Tests
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_running_profile_is_registered_and_autostarted(tmp_path: Path) -> None:
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "coder", state="running")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert _named_actions(actions) == [ReconcileAction(
|
|
profile="coder", prior_state="running", action="started",
|
|
)]
|
|
svc = scandir / "gateway-coder"
|
|
assert (svc / "run").exists()
|
|
assert (svc / "run").stat().st_mode & 0o111 # executable
|
|
assert (svc / "type").read_text().strip() == "longrun"
|
|
# Auto-start means no down-marker.
|
|
assert not (svc / "down").exists()
|
|
|
|
|
|
def test_stopped_profile_is_registered_but_not_started(tmp_path: Path) -> None:
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "writer", state="stopped")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert _named_actions(actions) == [ReconcileAction(
|
|
profile="writer", prior_state="stopped", action="registered",
|
|
)]
|
|
# down marker tells s6-svscan to NOT start the service.
|
|
assert (scandir / "gateway-writer" / "down").exists()
|
|
|
|
|
|
def test_startup_failed_does_not_autostart(tmp_path: Path) -> None:
|
|
"""Avoid crash-loop on restart when the gateway was failing to boot."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "broken", state="startup_failed")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
named = _named_actions(actions)
|
|
assert named[0].action == "registered"
|
|
assert (scandir / "gateway-broken" / "down").exists()
|
|
|
|
|
|
def test_starting_state_does_not_autostart(tmp_path: Path) -> None:
|
|
"""`starting` means the gateway died mid-boot last time; treat as
|
|
failed, not as a candidate for auto-restart."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "unlucky", state="starting")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
named = _named_actions(actions)
|
|
assert named[0].action == "registered"
|
|
|
|
|
|
def test_stale_runtime_files_are_removed(tmp_path: Path) -> None:
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
profile = _make_profile(tmp_path, "coder", state="running", with_pid=True)
|
|
assert (profile / "gateway.pid").exists()
|
|
assert (profile / "processes.json").exists()
|
|
|
|
reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert not (profile / "gateway.pid").exists()
|
|
assert not (profile / "processes.json").exists()
|
|
|
|
|
|
def test_profile_without_state_file_is_registered_but_not_started(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
"""A freshly-created profile that's never been started: register
|
|
its slot but don't auto-start."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "fresh", state=None)
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert _named_actions(actions) == [ReconcileAction(
|
|
profile="fresh", prior_state=None, action="registered",
|
|
)]
|
|
assert (scandir / "gateway-fresh" / "down").exists()
|
|
|
|
|
|
def test_directory_without_marker_file_is_skipped(tmp_path: Path) -> None:
|
|
"""A stray dir under profiles/ that isn't actually a profile (no
|
|
SOUL.md — the marker the reconciler keys on) should be skipped."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
# Create a profile dir but without SOUL.md
|
|
(tmp_path / "profiles" / "stray").mkdir(parents=True)
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert _named_actions(actions) == []
|
|
assert not (scandir / "gateway-stray").exists()
|
|
|
|
|
|
def test_corrupt_state_file_treated_as_no_prior_state(tmp_path: Path) -> None:
|
|
"""If gateway_state.json is malformed JSON, don't blow up the whole
|
|
reconciliation — register the slot in the down state."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
profile = _make_profile(tmp_path, "junk", state="running")
|
|
(profile / "gateway_state.json").write_text("{ not valid json")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
named = _named_actions(actions)
|
|
assert named[0].action == "registered" # not "started"
|
|
assert (scandir / "gateway-junk" / "down").exists()
|
|
|
|
|
|
def test_reconcile_log_is_written(tmp_path: Path) -> None:
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "a", state="running")
|
|
_make_profile(tmp_path, "b", state="stopped")
|
|
|
|
reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
log = (tmp_path / "logs" / "container-boot.log").read_text()
|
|
assert "profile=a" in log
|
|
assert "action=started" in log
|
|
assert "profile=b" in log
|
|
assert "action=registered" in log
|
|
|
|
|
|
def test_dry_run_makes_no_filesystem_changes(tmp_path: Path) -> None:
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
profile = _make_profile(tmp_path, "coder", state="running", with_pid=True)
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=True,
|
|
)
|
|
|
|
# The action list is still produced...
|
|
assert _named_actions(actions) == [ReconcileAction(
|
|
profile="coder", prior_state="running", action="started",
|
|
)]
|
|
# ...but nothing on disk was touched.
|
|
assert (profile / "gateway.pid").exists() # not removed under dry_run
|
|
assert not (scandir / "gateway-coder").exists()
|
|
assert not (tmp_path / "logs" / "container-boot.log").exists()
|
|
|
|
|
|
def test_missing_profiles_root_still_registers_default_slot(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
"""When $HERMES_HOME/profiles doesn't exist (fresh install), the
|
|
reconciliation should still register a gateway-default slot for
|
|
the root profile and return without raising. Previously this
|
|
returned an empty list; the default slot is now always present
|
|
so `hermes gateway start` (no -p) has somewhere to land."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
assert actions == [ReconcileAction(
|
|
profile="default", prior_state=None, action="registered",
|
|
)]
|
|
assert (scandir / "gateway-default").is_dir()
|
|
assert (scandir / "gateway-default" / "down").exists()
|
|
|
|
|
|
def test_invalid_profile_name_in_directory_raises(tmp_path: Path) -> None:
|
|
"""A profile dir whose name doesn't match validate_profile_name's
|
|
rules (uppercase, etc.) must surface as a hard error rather than
|
|
silently produce an invalid s6 service dir."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "BadName", state="running")
|
|
with pytest.raises(ValueError):
|
|
reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Default-profile slot — always registered (PR #30136 review item I1)
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def test_default_slot_always_registered_on_empty_home(tmp_path: Path) -> None:
|
|
"""Bare HERMES_HOME with nothing under it still produces a
|
|
gateway-default slot (down state)."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert actions == [ReconcileAction(
|
|
profile="default", prior_state=None, action="registered",
|
|
)]
|
|
svc = scandir / "gateway-default"
|
|
assert svc.is_dir()
|
|
assert (svc / "run").exists()
|
|
assert (svc / "down").exists()
|
|
|
|
|
|
def test_default_slot_run_script_omits_profile_flag(tmp_path: Path) -> None:
|
|
"""The default slot's run script must NOT pass `-p default` —
|
|
that would resolve to $HERMES_HOME/profiles/default/ instead of
|
|
the root profile. It must call `hermes gateway run` directly."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
|
|
reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
run = (scandir / "gateway-default" / "run").read_text()
|
|
assert "hermes gateway run" in run
|
|
assert "-p default" not in run
|
|
assert "-p 'default'" not in run
|
|
|
|
|
|
def test_default_slot_autostarts_when_root_state_running(tmp_path: Path) -> None:
|
|
"""gateway_state.json at the HERMES_HOME root with state=running
|
|
means the default slot auto-starts on container boot."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_seed_default_root(tmp_path, state="running")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
default_action = next(a for a in actions if a.profile == "default")
|
|
assert default_action.prior_state == "running"
|
|
assert default_action.action == "started"
|
|
assert not (scandir / "gateway-default" / "down").exists()
|
|
|
|
|
|
def test_default_slot_does_not_autostart_when_root_state_stopped(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_seed_default_root(tmp_path, state="stopped")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
default_action = next(a for a in actions if a.profile == "default")
|
|
assert default_action.action == "registered"
|
|
assert (scandir / "gateway-default" / "down").exists()
|
|
|
|
|
|
def test_default_slot_does_not_autostart_when_root_state_startup_failed(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
"""Crash-loop guard applies to the default slot too."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_seed_default_root(tmp_path, state="startup_failed")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
default_action = next(a for a in actions if a.profile == "default")
|
|
assert default_action.action == "registered"
|
|
|
|
|
|
def test_default_slot_cleans_up_stale_runtime_files_at_root(
|
|
tmp_path: Path,
|
|
) -> None:
|
|
"""gateway.pid and processes.json at the HERMES_HOME root (left
|
|
over from the previous container's default gateway) must be
|
|
swept the same way as for named profiles."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_seed_default_root(tmp_path, state="running", with_pid=True)
|
|
assert (tmp_path / "gateway.pid").exists()
|
|
|
|
reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert not (tmp_path / "gateway.pid").exists()
|
|
assert not (tmp_path / "processes.json").exists()
|
|
|
|
|
|
def test_default_slot_appears_before_named_profiles(tmp_path: Path) -> None:
|
|
"""The action list is ordered: default first, then named profiles
|
|
in directory order. Operators and the boot-log reader rely on
|
|
this ordering being stable."""
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "z-last-alphabetically", state="stopped")
|
|
_make_profile(tmp_path, "a-first-alphabetically", state="stopped")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
assert [a.profile for a in actions] == [
|
|
"default",
|
|
"a-first-alphabetically",
|
|
"z-last-alphabetically",
|
|
]
|
|
|
|
|
|
def test_profiles_default_subdir_is_skipped_with_warning(
|
|
tmp_path: Path,
|
|
caplog: pytest.LogCaptureFixture,
|
|
) -> None:
|
|
"""A user-created profiles/default/ collides with the reserved
|
|
root-profile slot — the named entry is skipped (with a warning)
|
|
so we don't double-register gateway-default."""
|
|
import logging
|
|
caplog.set_level(logging.WARNING)
|
|
scandir = tmp_path / "run-service"; scandir.mkdir()
|
|
_make_profile(tmp_path, "default", state="running")
|
|
|
|
actions = reconcile_profile_gateways(
|
|
hermes_home=tmp_path, scandir=scandir, dry_run=False,
|
|
)
|
|
|
|
# Only the root-profile default slot appears — not the colliding
|
|
# named profile.
|
|
default_actions = [a for a in actions if a.profile == "default"]
|
|
assert len(default_actions) == 1
|
|
# And the warning surfaces so operators know the named profile
|
|
# was ignored.
|
|
assert any(
|
|
"profiles/default/" in record.message for record in caplog.records
|
|
)
|