Skip to content

Commit 2c31231

Browse files
hyperpolymathhyperpolymath
authored
feat(dispatch): wire hypatia closed-loop contract
Auto-merged via Inbox Steward. Closes C15 estate blocker.
1 parent e61a1a6 commit 2c31231

2 files changed

Lines changed: 233 additions & 0 deletions

File tree

‎scripts/dispatch-runner.sh‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,88 @@ OUTCOME_FILE="${HYPATIA_DATA}/outcomes/$(date -u +%Y-%m).jsonl"
135135
OUTCOME_FILE_CENTRAL="${VERISIMDB_DATA}/outcomes/$(date -u +%Y-%m).jsonl"
136136
mkdir -p "$(dirname "$OUTCOME_FILE")"
137137

138+
# --- Hypatia closed-loop contract ---
139+
#
140+
# Per hypatia/docs/operations/dispatch-runner-contract.adoc, after each
141+
# fix the runner MUST invoke `mix hypatia.record_outcome` so Bayesian
142+
# confidence updating, auto-quarantine, and re-scan verification all see
143+
# real evidence. Without this call, every recipe stays at
144+
# :insufficient_data and the closed-loop verification metric (PR #309)
145+
# never engages. Closes estate-audit blocker C15.
146+
#
147+
# Configuration via env:
148+
# HYPATIA_HOME path to the hypatia checkout (defaults to
149+
# $REPOS_BASE/hypatia)
150+
# HYPATIA_OUTCOME_REPORT set to "off" to disable mix calls (e.g. a
151+
# CI runner without Elixir/mix on PATH);
152+
# defaults to "on"
153+
# HYPATIA_BATCH_ID when set, exit-2 hints suggest
154+
# `mix hypatia.rollback_batch $HYPATIA_BATCH_ID`
155+
#
156+
# Exit codes from the mix task (consumed below):
157+
# 0 outcome recorded; re-scan verified clean OR scan_unavailable
158+
# 2 outcome recorded BUT re-scan still flags the weak point
159+
# 1 bad arguments / unrecoverable error
160+
HYPATIA_HOME="${HYPATIA_HOME:-${REPOS_BASE}/hypatia}"
161+
HYPATIA_OUTCOME_REPORT="${HYPATIA_OUTCOME_REPORT:-on}"
162+
HYPATIA_BATCH_ID="${HYPATIA_BATCH_ID:-}"
163+
164+
hypatia_record_outcome() {
165+
local recipe_id="$1"
166+
local repo="$2"
167+
local file="$3"
168+
local outcome="$4"
169+
170+
# Opt-out short-circuit.
171+
if [[ "$HYPATIA_OUTCOME_REPORT" != "on" ]]; then
172+
return 0
173+
fi
174+
# Precondition: hypatia checkout reachable and mix on PATH.
175+
if [[ ! -d "$HYPATIA_HOME" ]]; then
176+
echo " WARN: hypatia outcome skipped — \$HYPATIA_HOME=$HYPATIA_HOME not a directory" >&2
177+
return 0
178+
fi
179+
if ! command -v mix &>/dev/null; then
180+
echo " WARN: hypatia outcome skipped — mix not on PATH" >&2
181+
return 0
182+
fi
183+
# Empty / placeholder recipe_id → skip silently rather than poison
184+
# hypatia's recipe-health metric with anonymous entries.
185+
if [[ -z "$recipe_id" || "$recipe_id" == "none" || "$recipe_id" == "null" ]]; then
186+
return 0
187+
fi
188+
189+
# Repo-grain fixes pass "." for --file (contract permits any
190+
# path-inside-repo string; "." is the explicit repo-root marker).
191+
local file_arg="${file:-.}"
192+
[[ -z "$file_arg" ]] && file_arg="."
193+
194+
local rc=0
195+
(
196+
cd "$HYPATIA_HOME"
197+
mix hypatia.record_outcome \
198+
--recipe "$recipe_id" \
199+
--repo "$repo" \
200+
--file "$file_arg" \
201+
--outcome "$outcome"
202+
) || rc=$?
203+
204+
case "$rc" in
205+
0)
206+
;;
207+
2)
208+
echo " ::warning::Recipe $recipe_id still flags $repo/$file_arg after fix" >&2
209+
if [[ -n "$HYPATIA_BATCH_ID" ]]; then
210+
echo " ::warning::consider 'mix hypatia.rollback_batch $HYPATIA_BATCH_ID'" >&2
211+
fi
212+
;;
213+
*)
214+
echo " ::error::record_outcome failed for $repo/$file_arg: exit $rc" >&2
215+
;;
216+
esac
217+
return "$rc"
218+
}
219+
138220
record_outcome() {
139221
local pattern_id="$1"
140222
local recipe_id="$2"
@@ -162,6 +244,29 @@ record_outcome() {
162244
if [[ -d "$(dirname "$OUTCOME_FILE_CENTRAL")" ]] || mkdir -p "$(dirname "$OUTCOME_FILE_CENTRAL")" 2>/dev/null; then
163245
echo "$json" >> "$OUTCOME_FILE_CENTRAL"
164246
fi
247+
248+
# Hypatia closed-loop contract — best-effort, never fails the dispatch
249+
# loop. Map shell outcomes to the contract's outcome vocabulary:
250+
# success/failure → pass through
251+
# refused_* → false_positive (the recipe is misfiring, not
252+
# the code; surfaces this to auto-quarantine)
253+
# anything else → skip (don't poison the metric).
254+
local hypatia_outcome
255+
case "$outcome" in
256+
success)
257+
hypatia_outcome="success"
258+
;;
259+
failure)
260+
hypatia_outcome="failure"
261+
;;
262+
refused_license_policy|refused_*)
263+
hypatia_outcome="false_positive"
264+
;;
265+
*)
266+
return 0
267+
;;
268+
esac
269+
hypatia_record_outcome "$recipe_id" "$repo" "$file" "$hypatia_outcome" || true
165270
}
166271

