Files
hermes-agent/tests/tools/test_tool_backend_helpers.py
alt-glitch c4635985a0 refactor(core): delete unreached send_message actions, clarify/session helpers and backend aliases
Removed. A search for callers by name, attribute and string (Python, TypeScript,
docs, the plugin API list and the frozen old-updater list) finds no supported
path that reaches any of them:
- tools/send_message_tool.py: _handle_list, _handle_react and the action
  dispatch in send_message_tool (every caller, including the external
  hermes-snooze plugin, passes action="send")
- tools/bot_failure_reasons.py: is_auto_retryable
- tools/clarify_gateway.py: _notify_cbs, _coerce_text_response,
  attempt_text_response_for_session, resolve_text_response_for_session
- tools/cronjob_tools.py: the unused task_id parameter of cronjob()
- tools/interrupt.py: is_thread_yield_requested
- toolsets.py: create_custom_toolset
- tools/tool_backend_helpers.py: prefers_gateway, REMOVED_BACKENDS,
  removed_backend_note, normalize_modal_mode (callers use coerce_modal_mode)
- hermes_cli/config_value_checks.py: _validate_web_backends (only read the
  always-empty REMOVED_BACKENDS map)

Tests that existed only for these symbols are deleted; tests that also
cover live behaviour now call the canonical live names
(attempt_text_response, _coerce_text_response_detailed, consume_yield).

