10d0872043
Replace _merge_provider_route's five-case nested conditional with a flat provisioned-wins merge: provider routes claim their hosts outright, manifest routes for unclaimed hosts append unchanged. Token slot assignment moves to a single _assign_token_slots pass over the merged list. Add _route_to_yaml_fields as the single authoritative EgressRoute→YAML mapping, eliminating the risk of EgressRoute and egress_addon_core.Route silently drifting apart when new fields are added. egress_manifest_routes is now a pure lifter with no slot assignment. _merge_provider_route and _find_or_alloc_token_env are removed. Tests updated: conflict-die case removed, upgrade-bare replaced with provider-wins semantics, slot-assignment tests moved to TestSlotAssignment.
357 lines
14 KiB
Python
357 lines
14 KiB
Python
"""Unit: Egress route lift + routes.yaml render + token
|
|
resolution (PRD 0017)."""
|
|
|
|
import unittest
|
|
|
|
from bot_bottle.egress import (
|
|
CODEX_HOST_CREDENTIAL_TOKEN_REF,
|
|
EgressRoute,
|
|
egress_manifest_routes,
|
|
egress_render_routes,
|
|
egress_resolve_token_values,
|
|
egress_routes_for_bottle,
|
|
egress_token_env_map,
|
|
)
|
|
from bot_bottle.log import Die
|
|
from bot_bottle.manifest import Manifest
|
|
from bot_bottle.yaml_subset import parse_yaml_subset
|
|
|
|
|
|
def _bottle(routes):
|
|
return Manifest.from_json_obj({
|
|
"bottles": {"dev": {"egress": {"routes": routes}}},
|
|
"agents": {"demo": {"skills": [], "prompt": "", "bottle": "dev"}},
|
|
}).bottles["dev"]
|
|
|
|
|
|
def _provider_route(host: str, token_ref: str, *, tls_passthrough: bool = False) -> EgressRoute:
|
|
return EgressRoute(
|
|
host=host,
|
|
auth_scheme="Bearer",
|
|
token_ref=token_ref,
|
|
tls_passthrough=tls_passthrough,
|
|
)
|
|
|
|
|
|
class TestManifestRouteLift(unittest.TestCase):
|
|
"""egress_manifest_routes is a pure lifter — no slot assignment."""
|
|
|
|
def test_authenticated_route_lifted_without_slot(self):
|
|
b = _bottle([{
|
|
"host": "api.github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"},
|
|
}])
|
|
routes = egress_manifest_routes(b)
|
|
self.assertEqual(1, len(routes))
|
|
r = routes[0]
|
|
self.assertEqual("api.github.com", r.host)
|
|
self.assertEqual("Bearer", r.auth_scheme)
|
|
self.assertEqual("GH_PAT", r.token_ref)
|
|
self.assertEqual("", r.token_env) # slot assigned later
|
|
self.assertEqual((), r.path_allowlist)
|
|
|
|
def test_unauthenticated_route_has_empty_auth_fields(self):
|
|
b = _bottle([{"host": "github.com", "path_allowlist": ["/x/"]}])
|
|
routes = egress_manifest_routes(b)
|
|
r = routes[0]
|
|
self.assertEqual("", r.auth_scheme)
|
|
self.assertEqual("", r.token_env)
|
|
self.assertEqual("", r.token_ref)
|
|
self.assertEqual(("/x/",), r.path_allowlist)
|
|
|
|
|
|
class TestSlotAssignment(unittest.TestCase):
|
|
"""Slot assignment happens in egress_routes_for_bottle."""
|
|
|
|
def test_authenticated_route_gets_slot(self):
|
|
b = _bottle([{
|
|
"host": "api.github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"},
|
|
}])
|
|
routes = egress_routes_for_bottle(b)
|
|
r = routes[0]
|
|
self.assertEqual("EGRESS_TOKEN_0", r.token_env)
|
|
self.assertEqual("GH_PAT", r.token_ref)
|
|
|
|
def test_shared_token_ref_collapses_to_one_slot(self):
|
|
b = _bottle([
|
|
{"host": "api.github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"}},
|
|
{"host": "github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"}},
|
|
])
|
|
routes = egress_routes_for_bottle(b)
|
|
slots = {r.token_env for r in routes}
|
|
self.assertEqual({"EGRESS_TOKEN_0"}, slots)
|
|
|
|
def test_distinct_token_refs_get_distinct_slots(self):
|
|
b = _bottle([
|
|
{"host": "a.example",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T1"}},
|
|
{"host": "b.example",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T2"}},
|
|
])
|
|
routes = egress_routes_for_bottle(b)
|
|
slots = [r.token_env for r in routes]
|
|
self.assertEqual(["EGRESS_TOKEN_0", "EGRESS_TOKEN_1"], slots)
|
|
|
|
def test_unauthenticated_routes_dont_consume_slots(self):
|
|
# A bare-pass route between two authenticated routes mustn't
|
|
# skip a slot number — slot 0 + slot 1 stay tight.
|
|
b = _bottle([
|
|
{"host": "a.example",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T1"}},
|
|
{"host": "passthrough.example"},
|
|
{"host": "b.example",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T2"}},
|
|
])
|
|
routes = egress_routes_for_bottle(b)
|
|
authed = [r.token_env for r in routes if r.token_env]
|
|
self.assertEqual(["EGRESS_TOKEN_0", "EGRESS_TOKEN_1"], authed)
|
|
self.assertEqual("", routes[1].token_env)
|
|
|
|
|
|
class TestRoutesForBottleManifestOnly(unittest.TestCase):
|
|
"""Without provider routes the effective table is exactly the manifest."""
|
|
|
|
def test_no_manifest_routes_means_no_effective_routes(self):
|
|
b = _bottle([])
|
|
self.assertEqual((), egress_routes_for_bottle(b))
|
|
|
|
def test_manifest_route_preserved_with_auth(self):
|
|
b = _bottle([{
|
|
"host": "api.anthropic.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T"},
|
|
}])
|
|
routes = egress_routes_for_bottle(b)
|
|
self.assertEqual(1, len(routes))
|
|
self.assertEqual("api.anthropic.com", routes[0].host)
|
|
self.assertEqual("Bearer", routes[0].auth_scheme)
|
|
|
|
def test_manifest_only(self):
|
|
b = _bottle([{"host": "x.example"}])
|
|
effective = [r.host for r in egress_routes_for_bottle(b)]
|
|
self.assertEqual(["x.example"], effective)
|
|
|
|
def test_tls_passthrough_lifted_from_manifest(self):
|
|
b = _bottle([{
|
|
"host": "api.openai.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T"},
|
|
"pipelock": {"tls_passthrough": True},
|
|
}])
|
|
routes = egress_routes_for_bottle(b)
|
|
self.assertTrue(routes[0].tls_passthrough)
|
|
|
|
def test_tls_passthrough_false_by_default(self):
|
|
b = _bottle([{"host": "api.github.com"}])
|
|
routes = egress_routes_for_bottle(b)
|
|
self.assertFalse(routes[0].tls_passthrough)
|
|
|
|
|
|
class TestProviderRouteMerge(unittest.TestCase):
|
|
"""Provider routes win on host collision; manifest fills the rest."""
|
|
|
|
def test_provider_route_appended_when_not_in_manifest(self):
|
|
b = _bottle([])
|
|
pr = _provider_route("api.openai.com", "TOK")
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
self.assertEqual(1, len(routes))
|
|
self.assertEqual("api.openai.com", routes[0].host)
|
|
self.assertEqual("Bearer", routes[0].auth_scheme)
|
|
self.assertEqual("EGRESS_TOKEN_0", routes[0].token_env)
|
|
self.assertEqual("TOK", routes[0].token_ref)
|
|
|
|
def test_unauthenticated_provider_route_appends_without_token_slot(self):
|
|
b = _bottle([])
|
|
pr = EgressRoute(host="api.openai.com", tls_passthrough=True)
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
self.assertEqual(1, len(routes))
|
|
self.assertEqual("api.openai.com", routes[0].host)
|
|
self.assertEqual("", routes[0].auth_scheme)
|
|
self.assertEqual("", routes[0].token_env)
|
|
self.assertEqual("", routes[0].token_ref)
|
|
self.assertEqual({}, egress_token_env_map(routes))
|
|
|
|
def test_provider_route_wins_over_bare_manifest_route(self):
|
|
# Provisioned host wins outright; manifest path_allowlist is dropped.
|
|
b = _bottle([{"host": "api.openai.com", "path_allowlist": ["/v1/"]}])
|
|
pr = EgressRoute(host="api.openai.com", tls_passthrough=True)
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
self.assertEqual(1, len(routes))
|
|
self.assertEqual("", routes[0].auth_scheme)
|
|
self.assertEqual("", routes[0].token_env)
|
|
self.assertEqual("", routes[0].token_ref)
|
|
self.assertTrue(routes[0].tls_passthrough)
|
|
self.assertEqual((), routes[0].path_allowlist)
|
|
self.assertEqual({}, egress_token_env_map(routes))
|
|
|
|
def test_two_provider_routes_with_same_token_ref_share_slot(self):
|
|
b = _bottle([])
|
|
routes = egress_routes_for_bottle(b, (
|
|
_provider_route("api.openai.com", CODEX_HOST_CREDENTIAL_TOKEN_REF),
|
|
_provider_route("chatgpt.com", CODEX_HOST_CREDENTIAL_TOKEN_REF),
|
|
))
|
|
self.assertEqual(["api.openai.com", "chatgpt.com"], [r.host for r in routes])
|
|
self.assertEqual("EGRESS_TOKEN_0", routes[0].token_env)
|
|
self.assertEqual("EGRESS_TOKEN_0", routes[1].token_env)
|
|
|
|
def test_provider_route_wins_over_authed_manifest_route(self):
|
|
# Provider wins even when manifest has its own auth for the host.
|
|
b = _bottle([{"host": "chatgpt.com",
|
|
"path_allowlist": ["/backend-api/"],
|
|
"auth": {"scheme": "Bearer", "token_ref": "OTHER"}}])
|
|
pr = _provider_route("chatgpt.com", CODEX_HOST_CREDENTIAL_TOKEN_REF)
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
self.assertEqual(1, len(routes))
|
|
self.assertEqual("chatgpt.com", routes[0].host)
|
|
self.assertEqual("Bearer", routes[0].auth_scheme)
|
|
self.assertEqual("EGRESS_TOKEN_0", routes[0].token_env)
|
|
self.assertEqual(CODEX_HOST_CREDENTIAL_TOKEN_REF, routes[0].token_ref)
|
|
self.assertEqual((), routes[0].path_allowlist)
|
|
|
|
def test_manifest_route_preserved_for_non_provisioned_host(self):
|
|
b = _bottle([
|
|
{"host": "api.openai.com"},
|
|
{"host": "api.github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"}},
|
|
])
|
|
pr = _provider_route("api.openai.com", CODEX_HOST_CREDENTIAL_TOKEN_REF)
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
hosts = [r.host for r in routes]
|
|
self.assertEqual(["api.openai.com", "api.github.com"], hosts)
|
|
self.assertEqual(CODEX_HOST_CREDENTIAL_TOKEN_REF, routes[0].token_ref)
|
|
self.assertEqual("GH_PAT", routes[1].token_ref)
|
|
|
|
def test_provider_route_tls_passthrough_set_on_appended_route(self):
|
|
b = _bottle([])
|
|
pr = _provider_route("api.openai.com", "TOK", tls_passthrough=True)
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
self.assertTrue(routes[0].tls_passthrough)
|
|
|
|
def test_provider_route_tls_passthrough_wins_over_bare_manifest_route(self):
|
|
b = _bottle([{"host": "api.openai.com"}])
|
|
pr = _provider_route("api.openai.com", "TOK", tls_passthrough=True)
|
|
routes = egress_routes_for_bottle(b, (pr,))
|
|
self.assertTrue(routes[0].tls_passthrough)
|
|
|
|
|
|
class TestTokenEnvMap(unittest.TestCase):
|
|
def test_only_authenticated_routes_contribute(self):
|
|
b = _bottle([
|
|
{"host": "a.example",
|
|
"auth": {"scheme": "Bearer", "token_ref": "T1"}},
|
|
{"host": "passthrough.example"},
|
|
])
|
|
routes = egress_routes_for_bottle(b)
|
|
m = egress_token_env_map(routes)
|
|
self.assertEqual({"EGRESS_TOKEN_0": "T1"}, m)
|
|
|
|
def test_no_routes_empty(self):
|
|
self.assertEqual({}, egress_token_env_map(()))
|
|
|
|
|
|
class TestRenderRoutes(unittest.TestCase):
|
|
"""Render is YAML now (PRD 0017 follow-up). Tests parse the
|
|
output via `yaml_subset` — the same parser the addon uses —
|
|
so the assertions check the actual semantic shape the addon
|
|
will see, not the textual layout."""
|
|
|
|
@staticmethod
|
|
def _parsed(routes) -> list[dict]:
|
|
return parse_yaml_subset(egress_render_routes(routes))["routes"]
|
|
|
|
def test_authenticated_route_serialised_with_auth_fields(self):
|
|
b = _bottle([{
|
|
"host": "api.github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"},
|
|
"path_allowlist": ["/repos/x/"],
|
|
}])
|
|
routes = egress_routes_for_bottle(b)
|
|
parsed = self._parsed(routes)
|
|
self.assertEqual(
|
|
[{
|
|
"host": "api.github.com",
|
|
"path_allowlist": ["/repos/x/"],
|
|
"auth_scheme": "Bearer",
|
|
"token_env": "EGRESS_TOKEN_0",
|
|
}],
|
|
parsed,
|
|
)
|
|
|
|
def test_unauthenticated_route_omits_auth_fields(self):
|
|
# auth_scheme + token_env keys are absent when the route was
|
|
# declared without an `auth` block — the addon's parser
|
|
# enforces both-or-neither, so emitting empty strings would
|
|
# round-trip as a partial pair and crash.
|
|
b = _bottle([{"host": "github.com", "path_allowlist": ["/x/"]}])
|
|
routes = egress_routes_for_bottle(b)
|
|
entry = self._parsed(routes)[0]
|
|
self.assertNotIn("auth_scheme", entry)
|
|
self.assertNotIn("token_env", entry)
|
|
|
|
def test_no_path_allowlist_omits_field(self):
|
|
b = _bottle([{
|
|
"host": "api.anthropic.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "CL"},
|
|
}])
|
|
routes = egress_routes_for_bottle(b)
|
|
self.assertNotIn("path_allowlist", self._parsed(routes)[0])
|
|
|
|
def test_empty_routes_round_trips(self):
|
|
rendered = egress_render_routes(())
|
|
# Inline-empty-list form is what the parser accepts.
|
|
self.assertEqual([], parse_yaml_subset(rendered)["routes"])
|
|
|
|
def test_round_trip_through_addon_core(self):
|
|
# Render here → parse in the addon must succeed for every
|
|
# combination the manifest can produce.
|
|
from bot_bottle.egress_addon_core import load_routes
|
|
b = _bottle([
|
|
{"host": "api.github.com",
|
|
"auth": {"scheme": "Bearer", "token_ref": "GH_PAT"},
|
|
"path_allowlist": ["/repos/x/"]},
|
|
{"host": "github.com", "path_allowlist": ["/x/"]},
|
|
{"host": "api.anthropic.com"},
|
|
])
|
|
routes = egress_routes_for_bottle(b)
|
|
addon_routes = load_routes(egress_render_routes(routes))
|
|
self.assertEqual(3, len(addon_routes))
|
|
self.assertEqual("Bearer", addon_routes[0].auth_scheme)
|
|
self.assertEqual("EGRESS_TOKEN_0", addon_routes[0].token_env)
|
|
self.assertEqual("", addon_routes[1].auth_scheme)
|
|
self.assertEqual("", addon_routes[2].auth_scheme)
|
|
|
|
|
|
class TestResolveTokenValues(unittest.TestCase):
|
|
def test_reads_host_env(self):
|
|
out = egress_resolve_token_values(
|
|
{"EGRESS_TOKEN_0": "GH_PAT"},
|
|
{"GH_PAT": "the-value"},
|
|
)
|
|
self.assertEqual({"EGRESS_TOKEN_0": "the-value"}, out)
|
|
|
|
def test_missing_token_ref_dies(self):
|
|
with self.assertRaises(Die):
|
|
egress_resolve_token_values(
|
|
{"EGRESS_TOKEN_0": "GH_PAT"},
|
|
{},
|
|
)
|
|
|
|
def test_empty_token_ref_dies(self):
|
|
with self.assertRaises(Die):
|
|
egress_resolve_token_values(
|
|
{"EGRESS_TOKEN_0": "GH_PAT"},
|
|
{"GH_PAT": ""},
|
|
)
|
|
|
|
def test_codex_host_credential_ref_resolved_via_provisioned_env(self):
|
|
out = egress_resolve_token_values(
|
|
{"EGRESS_TOKEN_0": CODEX_HOST_CREDENTIAL_TOKEN_REF},
|
|
{CODEX_HOST_CREDENTIAL_TOKEN_REF: "codex-access-token"},
|
|
)
|
|
self.assertEqual({"EGRESS_TOKEN_0": "codex-access-token"}, out)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|