Files
computer-playbook/tests/unit/python/utils/roles/test_entity_apps.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

97 lines
3.3 KiB
Python

"""Unit tests for `utils.roles.entity.apps.apps_for_entity`."""
from __future__ import annotations
import shutil
import tempfile
import unittest
from pathlib import Path
from unittest.mock import patch
from utils.cache.yaml import _reset_cache_for_tests, dump_yaml
from utils.roles.categories import categories_file
from utils.roles.entity.apps import apps_for_entity
from utils.roles.mapping import ROLE_FILE_VARS_MAIN
class TestAppsForEntity(unittest.TestCase):
def setUp(self) -> None:
_reset_cache_for_tests()
self.tmp = Path(tempfile.mkdtemp(prefix="apps_for_entity_test_"))
self.roles_dir = self.tmp / "roles"
self.roles_dir.mkdir(parents=True, exist_ok=True)
dump_yaml(
categories_file(self.tmp),
{
"roles": {
"web": {
"app": {"title": "Applications", "invokable": True},
"svc": {"title": "Services", "invokable": True},
}
}
},
)
root = patch("utils.roles.categories.PROJECT_ROOT", self.tmp)
root.start()
self.addCleanup(root.stop)
self.addCleanup(lambda: shutil.rmtree(self.tmp, ignore_errors=True))
def _mk_role(self, name: str, application_id: str | None) -> None:
rd = self.roles_dir / name
(rd / "vars").mkdir(parents=True, exist_ok=True)
payload: dict = {}
if application_id is not None:
payload["application_id"] = application_id
dump_yaml(rd / ROLE_FILE_VARS_MAIN, payload)
def test_returns_apps_under_entity(self) -> None:
self._mk_role("web-app-matomo", "web-app-matomo")
self._mk_role("web-app-dashboard", "web-app-dashboard")
self._mk_role("web-svc-cdn", "web-svc-cdn")
self.assertEqual(
apps_for_entity("matomo", roles_dir=self.roles_dir),
["web-app-matomo"],
)
self.assertEqual(
apps_for_entity("cdn", roles_dir=self.roles_dir),
["web-svc-cdn"],
)
def test_falls_back_to_role_dir_name_when_application_id_missing(self) -> None:
self._mk_role("web-app-foo", None)
self.assertEqual(
apps_for_entity("foo", roles_dir=self.roles_dir),
["web-app-foo"],
)
def test_unknown_entity_returns_empty(self) -> None:
self._mk_role("web-app-matomo", "web-app-matomo")
self.assertEqual(
apps_for_entity("does-not-exist", roles_dir=self.roles_dir),
[],
)
def test_blank_entity_returns_empty(self) -> None:
self._mk_role("web-app-matomo", "web-app-matomo")
self.assertEqual(apps_for_entity("", roles_dir=self.roles_dir), [])
self.assertEqual(apps_for_entity(" ", roles_dir=self.roles_dir), [])
def test_missing_roles_dir_returns_empty(self) -> None:
ghost = self.tmp / "ghost-roles"
self.assertEqual(apps_for_entity("matomo", roles_dir=ghost), [])
def test_result_is_sorted_and_unique(self) -> None:
self._mk_role("web-app-matomo", "web-app-matomo")
self._mk_role("web-svc-matomo", "web-svc-matomo")
got = apps_for_entity("matomo", roles_dir=self.roles_dir)
self.assertEqual(got, sorted(got))
self.assertEqual(len(got), len(set(got)))
if __name__ == "__main__": # pragma: no cover
unittest.main()