The shared-bot route-gate tests that reached the gate through the deleted
react action now call _shared_bot_target_allowed directly, so the origin
rules (guild-only, thread-under-channel and user_id routes, Telegram topics,
the turn's sender in a shared channel) keep their coverage. The two error
hints and one comment that named send_message(action='list') now name
`hermes send --list`; the stale send_message row in the zh-Hans tools
reference goes.

Also:
- test_messaging_slash_command_fifo spies on clarify_gateway.attempt_text_response,
  the name gateway/run_inbound.py calls, so its [clarify] case can fail again
- send_message_tool: an action other than 'send' returns an error that names
  `hermes send --list` for listing targets
- multi-profile-gateways.md no longer says send_message sends reactions; the zh-Hans
  simplex.md and tools-reference.md match the English pages
2026-11-16 15:40:08 +05:30

273 lines
11 KiB
Python

"""Unit tests for tools/tool_backend_helpers.py.
Tests cover:
- managed_nous_tools_enabled() subscription-based gate
- normalize_browser_cloud_provider() coercion
- coerce_modal_mode() validation
- has_direct_modal_credentials() detection
- resolve_modal_backend_state() backend selection matrix
- resolve_openai_audio_api_key() priority chain
"""
from __future__ import annotations
from pathlib import Path
from unittest.mock import patch
import pytest
from hermes_cli.nous_account import NousPaidServiceAccessInfo, NousPortalAccountInfo
from tools.tool_backend_helpers import (
coerce_modal_mode,
has_direct_modal_credentials,
managed_nous_tools_enabled,
nous_tool_gateway_unavailable_message,
normalize_browser_cloud_provider,
resolve_modal_backend_state,
resolve_openai_audio_api_key,
)
def _raise_import():
raise ImportError("simulated missing module")
# ---------------------------------------------------------------------------
# managed_nous_tools_enabled
# ---------------------------------------------------------------------------
class TestManagedNousToolsEnabled:
"""Subscription-based gate: True for paid Nous subscribers."""
def test_disabled_when_not_logged_in(self, monkeypatch):
monkeypatch.setattr(
"hermes_cli.nous_account.get_nous_portal_account_info",
lambda: NousPortalAccountInfo(logged_in=False, source="none", fresh=False),
)
assert managed_nous_tools_enabled() is False
def test_returns_false_on_exception(self, monkeypatch):
"""Should never crash — returns False on any exception."""
monkeypatch.setattr(
"hermes_cli.nous_account.get_nous_portal_account_info",
_raise_import,
)
assert managed_nous_tools_enabled() is False
class TestNousToolGatewayUnavailableMessage:
def test_uses_entitlement_reason_for_logged_in_user(self, monkeypatch):
monkeypatch.setattr(
"hermes_cli.nous_account.get_nous_portal_account_info",
lambda force_fresh=False: NousPortalAccountInfo(
logged_in=True,
source="account_api",
fresh=True,
paid_service_access=False,
portal_base_url="https://portal.example.test",
paid_service_access_info=NousPaidServiceAccessInfo(
allowed=False,
reason="no_usable_credits",
has_active_subscription=True,
active_subscription_is_paid=True,
subscription_credits_remaining=0,
purchased_credits_remaining=0,
total_usable_credits=0,
),
),
)
message = nous_tool_gateway_unavailable_message("managed image generation")
assert "credits are exhausted" in message
assert "managed image generation" in message
assert "https://portal.example.test/billing" in message
# ---------------------------------------------------------------------------
# normalize_browser_cloud_provider
# ---------------------------------------------------------------------------
class TestNormalizeBrowserCloudProvider:
"""Coerce arbitrary input to a lowercase browser provider key."""
def test_none_returns_default(self):
assert normalize_browser_cloud_provider(None) == "local"
# ---------------------------------------------------------------------------
# coerce_modal_mode
# ---------------------------------------------------------------------------
class TestCoerceModalMode:
"""Validate and coerce the requested modal execution mode."""
@pytest.mark.parametrize("value", ["auto", "direct", "managed"])
def test_valid_modes_passthrough(self, value):
assert coerce_modal_mode(value) == value
def test_none_returns_auto(self):
assert coerce_modal_mode(None) == "auto"
def test_strips_whitespace(self):
assert coerce_modal_mode(" managed ") == "managed"
# ---------------------------------------------------------------------------
# has_direct_modal_credentials
# ---------------------------------------------------------------------------
class TestHasDirectModalCredentials:
"""Detect Modal credentials via env vars or config file."""
def test_no_env_no_file(self, monkeypatch, tmp_path):
monkeypatch.delenv("MODAL_TOKEN_ID", raising=False)
monkeypatch.delenv("MODAL_TOKEN_SECRET", raising=False)
with patch.object(Path, "home", return_value=tmp_path):
assert has_direct_modal_credentials() is False
def test_only_token_secret_not_enough(self, monkeypatch, tmp_path):
monkeypatch.delenv("MODAL_TOKEN_ID", raising=False)
monkeypatch.setenv("MODAL_TOKEN_SECRET", "sec-456")
with patch.object(Path, "home", return_value=tmp_path):
assert has_direct_modal_credentials() is False
def test_env_vars_take_priority_over_file(self, monkeypatch, tmp_path):
monkeypatch.setenv("MODAL_TOKEN_ID", "id-123")
monkeypatch.setenv("MODAL_TOKEN_SECRET", "sec-456")
(tmp_path / ".modal.toml").touch()
with patch.object(Path, "home", return_value=tmp_path):
assert has_direct_modal_credentials() is True
def test_home_dir_permission_denied(self, monkeypatch):
"""PermissionError on Path.home() should not crash (issue #33525)."""
monkeypatch.delenv("MODAL_TOKEN_ID", raising=False)
monkeypatch.delenv("MODAL_TOKEN_SECRET", raising=False)
with patch.object(Path, "home", side_effect=PermissionError("denied")):
assert has_direct_modal_credentials() is False
def test_home_dir_permission_denied_with_env_vars(self, monkeypatch):
"""PermissionError on Path.home() should not prevent env var detection."""
monkeypatch.setenv("MODAL_TOKEN_ID", "id-123")
monkeypatch.setenv("MODAL_TOKEN_SECRET", "sec-456")
with patch.object(Path, "home", side_effect=PermissionError("denied")):
assert has_direct_modal_credentials() is True
# ---------------------------------------------------------------------------
# resolve_modal_backend_state
# ---------------------------------------------------------------------------
class TestResolveModalBackendState:
"""Full matrix of direct vs managed Modal backend selection."""
@staticmethod
def _resolve(monkeypatch, mode, *, has_direct, managed_ready, nous_enabled=False):
"""Helper to call resolve_modal_backend_state with feature flag control."""
monkeypatch.setattr(
"tools.tool_backend_helpers.managed_nous_tools_enabled",
lambda: nous_enabled,
)
return resolve_modal_backend_state(
mode, has_direct=has_direct, managed_ready=managed_ready
)
# --- auto mode ---
def test_auto_prefers_managed_when_available(self, monkeypatch):
result = self._resolve(monkeypatch, "auto", has_direct=True, managed_ready=True, nous_enabled=True)
assert result["selected_backend"] == "managed"
# --- direct mode ---
def test_direct_selects_direct_when_available(self, monkeypatch):
result = self._resolve(monkeypatch, "direct", has_direct=True, managed_ready=True, nous_enabled=True)
assert result["selected_backend"] == "direct"
def test_direct_none_when_no_credentials(self, monkeypatch):
result = self._resolve(monkeypatch, "direct", has_direct=False, managed_ready=True, nous_enabled=True)
assert result["selected_backend"] is None
# --- managed mode ---
def test_managed_blocked_when_nous_disabled(self, monkeypatch):
result = self._resolve(monkeypatch, "managed", has_direct=True, managed_ready=True, nous_enabled=False)
assert result["selected_backend"] is None
assert result["managed_mode_blocked"] is True
# --- return structure ---
# --- invalid mode falls back to auto ---
def test_invalid_mode_treated_as_auto(self, monkeypatch):
result = self._resolve(monkeypatch, "bogus", has_direct=True, managed_ready=False)
assert result["requested_mode"] == "auto"
assert result["mode"] == "auto"
# ---------------------------------------------------------------------------
# resolve_openai_audio_api_key
# ---------------------------------------------------------------------------
class TestResolveOpenaiAudioApiKey:
"""Priority: VOICE_TOOLS_OPENAI_KEY > OPENAI_API_KEY."""
def test_voice_key_preferred(self, monkeypatch):
monkeypatch.setenv("VOICE_TOOLS_OPENAI_KEY", "voice-key")
monkeypatch.setenv("OPENAI_API_KEY", "general-key")
assert resolve_openai_audio_api_key() == "voice-key"
def test_strips_whitespace(self, monkeypatch):
monkeypatch.setenv("VOICE_TOOLS_OPENAI_KEY", " voice-key ")
monkeypatch.delenv("OPENAI_API_KEY", raising=False)
assert resolve_openai_audio_api_key() == "voice-key"
# ---------------------------------------------------------------------------
# resolve_openai_audio_api_key — profile secret scope
# ---------------------------------------------------------------------------
class TestResolveOpenaiAudioApiKeyIsProfileScoped:
"""The key this returns authenticates the TTS/STT client.
In a multiplex gateway ``os.environ`` holds whichever profile's ``.env``
loaded at boot, not the profile the current turn belongs to — so a raw
read here would let one profile's voice reply or voice-note transcription
run on (and be billed to) another profile's OpenAI account. Same contract
``agent/vertex_adapter`` and the WeChat send path already follow.
"""
@pytest.fixture(autouse=True)
def _reset_multiplex(self):
from agent import secret_scope as ss
ss.set_multiplex_active(False)
yield
ss.set_multiplex_active(False)
def test_scope_wins_over_another_profiles_environ(self, monkeypatch):
from agent import secret_scope as ss
monkeypatch.delenv("VOICE_TOOLS_OPENAI_KEY", raising=False)
monkeypatch.setenv("OPENAI_API_KEY", "sk-other-profile")
ss.set_multiplex_active(True)
token = ss.set_secret_scope({"OPENAI_API_KEY": "sk-this-profile"})
try:
assert resolve_openai_audio_api_key() == "sk-this-profile", (
"voice/STT authenticated with another profile's OpenAI key"
)
finally:
ss.reset_secret_scope(token)
def test_single_profile_still_reads_environ(self, monkeypatch):
"""Control: no multiplexing, no scope — unchanged behaviour."""
monkeypatch.delenv("VOICE_TOOLS_OPENAI_KEY", raising=False)
monkeypatch.setenv("OPENAI_API_KEY", "sk-plain")
assert resolve_openai_audio_api_key() == "sk-plain"