mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-09 20:26:33 +00:00
kevinveenbirkenbachandClaude Opus 4.7
ed04dad5d5
Single atomic landing for three back-to-back role-meta refactor requirements
(see docs/requirements/008-role-meta-layout.md, 009-per-role-networks-and-ports.md,
010-role-meta-runafter-lifecycle-migration.md).
req-008 — role meta layout
* Move every role's metadata under meta/<topic>.yml with file-root
convention (no wrapping key matching the basename):
- schema/main.yml + config/main.yml.credentials → meta/schema.yml
- users/main.yml → meta/users.yml
- config/main.yml.server → meta/server.yml
- config/main.yml.rbac → meta/rbac.yml
- config/main.yml.compose.services + every other top-level key
of config/main.yml inlined under <entity>.<key>
→ meta/services.yml
- config/main.yml.compose.volumes → meta/volumes.yml
* Drop the legacy schema/, users/, config/ directories from every role.
* meta/schema.yml: support nested credential keys, optional `default:`
field (Jinja literal, not rendered/validated/regenerated), implicit
`algorithm: plain`.
* Materialised paths drop the `compose.` prefix:
compose.services.<e>.<…> → services.<e>.<…>
compose.volumes.<k> → volumes.<k>
<former-top-level>.<…> → services.<entity_name>.<former-top-level>.<…>
* Update every Python consumer (utils/cache, utils/manager, utils/applications,
plugins/lookup, plugins/filter, cli/*) plus every Jinja template, vars/*.yml
and task file to the new paths.
* No legacy fallback. Repository-wide grep for `compose.services.` /
`compose.volumes.` / `schema/main.yml` / `users/main.yml` / `config/main.yml`
is empty outside docs/requirements/ and tasks/utils/migrate_meta_layout.py.
* Add tests/lint/repository/test_role_meta_layout.py guarding against the
old paths returning, and an explicit lint guard that meta/variants.yml
files do not carry a `compose:` wrapper.
req-009 — per-role networks/ports
* Move group_vars/all/08_networks.yml.defaults_networks.local.<role>.{subnet,
dns_resolver} into roles/<role>/meta/server.yml.networks.local.{subnet,
dns_resolver}.
* Delete group_vars/all/09_ports.yml entirely; ports now live on the
service entity that exposes them at
roles/<role>/meta/services.yml.<entity>.ports.{inter,local,public}.
* Rename + int-cast every former top-level `services.<entity>.port`
field to `services.<entity>.ports.inter` (single int).
* Always-category-keyed maps for ports.local / ports.public; relay
spans use {start, end} integers.
* Add PORT_BANDS map to group_vars/all/08_networks.yml — single source
of truth for the per-<scope>.<category> band ranges, consumed by both
the new CLI helpers and the lint test.
* New CLI helpers (cli meta ports suggest, cli meta networks suggest)
walk the live role tree gap-first then increment-fallback, with
deterministic output and non-zero exit on capacity overflow.
* cli create role consumes both helpers when scaffolding a new role.
* Lint extensions: bare-int port shape rejection, host-bound port
collision check (single ints + relay span integers, inter excluded),
band-membership check with documented allow-list for the legacy
web-app-bigbluebutton.bigbluebutton.local.http: 48087 entry.
req-010 — run_after / lifecycle migration
* Move galaxy_info.run_after and galaxy_info.lifecycle out of
meta/main.yml into meta/services.yml.<primary_entity>.{run_after,
lifecycle}; <primary_entity> is the value returned by
get_entity_name(role_name).
* For multi-entity roles whose primary entity has no compose service
(web-app-bluesky → bluesky, web-app-matrix → matrix, desk/dev/drv/
gen roles), create a dedicated metadata-only top-level entry under
<primary_entity>.
* Introduce utils/roles/meta_lookup.py with get_role_run_after /
get_role_lifecycle that resolve <primary_entity> once and read from
meta/services.yml; degrade gracefully when meta/services.yml is
absent OR the field is absent; raise MetaServicesShapeError when the
file exists but is malformed.
* Update every consumer (utils/service_registry, utils/invokable,
cli/meta/applications/resolution/run_after/__main__, cli/meta/roles/
lifecycle_filter/__main__, cli/meta/applications/resolution/combined,
cli/build/{tree,graph,role_include}, cli/deploy/development/{common,
init,deps,deploy}, plugins/filter/canonical_domains_map, etc.) to
use the helper.
* Lint guards: no run_after/lifecycle in meta/main.yml; lifecycle
values restricted to {planned,pre-alpha,alpha,beta,stable,deprecated};
run_after/lifecycle never on a non-primary entity; empty run_after
lists rejected.
Also folded into this change set
* services_disabler now writes `services.<svc>.{enabled,shared}` into
host_vars instead of the old `compose.services.<svc>.{...}` path; the
discover/find pair walks meta/services.yml and only treats entries
carrying enabled/shared/provides as provider declarations (so
metadata-only entries from req-010 do not create spurious provider
rows).
* service_registry skips `run_after` deps whose target was filtered
out via SERVICES_DISABLED instead of failing the whole load.
* cli/mirror/resolver and cli/create/inventory/mirror_overrides emit/
consume the new applications.<role>.services.<svc>.image shape
(mirror.md updated to match).
* utils/domains/list.build_applications_from_roles now reads
meta/server.yml directly (it had been silently returning {} since
config/main.yml stopped existing).
* utils/roles/resource_validation.filter_roles_by_min_storage reads
meta/services.yml.<entity>.min_storage instead of the legacy
compose.services path.
* web-app-bluesky pre-clones the social-app build context BEFORE
sys-svc-compose so the build context is on disk by the time
sys-stk-front-proxy/tasks/main.yml flushes the docker build handler.
* 4 meta/variants.yml files (svc-ai-ollama, web-app-phpmyadmin,
web-app-wordpress, web-app-keycloak) lose their `compose: services:`
wrapper so deep-merge over meta/services.yml lands on the new
file-root shape.
Validation
* Unit tests: 1571 passed.
* Lint tests: 50 passed.
* Integration tests: 161 passed (1 skipped).
* Full-cycle fresh-purged-apps deploy succeeded for the 8-app validation
set: web-app-{nextcloud,wordpress,yourls,bigbluebutton,bluesky,gitea,
discourse,mattermost}.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
101 lines
3.3 KiB
Python
101 lines
3.3 KiB
Python
"""Unit tests for ``cli.create.role``.
|
|
|
|
The post-req-009 CLI auto-allocates the per-role subnet via
|
|
``cli meta networks suggest`` and per-entity port slots via
|
|
``cli meta ports suggest``. Network and port assignments live in the
|
|
new per-role meta layout (``meta/server.yml`` and ``meta/services.yml``).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import builtins
|
|
import shutil
|
|
import tempfile
|
|
import unittest
|
|
|
|
from cli.create.role.__main__ import render_templates
|
|
|
|
|
|
class TestRenderTemplates(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self.tmpdir = tempfile.mkdtemp()
|
|
|
|
def tearDown(self) -> None:
|
|
shutil.rmtree(self.tmpdir, ignore_errors=True)
|
|
|
|
def test_render_creates_and_overwrites_skips_merges(self) -> None:
|
|
from pathlib import Path
|
|
|
|
src = Path(self.tmpdir) / "src"
|
|
dst = Path(self.tmpdir) / "dst"
|
|
src.mkdir()
|
|
dst.mkdir()
|
|
|
|
tpl = src / "file.txt.j2"
|
|
tpl.write_text("Line1\nLine2", encoding="utf-8")
|
|
out_file = dst / "file.txt"
|
|
|
|
# Create
|
|
render_templates(src, dst, {})
|
|
self.assertEqual(out_file.read_text(encoding="utf-8"), "Line1\nLine2")
|
|
|
|
# Overwrite
|
|
out_file.write_text("Old", encoding="utf-8")
|
|
original_input = builtins.input
|
|
builtins.input = lambda _: "1"
|
|
try:
|
|
render_templates(src, dst, {})
|
|
self.assertEqual(out_file.read_text(encoding="utf-8"), "Line1\nLine2")
|
|
|
|
# Skip
|
|
out_file.write_text("Old", encoding="utf-8")
|
|
builtins.input = lambda _: "2"
|
|
render_templates(src, dst, {})
|
|
self.assertEqual(out_file.read_text(encoding="utf-8"), "Old")
|
|
|
|
# Merge
|
|
out_file.write_text("Line1\n", encoding="utf-8")
|
|
builtins.input = lambda _: "3"
|
|
render_templates(src, dst, {})
|
|
content = out_file.read_text(encoding="utf-8").splitlines()
|
|
self.assertIn("Line1", content)
|
|
self.assertIn("Line2", content)
|
|
finally:
|
|
builtins.input = original_input
|
|
|
|
|
|
class TestSuggesterIntegration(unittest.TestCase):
|
|
"""The CLI auto-allocates subnets and ports via the live role tree.
|
|
These tests pin the contract of the wired-in helpers; behaviour is
|
|
covered exhaustively in cli/meta/{ports,networks}/suggest tests."""
|
|
|
|
def test_suggest_subnets_returns_a_cidr(self) -> None:
|
|
from cli.meta.networks.suggest.__main__ import (
|
|
capacity_for,
|
|
suggest_subnets,
|
|
)
|
|
|
|
suggestions, gaps = suggest_subnets(clients=14, count=1, explicit_block=None)
|
|
self.assertEqual(len(suggestions), 1)
|
|
self.assertGreaterEqual(capacity_for(suggestions[0]), 14)
|
|
self.assertGreaterEqual(gaps, 1)
|
|
|
|
def test_suggest_single_ports_returns_band_member(self) -> None:
|
|
from cli.meta.ports.suggest.__main__ import suggest_single_ports
|
|
from utils.meta.port_bands import lookup_band
|
|
|
|
suggestions, _gaps = suggest_single_ports(
|
|
scope="local",
|
|
category="http",
|
|
count=1,
|
|
explicit_range=None,
|
|
)
|
|
band = lookup_band("local", "http")
|
|
self.assertIsNotNone(band)
|
|
self.assertGreaterEqual(suggestions[0], band[0])
|
|
self.assertLessEqual(suggestions[0], band[1])
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|