mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-21 18:15:16 +00:00
Strip every `req <NNN>`, `req-<NNN>`, `Requirement <NNN>`, `requirement-<NNN>`, and `docs/requirements/<NNN>-...md` mention from non-Markdown source files. Comments anchored to requirement numbers rot when requirements are renumbered or rewritten and conflate present-state behaviour (which the comment should describe) with the audit trail of how the code got there (which belongs in commit messages, PR descriptions, and the requirement file itself). * Document the rule in `docs/contributing/documentation.md` under "Comments". Code MUST describe the *why* in present-state language; contract enforcement lives in tests, not folklore. * Clean 254 source files across `roles/`, `tests/`, `plugins/`, `cli/`, `scripts/`, `utils/`, `group_vars/`, and the repo-root `eslint.config.js`. Pure comment / docstring / log-message edits; no behavioural change. * Add `tests/lint/repository/test_no_req_references_in_code.py` to enforce the rule going forward across `.js`, `.py`, `.yml`, `.yaml`, `.j2`, and `.sh` files. The legacy `test_no_stale_requirement_refs.py` is exempt as the only file whose purpose is to detect these very tokens. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
147 lines
5.0 KiB
Python
147 lines
5.0 KiB
Python
from __future__ import annotations
|
|
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
from plugins.lookup.active_alertmanager_channels import LookupModule
|
|
from utils.cache import _reset_cache_for_tests
|
|
|
|
|
|
def _make_applications(*app_ids: str, channels: tuple = ()) -> dict:
|
|
"""Build a minimal applications dict.
|
|
|
|
apps listed in *channels* get services.prometheus.communication.channel: true;
|
|
others do not.
|
|
"""
|
|
# Per the materialised payload moved from
|
|
# `applications.<app>.compose.services.<X>` to `applications.<app>.services.<X>`.
|
|
return {
|
|
app_id: (
|
|
{"services": {"prometheus": {"communication": {"channel": True}}}}
|
|
if app_id in channels
|
|
else {}
|
|
)
|
|
for app_id in app_ids
|
|
}
|
|
|
|
|
|
# Empty tmp roles dir → get_merged_applications returns the inventory
|
|
# `applications` override dict verbatim, without leaking real repo role defaults.
|
|
_TMP_ROLES_DIR_HOLDER: dict = {}
|
|
|
|
|
|
def setUpModule() -> None:
|
|
_TMP_ROLES_DIR_HOLDER["tmpdir"] = tempfile.TemporaryDirectory()
|
|
_TMP_ROLES_DIR_HOLDER["path"] = Path(_TMP_ROLES_DIR_HOLDER["tmpdir"].name)
|
|
|
|
|
|
def tearDownModule() -> None:
|
|
_TMP_ROLES_DIR_HOLDER["tmpdir"].cleanup()
|
|
|
|
|
|
def _run(applications: dict, group_names: list) -> list:
|
|
_reset_cache_for_tests()
|
|
return LookupModule().run(
|
|
[],
|
|
variables={"applications": applications, "group_names": group_names},
|
|
roles_dir=str(_TMP_ROLES_DIR_HOLDER["path"]),
|
|
)[0]
|
|
|
|
|
|
class TestActiveAlertmanagerChannelsDeploymentCheck(unittest.TestCase):
|
|
"""group_names gate — app must be deployed on this host."""
|
|
|
|
def test_includes_channel_when_deployed(self):
|
|
apps = _make_applications(
|
|
"web-app-mattermost", channels=("web-app-mattermost",)
|
|
)
|
|
result = _run(apps, ["web-app-mattermost"])
|
|
self.assertIn("web-app-mattermost", result)
|
|
|
|
def test_excludes_channel_when_not_deployed(self):
|
|
apps = _make_applications(
|
|
"web-app-mattermost", channels=("web-app-mattermost",)
|
|
)
|
|
result = _run(apps, [])
|
|
self.assertNotIn("web-app-mattermost", result)
|
|
|
|
def test_excludes_channel_when_deployed_but_not_in_group_names(self):
|
|
apps = _make_applications(
|
|
"web-app-mailu",
|
|
"web-app-matrix",
|
|
channels=("web-app-mailu", "web-app-matrix"),
|
|
)
|
|
result = _run(apps, ["web-app-mailu"])
|
|
self.assertIn("web-app-mailu", result)
|
|
self.assertNotIn("web-app-matrix", result)
|
|
|
|
|
|
class TestActiveAlertmanagerChannelsSelfDeclaration(unittest.TestCase):
|
|
"""services.prometheus.communication.channel flag gate — must be true in app config."""
|
|
|
|
def test_excludes_app_without_channel_flag(self):
|
|
apps = _make_applications("web-app-mattermost") # no channel flag
|
|
result = _run(apps, ["web-app-mattermost"])
|
|
self.assertNotIn("web-app-mattermost", result)
|
|
|
|
def test_includes_all_declared_channels_when_deployed(self):
|
|
apps = _make_applications(
|
|
"web-app-mattermost",
|
|
"web-app-matrix",
|
|
"web-app-mailu",
|
|
channels=("web-app-mattermost", "web-app-matrix", "web-app-mailu"),
|
|
)
|
|
result = _run(apps, ["web-app-mattermost", "web-app-matrix", "web-app-mailu"])
|
|
self.assertCountEqual(
|
|
result, ["web-app-mattermost", "web-app-matrix", "web-app-mailu"]
|
|
)
|
|
|
|
def test_result_is_sorted(self):
|
|
apps = _make_applications(
|
|
"web-app-mattermost",
|
|
"web-app-matrix",
|
|
"web-app-mailu",
|
|
channels=("web-app-mattermost", "web-app-matrix", "web-app-mailu"),
|
|
)
|
|
result = _run(apps, ["web-app-mattermost", "web-app-matrix", "web-app-mailu"])
|
|
self.assertEqual(result, sorted(result))
|
|
|
|
def test_non_channel_apps_are_excluded(self):
|
|
apps = _make_applications(
|
|
"web-app-gitea",
|
|
"web-app-nextcloud",
|
|
"web-app-mattermost",
|
|
channels=("web-app-mattermost",),
|
|
)
|
|
result = _run(
|
|
apps, ["web-app-gitea", "web-app-nextcloud", "web-app-mattermost"]
|
|
)
|
|
self.assertNotIn("web-app-gitea", result)
|
|
self.assertNotIn("web-app-nextcloud", result)
|
|
self.assertIn("web-app-mattermost", result)
|
|
|
|
|
|
class TestActiveAlertmanagerChannelsEmptyInputs(unittest.TestCase):
|
|
"""Edge cases: empty applications and empty group_names."""
|
|
|
|
def test_returns_empty_when_group_names_empty(self):
|
|
apps = _make_applications(
|
|
"web-app-mattermost", channels=("web-app-mattermost",)
|
|
)
|
|
result = _run(apps, [])
|
|
self.assertEqual(result, [])
|
|
|
|
def test_returns_empty_when_applications_empty(self):
|
|
result = _run({}, ["web-app-mattermost"])
|
|
self.assertEqual(result, [])
|
|
|
|
def test_returns_empty_when_no_channels_declared(self):
|
|
apps = _make_applications("web-app-gitea", "web-app-nextcloud")
|
|
result = _run(apps, ["web-app-gitea", "web-app-nextcloud"])
|
|
self.assertEqual(result, [])
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|