Files
computer-playbook/tests/unit/python/cli/build/test_tree_shadow_folder.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

110 lines
3.2 KiB
Python

import os
import sys
import json
import tempfile
import shutil
import unittest
from contextlib import redirect_stdout
from io import StringIO
from unittest.mock import patch
SCRIPT_PATH = os.path.abspath(
os.path.join(os.path.dirname(__file__), "../../../../../cli/build/tree/__main__.py")
)
class TestTreeShadowFolder(unittest.TestCase):
def setUp(self):
self.roles_dir = tempfile.mkdtemp()
self.role_name = "dummyrole"
self.role_path = os.path.join(self.roles_dir, self.role_name)
os.makedirs(os.path.join(self.role_path, "meta"))
self.shadow_dir = tempfile.mkdtemp()
self.orig_argv = sys.argv[:]
sys.argv = [
SCRIPT_PATH,
"-d", self.roles_dir,
"-s", self.shadow_dir,
"-o", "json"
]
from . import PROJECT_ROOT
if str(PROJECT_ROOT) not in sys.path:
sys.path.insert(0, str(PROJECT_ROOT))
def tearDown(self):
sys.argv = self.orig_argv
shutil.rmtree(self.roles_dir)
shutil.rmtree(self.shadow_dir)
@staticmethod
def _sync_as_completed(futures):
return list(futures)
@patch("cli.build.tree._main.as_completed", side_effect=_sync_as_completed.__func__)
@patch("cli.build.tree._main.ProcessPoolExecutor")
@patch("cli.build.tree.build_mappings")
@patch("cli.build.tree.output_graph")
def test_tree_json_written_to_shadow_folder(
self,
mock_output_graph,
mock_build_mappings,
mock_executor_cls,
_mock_as_completed,
):
dummy_graph = {"dummy": {"test": 42}}
mock_build_mappings.return_value = dummy_graph
class DummyFuture:
def __init__(self, value=None, exc=None):
self._value = value
self._exc = exc
def result(self):
if self._exc is not None:
raise self._exc
return self._value
class DummyExecutor:
def __enter__(self):
return self
def __exit__(self, exc_type, exc, tb):
return False
def submit(self, fn, *args, **kwargs):
try:
return DummyFuture(fn(*args, **kwargs))
except Exception as exc:
return DummyFuture(exc=exc)
mock_executor_cls.return_value = DummyExecutor()
import importlib
tree_mod = importlib.import_module("cli.build.tree")
with redirect_stdout(StringIO()):
tree_mod.main()
expected_tree_path = os.path.join(
self.shadow_dir, self.role_name, "meta", "tree.json"
)
self.assertTrue(
os.path.isfile(expected_tree_path),
f"tree.json not found at {expected_tree_path}"
)
with open(expected_tree_path, 'r') as f:
data = json.load(f)
self.assertEqual(data, dummy_graph, "tree.json content mismatch")
original_tree_path = os.path.join(self.role_path, "meta", "tree.json")
self.assertFalse(
os.path.exists(original_tree_path),
"tree.json should NOT be written to the real meta/ folder"
)
if __name__ == "__main__":
unittest.main()