admin/app-catalog-felhom.eu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

catalog: lifecycle field replaces the retired/ directory move

Browse Source 
Moving a template out of templates/ un-offers it but also makes the
controller's orphan detector see it as GONE for anyone already running the
app - flagging their working install Elavult with a Torles button. Withdrawing
an app must never take a working app away from a customer.

Optional lifecycle: available|hidden|abandoned in .felhom.yml instead.
plant-it returns to templates/ as the first abandoned app; retired/ removed.
Resolvability gate skips (and reports) non-available apps.
This commit is contained in:
authentik Default Admin
2026-07-21 16:19:49 +02:00
parent 857ba53233
commit a32541684a
8 changed files with 161 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/test_check_image_resolvable.py
+59 -5
View File
@@ -45,7 +45,7 @@ class TestResolvabilityGate(unittest.TestCase):
"""The whole point: one dead pin must fail the gate, and say which app pins it."""
with tempfile.TemporaryDirectory() as td:
root = make_catalog(Path(td), {"alive": [GOOD], "rotten": [DEAD]})
sites = cir.collect_images(root)
sites, _ = cir.collect_images(root)
absent, inconclusive = cir.check_images(sites, fake_resolver)
self.assertEqual(absent, [DEAD], "a dead image pin MUST fail the gate")
self.assertEqual(inconclusive, [])
@@ -55,12 +55,12 @@ class TestResolvabilityGate(unittest.TestCase):
def test_all_resolvable_passes(self):
with tempfile.TemporaryDirectory() as td:
root = make_catalog(Path(td), {"alive": [GOOD], "also": [GOOD]})
self.assertEqual(cir.check_images(cir.collect_images(root), fake_resolver), ([], []))
self.assertEqual(cir.check_images(cir.collect_images(root)[0], fake_resolver), ([], []))
def test_same_ref_in_two_apps_is_resolved_once_but_both_sites_reported(self):
with tempfile.TemporaryDirectory() as td:
root = make_catalog(Path(td), {"a": [DEAD], "b": [DEAD]})
sites = cir.collect_images(root)
sites, _ = cir.collect_images(root)
calls = []
def counting(ref):
@@ -77,7 +77,7 @@ class TestResolvabilityGate(unittest.TestCase):
gate would pass an app that cannot start."""
with tempfile.TemporaryDirectory() as td:
root = make_catalog(Path(td), {"wanderer": [GOOD, DEAD]})
sites = cir.collect_images(root)
sites, _ = cir.collect_images(root)
self.assertEqual(sorted(sites), sorted([GOOD, DEAD]))
absent, _ = cir.check_images(sites, fake_resolver)
self.assertEqual(absent, [DEAD])
@@ -93,7 +93,7 @@ class TestResolvabilityGate(unittest.TestCase):
def test_only_filter_restricts_to_named_apps(self):
with tempfile.TemporaryDirectory() as td:
root = make_catalog(Path(td), {"a": [GOOD], "b": [DEAD]})
self.assertEqual(sorted(cir.collect_images(root, only=["a"])), [GOOD])
self.assertEqual(sorted(cir.collect_images(root, only=["a"])[0]), [GOOD])
def test_check_returns_1_end_to_end_on_a_dead_pin(self):
with tempfile.TemporaryDirectory() as td:
@@ -144,5 +144,59 @@ class TestClassifyGuardsAgainstFalseAlarms(unittest.TestCase):
"and not a pass (0)")
class TestLifecycleSkipping(unittest.TestCase):
"""An abandoned app's image is EXPECTED to be gone — it is not offered for new installs. Counting
it as a failure would leave the gate permanently red for something nobody intends to fix, and a
gate that is always red is a gate nobody reads."""
def _catalog(self, td):
root = make_catalog(Path(td), {"alive": [GOOD], "dead-app": [DEAD]})
(root / "templates" / "dead-app" / ".felhom.yml").write_text(
'slug: "dead-app"\nlifecycle: abandoned\n', encoding="utf-8")
(root / "templates" / "alive" / ".felhom.yml").write_text('slug: "alive"\n', encoding="utf-8")
return root
def test_abandoned_app_is_skipped_and_reported(self):
with tempfile.TemporaryDirectory() as td:
sites, skipped = cir.collect_images(self._catalog(td))
self.assertEqual(sorted(sites), [GOOD], "an abandoned app's images must not be checked")
self.assertEqual(skipped, ["dead-app (abandoned)"],
"a skipped app must be REPORTED, never silently dropped")
def test_abandoned_app_does_not_fail_the_gate(self):
with tempfile.TemporaryDirectory() as td:
self.assertEqual(cir.check(self._catalog(td), resolver=fake_resolver), 0)
def test_all_flag_includes_it_again(self):
with tempfile.TemporaryDirectory() as td:
root = self._catalog(td)
sites, skipped = cir.collect_images(root, include_unavailable=True)
self.assertEqual(sorted(sites), sorted([GOOD, DEAD]))
self.assertEqual(skipped, [])
self.assertEqual(cir.check(root, resolver=fake_resolver, include_unavailable=True), 1,
"--all must surface the abandoned app's dead image again")
def test_everything_skipped_is_a_pass_not_an_error(self):
"""All-skipped is a legitimate outcome (e.g. `… plant-it`), not a broken catalog."""
with tempfile.TemporaryDirectory() as td:
root = self._catalog(td)
self.assertEqual(cir.check(root, only=["dead-app"], resolver=fake_resolver), 0)
def test_lifecycle_parsing(self):
with tempfile.TemporaryDirectory() as td:
d = Path(td); d.mkdir(exist_ok=True)
def lc(body):
(d / ".felhom.yml").write_text(body, encoding="utf-8")
return cir.app_lifecycle(d)
self.assertEqual(lc('slug: "x"\n'), "available", "absent field ≡ available")
self.assertEqual(lc('lifecycle: hidden\n'), "hidden")
self.assertEqual(lc('lifecycle: "abandoned"\n'), "abandoned", "quoted value")
self.assertEqual(lc('lifecycle: bogus\n'), "available",
"an unknown value must degrade to available, never brick the template")
self.assertEqual(lc(' lifecycle: abandoned\n'), "available",
"indented => not a top-level key, must not match")
self.assertEqual(cir.app_lifecycle(Path(td) / "nope"), "available", "no file ≡ available")
if __name__ == "__main__":
unittest.main(verbosity=2)