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

133 lines
4.4 KiB
Python

"""Unit tests for the ``sso_proxy_consumers`` lookup plugin.
The plugin enumerates roles whose merged config satisfies
``services.sso.flavor == 'oauth2'`` AND ``services.sso.enabled``
potentially-truthy. The shape test (no terms) and the predicate test
(only oauth2-flavored, enabled consumers appear) are pinned here so
future contract changes are caught.
"""
import importlib
import importlib.util
import sys
import unittest
import unittest.mock as mock
from ansible.errors import AnsibleError
from . import PROJECT_ROOT
def _load_module(rel_path: str, name: str):
for key in (
"utils.roles.applications.config",
"utils.roles.applications",
"utils",
"utils.cache.applications",
"utils.cache",
"utils.roles.applications.services.sso",
"utils.roles.applications.services",
):
sys.modules.pop(key, None)
importlib.import_module("utils.roles.applications.config")
importlib.import_module("utils.cache.applications")
importlib.import_module("utils.roles.applications.services.sso")
path = PROJECT_ROOT / rel_path
spec = importlib.util.spec_from_file_location(name, str(path))
mod = importlib.util.module_from_spec(spec)
assert spec and spec.loader
spec.loader.exec_module(mod)
return mod
def _role(*, enabled=True, flavor="oauth2"):
sso: dict = {"enabled": enabled, "flavor": flavor}
return {"services": {"sso": sso}}
class SsoProxyConsumersLookupTests(unittest.TestCase):
@classmethod
def setUpClass(cls):
cls.mod = _load_module(
"plugins/lookup/sso_proxy_consumers.py", "sso_proxy_consumers"
)
def setUp(self):
self._original_loader = self.mod.lookup_loader
self._stub_payload = None
loader_mock = mock.MagicMock()
loader_mock.get.return_value = mock.MagicMock(
run=lambda *_a, **_k: [self._stub_payload]
)
self.mod.lookup_loader = loader_mock
def tearDown(self):
self.mod.lookup_loader = self._original_loader
def _run(self, applications, terms=None):
self._stub_payload = applications
lk = self.mod.LookupModule()
lk._loader = mock.MagicMock()
return lk.run(terms or [], variables={"applications": applications})
def test_positional_terms_raise(self):
with self.assertRaises(AnsibleError):
self._run({}, ["extra-arg"])
def test_empty_applications_returns_empty_list(self):
result = self._run({})
self.assertEqual(result, [[]])
def test_oauth2_enabled_consumer_is_included(self):
apps = {"web-app-a": _role(enabled=True, flavor="oauth2")}
result = self._run(apps)
self.assertEqual(result, [["web-app-a"]])
def test_oidc_consumer_is_excluded(self):
apps = {"web-app-a": _role(enabled=True, flavor="oidc")}
self.assertEqual(self._run(apps), [[]])
def test_disabled_oauth2_consumer_is_excluded(self):
apps = {"web-app-a": _role(enabled=False, flavor="oauth2")}
self.assertEqual(self._run(apps), [[]])
def test_mixed_apps_only_oauth2_enabled_returned(self):
apps = {
"web-app-a": _role(enabled=True, flavor="oauth2"),
"web-app-b": _role(enabled=True, flavor="oidc"),
"web-app-c": _role(enabled=False, flavor="oauth2"),
"web-app-d": _role(enabled=True, flavor="oauth2"),
"web-app-e": {"services": {}},
}
result = self._run(apps)
self.assertEqual(result, [["web-app-a", "web-app-d"]])
def test_result_is_alphabetically_sorted(self):
apps = {
"web-app-zeta": _role(enabled=True, flavor="oauth2"),
"web-app-alpha": _role(enabled=True, flavor="oauth2"),
"web-app-mu": _role(enabled=True, flavor="oauth2"),
}
result = self._run(apps)
self.assertEqual(result, [["web-app-alpha", "web-app-mu", "web-app-zeta"]])
def test_jinja_enabled_string_is_treated_as_potentially_truthy(self):
apps = {
"web-app-a": {
"services": {
"sso": {
"enabled": "{{ 'web-app-keycloak' in group_names }}",
"flavor": "oauth2",
}
}
}
}
result = self._run(apps)
self.assertEqual(result, [["web-app-a"]])
if __name__ == "__main__":
unittest.main()