mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 02:54:26 +00:00
kevinveenbirkenbachandClaude Opus 5
5137465c6f
3529 invalid comments in 528 files, grandfathered in while the linter only saw the working-tree diff. Removal ran through the linter's own collectors, so detection and deletion cannot drift: a comment whose opener line is blank before it and whose closer line is blank after it loses all its lines, anything else loses only the comment region, and a line left holding a bare delimiter goes with it. Five files keep their comments behind a nocheck marker instead. Four are upstream configs whose inline docs are upstream's own (mautrix, systemd journald, nextcloud-oidc-login, MediaWiki). In littlejs the commented-out entries ARE the deactivation mechanism for an example tile, so deleting them would delete configuration. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
97 lines
3.3 KiB
Python
97 lines
3.3 KiB
Python
"""Verify that ARG declarations used in FROM instructions are in the global scope.
|
|
|
|
In multi-stage Dockerfiles every ``ARG`` whose value is referenced by a
|
|
``FROM`` instruction must be declared *before* the first ``FROM`` (the global
|
|
scope). An ``ARG`` declared inside a build stage is scoped to that stage only
|
|
and is invisible to subsequent ``FROM`` instructions, which causes Docker to
|
|
treat the variable as empty and fail with::
|
|
|
|
WARN: UndefinedArgInFrom: FROM argument '...' is not declared
|
|
failed to solve: failed to parse stage name ":": invalid reference format
|
|
|
|
The test scans all ``files/Dockerfile`` files under ``roles/`` and fails for
|
|
any file where an ``ARG`` used in a ``FROM`` instruction is not declared before
|
|
the first ``FROM``.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
import unittest
|
|
from typing import TYPE_CHECKING
|
|
|
|
from utils.cache.files import read_text
|
|
|
|
from . import PROJECT_ROOT
|
|
|
|
if TYPE_CHECKING:
|
|
from pathlib import Path
|
|
|
|
_REPO_ROOT = PROJECT_ROOT
|
|
_ROLES_ROOT = _REPO_ROOT / "roles"
|
|
|
|
_FROM_ARG_RE = re.compile(r"^\s*FROM\s+.*\$\{(\w+)\}", re.IGNORECASE)
|
|
_ARG_DECL_RE = re.compile(r"^\s*ARG\s+(\w+)", re.IGNORECASE)
|
|
_FROM_RE = re.compile(r"^\s*FROM\b", re.IGNORECASE)
|
|
|
|
|
|
def _collect_dockerfiles() -> list[Path]:
|
|
return sorted(_ROLES_ROOT.glob("*/files/Dockerfile"))
|
|
|
|
|
|
def _undeclared_from_args(dockerfile: Path) -> list[tuple[int, str, str]]:
|
|
"""Return a list of (line_no, from_line, var_name) for each ARG used in a
|
|
FROM instruction that was not declared in the global scope."""
|
|
lines = read_text(str(dockerfile)).splitlines()
|
|
|
|
global_args: set[str] = set()
|
|
for line in lines:
|
|
if _FROM_RE.match(line):
|
|
break
|
|
m = _ARG_DECL_RE.match(line)
|
|
if m:
|
|
global_args.add(m.group(1))
|
|
|
|
violations: list[tuple[int, str, str]] = []
|
|
for lineno, line in enumerate(lines, start=1):
|
|
violations.extend(
|
|
(lineno, line.strip(), m.group(1))
|
|
for m in _FROM_ARG_RE.finditer(line)
|
|
if m.group(1) not in global_args
|
|
)
|
|
|
|
return violations
|
|
|
|
|
|
class TestDockerfileArgScope(unittest.TestCase):
|
|
"""Fail when ARGs used in FROM instructions are not in the global scope."""
|
|
|
|
def test_from_args_declared_globally(self) -> None:
|
|
dockerfiles = _collect_dockerfiles()
|
|
self.assertTrue(
|
|
dockerfiles or True,
|
|
"No Dockerfiles found — check _ROLES_ROOT path.",
|
|
)
|
|
|
|
failures: list[str] = []
|
|
for dockerfile in dockerfiles:
|
|
violations = _undeclared_from_args(dockerfile)
|
|
for lineno, from_line, var_name in violations:
|
|
relative = dockerfile.relative_to(_REPO_ROOT).as_posix()
|
|
failures.append(
|
|
f"{relative}:{lineno}: ARG '{var_name}' used in FROM but not "
|
|
f"declared in global scope — '{from_line}'"
|
|
)
|
|
|
|
self.assertFalse(
|
|
failures,
|
|
"The following Dockerfiles reference ARGs in FROM instructions that are "
|
|
"not declared before the first FROM (global scope).\n"
|
|
"ARGs used in FROM must be declared globally so Docker can resolve them "
|
|
"in multi-stage builds:\n\n" + "\n".join(f" {f}" for f in failures),
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|