Files
computer-playbook/tests/unit/python/plugins/lookup/test_container.py
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

117 lines
4.5 KiB
Python

import importlib.util
import unittest
from unittest.mock import patch
from ansible.errors import AnsibleError
from . import PROJECT_ROOT
def _load_module(rel_path: str, name: str):
path = PROJECT_ROOT / rel_path
spec = importlib.util.spec_from_file_location(name, str(path))
mod = importlib.util.module_from_spec(spec)
assert spec and spec.loader
spec.loader.exec_module(mod)
return mod
class TestLookupDocker(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls.mod = _load_module("plugins/lookup/container.py", "lookup_plugins_docker")
cls.LookupModule = cls.mod.LookupModule
def setUp(self):
self.lookup = self.LookupModule()
self.vars_ok = {"DIR_COMPOSITIONS": "/opt/compose/"}
self.fake_paths = {
"directories": {
"instance": "/opt/compose/app/",
"env": "/opt/compose/app/.env/",
"services": "/opt/compose/app/services/",
"volumes": "/opt/compose/app/volumes/",
"config": "/opt/compose/app/config/",
},
"files": {
"env": "/opt/compose/app/.env/app.env",
"compose": "/opt/compose/app/compose.yml",
"compose_override": "/opt/compose/app/compose.override.yml",
"dockerfile": "/opt/compose/app/Dockerfile",
},
}
def test_returns_full_dict_when_only_application_id(self):
with patch.object(
self.mod, "get_docker_paths", return_value=self.fake_paths
) as p:
out = self.lookup.run(["web-app-mailu"], variables=self.vars_ok)
self.assertEqual(out, [self.fake_paths])
p.assert_called_once_with("web-app-mailu", "/opt/compose/")
def test_returns_subdict_for_top_level_key(self):
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
out = self.lookup.run(
["web-app-mailu", "directories"], variables=self.vars_ok
)
self.assertEqual(out, [self.fake_paths["directories"]])
out = self.lookup.run(["web-app-mailu", "files"], variables=self.vars_ok)
self.assertEqual(out, [self.fake_paths["files"]])
def test_returns_deep_value_for_dotted_path(self):
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
out = self.lookup.run(
["web-app-mailu", "directories.instance"], variables=self.vars_ok
)
self.assertEqual(out, ["/opt/compose/app/"])
out = self.lookup.run(
["web-app-mailu", "files.env"], variables=self.vars_ok
)
self.assertEqual(out, ["/opt/compose/app/.env/app.env"])
def test_invalid_path_raises(self):
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
with self.assertRaises(AnsibleError):
self.lookup.run(
["web-app-mailu", "doesnotexist"], variables=self.vars_ok
)
with self.assertRaises(AnsibleError):
self.lookup.run(
["web-app-mailu", "directories.doesnotexist"],
variables=self.vars_ok,
)
with self.assertRaises(AnsibleError):
self.lookup.run(
["web-app-mailu", "directories.instance.foo"],
variables=self.vars_ok,
)
def test_missing_instances_base_var_raises(self):
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
with self.assertRaises(AnsibleError) as ctx:
self.lookup.run(["web-app-mailu"], variables={})
self.assertIn("DIR_COMPOSITIONS not set", str(ctx.exception))
def test_empty_application_id_raises(self):
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
with self.assertRaises(AnsibleError) as ctx:
self.lookup.run([" "], variables=self.vars_ok)
self.assertIn("application_id is empty", str(ctx.exception))
def test_wrong_arity_raises(self):
with patch.object(self.mod, "get_docker_paths", return_value=self.fake_paths):
with self.assertRaises(AnsibleError):
self.lookup.run([], variables=self.vars_ok)
with self.assertRaises(AnsibleError):
self.lookup.run(["a", "b", "c"], variables=self.vars_ok)
if __name__ == "__main__":
unittest.main()