mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-07-20 15:33:54 +00:00
52ae9d9f02
Re-running `hermes dashboard register` now updates the existing dashboard record in nous-account-service instead of creating a duplicate. The stable key is the client_id this install already persisted in HERMES_DASHBOARD_OAUTH_CLIENT_ID on a prior run: - No stored client_id -> first registration -> create a fresh client with an auto-generated name (unchanged behavior). - Stored client_id present -> re-send it as `client_id` so the portal updates that row in place. Without an explicit --name, the name is omitted so the portal-stored name isn't churned to a new random value on every re-run. - Prints "Updated dashboard" vs "Registered dashboard" based on whether the portal echoed back the same client_id. A stale/deleted id safely falls through to a fresh create server-side. Requires the matching nous-account-service change (POST /api/oauth/self-hosted-client accepting an optional client_id + optional name). Tests: 7 new TestIdempotentRerun cases (key sent, name preserved/overridden, Updated message, persisted id, stale-id fall-through, blank-id first-run); existing create-path tests unchanged (23 pass).
338 lines
13 KiB
Python
338 lines
13 KiB
Python
"""Tests for ``hermes dashboard register``.
|
|
|
|
Covers the CLI half of self-hosted dashboard registration:
|
|
- Docker-style auto-name generation
|
|
- not-logged-in fast-fail (AuthError with relogin_required)
|
|
- managed-install refusal
|
|
- the happy path: POST shape, env-var writes, custom redirect URI
|
|
- portal-URL write logic (only when non-default and not already set)
|
|
- portal HTTP error mapping (401/403)
|
|
|
|
The portal HTTP call and the Nous token resolution are both mocked — this
|
|
file proves the CLI wiring + env-write behaviour. The live end-to-end token
|
|
round-trip against the Vercel preview build is a separate manual step.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import json
|
|
import urllib.error
|
|
from io import BytesIO
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
import hermes_cli.dashboard_register as dr
|
|
|
|
|
|
def _ns(**kw):
|
|
defaults = dict(name=None, redirect_uri=None)
|
|
defaults.update(kw)
|
|
return argparse.Namespace(**defaults)
|
|
|
|
|
|
class TestNameGenerator:
|
|
def test_shape_is_adjective_underscore_noun(self):
|
|
for _ in range(50):
|
|
name = dr._generate_dashboard_name()
|
|
assert "_" in name
|
|
adj, _, noun = name.partition("_")
|
|
assert adj in dr._NAME_ADJECTIVES
|
|
assert noun in dr._NAME_NOUNS
|
|
|
|
|
|
class TestFastFails:
|
|
def test_not_logged_in_exits_1_with_setup_hint(self, capsys):
|
|
from hermes_cli.auth import AuthError
|
|
|
|
err = AuthError("not logged in", provider="nous", relogin_required=True)
|
|
with patch.object(dr, "cmd_dashboard_register", dr.cmd_dashboard_register):
|
|
with patch(
|
|
"hermes_cli.auth.resolve_nous_access_token", side_effect=err
|
|
), patch("hermes_cli.config.is_managed", return_value=False):
|
|
with pytest.raises(SystemExit) as exc:
|
|
dr.cmd_dashboard_register(_ns())
|
|
assert exc.value.code == 1
|
|
out = capsys.readouterr().out
|
|
assert "not logged into Nous Portal" in out
|
|
assert "hermes setup" in out
|
|
|
|
def test_managed_install_refuses(self, capsys):
|
|
with patch("hermes_cli.config.is_managed", return_value=True):
|
|
with pytest.raises(SystemExit) as exc:
|
|
dr.cmd_dashboard_register(_ns())
|
|
assert exc.value.code == 1
|
|
out = capsys.readouterr().out
|
|
assert "not available in a managed" in out
|
|
|
|
|
|
def _fake_http_ok(payload: dict):
|
|
"""Return a context-manager urlopen stub yielding `payload` as JSON."""
|
|
cm = MagicMock()
|
|
cm.__enter__.return_value.read.return_value = json.dumps(payload).encode()
|
|
return cm
|
|
|
|
|
|
class TestHappyPath:
|
|
def _run(self, *, args, account_token="tok_abc", portal="https://portal.nousresearch.com",
|
|
response=None, captured=None, existing_client_id=None):
|
|
response = response or {
|
|
"client_id": "agent:selfhost-1",
|
|
"id": "selfhost-1",
|
|
"name": "dreamy_tesla",
|
|
"kind": "SELF_HOSTED",
|
|
"custom_redirect_uri": None,
|
|
"created_at": "2026-06-04T12:00:00.000Z",
|
|
}
|
|
|
|
def fake_urlopen(req, timeout=None):
|
|
if captured is not None:
|
|
captured["url"] = req.full_url
|
|
captured["headers"] = dict(req.header_items())
|
|
captured["body"] = json.loads(req.data.decode())
|
|
return _fake_http_ok(response)
|
|
|
|
saved = {}
|
|
|
|
def fake_save(key, value):
|
|
saved[key] = value
|
|
|
|
# get_env_value is consulted twice: once for the stored client_id
|
|
# (idempotency key) and once for HERMES_DASHBOARD_PORTAL_URL. Route by
|
|
# key so a test can seed a prior client_id while keeping the portal
|
|
# unset (the default-portal-not-persisted path).
|
|
def fake_get_env(key):
|
|
if key == "HERMES_DASHBOARD_OAUTH_CLIENT_ID":
|
|
return existing_client_id
|
|
return None
|
|
|
|
with patch(
|
|
"hermes_cli.auth.resolve_nous_access_token", return_value=account_token
|
|
), patch("hermes_cli.config.is_managed", return_value=False), patch.object(
|
|
dr, "_resolve_portal_base_url", return_value=portal
|
|
), patch(
|
|
"hermes_cli.config.get_env_value", side_effect=fake_get_env
|
|
), patch(
|
|
"hermes_cli.config.save_env_value", side_effect=fake_save
|
|
), patch.object(
|
|
dr.urllib.request, "urlopen", side_effect=fake_urlopen
|
|
):
|
|
dr.cmd_dashboard_register(args)
|
|
return saved
|
|
|
|
def test_writes_client_id_and_posts_generated_name(self, capsys):
|
|
captured: dict = {}
|
|
saved = self._run(args=_ns(), captured=captured)
|
|
|
|
# POST shape
|
|
assert captured["url"].endswith("/api/oauth/self-hosted-client")
|
|
assert captured["headers"]["Authorization"] == "Bearer tok_abc"
|
|
assert "name" in captured["body"] and captured["body"]["name"]
|
|
assert "custom_redirect_uri" not in captured["body"]
|
|
|
|
# env write: client_id present, portal URL NOT written (default portal)
|
|
assert saved["HERMES_DASHBOARD_OAUTH_CLIENT_ID"] == "agent:selfhost-1"
|
|
assert "HERMES_DASHBOARD_PORTAL_URL" not in saved
|
|
|
|
out = capsys.readouterr().out
|
|
assert "Registered dashboard" in out
|
|
assert "non-loopback bind" in out # the gate-engagement hint
|
|
|
|
def test_explicit_name_is_sent(self, capsys):
|
|
captured: dict = {}
|
|
self._run(args=_ns(name="my_box"), captured=captured)
|
|
assert captured["body"]["name"] == "my_box"
|
|
|
|
def test_custom_redirect_uri_is_forwarded(self, capsys):
|
|
captured: dict = {}
|
|
self._run(
|
|
args=_ns(redirect_uri="https://hermes.example.com/auth/callback"),
|
|
captured=captured,
|
|
)
|
|
assert (
|
|
captured["body"]["custom_redirect_uri"]
|
|
== "https://hermes.example.com/auth/callback"
|
|
)
|
|
|
|
def test_non_default_portal_is_persisted(self, capsys):
|
|
saved = self._run(
|
|
args=_ns(),
|
|
portal="https://nous-account-service-git-feat-x.vercel.app",
|
|
)
|
|
assert (
|
|
saved["HERMES_DASHBOARD_PORTAL_URL"]
|
|
== "https://nous-account-service-git-feat-x.vercel.app"
|
|
)
|
|
|
|
|
|
class TestIdempotentRerun(TestHappyPath):
|
|
"""Re-running with a stored client_id updates instead of creating.
|
|
|
|
Inherits ``_run`` from TestHappyPath; the only new lever is
|
|
``existing_client_id`` (the HERMES_DASHBOARD_OAUTH_CLIENT_ID a prior run
|
|
persisted), which the CLI re-sends so the portal updates that row.
|
|
"""
|
|
|
|
def test_stored_client_id_is_sent_as_idempotency_key(self, capsys):
|
|
captured: dict = {}
|
|
# Portal echoes back the SAME id -> it updated in place.
|
|
self._run(
|
|
args=_ns(),
|
|
existing_client_id="agent:selfhost-1",
|
|
response={
|
|
"client_id": "agent:selfhost-1",
|
|
"id": "selfhost-1",
|
|
"name": "dreamy_tesla",
|
|
"kind": "SELF_HOSTED",
|
|
"custom_redirect_uri": None,
|
|
"created_at": "2026-06-04T12:00:00.000Z",
|
|
},
|
|
captured=captured,
|
|
)
|
|
assert captured["body"]["client_id"] == "agent:selfhost-1"
|
|
|
|
def test_rerun_without_name_omits_name_to_preserve_stored(self, capsys):
|
|
# No --name on a re-run: don't churn the portal-stored name. The CLI
|
|
# leaves `name` out of the body so the portal keeps what it has.
|
|
captured: dict = {}
|
|
self._run(
|
|
args=_ns(),
|
|
existing_client_id="agent:selfhost-1",
|
|
captured=captured,
|
|
)
|
|
assert "name" not in captured["body"]
|
|
assert captured["body"]["client_id"] == "agent:selfhost-1"
|
|
|
|
def test_rerun_with_explicit_name_still_sends_name(self, capsys):
|
|
captured: dict = {}
|
|
self._run(
|
|
args=_ns(name="renamed_box"),
|
|
existing_client_id="agent:selfhost-1",
|
|
captured=captured,
|
|
)
|
|
assert captured["body"]["name"] == "renamed_box"
|
|
assert captured["body"]["client_id"] == "agent:selfhost-1"
|
|
|
|
def test_rerun_prints_updated_when_same_id_returned(self, capsys):
|
|
self._run(
|
|
args=_ns(),
|
|
existing_client_id="agent:selfhost-1",
|
|
response={
|
|
"client_id": "agent:selfhost-1",
|
|
"id": "selfhost-1",
|
|
"name": "dreamy_tesla",
|
|
"kind": "SELF_HOSTED",
|
|
"custom_redirect_uri": None,
|
|
"created_at": "2026-06-04T12:00:00.000Z",
|
|
},
|
|
)
|
|
out = capsys.readouterr().out
|
|
assert "Updated dashboard" in out
|
|
assert "Registered dashboard" not in out
|
|
|
|
def test_rerun_persists_returned_client_id(self, capsys):
|
|
saved = self._run(
|
|
args=_ns(),
|
|
existing_client_id="agent:selfhost-1",
|
|
)
|
|
# Same id round-trips into .env -> idempotent, one record.
|
|
assert saved["HERMES_DASHBOARD_OAUTH_CLIENT_ID"] == "agent:selfhost-1"
|
|
|
|
def test_stale_id_falls_through_to_create_prints_registered(self, capsys):
|
|
# Stored id no longer resolves server-side -> portal created a fresh
|
|
# row and returns a DIFFERENT id. The CLI treats that as a create and
|
|
# persists the new id (re-run stays safe, never worse than first run).
|
|
captured: dict = {}
|
|
saved = self._run(
|
|
args=_ns(name="seed_name"),
|
|
existing_client_id="agent:selfhost-stale",
|
|
response={
|
|
"client_id": "agent:selfhost-new",
|
|
"id": "selfhost-new",
|
|
"name": "seed_name",
|
|
"kind": "SELF_HOSTED",
|
|
"custom_redirect_uri": None,
|
|
"created_at": "2026-06-04T12:00:00.000Z",
|
|
},
|
|
captured=captured,
|
|
)
|
|
# The stale id is still SENT (portal decides create-vs-update).
|
|
assert captured["body"]["client_id"] == "agent:selfhost-stale"
|
|
# Returned id differs from what we sent -> message is "Registered".
|
|
out = capsys.readouterr().out
|
|
assert "Registered dashboard" in out
|
|
assert "Updated dashboard" not in out
|
|
assert saved["HERMES_DASHBOARD_OAUTH_CLIENT_ID"] == "agent:selfhost-new"
|
|
|
|
def test_blank_stored_client_id_treated_as_first_run(self, capsys):
|
|
# A blank/whitespace stored value is not a usable key: treat as a
|
|
# first registration (auto-generate a name, don't send client_id).
|
|
captured: dict = {}
|
|
self._run(
|
|
args=_ns(),
|
|
existing_client_id=" ",
|
|
captured=captured,
|
|
)
|
|
assert "client_id" not in captured["body"]
|
|
assert captured["body"].get("name") # auto-generated
|
|
|
|
|
|
class TestPortalResolution:
|
|
def test_override_arg_wins(self):
|
|
assert (
|
|
dr._resolve_portal_base_url("https://preview.example.com/")
|
|
== "https://preview.example.com"
|
|
)
|
|
|
|
def test_falls_back_to_stored_login_portal(self):
|
|
with patch(
|
|
"hermes_cli.auth.get_provider_auth_state",
|
|
return_value={"portal_base_url": "https://portal.staging-nousresearch.com"},
|
|
):
|
|
assert (
|
|
dr._resolve_portal_base_url(None)
|
|
== "https://portal.staging-nousresearch.com"
|
|
)
|
|
|
|
def test_blank_override_ignored(self):
|
|
with patch(
|
|
"hermes_cli.auth.get_provider_auth_state",
|
|
return_value={"portal_base_url": "https://portal.staging-nousresearch.com"},
|
|
):
|
|
assert (
|
|
dr._resolve_portal_base_url(" ")
|
|
== "https://portal.staging-nousresearch.com"
|
|
)
|
|
|
|
|
|
class TestPortalErrors:
|
|
def _run_http_error(self, code, body):
|
|
err = urllib.error.HTTPError(
|
|
url="https://portal.nousresearch.com/api/oauth/self-hosted-client",
|
|
code=code,
|
|
msg="err",
|
|
hdrs=None,
|
|
fp=BytesIO(json.dumps(body).encode()),
|
|
)
|
|
|
|
with patch(
|
|
"hermes_cli.auth.resolve_nous_access_token", return_value="tok"
|
|
), patch("hermes_cli.config.is_managed", return_value=False), patch.object(
|
|
dr, "_resolve_portal_base_url", return_value="https://portal.nousresearch.com"
|
|
), patch.object(dr.urllib.request, "urlopen", side_effect=err):
|
|
with pytest.raises(SystemExit) as exc:
|
|
dr.cmd_dashboard_register(_ns())
|
|
return exc.value.code
|
|
|
|
def test_401_maps_to_reauth_message(self, capsys):
|
|
code = self._run_http_error(401, {"error": "invalid_token"})
|
|
assert code == 1
|
|
assert "re-authenticate" in capsys.readouterr().out
|
|
|
|
def test_403_surfaces_server_detail(self, capsys):
|
|
code = self._run_http_error(
|
|
403, {"error": "access_denied", "error_description": "Not permitted here."}
|
|
)
|
|
assert code == 1
|
|
assert "Not permitted here." in capsys.readouterr().out
|