ca1d341d4f
tracker-policy-pr / check-pr (pull_request) Successful in 14s
test / integration-docker (pull_request) Successful in 18s
test / unit (pull_request) Successful in 46s
lint / lint (push) Failing after 54s
test / integration-firecracker (pull_request) Successful in 3m21s
test / coverage (pull_request) Successful in 18s
test / publish-infra (pull_request) Has been skipped
The codebase used "control plane" both as an architectural role term AND
as an identifier alias for the orchestrator component, producing
duplicate names for one thing (control_plane_url vs orchestrator_url,
CONTROL_PLANE_PORT, host_control_plane_token, …). Going forward the
concrete component is always named for what it is — Gateway or
Orchestrator — and the plane vocabulary is reserved for prose (module
descriptions, the security argument).
Renamed (identifiers + the in-repo env/wire/file string values, all
setters/getters are in this repo so the change is atomic):
ControlPlaneServer -> OrchestratorServer
control_plane_url -> orchestrator_url
probe_control_plane_url -> probe_orchestrator_url
host_control_plane_token -> host_orchestrator_token
CONTROL_PLANE_PORT -> ORCHESTRATOR_PORT
CONTROL_PLANE_TOKEN_ENV/FILE -> ORCHESTRATOR_TOKEN_ENV/FILENAME
BOT_BOTTLE_CONTROL_PLANE_TOKEN-> BOT_BOTTLE_ORCHESTRATOR_TOKEN
control-plane-token (file) -> orchestrator-token
control_auth (module) -> orchestrator_auth (stays top-level;
the gateway imports it and must not
import the orchestrator/ package)
CONTROL_AUTH_HEADER -> ORCHESTRATOR_AUTH_HEADER
x-bot-bottle-control-auth -> x-bot-bottle-orchestrator-auth
CONTROL_AUTH_JWT_ENV -> ORCHESTRATOR_AUTH_JWT_ENV
BOT_BOTTLE_CONTROL_AUTH_JWT -> BOT_BOTTLE_ORCHESTRATOR_AUTH_JWT
_control_auth_headers -> _orchestrator_auth_headers
Prose plane-terms ("control plane", "data plane") are preserved,
including the test name test_data_plane_daemons_get_jwt_not_key (it
names the security invariant). Gateway and orchestrator verified to
agree on the renamed wire header; full unit suite green (2243).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
172 lines
7.0 KiB
Python
172 lines
7.0 KiB
Python
"""Unit: host-side orchestrator control-plane client (PRD 0070). HTTP mocked."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import unittest
|
|
import urllib.error
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from bot_bottle.orchestrator_auth import ROLE_CLI, verify
|
|
from bot_bottle.orchestrator.client import (
|
|
OrchestratorClient,
|
|
OrchestratorClientError,
|
|
RegisteredBottle,
|
|
_host_auth_token,
|
|
)
|
|
|
|
_URLOPEN = "bot_bottle.orchestrator.client.urllib.request.urlopen"
|
|
|
|
|
|
class TestHostAuthToken(unittest.TestCase):
|
|
def test_mints_a_cli_token_from_the_host_key(self) -> None:
|
|
with patch("bot_bottle.orchestrator.client.host_orchestrator_token",
|
|
return_value="signing-key"):
|
|
tok = _host_auth_token()
|
|
self.assertEqual(ROLE_CLI, verify(tok, "signing-key"))
|
|
|
|
def test_returns_empty_when_key_unreadable(self) -> None:
|
|
with patch("bot_bottle.orchestrator.client.host_orchestrator_token",
|
|
side_effect=OSError("no host root")):
|
|
self.assertEqual("", _host_auth_token())
|
|
|
|
|
|
def _resp(status: int, payload: object) -> MagicMock:
|
|
m = MagicMock()
|
|
inner = m.__enter__.return_value
|
|
inner.status = status
|
|
inner.read.return_value = json.dumps(payload).encode()
|
|
return m
|
|
|
|
|
|
def _http_error(code: int, payload: object = None) -> urllib.error.HTTPError:
|
|
del payload # the client tolerates an empty error body; keep the signature
|
|
return urllib.error.HTTPError("http://x", code, "err", {}, None) # type: ignore[arg-type]
|
|
|
|
|
|
class TestRegister(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.c = OrchestratorClient("http://orch:8080")
|
|
|
|
def test_register_returns_id_and_token(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(201, {"bottle_id": "b1", "identity_token": "tok"})):
|
|
got = self.c.register_bottle("10.0.0.2", policy="routes: []\n", metadata="{}")
|
|
self.assertEqual(RegisteredBottle("b1", "tok"), got)
|
|
|
|
def test_register_posts_source_ip_and_policy(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(201, {"bottle_id": "b", "identity_token": "t"})) as m:
|
|
self.c.register_bottle("10.0.0.9", policy="P", metadata="M", image_ref="img")
|
|
sent = json.loads(m.call_args.args[0].data)
|
|
self.assertEqual("10.0.0.9", sent["source_ip"])
|
|
self.assertEqual("P", sent["policy"])
|
|
self.assertEqual("img", sent["image_ref"])
|
|
|
|
def test_register_missing_fields_raises(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(201, {"bottle_id": "b1"})):
|
|
with self.assertRaises(OrchestratorClientError):
|
|
self.c.register_bottle("10.0.0.2")
|
|
|
|
def test_register_non_2xx_raises(self) -> None:
|
|
with patch(_URLOPEN, side_effect=_http_error(400, {"error": "bad"})):
|
|
with self.assertRaises(OrchestratorClientError):
|
|
self.c.register_bottle("")
|
|
|
|
|
|
class TestTeardown(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.c = OrchestratorClient("http://orch:8080")
|
|
|
|
def test_teardown_true_on_success(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"torn_down": True})):
|
|
self.assertTrue(self.c.teardown_bottle("b1"))
|
|
|
|
def test_teardown_false_on_404(self) -> None:
|
|
# Idempotent: an already-gone bottle is a clean no-op.
|
|
with patch(_URLOPEN, side_effect=_http_error(404)):
|
|
self.assertFalse(self.c.teardown_bottle("gone"))
|
|
|
|
def test_teardown_uses_delete(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"torn_down": True})) as m:
|
|
self.c.teardown_bottle("b1")
|
|
self.assertEqual("DELETE", m.call_args.args[0].get_method())
|
|
|
|
|
|
class TestReprovisionGateway(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.c = OrchestratorClient("http://orch:8080")
|
|
|
|
def test_success_posts_key(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"reprovisioned": True})) as opened:
|
|
self.assertTrue(self.c.reprovision_gateway("b1", "key"))
|
|
request = opened.call_args.args[0]
|
|
self.assertEqual("POST", request.get_method())
|
|
self.assertEqual({"env_var_secret": "key"}, json.loads(request.data))
|
|
|
|
def test_missing_stored_secret_is_false(self) -> None:
|
|
with patch(_URLOPEN, side_effect=_http_error(404)):
|
|
self.assertFalse(self.c.reprovision_gateway("b1", "key"))
|
|
|
|
def test_other_status_raises(self) -> None:
|
|
with patch(_URLOPEN, side_effect=_http_error(400)):
|
|
with self.assertRaises(OrchestratorClientError):
|
|
self.c.reprovision_gateway("b1", "key")
|
|
|
|
|
|
class TestHealthAndPolicy(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.c = OrchestratorClient("http://orch:8080")
|
|
|
|
def test_health_true_on_200(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"status": "ok"})):
|
|
self.assertTrue(self.c.health())
|
|
|
|
def test_health_false_when_unreachable(self) -> None:
|
|
with patch(_URLOPEN, side_effect=urllib.error.URLError("refused")):
|
|
self.assertFalse(self.c.health())
|
|
|
|
def test_set_policy_false_on_404(self) -> None:
|
|
with patch(_URLOPEN, side_effect=_http_error(404)):
|
|
self.assertFalse(self.c.set_policy("gone", "P"))
|
|
|
|
def test_set_policy_true_on_success(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"updated": True})):
|
|
self.assertTrue(self.c.set_policy("b1", "P"))
|
|
|
|
def test_unreachable_raises(self) -> None:
|
|
with patch(_URLOPEN, side_effect=urllib.error.URLError("refused")):
|
|
with self.assertRaises(OrchestratorClientError):
|
|
self.c.register_bottle("10.0.0.2")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|
|
|
|
|
|
class TestReconcile(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.c = OrchestratorClient("http://orch:8080")
|
|
|
|
def test_posts_live_ips_and_returns_reaped(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"reaped": ["b1", "b2"]})) as m:
|
|
got = self.c.reconcile(["10.0.0.2", "10.0.0.3"])
|
|
self.assertEqual(["b1", "b2"], got)
|
|
sent = json.loads(m.call_args.args[0].data)
|
|
self.assertEqual(["10.0.0.2", "10.0.0.3"], sent["live_source_ips"])
|
|
self.assertNotIn("grace_seconds", sent) # omitted -> server default
|
|
|
|
def test_grace_seconds_is_forwarded_when_given(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"reaped": []})) as m:
|
|
self.c.reconcile([], grace_seconds=30)
|
|
self.assertEqual(30, json.loads(m.call_args.args[0].data)["grace_seconds"])
|
|
|
|
def test_malformed_reaped_is_tolerated(self) -> None:
|
|
with patch(_URLOPEN, return_value=_resp(200, {"reaped": ["ok", 5, None]})):
|
|
self.assertEqual(["ok"], self.c.reconcile([]))
|
|
with patch(_URLOPEN, return_value=_resp(200, {})):
|
|
self.assertEqual([], self.c.reconcile([]))
|
|
|
|
def test_error_status_raises(self) -> None:
|
|
with patch(_URLOPEN, side_effect=_http_error(500)):
|
|
with self.assertRaises(OrchestratorClientError):
|
|
self.c.reconcile([])
|