hermes-agent/tests/plugins/test_raft_check_fn_silent.py
ruangraung 8cf7df867e fix(plugins): silence raft check_fn log spam for users without raft CLI
The raft platform plugin's check_raft_requirements() logged a WARNING every
time it returned False. Since check_fn is called on every load_gateway_config()
(~every 10s during normal gateway operation), users who don't have the raft
CLI installed get their logs flooded with no way to suppress it — hermes plugins
disable doesn't work for bundled platform plugins, and platforms.raft.enabled:
false doesn't gate the check_fn call.

Fix: make check_raft_requirements() a silent predicate (return True/False
only, no logging), matching the convention documented and used by other
platform adapters (e.g. teams/adapter.py). The caller in
gateway/platform_registry.py create_adapter() already emits its own warning
when requirements aren't met and an adapter is actually requested — that's the
correct place for a user-facing warning (fires once per connect attempt, not
once per config load).

Fixes #49234
2026-06-19 17:12:58 -07:00

75 lines
3.1 KiB
Python

"""Regression tests for the raft platform plugin's check_fn.
The raft platform adapter's ``check_raft_requirements()`` is registered as
the platform's ``check_fn``. This function is invoked on every
``load_gateway_config()`` call (dozens of times during normal gateway
operation). It must therefore be a *silent* predicate — returning True/False
without logging — otherwise every user without the ``raft`` CLI installed
gets their logs flooded with WARNING messages every few seconds.
See: https://github.com/NousResearch/hermes-agent/issues/49234
"""
import logging
from unittest.mock import patch
import pytest
@pytest.fixture
def raft_check():
"""Import check_raft_requirements fresh (adapter self-manages sys.path)."""
from plugins.platforms.raft.adapter import check_raft_requirements
return check_raft_requirements
def test_check_returns_false_when_raft_cli_missing(raft_check):
"""check_fn returns False when raft CLI is not in PATH."""
with patch("plugins.platforms.raft.adapter.shutil.which", return_value=None), \
patch("plugins.platforms.raft.adapter.AIOHTTP_AVAILABLE", True):
assert raft_check() is False
def test_check_returns_false_when_aiohttp_missing(raft_check):
"""check_fn returns False when aiohttp dependency is unavailable."""
with patch("plugins.platforms.raft.adapter.AIOHTTP_AVAILABLE", False):
assert raft_check() is False
def test_check_returns_true_when_all_deps_present(raft_check):
"""check_fn returns True when all dependencies are available."""
with patch("plugins.platforms.raft.adapter.shutil.which", return_value="/usr/bin/raft"), \
patch("plugins.platforms.raft.adapter.AIOHTTP_AVAILABLE", True):
assert raft_check() is True
def test_check_silent_when_raft_cli_missing(raft_check, caplog):
"""check_fn must NOT log a WARNING when raft CLI is missing.
This is the regression guard for issue #49234 — logging inside check_fn
causes log spam because the function is called on every config load.
"""
with patch("plugins.platforms.raft.adapter.shutil.which", return_value=None), \
patch("plugins.platforms.raft.adapter.AIOHTTP_AVAILABLE", True):
with caplog.at_level(logging.WARNING, logger="plugins.platforms.raft.adapter"):
raft_check()
warnings = [r for r in caplog.records if r.levelno >= logging.WARNING]
assert warnings == [], (
f"check_raft_requirements must be silent (no WARNING logs), "
f"but emitted: {[r.getMessage() for r in warnings]}"
)
def test_check_silent_when_aiohttp_missing(raft_check, caplog):
"""check_fn must NOT log a WARNING when aiohttp is missing."""
with patch("plugins.platforms.raft.adapter.AIOHTTP_AVAILABLE", False):
with caplog.at_level(logging.WARNING, logger="plugins.platforms.raft.adapter"):
raft_check()
warnings = [r for r in caplog.records if r.levelno >= logging.WARNING]
assert warnings == [], (
f"check_raft_requirements must be silent (no WARNING logs), "
f"but emitted: {[r.getMessage() for r in warnings]}"
)