hermes-agent/tests/hermes_cli/test_update_stale_dashboard.py
Teknium 39975613b1
test: prune wave 2 + speed fixes — 28,106 → 19,757 test functions, suite wall 315s → 294s
Second, deeper pass over tools/gateway/hermes_cli plus first pass over
the trees wave 1 missed (acp, acp_adapter, skills, computer_use, docker,
dashboard, conformance, monitoring, secret_sources, hermes_state,
providers). Same rubric as wave 1 (AGENTS.md test policy); security,
alternation/caching invariants, issue-number regressions, and E2E kept.

Real test-quality fixes found and rooted out along the way:
- tests/tools/test_command_guards.py made real auxiliary-LLM HTTPS calls
  (DEFAULT_CONFIG smart-approval leaked in) — pinned approval
  mode=manual via autouse fixture: 17.4s → 0.4s.
- test_model_switch_custom_providers.py / test_user_providers_model_switch.py
  silently probed live provider catalogs (~2s/test) — stubbed
  cached_provider_model_ids/provider_model_ids/fetch_api_models.
- test_telegram_noise_filter.py: 15-platform copy-paste matrix over
  shared gateway.run logic → 3 representative platforms (55s → 3.9s).
- test_gateway_shutdown.py: stop()'s 5s interrupt-deadline loop spun on
  MagicMock agents — interrupt.side_effect now clears _running_agents
  (22s → 1.0s).
- test_gateway_inactivity_timeout.py poll-harness timings shrunk 3-5x
  (24s → 1.1s); test_mcp_stability.py backoff/SIGTERM-grace sleeps
  patched (15.4s → 2.5s); test_async_delegation.py negative-drain wait
  5s → 0.5s.
- test_telegram_init_deadline.py: loop-block margin restored to 1.0s
  with rationale comment — the watchdog-dump assertion needs the loop
  blocked well past deadline+grace under parallel load (flaked once in
  the 40-worker verification run at a 0.2s margin).

Verification: full hermetic suite via scripts/run_tests.sh —
2,438 files, 21,718 tests passed, 0 failed, 293.9s wall.
Suite totals vs original baseline: 46,820 → 19,757 test functions
(−57.8%), wall 583.5s → 293.9s (−50%), subprocess CPU 13,564s → 11,623s.
2026-07-29 13:39:40 -07:00

427 lines
17 KiB
Python

