hermes-agent/tests/agent/test_display_tool_failure.py

"""Tests for _detect_tool_failure + _trim_error + get_cute_tool_message
inline failure suffix rendering.

Covers the user-visible promise: when a tool fails, the CLI shows a short,
specific reason in square brackets at the end of the completion line —
not a generic "[error]".
"""

import json

from agent.display import (
    _detect_tool_failure,
    _trim_error,
    _ERROR_SUFFIX_MAX_LEN,
    get_cute_tool_message,
)


class TestTrimError:
    """The helper that shrinks an error message for inline display."""

    def test_short_message_unchanged(self):
        assert _trim_error("nope") == "nope"


    def test_long_message_truncated_to_cap(self):
        msg = "x" * 200
        trimmed = _trim_error(msg)
        assert len(trimmed) <= _ERROR_SUFFIX_MAX_LEN
        assert trimmed.endswith("...")

    def test_file_not_found_path_collapsed_to_filename(self):
        long_path = "File not found: /home/teknium/.hermes/hermes-agent/very/deep/path/foo.py"
        assert _trim_error(long_path) == "File not found: foo.py"




class TestDetectToolFailureTerminal:
    """terminal: non-zero exit_code is the canonical failure signal."""

    def test_success_returns_no_suffix(self):
        result = json.dumps({"output": "ok\n", "exit_code": 0})
        assert _detect_tool_failure("terminal", result) == (False, "")


    def test_nonzero_exit_with_error_shows_message(self):
        result = json.dumps({
            "output": "",
            "exit_code": 127,
            "error": "ls: cannot access 'foo': No such file or directory",
        })
        is_failure, suffix = _detect_tool_failure("terminal", result)
        assert is_failure is True
        assert "cannot access" in suffix
        # Trimmed to the cap, in brackets
        assert suffix.startswith(" [")
        assert suffix.endswith("]")

    def test_degraded_backend_shows_full_reason_and_retry_hint(self):
        """A degraded backend (Docker down, SSH host unreachable) is an infrastructure problem: the user
        needs the whole reason plus the fix hint, not the 48-char trimmed 'Terminal backend degraded: ...'."""
        result = json.dumps({
            "output": "", "exit_code": -1, "status": "degraded",
            "reason": "Docker daemon is not reachable at unix:///var/run/docker.sock",
            "retry_hint": "Start Docker, or run `hermes setup terminal` to switch to Local, then retry",
            "error": "Terminal backend degraded: Docker daemon is not reachable at unix:///var/run/docker.sock",
        })
        is_failure, suffix = _detect_tool_failure("terminal", result)
        assert is_failure is True
        assert "unix:///var/run/docker.sock" in suffix
        assert "hermes setup terminal" in suffix
        assert "Terminal backend degraded:" not in suffix

    def test_nonzero_dict_result_is_a_failure(self):
        """An already-parsed terminal result (a plugin tool_execution middleware may hand back the
        dict instead of the JSON string) must classify like its JSON form (#111815)."""
        is_failure, suffix = _detect_tool_failure("terminal", {"exit_code": 2})
        assert is_failure is True
        assert suffix == " [exit 2]"

    def test_multimodal_envelope_dict_is_still_a_success(self):
        envelope = {"_multimodal": True, "content": [{"type": "text", "text": "screenshot taken"}]}
        assert _detect_tool_failure("browser_exec", envelope) == (False, "")

    def test_degraded_backend_without_hint_shows_reason_alone(self):
        result = json.dumps({"output": "", "exit_code": -1, "status": "degraded",
                             "reason": "SSH connection to bob@host timed out", "retry_hint": "",
                             "error": "Terminal backend degraded: SSH connection to bob@host timed out"})
        _, suffix = _detect_tool_failure("terminal", result)
        assert suffix == " [SSH connection to bob@host timed out]"


class TestDetectToolFailureMemory:
    """memory: 'full' is distinct from real errors."""

    def test_memory_full_returns_full_suffix(self):
        result = json.dumps({"success": False, "error": "would exceed the limit"})
        assert _detect_tool_failure("memory", result) == (True, " [full]")

    def test_memory_other_error_returns_specific_message(self):
        # An error that's NOT a "full" overflow falls through to the
        # structured-error path and surfaces the actual message.
        result = json.dumps({"success": False, "error": "invalid action: zap"})
        is_failure, suffix = _detect_tool_failure("memory", result)
        assert is_failure is True
        assert "invalid action" in suffix


class TestDetectToolFailureStructured:
    """Generic path: any tool that returns {"error": ...} JSON."""

    def test_read_file_error_surfaced(self):
        result = json.dumps({
            "path": "/nope/missing.py",
            "success": False,
            "error": "File not found: /nope/missing.py",
        })
        is_failure, suffix = _detect_tool_failure("read_file", result)
        assert is_failure is True
        # _trim_error reduces the path to the basename.
        assert suffix == " [File not found: missing.py]"



    def test_successful_result_not_flagged(self):
        result = json.dumps({"success": True, "data": "hello"})
        assert _detect_tool_failure("web_search", result) == (False, "")



class TestGetCuteToolMessageFailureSuffix:
    """End-to-end: failure suffix is appended by get_cute_tool_message."""




    def test_memory_full_suffix(self):
        fail = json.dumps({"success": False, "error": "would exceed the limit"})
        line = get_cute_tool_message(
            "memory",
            {"action": "add", "target": "memory", "content": "x"},
            0.05,
            result=fail,
        )
        assert "[full]" in line

    def test_success_has_no_suffix(self):
        ok = json.dumps({"success": True, "data": "hi"})
        line = get_cute_tool_message("web_search", {"query": "hi"}, 0.2, result=ok)
        assert "[" not in line.split("0.2s", 1)[1]