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>
274 lines
8.0 KiB
Python
274 lines
8.0 KiB
Python
"""Unit tests for utils.roles.meta_lookup.
|
|
|
|
Covers:
|
|
* service role with run_after / lifecycle on its primary entity;
|
|
* multi-entity role where the primary entity is a metadata-only holder;
|
|
* absent run_after (returns []);
|
|
* absent lifecycle (returns None);
|
|
* malformed meta/services.yml (raises a clear error).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import textwrap
|
|
import unittest
|
|
from pathlib import Path
|
|
from tempfile import TemporaryDirectory
|
|
|
|
from utils.roles.mapping import ROLE_FILE_META_SERVICES
|
|
from utils.roles.meta_lookup import (
|
|
MetaServicesShapeError,
|
|
get_role_lifecycle,
|
|
get_role_placement,
|
|
get_role_run_after,
|
|
get_role_skip,
|
|
iter_roles_with_placement,
|
|
)
|
|
|
|
|
|
class _RoleFixtures:
|
|
def __init__(self, root: Path):
|
|
self.root = root
|
|
|
|
def write(self, role_name: str, body: str) -> Path:
|
|
role_dir = self.root / role_name
|
|
(role_dir / "meta").mkdir(parents=True, exist_ok=True)
|
|
path = role_dir / ROLE_FILE_META_SERVICES
|
|
path.write_text(textwrap.dedent(body).lstrip("\n"), encoding="utf-8")
|
|
return role_dir
|
|
|
|
|
|
class TestMetaLookup(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.tmp = TemporaryDirectory()
|
|
self.addCleanup(self.tmp.cleanup)
|
|
self.fx = _RoleFixtures(Path(self.tmp.name))
|
|
|
|
def test_service_role_with_run_after_and_lifecycle(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-gitea",
|
|
"""
|
|
gitea:
|
|
image: gitea/gitea
|
|
run_after:
|
|
- svc-db-postgres
|
|
- web-app-keycloak
|
|
lifecycle: stable
|
|
""",
|
|
)
|
|
|
|
self.assertEqual(
|
|
get_role_run_after(role_dir, role_name="web-app-gitea"),
|
|
["svc-db-postgres", "web-app-keycloak"],
|
|
)
|
|
self.assertEqual(
|
|
get_role_lifecycle(role_dir, role_name="web-app-gitea"),
|
|
"stable",
|
|
)
|
|
|
|
def test_multi_entity_metadata_only_primary_holder(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-bluesky",
|
|
"""
|
|
bluesky:
|
|
run_after:
|
|
- web-app-keycloak
|
|
lifecycle: alpha
|
|
api:
|
|
ports:
|
|
local:
|
|
http: 8030
|
|
web:
|
|
ports:
|
|
local:
|
|
http: 8031
|
|
""",
|
|
)
|
|
|
|
self.assertEqual(
|
|
get_role_run_after(role_dir, role_name="web-app-bluesky"),
|
|
["web-app-keycloak"],
|
|
)
|
|
self.assertEqual(
|
|
get_role_lifecycle(role_dir, role_name="web-app-bluesky"),
|
|
"alpha",
|
|
)
|
|
|
|
def test_returns_empty_list_when_run_after_absent(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-yourls",
|
|
"""
|
|
yourls:
|
|
lifecycle: beta
|
|
""",
|
|
)
|
|
self.assertEqual(
|
|
get_role_run_after(role_dir, role_name="web-app-yourls"),
|
|
[],
|
|
)
|
|
|
|
def test_returns_none_when_lifecycle_absent(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-yourls",
|
|
"""
|
|
yourls:
|
|
run_after:
|
|
- svc-db-postgres
|
|
""",
|
|
)
|
|
self.assertIsNone(get_role_lifecycle(role_dir, role_name="web-app-yourls"))
|
|
|
|
def test_returns_empty_when_services_file_missing(self) -> None:
|
|
role_dir = self.fx.root / "desk-something"
|
|
role_dir.mkdir(parents=True)
|
|
self.assertEqual(
|
|
get_role_run_after(role_dir, role_name="desk-something"),
|
|
[],
|
|
)
|
|
self.assertIsNone(get_role_lifecycle(role_dir, role_name="desk-something"))
|
|
|
|
def test_malformed_yaml_raises_clear_error(self) -> None:
|
|
role_dir = self.fx.root / "web-app-broken"
|
|
(role_dir / "meta").mkdir(parents=True)
|
|
(role_dir / ROLE_FILE_META_SERVICES).write_text(
|
|
"key: value\n:foo: ]invalid[\n - not\n", encoding="utf-8"
|
|
)
|
|
with self.assertRaises(MetaServicesShapeError):
|
|
get_role_run_after(role_dir, role_name="web-app-broken")
|
|
|
|
def test_non_dict_root_raises_clear_error(self) -> None:
|
|
role_dir = self.fx.root / "web-app-listroot"
|
|
(role_dir / "meta").mkdir(parents=True)
|
|
(role_dir / ROLE_FILE_META_SERVICES).write_text(
|
|
"- this\n- is\n- a list\n", encoding="utf-8"
|
|
)
|
|
with self.assertRaises(MetaServicesShapeError):
|
|
get_role_lifecycle(role_dir, role_name="web-app-listroot")
|
|
|
|
def test_placement_manager_is_returned(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"svc-registry-cache",
|
|
"""
|
|
cache:
|
|
placement: manager
|
|
""",
|
|
)
|
|
self.assertEqual(
|
|
get_role_placement(role_dir, role_name="svc-registry-cache"),
|
|
"manager",
|
|
)
|
|
|
|
def test_placement_absent_returns_none(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-yourls",
|
|
"""
|
|
yourls:
|
|
lifecycle: beta
|
|
""",
|
|
)
|
|
self.assertIsNone(get_role_placement(role_dir, role_name="web-app-yourls"))
|
|
|
|
def test_iter_roles_with_placement_filters_correctly(self) -> None:
|
|
self.fx.write(
|
|
"svc-registry-cache",
|
|
"cache:\n placement: manager\n",
|
|
)
|
|
self.fx.write(
|
|
"svc-registry-docker",
|
|
"docker:\n placement: manager\n",
|
|
)
|
|
self.fx.write(
|
|
"svc-prx-openresty",
|
|
"openresty:\n placement: manager\n",
|
|
)
|
|
self.fx.write(
|
|
"web-app-yourls",
|
|
"yourls:\n lifecycle: beta\n",
|
|
)
|
|
self.fx.write(
|
|
"web-app-only-worker",
|
|
"only-worker:\n placement: worker\n",
|
|
)
|
|
|
|
managers = iter_roles_with_placement("manager", roles_dir=self.fx.root)
|
|
self.assertEqual(
|
|
managers,
|
|
["svc-prx-openresty", "svc-registry-cache", "svc-registry-docker"],
|
|
)
|
|
|
|
def test_iter_roles_with_placement_empty_placement_returns_empty(
|
|
self,
|
|
) -> None:
|
|
self.fx.write(
|
|
"svc-registry-cache",
|
|
"cache:\n placement: manager\n",
|
|
)
|
|
self.assertEqual(
|
|
iter_roles_with_placement("", roles_dir=self.fx.root),
|
|
[],
|
|
)
|
|
|
|
def test_iter_roles_with_placement_missing_roles_dir(self) -> None:
|
|
self.assertEqual(
|
|
iter_roles_with_placement(
|
|
"manager", roles_dir=self.fx.root / "does-not-exist"
|
|
),
|
|
[],
|
|
)
|
|
|
|
def test_skip_returns_disabled_modes(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"svc-storage-nfs-client",
|
|
"""
|
|
nfs-client:
|
|
modes:
|
|
compose:
|
|
enabled: false
|
|
swarm:
|
|
enabled: false
|
|
""",
|
|
)
|
|
self.assertEqual(
|
|
get_role_skip(role_dir, role_name="svc-storage-nfs-client"),
|
|
["compose", "swarm"],
|
|
)
|
|
|
|
def test_skip_absent_modes_returns_empty(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-yourls",
|
|
"""
|
|
yourls:
|
|
lifecycle: beta
|
|
""",
|
|
)
|
|
self.assertEqual(get_role_skip(role_dir, role_name="web-app-yourls"), [])
|
|
|
|
def test_partial_modes_default_enabled(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-yourls",
|
|
"""
|
|
yourls:
|
|
modes:
|
|
compose:
|
|
enabled: true
|
|
""",
|
|
)
|
|
self.assertEqual(get_role_skip(role_dir, role_name="web-app-yourls"), [])
|
|
|
|
def test_modes_enabled_non_bool_raises(self) -> None:
|
|
role_dir = self.fx.write(
|
|
"web-app-broken",
|
|
"""
|
|
broken:
|
|
modes:
|
|
compose:
|
|
enabled: maybe
|
|
""",
|
|
)
|
|
with self.assertRaises(MetaServicesShapeError):
|
|
get_role_skip(role_dir, role_name="web-app-broken")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|