From b3a41e577e2e4bbbd7ce2b3d1d95214f416ade1b Mon Sep 17 00:00:00 2001 From: Caleb <46907094+rotationalphysics495@users.noreply.github.com> Date: Wed, 3 Jun 2026 08:04:57 -0500 Subject: [PATCH] feat(epic-execute): contract harness preflight + dry-run readiness gate MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Let a project declare a contract-validation harness (contract-harness.yaml) describing how to bring up a sample/test environment and verify API + database contracts. The system validates readiness itself - the user never hand-checks. - contract-harness.sh: discover the harness, auto-derive prerequisites from its own commands (env var refs, executables, file paths) plus an optional requires: block, then run a presence preflight with a ✓/✗ readiness report - Startup wiring: real runs fail fast (abort before story 1 if prerequisites are missing); dry runs print the report and exit non-zero when anything required is missing, so --dry-run works as a CI readiness gate - Opt-in deep connectivity smoke (--preflight-deep) boots the sample env, polls the readiness URL, and tears down - Safety guard: warns when the datastore target looks production-scoped (contract validation must only ever touch a throwaway/test store) - --init-harness scaffolds a commented template; --skip-contract-validation bypasses the gate; full --help/usage documentation Opt-in by presence of the harness file - projects without one are unaffected. Parses/validates harness `cases`; executing them per-story is the next increment. Co-Authored-By: Claude Opus 4.8 (1M context) --- scripts/epic-execute-lib/contract-harness.sh | 380 +++++++++++++++++++ scripts/epic-execute.sh | 70 ++++ 2 files changed, 450 insertions(+) create mode 100644 scripts/epic-execute-lib/contract-harness.sh diff --git a/scripts/epic-execute-lib/contract-harness.sh b/scripts/epic-execute-lib/contract-harness.sh new file mode 100644 index 000000000..79e4ecfa0 --- /dev/null +++ b/scripts/epic-execute-lib/contract-harness.sh @@ -0,0 +1,380 @@ +#!/bin/bash +# +# BMAD Epic Execute - Contract Harness Preflight Module +# +# A project may declare a contract-validation harness (contract-harness.yaml) +# that describes how to bring up a SAMPLE/TEST environment and verify that the +# API and database contracts hold (the proper API is called and data lands in +# the right place). +# +# This module does NOT execute the per-story contract checks. It validates at +# STARTUP that the system has everything it needs to run them - credentials, +# commands, and files - so a misconfigured harness fails fast (or, in a dry +# run, produces an exit-code-honest readiness report) instead of blowing up +# mid-epic. +# +# The user never hand-maintains a checklist: prerequisites are inferred from the +# harness commands themselves (env var references, executables, file paths), +# with an optional `requires:` block for anything inference cannot see. +# +# Usage: sourced by epic-execute.sh +# + +# Set true by contract_preflight when a required prerequisite is missing. +# epic-execute uses this to fail the run / dry-run exit code. +PREFLIGHT_FAILED=false + +# ============================================================================= +# Harness Discovery +# ============================================================================= + +# Locate the harness file (project root, then docs/). Echoes the path or "". +find_contract_harness() { + local candidate + for candidate in \ + "$PROJECT_ROOT/contract-harness.yaml" \ + "$PROJECT_ROOT/contract-harness.yml" \ + "$PROJECT_ROOT/docs/contract-harness.yaml" \ + "$PROJECT_ROOT/docs/contract-harness.yml"; do + if [ -f "$candidate" ]; then + echo "$candidate" + return 0 + fi + done + echo "" + return 0 +} + +# ============================================================================= +# Prerequisite Inference +# ============================================================================= + +# Emit every command string declared in the harness (setup, start, teardown, +# and the datastore verify command), one per line. +_harness_commands() { + local h="$1" + yq '(.environment.setup // [])[]' "$h" 2>/dev/null + yq '.environment.start.command // ""' "$h" 2>/dev/null + yq '(.environment.teardown // [])[]' "$h" 2>/dev/null + yq '.datastore.verify_command // ""' "$h" 2>/dev/null +} + +# Derive required environment variables: references inside command strings +# ($VAR / ${VAR}), the datastore url_env value (itself a var name), and any +# explicit requires.env entries. +_derive_env_vars() { + local h="$1" + { + _harness_commands "$h" | grep -oE '\$\{?[A-Za-z_][A-Za-z0-9_]*\}?' | tr -d '${}' + yq '.datastore.url_env // ""' "$h" 2>/dev/null + yq '(.requires.env // [])[]' "$h" 2>/dev/null + } | sed '/^$/d' | sort -u +} + +# Derive required executables: the first non-assignment token of each command, +# plus any explicit requires.commands entries. +_derive_commands() { + local h="$1" + { + _harness_commands "$h" | while IFS= read -r cmd; do + [ -z "$cmd" ] && continue + # shellcheck disable=SC2086 + set -- $cmd + while [ $# -gt 0 ]; do + case "$1" in + *=*) shift ;; # skip leading VAR=value assignments + *) echo "$1"; break ;; + esac + done + done + yq '(.requires.commands // [])[]' "$h" 2>/dev/null + } | sed '/^$/d' | sort -u +} + +# Derive referenced files: path-like tokens in command strings (best effort), +# plus any explicit requires.files entries. +_derive_files() { + local h="$1" + { + _harness_commands "$h" | tr ' ' '\n' | grep -E '/|\.(ya?ml|json|toml|sh|env)$' 2>/dev/null + yq '(.requires.files // [])[]' "$h" 2>/dev/null + } | sed '/^$/d' | sort -u +} + +# ============================================================================= +# Safety Guard +# ============================================================================= + +# Warn if the declared datastore connection looks like a real/production target. +# Contract validation writes data, so it must point at a throwaway/test store. +_check_datastore_safety() { + local h="$1" + local url_env + url_env=$(yq '.datastore.url_env // ""' "$h" 2>/dev/null) + [ -z "$url_env" ] && return 0 + + case "$url_env" in + DATABASE_URL|*PROD*|*PRODUCTION*) + log_warn " ! datastore.url_env='$url_env' looks production-scoped - use a TEST-only variable" ;; + esac + + local val="${!url_env:-}" + if [ -n "$val" ]; then + case "$val" in + *localhost*|*127.0.0.1*|*test*) : ;; + *) log_warn " ! $url_env does not look local/test-scoped - contract validation must never run against a real database" ;; + esac + fi + return 0 +} + +# ============================================================================= +# Preflight (presence checks + readiness report) +# ============================================================================= + +# Validate that everything needed to run the harness is present. +# Arguments: +# $1 - path to the harness file +# Returns: 0 if ready, 1 if a required prerequisite is missing. +contract_preflight() { + local h="$1" + [ -z "$h" ] && return 0 + + log "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + log "Contract Harness Preflight" + log "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + log "Harness: $h" + + local check="✓" cross="✗" + local missing=0 + + # yq is required to parse the harness + if ! command -v yq >/dev/null 2>&1; then + log_error " $cross yq is required to parse the contract harness (install yq)" + PREFLIGHT_FAILED=true + return 1 + fi + + # Basic schema sanity (advisory) + local start_cmd + start_cmd=$(yq '.environment.start.command // ""' "$h" 2>/dev/null) + [ -z "$start_cmd" ] && log_warn " ! harness declares no environment.start.command" + + # 1. Credentials / environment variables + local envs + envs=$(_derive_env_vars "$h") + if [ -n "$envs" ]; then + log "Credentials / environment variables:" + while IFS= read -r v; do + [ -z "$v" ] && continue + if [ -n "${!v:-}" ]; then + echo " $check $v" + else + echo " $cross $v (not set)" + missing=$((missing + 1)) + fi + done <<< "$envs" + fi + + # 2. Required executables + local cmds + cmds=$(_derive_commands "$h") + if [ -n "$cmds" ]; then + log "Required commands:" + while IFS= read -r c; do + [ -z "$c" ] && continue + if command -v "$c" >/dev/null 2>&1; then + echo " $check $c" + else + echo " $cross $c (not on PATH)" + missing=$((missing + 1)) + fi + done <<< "$cmds" + fi + + # 3. Referenced files + local files + files=$(_derive_files "$h") + if [ -n "$files" ]; then + log "Referenced files:" + while IFS= read -r f; do + [ -z "$f" ] && continue + local path="$f" + case "$f" in /*) path="$f" ;; *) path="$PROJECT_ROOT/$f" ;; esac + if [ -e "$path" ]; then + echo " $check $f" + else + echo " $cross $f (not found)" + missing=$((missing + 1)) + fi + done <<< "$files" + fi + + # 4. Safety guard on datastore connection + _check_datastore_safety "$h" + + # 5. Optional deep connectivity smoke (boots the sample environment) + if [ "${PREFLIGHT_DEEP:-false}" = true ]; then + if [ "$missing" -gt 0 ]; then + log_warn "Skipping deep connectivity smoke - presence checks failed first" + elif ! contract_preflight_deep "$h"; then + missing=$((missing + 1)) + fi + fi + + if [ "$missing" -gt 0 ]; then + log_error "Contract preflight: $missing required prerequisite(s) missing" + PREFLIGHT_FAILED=true + return 1 + fi + + log_success "Contract preflight passed - ready to validate contracts" + return 0 +} + +# ============================================================================= +# Deep Connectivity Smoke (opt-in: --preflight-deep) +# ============================================================================= + +# Run teardown commands (best effort, always safe to call). +_harness_teardown() { + local h="$1" + while IFS= read -r cmd; do + [ -z "$cmd" ] && continue + log " teardown: $cmd" + ( cd "$PROJECT_ROOT" && eval "$cmd" ) >>"$LOG_FILE" 2>&1 || true + done < <(yq '(.environment.teardown // [])[]' "$h" 2>/dev/null) +} + +# Actually bring the sample environment up, check readiness, then tear it down. +# Executes the project's own commands (same trust level as package.json scripts). +# Arguments: +# $1 - path to the harness file +# Returns: 0 on success, 1 on any failure. +contract_preflight_deep() { + local h="$1" + log "Deep connectivity smoke (booting the sample environment)..." + + # Run setup commands + local rc=0 cmd + while IFS= read -r cmd; do + [ -z "$cmd" ] && continue + log " setup: $cmd" + if ! ( cd "$PROJECT_ROOT" && eval "$cmd" ) >>"$LOG_FILE" 2>&1; then + log_error " setup failed: $cmd" + rc=1 + break + fi + done < <(yq '(.environment.setup // [])[]' "$h" 2>/dev/null) + + if [ "$rc" -ne 0 ]; then + _harness_teardown "$h" + return 1 + fi + + # Start the app in the background (if a start command is declared) + local start_cmd start_pid="" + start_cmd=$(yq '.environment.start.command // ""' "$h" 2>/dev/null) + if [ -n "$start_cmd" ]; then + log " start: $start_cmd" + ( cd "$PROJECT_ROOT" && eval "$start_cmd" ) >>"$LOG_FILE" 2>&1 & + start_pid=$! + fi + + # Poll the readiness URL (if declared) + local ready_url timeout ok=1 + ready_url=$(yq '.environment.start.ready.url // ""' "$h" 2>/dev/null) + timeout=$(yq '.environment.start.ready.timeout_seconds // 30' "$h" 2>/dev/null) + if [ -n "$ready_url" ]; then + ok=0 + local waited=0 + while [ "$waited" -lt "$timeout" ]; do + if curl -sf -o /dev/null "$ready_url" 2>/dev/null; then + ok=1 + break + fi + sleep 2 + waited=$((waited + 2)) + done + if [ "$ok" -eq 1 ]; then + log_success " ready: $ready_url" + else + log_error " not ready after ${timeout}s: $ready_url" + fi + fi + + # Stop the app and tear down + [ -n "$start_pid" ] && kill "$start_pid" 2>/dev/null || true + _harness_teardown "$h" + + [ "$ok" -eq 1 ] && return 0 || return 1 +} + +# ============================================================================= +# Scaffolder (--init-harness) +# ============================================================================= + +# Write a commented contract-harness.yaml template to the project root. +init_contract_harness() { + local target="$PROJECT_ROOT/contract-harness.yaml" + if [ -e "$target" ]; then + log_warn "Harness already exists: $target (not overwriting)" + return 0 + fi + + cat > "$target" <<'YAML' +# Contract validation harness for epic-execute. +# +# Declares how to bring up a SAMPLE/TEST environment and verify that the API and +# database contracts hold. epic-execute validates at startup that it has +# everything needed to run this - run `epic-execute --dry-run` to get an +# exit-code-honest readiness report (great as a CI gate). +version: 1 + +environment: + # Commands to provision the sample environment (DB, migrations, seed data). + setup: + - docker compose -f docker-compose.test.yml up -d db + # - npm run migrate:test + # - npm run seed:test + # How to start the app under test. + start: + command: npm run start:test + ready: + url: http://localhost:3000/health + timeout_seconds: 60 + # Always run to clean up. + teardown: + - docker compose -f docker-compose.test.yml down -v + +api: + base_url: http://localhost:3000 + +# How to verify data landed "in the right place". Prefer a command (no DB +# credentials needed); the system passes the table/where as arguments. +datastore: + verify_command: "npm run db:assert --" + # OR direct query via a TEST-scoped env var (never a real DATABASE_URL): + # url_env: TEST_DATABASE_URL + +# Optional explicit prerequisites. The system also INFERS these from the +# commands above (env var references, executables, and file paths), so you only +# need to list things inference cannot see (e.g. an API token used at call time). +requires: + env: [] + commands: [] + files: [] + +# Contract cases: call the API and assert the response + persistence. +# (Validated by preflight now; executed by the per-story contract gate.) +cases: + - name: "example: create persists a row" + request: { method: POST, path: /api/example, body: { name: "x" } } + expect: { status: 201, body_contains: { name: "x" } } + verify_persistence: { table: example, where: { name: "x" }, exists: true } +YAML + + log_success "Created harness template: $target" + log "Edit it, then run a dry run to validate readiness." + return 0 +} diff --git a/scripts/epic-execute.sh b/scripts/epic-execute.sh index 892db3cca..7ebc0076a 100755 --- a/scripts/epic-execute.sh +++ b/scripts/epic-execute.sh @@ -132,6 +132,7 @@ LIB_DIR="$SCRIPT_DIR/epic-execute-lib" [ -f "$LIB_DIR/design-phase.sh" ] && source "$LIB_DIR/design-phase.sh" [ -f "$LIB_DIR/json-output.sh" ] && source "$LIB_DIR/json-output.sh" [ -f "$LIB_DIR/tdd-flow.sh" ] && source "$LIB_DIR/tdd-flow.sh" +[ -f "$LIB_DIR/contract-harness.sh" ] && source "$LIB_DIR/contract-harness.sh" STORIES_DIR="$PROJECT_ROOT/docs/stories" SPRINT_ARTIFACTS_DIR="$PROJECT_ROOT/docs/sprint-artifacts" @@ -941,6 +942,11 @@ OPTIONS: --skip-test-spec Skip test specification phase only --skip-test-impl Skip test implementation phase only + Contract Validation: + --init-harness Scaffold a contract-harness.yaml template and exit + --preflight-deep Also run a connectivity smoke (boots the sample env) + --skip-contract-validation Skip the contract harness preflight + Commit Control: --no-commit Stage changes but don't commit --skip-done Skip stories with Status: Done @@ -983,6 +989,16 @@ FILES: Logs: docs/sprint-artifacts/logs/epic--.log Metrics: docs/sprint-artifacts/metrics/epic--metrics.yaml Checkpoint: docs/sprint-artifacts/.epic--checkpoint + Harness: contract-harness.yaml (project root or docs/) - optional + +CONTRACT VALIDATION: + If a contract-harness.yaml is present, startup runs a preflight that checks + every credential, command, and file the harness needs (inferred from the + harness itself). A dry run prints a readiness report and exits non-zero when + anything required is missing, so it works as a CI readiness gate: + ./epic-execute.sh --dry-run # presence checks only + ./epic-execute.sh --dry-run --preflight-deep # + connectivity smoke + ./epic-execute.sh --init-harness # scaffold a starter harness For more information, see: docs/bmad_improvements_v2_fixes.md EOF @@ -1009,6 +1025,9 @@ SKIP_STATIC_ANALYSIS=false SKIP_DESIGN=false SKIP_DESIGN_CRITIC=false SKIP_REGRESSION=false +SKIP_CONTRACT_VALIDATION=false +PREFLIGHT_DEEP=false +INIT_HARNESS=false SKIP_TDD=false SKIP_TEST_SPEC=false SKIP_TEST_IMPL=false @@ -1084,6 +1103,18 @@ while [[ $# -gt 0 ]]; do SKIP_REGRESSION=true shift ;; + --skip-contract-validation) + SKIP_CONTRACT_VALIDATION=true + shift + ;; + --preflight-deep) + PREFLIGHT_DEEP=true + shift + ;; + --init-harness) + INIT_HARNESS=true + shift + ;; --skip-tdd) SKIP_TDD=true shift @@ -1111,6 +1142,17 @@ while [[ $# -gt 0 ]]; do esac done +# --init-harness: scaffold a contract-harness.yaml template and exit (no epic needed) +if [ "$INIT_HARNESS" = true ]; then + if type init_contract_harness >/dev/null 2>&1; then + init_contract_harness + exit $? + else + echo "Contract harness module not available (scripts/epic-execute-lib/contract-harness.sh)" + exit 1 + fi +fi + if [ -z "$EPIC_ID" ]; then echo "Usage: $0 [options]" echo "" @@ -1210,6 +1252,26 @@ if [ "$NO_COMMIT" != true ] && type check_branch_protection >/dev/null 2>&1; the fi fi +# Contract harness preflight - validate readiness to run contract validation. +# Opt-in by presence of a contract-harness.yaml. In a real run this is a +# fail-fast gate (abort before story 1 if prerequisites are missing). In a dry +# run it reports readiness and makes the run exit non-zero (a CI readiness gate). +if [ "$SKIP_CONTRACT_VALIDATION" != true ] && type contract_preflight >/dev/null 2>&1; then + CONTRACT_HARNESS_FILE=$(find_contract_harness) + if [ -n "$CONTRACT_HARNESS_FILE" ]; then + if ! contract_preflight "$CONTRACT_HARNESS_FILE"; then + if [ "$DRY_RUN" = true ]; then + log_warn "Preflight found missing prerequisites - dry run will exit non-zero" + else + log_error "Contract harness preflight failed - aborting before execution" + exit 1 + fi + fi + elif [ "$VERBOSE" = true ]; then + log "No contract-harness.yaml found - contract validation not configured" + fi +fi + # Ensure directories exist mkdir -p "$UAT_DIR" mkdir -p "$SPRINTS_DIR" @@ -3216,6 +3278,14 @@ echo " - Metrics: $METRICS_FILE" echo " - Log: $LOGS_DIR/epic-${EPIC_ID}-.log (saved on exit)" echo "" +# Contract preflight is an exit-code-honest gate: if a declared harness was +# missing prerequisites, fail the run (this is what makes --dry-run usable as a +# CI readiness check). +if [ "${PREFLIGHT_FAILED:-false}" = true ]; then + log_warn "Contract preflight reported missing prerequisites - see the readiness report above" + exit 1 +fi + if [ $FAILED -gt 0 ]; then log_warn "$FAILED stories failed - check log for details" log "Checkpoint preserved for resume capability"