mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-07 19:32:17 +00:00
kevinveenbirkenbachandClaude Opus 4.7
d3afe0bc81
Hard-coded self-path references rot the moment the file moves: a header
comment ``# utils/foo/bar.py`` at the top of a module, a docstring
mentioning ``utils/foo/bar.py``, or a docs entry linking
``utils/foo/bar.py`` from inside ``utils/foo/bar.py`` itself all silently
desync from reality after the next ``git mv``.
The new lint walks every project file, computes its POSIX-style relative
path from PROJECT_ROOT, and reports any line whose text contains that
path as a substring. Files at the repo root (no ``/`` in their relative
path) and setuptools-generated ``*.egg-info/`` artefacts are exempt.
Per-line opt-out via ``# nocheck: self-path-reference`` on the offending
line, registered in the suppression catalog.
Existing offenders cleaned up:
- 72 redundant ``# <self-path>`` header lines removed across roles,
cli, plugins, scripts, tests, and utils.
- 4 prometheus templates that told consumers to "update
<self-template-path>" rewritten to drop the redundant self-reference.
- 8 docstring/comment self-references in cli, plugins, tests, utils,
and the dashboard oidc.js.j2 header rewritten to describe the layout
without naming the file's own path.
- 17 legitimate usage examples (shell scripts, test data lists, one
template self-include doc-block) marked with ``nocheck:
self-path-reference``.
- ``container.sh`` heredoc usage strings switched to ``${0}`` so the
marker stays out of the user-visible help output.
- ``healthcheck/http.yml.j2`` doc-block rewritten to prose because
``{# ... #}`` Jinja comments cannot host an inner ``{# nocheck #}``
(the inner ``#}`` closes the outer comment).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
71 lines
2.0 KiB
Python
71 lines
2.0 KiB
Python
"""
|
|
Ansible lookup plugin: version
|
|
|
|
No parameters.
|
|
Reads ``pyproject.toml`` from the repository root, located by walking
|
|
parents from this plugin file's location.
|
|
|
|
Resolution order:
|
|
1) [project].version (PEP 621)
|
|
2) [tool.poetry].version (Poetry fallback)
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
|
|
from ansible.errors import AnsibleError
|
|
from ansible.plugins.lookup import LookupBase
|
|
|
|
from plugins.lookup import PROJECT_ROOT
|
|
|
|
try:
|
|
import tomllib # Python 3.11+
|
|
except Exception:
|
|
try:
|
|
import tomli as tomllib
|
|
except Exception as exc:
|
|
raise AnsibleError(
|
|
"version lookup requires 'tomllib' (Python 3.11+) "
|
|
"or the 'tomli' package installed on the control node."
|
|
) from exc
|
|
|
|
|
|
def _get_nested(data: dict, path: list[str]):
|
|
cur = data
|
|
for key in path:
|
|
if not isinstance(cur, dict) or key not in cur:
|
|
return None
|
|
cur = cur[key]
|
|
return cur
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
def run(self, terms, variables=None, **kwargs):
|
|
# Intentionally ignore terms/kwargs — no parameters supported
|
|
|
|
pyproject_path = str(PROJECT_ROOT / "pyproject.toml")
|
|
|
|
if not Path(pyproject_path).exists():
|
|
raise AnsibleError(f"version lookup: file not found: {pyproject_path}")
|
|
|
|
try:
|
|
with Path(pyproject_path).open("rb") as f:
|
|
data = tomllib.load(f)
|
|
except Exception as exc:
|
|
raise AnsibleError(
|
|
f"version lookup: failed to parse TOML: {pyproject_path}: {exc}"
|
|
) from exc
|
|
|
|
version = _get_nested(data, ["project", "version"])
|
|
if not version:
|
|
version = _get_nested(data, ["tool", "poetry", "version"])
|
|
|
|
if not version or not isinstance(version, str) or not version.strip():
|
|
raise AnsibleError(
|
|
f"version lookup: could not extract version from {pyproject_path}. "
|
|
"Tried [project].version and [tool.poetry].version."
|
|
)
|
|
|
|
return [version.strip()]
|