Files
computer-playbook/tests/unit/python/utils/roles/validation/test_deploy_id.py
T
kevinveenbirkenbachandClaude Opus 5 575a5a87ac refactor(layout): sort shipped scripts by language and split the unit suite
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>
2026-08-22 01:31:09 +02:00

108 lines
3.7 KiB
Python

from __future__ import annotations
import os
import tempfile
import unittest
from pathlib import Path
from utils.cache.yaml import dump_yaml
from utils.roles.validation.deploy_id import ValidDeployId
class TestValidDeployId(unittest.TestCase):
def setUp(self) -> None:
self.validator = ValidDeployId()
self.assertTrue(
self.validator.valid_ids,
"Expected at least one application id discovered from repo roles/",
)
self.existing_app = min(self.validator.valid_ids)
self.missing_app = "this-app-id-should-not-exist-xyz-123"
def _write_ini_inventory(self, content: str) -> str:
fd, path = tempfile.mkstemp(suffix=".ini")
os.close(fd)
with Path(path).open("w", encoding="utf-8") as f:
f.write(content)
return path
def _write_yaml_inventory(self, data) -> str:
fd, path = tempfile.mkstemp(suffix=".yml")
os.close(fd)
dump_yaml(path, data)
return path
def test_valid_in_roles_and_ini_inventory(self) -> None:
ini_content = f"""
[servers]
{self.existing_app},otherhost
"""
inv = self._write_ini_inventory(ini_content)
result = self.validator.validate(inv, [self.existing_app])
self.assertEqual(
result, {}, "app should be valid when in roles and ini inventory"
)
def test_missing_in_roles(self) -> None:
ini_content = f"""
[servers]
{self.missing_app}
"""
inv = self._write_ini_inventory(ini_content)
result = self.validator.validate(inv, [self.missing_app])
expected = {self.missing_app: {"in_roles": False, "in_inventory": True}}
self.assertEqual(result, expected)
def test_missing_in_inventory_ini(self) -> None:
ini_content = """
[servers]
otherhost
"""
inv = self._write_ini_inventory(ini_content)
result = self.validator.validate(inv, [self.existing_app])
expected = {self.existing_app: {"in_roles": True, "in_inventory": False}}
self.assertEqual(result, expected)
def test_missing_both_ini(self) -> None:
ini_content = """
[servers]
otherhost
"""
inv = self._write_ini_inventory(ini_content)
result = self.validator.validate(inv, [self.missing_app])
expected = {self.missing_app: {"in_roles": False, "in_inventory": False}}
self.assertEqual(result, expected)
def test_valid_in_roles_and_yaml_inventory(self) -> None:
data = {self.existing_app: {"hosts": ["localhost"]}}
inv = self._write_yaml_inventory(data)
result = self.validator.validate(inv, [self.existing_app])
self.assertEqual(result, {}, "app should be valid in roles and yaml inventory")
def test_missing_in_roles_yaml(self) -> None:
data = {self.missing_app: {}}
inv = self._write_yaml_inventory(data)
result = self.validator.validate(inv, [self.missing_app])
expected = {self.missing_app: {"in_roles": False, "in_inventory": True}}
self.assertEqual(result, expected)
def test_missing_in_inventory_yaml(self) -> None:
data = {"group": {"other": {}}}
inv = self._write_yaml_inventory(data)
result = self.validator.validate(inv, [self.existing_app])
expected = {self.existing_app: {"in_roles": True, "in_inventory": False}}
self.assertEqual(result, expected)
def test_missing_both_yaml(self) -> None:
data = {}
inv = self._write_yaml_inventory(data)
result = self.validator.validate(inv, [self.missing_app])
expected = {self.missing_app: {"in_roles": False, "in_inventory": False}}
self.assertEqual(result, expected)
if __name__ == "__main__":
unittest.main()