test(tests): select resources in absence-only Helm checks

Signed-off-by: Ahmed Kamal <email.ahmedkamal@googlemail.com>
Assisted-by: LLM
This commit is contained in:
Ahmed Kamal committed 2026-10-31 23:07:29 +02:00
1 parent 94ada11eef
commit a8c4640bea
10 files changed
+294 -23

No files matched your search

+4
View File
@@ -364,6 +364,10 @@ jobs:
with:
path: _out/envtest
key: envtest-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('Makefile') }}
- name: Check new Helm document indices
env:
BASE_REF: ${{ github.event.pull_request.base.ref }}
run: python3 hack/check-helm-document-indices.py "$(git merge-base HEAD "origin/$BASE_REF")"
# -k is required, not cosmetic: unit-tests and test-controllers are two
# independent goals on the same command line, and without -k make stops
# handing out new work the moment any unit-tests prerequisite fails —
+141
View File
@@ -0,0 +1,141 @@
#!/usr/bin/env bats
load test_helper
REPO_ROOT="$(cd "$(dirname "${BATS_TEST_FILENAME:-$0}")/.." && pwd)"
setup() {
strict_setup
tmp=$(mktemp -d)
cd "$tmp"
git init -q
mkdir -p packages/apps/example/templates packages/apps/example/tests
cat > packages/apps/example/templates/multi.yaml <<'EOF'
apiVersion: v1
kind: ConfigMap
metadata:
name: first
---
apiVersion: v1
kind: Secret
metadata:
name: second
EOF
head -n 4 packages/apps/example/templates/multi.yaml > packages/apps/example/templates/single.yaml
git add .
git -c user.name=Test -c user.email=test@example.org commit -qm fixture
base=$(git rev-parse HEAD)
}
teardown() {
cd "$REPO_ROOT"
rm -rf "$tmp"
}
write_suite() {
cat > packages/apps/example/tests/resource_test.yaml <<EOF
suite: resource selection
templates:
- templates/$1.yaml
tests:
- it: checks a resource
documentIndex: 0
asserts:
- notExists:
path: spec.missing
EOF
git add .
}
@test "rejects a new test-level index on a multi-document template" {
write_suite multi
if python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base" > output 2>&1; then
echo "accepted a positional selector on a multi-document template" >&2
false
fi
grep -q 'resource_test.yaml:6: use documentSelector' output
}
@test "allows an index on a single-document template and ignores comments" {
write_suite single
printf '\n# documentIndex: 1\n' >> packages/apps/example/tests/resource_test.yaml
python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base"
}
@test "leaves existing indices alone when another assertion changes" {
write_suite multi
git -c user.name=Test -c user.email=test@example.org commit -qm existing
base=$(git rev-parse HEAD)
sed -i 's/spec.missing/spec.other/' packages/apps/example/tests/resource_test.yaml
python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base"
}
@test "follows assertion template overrides in later YAML suites" {
write_suite single
cat >> packages/apps/example/tests/resource_test.yaml <<'EOF'
---
suite: overridden template
templates:
- templates/single.yaml
tests:
- it: checks another resource
asserts:
- notExists:
path: spec.missing
template: templates/multi.yaml
documentIndex: 1
EOF
if python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base" > output 2>&1; then
echo "accepted an assertion-level positional selector" >&2
false
fi
grep -q 'use documentSelector.*templates/multi.yaml' output
}
@test "rejects an invalid base rather than passing an empty diff" {
if python3 "$REPO_ROOT/hack/check-helm-document-indices.py" missing-base > output 2>&1; then
echo "accepted an invalid base" >&2
false
fi
}
@test "test-level indices follow each assertion's template override" {
write_suite multi
cat > packages/apps/example/tests/resource_test.yaml <<'EOF'
suite: assertion override
templates: [templates/single.yaml, templates/multi.yaml]
tests:
- it: checks only the single-document template
documentIndex: 0
asserts:
- template: templates/single.yaml
notExists:
path: spec.missing
EOF
python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base"
}
@test "conditional kinds inside one document are not multiple documents" {
write_suite single
cat > packages/apps/example/templates/single.yaml <<'EOF'
apiVersion: v1
{{ if .Values.secret }}
kind: Secret
{{ else }}
kind: ConfigMap
{{ end }}
metadata:
name: single
EOF
python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base"
}
@test "rejects a positional selector whose value is on a separate line" {
write_suite multi
sed -i 's/documentIndex: 0/documentIndex:\n 0/' packages/apps/example/tests/resource_test.yaml
if python3 "$REPO_ROOT/hack/check-helm-document-indices.py" "$base" > output 2>&1; then
echo "accepted a multiline positional selector" >&2
false
fi
grep -q 'resource_test.yaml:6: use documentSelector' output
}
+79
View File
@@ -0,0 +1,79 @@
#!/usr/bin/env python3
"""Reject added positional selectors on multi-resource Helm templates.
Usage: hack/check-helm-document-indices.py <base-ref>
Requires mikefarah/yq, like the chart test tooling. Existing indices are left
alone. This static check counts --- separated blocks with a top-level kind;
it does not evaluate conditional documents or resources emitted by helpers/ranges.
"""
import json
from pathlib import Path
import re
import subprocess
import sys
def git(*args):
return subprocess.check_output(["git", *args], text=True)
def check(base):
root = Path(git("rev-parse", "--show-toplevel").strip())
paths = git("diff", "--name-only", "--diff-filter=ACMR", base, "--",
"packages/*/*/tests/*_test.yaml").splitlines()
errors = []
for path in paths:
added = set()
for line in git("diff", "--no-ext-diff", "--unified=0", base, "--", path).splitlines():
if line.startswith("@@"):
number = int(re.search(r"\+(\d+)", line).group(1))
elif line.startswith(("+++", "---", "diff ", "index ", "\\")):
continue
elif line.startswith("+"):
if "documentIndex" in line:
added.add(number)
number += 1
elif line.startswith(" "):
number += 1
if not added:
continue
# Preserve the key's source line while yq resolves multi-document YAML,
# flow mappings and anchors; a text-only suite parser misses those.
expression = ('[. | (.. | select(tag == "!!map" and has("documentIndex")) '
'| .documentIndex) |= {"line": key | line}]')
suites = json.loads(subprocess.check_output(
["yq", "eval-all", "-o=json", expression, str(root / path)], text=True))
chart = (root / path).parent.parent
for suite in suites:
if not suite:
continue
for test in suite.get("tests", []):
templates = test.get("templates", suite.get("templates", ["templates/*"]))
for assertion in test.get("asserts", []):
index = assertion.get("documentIndex", test.get("documentIndex", {}))
number = index.get("line")
if number not in added:
continue
selected = [assertion["template"]] if "template" in assertion else templates
for pattern in selected:
matches = list(chart.glob(pattern))
if not matches:
matches = list((chart / "templates").glob(pattern))
for template in matches:
if not template.is_file():
continue
documents = re.split(r"(?m)^---[ \t]*(?:#.*)?$", template.read_text())
if sum(bool(re.search(r"(?m)^kind\s*:", doc)) for doc in documents) > 1:
errors.append(f"{path}:{number}: use documentSelector, not "
f"documentIndex, for {template.relative_to(root)}")
for error in sorted(set(errors)):
print(error, file=sys.stderr)
return bool(errors)
if __name__ == "__main__":
if len(sys.argv) != 2:
sys.exit("usage: check-helm-document-indices.py <base-ref>")
sys.exit(check(sys.argv[1]))
@@ -137,11 +137,13 @@ tests:
release:
name: test-kafka
namespace: tenant-test
documentSelector:
path: kind
value: Role
asserts:
- notContains:
path: rules[2].resourceNames
content: test-kafka-zookeeper
documentIndex: 0
# External bootstrap service absent when external=false, regardless of tls.enabled
- it: does not grant access to external bootstrap service when tls.enabled=true and external=false
@@ -241,18 +241,22 @@ tests:
errorMessage: 'controlPlane.apiServer.extraArgs contains "--secure-port=6444" — the tenant control plane sets --secure-port itself and drops every entry naming it before the kube-apiserver sees the list, so this entry has no effect, and written without =value it leaves its value behind as an argument the apiserver refuses. Remove the entry; the description of controlPlane.apiServer.extraArgs lists every flag the control plane owns.'
- it: leaves spec.admissionControllers out by default, so the control plane keeps its own default set
documentSelector:
path: kind
value: KamajiControlPlane
asserts:
- notExists:
path: spec.admissionControllers
documentIndex: 1
- it: leaves spec.admissionControllers out for an explicitly empty list
set:
controlPlane.apiServer.admissionControllers: []
documentSelector:
path: kind
value: KamajiControlPlane
asserts:
- notExists:
path: spec.admissionControllers
documentIndex: 1
- it: renders controlPlane.apiServer.admissionControllers into spec.admissionControllers verbatim
set:
+21 -6
View File
@@ -530,7 +530,9 @@ tests:
- templates/dashboard-resourcemap.yaml
set:
external: false
documentIndex: 0
documentSelector:
path: kind
value: Role
asserts:
- notContains:
path: rules[1].resourceNames
@@ -544,7 +546,9 @@ tests:
- templates/dashboard-resourcemap.yaml
set:
external: true
documentIndex: 0
documentSelector:
path: kind
value: Role
asserts:
- notContains:
path: rules[1].resourceNames
@@ -560,7 +564,9 @@ tests:
external: true
tls:
issuer: operator
documentIndex: 0
documentSelector:
path: kind
value: Role
asserts:
- notContains:
path: rules[1].resourceNames
@@ -576,7 +582,9 @@ tests:
external: false
tls:
issuer: cert-manager
documentIndex: 0
documentSelector:
path: kind
value: Role
asserts:
- notContains:
path: rules[1].resourceNames
@@ -695,7 +703,9 @@ tests:
set:
tls:
issuer: cert-manager
documentIndex: 3
documentSelector:
path: metadata.name
value: my-mariadb-tls
asserts:
- notContains:
path: spec.dnsNames
@@ -1187,7 +1197,9 @@ tests:
- it: "dashboard Role never grants the CA bundle even when TLS is unmanaged"
templates:
- templates/dashboard-resourcemap.yaml
documentIndex: 0
documentSelector:
path: kind
value: Role
set:
tls:
issuer: operator
@@ -1436,6 +1448,9 @@ tests:
enabled: true
s3Bucket: s3.example.org/test
cleanupStrategy: "--keep-last=3"
documentSelector:
path: kind
value: Secret
asserts:
- notMatchRegex:
path: stringData["backup.sh"]
+24 -8
View File
@@ -53,7 +53,9 @@ tests:
value: mg-test-ssl
- it: spec.tls has no issuerConf (the operator-managed secret is passed directly)
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
- notExists:
path: spec.tls.issuerConf
@@ -127,13 +129,17 @@ tests:
# test would pass even with the external check removed.
_namespace:
host: example.com
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
- notExists:
path: spec.replsets[0].splitHorizons
- it: chart does not set allowInvalidCertificates, leaving the operator default
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
# The README states the permissive default is inherited rather than
# chosen here. Pin that, so the claim stays falsifiable.
@@ -141,7 +147,9 @@ tests:
path: spec.tls.allowInvalidCertificates
- it: chart does not set certValidityDuration, leaving the operator default
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
# Same class as allowInvalidCertificates above: the leaf lifetime is the
# operator's to choose, not this chart's. Deliberately left unpinned.
@@ -177,7 +185,9 @@ tests:
# the CRD and notExists on it can never fail.
- it: no TLS-disabling escape hatches with a default replica count
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
- notExists:
path: spec.allowUnsafeConfigurations
@@ -235,7 +245,9 @@ tests:
- name: rs0
replicas: 3
size: 10Gi
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
# splitHorizons is replica-set scoped and rendered only for the
# non-sharded topology. In sharded mode external access goes through the
@@ -255,7 +267,9 @@ tests:
replicas: 0
_namespace:
host: example.com
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
# With replicas: 0 the range body renders nothing. Emitting the key with
# a null value would be rejected by the API server: the CRD types
@@ -269,7 +283,9 @@ tests:
external: true
_namespace:
host: ""
documentIndex: 0
documentSelector:
path: kind
value: PerconaServerMongoDB
asserts:
# The controller may create _namespace before populating host, so the
# bootstrap window presents host as an empty string rather than as an
+6 -2
View File
@@ -557,7 +557,9 @@ tests:
external: false
tls:
enabled: true
documentIndex: 3
documentSelector:
path: metadata.name
value: my-redis-tls
asserts:
- notContains:
path: spec.dnsNames
@@ -840,7 +842,9 @@ tests:
external: false
tls:
enabled: true
documentIndex: 3
documentSelector:
path: metadata.name
value: my-redis-tls
asserts:
- notContains:
path: spec.dnsNames
@@ -228,10 +228,14 @@ tests:
gateway-class-name: " cloudflare-tunnel "
gateway-edge-classes: cloudflare-tunnel
asserts:
- documentIndex: 0
- documentSelector:
path: metadata.name
value: letsencrypt-prod
notExists:
path: spec.acme.solvers[0].http01.gatewayHTTPRoute.parentRefs[0].sectionName
- documentIndex: 1
- documentSelector:
path: metadata.name
value: letsencrypt-stage
notExists:
path: spec.acme.solvers[0].http01.gatewayHTTPRoute.parentRefs[0].sectionName
@@ -156,9 +156,11 @@ tests:
resources:
requests:
storage: 10Gi
documentSelector:
path: kind
value: Job
asserts:
- documentIndex: 0
notMatchRegex:
- notMatchRegex:
path: spec.template.spec.containers[0].args[0]
pattern: kubectl patch pvc