mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-25 00:51:20 +00:00
feat(cli): add dynamic shell completion for bash, zsh, and fish
Replaces the hardcoded completion stubs in profiles.py with a dynamic generator that walks the live argparse parser tree at runtime. - New hermes_cli/completion.py: _walk() recursively extracts all subcommands and flags; generate_bash/zsh/fish() produce complete scripts with nested subcommand support - cmd_completion now accepts the parser via closure so completions always reflect the actual registered commands (including plugin- registered ones like honcho) - completion subcommand now accepts bash | zsh | fish (fish requested in issue comments) - Fix _SUBCOMMANDS set: add honcho, claw, plugins, acp, webhook, memory, dump, debug, backup, import, completion, logs so that multi-word session names after -c/-r are not broken by these commands - Add tests/hermes_cli/test_completion.py: 17 tests covering parser extraction, alias deduplication, bash/zsh/fish output content, bash syntax validation, fish syntax validation, and subcommand drift prevention Tested on Linux (Arch). bash and fish completion verified live. zsh script passes syntax check (zsh not installed on test machine). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
b21b3bfd68
commit
a686dbdd26
3 changed files with 432 additions and 8 deletions
189
tests/hermes_cli/test_completion.py
Normal file
189
tests/hermes_cli/test_completion.py
Normal file
|
|
@ -0,0 +1,189 @@
|
|||
"""Tests for hermes_cli/completion.py — shell completion script generation."""
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
import tempfile
|
||||
|
||||
import pytest
|
||||
|
||||
from hermes_cli.completion import _walk, generate_bash, generate_zsh, generate_fish
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _make_parser() -> argparse.ArgumentParser:
|
||||
"""Build a minimal parser that mirrors the real hermes structure."""
|
||||
p = argparse.ArgumentParser(prog="hermes")
|
||||
p.add_argument("--version", "-V", action="store_true")
|
||||
sub = p.add_subparsers(dest="command")
|
||||
|
||||
chat = sub.add_parser("chat", help="Interactive chat with the agent")
|
||||
chat.add_argument("-q", "--query")
|
||||
chat.add_argument("-m", "--model")
|
||||
|
||||
gw = sub.add_parser("gateway", help="Messaging gateway management")
|
||||
gw_sub = gw.add_subparsers(dest="gateway_command")
|
||||
gw_sub.add_parser("start", help="Start service")
|
||||
gw_sub.add_parser("stop", help="Stop service")
|
||||
gw_sub.add_parser("status", help="Show status")
|
||||
# alias — should NOT appear as a duplicate in completions
|
||||
gw_sub.add_parser("run", aliases=["foreground"], help="Run in foreground")
|
||||
|
||||
sess = sub.add_parser("sessions", help="Manage session history")
|
||||
sess_sub = sess.add_subparsers(dest="sessions_action")
|
||||
sess_sub.add_parser("list", help="List sessions")
|
||||
sess_sub.add_parser("delete", help="Delete a session")
|
||||
|
||||
sub.add_parser("version", help="Show version")
|
||||
|
||||
return p
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 1. Parser extraction
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestWalk:
|
||||
def test_top_level_subcommands_extracted(self):
|
||||
tree = _walk(_make_parser())
|
||||
assert set(tree["subcommands"].keys()) == {"chat", "gateway", "sessions", "version"}
|
||||
|
||||
def test_nested_subcommands_extracted(self):
|
||||
tree = _walk(_make_parser())
|
||||
gw_subs = set(tree["subcommands"]["gateway"]["subcommands"].keys())
|
||||
assert {"start", "stop", "status", "run"}.issubset(gw_subs)
|
||||
|
||||
def test_aliases_not_duplicated(self):
|
||||
"""'foreground' is an alias of 'run' — must not appear as separate entry."""
|
||||
tree = _walk(_make_parser())
|
||||
gw_subs = tree["subcommands"]["gateway"]["subcommands"]
|
||||
assert "foreground" not in gw_subs
|
||||
|
||||
def test_flags_extracted(self):
|
||||
tree = _walk(_make_parser())
|
||||
chat_flags = tree["subcommands"]["chat"]["flags"]
|
||||
assert "-q" in chat_flags or "--query" in chat_flags
|
||||
|
||||
def test_help_text_captured(self):
|
||||
tree = _walk(_make_parser())
|
||||
assert tree["subcommands"]["chat"]["help"] != ""
|
||||
assert tree["subcommands"]["gateway"]["help"] != ""
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 2. Bash output
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestGenerateBash:
|
||||
def test_contains_completion_function_and_register(self):
|
||||
out = generate_bash(_make_parser())
|
||||
assert "_hermes_completion()" in out
|
||||
assert "complete -F _hermes_completion hermes" in out
|
||||
|
||||
def test_top_level_commands_present(self):
|
||||
out = generate_bash(_make_parser())
|
||||
for cmd in ("chat", "gateway", "sessions", "version"):
|
||||
assert cmd in out
|
||||
|
||||
def test_nested_subcommands_in_case(self):
|
||||
out = generate_bash(_make_parser())
|
||||
assert "start" in out
|
||||
assert "stop" in out
|
||||
|
||||
def test_valid_bash_syntax(self):
|
||||
"""Script must pass `bash -n` syntax check."""
|
||||
out = generate_bash(_make_parser())
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".bash", delete=False) as f:
|
||||
f.write(out)
|
||||
path = f.name
|
||||
try:
|
||||
result = subprocess.run(["bash", "-n", path], capture_output=True)
|
||||
assert result.returncode == 0, result.stderr.decode()
|
||||
finally:
|
||||
os.unlink(path)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 3. Zsh output
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestGenerateZsh:
|
||||
def test_contains_compdef_header(self):
|
||||
out = generate_zsh(_make_parser())
|
||||
assert "#compdef hermes" in out
|
||||
|
||||
def test_top_level_commands_present(self):
|
||||
out = generate_zsh(_make_parser())
|
||||
for cmd in ("chat", "gateway", "sessions", "version"):
|
||||
assert cmd in out
|
||||
|
||||
def test_nested_describe_blocks(self):
|
||||
out = generate_zsh(_make_parser())
|
||||
assert "_describe" in out
|
||||
# gateway has subcommands so a _cmds array must be generated
|
||||
assert "gateway_cmds" in out
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 4. Fish output
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestGenerateFish:
|
||||
def test_disables_file_completion(self):
|
||||
out = generate_fish(_make_parser())
|
||||
assert "complete -c hermes -f" in out
|
||||
|
||||
def test_top_level_commands_present(self):
|
||||
out = generate_fish(_make_parser())
|
||||
for cmd in ("chat", "gateway", "sessions", "version"):
|
||||
assert cmd in out
|
||||
|
||||
def test_subcommand_guard_present(self):
|
||||
out = generate_fish(_make_parser())
|
||||
assert "__fish_seen_subcommand_from" in out
|
||||
|
||||
def test_valid_fish_syntax(self):
|
||||
"""Script must be accepted by fish without errors."""
|
||||
if not shutil.which("fish"):
|
||||
pytest.skip("fish not installed")
|
||||
out = generate_fish(_make_parser())
|
||||
with tempfile.NamedTemporaryFile(mode="w", suffix=".fish", delete=False) as f:
|
||||
f.write(out)
|
||||
path = f.name
|
||||
try:
|
||||
result = subprocess.run(["fish", path], capture_output=True)
|
||||
assert result.returncode == 0, result.stderr.decode()
|
||||
finally:
|
||||
os.unlink(path)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 5. Subcommand drift prevention
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestSubcommandDrift:
|
||||
def test_SUBCOMMANDS_covers_required_commands(self):
|
||||
"""_SUBCOMMANDS must include all known top-level commands so that
|
||||
multi-word session names after -c/-r are never accidentally split.
|
||||
"""
|
||||
import inspect
|
||||
from hermes_cli.main import _coalesce_session_name_args
|
||||
|
||||
source = inspect.getsource(_coalesce_session_name_args)
|
||||
match = re.search(r'_SUBCOMMANDS\s*=\s*\{([^}]+)\}', source, re.DOTALL)
|
||||
assert match, "_SUBCOMMANDS block not found in _coalesce_session_name_args()"
|
||||
defined = set(re.findall(r'"(\w+)"', match.group(1)))
|
||||
|
||||
required = {
|
||||
"chat", "model", "gateway", "setup", "login", "logout", "auth",
|
||||
"status", "cron", "config", "sessions", "version", "update",
|
||||
"uninstall", "profile", "skills", "tools", "mcp", "plugins",
|
||||
"acp", "claw", "honcho", "completion", "logs",
|
||||
}
|
||||
missing = required - defined
|
||||
assert not missing, f"Missing from _SUBCOMMANDS: {missing}"
|
||||
Loading…
Add table
Add a link
Reference in a new issue