Files
computer-playbook/tests/unit/python/utils/install/lint/test_main.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

156 lines
5.8 KiB
Python

"""Unit tests for :mod:`utils.install.lint.__main__`."""
from __future__ import annotations
import os
import time
import unittest
import unittest.mock as mock
from pathlib import Path
from tempfile import TemporaryDirectory
from utils.install.lint import __main__ as cli
def _make_repo_root(tmp: str, *, stamp_age_offset: float | None = None) -> Path:
root = Path(tmp)
(root / "scripts" / "install").mkdir(parents=True)
(root / "scripts" / "install" / "lint.sh").write_text("#\n", encoding="utf-8")
(root / "pyproject.toml").write_text("[project]\n", encoding="utf-8")
if stamp_age_offset is not None:
stamp = root / cli._STAMP
stamp.parent.mkdir(parents=True, exist_ok=True)
stamp.write_text("", encoding="utf-8")
if stamp_age_offset:
new_time = time.time() + stamp_age_offset
os.utime(stamp, (new_time, new_time))
return root
class TestStampLogic(unittest.TestCase):
def test_fresh_stamp_short_circuits(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp, stamp_age_offset=60.0)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli.shutil, "which", return_value="/usr/bin/x"),
mock.patch.object(cli, "_install_all") as inst,
):
rc = cli.main([])
self.assertEqual(rc, 0)
inst.assert_not_called()
def test_missing_tool_invalidates_stamp(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp, stamp_age_offset=60.0)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli.shutil, "which", return_value=None),
mock.patch.object(cli, "_install_all") as inst,
):
rc = cli.main([])
self.assertEqual(rc, 0)
inst.assert_called_once()
def test_stale_stamp_triggers_install(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp, stamp_age_offset=-60.0)
time.sleep(0.01)
(root / "scripts" / "install" / "lint.sh").write_text(
"#updated\n", encoding="utf-8"
)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli, "_install_all") as inst,
):
rc = cli.main([])
self.assertEqual(rc, 0)
inst.assert_called_once()
self.assertTrue((root / cli._STAMP).exists())
def test_no_stamp_triggers_install_and_touches(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli, "_install_all") as inst,
):
rc = cli.main([])
self.assertEqual(rc, 0)
inst.assert_called_once()
self.assertTrue((root / cli._STAMP).exists())
def test_force_drops_stamp(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp, stamp_age_offset=60.0)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli, "_install_all") as inst,
):
rc = cli.main(["--force"])
self.assertEqual(rc, 0)
inst.assert_called_once()
class TestGroupDispatch(unittest.TestCase):
def test_group_only_bypasses_stamp(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp, stamp_age_offset=60.0)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli, "_install_javascript_tools") as js,
mock.patch.object(cli, "_install_all") as inst_all,
):
rc = cli.main(["javascript"])
self.assertEqual(rc, 0)
js.assert_called_once()
inst_all.assert_not_called()
def test_group_does_not_touch_stamp(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp)
stamp = root / cli._STAMP
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli, "_install_javascript_tools"),
):
cli.main(["javascript"])
self.assertFalse(stamp.exists())
def test_ansible_group_calls_all_modules(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(cli.ansible_commands, "ensure") as a,
mock.patch.object(cli.ansible_collections, "ensure") as b,
mock.patch.object(cli.ansible_lint, "ensure") as c,
):
cli.main(["ansible"])
a.assert_called_once()
b.assert_called_once()
c.assert_called_once()
def test_unknown_group_returns_1(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp)
with mock.patch.object(cli, "PROJECT_ROOT", root):
rc = cli.main(["bogus"])
self.assertEqual(rc, 1)
def test_runtime_error_in_ensure_returns_1(self) -> None:
with TemporaryDirectory() as tmp:
root = _make_repo_root(tmp)
with (
mock.patch.object(cli, "PROJECT_ROOT", root),
mock.patch.object(
cli.eslint, "ensure", side_effect=RuntimeError("boom")
),
):
rc = cli.main(["javascript"])
self.assertEqual(rc, 1)
if __name__ == "__main__":
unittest.main()