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

130 lines
4.2 KiB
Python

"""Unit tests for the smtp_host lookup plugin.
Pins the SMTP endpoint matrix msmtp relays through: the configured relay in
production, loopback on a host that carries the stack, and the swarm manager's
routing mesh on a bare infra node inside the containerised test rig.
"""
from __future__ import annotations
import importlib.util
import unittest
from ansible.errors import AnsibleError
from . import PROJECT_ROOT
RELAY = "mail.infinito.example"
MANAGER = "swarm-manager-01"
def _load_lookup():
spec = importlib.util.spec_from_file_location(
"lookup_smtp_host",
str(PROJECT_ROOT / "plugins/lookup/smtp_host.py"),
)
mod = importlib.util.module_from_spec(spec)
assert spec and spec.loader
spec.loader.exec_module(mod)
return mod.LookupModule
class _DummyTemplar:
def __init__(self, available_variables=None):
self.available_variables = available_variables or {}
def template(self, value):
return value
def _email(external=True, host=RELAY):
return {"external": external, "host": host}
class TestSmtpHostLookup(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls.LookupModule = _load_lookup()
def _resolve(self, variables, email=None):
lm = self.LookupModule()
lm._templar = _DummyTemplar(variables)
lm._loader = None
return lm.run([email if email is not None else _email()], variables=variables)[
0
]
def test_production_keeps_the_configured_relay(self):
vars_ = {"DOCKER_IN_CONTAINER": False, "DEPLOYMENT_MODE": "swarm"}
self.assertEqual(self._resolve(vars_), RELAY)
def test_non_external_mail_keeps_the_configured_relay(self):
vars_ = {"DOCKER_IN_CONTAINER": True, "DEPLOYMENT_MODE": "swarm"}
email = _email(external=False, host="localhost")
self.assertEqual(self._resolve(vars_, email), "localhost")
def test_compose_rig_uses_loopback(self):
vars_ = {"DOCKER_IN_CONTAINER": True, "DEPLOYMENT_MODE": "compose"}
self.assertEqual(self._resolve(vars_), "127.0.0.1")
def test_swarm_node_uses_loopback(self):
vars_ = {
"DOCKER_IN_CONTAINER": True,
"DEPLOYMENT_MODE": "swarm",
"group_names": ["svc-swarm-node"],
}
self.assertEqual(self._resolve(vars_), "127.0.0.1")
def test_infra_node_enters_through_the_manager(self):
vars_ = {
"DOCKER_IN_CONTAINER": True,
"DEPLOYMENT_MODE": "swarm",
"group_names": ["svc-nfs-server"],
"groups": {"svc-swarm-manager": [MANAGER, "swarm-manager-02"]},
}
self.assertEqual(self._resolve(vars_), MANAGER)
def test_infra_node_without_manager_falls_back_to_the_relay(self):
vars_ = {
"DOCKER_IN_CONTAINER": True,
"DEPLOYMENT_MODE": "swarm",
"group_names": ["svc-nfs-server"],
"groups": {"svc-swarm-manager": []},
}
self.assertEqual(self._resolve(vars_), RELAY)
def test_string_booleans_are_coerced(self):
vars_ = {"DOCKER_IN_CONTAINER": "True", "DEPLOYMENT_MODE": "compose"}
self.assertEqual(self._resolve(vars_, _email(external="yes")), "127.0.0.1")
def test_swarm_node_wins_over_a_populated_manager_group(self):
vars_ = {
"DOCKER_IN_CONTAINER": True,
"DEPLOYMENT_MODE": "swarm",
"group_names": ["svc-swarm-node"],
"groups": {"svc-swarm-manager": [MANAGER]},
}
self.assertEqual(self._resolve(vars_), "127.0.0.1")
def test_missing_terms_raise(self):
lm = self.LookupModule()
lm._templar = _DummyTemplar({})
with self.assertRaises(AnsibleError):
lm.run([], variables={})
def test_too_many_terms_raise(self):
lm = self.LookupModule()
lm._templar = _DummyTemplar({})
with self.assertRaises(AnsibleError):
lm.run([_email(), _email()], variables={})
def test_non_mapping_term_raises(self):
lm = self.LookupModule()
lm._templar = _DummyTemplar({})
with self.assertRaises(AnsibleError):
lm.run([RELAY], variables={})
if __name__ == "__main__":
unittest.main(verbosity=2)