John Paul Soliva
7af3515c57
hermes_time reads `timezone` from config.yaml (or HERMES_TIMEZONE) and, when
ZoneInfo cannot load the name, logs one warning and falls back to
server-local time. Nothing else ever looks at the value: not doctor, not
validate_config_structure. So a typo ("Asia/Tokio", "EST5", "Tokyo") puts
the agent clock and every cron schedule on the server's zone, with the
only evidence a single line in the gateway log.
validate_config_structure now checks the key: a non-string is an error, a
non-empty string that ZoneInfo cannot load is an error, and blank/missing
stays silent (server-local is the documented default). Because the check
runs at startup too, it is skipped when the interpreter has no tz database
at all (bare Windows without tzdata) — there is nothing to judge against,
and flagging every valid name there would be worse than the bug. The hint
names the IANA form and points out that HERMES_TIMEZONE overrides the key.
199 lines
7.4 KiB
Python
199 lines
7.4 KiB
Python
"""Tests for config.yaml structure validation (validate_config_structure)."""
|
|
|
|
|
|
import pytest
|
|
|
|
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_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)
|
|
|
|
|
|
|
|
|
|
class TestMissingModelSection:
|
|
"""Warn when custom_providers exists but model section is missing."""
|
|
|
|
|
|
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 TestVoiceSubmitModeValidation:
|
|
def test_default_is_direct(self):
|
|
assert DEFAULT_CONFIG["voice"]["submit_mode"] == "direct"
|
|
|
|
def test_direct_and_draft_are_valid(self):
|
|
for mode in ("direct", "draft"):
|
|
issues = validate_config_structure({"voice": {"submit_mode": mode}})
|
|
assert not any("voice.submit_mode" in issue.message for issue in issues)
|
|
|
|
def test_invalid_mode_is_reported(self):
|
|
issues = validate_config_structure({"voice": {"submit_mode": "refine"}})
|
|
|
|
assert any(
|
|
issue.severity == "error"
|
|
and "voice.submit_mode" in issue.message
|
|
and "direct" in issue.hint
|
|
and "draft" in issue.hint
|
|
for issue in issues
|
|
)
|
|
|
|
|
|
def _tz_issues(config):
|
|
return [i for i in validate_config_structure(config) if "timezone" in i.message]
|
|
|
|
|
|
def _has_tz_database() -> bool:
|
|
try:
|
|
import zoneinfo
|
|
zoneinfo.ZoneInfo("UTC")
|
|
return True
|
|
except Exception:
|
|
return False
|
|
|
|
|
|
class TestTimezoneValidation:
|
|
"""An invalid ``timezone`` silently puts the agent clock and every cron
|
|
schedule on server-local time (hermes_time._get_zoneinfo falls back with
|
|
one log warning). validate_config_structure must report it."""
|
|
|
|
def test_valid_zone_passes(self):
|
|
assert _tz_issues({"timezone": "Asia/Tokyo", "model": {"provider": "nous"}}) == []
|
|
|
|
def test_missing_or_blank_is_not_reported(self):
|
|
assert _tz_issues({"model": {"provider": "nous"}}) == []
|
|
assert _tz_issues({"timezone": "", "model": {"provider": "nous"}}) == []
|
|
assert _tz_issues({"timezone": " ", "model": {"provider": "nous"}}) == []
|
|
assert _tz_issues({"timezone": None, "model": {"provider": "nous"}}) == []
|
|
|
|
@pytest.mark.skipif(not _has_tz_database(), reason="no tz database in this interpreter")
|
|
def test_invalid_zone_is_reported(self):
|
|
[issue] = _tz_issues({"timezone": "Asia/Tokio", "model": {"provider": "nous"}})
|
|
assert issue.severity == "error"
|
|
assert "Asia/Tokio" in issue.message
|
|
assert "IANA" in issue.hint
|
|
assert "HERMES_TIMEZONE" in issue.hint
|
|
|
|
def test_non_string_is_reported(self):
|
|
[issue] = _tz_issues({"timezone": 9, "model": {"provider": "nous"}})
|
|
assert issue.severity == "error"
|
|
assert "string" in issue.message
|
|
|
|
def test_silent_without_a_tz_database(self, monkeypatch):
|
|
# Bare Windows without tzdata: ZoneInfo cannot load anything, including
|
|
# UTC. A valid name must not be flagged just because it cannot be checked.
|
|
import zoneinfo
|
|
|
|
def no_db(_key):
|
|
raise zoneinfo.ZoneInfoNotFoundError("no tz database")
|
|
|
|
monkeypatch.setattr(zoneinfo, "ZoneInfo", no_db)
|
|
assert _tz_issues({"timezone": "Asia/Tokyo", "model": {"provider": "nous"}}) == []
|
|
assert _tz_issues({"timezone": "Asia/Tokio", "model": {"provider": "nous"}}) == []
|
|
|
|
|
|
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_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)
|
|
|