hermes-agent/tests/hermes_cli/test_web_server_messaging_profiles.py
2026-06-17 05:40:57 -07:00

223 lines
8.3 KiB
Python

"""Regression tests for profile-scoped dashboard Channels endpoints.
Before the ``profile`` parameter existed, ``/api/messaging/platforms`` always
read/wrote the dashboard process's own (root) ``.env`` via ``load_env()`` /
``save_env_value()`` — so a dashboard switched to a freshly created profile
still displayed and persisted the ROOT install's messaging credentials.
These tests pin the new behavior: reads and writes land in the REQUESTED
profile's HERMES_HOME, and the dashboard's own profile stays untouched.
"""
import pytest
import yaml
@pytest.fixture
def isolated_profiles(tmp_path, monkeypatch, _isolate_hermes_home):
"""Isolated default home + one named profile, each with its own .env."""
from hermes_constants import get_hermes_home
from hermes_cli import profiles
default_home = get_hermes_home()
profiles_root = default_home / "profiles"
worker_home = profiles_root / "worker_alpha"
for home in (default_home, worker_home):
home.mkdir(parents=True, exist_ok=True)
(home / "config.yaml").write_text("{}\n", encoding="utf-8")
(default_home / ".env").write_text(
"TELEGRAM_BOT_TOKEN=root-token\n", encoding="utf-8"
)
(worker_home / ".env").write_text("", encoding="utf-8")
monkeypatch.setattr(profiles, "_get_default_hermes_home", lambda: default_home)
monkeypatch.setattr(profiles, "_get_profiles_root", lambda: profiles_root)
return {"default": default_home, "worker_alpha": worker_home}
@pytest.fixture
def client(monkeypatch, isolated_profiles):
try:
from starlette.testclient import TestClient
except ImportError:
pytest.skip("fastapi/starlette not installed")
import hermes_state
from hermes_constants import get_hermes_home
from hermes_cli.web_server import app, _SESSION_HEADER_NAME, _SESSION_TOKEN
monkeypatch.setattr(hermes_state, "DEFAULT_DB_PATH", get_hermes_home() / "state.db")
# The dashboard process's os.environ may carry root-install credentials;
# make sure the scoped path never falls back to them.
monkeypatch.delenv("TELEGRAM_BOT_TOKEN", raising=False)
c = TestClient(app)
c.headers[_SESSION_HEADER_NAME] = _SESSION_TOKEN
return c
def _telegram(payload):
return next(p for p in payload["platforms"] if p["id"] == "telegram")
def _env_field(platform, key):
return next(f for f in platform["env_vars"] if f["key"] == key)
class TestProfileScopedMessagingReads:
def test_scoped_read_does_not_show_root_credentials(
self, client, isolated_profiles
):
resp = client.get(
"/api/messaging/platforms", params={"profile": "worker_alpha"}
)
assert resp.status_code == 200
telegram = _telegram(resp.json())
token = _env_field(telegram, "TELEGRAM_BOT_TOKEN")
# The worker profile has an empty .env — the root token must not leak.
assert token["is_set"] is False
assert telegram["configured"] is False
def test_unscoped_read_shows_dashboard_profile_env(
self, client, isolated_profiles
):
resp = client.get("/api/messaging/platforms")
assert resp.status_code == 200
telegram = _telegram(resp.json())
token = _env_field(telegram, "TELEGRAM_BOT_TOKEN")
assert token["is_set"] is True
def test_unknown_profile_returns_404(self, client, isolated_profiles):
resp = client.get(
"/api/messaging/platforms", params={"profile": "no_such_profile"}
)
assert resp.status_code == 404
def test_scoped_read_returns_profile_path_command_and_startup_failure(
self, client, isolated_profiles, monkeypatch
):
import hermes_cli.web_server as web_server
worker_home = isolated_profiles["worker_alpha"]
(worker_home / ".env").write_text(
"TELEGRAM_BOT_TOKEN=worker-token\n", encoding="utf-8"
)
(worker_home / "config.yaml").write_text(
yaml.safe_dump({"platforms": {"telegram": {"enabled": True}}}),
encoding="utf-8",
)
monkeypatch.setattr(web_server, "get_running_pid", lambda: None)
monkeypatch.setattr(
web_server,
"read_runtime_status",
lambda: {
"gateway_state": "startup_failed",
"exit_reason": "all configured messaging platforms failed to connect",
"platforms": {},
},
)
resp = client.get(
"/api/messaging/platforms", params={"profile": "worker_alpha"}
)
assert resp.status_code == 200
payload = resp.json()
assert payload["env_path"] == str(worker_home / ".env")
assert payload["gateway_start_command"] == (
"hermes -p worker_alpha gateway start"
)
telegram = _telegram(payload)
assert telegram["state"] == "startup_failed"
assert telegram["error_code"] == "startup_failed"
assert telegram["error_message"] == (
"all configured messaging platforms failed to connect"
)
class TestProfileScopedMessagingWrites:
def test_scoped_write_lands_in_target_profile_env(
self, client, isolated_profiles
):
resp = client.put(
"/api/messaging/platforms/telegram",
params={"profile": "worker_alpha"},
json={
"enabled": True,
"env": {"TELEGRAM_BOT_TOKEN": "worker-token"},
},
)
assert resp.status_code == 200
worker_env = (
isolated_profiles["worker_alpha"] / ".env"
).read_text(encoding="utf-8")
assert "TELEGRAM_BOT_TOKEN=worker-token" in worker_env
# The dashboard's own .env must stay untouched — this was the bug.
root_env = (isolated_profiles["default"] / ".env").read_text(
encoding="utf-8"
)
assert "worker-token" not in root_env
assert "TELEGRAM_BOT_TOKEN=root-token" in root_env
# Enablement lands in the target profile's config.yaml.
worker_cfg = yaml.safe_load(
(isolated_profiles["worker_alpha"] / "config.yaml").read_text()
) or {}
assert worker_cfg.get("platforms", {}).get("telegram", {}).get("enabled") is True
root_cfg = yaml.safe_load(
(isolated_profiles["default"] / "config.yaml").read_text()
) or {}
assert "telegram" not in (root_cfg.get("platforms") or {})
def test_body_profile_beats_query_param(self, client, isolated_profiles):
resp = client.put(
"/api/messaging/platforms/telegram",
json={
"env": {"TELEGRAM_BOT_TOKEN": "body-token"},
"profile": "worker_alpha",
},
)
assert resp.status_code == 200
worker_env = (
isolated_profiles["worker_alpha"] / ".env"
).read_text(encoding="utf-8")
assert "TELEGRAM_BOT_TOKEN=body-token" in worker_env
def test_scoped_read_after_scoped_write_round_trips(
self, client, isolated_profiles
):
client.put(
"/api/messaging/platforms/telegram",
params={"profile": "worker_alpha"},
json={"enabled": True, "env": {"TELEGRAM_BOT_TOKEN": "worker-token"}},
)
resp = client.get(
"/api/messaging/platforms", params={"profile": "worker_alpha"}
)
telegram = _telegram(resp.json())
assert telegram["enabled"] is True
assert _env_field(telegram, "TELEGRAM_BOT_TOKEN")["is_set"] is True
assert telegram["configured"] is True
def test_scoped_clear_env_removes_from_target_only(
self, client, isolated_profiles
):
client.put(
"/api/messaging/platforms/telegram",
params={"profile": "worker_alpha"},
json={"env": {"TELEGRAM_BOT_TOKEN": "worker-token"}},
)
resp = client.put(
"/api/messaging/platforms/telegram",
params={"profile": "worker_alpha"},
json={"clear_env": ["TELEGRAM_BOT_TOKEN"]},
)
assert resp.status_code == 200
worker_env = (
isolated_profiles["worker_alpha"] / ".env"
).read_text(encoding="utf-8")
assert "worker-token" not in worker_env
root_env = (isolated_profiles["default"] / ".env").read_text(
encoding="utf-8"
)
assert "TELEGRAM_BOT_TOKEN=root-token" in root_env