hermes-agent/tests/gateway/test_profile_resolution.py
Burgunthy f58e4622cf fix(gateway): profile routing — conjunctive matching + universal gateway_runner
Addresses hermes-sweeper review on #20096.

Problem 1 (profile_routing.py): route matching returned True on a chat_id
hit before the guild_id constraint was consulted, so a route declaring both
guild_id and chat_id matched on chat_id alone. Restored conjunctive (AND)
semantics — every declared discriminator must hold; hierarchical parent_chat_id
matching is preserved. Added a regression test for the guild+chat case.

Problem 2 (base.py / run.py): gateway_runner was injected only when an adapter
pre-declared the attribute, and only Discord did — so build_source never called
_profile_name_for_source for Telegram/Feishu/Slack/etc., despite the
platform-generic claim. Declared gateway_runner on BasePlatformAdapter and made
the plugin-registry injection unconditional, so profile routing now reaches
every platform. Added non-Discord (Telegram) resolution coverage and an
injection-inheritance test.

Also adds docs/profile-routing.md documenting gateway.profile_routes
(matching rules, specificity, profile isolation) — requested in review.

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-15 09:50:05 -07:00

333 lines
16 KiB
Python

"""Tests for GatewayRunner._resolve_profile_home_for_source — profile resolution logic."""
import logging
from pathlib import Path
from unittest.mock import MagicMock, patch
import pytest
from gateway.session import SessionSource
from gateway.run import GatewayRunner
from gateway.profile_routing import ProfileRoute
@pytest.fixture
def mock_runner():
"""Create a minimal mock GatewayRunner with the methods we need."""
runner = MagicMock(spec=GatewayRunner)
runner.config = MagicMock(profile_routes=[])
# Bind the actual methods to the mock
runner._profile_name_for_source = GatewayRunner._profile_name_for_source.__get__(runner)
runner._resolve_profile_home_for_source = GatewayRunner._resolve_profile_home_for_source.__get__(runner)
return runner
@pytest.fixture
def discord_source():
"""Create a basic Discord SessionSource for testing."""
return SessionSource(
platform=MagicMock(value="discord"),
chat_id="123456",
guild_id="789",
thread_id=None,
parent_chat_id=None,
)
@pytest.fixture
def telegram_source():
"""Create a basic Telegram SessionSource for testing.
Telegram (like Slack/Feishu/etc.) has no ``guild_id`` — only ``chat_id``.
Used to prove profile routing is platform-generic, not Discord-only.
"""
return SessionSource(
platform=MagicMock(value="telegram"),
chat_id="-1001234567890",
guild_id=None,
thread_id=None,
parent_chat_id=None,
)
class TestResolutionOrder:
"""Tests that profile resolution follows the correct priority order."""
def test_source_profile_wins_over_routing(self, mock_runner, discord_source):
"""source.profile should be used even if routing would match."""
discord_source.profile = "from-source"
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
with patch("hermes_cli.profiles.profile_exists", return_value=True):
mock_get_dir.return_value = Path("/hermes/profiles/from-source")
result = mock_runner._resolve_profile_home_for_source(discord_source)
assert result == Path("/hermes/profiles/from-source")
mock_get_dir.assert_called_once_with("from-source")
def test_routing_wins_over_active_profile(self, mock_runner, discord_source):
"""When source.profile is empty, routing should win over active profile."""
discord_source.profile = None
# Mock routing to return a profile
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
with patch("hermes_cli.profiles.profile_exists", return_value=True):
mock_get_dir.return_value = Path("/hermes/profiles/routed")
# Manually set routing to return a profile
mock_runner._profile_name_for_source = MagicMock(return_value="routed")
result = mock_runner._resolve_profile_home_for_source(discord_source)
assert result == Path("/hermes/profiles/routed")
mock_get_dir.assert_called_once_with("routed")
def test_active_profile_fallback(self, mock_runner, discord_source):
"""When source.profile and routing both return None, active profile is used."""
discord_source.profile = None
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/active")
# No routing match
mock_runner._profile_name_for_source = MagicMock(return_value=None)
result = mock_runner._resolve_profile_home_for_source(discord_source)
assert result == Path("/hermes/profiles/active")
mock_get_dir.assert_called_once_with("active")
def test_default_fallback_when_no_active(self, mock_runner, discord_source):
"""When even active profile is None, 'default' is used."""
discord_source.profile = None
with patch("hermes_cli.profiles.get_active_profile_name", return_value=None):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes")
mock_runner._profile_name_for_source = MagicMock(return_value=None)
result = mock_runner._resolve_profile_home_for_source(discord_source)
assert result == Path("/hermes")
mock_get_dir.assert_called_once_with("default")
class TestMissingProfileWarning:
"""Tests for warning when a profile doesn't exist on disk."""
def test_nonexistent_profile_warning(self, mock_runner, discord_source, caplog):
"""When source.profile points to a nonexistent profile, log a WARNING."""
discord_source.profile = "nonexistent"
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/nonexistent")
with patch("hermes_cli.profiles.profile_exists", return_value=False):
with patch("hermes_constants.get_hermes_home", return_value=Path("/hermes")):
with caplog.at_level(logging.WARNING):
result = mock_runner._resolve_profile_home_for_source(discord_source)
# Should fall back to global HERMES_HOME
assert result == Path("/hermes")
# Should have logged a warning
assert len(caplog.records) == 1
assert caplog.records[0].levelname == "WARNING"
assert "nonexistent" in caplog.records[0].message
assert "does not exist" in caplog.records[0].message
assert "discord" in caplog.records[0].message
assert "123456" in caplog.records[0].message
def test_nonexistent_routing_profile_warning(self, mock_runner, discord_source, caplog):
"""When routing returns a nonexistent profile, log a WARNING."""
discord_source.profile = None
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/routed")
with patch("hermes_cli.profiles.profile_exists", return_value=False):
with patch("hermes_constants.get_hermes_home", return_value=Path("/hermes")):
# Routing returns a profile that doesn't exist
mock_runner._profile_name_for_source = MagicMock(return_value="routed")
with caplog.at_level(logging.WARNING):
result = mock_runner._resolve_profile_home_for_source(discord_source)
# Should fall back to global HERMES_HOME
assert result == Path("/hermes")
# Should have logged a warning
assert len(caplog.records) == 1
assert "routed" in caplog.records[0].message
def test_empty_source_profile_no_warning(self, mock_runner, discord_source, caplog):
"""When source.profile is empty, silent fallback to active profile (no warning)."""
discord_source.profile = None
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/active")
with patch("hermes_cli.profiles.profile_exists", return_value=True):
with caplog.at_level(logging.WARNING):
mock_runner._profile_name_for_source = MagicMock(return_value=None)
result = mock_runner._resolve_profile_home_for_source(discord_source)
# Should use active profile
assert result == Path("/hermes/profiles/active")
# No warnings (active profile exists)
assert not any(r.levelname == "WARNING" for r in caplog.records)
def test_existing_profile_no_warning(self, mock_runner, discord_source, caplog):
"""When the profile exists, no warning should be logged."""
discord_source.profile = "existing"
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/existing")
with patch("hermes_cli.profiles.profile_exists", return_value=True):
with caplog.at_level(logging.WARNING):
result = mock_runner._resolve_profile_home_for_source(discord_source)
assert result == Path("/hermes/profiles/existing")
# No warnings
assert not any(r.levelname == "WARNING" for r in caplog.records)
class TestExceptionHandling:
"""Tests for exception handling in profile resolution."""
def test_get_profile_dir_exception_logs_warning(self, mock_runner, discord_source, caplog):
"""When get_profile_dir raises an exception, log a WARNING with context."""
discord_source.profile = "bad-profile"
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir", side_effect=ValueError("Invalid profile name")):
with patch("hermes_constants.get_hermes_home", return_value=Path("/hermes")):
with caplog.at_level(logging.WARNING):
result = mock_runner._resolve_profile_home_for_source(discord_source)
# Should fall back to global HERMES_HOME
assert result == Path("/hermes")
# Should have logged a warning with exception info
assert len(caplog.records) == 1
assert caplog.records[0].levelname == "WARNING"
assert "bad-profile" in caplog.records[0].message
assert "Failed to resolve profile directory" in caplog.records[0].message
def test_exception_with_no_profile_name(self, mock_runner, discord_source, caplog):
"""Exception when no profile was set should still log a warning."""
discord_source.profile = None
with patch("hermes_cli.profiles.get_active_profile_name", return_value=None):
with patch("hermes_cli.profiles.get_profile_dir", side_effect=RuntimeError("Filesystem error")):
with patch("hermes_constants.get_hermes_home", return_value=Path("/hermes")):
mock_runner._profile_name_for_source = MagicMock(return_value=None)
with caplog.at_level(logging.WARNING):
result = mock_runner._resolve_profile_home_for_source(discord_source)
assert result == Path("/hermes")
# Warning should mention "(no profile)"
assert "(no profile)" in caplog.records[0].message
class TestRoutingConsultation:
"""Tests that _profile_name_for_source is consulted when source.profile is empty."""
def test_routing_consulted_when_source_profile_empty(self, mock_runner, discord_source):
"""_profile_name_for_source should be called when source.profile is empty."""
discord_source.profile = None
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/routed")
mock_runner._profile_name_for_source = MagicMock(return_value="routed")
mock_runner._resolve_profile_home_for_source(discord_source)
# Should have called routing
mock_runner._profile_name_for_source.assert_called_once_with(discord_source)
def test_routing_not_consulted_when_source_profile_set(self, mock_runner, discord_source):
"""_profile_name_for_source should NOT be called when source.profile is set."""
discord_source.profile = "from-source"
with patch("hermes_cli.profiles.get_active_profile_name", return_value="active"):
with patch("hermes_cli.profiles.get_profile_dir") as mock_get_dir:
mock_get_dir.return_value = Path("/hermes/profiles/from-source")
mock_runner._profile_name_for_source = MagicMock(return_value="routed")
mock_runner._resolve_profile_home_for_source(discord_source)
# Should NOT have called routing
mock_runner._profile_name_for_source.assert_not_called()
class TestNonDiscordProfileRouting:
"""Profile routing must be platform-generic, not Discord-only.
Regression coverage for the ``gateway_runner`` injection gap: previously
only Discord's adapter pre-declared ``gateway_runner``, so only Discord
ever had ``build_source`` call ``_profile_name_for_source``. Telegram /
Feishu / Slack / etc. silently fell through to the default profile. These
tests pin the resolution half for a non-Discord platform (Telegram).
"""
def test_telegram_route_resolves(self, mock_runner, telegram_source):
"""A configured Telegram route resolves to its profile via the real
``_profile_name_for_source`` (bound onto the mock runner)."""
mock_runner.config.profile_routes = [
ProfileRoute(name="tg", platform="telegram", profile="tg-profile",
chat_id="-1001234567890"),
]
telegram_source.profile = None
assert mock_runner._profile_name_for_source(telegram_source) == "tg-profile"
def test_telegram_no_route_returns_none(self, mock_runner, telegram_source):
"""With no matching Telegram route, resolution returns None (caller
falls back to the default/active profile)."""
mock_runner.config.profile_routes = [
ProfileRoute(name="dc", platform="discord", profile="dc-profile",
chat_id="123456"),
]
telegram_source.profile = None
assert mock_runner._profile_name_for_source(telegram_source) is None
class TestGatewayRunnerInjection:
"""``BasePlatformAdapter`` declares ``gateway_runner`` so the gateway's
unconditional injection reaches every platform adapter — the foundation
that makes the routing in TestNonDiscordProfileRouting reachable at runtime.
"""
def test_base_adapter_declares_gateway_runner(self):
from gateway.platforms.base import BasePlatformAdapter
# Class-level attribute exists and defaults to None.
assert hasattr(BasePlatformAdapter, "gateway_runner")
assert BasePlatformAdapter.gateway_runner is None
def test_subclass_inherits_gateway_runner(self):
from gateway.platforms.base import BasePlatformAdapter
class _ToyAdapter(BasePlatformAdapter):
pass
# No manual declaration — yet the attribute is inherited from the base,
# so the gateway's ``adapter.gateway_runner = self`` injection reaches
# every adapter, not just the ones that pre-declared it (Discord).
assert hasattr(_ToyAdapter, "gateway_runner")
assert _ToyAdapter.gateway_runner is None