167272
# --- Execute a single manifest entry ---

‎tests/hypatia-record-outcome-smoke.sh‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
#!/usr/bin/env bash
2+
# SPDX-License-Identifier: MPL-2.0
3+
#
4+
# Smoke test for hypatia_record_outcome() in scripts/dispatch-runner.sh.
5+
#
6+
# Covers the no-op short-circuit paths that don't require an actual
7+
# hypatia checkout or `mix` on PATH:
8+
# 1. HYPATIA_OUTCOME_REPORT=off → silent no-op, exit 0.
9+
# 2. HYPATIA_HOME not a directory → warn to stderr, exit 0.
10+
# 3. Empty / "none" / "null" recipe_id → silent no-op, exit 0.
11+
#
12+
# End-to-end paths that *do* talk to hypatia (exit 0/2/1) require a
13+
# running mix env and are covered by the integration suite on the
14+
# hypatia side. This file just guarantees the dispatch loop never
15+
# crashes on the optional-call ladder.
16+
17+
set -euo pipefail
18+
19+
SCRIPT_DIR=$(dirname "$(realpath "$0")")
20+
DISPATCH_RUNNER="${SCRIPT_DIR}/../scripts/dispatch-runner.sh"
21+
22+
if [[ ! -f "$DISPATCH_RUNNER" ]]; then
23+
echo "FAIL: dispatch-runner.sh not found at $DISPATCH_RUNNER"
24+
exit 1
25+
fi
26+
27+
# We source the script in a guarded mode so we get function definitions
28+
# without triggering the main loop. The script exits early when its
29+
# manifest doesn't exist, so we point it at a non-existent path and
30+
# capture the early exit.
31+
TMP=$(mktemp -d /tmp/c15-smoke-XXXXXX)
32+
trap 'rm -rf "$TMP"' EXIT
33+
34+
# Extract just the function definitions we need (between # --- Hypatia
35+
# closed-loop contract --- and the next "# --- " section). Cheap and
36+
# avoids running the main loop.
37+
awk '
38+
/^# --- Hypatia closed-loop contract ---/ { capture=1 }
39+
capture { print }
40+
/^record_outcome\(\)/ && capture { record_seen=1 }
41+
record_seen && /^}/ { print "# end-extract"; exit }
42+
' "$DISPATCH_RUNNER" > "$TMP/extracted.sh"
43+
44+
# Provide a stub REPOS_BASE so HYPATIA_HOME default resolves to
45+
# something the test can control.
46+
export REPOS_BASE="$TMP/repos"
47+
48+
# Source the extracted block into this shell.
49+
# shellcheck disable=SC1091
50+
source "$TMP/extracted.sh"
51+
52+
pass=0
53+
fail=0
54+
55+
assert_silent_ok() {
56+
local label="$1"
57+
shift
58+
local out
59+
if out=$("$@" 2>&1); then
60+
if [[ -z "$out" ]]; then
61+
pass=$((pass + 1))
62+
echo "PASS: $label"
63+
else
64+
fail=$((fail + 1))
65+
echo "FAIL: $label — expected silent, got: $out"
66+
fi
67+
else
68+
fail=$((fail + 1))
69+
echo "FAIL: $label — expected exit 0, got non-zero"
70+
fi
71+
}
72+
73+
assert_warn_ok() {
74+
local label="$1"
75+
local expect="$2"
76+
shift 2
77+
local out
78+
if out=$("$@" 2>&1); then
79+
if [[ "$out" == *"$expect"* ]]; then
80+
pass=$((pass + 1))
81+
echo "PASS: $label"
82+
else
83+
fail=$((fail + 1))
84+
echo "FAIL: $label — expected warning containing '$expect', got: $out"
85+
fi
86+
else
87+
fail=$((fail + 1))
88+
echo "FAIL: $label — expected exit 0, got non-zero"
89+
fi
90+
}
91+
92+
# Case 1: opt-out.
93+
HYPATIA_OUTCOME_REPORT=off \
94+
assert_silent_ok "opt-out silently no-ops" \
95+
hypatia_record_outcome "rid-1" "owner/repo" "src/file.py" "success"
96+
97+
# Case 2: HYPATIA_HOME not a directory.
98+
HYPATIA_OUTCOME_REPORT=on \
99+
HYPATIA_HOME="$TMP/does-not-exist" \
100+
assert_warn_ok "missing HYPATIA_HOME warns and no-ops" \
101+
"not a directory" \
102+
hypatia_record_outcome "rid-2" "owner/repo" "src/file.py" "success"
103+
104+
# Cases 3a-c need HYPATIA_HOME to exist so the recipe-id guard fires
105+
# rather than the missing-dir guard.
106+
mkdir -p "$TMP/repos/hypatia"
107+
108+
# Case 3a: empty recipe_id.
109+
HYPATIA_OUTCOME_REPORT=on \
110+
HYPATIA_HOME="$TMP/repos/hypatia" \
111+
assert_silent_ok "empty recipe_id silently no-ops" \
112+
hypatia_record_outcome "" "owner/repo" "src/file.py" "success"
113+
114+
# Case 3b: "none" recipe_id.
115+
HYPATIA_OUTCOME_REPORT=on \
116+
HYPATIA_HOME="$TMP/repos/hypatia" \
117+
assert_silent_ok "'none' recipe_id silently no-ops" \
118+
hypatia_record_outcome "none" "owner/repo" "src/file.py" "success"
119+
120+
# Case 3c: "null" recipe_id.
121+
HYPATIA_OUTCOME_REPORT=on \
122+
HYPATIA_HOME="$TMP/repos/hypatia" \
123+
assert_silent_ok "'null' recipe_id silently no-ops" \
124+
hypatia_record_outcome "null" "owner/repo" "src/file.py" "success"
125+
126+
echo ""
127+
echo "Results: $pass passed, $fail failed"
128+
[[ "$fail" -eq 0 ]]

0 commit comments

Comments
 (0)