Files
computer-playbook/tests/unit/python/roles/sys-front-inj-all/test_injected_javascript.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

86 lines
3.0 KiB
Python

"""Injected JavaScript must still parse after ``to_one_liner`` collapses it.
``sys-front-inj-javascript`` loads a role's ``javascript.js`` or its ``.j2``
template, runs it through ``to_one_liner`` - which strips every comment and
newline - and inlines the result under a CSP hash. A script that parses only
before that collapse is served broken *with a matching hash*: the browser
rejects nothing and executes nothing, so the page loses its injection without
a single error anywhere in the deploy. Parsing the collapsed form is the only
place that failure is observable.
Jinja is not rendered. Expressions become a neutral literal and statements are
dropped, which is enough to expose an ASI break or a comment-stripping defect
without standing up an inventory.
"""
from __future__ import annotations
import re
import shutil
import subprocess
import tempfile
import unittest
from typing import TYPE_CHECKING
from plugins.filter.text_filters import to_one_liner
from utils.cache.files import PROJECT_ROOT, read_text
if TYPE_CHECKING:
from pathlib import Path
ROLES = PROJECT_ROOT / "roles"
PATTERNS = (
"*/templates/javascript.js.j2",
"*/templates/javascript.js",
"*/files/javascript/javascript.js",
)
EXPRESSION = re.compile(r"\{\{.*?\}\}", re.DOTALL)
STATEMENT = re.compile(r"\{%.*?%\}", re.DOTALL)
def _sources() -> list[Path]:
return sorted({path for pattern in PATTERNS for path in ROLES.glob(pattern)})
def _have_node() -> bool:
return shutil.which("node") is not None
@unittest.skipUnless(_have_node(), "node is not available in PATH")
class TestInjectedJavascript(unittest.TestCase):
def test_every_injected_script_parses_after_one_lining(self) -> None:
sources = _sources()
self.assertTrue(
sources, f"no injected JavaScript matched {PATTERNS} under {ROLES}"
)
for path in sources:
with self.subTest(role=path.relative_to(ROLES).parts[0]):
text = read_text(str(path))
if path.name.endswith(".j2"):
text = EXPRESSION.sub("0", STATEMENT.sub("", text))
collapsed = to_one_liner(text)
self.assertNotIn("\n", collapsed)
self.assertNotIn(
"]=]",
collapsed,
"body_filter.lua.j2 embeds the snippet as a Lua [=[ ]=] long"
" string; an inner ]=] closes it early and the OpenResty"
" config stops loading for every site on the host",
)
with tempfile.NamedTemporaryFile("w", suffix=".js") as handle:
handle.write(collapsed)
handle.flush()
proc = subprocess.run(
["node", "--check", handle.name],
capture_output=True,
text=True,
check=False,
)
self.assertEqual(proc.returncode, 0, proc.stderr)
if __name__ == "__main__":
unittest.main()