mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 10:59:59 +00:00
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>
85 lines
2.8 KiB
Python
85 lines
2.8 KiB
Python
import re
|
|
import sys
|
|
import unittest
|
|
|
|
from . import PROJECT_ROOT
|
|
|
|
ROOT = str(PROJECT_ROOT)
|
|
sys.path.insert(0, ROOT)
|
|
|
|
from cli.meta.roles.applications.all import find_application_ids # noqa: E402
|
|
from utils.cache.files import iter_project_files_with_content # noqa: E402
|
|
|
|
|
|
class TestValidApplicationUsage(unittest.TestCase):
|
|
"""
|
|
Integration test to ensure that only valid application IDs
|
|
are used in all .yml, .yaml, .yml.j2, .yaml.j2, and .py files.
|
|
|
|
It detects:
|
|
- lookup('applications', 'name') (canonical applications lookup)
|
|
- get_domain('name') (filter helper for domain resolution)
|
|
|
|
Dynamic calls such as lookup('applications', application_id) are not
|
|
validated here, because the app ID is a runtime variable.
|
|
"""
|
|
|
|
LOOKUP_APPLICATIONS_RE = re.compile(
|
|
r"lookup\(\s*['\"]applications['\"]\s*,\s*['\"](?P<name>[^'\"]+)['\"]"
|
|
)
|
|
APPLICATION_DOMAIN_RE = re.compile(
|
|
r"get_domain\(\s*['\"](?P<name>[^'\"]+)['\"]\s*\)"
|
|
)
|
|
|
|
@staticmethod
|
|
def _line_no_and_col(content: str, index: int) -> tuple[int, int]:
|
|
"""
|
|
Return 1-based (line_no, col) for a 0-based absolute index into content.
|
|
"""
|
|
line_no = content.count("\n", 0, index) + 1
|
|
line_start = content.rfind("\n", 0, index) + 1
|
|
col = (index - line_start) + 1
|
|
return line_no, col
|
|
|
|
def test_application_references_use_valid_ids(self):
|
|
valid_apps = find_application_ids()
|
|
|
|
patterns = (
|
|
self.LOOKUP_APPLICATIONS_RE,
|
|
self.APPLICATION_DOMAIN_RE,
|
|
)
|
|
|
|
for filepath, content in iter_project_files_with_content(
|
|
extensions=(".yml", ".yaml", ".yml.j2", ".yaml.j2", ".py"),
|
|
exclude_tests=True,
|
|
):
|
|
for pattern in patterns:
|
|
for match in pattern.finditer(content):
|
|
start = match.start()
|
|
|
|
line_start = content.rfind("\n", 0, start) + 1
|
|
line_end = content.find("\n", start)
|
|
line = content[line_start : line_end if line_end != -1 else None]
|
|
|
|
if line.strip().startswith(("import ", "from ")):
|
|
continue
|
|
|
|
name = match.group("name")
|
|
|
|
line_no, col = self._line_no_and_col(content, start)
|
|
|
|
self.assertIn(
|
|
name,
|
|
valid_apps,
|
|
msg=(
|
|
f"{filepath}: reference to application '{name}' is invalid.\n"
|
|
f"Location: line {line_no}, col {col}\n"
|
|
f"Line: {line.rstrip()}\n"
|
|
f"Known IDs: {sorted(valid_apps)}"
|
|
),
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|