mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-03 02:11:48 +00:00
feat(irc): add interactive setup
feat(gateway): refine Platform._missing_ and platform-connected dispatch Restricts plugin-name acceptance to bundled plugin scan + registry (no arbitrary string -> enum-pollution), pulls per-platform connectivity checks into a _PLATFORM_CONNECTED_CHECKERS lambda map with a clean _is_platform_connected method, and adds tests covering the checker map, plugin platform interface, and IRC setup wizard.
This commit is contained in:
parent
6e42daf7dd
commit
868bc1c242
38 changed files with 2191 additions and 189 deletions
230
tests/gateway/test_plugin_platform_interface.py
Normal file
230
tests/gateway/test_plugin_platform_interface.py
Normal file
|
|
@ -0,0 +1,230 @@
|
|||
"""
|
||||
Interface compliance tests for all plugin-based gateway platforms.
|
||||
|
||||
Discovers platforms dynamically under ``plugins/platforms/`` — no manual
|
||||
enumeration — and verifies each one implements the required contract.
|
||||
"""
|
||||
|
||||
import importlib
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from types import ModuleType
|
||||
from typing import Any
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
import pytest
|
||||
|
||||
PROJECT_ROOT = Path(__file__).parent.parent.resolve()
|
||||
PLATFORMS_DIR = PROJECT_ROOT / "plugins" / "platforms"
|
||||
|
||||
|
||||
def _discover_platform_plugins() -> list[str]:
|
||||
"""Return names of all bundled platform plugins."""
|
||||
if not PLATFORMS_DIR.is_dir():
|
||||
return []
|
||||
names = []
|
||||
for child in sorted(PLATFORMS_DIR.iterdir()):
|
||||
if child.is_dir() and (child / "__init__.py").exists():
|
||||
names.append(child.name)
|
||||
return names
|
||||
|
||||
|
||||
# Dynamically parametrise over discovered platforms
|
||||
_PLATFORM_NAMES = _discover_platform_plugins()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def clean_registry():
|
||||
"""Yield with a clean platform registry, restoring state afterwards."""
|
||||
from gateway.platform_registry import platform_registry
|
||||
|
||||
original = dict(platform_registry._entries)
|
||||
platform_registry._entries.clear()
|
||||
yield platform_registry
|
||||
platform_registry._entries.clear()
|
||||
platform_registry._entries.update(original)
|
||||
|
||||
|
||||
class _MockPluginContext:
|
||||
"""Minimal mock of hermes_cli.plugins.PluginContext.
|
||||
|
||||
Only implements register_platform so we can exercise the plugin's
|
||||
register() entrypoint without importing the real plugin system.
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.registered_names: list[str] = []
|
||||
|
||||
def register_platform(
|
||||
self,
|
||||
*,
|
||||
name: str,
|
||||
label: str,
|
||||
adapter_factory: Any,
|
||||
check_fn: Any,
|
||||
**kwargs: Any,
|
||||
) -> None:
|
||||
from gateway.platform_registry import platform_registry, PlatformEntry
|
||||
|
||||
entry = PlatformEntry(
|
||||
name=name,
|
||||
label=label,
|
||||
adapter_factory=adapter_factory,
|
||||
check_fn=check_fn,
|
||||
**kwargs,
|
||||
)
|
||||
platform_registry.register(entry)
|
||||
self.registered_names.append(name)
|
||||
|
||||
|
||||
def _import_platform_module(name: str) -> ModuleType:
|
||||
"""Import plugins.platforms.<name> in a test-safe way."""
|
||||
# Make sure the project root is on sys.path so relative imports work
|
||||
if str(PROJECT_ROOT) not in sys.path:
|
||||
sys.path.insert(0, str(PROJECT_ROOT))
|
||||
module = importlib.import_module(f"plugins.platforms.{name}")
|
||||
return module
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_plugin_exposes_register_function(platform_name: str):
|
||||
"""Every platform plugin must expose a callable register function."""
|
||||
module = _import_platform_module(platform_name)
|
||||
assert hasattr(module, "register"), f"{platform_name} missing register()"
|
||||
assert callable(module.register), f"{platform_name}.register not callable"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_plugin_registers_valid_platform_entry(platform_name: str, clean_registry):
|
||||
"""Calling register() must create a valid PlatformEntry."""
|
||||
module = _import_platform_module(platform_name)
|
||||
ctx = _MockPluginContext()
|
||||
module.register(ctx)
|
||||
|
||||
assert platform_name in ctx.registered_names
|
||||
|
||||
from gateway.platform_registry import platform_registry
|
||||
entry = platform_registry.get(platform_name)
|
||||
assert entry is not None, f"{platform_name} did not register an entry"
|
||||
assert entry.name == platform_name
|
||||
assert entry.label
|
||||
assert callable(entry.adapter_factory)
|
||||
assert callable(entry.check_fn)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_platform_entry_has_required_fields(platform_name: str, clean_registry):
|
||||
"""PlatformEntry must have the mandatory metadata fields."""
|
||||
module = _import_platform_module(platform_name)
|
||||
ctx = _MockPluginContext()
|
||||
module.register(ctx)
|
||||
|
||||
from gateway.platform_registry import platform_registry
|
||||
entry = platform_registry.get(platform_name)
|
||||
assert entry is not None
|
||||
|
||||
# Mandatory fields
|
||||
assert isinstance(entry.name, str) and entry.name
|
||||
assert isinstance(entry.label, str) and entry.label
|
||||
assert callable(entry.adapter_factory)
|
||||
assert callable(entry.check_fn)
|
||||
|
||||
# Optional but recommended fields
|
||||
if entry.validate_config is not None:
|
||||
assert callable(entry.validate_config)
|
||||
if entry.is_connected is not None:
|
||||
assert callable(entry.is_connected)
|
||||
if entry.setup_fn is not None:
|
||||
assert callable(entry.setup_fn)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_adapter_factory_produces_valid_adapter(platform_name: str, clean_registry):
|
||||
"""The adapter factory must return an object with the base interface."""
|
||||
module = _import_platform_module(platform_name)
|
||||
ctx = _MockPluginContext()
|
||||
module.register(ctx)
|
||||
|
||||
from gateway.platform_registry import platform_registry
|
||||
entry = platform_registry.get(platform_name)
|
||||
assert entry is not None
|
||||
|
||||
# Build a minimal synthetic config that shouldn't crash __init__
|
||||
mock_config = MagicMock()
|
||||
mock_config.extra = {}
|
||||
mock_config.enabled = True
|
||||
mock_config.token = None
|
||||
mock_config.api_key = None
|
||||
mock_config.home_channel = None
|
||||
mock_config.reply_to_mode = "first"
|
||||
|
||||
adapter = entry.adapter_factory(mock_config)
|
||||
assert adapter is not None, f"{platform_name} adapter_factory returned None"
|
||||
|
||||
# Required adapter interface
|
||||
assert hasattr(adapter, "connect") and callable(adapter.connect)
|
||||
assert hasattr(adapter, "disconnect") and callable(adapter.disconnect)
|
||||
assert hasattr(adapter, "send") and callable(adapter.send)
|
||||
assert hasattr(adapter, "name")
|
||||
|
||||
# Should be a BasePlatformAdapter subclass if importable
|
||||
try:
|
||||
from gateway.platforms.base import BasePlatformAdapter
|
||||
assert isinstance(adapter, BasePlatformAdapter)
|
||||
except Exception:
|
||||
pytest.skip("BasePlatformAdapter not available for isinstance check")
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_check_fn_returns_bool(platform_name: str, clean_registry):
|
||||
"""check_fn() must return a boolean."""
|
||||
module = _import_platform_module(platform_name)
|
||||
ctx = _MockPluginContext()
|
||||
module.register(ctx)
|
||||
|
||||
from gateway.platform_registry import platform_registry
|
||||
entry = platform_registry.get(platform_name)
|
||||
assert entry is not None
|
||||
|
||||
result = entry.check_fn()
|
||||
assert isinstance(result, bool), f"{platform_name}.check_fn() returned {type(result)}, expected bool"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_validate_config_if_present(platform_name: str, clean_registry):
|
||||
"""If validate_config is provided, it must accept a config object."""
|
||||
module = _import_platform_module(platform_name)
|
||||
ctx = _MockPluginContext()
|
||||
module.register(ctx)
|
||||
|
||||
from gateway.platform_registry import platform_registry
|
||||
entry = platform_registry.get(platform_name)
|
||||
assert entry is not None
|
||||
|
||||
if entry.validate_config is None:
|
||||
pytest.skip("No validate_config provided")
|
||||
|
||||
mock_config = MagicMock()
|
||||
mock_config.extra = {}
|
||||
result = entry.validate_config(mock_config)
|
||||
assert isinstance(result, bool)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("platform_name", _PLATFORM_NAMES)
|
||||
def test_is_connected_if_present(platform_name: str, clean_registry):
|
||||
"""If is_connected is provided, it must accept a config object."""
|
||||
module = _import_platform_module(platform_name)
|
||||
ctx = _MockPluginContext()
|
||||
module.register(ctx)
|
||||
|
||||
from gateway.platform_registry import platform_registry
|
||||
entry = platform_registry.get(platform_name)
|
||||
assert entry is not None
|
||||
|
||||
if entry.is_connected is None:
|
||||
pytest.skip("No is_connected provided")
|
||||
|
||||
mock_config = MagicMock()
|
||||
mock_config.extra = {}
|
||||
result = entry.is_connected(mock_config)
|
||||
assert isinstance(result, bool)
|
||||
Loading…
Add table
Add a link
Reference in a new issue