mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-08 11:46:35 +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>
106 lines
3.1 KiB
Python
106 lines
3.1 KiB
Python
from __future__ import annotations
|
|
|
|
import re
|
|
import unittest
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from utils.cache.yaml import load_yaml_str
|
|
from utils.docker.image.ref import is_valid_image_name
|
|
from utils.roles.mapping import ROLE_FILE_META_SERVICES
|
|
|
|
from . import PROJECT_ROOT
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import Iterable
|
|
from pathlib import Path
|
|
|
|
TAG_RE = re.compile(r"^[A-Za-z0-9_][A-Za-z0-9_.-]{0,127}$")
|
|
|
|
|
|
def _safe_mapping(obj: Any) -> dict[str, Any]:
|
|
return obj if isinstance(obj, dict) else {}
|
|
|
|
|
|
def _iter_role_config_files(repo_root: Path) -> list[Path]:
|
|
roles_dir = repo_root / "roles"
|
|
if not roles_dir.is_dir():
|
|
return []
|
|
return sorted(roles_dir.glob(f"*/{ROLE_FILE_META_SERVICES}"))
|
|
|
|
|
|
def _extract_services(cfg: dict[str, Any]) -> dict[str, Any]:
|
|
return _safe_mapping(cfg)
|
|
|
|
|
|
def _iter_declared_fields(
|
|
services: dict[str, Any],
|
|
) -> Iterable[tuple[str, str, Any]]:
|
|
"""
|
|
Yield (service_name, field_name, value) for each declared field
|
|
where field_name ∈ {"image", "version"}.
|
|
"""
|
|
for svc_name, svc_cfg in services.items():
|
|
svc_map = _safe_mapping(svc_cfg)
|
|
for field in ("image", "version"):
|
|
if field in svc_map:
|
|
yield svc_name, field, svc_map.get(field)
|
|
|
|
|
|
def _is_valid_image(image: Any) -> bool:
|
|
return is_valid_image_name(image)
|
|
|
|
|
|
def _is_valid_version(version: Any) -> bool:
|
|
if not isinstance(version, str):
|
|
return False
|
|
version = version.strip()
|
|
if not version or " " in version:
|
|
return False
|
|
return TAG_RE.fullmatch(version) is not None
|
|
|
|
|
|
class TestDockerServicesImageVersionValid(unittest.TestCase):
|
|
def test_declared_docker_service_image_and_version_are_valid(self) -> None:
|
|
"""
|
|
Rules:
|
|
- `image` is OPTIONAL → only validated if present
|
|
- `version` is OPTIONAL → only validated if present
|
|
- No coupling required between image/version
|
|
"""
|
|
repo_root = PROJECT_ROOT
|
|
failures: list[str] = []
|
|
|
|
config_files = _iter_role_config_files(repo_root)
|
|
self.assertTrue(
|
|
config_files,
|
|
f"No role config files found under: {repo_root / 'roles' / f'*/{ROLE_FILE_META_SERVICES}'}",
|
|
)
|
|
|
|
for cfg_path in config_files:
|
|
with cfg_path.open("r", encoding="utf-8") as f:
|
|
data = load_yaml_str(f) or {}
|
|
|
|
cfg = _safe_mapping(data)
|
|
services = _extract_services(cfg)
|
|
|
|
for svc_name, field, value in _iter_declared_fields(services):
|
|
if field == "image" and not _is_valid_image(value):
|
|
failures.append(
|
|
f"{cfg_path}: services.{svc_name}.image invalid: {value!r}"
|
|
)
|
|
|
|
if field == "version" and not _is_valid_version(value):
|
|
failures.append(
|
|
f"{cfg_path}: services.{svc_name}.version invalid: {value!r}"
|
|
)
|
|
|
|
if failures:
|
|
self.fail(
|
|
"Invalid services image/version entries found:\n"
|
|
+ "\n".join(f"- {x}" for x in failures)
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|