mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-22 16:25:58 +00:00
9bda6438d4
The 'Unknown top-level config key' warning (f5bacee27) assumed a closed-world allowlist of valid roots, but top-level scalars in config.yaml are deliberately bridged into os.environ (gateway/run.py, hermes send) so skills and external apps Hermes drives can read arbitrary env-style keys (DISCORD_HOME_CHANNEL, MY_APP_TOKEN, ...). An allowlist can never enumerate those — two widening follow-ups (7c2ece53c,3c7217706) already proved the whack-a-mole. Drop the generic warning entirely; keep the targeted provider-like-field misplacement hint (base_url/api_key at root).
264 lines
10 KiB
Python
264 lines
10 KiB
Python
"""Tests for config.yaml structure validation (validate_config_structure)."""
|
|
|
|
|
|
from hermes_cli.config import (
|
|
DEFAULT_CONFIG,
|
|
_EXTRA_KNOWN_ROOT_KEYS,
|
|
_KNOWN_ROOT_KEYS,
|
|
validate_config_structure,
|
|
ConfigIssue,
|
|
)
|
|
|
|
|
|
class TestCustomProvidersValidation:
|
|
"""custom_providers must be a YAML list, not a dict."""
|
|
|
|
def test_dict_instead_of_list(self):
|
|
"""The exact Discord user scenario — custom_providers as flat dict."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": {
|
|
"name": "Generativelanguage.googleapis.com",
|
|
"base_url": "https://generativelanguage.googleapis.com/v1beta",
|
|
"api_key": "xxx",
|
|
"model": "models/gemini-2.5-flash",
|
|
"rate_limit_delay": 2.0,
|
|
"fallback_model": {
|
|
"provider": "openrouter",
|
|
"model": "qwen/qwen3.6-plus:free",
|
|
},
|
|
},
|
|
"fallback_providers": [],
|
|
})
|
|
errors = [i for i in issues if i.severity == "error"]
|
|
assert any("dict" in i.message and "list" in i.message for i in errors), (
|
|
"Should detect custom_providers as dict instead of list"
|
|
)
|
|
|
|
def test_dict_detects_misplaced_fields(self):
|
|
"""When custom_providers is a dict, detect fields that look misplaced."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": {
|
|
"name": "test",
|
|
"base_url": "https://example.com",
|
|
"api_key": "xxx",
|
|
},
|
|
})
|
|
warnings = [i for i in issues if i.severity == "warning"]
|
|
# Should flag base_url, api_key as looking like custom_providers entry fields
|
|
misplaced = [i for i in warnings if "custom_providers entry fields" in i.message]
|
|
assert len(misplaced) == 1
|
|
|
|
def test_dict_detects_nested_fallback(self):
|
|
"""When fallback_model gets swallowed into custom_providers dict."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": {
|
|
"name": "test",
|
|
"fallback_model": {"provider": "openrouter", "model": "test"},
|
|
},
|
|
})
|
|
errors = [i for i in issues if i.severity == "error"]
|
|
assert any("fallback_model" in i.message and "inside" in i.message for i in errors)
|
|
|
|
def test_valid_list_no_issues(self):
|
|
"""Properly formatted custom_providers should produce no issues."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": [
|
|
{"name": "gemini", "base_url": "https://example.com/v1"},
|
|
],
|
|
"model": {"provider": "custom", "default": "test"},
|
|
})
|
|
assert len(issues) == 0
|
|
|
|
def test_list_entry_missing_name(self):
|
|
"""List entry without name should warn."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": [{"base_url": "https://example.com/v1"}],
|
|
"model": {"provider": "custom"},
|
|
})
|
|
assert any("missing 'name'" in i.message for i in issues)
|
|
|
|
def test_list_entry_missing_base_url(self):
|
|
"""List entry without base_url should warn."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": [{"name": "test"}],
|
|
"model": {"provider": "custom"},
|
|
})
|
|
assert any("missing 'base_url'" in i.message for i in issues)
|
|
|
|
def test_list_entry_not_dict(self):
|
|
"""Non-dict list entries should warn."""
|
|
issues = validate_config_structure({
|
|
"custom_providers": ["not-a-dict"],
|
|
"model": {"provider": "custom"},
|
|
})
|
|
assert any("not a dict" in i.message for i in issues)
|
|
|
|
def test_none_custom_providers_no_issues(self):
|
|
"""No custom_providers at all should be fine."""
|
|
issues = validate_config_structure({
|
|
"model": {"provider": "openrouter"},
|
|
})
|
|
assert len(issues) == 0
|
|
|
|
|
|
class TestFallbackModelValidation:
|
|
"""fallback_model should be a top-level dict with provider + model."""
|
|
|
|
def test_missing_provider(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": {"model": "anthropic/claude-sonnet-4"},
|
|
})
|
|
assert any("missing 'provider'" in i.message for i in issues)
|
|
|
|
def test_missing_model(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": {"provider": "openrouter"},
|
|
})
|
|
assert any("missing 'model'" in i.message for i in issues)
|
|
|
|
def test_valid_fallback(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": {
|
|
"provider": "openrouter",
|
|
"model": "anthropic/claude-sonnet-4",
|
|
},
|
|
})
|
|
# Only fallback-related issues should be absent
|
|
fb_issues = [i for i in issues if "fallback" in i.message.lower()]
|
|
assert len(fb_issues) == 0
|
|
|
|
def test_non_dict_fallback(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": "openrouter:anthropic/claude-sonnet-4",
|
|
})
|
|
assert any("should be a dict" in i.message for i in issues)
|
|
|
|
def test_empty_fallback_dict_no_issues(self):
|
|
"""Empty fallback_model dict means disabled — no warnings needed."""
|
|
issues = validate_config_structure({
|
|
"fallback_model": {},
|
|
})
|
|
fb_issues = [i for i in issues if "fallback" in i.message.lower()]
|
|
assert len(fb_issues) == 0
|
|
|
|
def test_valid_fallback_list(self):
|
|
"""List-form fallback_model (chain) should validate when every entry has provider+model."""
|
|
issues = validate_config_structure({
|
|
"fallback_model": [
|
|
{"provider": "openrouter", "model": "anthropic/claude-sonnet-4"},
|
|
{"provider": "anthropic", "model": "claude-sonnet-4-6"},
|
|
],
|
|
})
|
|
fb_issues = [i for i in issues if "fallback" in i.message.lower()]
|
|
assert len(fb_issues) == 0
|
|
|
|
def test_fallback_list_entry_missing_provider(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": [
|
|
{"provider": "openrouter", "model": "anthropic/claude-sonnet-4"},
|
|
{"model": "claude-sonnet-4-6"},
|
|
],
|
|
})
|
|
assert any("fallback_model[1]" in i.message and "provider" in i.message for i in issues)
|
|
|
|
def test_fallback_list_entry_missing_model(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": [
|
|
{"provider": "openrouter"},
|
|
],
|
|
})
|
|
assert any("fallback_model[0]" in i.message and "model" in i.message for i in issues)
|
|
|
|
def test_fallback_list_entry_not_a_dict(self):
|
|
issues = validate_config_structure({
|
|
"fallback_model": ["openrouter:anthropic/claude-sonnet-4"],
|
|
})
|
|
assert any("fallback_model[0]" in i.message and "should be a dict" in i.message for i in issues)
|
|
|
|
|
|
class TestMissingModelSection:
|
|
"""Warn when custom_providers exists but model section is missing."""
|
|
|
|
def test_custom_providers_without_model(self):
|
|
issues = validate_config_structure({
|
|
"custom_providers": [
|
|
{"name": "test", "base_url": "https://example.com/v1"},
|
|
],
|
|
})
|
|
assert any("no 'model' section" in i.message for i in issues)
|
|
|
|
def test_custom_providers_with_model(self):
|
|
issues = validate_config_structure({
|
|
"custom_providers": [
|
|
{"name": "test", "base_url": "https://example.com/v1"},
|
|
],
|
|
"model": {"provider": "custom", "default": "test-model"},
|
|
})
|
|
# Should not warn about missing model section
|
|
assert not any("no 'model' section" in i.message for i in issues)
|
|
|
|
|
|
class TestConfigIssueDataclass:
|
|
"""ConfigIssue should be a proper dataclass."""
|
|
|
|
def test_fields(self):
|
|
issue = ConfigIssue(severity="error", message="test msg", hint="test hint")
|
|
assert issue.severity == "error"
|
|
assert issue.message == "test msg"
|
|
assert issue.hint == "test hint"
|
|
|
|
def test_equality(self):
|
|
a = ConfigIssue("error", "msg", "hint")
|
|
b = ConfigIssue("error", "msg", "hint")
|
|
assert a == b
|
|
|
|
|
|
class TestUnknownTopLevelKeys:
|
|
"""Arbitrary top-level keys must NOT warn — they are bridged to os.environ.
|
|
|
|
Top-level scalars in config.yaml are forwarded into the environment
|
|
(gateway/run.py, hermes send) so users can feed skills and external apps
|
|
env-style keys like DISCORD_HOME_CHANNEL or MY_APP_TOKEN. A closed-world
|
|
allowlist can never enumerate those, so no "Unknown top-level config key"
|
|
warning may exist.
|
|
"""
|
|
|
|
def test_arbitrary_top_level_keys_stay_silent(self):
|
|
"""Env-style and custom keys must produce no unknown-key warnings."""
|
|
issues = validate_config_structure({
|
|
"model": {"provider": "openrouter"},
|
|
"DISCORD_HOME_CHANNEL": "12345",
|
|
"TELEGRAM_HOME_CHANNEL": "-100987",
|
|
"DISCORD_ALLOW_ALL_USERS": True,
|
|
"MY_CUSTOM_SKILL_VAR": "hello",
|
|
"skillz": {"enabled": True},
|
|
})
|
|
assert not any("Unknown top-level config key" in i.message for i in issues)
|
|
assert issues == []
|
|
|
|
def test_known_root_keys_derived_from_default_config(self):
|
|
"""_KNOWN_ROOT_KEYS must be DEFAULT_CONFIG.keys() plus extras — single source of truth."""
|
|
assert set(DEFAULT_CONFIG.keys()).issubset(_KNOWN_ROOT_KEYS)
|
|
assert _EXTRA_KNOWN_ROOT_KEYS.issubset(_KNOWN_ROOT_KEYS)
|
|
assert _KNOWN_ROOT_KEYS == frozenset(DEFAULT_CONFIG.keys()) | _EXTRA_KNOWN_ROOT_KEYS
|
|
|
|
def test_provider_like_unknown_root_keeps_misplaced_message(self):
|
|
"""Preserve existing base_url/api_key root-level guidance."""
|
|
issues = validate_config_structure({
|
|
"base_url": "https://example.com/v1",
|
|
"api_key": "secret",
|
|
})
|
|
misplaced = [
|
|
i for i in issues
|
|
if i.severity == "warning" and "looks misplaced" in i.message
|
|
]
|
|
assert any("base_url" in i.message for i in misplaced)
|
|
assert any("api_key" in i.message for i in misplaced)
|
|
|
|
def test_private_underscore_keys_not_flagged(self):
|
|
"""Internal keys starting with _ remain ignored."""
|
|
issues = validate_config_structure({
|
|
"_internal_scratch": True,
|
|
"model": {"provider": "openrouter"},
|
|
})
|
|
assert issues == []
|