common/hermes
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

feat(update): warn about legacy hermes.service units during hermes update (#11918)

Browse Source 
Follow-up to #11909: surface the legacy-unit warning where users are most
likely to see it. After a 'hermes update', if a pre-rename hermes.service
is still installed alongside the current hermes-gateway.service, print
the list of legacy units + the 'hermes gateway migrate-legacy' command.

Profile-safe: reuses _find_legacy_hermes_units() which is an explicit
allowlist of hermes.service only — profile units never match.
Platform-gated: only prints on systemd hosts (the rename is Linux-only).
Non-blocking: just prints, never prompts, so gateway-spawned
hermes update --gateway runs aren't affected.
This commit is contained in:
Teknium
2026-04-17 19:35:12 -07:00
committed by GitHub
parent 07db20c72d
commit 53e4a2f2c6
2 changed files with 209 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
hermes_cli/main.py
View File

@@ -5604,6 +5604,35 @@ def cmd_update(args):
except Exception as e:
logger.debug("Gateway restart during update failed: %s", e)
# Warn if legacy Hermes gateway unit files are still installed.
# When both hermes.service (from a pre-rename install) and the
# current hermes-gateway.service are enabled, they SIGTERM-fight
# for the same bot token (see PR #11909). Flagging here means
# every `hermes update` surfaces the issue until the user migrates.
try:
from hermes_cli.gateway import (
has_legacy_hermes_units,
_find_legacy_hermes_units,
supports_systemd_services,
)
if supports_systemd_services() and has_legacy_hermes_units():
print()
print("⚠ Legacy Hermes gateway unit(s) detected:")
for name, path, is_sys in _find_legacy_hermes_units():
scope = "system" if is_sys else "user"
print(f" {path} ({scope} scope)")
print()
print(" These pre-rename units (hermes.service) fight the current")
print(" hermes-gateway.service for the bot token and cause SIGTERM")
print(" flap loops. Remove them with:")
print()
print(" hermes gateway migrate-legacy")
print()
print(" (add `sudo` if any are in system scope)")
except Exception as e:
logger.debug("Legacy unit check during update failed: %s", e)
print()
print("Tip: You can now select a provider and model:")
print(" hermes model # Select provider and model")

180
tests/hermes_cli/test_update_gateway_restart.py
View File

@@ -935,3 +935,183 @@ class TestGatewayModeWritesExitCodeEarly:
assert exit_code_existed_at_restart, "systemctl restart was never called"
assert exit_code_existed_at_restart[0] is True, \
".update_exit_code must exist BEFORE systemctl restart (cgroup kill race)"
class TestCmdUpdateLegacyGatewayWarning:
"""Tests for the legacy hermes.service warning printed by `hermes update`.
Users who installed Hermes before the service rename often have a
dormant ``hermes.service`` that starts flap-fighting the current
``hermes-gateway.service`` after PR #5646. Every ``hermes update``
should remind them to run ``hermes gateway migrate-legacy`` until
they do.
"""
_OUR_UNIT_TEXT = (
"[Unit]\nDescription=Hermes Gateway\n[Service]\n"
"ExecStart=/usr/bin/python -m hermes_cli.main gateway run --replace\n"
)
@patch("shutil.which", return_value=None)
@patch("subprocess.run")
def test_update_prints_legacy_warning_when_detected(
self, mock_run, _mock_which, mock_args, capsys, tmp_path, monkeypatch,
):
"""Legacy units present → warning in update output with migrate command."""
user_dir = tmp_path / "user"
system_dir = tmp_path / "system"
user_dir.mkdir()
system_dir.mkdir()
legacy_path = user_dir / "hermes.service"
legacy_path.write_text(self._OUR_UNIT_TEXT, encoding="utf-8")
monkeypatch.setattr(
gateway_cli,
"_legacy_unit_search_paths",
lambda: [(False, user_dir), (True, system_dir)],
)
monkeypatch.setattr(gateway_cli, "is_macos", lambda: False)
monkeypatch.setattr(gateway_cli, "supports_systemd_services", lambda: True)
monkeypatch.setattr(gateway_cli, "is_termux", lambda: False)
mock_run.side_effect = _make_run_side_effect(commit_count="3")
with patch.object(gateway_cli, "find_gateway_pids", return_value=[]):
cmd_update(mock_args)
captured = capsys.readouterr().out
assert "Legacy Hermes gateway unit(s) detected" in captured
assert "hermes.service" in captured
assert "hermes gateway migrate-legacy" in captured
assert "(user scope)" in captured
@patch("shutil.which", return_value=None)
@patch("subprocess.run")
def test_update_silent_when_no_legacy_units(
self, mock_run, _mock_which, mock_args, capsys, tmp_path, monkeypatch,
):
"""No legacy units → no warning printed."""
user_dir = tmp_path / "user"
system_dir = tmp_path / "system"
user_dir.mkdir()
system_dir.mkdir()
monkeypatch.setattr(
gateway_cli,
"_legacy_unit_search_paths",
lambda: [(False, user_dir), (True, system_dir)],
)
monkeypatch.setattr(gateway_cli, "is_macos", lambda: False)
monkeypatch.setattr(gateway_cli, "supports_systemd_services", lambda: True)
monkeypatch.setattr(gateway_cli, "is_termux", lambda: False)
mock_run.side_effect = _make_run_side_effect(commit_count="3")
with patch.object(gateway_cli, "find_gateway_pids", return_value=[]):
cmd_update(mock_args)
captured = capsys.readouterr().out
assert "Legacy Hermes gateway" not in captured
assert "migrate-legacy" not in captured
@patch("shutil.which", return_value=None)
@patch("subprocess.run")
def test_update_does_not_flag_profile_units(
self, mock_run, _mock_which, mock_args, capsys, tmp_path, monkeypatch,
):
"""Profile units (hermes-gateway-coder.service) must not trigger the warning.
This is the core safety invariant: the legacy allowlist is
``hermes.service`` only, no globs.
"""
user_dir = tmp_path / "user"
system_dir = tmp_path / "system"
user_dir.mkdir()
system_dir.mkdir()
# Drop a profile unit that an over-eager glob would match
(user_dir / "hermes-gateway-coder.service").write_text(
self._OUR_UNIT_TEXT, encoding="utf-8"
)
(user_dir / "hermes-gateway.service").write_text(
self._OUR_UNIT_TEXT, encoding="utf-8"
)
monkeypatch.setattr(
gateway_cli,
"_legacy_unit_search_paths",
lambda: [(False, user_dir), (True, system_dir)],
)
monkeypatch.setattr(gateway_cli, "is_macos", lambda: False)
monkeypatch.setattr(gateway_cli, "supports_systemd_services", lambda: True)
monkeypatch.setattr(gateway_cli, "is_termux", lambda: False)
mock_run.side_effect = _make_run_side_effect(commit_count="3")
with patch.object(gateway_cli, "find_gateway_pids", return_value=[]):
cmd_update(mock_args)
captured = capsys.readouterr().out
assert "Legacy Hermes gateway" not in captured
assert "hermes-gateway-coder.service" not in captured # not flagged
@patch("shutil.which", return_value=None)
@patch("subprocess.run")
def test_update_skips_legacy_check_on_non_systemd_platforms(
self, mock_run, _mock_which, mock_args, capsys, tmp_path, monkeypatch,
):
"""macOS / Windows / Termux — skip check entirely since the rename
is systemd-specific."""
user_dir = tmp_path / "user"
user_dir.mkdir()
# Put a file that WOULD match if the check ran
(user_dir / "hermes.service").write_text(self._OUR_UNIT_TEXT, encoding="utf-8")
monkeypatch.setattr(
gateway_cli,
"_legacy_unit_search_paths",
lambda: [(False, user_dir), (True, tmp_path / "system")],
)
monkeypatch.setattr(gateway_cli, "is_macos", lambda: True)
monkeypatch.setattr(gateway_cli, "supports_systemd_services", lambda: False)
mock_run.side_effect = _make_run_side_effect(
commit_count="3", launchctl_loaded=False,
)
with patch.object(gateway_cli, "find_gateway_pids", return_value=[]):
cmd_update(mock_args)
captured = capsys.readouterr().out
# Must not print the warning on non-systemd platforms
assert "Legacy Hermes gateway" not in captured
@patch("shutil.which", return_value=None)
@patch("subprocess.run")
def test_update_lists_system_scope_unit_with_sudo_hint(
self, mock_run, _mock_which, mock_args, capsys, tmp_path, monkeypatch,
):
"""System-scope legacy units need sudo — the warning must point that out."""
user_dir = tmp_path / "user"
system_dir = tmp_path / "system"
user_dir.mkdir()
system_dir.mkdir()
(system_dir / "hermes.service").write_text(self._OUR_UNIT_TEXT, encoding="utf-8")
monkeypatch.setattr(
gateway_cli,
"_legacy_unit_search_paths",
lambda: [(False, user_dir), (True, system_dir)],
)
monkeypatch.setattr(gateway_cli, "is_macos", lambda: False)
monkeypatch.setattr(gateway_cli, "supports_systemd_services", lambda: True)
monkeypatch.setattr(gateway_cli, "is_termux", lambda: False)
mock_run.side_effect = _make_run_side_effect(commit_count="3")
with patch.object(gateway_cli, "find_gateway_pids", return_value=[]):
cmd_update(mock_args)
captured = capsys.readouterr().out
assert "Legacy Hermes gateway" in captured
assert "(system scope)" in captured
assert "sudo" in captured