feat(ci): promtool in the pinned toolchain, one alert-rule harness, and the gaps declared
The CNPG alert unit tests (324 lines, mutation-checked) were run by NOTHING. promtool was
not in the baked toolchain, no gate stage evaluated any *.promtool-test.yaml, and the only
runner `curl | tar -xz`'d a promtool release from GitHub at TEST-RUN time if one was
missing. Hours later a second, independent harness landed for the Velero rules
(platform/monitoring/tests/) with its own fallback — a `podman run` of
quay.io/prometheus/prometheus. So the repo had two harnesses, two acquisition paths, and
coverage that looked present and was enforced nowhere: the exact failure mode that had just
produced a permanently-firing CNPG alert and a structurally inert Velero alert.
PROMTOOL IS NOW PINNED LIKE EVERY OTHER TOOL. PROMTOOL_VERSION=3.14.0 in
infra/devcontainer/versions.env and ci/versions.env (the two stay in lockstep, per the
repo's rule), baked by the Containerfile from the prometheus release tarball (promtool ships
inside it), recorded in /etc/dev-toolchain-versions, passed by dev.sh, and installed for the
l0 stage by .gitea/workflows/scripts/install-tools.sh so the CI runner is not permanently
SKIPPED. The pin is not free-floating: promtool IS the rule engine, so it tracks the
Prometheus prod actually runs — verified against the live cluster, not assumed:
kubectl --context k3s-prod get prometheus -n monitoring -o jsonpath='{.items[*].spec.version}'
-> v3.14.0-distroless (image quay.io/prometheus/prometheus:v3.14.0-distroless)
ONE HARNESS. platform/cnpg/run-alert-tests.sh is folded into
platform/monitoring/tests/run.sh, which now covers every PrometheusRule in the repo that has
tests, via two conventions it discovers automatically: `<manifest>.promtool-test.yaml`
beside its manifest (cnpg), and `<component>/tests/*.test.yaml` over that component's
manifests (monitoring). It writes the flattened rules under whatever name each test file's
own `rule_files:` declares, so no test file needs to know the harness exists, and it
`promtool check rules` first — a rules file that does not parse would make every unit test
pass vacuously by finding no rules at all. The cnpg script's reasoning is preserved: why a
CR must be flattened (`.spec.groups`, never re-typed), and why generated files go to a temp
dir. Its `${BASE_DOMAIN}` substitution is dropped in favour of extract_rules.py's verbatim
placeholders, with the trade-off recorded there — the hazard it guarded against is addressed
by the temp dir, and verbatim leaves one transformation fewer between the shipped rule and
the rule under test.
NO ENGINE IS ACQUIRED AT RUN TIME any more — not the GitHub release, not the container
image. Not because a pinned download is unusual here (the Containerfile downloads every tool
it bakes) but because those two decided the version, the network and the machine SILENTLY,
at test time, on whatever host ran the tests; and each quietly turned "the toolchain has no
promtool" into a green run, which is how the toolchain stayed without one. Missing promtool
is exit 3 (UNWIRED, never green); a PROMTOOL= that does not resolve is exit 2.
ONE WIRING: conformance/tests/l0-static/alert-rules-unit-tested, NOT a gate stage. The
`prom-rules` stage (ci/prom-rules.sh + its Makefile target + ci/gate.sh entry) is deleted:
it is the bespoke-per-check pattern b9f8807 had just removed from ci/l0.sh, and the
declarative replacement gives what a hand-written stage cannot — selection by
`conformance.home.k3s/scope: "whole-repo"` (asserted: the test is selected even under a
requirement filter matching nothing), requirement-attributed JUnit/coverage/ledger evidence,
and run_l1_offline.py's rule that a SKIP of a scope-declaring check is the runner's rc 3.
The scope declaration is load-bearing here: touched-requirements.sh keys apps/* to nothing
and platform/monitoring/* to R-OBS-01/02, never R-OBS-04, so a new untested PrometheusRule
would otherwise be gated by nothing.
The check asserts the pins and their lockstep, that the image bakes and records promtool,
that the promtool IN USE reports exactly the pin (a FAILURE, not a skip: the wrong engine
still prints SUCCESS), that exactly ONE harness exists and none fetches an engine, that
every rule-unit test file passes, and — on every run — that the harness CAN fail, by putting
a synthetic rule through it twice with one expectation mutated.
MISSING TESTS ARE A RATCHET, deliberately, and the reasoning is in the check's header. 51 of
58 alert rules have no unit test. Failing on all of them makes the gate red until ~51 tests
exist, so it gets disabled and protects nothing; merely reporting is exactly how the CNPG
tests came to be enforced by nothing. So the gap is DECLARED in the check as a shrink-only
register, printed with counts every run (13 alert files nothing tests at all; 35 named
alerts inside covered files that nothing asserts on), and it cannot grow: a new
PrometheusRule, or a new alert in an already-covered file, FAILS without a test, and a stale
entry FAILS too. A missing test is never an exit-3 skip — SKIPPED is reserved for the one
genuine environment gap, promtool being absent.
PROVEN, in the rebuilt image (promtool 3.14.0):
* both suites pass through the single harness: cnpg 6 rules, monitoring 36 rules, SUCCESS.
* the check passes: 95 assertions, 7/58 alert rules unit-tested, 13 declared gap files.
* NOT VACUOUS, twice over. Shortening CNPGPrimariesCoLocated's `for: 30m` to 5m turns it
red (pending expected at 25m/29m, got firing), reverted. Adding an untested
PrometheusRule (platform/kubevirt/probe-alerts.yaml) turns it red on the ratchet,
removed. The harness's own mutation self-test runs on every invocation.
* the scope mechanism selects it: `run.sh --layer l0 --requirements r-nosuchreq-99
--include-scope whole-repo --print-selection` lists alert-rules-unit-tested.
Co-Authored-By: Claude Opus 5 <[email protected]>
This commit is contained in:
jakman85andClaude Opus 5 committed
1 parent
4865734c5f
commit
78d0f1b0f6
18 files changed
+950
-187
No files matched your search
@@ -9,11 +9,25 @@
|
||||
# not evidence that it can fire, and it is certainly not evidence that it can stop. These tests pin
|
||||
# BOTH directions plus the two ways the rule is meant to stay quiet.
|
||||
#
|
||||
# HOW TO RUN. `./run-alert-tests.sh` in this directory — it extracts `.spec` from the PrometheusRule
|
||||
# (promtool wants a bare Prometheus rules file, not a Kubernetes CR), substitutes ${BASE_DOMAIN},
|
||||
# and runs promtool against both files in a temp dir. promtool is NOT in the baked devcontainer
|
||||
# toolchain (infra/devcontainer/versions.env); the script downloads the version that matches the
|
||||
# Prometheus actually running on prod (v3.14.0) if it is not already on PATH.
|
||||
# HOW TO RUN. `platform/monitoring/tests/run.sh` — the ONE repo-wide rule-unit harness. It finds
|
||||
# this file by the companion convention (`<manifest>.promtool-test.yaml` sits beside
|
||||
# `<manifest>.yaml`), flattens the PrometheusRule CR's `.spec.groups` into the bare Prometheus
|
||||
# rules file promtool wants (a CR is not a rules file), writes it under the name `rule_files:`
|
||||
# below declares, `promtool check rules` it first so a non-parsing file cannot make these tests
|
||||
# pass vacuously, and runs them — all in a temp dir, because a generated file sitting next to its
|
||||
# source is how a stale copy becomes the thing under test. Run just this file with
|
||||
# `platform/monitoring/tests/run.sh platform/cnpg/alerts.promtool-test.yaml`.
|
||||
# (There used to be a cnpg-only `run-alert-tests.sh` here; it was folded into that harness on
|
||||
# 2026-09-12 — two harnesses means two behaviours, and the one nothing runs rots.)
|
||||
#
|
||||
# promtool IS in the baked devcontainer toolchain (PROMTOOL_VERSION in
|
||||
# infra/devcontainer/versions.env, mirrored in ci/versions.env), pinned to the Prometheus version
|
||||
# prod actually runs (v3.14.0) because promtool is the rule ENGINE. A missing promtool is exit 3
|
||||
# (SKIPPED, never green), not a silent download.
|
||||
#
|
||||
# WHO RUNS IT IN CI. conformance/tests/l0-static/alert-rules-unit-tested — the L0 static check
|
||||
# that runs the harness over every *.promtool-test.yaml in the repo and reports which alert files
|
||||
# still have none. Before that check existed these tests were never evaluated by anything.
|
||||
#
|
||||
# WHY THE ASSERTIONS USE `ALERTS` AND NOT `exp_alerts`. promtool's alert_rule_test compares
|
||||
# annotations VERBATIM, which would mean pasting this rule's ~1200-character runbook description in
|
||||
|
||||
@@ -349,7 +349,9 @@ spec:
|
||||
# on k3s-prod-1, keycloak-db-1 on k3s-prod-2, nextcloud-db-1 on k3s-prod-3. Quiet because
|
||||
# the condition is false, NOT because the query went blind.
|
||||
# * UNIT-TESTED, AND THE TESTS CAN FAIL. alerts.promtool-test.yaml (run it with
|
||||
# ./run-alert-tests.sh) covers four cases under promtool 3.14.0, the exact Prometheus
|
||||
# platform/monitoring/tests/run.sh — the one repo-wide harness; the merge gate runs the
|
||||
# same path via conformance/tests/l0-static/alert-rules-unit-tested) covers four cases
|
||||
# under promtool 3.14.0, the exact Prometheus
|
||||
# version running here: co-located fires after 30m, one-per-node is silent, a NotReady
|
||||
# node suppresses it and then re-arms when the node returns, and a non-CNPG `*-rw`
|
||||
# Service is ignored. Mutation-checked — deleting the cnpg_collector_up join, the
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
###############################################################################
|
||||
# platform/cnpg/run-alert-tests.sh — run the promtool unit tests for alerts.yaml.
|
||||
#
|
||||
# WHY A SCRIPT AND NOT JUST `promtool test rules`. Two impedance mismatches:
|
||||
# 1. alerts.yaml is a Kubernetes PrometheusRule CR; promtool wants a bare Prometheus
|
||||
# rules file (`groups:` at the top level). So `.spec` is extracted first.
|
||||
# 2. runbook_url carries `${BASE_DOMAIN}`, a Flux postBuild substitution that is not
|
||||
# resolved in git. promtool does not care what the string says, but leaving a raw
|
||||
# `${...}` in a rendered rules file is exactly the kind of thing that gets copied
|
||||
# somewhere it DOES matter, so it is substituted with a placeholder here.
|
||||
# Both derived files go to a temp dir — nothing generated is left in the worktree, because
|
||||
# a generated file sitting next to its source is how a stale copy becomes the thing under
|
||||
# test.
|
||||
#
|
||||
# promtool is NOT in the baked devcontainer toolchain (infra/devcontainer/versions.env).
|
||||
# If it is not on PATH this fetches the version that matches the Prometheus actually
|
||||
# running on prod, so the unit tests are evaluated by the same engine that will evaluate
|
||||
# the rules for real. Override with PROMTOOL=/path/to/promtool.
|
||||
#
|
||||
# ./run-alert-tests.sh
|
||||
###############################################################################
|
||||
set -euo pipefail
|
||||
|
||||
# Match the Prometheus running on prod: quay.io/prometheus/prometheus:v3.14.0-distroless
|
||||
# (`kubectl get prometheus -n monitoring -o jsonpath='{.items[*].spec.version}'`).
|
||||
PROMETHEUS_VERSION="${PROMETHEUS_VERSION:-3.14.0}"
|
||||
|
||||
here="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
tmp="$(mktemp -d)"
|
||||
trap 'rm -rf "$tmp"' EXIT
|
||||
|
||||
promtool="${PROMTOOL:-$(command -v promtool || true)}"
|
||||
if [[ -z "$promtool" ]]; then
|
||||
echo "==> promtool not on PATH; fetching v${PROMETHEUS_VERSION} (matches prod Prometheus)"
|
||||
tarball="prometheus-${PROMETHEUS_VERSION}.linux-amd64"
|
||||
curl -fsSL "https://github.com/prometheus/prometheus/releases/download/v${PROMETHEUS_VERSION}/${tarball}.tar.gz" \
|
||||
| tar -xz -C "$tmp" --strip-components=1 "${tarball}/promtool"
|
||||
promtool="$tmp/promtool"
|
||||
fi
|
||||
# Absolutised because step 3 runs promtool from inside $tmp — a relative PROMTOOL= would
|
||||
# break there, and it did during development.
|
||||
promtool="$(cd "$(dirname "$promtool")" && pwd)/$(basename "$promtool")"
|
||||
echo "==> $("$promtool" --version 2>&1 | head -1)"
|
||||
|
||||
# 1. PrometheusRule CR -> bare Prometheus rules file, with ${BASE_DOMAIN} resolved.
|
||||
sed 's/\${BASE_DOMAIN}/base-domain.invalid/g' "$here/alerts.yaml" \
|
||||
| python3 -c 'import sys,yaml; yaml.safe_dump(yaml.safe_load(sys.stdin)["spec"], sys.stdout, sort_keys=False, width=10**6)' \
|
||||
> "$tmp/alerts.rules.yaml"
|
||||
cp "$here/alerts.promtool-test.yaml" "$tmp/"
|
||||
|
||||
# 2. Syntax gate first — a rules file that does not parse would make every unit test
|
||||
# "pass" vacuously by finding no rules at all.
|
||||
echo "==> promtool check rules"
|
||||
"$promtool" check rules "$tmp/alerts.rules.yaml"
|
||||
|
||||
# 3. The unit tests.
|
||||
echo "==> promtool test rules"
|
||||
cd "$tmp"
|
||||
"$promtool" test rules alerts.promtool-test.yaml
|
||||
Reference in new issue
Block a user