Files
hermes-agent/tests/hermes_cli/test_copilot_token_exchange.py
T
Teknium 1737741730 fix(copilot): follow-ups for salvaged PR #58743
- Bound ALL reads of the on-disk JWT store through one _read_jwt_store()
  helper (load, eviction, save-merge) — the 1 MiB cap previously only
  covered the load path; eviction and save could still parse an
  oversized/corrupt store and rewrite it back out (sweeper finding).
- Fix the class, not the site: the recovery gates checked the literal
  provider == "copilot" while /model and profile configs can leave the
  alias spelling in place (the reporter's own log shows provider=copilot
  AND provider=github-copilot in one session — the aliased turns would
  have silently skipped recovery). Single owner:
  AIAgent._is_copilot_provider() (slug aliases + Copilot base-URL
  fallback), used by both run_agent recovery methods and both
  conversation_loop gates.
- Update the salvaged 401 test to current main's client-retirement
  contract (release deferred to GC — no synchronous .close()).
- Add copilot_stale_cred_retry_attempted to the TurnRetryState field
  contract test; add bounded-store and alias-gate regression tests.
2026-07-31 22:31:09 -07:00

190 lines
7.3 KiB
Python

"""Tests for Copilot token exchange (raw GitHub token → Copilot API token)."""
from __future__ import annotations
import json
import time
from unittest.mock import MagicMock, patch
import pytest
@pytest.fixture(autouse=True)
def _clear_jwt_cache():
"""Reset the module-level JWT cache before each test."""
import hermes_cli.copilot_auth as mod
mod._jwt_cache.clear()
yield
mod._jwt_cache.clear()
class TestExchangeCopilotToken:
"""Tests for exchange_copilot_token()."""
def _mock_urlopen(self, token="tid=abc;exp=123;sku=copilot_individual", expires_at=None):
"""Create a mock urlopen context manager returning a token response."""
if expires_at is None:
expires_at = time.time() + 1800
resp_data = json.dumps({"token": token, "expires_at": expires_at}).encode()
mock_resp = MagicMock()
mock_resp.read.return_value = resp_data
mock_resp.__enter__ = MagicMock(return_value=mock_resp)
mock_resp.__exit__ = MagicMock(return_value=False)
return mock_resp
@patch("urllib.request.urlopen")
def test_exchanges_token_successfully(self, mock_urlopen):
from hermes_cli.copilot_auth import exchange_copilot_token
mock_urlopen.return_value = self._mock_urlopen(token="tid=abc;exp=999")
api_token, expires_at, base_url = exchange_copilot_token("gho_test123")
assert api_token == "tid=abc;exp=999"
assert isinstance(expires_at, float)
assert base_url is None # no proxy-ep in this token
# Verify request was made with correct headers
call_args = mock_urlopen.call_args
req = call_args[0][0]
assert req.get_header("Authorization") == "token gho_test123"
assert "GitHubCopilotChat" in req.get_header("User-agent")
@patch("urllib.request.urlopen")
def test_raises_on_empty_token(self, mock_urlopen):
from hermes_cli.copilot_auth import exchange_copilot_token
resp_data = json.dumps({"token": "", "expires_at": 0}).encode()
mock_resp = MagicMock()
mock_resp.read.return_value = resp_data
mock_resp.__enter__ = MagicMock(return_value=mock_resp)
mock_resp.__exit__ = MagicMock(return_value=False)
mock_urlopen.return_value = mock_resp
with pytest.raises(ValueError, match="empty token"):
exchange_copilot_token("gho_test123")
class TestGetCopilotApiToken:
"""Tests for get_copilot_api_token() — the fallback wrapper."""
@patch("hermes_cli.copilot_auth.exchange_copilot_token")
def test_returns_exchanged_token(self, mock_exchange):
from hermes_cli.copilot_auth import get_copilot_api_token
mock_exchange.return_value = ("exchanged_jwt", time.time() + 1800, None)
api_token, base_url = get_copilot_api_token("gho_raw")
assert api_token == "exchanged_jwt"
assert base_url is None
class TestTokenFingerprint:
"""Tests for _token_fingerprint()."""
def test_consistent(self):
from hermes_cli.copilot_auth import _token_fingerprint
fp1 = _token_fingerprint("gho_abc123")
fp2 = _token_fingerprint("gho_abc123")
assert fp1 == fp2
class TestCallerIntegration:
"""Test that callers correctly use token exchange."""
@patch("hermes_cli.copilot_auth.resolve_copilot_token", return_value=("gho_raw", "GH_TOKEN"))
@patch("hermes_cli.copilot_auth.get_copilot_api_token", return_value=("exchanged_jwt", None))
def test_auth_resolve_uses_exchange(self, mock_exchange, mock_resolve):
from hermes_cli.auth import _resolve_api_key_provider_secret
# Create a minimal pconfig mock
pconfig = MagicMock()
token, source = _resolve_api_key_provider_secret("copilot", pconfig)
assert token == "exchanged_jwt"
assert source == "GH_TOKEN"
mock_exchange.assert_called_once_with("gho_raw")
class TestDeriveBaseUrlFromProxyEp:
"""Tests for _derive_base_url_from_proxy_ep()."""
def test_extracts_enterprise_url(self):
from hermes_cli.copilot_auth import _derive_base_url_from_proxy_ep
token = "tid=abc;exp=999;proxy-ep=proxy.enterprise.githubcopilot.com;sku=copilot_enterprise"
assert _derive_base_url_from_proxy_ep(token) == "https://api.enterprise.githubcopilot.com"
@patch("urllib.request.urlopen")
def test_exchange_returns_none_base_url_for_individual(self, mock_urlopen, _clear_jwt_cache):
"""exchange_copilot_token returns None base_url for individual accounts."""
from hermes_cli.copilot_auth import exchange_copilot_token
token_no_ep = "tid=abc;exp=999;sku=copilot_individual"
expires_at = time.time() + 1800
resp_data = json.dumps({"token": token_no_ep, "expires_at": expires_at}).encode()
mock_resp = MagicMock()
mock_resp.read.return_value = resp_data
mock_resp.__enter__ = MagicMock(return_value=mock_resp)
mock_resp.__exit__ = MagicMock(return_value=False)
mock_urlopen.return_value = mock_resp
api_token, _, base_url = exchange_copilot_token("gho_test")
assert base_url is None
class TestJwtDiskStoreBounds:
"""The on-disk JWT store must go through one bounded read everywhere."""
def _store_path(self, tmp_path, monkeypatch):
import hermes_cli.copilot_auth as mod
path = tmp_path / mod._JWT_DISK_FILENAME
monkeypatch.setattr(mod, "_jwt_disk_path", lambda: path)
return path
def test_read_jwt_store_rejects_oversized_file(self, tmp_path, monkeypatch):
import hermes_cli.copilot_auth as mod
path = self._store_path(tmp_path, monkeypatch)
path.write_text("x" * (mod._JWT_DISK_MAX_BYTES + 1))
assert mod._read_jwt_store(path) is None
# Load path treats it as unusable → caller re-exchanges.
assert mod._load_jwt_from_disk("deadbeef") is None
def test_read_jwt_store_rejects_non_dict_and_malformed(self, tmp_path, monkeypatch):
import hermes_cli.copilot_auth as mod
path = self._store_path(tmp_path, monkeypatch)
path.write_text("[1, 2, 3]")
assert mod._read_jwt_store(path) is None
path.write_text("{not json")
assert mod._read_jwt_store(path) is None
def test_evict_ignores_oversized_store(self, tmp_path, monkeypatch):
"""Eviction on an oversized store must not parse or rewrite it."""
import hermes_cli.copilot_auth as mod
path = self._store_path(tmp_path, monkeypatch)
blob = "x" * (mod._JWT_DISK_MAX_BYTES + 1)
path.write_text(blob)
mod.evict_cached_exchanged_token("gho_whatever")
# Untouched — bounded read refused it before any rewrite.
assert path.read_text() == blob
def test_save_discards_oversized_store_instead_of_merging(self, tmp_path, monkeypatch):
"""Saving over a corrupt/oversized store starts fresh rather than
re-serializing the oversized content back out."""
import json as _json
import time as _time
import hermes_cli.copilot_auth as mod
path = self._store_path(tmp_path, monkeypatch)
path.write_text("x" * (mod._JWT_DISK_MAX_BYTES + 1))
mod._save_jwt_to_disk("fp1", "tid=fresh", _time.time() + 1800, None)
store = _json.loads(path.read_text())
assert set(store) == {"fp1"}
assert store["fp1"]["api_token"] == "tid=fresh"