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

73 lines
2.6 KiB
Python

"""Unit tests for the container_image lookup plugin.
container_image is a thin wrapper around the `image` lookup: it forwards
terms + kwargs and wraps the resolved ref in a compose ``image: "<ref>"``
line. Resolution semantics are pinned by test_image.py.
"""
from __future__ import annotations
import unittest
import unittest.mock as mock
from unittest.mock import patch
from ansible.errors import AnsibleError
from plugins.lookup.container_image import LookupModule
def _run_with_ref(ref: str, terms, **kwargs) -> tuple[list[str], mock.MagicMock]:
image_plugin = mock.MagicMock(run=mock.MagicMock(return_value=[ref]))
with patch("plugins.lookup.container_image.lookup_loader") as loader_mock:
loader_mock.get.return_value = image_plugin
lm = LookupModule()
lm._loader = mock.MagicMock()
out = lm.run(terms, variables={"DEPLOYMENT_MODE": "compose"}, **kwargs)
return out, image_plugin
class TestContainerImageLookup(unittest.TestCase):
def test_wraps_resolved_ref_in_compose_image_line(self):
out, _ = _run_with_ref(
"mattermost/mattermost-team-edition:11.8.0",
["web-app-mattermost", "mattermost"],
)
self.assertEqual(out, ['image: "mattermost/mattermost-team-edition:11.8.0"'])
def test_wraps_swarm_prefixed_ref(self):
out, _ = _run_with_ref(
"registry.example.com:5000/prom/prometheus:v3.13.1",
["web-app-prometheus", "prometheus"],
)
self.assertEqual(
out, ['image: "registry.example.com:5000/prom/prometheus:v3.13.1"']
)
def test_forwards_terms_and_kwargs_to_image_lookup(self):
terms = ["web-app-mattermost", "mattermost"]
_, image_plugin = _run_with_ref(
"busybox:1.36", terms, image="busybox", version="1.36", custom=True
)
image_plugin.run.assert_called_once_with(
terms,
variables={"DEPLOYMENT_MODE": "compose"},
image="busybox",
version="1.36",
custom=True,
)
def test_propagates_image_lookup_error(self):
image_plugin = mock.MagicMock(
run=mock.MagicMock(side_effect=AnsibleError("boom"))
)
with patch("plugins.lookup.container_image.lookup_loader") as loader_mock:
loader_mock.get.return_value = image_plugin
lm = LookupModule()
lm._loader = mock.MagicMock()
with self.assertRaises(AnsibleError):
lm.run(["web-app-mattermost", "mattermost"], variables={})
if __name__ == "__main__":
unittest.main()