From e578a11b7ab7d9e6426419b1d327b1bfcf7ed9d9 Mon Sep 17 00:00:00 2001 From: Johnathan Corgan Date: Wed, 22 Jul 2026 21:59:28 +0000 Subject: [PATCH] Compare every CI leg in the parity guard, not a folded token The guard collapsed all thirteen chaos legs to the token "chaos" and all five deb-install legs to "deb-install", so sixteen of the thirty-four integration legs were invisible to it. Deleting twelve chaos legs and four deb-install legs from a copy of the workflow left it still reporting "CI parity OK". The fold existed because the guard compared the cosmetic suite name, which really does differ between the runners; both sides have carried a directly comparable scenario field all along, so the fix is to compare that instead, along with the chaos flags. The local suite set is now discovered by sweeping ci-local.sh for suite arrays rather than reading a hardcoded list of variable names, and the deb-install distro list is read from the suite's own script. A suite dispatched with no backing array is invisible to either approach, so every run_suite arm is now checked to have one and the guard names any that does not. That is not hypothetical: next dispatches its mixed-profile suite without an array, and the guard could only report it as missing from the local runner without being able to say why. The guard also now refuses to run rather than failing obscurely when python3 or pyyaml is absent, since a parity check that cannot run must not look like one that passed. Verified by breaking each thing it guards: legs deleted from the workflow, drifted chaos flags, a fabricated suite array, and a dispatch arm whose array was removed. That last case initially did not fire because the arm pattern was pinned to the wrong indentation, which the test caught. --- testing/check-ci-parity.sh | 241 ++++++++++++++++++++++++++----------- 1 file changed, 174 insertions(+), 67 deletions(-) diff --git a/testing/check-ci-parity.sh b/testing/check-ci-parity.sh index deadc6f..f66e377 100755 --- a/testing/check-ci-parity.sh +++ b/testing/check-ci-parity.sh @@ -11,19 +11,30 @@ # unreliable on GitHub-hosted runners. # tor-directory — same; live Tor dependency. # -# Granularity-only differences folded before comparison (same coverage, -# different matrix shape — NOT a divergence): -# deb-install — GitHub splits into per-distro legs (deb-install-debian12/ -# debian13/ubuntu22/ubuntu24/ubuntu26); local runs the same -# distro set in one suite. Folded to "deb-install". -# chaos-* — GitHub fans each chaos scenario into its own matrix leg -# (type: chaos); local runs them all via the one CHAOS_SUITES -# path. The individual scenario names also differ cosmetically -# between runners (e.g. chaos-smoke-10 vs churn-mixed-10). -# Folded to a single "chaos" token on both sides. -# dns-resolver — single leg / single suite both sides; runs all scenarios. +# What is compared, and at what granularity: +# chaos — per scenario, plus its flags. GitHub fans each scenario +# into its own matrix leg carrying `scenario:` (and +# optionally `chaos_flags:`); local lists the same scenarios +# in CHAOS_SUITES as "display scenario flags". The `suite:` +# names differ cosmetically between runners and are ignored +# — `scenario:` is the identity. +# deb-install — per distro. GitHub splits into per-distro legs carrying +# `scenario:`; local runs the same distro set in one suite, +# enumerated by ALL_SCENARIOS in deb-install/test.sh. +# everything else — per suite name. # -# Exit 0 = parity clean. Exit 1 = unexpected divergence (suite names printed). +# dns-resolver is the one leg still compared at leg granularity rather than +# per scenario: it is a single leg and a single suite on both sides, and it +# runs all of its scenarios internally. Its scenario list is NOT cross-checked. +# +# The local suite set is discovered by sweeping ci-local.sh for *_SUITES arrays +# rather than from a hardcoded list of variable names, and every run_suite +# dispatch arm is then checked to have a backing array — a suite dispatched +# without one is invisible to a name-list sweep, which is how a real divergence +# went unnoticed. +# +# Exit 0 = parity clean. Exit 1 = unexpected divergence. Exit 2 = the guard +# could not run (missing file or missing dependency); never treated as a pass. # ───────────────────────────────────────────────────────────────────────────── set -uo pipefail @@ -32,113 +43,209 @@ PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)" CI_LOCAL="$SCRIPT_DIR/ci-local.sh" CI_YML="$PROJECT_ROOT/.github/workflows/ci.yml" +DEB_TEST="$SCRIPT_DIR/deb-install/test.sh" # Deliberate local-only allowlist (suites intentionally absent from GitHub). ALLOWLIST="tor-socks5 tor-directory" -for f in "$CI_LOCAL" "$CI_YML"; do +for f in "$CI_LOCAL" "$CI_YML" "$DEB_TEST"; do if [[ ! -f "$f" ]]; then echo "check-ci-parity: missing file: $f" >&2 exit 2 fi done -# Extract and normalize both suite sets in Python (robust YAML parse of the -# matrix; regex extraction of the bash suite arrays). Folding rules above are -# applied identically to both sides so only genuine divergence surfaces. -python3 - "$CI_LOCAL" "$CI_YML" "$ALLOWLIST" <<'PY' +if ! command -v python3 >/dev/null 2>&1; then + echo "check-ci-parity: python3 not found; cannot verify CI parity" >&2 + exit 2 +fi +if ! python3 -c "import yaml" >/dev/null 2>&1; then + echo "check-ci-parity: python3 module 'yaml' not found; cannot verify CI parity" >&2 + echo "check-ci-parity: install it with 'pip3 install pyyaml'" >&2 + exit 2 +fi + +python3 - "$CI_LOCAL" "$CI_YML" "$DEB_TEST" "$ALLOWLIST" <<'PY' import re import sys -ci_local_path, ci_yml_path, allowlist_raw = sys.argv[1], sys.argv[2], sys.argv[3] +import yaml + +ci_local_path, ci_yml_path, deb_test_path, allowlist_raw = sys.argv[1:5] allowlist = set(allowlist_raw.split()) - -def fold(name): - """Collapse granularity-only matrix shape into canonical suite identity.""" - if name.startswith("chaos-") or name == "chaos": - return "chaos" - if name.startswith("deb-install"): - return "deb-install" - return name - - -# ── Local: parse the suite arrays from ci-local.sh ─────────────────────────── with open(ci_local_path, encoding="utf-8") as fh: local_src = fh.read() +with open(deb_test_path, encoding="utf-8") as fh: + deb_src = fh.read() -def bash_array(var): +def bash_array_entries(var): + """Full entries of a bash array, in order, quotes stripped.""" m = re.search(rf"^{var}=\((.*?)\)", local_src, re.MULTILINE | re.DOTALL) if not m: return [] body = m.group(1) - # Quoted entries (chaos uses "display scenario flags"): first token is name. quoted = re.findall(r'"([^"]*)"', body) if quoted: - return [entry.split()[0] for entry in quoted if entry.strip()] + return [e.strip() for e in quoted if e.strip()] return [tok for tok in body.split() if tok.strip()] +def discovered_arrays(): + """Every *_SUITES array in ci-local.sh, by name. + + Swept rather than hardcoded: a suite whose array is not on a fixed list + would otherwise be invisible to this guard. + """ + return { + name + "_SUITES": bash_array_entries(name + "_SUITES") + for name in re.findall(r"^([A-Z_]+)_SUITES=\(", local_src, re.MULTILINE) + } + + +arrays = discovered_arrays() + +# ── Local side ─────────────────────────────────────────────────────────────── +# Chaos: "display scenario flags" — compare the scenario and its flags. +local_chaos = {} +for entry in arrays.get("CHAOS_SUITES", []): + parts = entry.split() + if len(parts) < 2: + continue + local_chaos[parts[1]] = " ".join(parts[2:]) + +# deb-install: one local suite that runs the distro set enumerated in its script. +m = re.search(r'^ALL_SCENARIOS="([^"]*)"', deb_src, re.MULTILINE) +local_deb = set(m.group(1).split()) if m else set() + +# Everything else: suite names, with NAT stored bare and prefixed at use. local = set() -# Static, rekey, gateway, sidecar, acl, firewall, nostr, stun, dns, deb. -for var in ("STATIC_SUITES", "REKEY_SUITES", "ADMISSION_SUITES", - "GATEWAY_SUITES", "SIDECAR_SUITES", "ACL_SUITES", - "FIREWALL_SUITES", "NOSTR_RELAY_SUITES", "STUN_FAULTS_SUITES", - "DNS_RESOLVER_SUITES", "DEB_INSTALL_SUITES"): - local.update(bash_array(var)) -# Chaos display names → fold to "chaos". -for _ in bash_array("CHAOS_SUITES"): - local.add("chaos") -# NAT scenarios are stored bare (cone/symmetric/lan) and prefixed nat- at use. -for scen in bash_array("NAT_SUITES"): - local.add(f"nat-{scen}") -# TOR_SUITES is the deliberate local-only set — excluded from the default path. - -local = {fold(n) for n in local} - -# ── GitHub: parse the integration matrix suite: values from ci.yml ─────────── -import yaml # noqa: E402 +for name, entries in arrays.items(): + if name in ("CHAOS_SUITES", "DEB_INSTALL_SUITES"): + continue + names = [e.split()[0] for e in entries] + if name == "NAT_SUITES": + local |= {f"nat-{n}" for n in names} + else: + local |= set(names) +# ── GitHub side ────────────────────────────────────────────────────────────── with open(ci_yml_path, encoding="utf-8") as fh: doc = yaml.safe_load(fh) include = doc["jobs"]["integration"]["strategy"]["matrix"]["include"] -github = set() +github_chaos, github_deb, github = {}, set(), set() for leg in include: if "suite" not in leg: continue - # Chaos legs carry inconsistent suite: names (chaos-smoke-10 vs - # churn-mixed-10) but a uniform type: chaos — fold via type, not name. - if str(leg.get("type", "")) == "chaos": - github.add("chaos") + kind = str(leg.get("type", "")) + if kind == "chaos": + github_chaos[str(leg["scenario"])] = str(leg.get("chaos_flags", "")) + elif kind == "deb-install": + github_deb.add(str(leg["scenario"])) else: - github.add(fold(str(leg["suite"]))) + github.add(str(leg["suite"])) -# ── Diff (subtract allowlist from local before comparison) ─────────────────── +# ── Dispatch cross-check: every run_suite arm needs a backing array ────────── +# A suite dispatched without an array is invisible to the sweep above, so the +# guard would report it as GitHub-only forever without ever naming the cause. +body = re.search(r"^run_suite\(\).*?^\}", local_src, re.MULTILINE | re.DOTALL) +dispatch_uncovered = [] +if body is None: + print("check-ci-parity: could not locate run_suite() in ci-local.sh", file=sys.stderr) + sys.exit(2) + +# Arms sit at one fixed indentation inside the case block. Pin to it, taken from +# the first arm rather than assumed, so a body line that happens to end in ')' +# cannot be read as an arm. +arm_re = re.compile(r"^([ \t]+)([a-z0-9|*_-]+)\)", re.MULTILINE) +first = arm_re.search(body.group(0)) +if first is None: + print("check-ci-parity: no dispatch arms found in run_suite()", file=sys.stderr) + sys.exit(2) + +indent = first.group(1) +known = set(local) | set(local_chaos) | local_deb | {"deb-install"} +for m in arm_re.finditer(body.group(0)): + if m.group(1) != indent: + continue + for arm in m.group(2).split("|"): + if arm == "*": + continue # the unknown-suite error arm, not a suite + if arm == "chaos-*": + # Dispatches any chaos- through a fallback, so its vocabulary + # is unbounded; the chaos scenario comparison covers it instead. + continue + if arm not in known: + dispatch_uncovered.append(arm) + +# ── Diff ───────────────────────────────────────────────────────────────────── local_cmp = {n for n in local if n not in allowlist} local_only = sorted(local_cmp - github) github_only = sorted(github - local_cmp) +chaos_local_only = sorted(set(local_chaos) - set(github_chaos)) +chaos_github_only = sorted(set(github_chaos) - set(local_chaos)) +chaos_flag_drift = sorted( + (s, local_chaos[s], github_chaos[s]) + for s in set(local_chaos) & set(github_chaos) + if local_chaos[s] != github_chaos[s] +) +deb_local_only = sorted(local_deb - github_deb) +deb_github_only = sorted(github_deb - local_deb) -if local_only or github_only: - print("CI parity FAILED: integration suite sets diverge.\n") +problems = (local_only or github_only or chaos_local_only or chaos_github_only + or chaos_flag_drift or deb_local_only or deb_github_only + or dispatch_uncovered) + +if problems: + print("CI parity FAILED: the two runners do not cover the same work.\n") if local_only: - print(" Local-only (in ci-local.sh, missing from ci.yml, " - "not in deliberate allowlist):") + print(" Suites local-only (in ci-local.sh, missing from ci.yml, " + "not in the deliberate allowlist):") for n in local_only: print(f" - {n}") if github_only: - print(" GitHub-only (in ci.yml, missing from local default path):") + print(" Suites GitHub-only (in ci.yml, missing from the local default path):") for n in github_only: print(f" - {n}") - print("\n Resolve by adding the suite to the other runner, or by adding " - "it\n to the deliberate local-only allowlist in " - "check-ci-parity.sh with a\n stated reason.") + if chaos_local_only: + print(" Chaos scenarios local-only:") + for n in chaos_local_only: + print(f" - {n}") + if chaos_github_only: + print(" Chaos scenarios GitHub-only:") + for n in chaos_github_only: + print(f" - {n}") + if chaos_flag_drift: + print(" Chaos scenarios whose flags differ between runners:") + for name, lflags, gflags in chaos_flag_drift: + print(f" - {name}: local '{lflags}' vs GitHub '{gflags}'") + if deb_local_only: + print(" deb-install distros local-only:") + for n in deb_local_only: + print(f" - {n}") + if deb_github_only: + print(" deb-install distros GitHub-only:") + for n in deb_github_only: + print(f" - {n}") + if dispatch_uncovered: + print(" run_suite dispatches these with no backing *_SUITES array, so " + "this guard\n cannot see them in the local set:") + for n in dispatch_uncovered: + print(f" - {n}") + print("\n Resolve by adding the suite to the other runner, by giving a " + "dispatchable\n suite a *_SUITES array, or by adding it to the " + "deliberate local-only\n allowlist in check-ci-parity.sh with a " + "stated reason.") sys.exit(1) -print("CI parity OK: integration suite sets match " +total = len(github) + len(github_chaos) + len(github_deb) +print("CI parity OK: both runners cover the same work " "(allowlist: " + ", ".join(sorted(allowlist)) + ").") -print(f" {len(github)} canonical suites compared on each side.") +print(f" {len(github)} suites, {len(github_chaos)} chaos scenarios " + f"(flags compared), {len(github_deb)} deb-install distros " + f"— {total} legs on each side.") sys.exit(0) PY