Add sunbeam check verb with service-level health probes
11 checks across 7 namespaces: gitea version+auth, postgres CNPG readiness, valkey PONG, openbao sealed state, seaweedfs filer, kratos health, hydra OIDC discovery, people HTTP (catches 502s), people API, and livekit. Supports ns and ns/svc scoping. - checks.py: new module with _http_get (no-redirect opener + mkcert SSL), kube_exec-based exec checks, and cmd_check dispatch - kube.py: add kube_exec() and get_domain() (reads from cluster configmap) - cli.py: add 'check [target]' verb - 103 tests, all passing
This commit is contained in:
284
sunbeam/tests/test_checks.py
Normal file
284
sunbeam/tests/test_checks.py
Normal file
@@ -0,0 +1,284 @@
|
||||
"""Tests for checks.py — service-level health probes."""
|
||||
import json
|
||||
import unittest
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
|
||||
class TestCheckGiteaVersion(unittest.TestCase):
|
||||
def test_ok_returns_version(self):
|
||||
body = json.dumps({"version": "1.21.0"}).encode()
|
||||
with patch("sunbeam.checks._http_get", return_value=(200, body)):
|
||||
from sunbeam import checks
|
||||
r = checks.check_gitea_version("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
self.assertIn("1.21.0", r.detail)
|
||||
|
||||
def test_non_200_fails(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(502, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_gitea_version("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
self.assertIn("502", r.detail)
|
||||
|
||||
def test_connection_error_fails(self):
|
||||
import urllib.error
|
||||
with patch("sunbeam.checks._http_get", side_effect=urllib.error.URLError("refused")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_gitea_version("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckGiteaAuth(unittest.TestCase):
|
||||
def _secret(self, key, val):
|
||||
def side_effect(ns, name, k):
|
||||
return val if k == key else "gitea_admin"
|
||||
return side_effect
|
||||
|
||||
def test_ok_returns_login(self):
|
||||
body = json.dumps({"login": "gitea_admin"}).encode()
|
||||
with patch("sunbeam.checks._kube_secret",
|
||||
side_effect=self._secret("admin-password", "hunter2")):
|
||||
with patch("sunbeam.checks._http_get", return_value=(200, body)):
|
||||
from sunbeam import checks
|
||||
r = checks.check_gitea_auth("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
self.assertIn("gitea_admin", r.detail)
|
||||
|
||||
def test_missing_password_fails(self):
|
||||
with patch("sunbeam.checks._kube_secret", return_value=""):
|
||||
from sunbeam import checks
|
||||
r = checks.check_gitea_auth("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
self.assertIn("secret", r.detail)
|
||||
|
||||
def test_non_200_fails(self):
|
||||
with patch("sunbeam.checks._kube_secret",
|
||||
side_effect=self._secret("admin-password", "hunter2")):
|
||||
with patch("sunbeam.checks._http_get", return_value=(401, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_gitea_auth("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckPostgres(unittest.TestCase):
|
||||
def test_ready_passes(self):
|
||||
with patch("sunbeam.checks.kube_out", side_effect=["1", "1"]):
|
||||
from sunbeam import checks
|
||||
r = checks.check_postgres("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
self.assertIn("1/1", r.detail)
|
||||
|
||||
def test_not_ready_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", side_effect=["0", "1"]):
|
||||
from sunbeam import checks
|
||||
r = checks.check_postgres("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
def test_cluster_not_found_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value=""):
|
||||
from sunbeam import checks
|
||||
r = checks.check_postgres("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckValkey(unittest.TestCase):
|
||||
def test_pong_passes(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value="valkey-abc"):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(0, "PONG")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_valkey("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_no_pod_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value=""):
|
||||
from sunbeam import checks
|
||||
r = checks.check_valkey("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
def test_no_pong_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value="valkey-abc"):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(1, "")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_valkey("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckOpenbao(unittest.TestCase):
|
||||
def test_unsealed_passes(self):
|
||||
out = json.dumps({"initialized": True, "sealed": False})
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(0, out)):
|
||||
from sunbeam import checks
|
||||
r = checks.check_openbao("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_sealed_fails(self):
|
||||
out = json.dumps({"initialized": True, "sealed": True})
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(2, out)):
|
||||
from sunbeam import checks
|
||||
r = checks.check_openbao("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
def test_no_output_fails(self):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(1, "")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_openbao("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckSeaweedfs(unittest.TestCase):
|
||||
def test_responding_passes(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value="seaweedfs-filer-abc"):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(0, "filer status data")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_seaweedfs("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_no_pod_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value=""):
|
||||
from sunbeam import checks
|
||||
r = checks.check_seaweedfs("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
def test_exec_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value="seaweedfs-filer-abc"):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(1, "")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_seaweedfs("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckKratos(unittest.TestCase):
|
||||
def test_200_passes(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(200, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_kratos("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_503_fails(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(503, b"not ready")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_kratos("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
self.assertIn("503", r.detail)
|
||||
|
||||
|
||||
class TestCheckHydraOidc(unittest.TestCase):
|
||||
def test_200_with_issuer_passes(self):
|
||||
body = json.dumps({"issuer": "https://auth.testdomain/"}).encode()
|
||||
with patch("sunbeam.checks._http_get", return_value=(200, body)):
|
||||
from sunbeam import checks
|
||||
r = checks.check_hydra_oidc("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
self.assertIn("testdomain", r.detail)
|
||||
|
||||
def test_502_fails(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(502, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_hydra_oidc("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckPeople(unittest.TestCase):
|
||||
def test_200_passes(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(200, b"<html>")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_people("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_302_redirect_passes(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(302, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_people("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
self.assertIn("302", r.detail)
|
||||
|
||||
def test_502_fails(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(502, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_people("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
self.assertIn("502", r.detail)
|
||||
|
||||
|
||||
class TestCheckPeopleApi(unittest.TestCase):
|
||||
def test_200_passes(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(200, b"{}")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_people_api("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_401_auth_required_passes(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(401, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_people_api("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_502_fails(self):
|
||||
with patch("sunbeam.checks._http_get", return_value=(502, b"")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_people_api("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCheckLivekit(unittest.TestCase):
|
||||
def test_responding_passes(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value="livekit-server-abc"):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(0, "")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_livekit("testdomain", None)
|
||||
self.assertTrue(r.passed)
|
||||
|
||||
def test_no_pod_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value=""):
|
||||
from sunbeam import checks
|
||||
r = checks.check_livekit("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
def test_exec_fails(self):
|
||||
with patch("sunbeam.checks.kube_out", return_value="livekit-server-abc"):
|
||||
with patch("sunbeam.checks.kube_exec", return_value=(1, "")):
|
||||
from sunbeam import checks
|
||||
r = checks.check_livekit("testdomain", None)
|
||||
self.assertFalse(r.passed)
|
||||
|
||||
|
||||
class TestCmdCheck(unittest.TestCase):
|
||||
def _run(self, target, mock_list):
|
||||
from sunbeam import checks
|
||||
result = checks.CheckResult("x", "ns", "svc", True, "ok")
|
||||
fns = [MagicMock(return_value=result) for _ in mock_list]
|
||||
patched = list(zip(fns, [ns for _, ns, _ in mock_list], [s for _, _, s in mock_list]))
|
||||
with patch("sunbeam.checks.get_domain", return_value="td"), \
|
||||
patch("sunbeam.checks._ssl_ctx", return_value=None), \
|
||||
patch("sunbeam.checks._opener", return_value=None), \
|
||||
patch.object(checks, "CHECKS", patched):
|
||||
checks.cmd_check(target)
|
||||
return fns
|
||||
|
||||
def test_no_target_runs_all(self):
|
||||
mock_list = [("unused", "devtools", "gitea"), ("unused", "data", "postgres")]
|
||||
fns = self._run(None, mock_list)
|
||||
fns[0].assert_called_once_with("td", None)
|
||||
fns[1].assert_called_once_with("td", None)
|
||||
|
||||
def test_ns_filter_skips_other_namespaces(self):
|
||||
mock_list = [("unused", "devtools", "gitea"), ("unused", "data", "postgres")]
|
||||
fns = self._run("devtools", mock_list)
|
||||
fns[0].assert_called_once()
|
||||
fns[1].assert_not_called()
|
||||
|
||||
def test_svc_filter(self):
|
||||
mock_list = [("unused", "ory", "kratos"), ("unused", "ory", "hydra")]
|
||||
fns = self._run("ory/kratos", mock_list)
|
||||
fns[0].assert_called_once()
|
||||
fns[1].assert_not_called()
|
||||
|
||||
def test_no_match_warns(self):
|
||||
from sunbeam import checks
|
||||
with patch("sunbeam.checks.get_domain", return_value="td"), \
|
||||
patch("sunbeam.checks._ssl_ctx", return_value=None), \
|
||||
patch("sunbeam.checks._opener", return_value=None), \
|
||||
patch.object(checks, "CHECKS", []), \
|
||||
patch("sunbeam.checks.warn") as mock_warn:
|
||||
checks.cmd_check("nonexistent")
|
||||
mock_warn.assert_called_once()
|
||||
@@ -31,6 +31,8 @@ class TestArgParsing(unittest.TestCase):
|
||||
p_build.add_argument("what", choices=["proxy"])
|
||||
sub.add_parser("mirror")
|
||||
sub.add_parser("bootstrap")
|
||||
p_check = sub.add_parser("check")
|
||||
p_check.add_argument("target", nargs="?", default=None)
|
||||
return parser.parse_args(argv)
|
||||
|
||||
def test_up(self):
|
||||
@@ -83,6 +85,21 @@ class TestArgParsing(unittest.TestCase):
|
||||
with self.assertRaises(SystemExit):
|
||||
self._parse(["get", "ory/kratos-abc", "-o", "toml"])
|
||||
|
||||
def test_check_no_target(self):
|
||||
args = self._parse(["check"])
|
||||
self.assertEqual(args.verb, "check")
|
||||
self.assertIsNone(args.target)
|
||||
|
||||
def test_check_with_namespace(self):
|
||||
args = self._parse(["check", "devtools"])
|
||||
self.assertEqual(args.verb, "check")
|
||||
self.assertEqual(args.target, "devtools")
|
||||
|
||||
def test_check_with_service(self):
|
||||
args = self._parse(["check", "lasuite/people"])
|
||||
self.assertEqual(args.verb, "check")
|
||||
self.assertEqual(args.target, "lasuite/people")
|
||||
|
||||
def test_no_args_verb_is_none(self):
|
||||
args = self._parse([])
|
||||
self.assertIsNone(args.verb)
|
||||
@@ -189,3 +206,27 @@ class TestCliDispatch(unittest.TestCase):
|
||||
except SystemExit:
|
||||
pass
|
||||
mock_build.assert_called_once_with("proxy")
|
||||
|
||||
def test_check_no_target(self):
|
||||
mock_check = MagicMock()
|
||||
with patch.object(sys, "argv", ["sunbeam", "check"]):
|
||||
with patch.dict("sys.modules", {"sunbeam.checks": MagicMock(cmd_check=mock_check)}):
|
||||
import importlib, sunbeam.cli as cli_mod
|
||||
importlib.reload(cli_mod)
|
||||
try:
|
||||
cli_mod.main()
|
||||
except SystemExit:
|
||||
pass
|
||||
mock_check.assert_called_once_with(None)
|
||||
|
||||
def test_check_with_target(self):
|
||||
mock_check = MagicMock()
|
||||
with patch.object(sys, "argv", ["sunbeam", "check", "lasuite/people"]):
|
||||
with patch.dict("sys.modules", {"sunbeam.checks": MagicMock(cmd_check=mock_check)}):
|
||||
import importlib, sunbeam.cli as cli_mod
|
||||
importlib.reload(cli_mod)
|
||||
try:
|
||||
cli_mod.main()
|
||||
except SystemExit:
|
||||
pass
|
||||
mock_check.assert_called_once_with("lasuite/people")
|
||||
|
||||
Reference in New Issue
Block a user