mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 02:54:26 +00:00
kevinveenbirkenbachandClaude Opus 5
575a5a87ac
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>
432 lines
14 KiB
Python
432 lines
14 KiB
Python
"""Unit tests for the `image` lookup plugin.
|
|
|
|
Pins the SPOT contract for resolving image references. The default return
|
|
is the bare ``<image>:<version>`` in compose mode, prefixed with the
|
|
in-cluster registry host:port in swarm mode when configured. ``tag_only=True``
|
|
strips the swarm prefix. Overrides bypass the services map; a missing
|
|
version emits a warning but does not abort. ``custom=True`` auto-derives
|
|
the image name as ``<entity_name>_custom`` for locally-built images.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import unittest
|
|
import unittest.mock as mock
|
|
from typing import Any
|
|
from unittest.mock import patch
|
|
|
|
from ansible.errors import AnsibleError
|
|
|
|
from plugins.lookup.image import LookupModule
|
|
|
|
|
|
def _apps(
|
|
image: str | None = "mattermost/mattermost-team-edition",
|
|
version: str | None = "11.8.0",
|
|
) -> dict[str, Any]:
|
|
entry: dict[str, Any] = {}
|
|
if image is not None:
|
|
entry["image"] = image
|
|
if version is not None:
|
|
entry["version"] = version
|
|
return {
|
|
"web-app-mattermost": {
|
|
"services": {
|
|
"mattermost": entry,
|
|
},
|
|
},
|
|
}
|
|
|
|
|
|
def _run(
|
|
application_id: str,
|
|
service_key: str,
|
|
*,
|
|
variables: dict[str, Any] | None = None,
|
|
applications: dict[str, Any] | None = None,
|
|
**kwargs: Any,
|
|
) -> list[str]:
|
|
apps = applications if applications is not None else _apps()
|
|
with patch("plugins.lookup.image.lookup_loader") as loader_mock:
|
|
loader_mock.get.return_value = mock.MagicMock(run=lambda *_a, **_k: [apps])
|
|
lm = LookupModule()
|
|
lm._loader = mock.MagicMock()
|
|
return lm.run(
|
|
[application_id, service_key],
|
|
variables=variables or {},
|
|
**kwargs,
|
|
)
|
|
|
|
|
|
class TestImageLookup(unittest.TestCase):
|
|
def test_missing_terms_raise(self):
|
|
with self.assertRaises(AnsibleError):
|
|
LookupModule().run([], variables={})
|
|
with self.assertRaises(AnsibleError):
|
|
LookupModule().run(["web-app-mattermost"], variables={})
|
|
with self.assertRaises(AnsibleError):
|
|
LookupModule().run(
|
|
["web-app-mattermost", "mattermost", "extra"], variables={}
|
|
)
|
|
|
|
def test_empty_application_id_raises(self):
|
|
with self.assertRaises(AnsibleError):
|
|
_run("", "mattermost")
|
|
|
|
def test_empty_service_key_raises(self):
|
|
with self.assertRaises(AnsibleError):
|
|
_run("web-app-mattermost", "")
|
|
|
|
def test_unknown_application_raises(self):
|
|
with self.assertRaises(AnsibleError):
|
|
_run("web-app-missing", "mattermost")
|
|
|
|
def test_unknown_service_raises(self):
|
|
with self.assertRaises(AnsibleError):
|
|
_run("web-app-mattermost", "smtp")
|
|
|
|
def test_missing_image_raises(self):
|
|
apps = _apps(image=None)
|
|
with self.assertRaises(AnsibleError):
|
|
_run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
)
|
|
|
|
def test_compose_mode_returns_unprefixed_reference(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_compose_mode_defaults_when_deployment_mode_missing(self):
|
|
out = _run("web-app-mattermost", "mattermost", variables={})
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_swarm_mode_without_registry_host_is_unprefixed(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {"registry": {"host": "", "port": 5000}},
|
|
},
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_swarm_mode_without_registry_port_is_unprefixed(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {"registry": {"host": "registry.example.com", "port": ""}},
|
|
},
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_compose_mode_force_suppresses_swarm_prefix(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"compose_mode_force": "compose",
|
|
"swarm": {
|
|
"registry": {"host": "registry.example.com", "port": 5000},
|
|
},
|
|
},
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_swarm_mode_with_registry_is_prefixed(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {
|
|
"registry": {"host": "registry.example.com", "port": 5000},
|
|
},
|
|
},
|
|
)
|
|
self.assertEqual(
|
|
out,
|
|
["registry.example.com:5000/mattermost/mattermost-team-edition:11.8.0"],
|
|
)
|
|
|
|
def test_swarm_mode_without_swarm_dict_is_unprefixed(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "swarm"},
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_image_override_bypasses_services_image(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
image="busybox",
|
|
)
|
|
self.assertEqual(out, ["busybox:11.8.0"])
|
|
|
|
def test_version_override_bypasses_services_version(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
version="latest",
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:latest"])
|
|
|
|
def test_both_overrides_bypass_services_values(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
image="busybox",
|
|
version="1.36",
|
|
)
|
|
self.assertEqual(out, ["busybox:1.36"])
|
|
|
|
def test_missing_version_returns_bare_image_with_warning(self):
|
|
apps = _apps(version=None)
|
|
with patch("plugins.lookup.image._warn") as warn:
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition"])
|
|
warn.assert_called_once()
|
|
|
|
def test_image_override_with_missing_services_version_warns(self):
|
|
apps = _apps(version=None)
|
|
with patch("plugins.lookup.image._warn") as warn:
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
image="busybox",
|
|
)
|
|
self.assertEqual(out, ["busybox"])
|
|
warn.assert_called_once()
|
|
|
|
def test_tag_only_strips_swarm_prefix(self):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {
|
|
"registry": {"host": "registry.example.com", "port": 5000},
|
|
},
|
|
},
|
|
tag_only=True,
|
|
)
|
|
self.assertEqual(out, ["mattermost/mattermost-team-edition:11.8.0"])
|
|
|
|
def test_custom_true_uses_entity_name_custom(self):
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
custom=True,
|
|
)
|
|
self.assertEqual(out, ["mattermost_custom:11.8.0"])
|
|
|
|
def test_custom_true_with_version_override(self):
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
custom=True,
|
|
version="local",
|
|
)
|
|
self.assertEqual(out, ["mattermost_custom:local"])
|
|
|
|
def test_custom_true_with_image_override_image_wins(self):
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
) as get_name:
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
custom=True,
|
|
image="busybox",
|
|
)
|
|
self.assertEqual(out, ["busybox:11.8.0"])
|
|
get_name.assert_not_called()
|
|
|
|
def test_custom_true_swarm_prefix_applied(self):
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {
|
|
"registry": {
|
|
"host": "registry.example.com",
|
|
"port": 5000,
|
|
},
|
|
},
|
|
},
|
|
custom=True,
|
|
)
|
|
self.assertEqual(
|
|
out,
|
|
["registry.example.com:5000/mattermost_custom:11.8.0"],
|
|
)
|
|
|
|
def test_custom_true_ignores_services_image(self):
|
|
apps = _apps(image="mattermost/mattermost-team-edition", version="11.8.0")
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
custom=True,
|
|
)
|
|
self.assertEqual(out, ["mattermost_custom:11.8.0"])
|
|
|
|
def test_custom_true_tag_only_returns_bare(self):
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {
|
|
"registry": {
|
|
"host": "registry.example.com",
|
|
"port": 5000,
|
|
},
|
|
},
|
|
},
|
|
custom=True,
|
|
tag_only=True,
|
|
)
|
|
self.assertEqual(out, ["mattermost_custom:11.8.0"])
|
|
|
|
def test_entry_custom_true_used_without_kwarg(self):
|
|
apps = _apps()
|
|
apps["web-app-mattermost"]["services"]["mattermost"]["custom"] = True
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
):
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
)
|
|
self.assertEqual(out, ["mattermost_custom:11.8.0"])
|
|
|
|
def test_entry_custom_string_used_without_kwarg(self):
|
|
apps = _apps()
|
|
apps["web-app-mattermost"]["services"]["mattermost"]["custom"] = "side"
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
)
|
|
self.assertEqual(out, ["side_custom:11.8.0"])
|
|
|
|
def test_custom_kwarg_wins_over_entry_declaration(self):
|
|
apps = _apps()
|
|
apps["web-app-mattermost"]["services"]["mattermost"]["custom"] = True
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
custom="side",
|
|
)
|
|
self.assertEqual(out, ["side_custom:11.8.0"])
|
|
|
|
def test_custom_string_uses_string_base(self):
|
|
apps = _apps(image="ghcr.io/x/whiteboard", version="v1.5.9")
|
|
apps["web-app-mattermost"]["services"]["wb"] = apps["web-app-mattermost"][
|
|
"services"
|
|
].pop("mattermost")
|
|
with patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="mattermost",
|
|
) as get_name:
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"wb",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
applications=apps,
|
|
custom="nextcloud-whiteboard",
|
|
)
|
|
self.assertEqual(out, ["nextcloud-whiteboard_custom:v1.5.9"])
|
|
get_name.assert_not_called()
|
|
|
|
def test_custom_string_swarm_prefix_applied(self):
|
|
apps = _apps(image="ghcr.io/x/whiteboard", version="v1.5.9")
|
|
apps["web-app-mattermost"]["services"]["wb"] = apps["web-app-mattermost"][
|
|
"services"
|
|
].pop("mattermost")
|
|
out = _run(
|
|
"web-app-mattermost",
|
|
"wb",
|
|
variables={
|
|
"DEPLOYMENT_MODE": "swarm",
|
|
"swarm": {"registry": {"host": "mgr", "port": 5000}},
|
|
},
|
|
applications=apps,
|
|
custom="nextcloud-whiteboard",
|
|
)
|
|
self.assertEqual(out, ["mgr:5000/nextcloud-whiteboard_custom:v1.5.9"])
|
|
|
|
def test_custom_true_empty_entity_name_raises(self):
|
|
with (
|
|
patch(
|
|
"plugins.lookup.image.get_entity_name",
|
|
return_value="",
|
|
),
|
|
self.assertRaises(AnsibleError),
|
|
):
|
|
_run(
|
|
"web-app-mattermost",
|
|
"mattermost",
|
|
variables={"DEPLOYMENT_MODE": "compose"},
|
|
custom=True,
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|