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>
236 lines
8.1 KiB
Python
236 lines
8.1 KiB
Python
import unittest
|
|
import unittest.mock as mock
|
|
from unittest.mock import patch
|
|
|
|
from ansible.errors import AnsibleError
|
|
|
|
from plugins.lookup.nginx import LookupModule
|
|
|
|
|
|
class _FakeTlsResolveLookup:
|
|
"""
|
|
Minimal fake lookup plugin compatible with the NEW call style:
|
|
- run([domain, "protocols.web"], variables=...)
|
|
"""
|
|
|
|
def __init__(self, protocol: str):
|
|
self._protocol = protocol
|
|
|
|
def run(self, terms, variables=None, **kwargs):
|
|
if len(terms) != 2 or terms[1] != "protocols.web":
|
|
raise AssertionError(f"Unexpected terms passed to tls: {terms}")
|
|
|
|
if kwargs.get("want"):
|
|
raise AssertionError(f"Unexpected want kwarg passed to tls: {kwargs}")
|
|
|
|
return [self._protocol]
|
|
|
|
|
|
class TestNginxPathsLookup(unittest.TestCase):
|
|
def setUp(self):
|
|
self.plugin = LookupModule()
|
|
self.plugin._loader = mock.MagicMock()
|
|
self.applications = {"svc-prx-openresty": {"docker": {"volumes": {}}}}
|
|
self.variables = {
|
|
"applications": self.applications,
|
|
}
|
|
|
|
def _fake_get(self, applications, app_id, key, strict=True):
|
|
if key == "volumes.www.path":
|
|
return "/opt/mock/www"
|
|
if key == "volumes.nginx.path":
|
|
return "/opt/mock/nginx"
|
|
raise KeyError(key)
|
|
|
|
def _loader_get(self, tls=None):
|
|
def _get(name, *a, **k):
|
|
if name == "applications":
|
|
return mock.MagicMock(run=lambda *_a, **_k: [self.applications])
|
|
if name == "tls":
|
|
if tls is None:
|
|
raise AssertionError(
|
|
"tls must not be called when protocol override is set"
|
|
)
|
|
return tls
|
|
raise AssertionError(f"Unexpected lookup requested: {name}")
|
|
|
|
return _get
|
|
|
|
def _run(self, terms, **kwargs):
|
|
with (
|
|
patch(
|
|
"plugins.lookup.nginx.get",
|
|
side_effect=self._fake_get,
|
|
),
|
|
patch(
|
|
"plugins.lookup.nginx.get_canonical_volumes",
|
|
return_value={},
|
|
),
|
|
patch("plugins.lookup.nginx.lookup_loader") as loader_mock,
|
|
):
|
|
loader_mock.get.side_effect = self._loader_get()
|
|
return self.plugin.run(terms, variables=self.variables, **kwargs)[0]
|
|
|
|
def test_files_configuration_projection(self):
|
|
out = self._run(["files.configuration"])
|
|
self.assertEqual(out, "/opt/mock/nginx/nginx.conf")
|
|
|
|
def test_directories_configuration_projection(self):
|
|
out = self._run(["directories.configuration.base"])
|
|
self.assertEqual(out, "/opt/mock/nginx/conf.d/")
|
|
|
|
def test_directories_configuration_http_includes(self):
|
|
out = self._run(["directories.configuration.http_includes"])
|
|
self.assertEqual(
|
|
out,
|
|
[
|
|
"/opt/mock/nginx/conf.d/global/",
|
|
"/opt/mock/nginx/conf.d/maps/",
|
|
"/opt/mock/nginx/conf.d/servers/http/",
|
|
"/opt/mock/nginx/conf.d/servers/https/",
|
|
],
|
|
)
|
|
|
|
def test_directories_data_projection(self):
|
|
out = self._run(["directories.data"])
|
|
self.assertEqual(out["www"], "/opt/mock/www/")
|
|
self.assertEqual(out["html"], "/opt/mock/www/public_html/")
|
|
self.assertEqual(out["files"], "/opt/mock/www/public_files/")
|
|
self.assertEqual(out["cdn"], "/opt/mock/www/public_cdn/")
|
|
self.assertEqual(out["global"], "/opt/mock/www/global/")
|
|
self.assertEqual(out["well_known"], "/usr/share/nginx/well-known/")
|
|
|
|
def test_directories_cache_projection(self):
|
|
out = self._run(["directories.cache"])
|
|
self.assertEqual(out["general"], "/tmp/cache_nginx_general/")
|
|
self.assertEqual(out["image"], "/tmp/cache_nginx_image/")
|
|
|
|
def test_directories_ensure_projection(self):
|
|
ensure = self._run(["directories.ensure"])
|
|
self.assertIsInstance(ensure, list)
|
|
|
|
self.assertIn({"path": "/tmp/cache_nginx_general/", "mode": "0700"}, ensure)
|
|
self.assertIn({"path": "/tmp/cache_nginx_image/", "mode": "0700"}, ensure)
|
|
|
|
ensure_paths = self._run(["directories.ensure_paths"])
|
|
self.assertIsInstance(ensure_paths, list)
|
|
self.assertEqual(ensure_paths, [d["path"] for d in ensure])
|
|
|
|
self.assertNotIn("/usr/share/nginx/well-known/", ensure_paths)
|
|
|
|
def test_canonical_dict_supplies_volume_paths(self):
|
|
canonical = {
|
|
"www": {"type": "volume", "path": "/opt/canonical/www"},
|
|
"nginx": {"type": "volume", "path": "/opt/canonical/nginx"},
|
|
}
|
|
with (
|
|
patch(
|
|
"plugins.lookup.nginx.get",
|
|
side_effect=AssertionError(
|
|
"get() must not be called when canonical paths are present"
|
|
),
|
|
),
|
|
patch(
|
|
"plugins.lookup.nginx.get_canonical_volumes",
|
|
return_value=canonical,
|
|
),
|
|
patch("plugins.lookup.nginx.lookup_loader") as loader_mock,
|
|
):
|
|
loader_mock.get.side_effect = self._loader_get()
|
|
out = self.plugin.run(["files.configuration"], variables=self.variables)[0]
|
|
self.assertEqual(out, "/opt/canonical/nginx/nginx.conf")
|
|
|
|
def test_domain_uses_tls_when_no_override(self):
|
|
fake_tls = _FakeTlsResolveLookup("https")
|
|
|
|
with (
|
|
patch(
|
|
"plugins.lookup.nginx.get",
|
|
side_effect=self._fake_get,
|
|
),
|
|
patch(
|
|
"plugins.lookup.nginx.get_canonical_volumes",
|
|
return_value={},
|
|
),
|
|
patch("plugins.lookup.nginx.lookup_loader") as loader_mock,
|
|
):
|
|
loader_mock.get.side_effect = self._loader_get(tls=fake_tls)
|
|
out = self.plugin.run(
|
|
["files.domain", "example.com"], variables=self.variables
|
|
)[0]
|
|
|
|
self.assertEqual(
|
|
out,
|
|
"/opt/mock/nginx/conf.d/servers/https/example.com.conf",
|
|
)
|
|
|
|
def test_domain_protocol_override_http(self):
|
|
with (
|
|
patch(
|
|
"plugins.lookup.nginx.get",
|
|
side_effect=self._fake_get,
|
|
),
|
|
patch(
|
|
"plugins.lookup.nginx.get_canonical_volumes",
|
|
return_value={},
|
|
),
|
|
patch("plugins.lookup.nginx.lookup_loader") as loader_mock,
|
|
):
|
|
loader_mock.get.side_effect = self._loader_get()
|
|
out = self.plugin.run(
|
|
["files.domain", "example.com"],
|
|
variables=self.variables,
|
|
protocol="http",
|
|
)[0]
|
|
|
|
self.assertEqual(
|
|
out,
|
|
"/opt/mock/nginx/conf.d/servers/http/example.com.conf",
|
|
)
|
|
|
|
def test_invalid_protocol_override_raises(self):
|
|
with (
|
|
patch(
|
|
"plugins.lookup.nginx.get",
|
|
side_effect=self._fake_get,
|
|
),
|
|
patch(
|
|
"plugins.lookup.nginx.get_canonical_volumes",
|
|
return_value={},
|
|
),
|
|
patch("plugins.lookup.nginx.lookup_loader") as loader_mock,
|
|
self.assertRaises(AnsibleError),
|
|
):
|
|
loader_mock.get.side_effect = self._loader_get()
|
|
self.plugin.run(
|
|
["files.domain", "example.com"],
|
|
variables=self.variables,
|
|
protocol="ftp",
|
|
)
|
|
|
|
def test_invalid_usage_raises(self):
|
|
with (
|
|
patch(
|
|
"plugins.lookup.nginx.get",
|
|
side_effect=self._fake_get,
|
|
),
|
|
patch(
|
|
"plugins.lookup.nginx.get_canonical_volumes",
|
|
return_value={},
|
|
),
|
|
patch("plugins.lookup.nginx.lookup_loader") as loader_mock,
|
|
):
|
|
loader_mock.get.side_effect = self._loader_get()
|
|
|
|
with self.assertRaises(AnsibleError):
|
|
self.plugin.run([], variables=self.variables)
|
|
|
|
with self.assertRaises(AnsibleError):
|
|
self.plugin.run(
|
|
["files.domain", "example.com", "extra"], variables=self.variables
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|