mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
kevinveenbirkenbachandClaude Opus 5
575a5a87ac
Every script a role ships now lives under `files/<language>/`, and the unit
suite is split the same way: `tests/unit/python/` beside new sibling trees for
the other languages. `tests/lint/filesystem/test_role_files_layout.py` keeps it
that way; directories whose shape is dictated from outside carry a `.nocheck`
naming the constraint (Docker build contexts, WordPress mu-plugins, the Joomla
extension, Odoo addons, Playwright suites, the `files/test/test.sh` harness
that `test-e2e-cli` resolves generically).
This cannot be applied in halves. Moving a file and repointing what names it
are the same change: 14 references resolve only at deploy time, so the tree is
green either before or after, never between.
Those 14 were found by static resolution over every reference class, not by the
test suite -- a full `make quality-high` was green while all of them were
broken:
* 7 `src:` values built from a role variable holding a bare filename
(svc-bkp-remote-2-local, decidim, espocrm, friendica, joomla, pixelfed x2).
The variable doubles as the destination name inside the container, so the
language segment belongs at the call site, not in the variable.
* `sys-service/tasks/04_base.yml` resolved every consumer's systemd script
through `first_found(..., errors='strict')` over `files/script.{sh,py}`.
18 roles ship exactly that and have no template fallback: the play would
have died on each.
* `sys-front-inj-javascript` fell back to `<role>/files/javascript.js`; the
interface now reads `files/javascript/javascript.js`.
* `sys-front-inj-logout/templates/head_sub.j2` built the cache-busting mtime
path through `path_absolute(... 'files', ...)`.
* 4 `ansible.builtin.script:` invocations naming a bare command
(pull.py, prune.sh, set_postgres_superuser_password.sh, ganesha-serve.sh).
* `dev-python/files/shell/install.sh` pointed at a sibling role's script.
Depth-dependent paths inside the moved trees were bumped accordingly: 59
`parents[N]` computations, 12 relative climbs, and the per-role recover CLI,
whose path `cli/administration/recover/recoverers.py` still assembled from the
pre-move location.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
260 lines
8.2 KiB
Python
260 lines
8.2 KiB
Python
from __future__ import annotations
|
|
|
|
import io
|
|
import unittest
|
|
from contextlib import redirect_stdout
|
|
from pathlib import Path
|
|
from tempfile import TemporaryDirectory
|
|
from unittest.mock import patch
|
|
|
|
from utils.roles.mapping import ROLE_FILE_META_SERVICES
|
|
from utils.roles.validation import resources as rrv
|
|
|
|
|
|
class TestFilterRolesByMinStorage(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.tmp = TemporaryDirectory()
|
|
self.addCleanup(self.tmp.cleanup)
|
|
self.root = Path(self.tmp.name)
|
|
self.roles_root = self.root / "roles"
|
|
self.roles_root.mkdir(parents=True, exist_ok=True)
|
|
|
|
def _write_role_config(self, role_name: str, *, yaml_text: str) -> Path:
|
|
role_dir = self.roles_root / role_name
|
|
(role_dir / "meta").mkdir(parents=True, exist_ok=True)
|
|
cfg_path = role_dir / ROLE_FILE_META_SERVICES
|
|
cfg_path.write_text(yaml_text, encoding="utf-8")
|
|
return cfg_path
|
|
|
|
def test_keeps_role_when_min_storage_is_within_required_storage(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
demo:
|
|
min_storage: 5G
|
|
""".lstrip(),
|
|
)
|
|
|
|
with (
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="10G",
|
|
emit_warnings=False,
|
|
)
|
|
|
|
self.assertEqual(kept, ["web-app-demo"])
|
|
|
|
def test_filters_out_role_when_min_storage_exceeds_required_storage(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
demo:
|
|
min_storage: 50G
|
|
""".lstrip(),
|
|
)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="10G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, [])
|
|
self.assertIn("requires", err.getvalue())
|
|
|
|
def test_missing_key_treats_as_zero_and_keeps_role(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
demo: {}
|
|
""".lstrip(),
|
|
)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="1G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, ["web-app-demo"])
|
|
self.assertIn("Missing key services.demo.min_storage", err.getvalue())
|
|
|
|
def test_missing_role_directory_emits_absolute_path_warning(self) -> None:
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-does-not-exist"],
|
|
required_storage="1G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, [])
|
|
self.assertIn(
|
|
str((self.roles_root / "web-app-does-not-exist").resolve()), err.getvalue()
|
|
)
|
|
|
|
def test_missing_services_file_skips_silently(self) -> None:
|
|
role_dir = self.roles_root / "web-app-demo"
|
|
role_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="1G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, [])
|
|
self.assertEqual(err.getvalue(), "")
|
|
|
|
def test_missing_service_entry_keeps_role_without_warning(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
other: {}
|
|
""".lstrip(),
|
|
)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="1G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, ["web-app-demo"])
|
|
self.assertEqual(err.getvalue(), "")
|
|
|
|
def test_missing_primary_entity_keeps_role_without_warning(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
not_demo: {}
|
|
""".lstrip(),
|
|
)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="1G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, ["web-app-demo"])
|
|
self.assertEqual(err.getvalue(), "")
|
|
|
|
def test_invalid_yaml_emits_warning(self) -> None:
|
|
self._write_role_config("web-app-demo", yaml_text=": this is not yaml")
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="1G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, [])
|
|
self.assertIn("Failed to parse YAML:", err.getvalue())
|
|
|
|
def test_invalid_min_storage_value_emits_warning(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
demo:
|
|
min_storage: "nope"
|
|
""".lstrip(),
|
|
)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value="demo"),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="10G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, [])
|
|
self.assertIn("Invalid min_storage value", err.getvalue())
|
|
|
|
def test_invalid_required_storage_raises_value_error(self) -> None:
|
|
with (
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
self.assertRaises(ValueError),
|
|
):
|
|
rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="not-a-size",
|
|
emit_warnings=False,
|
|
)
|
|
|
|
def test_entity_name_missing_emits_warning_and_skips(self) -> None:
|
|
self._write_role_config(
|
|
"web-app-demo",
|
|
yaml_text="""
|
|
demo:
|
|
min_storage: 1G
|
|
""".lstrip(),
|
|
)
|
|
|
|
err = io.StringIO()
|
|
with (
|
|
redirect_stdout(err),
|
|
patch.object(rrv, "_roles_root", return_value=self.roles_root),
|
|
patch.object(rrv, "get_entity_name", return_value=""),
|
|
):
|
|
kept = rrv.filter_roles_by_min_storage(
|
|
role_names=["web-app-demo"],
|
|
required_storage="10G",
|
|
emit_warnings=True,
|
|
)
|
|
|
|
self.assertEqual(kept, [])
|
|
self.assertIn("Could not derive entity_name", err.getvalue())
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|