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

124 lines
3.8 KiB
Python

import unittest
import unittest.mock as mock
from typing import ClassVar
from unittest.mock import patch
from ansible.errors import AnsibleError
from plugins.lookup.container_ports import LookupModule
def _apps():
return {
"web-app-gitea": {
"services": {
"gitea": {
"ports": {
"local": {"http": 8002},
"public": {"ssh": 2201},
"internal": {"http": 3000, "ssh": 22},
}
}
}
}
}
def _run(terms, *, app_id="web-app-gitea", **kwargs):
lm = LookupModule()
lm._loader = mock.MagicMock()
apps = _apps()
with patch("plugins.lookup.container_ports.lookup_loader") as loader_mock:
loader_mock.get.return_value = mock.MagicMock(run=lambda *_a, **_k: [apps])
return lm.run(terms, variables={"application_id": app_id}, **kwargs)
class TestContainerPortsLookup(unittest.TestCase):
def test_local_scope_with_ip(self):
self.assertEqual(
_run([["gitea", "http", "10.0.0.1"]]),
['ports:\n - "10.0.0.1:8002:3000"'],
)
def test_public_scope_without_ip(self):
self.assertEqual(
_run([["gitea", "ssh"]]),
['ports:\n - "2201:22"'],
)
def test_local_scope_without_ip_drops_ip(self):
self.assertEqual(
_run([["gitea", "http"]]),
['ports:\n - "8002:3000"'],
)
def test_multiple_mixed_terms(self):
self.assertEqual(
_run([["gitea", "http", "10.0.0.1"], ["gitea", "ssh"]]),
['ports:\n - "10.0.0.1:8002:3000"\n - "2201:22"'],
)
def test_application_id_kwarg_overrides_vars(self):
self.assertEqual(
_run(
[["gitea", "http", "127.0.0.1"]],
app_id="nope",
application_id="web-app-gitea",
),
['ports:\n - "127.0.0.1:8002:3000"'],
)
def test_ip_kwarg_is_removed(self):
with self.assertRaises(AnsibleError):
_run([["gitea", "http"]], ip="10.0.0.1")
def test_no_terms_raises(self):
with self.assertRaises(AnsibleError):
_run([])
def test_bad_term_raises(self):
with self.assertRaises(AnsibleError):
_run([["gitea"]])
with self.assertRaises(AnsibleError):
_run([["gitea", "http", "10.0.0.1", "extra"]])
def test_unknown_protocol_raises(self):
with self.assertRaises(AnsibleError):
_run([["gitea", "nope", "127.0.0.1"]])
def test_missing_application_id_raises(self):
lm = LookupModule()
lm._loader = mock.MagicMock()
with (
patch("plugins.lookup.container_ports.lookup_loader") as loader_mock,
self.assertRaises(AnsibleError),
):
loader_mock.get.return_value = mock.MagicMock(
run=lambda *_a, **_k: [_apps()]
)
lm.run([["gitea", "http"]], variables={})
def test_application_id_unrendered_var_is_templated(self):
class _Templar:
available_variables: ClassVar[dict] = {}
def template(self, value):
return "web-app-gitea" if value == "{{ app }}" else value
lookup = LookupModule()
lookup._templar = _Templar()
lookup._loader = mock.MagicMock()
with patch("plugins.lookup.container_ports.lookup_loader") as loader_mock:
loader_mock.get.return_value = mock.MagicMock(
run=lambda *_a, **_k: [_apps()]
)
out = lookup.run(
[["gitea", "http", "10.0.0.1"]],
variables={"application_id": "{{ app }}"},
)
self.assertEqual(out, ['ports:\n - "10.0.0.1:8002:3000"'])
if __name__ == "__main__":
unittest.main()