hermes-agent/tests/hermes_cli/test_dashboard_web_dist_validation.py
Teknium 18a3fa57bd fix(dashboard): attempt one recovery build when --skip-build finds no dist
--skip-build with a missing web_dist/index.html previously hard-failed
with sys.exit(1) (issue #59288). The desktop launcher passes
--build-mode skip on every boot, so a wiped or never-populated dist
bricked the dashboard until the user manually rebuilt.

Now the default-dist path logs a clear warning and attempts exactly ONE
recovery build through the existing _build_web_ui path. If the recovery
build also fails to produce index.html, the original fatal behavior is
preserved with a clear message. A custom HERMES_WEB_DIST stays fail-fast:
the build writes to the default dist location and cannot populate a
caller-managed directory.

Closes #59288
2026-07-21 12:41:41 -07:00

248 lines
7.9 KiB
Python

"""Regression tests: `hermes dashboard` validates HERMES_WEB_DIST before serving.
A custom HERMES_WEB_DIST without --skip-build previously skipped BOTH the
build and any validation, so the server started and served 404s with no
obvious cause (same failure mode as issue #23817, reached via the env-var
path instead of --skip-build). The env-var branch must now fail fast when
the dist has no index.html, and proceed when it does.
Design credit: PR #17845 (@Caelier).
"""
import sys
import types
import pytest
@pytest.fixture()
def main_mod():
import hermes_cli.main as main
return main
def _args(**over):
base = {
"host": "127.0.0.1",
"port": 0,
"no_open": True,
"open_profile": None,
"skip_build": False,
"headless_backend": False,
"tui": False,
}
base.update(over)
return types.SimpleNamespace(**base)
def _wire_common(main_mod, monkeypatch):
monkeypatch.setattr(
"hermes_cli.profiles.get_active_profile_name", lambda: "default"
)
monkeypatch.setattr(main_mod, "_sync_bundled_skills_quietly", lambda: None)
monkeypatch.setitem(sys.modules, "fastapi", types.SimpleNamespace())
monkeypatch.setitem(sys.modules, "uvicorn", types.SimpleNamespace())
monkeypatch.setitem(
sys.modules,
"hermes_logging",
types.SimpleNamespace(setup_logging=lambda **_k: None),
)
monkeypatch.setitem(
sys.modules,
"hermes_cli.plugins",
types.SimpleNamespace(discover_plugins=lambda: None),
)
monkeypatch.setattr(
"hermes_cli.mcp_startup.start_background_mcp_discovery",
lambda **_k: None,
)
def test_env_dist_without_index_exits(main_mod, monkeypatch, tmp_path, capsys):
"""HERMES_WEB_DIST pointing at a dist with no index.html must exit 1,
not start a server that 404s."""
_wire_common(main_mod, monkeypatch)
empty_dist = tmp_path / "empty_dist"
empty_dist.mkdir()
monkeypatch.setenv("HERMES_WEB_DIST", str(empty_dist))
started = []
monkeypatch.setitem(
sys.modules,
"hermes_cli.web_server",
types.SimpleNamespace(start_server=lambda **k: started.append(k)),
)
builds = []
monkeypatch.setattr(
main_mod, "_build_web_ui", lambda *a, **k: builds.append(a) or True
)
with pytest.raises(SystemExit) as exc:
main_mod.cmd_dashboard(_args())
assert exc.value.code == 1
assert started == []
assert builds == [] # env var set -> build skipped, validation is the gate
out = capsys.readouterr().out
assert "HERMES_WEB_DIST" in out and str(empty_dist) in out
def test_env_dist_with_index_starts_server(main_mod, monkeypatch, tmp_path):
"""A valid HERMES_WEB_DIST (has index.html) proceeds to start_server
without building."""
_wire_common(main_mod, monkeypatch)
dist = tmp_path / "dist"
dist.mkdir()
(dist / "index.html").write_text("<html></html>", encoding="utf-8")
monkeypatch.setenv("HERMES_WEB_DIST", str(dist))
started = []
monkeypatch.setitem(
sys.modules,
"hermes_cli.web_server",
types.SimpleNamespace(start_server=lambda **k: started.append(k)),
)
builds = []
monkeypatch.setattr(
main_mod, "_build_web_ui", lambda *a, **k: builds.append(a) or True
)
main_mod.cmd_dashboard(_args())
assert len(started) == 1
assert builds == []
def test_env_dist_tilde_expanded_for_web_server(main_mod, monkeypatch, tmp_path):
"""A '~/...' HERMES_WEB_DIST must be written back expanded so
web_server's raw os.environ read serves the validated path."""
_wire_common(main_mod, monkeypatch)
home = tmp_path / "home"
dist = home / "mydist"
dist.mkdir(parents=True)
(dist / "index.html").write_text("<html></html>", encoding="utf-8")
monkeypatch.setenv("HOME", str(home))
monkeypatch.setenv("HERMES_WEB_DIST", "~/mydist")
monkeypatch.setitem(
sys.modules,
"hermes_cli.web_server",
types.SimpleNamespace(start_server=lambda **k: None),
)
main_mod.cmd_dashboard(_args())
import os
assert os.environ["HERMES_WEB_DIST"] == str(dist)
# ---------------------------------------------------------------------------
# --skip-build recovery (issue #59288): a missing dist under --skip-build
# should warn and attempt ONE recovery build via _build_web_ui before the
# fatal exit, instead of hard-failing immediately.
# ---------------------------------------------------------------------------
def test_skip_build_missing_dist_attempts_one_recovery_build(
main_mod, monkeypatch, tmp_path, capsys
):
"""--skip-build + missing index.html triggers exactly one recovery build;
when the build produces a dist, the server starts."""
_wire_common(main_mod, monkeypatch)
monkeypatch.delenv("HERMES_WEB_DIST", raising=False)
project_root = tmp_path / "proj"
dist = project_root / "hermes_cli" / "web_dist"
dist.mkdir(parents=True)
monkeypatch.setattr(main_mod, "PROJECT_ROOT", project_root)
started = []
monkeypatch.setitem(
sys.modules,
"hermes_cli.web_server",
types.SimpleNamespace(start_server=lambda **k: started.append(k)),
)
builds = []
def fake_build(web_dir, *, fatal=False):
builds.append((web_dir, fatal))
(dist / "index.html").write_text("<html></html>", encoding="utf-8")
return True
monkeypatch.setattr(main_mod, "_build_web_ui", fake_build)
main_mod.cmd_dashboard(_args(skip_build=True))
assert len(builds) == 1 # exactly ONE recovery build
assert builds[0][0] == project_root / "web"
assert len(started) == 1
out = capsys.readouterr().out
assert "recovery build" in out.lower()
def test_skip_build_recovery_build_failure_preserves_fatal_exit(
main_mod, monkeypatch, tmp_path, capsys
):
"""When the recovery build also fails to produce a dist, the original
fatal path is preserved: exit 1, clear message, server never starts."""
_wire_common(main_mod, monkeypatch)
monkeypatch.delenv("HERMES_WEB_DIST", raising=False)
project_root = tmp_path / "proj"
(project_root / "hermes_cli" / "web_dist").mkdir(parents=True)
monkeypatch.setattr(main_mod, "PROJECT_ROOT", project_root)
started = []
monkeypatch.setitem(
sys.modules,
"hermes_cli.web_server",
types.SimpleNamespace(start_server=lambda **k: started.append(k)),
)
builds = []
monkeypatch.setattr(
main_mod,
"_build_web_ui",
lambda web_dir, *, fatal=False: builds.append(web_dir) or False,
)
with pytest.raises(SystemExit) as exc:
main_mod.cmd_dashboard(_args(skip_build=True))
assert exc.value.code == 1
assert len(builds) == 1 # attempted once, never retried
assert started == []
out = capsys.readouterr().out
assert "--skip-build was passed but no web dist found" in out
assert "recovery build did not produce a usable dist" in out
def test_skip_build_custom_env_dist_missing_does_not_attempt_recovery(
main_mod, monkeypatch, tmp_path, capsys
):
"""A custom HERMES_WEB_DIST is caller-managed: the recovery build writes
to the default dist location and cannot populate it, so the env-var +
--skip-build combination keeps the immediate fatal exit with no build."""
_wire_common(main_mod, monkeypatch)
empty_dist = tmp_path / "custom_dist"
empty_dist.mkdir()
monkeypatch.setenv("HERMES_WEB_DIST", str(empty_dist))
started = []
monkeypatch.setitem(
sys.modules,
"hermes_cli.web_server",
types.SimpleNamespace(start_server=lambda **k: started.append(k)),
)
builds = []
monkeypatch.setattr(
main_mod, "_build_web_ui", lambda *a, **k: builds.append(a) or True
)
with pytest.raises(SystemExit) as exc:
main_mod.cmd_dashboard(_args(skip_build=True))
assert exc.value.code == 1
assert builds == []
assert started == []
out = capsys.readouterr().out
assert "--skip-build was passed but no web dist found" in out