"""Tests for the stale-dashboard handling run at the end of ``hermes update``.
``hermes update`` detects ``hermes dashboard`` processes left over from the
previous version and kills them (SIGTERM + SIGKILL grace, or ``taskkill /F``
on Windows). Without this, the running backend silently serves stale Python
against a freshly-updated JS bundle, producing 401s / empty data.
History:
- #16872 introduced the warn-only helper (``_warn_stale_dashboard_processes``).
- #17049 fixed a Windows wmic UnicodeDecodeError crash on non-UTF-8 locales.
- This file now also covers the kill semantics that replaced the warning.
"""
from __future__ import annotations
import importlib
import os
import sys
from unittest.mock import patch, MagicMock
import pytest
from hermes_cli.main import (
_finish_dashboard_update_cleanup,
_find_stale_dashboard_pids,
_kill_stale_dashboard_processes,
_restart_managed_dashboard_service,
_warn_stale_dashboard_processes, # back-compat alias
)
@pytest.fixture(autouse=True)
def _refresh_bindings_against_live_module():
"""Rebind module-level names to the *current* ``hermes_cli.main``.
Other tests in the suite (notably ``test_env_loader.py`` and
``test_skills_subparser.py``) reload or delete ``hermes_cli.main`` from
``sys.modules``. When that happens on the same xdist worker before we
run, our top-of-file ``from hermes_cli.main import ...`` bindings end
up pointing at the *old* module object. ``patch(\"hermes_cli.main.X\")``
then patches the *new* module, but the function we call still resolves
``_find_stale_dashboard_pids`` via its stale ``__globals__``, so every
patch becomes a no-op and the kill path silently returns early.
Refreshing the bindings (and the patch target) to the live module
object — and keeping them consistent — makes the tests immune to
ordering within the worker. The fix lives in the test module because
the two pollutants above are load-bearing for their own tests.
"""
global _finish_dashboard_update_cleanup
global _find_stale_dashboard_pids
global _kill_stale_dashboard_processes
global _restart_managed_dashboard_service
global _warn_stale_dashboard_processes
live = sys.modules.get("hermes_cli.main")
if live is None:
live = importlib.import_module("hermes_cli.main")
_finish_dashboard_update_cleanup = live._finish_dashboard_update_cleanup
_find_stale_dashboard_pids = live._find_stale_dashboard_pids
_kill_stale_dashboard_processes = live._kill_stale_dashboard_processes
_restart_managed_dashboard_service = live._restart_managed_dashboard_service
_warn_stale_dashboard_processes = live._warn_stale_dashboard_processes
yield
def _ps_line(pid: int, cmd: str) -> str:
"""Format a line as it would appear in ``ps -A -o pid=,command=`` output."""
return f"{pid:>7} {cmd}"
def _ps_runner(stdout: str):
"""Build a subprocess.run side_effect that only stubs ps -A calls.
Any other subprocess.run invocation (e.g. taskkill on Windows) is
handed back as a successful no-op. This lets tests exercise the real
scan path without having to re-stub every unrelated subprocess call
made later in ``_kill_stale_dashboard_processes``.
"""
def _side_effect(args, *a, **kw):
if isinstance(args, (list, tuple)) and args and args[0] == "ps":
return MagicMock(returncode=0, stdout=stdout, stderr="")
# Any other subprocess.run (e.g. taskkill) — benign success stub.
return MagicMock(returncode=0, stdout="", stderr="")
return _side_effect
class TestFindStaleDashboardPids:
"""Unit tests for the ps/wmic-based detection step."""
def test_self_pid_excluded(self):
with patch("subprocess.run") as mock_run:
mock_run.return_value = MagicMock(
returncode=0,
stdout="\n".join([
_ps_line(os.getpid(), "python3 -m hermes_cli.main dashboard"),
_ps_line(12345, "hermes dashboard --port 9119"),
]) + "\n",
stderr="",
)
pids = _find_stale_dashboard_pids()
assert os.getpid() not in pids
assert 12345 in pids
def test_ps_timeout_returns_empty(self):
import subprocess as sp
with patch("subprocess.run", side_effect=sp.TimeoutExpired("ps", 10)):
assert _find_stale_dashboard_pids() == []
@pytest.mark.skipif(sys.platform == "win32", reason="POSIX kill semantics")
class TestKillStaleDashboardPosix:
"""Kill path on Linux / macOS: SIGTERM then SIGKILL any survivors."""
def test_sigterm_graceful_exit(self, capsys):
"""Processes that exit on SIGTERM (the probe gets ProcessLookupError)
are reported as stopped and SIGKILL is never sent."""
import signal as _signal
killed_signals: list[tuple[int, int]] = []
def fake_kill(pid, sig):
killed_signals.append((pid, sig))
if sig == 0:
# Probe after SIGTERM → "process gone".
raise ProcessLookupError
# SIGTERM itself: succeed silently.
with patch("hermes_cli.main._find_stale_dashboard_pids",
return_value=[12345, 12346]), \
patch("os.kill", side_effect=fake_kill), \
patch("time.sleep"):
result = _kill_stale_dashboard_processes()
# Both got SIGTERM.
sigterms = [pid for pid, sig in killed_signals if sig == _signal.SIGTERM]
assert sorted(sigterms) == [12345, 12346]
# No SIGKILL was needed.
assert not any(sig == _signal.SIGKILL for _, sig in killed_signals)
assert result["matched"] == [12345, 12346]
assert result["killed"] == [12345, 12346]
assert result["failed"] == []
out = capsys.readouterr().out
assert "Stopping 2 dashboard" in out
assert "✓ stopped PID 12345" in out
assert "✓ stopped PID 12346" in out
assert "Restart the dashboard" in out
def test_user_scope_restart_never_falls_back_to_system_or_sudo(self, capsys):
"""A user unit is discovered and restarted through ``systemctl --user``."""
calls: list[list[str]] = []
def fake_run(args, *a, **kw):
calls.append(list(args))
if args == ["systemctl", "--user", "list-unit-files", "hermes-dashboard.service", "--no-legend", "--no-pager"]:
return MagicMock(returncode=0, stdout="hermes-dashboard.service enabled enabled\n", stderr="")
if args == ["systemctl", "--user", "is-active", "hermes-dashboard.service"]:
return MagicMock(returncode=0, stdout="active\n", stderr="")
if args == ["systemctl", "--user", "is-enabled", "hermes-dashboard.service"]:
return MagicMock(returncode=0, stdout="enabled\n", stderr="")
if args == ["systemctl", "--user", "restart", "hermes-dashboard.service"]:
return MagicMock(returncode=0, stdout="", stderr="")
raise AssertionError(f"unexpected subprocess.run call: {args}")
with patch("subprocess.run", side_effect=fake_run), \
patch("hermes_cli.main._find_stale_dashboard_pids", return_value=[12345]) as find_pids, \
patch("os.kill") as kill:
_kill_stale_dashboard_processes(restart_managed=True)
assert calls == [
["systemctl", "--user", "list-unit-files", "hermes-dashboard.service", "--no-legend", "--no-pager"],
["systemctl", "--user", "is-active", "hermes-dashboard.service"],
["systemctl", "--user", "is-enabled", "hermes-dashboard.service"],
["systemctl", "--user", "restart", "hermes-dashboard.service"],
]
assert all(call[:1] != ["sudo"] and call[:2] != ["systemctl"] for call in calls)
find_pids.assert_not_called()
kill.assert_not_called()
assert "✓ restarted hermes-dashboard.service" in capsys.readouterr().out
class TestKillStaleDashboardWindows:
"""Kill path on Windows: taskkill /F."""
def test_taskkill_invoked_for_each_pid(self, monkeypatch, capsys):
monkeypatch.setattr(sys, "platform", "win32")
def fake_run(args, *a, **kw):
# taskkill returns 0 on success
return MagicMock(returncode=0, stdout="", stderr="")
with patch("hermes_cli.main._find_stale_dashboard_pids",
return_value=[12345, 12346]), \
patch("subprocess.run", side_effect=fake_run) as mock_run:
_kill_stale_dashboard_processes()
# Each PID triggered a taskkill /PID <n> /F invocation.
taskkill_calls = [
c for c in mock_run.call_args_list
if c.args and isinstance(c.args[0], list) and c.args[0][:1] == ["taskkill"]
]
assert len(taskkill_calls) == 2
assert ["taskkill", "/PID", "12345", "/F"] in [c.args[0] for c in taskkill_calls]
assert ["taskkill", "/PID", "12346", "/F"] in [c.args[0] for c in taskkill_calls]
out = capsys.readouterr().out
assert "✓ stopped PID 12345" in out
assert "✓ stopped PID 12346" in out
class TestBackCompatAlias:
"""``_warn_stale_dashboard_processes`` is kept as an alias for the
new kill function so old imports don't break."""
def test_alias_is_the_kill_function(self):
assert _warn_stale_dashboard_processes is _kill_stale_dashboard_processes
class TestDashboardUpdateCleanup:
"""The git and Windows ZIP update paths share this final cleanup."""
def test_all_failed_stops_do_not_claim_the_dashboard_was_stopped(self, capsys):
with patch(
"hermes_cli.main._kill_stale_dashboard_processes",
return_value={"matched": [12345], "killed": [], "failed": [(12345, "denied")],
"unrecovered": []},
):
_finish_dashboard_update_cleanup([])
assert "stopped during update" not in capsys.readouterr().out
class TestWindowsWmicEncoding:
"""Regression tests for #17049 — the Windows wmic branch must not crash
`hermes update` on non-UTF-8 system locales (e.g. cp936 on zh-CN).
"""
def test_wmic_invoked_with_utf8_ignore_errors(self, monkeypatch):
"""The wmic subprocess.run call must pass encoding='utf-8' and
errors='ignore' so the subprocess reader thread cannot raise
UnicodeDecodeError on non-UTF-8 wmic output."""
monkeypatch.setattr(sys, "platform", "win32")
with patch("subprocess.run") as mock_run:
mock_run.return_value = MagicMock(
returncode=0,
stdout=(
"CommandLine=python -m hermes_cli.main dashboard\n"
"ProcessId=12345\n"
),
stderr="",
)
_find_stale_dashboard_pids()
# The wmic call is the first subprocess.run invocation.
assert mock_run.called, "subprocess.run was not invoked"
wmic_call = mock_run.call_args_list[0]
kwargs = wmic_call.kwargs
assert kwargs.get("encoding") == "utf-8", (
"encoding kwarg must be 'utf-8' so wmic output is decoded "
"deterministically rather than via the implicit reader-thread "
"default that crashes on non-UTF-8 locales (#17049)."
)
assert kwargs.get("errors") == "ignore", (
"errors kwarg must be 'ignore' so undecodable bytes don't take "
"down the reader thread (#17049)."
)
class TestSupervisedBackendRestart:
"""After the kill, systemd-supervised PIDs get their owning unit
restarted (#68934) — SIGTERM reads as a clean stop to systemd, so
Restart=on-failure never fires on its own."""
def _live(self):
return sys.modules["hermes_cli.main"]
def test_supervised_pid_restarts_owning_unit(self, capsys):
"""A killed PID whose cgroup names a custom unit → systemctl restart."""
live = self._live()
def fake_kill(pid, sig):
if sig == 0:
raise ProcessLookupError
with patch.object(live, "_restart_managed_dashboard_service", return_value=False), \
patch.object(live, "_find_stale_dashboard_pids", return_value=[4321]), \
patch.object(live, "_get_pid_cgroup_path",
return_value="/system.slice/hermes-serve.service"), \
patch.object(live, "_get_systemd_service_for_pid",
return_value="hermes-serve.service"), \
patch.object(live, "_try_restart_systemd_service", return_value=True) as restart, \
patch("os.kill", side_effect=fake_kill), \
patch("time.sleep"):
_kill_stale_dashboard_processes(restart_managed=True)
restart.assert_called_once_with(
"hermes-serve.service", "/system.slice/hermes-serve.service"
)
out = capsys.readouterr().out
assert "✓ restarted systemd service hermes-serve.service" in out
# Supervised restart succeeded — no manual hint.
assert "when you're ready" not in out
class TestManualBackendRespawn:
"""Manually-started dashboards/serves have their argv captured before the
kill and are respawned detached after the update (#40449)."""
def _live(self):
return sys.modules["hermes_cli.main"]
def test_argv_capture_failure_falls_back_to_hint(self, capsys):
live = self._live()
def fake_kill(pid, sig):
if sig == 0:
raise ProcessLookupError
with patch.object(live, "_restart_managed_dashboard_service", return_value=False), \
patch.object(live, "_find_stale_dashboard_pids", return_value=[5555]), \
patch.object(live, "_get_pid_cgroup_path", return_value=None), \
patch.object(live, "_get_systemd_service_for_pid", return_value=None), \
patch.object(live, "_dashboard_cmdline_for_pid", return_value=None), \
patch.object(live, "_respawn_dashboard_processes") as respawn, \
patch("os.kill", side_effect=fake_kill), \
patch("time.sleep"):
_kill_stale_dashboard_processes(restart_managed=True)
respawn.assert_not_called()
out = capsys.readouterr().out
assert "Restart anything not auto-restarted" in out
def test_respawn_adds_no_open_to_dashboard_commands(self, tmp_path, monkeypatch):
"""Respawned `dashboard` argv gains --no-open; `serve` argv untouched."""
live = self._live()
monkeypatch.setenv("HERMES_HOME", str(tmp_path / ".hermes"))
spawned: list[list[str]] = []
class _FakePopen:
def __init__(self, cmd, **kwargs):
spawned.append(list(cmd))
with patch.object(live.subprocess, "Popen", _FakePopen):
failed = live._respawn_dashboard_processes([
["hermes", "dashboard", "--port", "8300"],
["hermes", "serve", "--host", "0.0.0.0"],
])
assert failed == []
assert spawned[0] == ["hermes", "dashboard", "--port", "8300", "--no-open"]
assert spawned[1] == ["hermes", "serve", "--host", "0.0.0.0"]
def test_respawn_failure_returned(self, tmp_path, monkeypatch, capsys):
live = self._live()
monkeypatch.setenv("HERMES_HOME", str(tmp_path / ".hermes"))
with patch.object(live.subprocess, "Popen", side_effect=OSError("no such file")):
failed = live._respawn_dashboard_processes([["hermes", "serve"]])
assert failed == [["hermes", "serve"]]
out = capsys.readouterr().out
assert "✗ failed to restart" in out
class TestCmdlineCapture:
"""_dashboard_cmdline_for_pid reads /proc on Linux, ps on macOS."""
def _live(self):
return sys.modules["hermes_cli.main"]
def test_reads_proc_cmdline_when_available(self, tmp_path, monkeypatch):
live = self._live()
proc_file = tmp_path / "cmdline"
proc_file.write_bytes(b"/usr/bin/python3\x00-m\x00hermes_cli.main\x00serve\x00")
real_exists = os.path.exists
def fake_exists(path):
if path == "/proc/777/cmdline":
return True
return real_exists(path)
real_open = open
def fake_open(path, *a, **kw):
if path == "/proc/777/cmdline":
return real_open(proc_file, *a, **kw)
return real_open(path, *a, **kw)
with patch.object(live.os.path, "exists", fake_exists), \
patch("builtins.open", fake_open):
argv = live._dashboard_cmdline_for_pid(777)
assert argv == ["/usr/bin/python3", "-m", "hermes_cli.main", "serve"]
def test_falls_back_to_ps_without_proc(self, monkeypatch):
live = self._live()
def fake_run(args, *a, **kw):
assert args == ["ps", "-p", "888", "-o", "command="]
return MagicMock(returncode=0, stdout="hermes serve --port 8300\n", stderr="")
with patch.object(live.os.path, "exists", return_value=False), \
patch("subprocess.run", side_effect=fake_run):
argv = live._dashboard_cmdline_for_pid(888)
assert argv == ["hermes", "serve", "--port", "8300"]
def test_returns_none_on_windows(self, monkeypatch):
live = self._live()
monkeypatch.setattr(live.sys, "platform", "win32")
assert live._dashboard_cmdline_for_pid(123) is None