Files
hermes-agent/tests/hermes_cli/test_env_export_line_lifecycle.py
T
Teknium 9a987f142d fix(credentials): unified provider key delete/update across .env, auth.json, config.yaml (#67213)
* fix(env): recognize export-prefixed .env lines in save/remove (#40041)

load_env() parses bash-compatible 'export KEY=value' lines (#6659), so a
hand-added 'export GITHUB_TOKEN=ghp_...' shows as set (green light) in the
desktop Tools & Keys page. But save_env_value/remove_env_value only matched
plain 'KEY=' lines:

- DELETE /api/env 404'd ('not found in .env') — the token could not be
  removed through the UI
- PUT /api/env appended a SECOND line; a later delete removed the new line
  while the export line silently resurrected the old value

Both writers now match assignments through a shared _env_line_defines_key()
helper that understands the export prefix. Commented-out lines are still
ignored.

Regression tests drive the real dashboard endpoint handlers against a temp
HERMES_HOME with runtime-constructed classic-PAT-shaped fixtures, covering
save-does-not-500, export-line remove, export-line replace-without-duplicate,
and the plain-line path staying intact.

Fixes #40041

* fix(credentials): unify provider key delete/update across .env, auth.json, config.yaml (#51071 #59761 #62269)

A provider API key can live in three stores at once: ~/.hermes/.env,
auth.json credential_pool (env-seeded 'env:<VAR>' entries persisted by the
pool loader), and config.yaml mirrors (model.api_key, auxiliary.*.api_key,
custom_providers[*].api_key). The desktop/dashboard endpoints and the TUI
gateway RPCs only ever mutated .env, so the stores diverged:

- #51071/#59761: DELETE /api/env removed the key from .env but left the
  credential_pool entry (the loader is additive-only and never prunes),
  so the provider kept appearing in the model picker — surviving restart
  via the stale pool entry + provider_models_cache.json row.
- #62269: PUT /api/env rewrote .env but left the OLD key in config.yaml
  (model.api_key wins over env at client construction), producing 401s
  with a key the UI no longer showed.

New hermes_cli/credential_lifecycle.py is the single choke point:

- remove_provider_env_credential(): clears the .env entry, prunes
  env:<VAR> pool entries across ALL providers (a shared var like
  GITHUB_TOKEN can seed several), suppresses the env source so a lingering
  shell export can't re-seed it (matching 'hermes auth remove' semantics),
  drops the affected providers' model-cache rows, and scrubs value-matched
  config.yaml api_key mirrors. Returns 'found' spanning every store so a
  stale pool-only entry is cleanable through the same delete button.
- save_provider_env_credential(): writes .env, rotates any config.yaml
  mirror that held the PREVIOUS value (value-matched — an unrelated inline
  key is untouched), and lifts a prior env-source suppression so re-adding
  behaves like 'hermes auth add'.

OAuth preservation: only entries with source == 'env:<VAR>' are pruned.
OAuth/device-code/manual/borrowed pool entries and providers.<id> OAuth
token blocks are never touched by a key-only delete. (model.disconnect in
the TUI gateway still clears OAuth via clear_provider_auth — that surface
is a full provider disconnect, which is the documented intent there.)

Rerouted call sites: PUT/DELETE /api/env (dashboard + desktop),
tui_gateway model.save_key / model.disconnect, save_env_value_secure
(TUI/gateway secret capture), and hermes config set/unset for env-shaped
keys.

E2E tests drive the real endpoint handlers against temp-HERMES_HOME
fixtures (.env + auth.json + config.yaml with runtime-constructed fake
keys) and assert cross-store consistency after delete/update, pool-reload
survival ('restart'), OAuth preservation, models-cache invalidation, and
the suppress/unsuppress round-trip.

Fixes #51071
Fixes #59761
Fixes #62269
2026-07-19 03:02:21 -07:00

126 lines
4.3 KiB
Python

"""Regression tests for the Tools & Keys GitHub PAT save/remove path (#40041).
Users following generic docs add ``export GITHUB_TOKEN=ghp_...`` to
``~/.hermes/.env``. ``load_env()`` parses the export prefix (#6659), so every
UI shows the token as set (green light) — but ``save_env_value`` /
``remove_env_value`` only matched plain ``KEY=`` lines. Result: the UI could
neither replace nor remove the token (delete 404s as "not found in .env";
save appends a duplicate line that a later delete removes while the export
line silently resurrects the old value).
Fake tokens are constructed at runtime — no key-shaped literals on disk.
"""
import pytest
from fastapi.testclient import TestClient
from hermes_cli.web_server import _SESSION_TOKEN, app
client = TestClient(app)
HEADERS = {"X-Hermes-Session-Token": _SESSION_TOKEN}
# Classic-PAT-shaped token, constructed at runtime (36 chars after prefix).
OLD_PAT = "ghp_" + "A" * 36
NEW_PAT = "ghp_" + "B" * 36
@pytest.fixture
def hermes_home(monkeypatch, tmp_path):
home = tmp_path / "pat_home"
home.mkdir()
monkeypatch.setenv("HERMES_HOME", str(home))
from hermes_cli.config import invalidate_env_cache
invalidate_env_cache()
return home
def _write_env_raw(home, text):
home.joinpath(".env").write_text(text, encoding="utf-8")
from hermes_cli.config import invalidate_env_cache
invalidate_env_cache()
def test_classic_pat_save_via_endpoint_succeeds(hermes_home):
"""Saving a ghp_* classic PAT through the env endpoint must not 500 —
GITHUB_TOKEN is a REST/Skills-Hub credential, not a Copilot one."""
resp = client.put(
"/api/env", json={"key": "GITHUB_TOKEN", "value": NEW_PAT}, headers=HEADERS
)
assert resp.status_code == 200, resp.text
from hermes_cli.config import load_env
assert load_env()["GITHUB_TOKEN"] == NEW_PAT
def test_remove_export_prefixed_token(hermes_home):
"""DELETE must clear an ``export KEY=...`` line, not 404 on it."""
_write_env_raw(hermes_home, f"export GITHUB_TOKEN={OLD_PAT}\n")
resp = client.request(
"DELETE", "/api/env", json={"key": "GITHUB_TOKEN"}, headers=HEADERS
)
assert resp.status_code == 200, (
"export-prefixed lines are parsed by load_env (UI shows the token as "
"set) so the delete path must recognise them too (#40041)"
)
env_text = hermes_home.joinpath(".env").read_text(encoding="utf-8")
assert OLD_PAT not in env_text
from hermes_cli.config import load_env
assert "GITHUB_TOKEN" not in load_env()
def test_update_export_prefixed_token_does_not_duplicate(hermes_home):
"""Saving over an ``export KEY=`` line must replace it in place."""
_write_env_raw(hermes_home, f"export GITHUB_TOKEN={OLD_PAT}\n")
resp = client.put(
"/api/env", json={"key": "GITHUB_TOKEN", "value": NEW_PAT}, headers=HEADERS
)
assert resp.status_code == 200
env_text = hermes_home.joinpath(".env").read_text(encoding="utf-8")
assert OLD_PAT not in env_text, "old exported token line must be replaced"
assert env_text.count("GITHUB_TOKEN") == 1, (
"save must not append a duplicate GITHUB_TOKEN line alongside the "
"export-prefixed one"
)
from hermes_cli.config import load_env
assert load_env()["GITHUB_TOKEN"] == NEW_PAT
def test_plain_line_save_and_remove_still_work(hermes_home):
"""Sanity: the ordinary KEY= path is unchanged."""
from hermes_cli.config import load_env, remove_env_value, save_env_value
save_env_value("GITHUB_TOKEN", OLD_PAT)
assert load_env()["GITHUB_TOKEN"] == OLD_PAT
save_env_value("GITHUB_TOKEN", NEW_PAT)
env_text = hermes_home.joinpath(".env").read_text(encoding="utf-8")
assert env_text.count("GITHUB_TOKEN") == 1
assert remove_env_value("GITHUB_TOKEN") is True
assert "GITHUB_TOKEN" not in load_env()
def test_export_line_with_comment_untouched(hermes_home):
"""Commented-out export lines are not live assignments — leave them."""
_write_env_raw(
hermes_home,
f"# export GITHUB_TOKEN={OLD_PAT}\nOTHER_KEY=value\n",
)
resp = client.request(
"DELETE", "/api/env", json={"key": "GITHUB_TOKEN"}, headers=HEADERS
)
assert resp.status_code == 404
env_text = hermes_home.joinpath(".env").read_text(encoding="utf-8")
assert "# export GITHUB_TOKEN=" in env_text
assert "OTHER_KEY=value" in env_text