75c227429a
The reusable deploy workflow invokes run_platform.sh from the CONSUMER
repo's workspace root with a relative contract path (e.g.
.acdl/contract.yaml). run_platform.sh does `cd "$ROOT"` (the platform
repo) early in its lifecycle, which caused the relative contract path to
resolve against the platform repo (acdl-platform/) instead of the
consumer repo — the `[ -f "$CONTRACT" ]` check then failed with
"contract file missing" and the pipeline could never run.
Fix: capture CALLER_CWD before `cd "$ROOT"` and resolve a caller-supplied
relative contract path against CALLER_CWD. The default contract
(contracts/static-asset.yaml, used only when no contract is supplied)
remains relative to ROOT, preserving platform-local CI behavior.
Reproduced pre-fix: bash acdl-platform/scripts/run_platform.sh --check-only
.acdl/contract.yaml (from a consumer workspace) -> "contract file missing".
Verified post-fix: same invocation reads the consumer contract correctly.
verify(P0): code review — correctness
---ci---
phase: 20
milestone: v1.5
status: verify
lessons:
- P0 fix applied: run_platform.sh now resolves relative contract path
against caller CWD (deploy workflow contract path was broken)
---/ci---
256 lines
9.7 KiB
Bash
Executable File
256 lines
9.7 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# scripts/run_platform.sh - the ACDL platform pipeline.
|
|
#
|
|
# Usage:
|
|
# run_platform.sh <contract.yaml> (full e2e with AWS)
|
|
# run_platform.sh --check-only [contract.yaml] (offline, no AWS/Checkov/DynamoDB)
|
|
# run_platform.sh --plan-only <contract.yaml> (AWS plan only, no Checkov/outbox)
|
|
#
|
|
# Modes:
|
|
# --check-only (offline, no AWS/Checkov/DynamoDB — for CI)
|
|
# contract -> resolver -> stack -> adapter -> stream TF -> validate -> exit 0
|
|
# --plan-only (requires AWS creds, no Checkov/outbox)
|
|
# contract -> resolver -> stack -> adapter -> terraform init/validate/plan -> exit 0
|
|
# (default) (requires AWS creds + Checkov + DynamoDB)
|
|
# contract -> resolver -> stack -> adapter -> terraform plan -> Checkov ->
|
|
# confidence -> outbox
|
|
#
|
|
# Flags:
|
|
# --quiet suppress terraform/checkov streaming (output to log only)
|
|
#
|
|
# The contract file is a YAML file validated against schemas/contract.schema.json.
|
|
# The resolver (acdl_platform/contract_resolver.py) resolves it to a Target Stack
|
|
# instance, which the adapter (adapters/terraform/adapter.py) compiles to Terraform.
|
|
#
|
|
# Uses the rotated spike key (D-039/D-047) from gitignored .env.secrets.
|
|
# Plan-only (no apply); -lock=false per D-P09-1.
|
|
set -euo pipefail
|
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
|
|
|
# Capture the caller's CWD before we cd to ROOT. The reusable deploy workflow
|
|
# invokes this script from the CONSUMER repo's workspace root with a relative
|
|
# contract path (e.g. .acdl/contract.yaml); the contract must resolve against
|
|
# the consumer repo, not the platform repo (acdl-platform/). Without this, the
|
|
# `[ -f "$CONTRACT" ]` check below looks for the contract inside the platform
|
|
# repo and fails (P0 fix — see docs/CONSUMER_GUIDE.md Step 4).
|
|
CALLER_CWD="$(pwd)"
|
|
cd "$ROOT"
|
|
|
|
CHECK_ONLY=0
|
|
PLAN_ONLY=0
|
|
QUIET=0
|
|
CONTRACT=""
|
|
|
|
for arg in "$@"; do
|
|
case "$arg" in
|
|
--check-only) CHECK_ONLY=1 ;;
|
|
--plan-only) PLAN_ONLY=1 ;;
|
|
--quiet) QUIET=1 ;;
|
|
--*) echo "FAIL: unknown flag: $arg" >&2; exit 1 ;;
|
|
*) CONTRACT="$arg" ;;
|
|
esac
|
|
done
|
|
|
|
# Resolve a caller-supplied contract path to an absolute path against the
|
|
# caller's CWD (captured before `cd "$ROOT"`). The default contract below is
|
|
# intentionally left relative to ROOT (it is set only when no contract was
|
|
# supplied and resolves against ROOT, which is correct for platform-local CI).
|
|
if [ -n "$CONTRACT" ]; then
|
|
case "$CONTRACT" in
|
|
/*) ;;
|
|
*) CONTRACT="$CALLER_CWD/$CONTRACT" ;;
|
|
esac
|
|
fi
|
|
|
|
# Default contract for --check-only (CI uses this)
|
|
if [ -z "$CONTRACT" ]; then
|
|
if [ "$CHECK_ONLY" = "1" ]; then
|
|
CONTRACT="contracts/static-asset.yaml"
|
|
else
|
|
echo "FAIL: contract file required (usage: run_platform.sh <contract.yaml>)" >&2
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
fail() { echo "FAIL: $*" >&2; exit 1; }
|
|
|
|
# stream: pipe a command's stdout+stderr to both a log file and the
|
|
# terminal (unless --quiet). Usage: stream <logfile> -- <command...>
|
|
stream() {
|
|
local log="$1"; shift
|
|
if [ "$QUIET" = "1" ]; then
|
|
"$@" > "$log" 2>&1
|
|
else
|
|
"$@" 2>&1 | tee "$log"
|
|
fi
|
|
}
|
|
|
|
CONTRACT_ID="11111111-1111-1111-1111-111111111111" # spike fixed UUID
|
|
WORK="/tmp/acdl_platform"
|
|
rm -rf "$WORK"; mkdir -p "$WORK"
|
|
|
|
echo "=== Step 1: validate contract against contract.schema.json ==="
|
|
[ -f "$CONTRACT" ] || fail "contract file $CONTRACT missing"
|
|
python3 -c "
|
|
import json, yaml, jsonschema
|
|
schema = json.load(open('schemas/contract.schema.json'))
|
|
contract = yaml.safe_load(open('$CONTRACT'))
|
|
jsonschema.validate(contract, schema)
|
|
print(f'contract: module={contract[\"module\"]} env={contract[\"environment\"]} inputs={list(contract.get(\"inputs\",{}).keys())}')
|
|
"
|
|
|
|
echo ""
|
|
echo "=== Step 2: resolve contract -> Target Stack instance ==="
|
|
python3 acdl_platform/contract_resolver.py "$CONTRACT" "$WORK/stack.json" || fail "resolver failed"
|
|
python3 -c "import json; d=json.load(open('$WORK/stack.json')); print(f'stack: {d[\"stack\"][\"name\"]} {d[\"stack\"][\"kind\"]} {len(d[\"resources\"])} resource(s)')"
|
|
|
|
echo ""
|
|
echo "=== Step 3: adapter compiles stack -> terraform/spike/*.tf ==="
|
|
python3 adapters/terraform/adapter.py "$WORK/stack.json" terraform/spike || fail "adapter failed"
|
|
echo "adapter: emitted terraform/spike/{main.tf,terraform.tf,providers.tf}"
|
|
|
|
if [ "$QUIET" = "0" ]; then
|
|
echo ""
|
|
echo "--- emitted terraform/spike/main.tf ---"
|
|
cat terraform/spike/main.tf
|
|
echo "--- end main.tf ---"
|
|
fi
|
|
|
|
if [ "$CHECK_ONLY" = "1" ]; then
|
|
echo ""
|
|
echo "=== Step 3b: validate adapter output structure (offline) ==="
|
|
python3 -c "
|
|
import json, os
|
|
d = json.load(open('$WORK/stack.json'))
|
|
assert d['stack']['name'] == 'static-asset', f\"expected static-asset, got {d['stack']['name']}\"
|
|
assert len(d['resources']) >= 1
|
|
tf_dir = 'terraform/spike'
|
|
for f in ('main.tf', 'terraform.tf', 'providers.tf'):
|
|
assert os.path.isfile(os.path.join(tf_dir, f)), f'{f} missing'
|
|
main = open(os.path.join(tf_dir, 'main.tf')).read()
|
|
assert 'aws_s3_bucket' in main
|
|
assert 'acdl-spike-bucket' in main
|
|
assert 'versioning' in main
|
|
tf = open(os.path.join(tf_dir, 'terraform.tf')).read()
|
|
assert 'backend' in tf
|
|
assert 'required_version' in tf
|
|
prov = open(os.path.join(tf_dir, 'providers.tf')).read()
|
|
assert 'provider \"aws\"' in prov
|
|
print('adapter output: OK')
|
|
"
|
|
echo ""
|
|
echo "=== PLATFORM CHECK OK ==="
|
|
echo "contract -> resolver -> stack -> adapter -> structure validated (offline, no AWS)"
|
|
exit 0
|
|
fi
|
|
|
|
echo "=== Loading AWS credentials (not needed for --check-only) ==="
|
|
ENV_FILE="$ROOT/.env.secrets"
|
|
[ -f "$ENV_FILE" ] || fail ".env.secrets missing (run scripts/rotate_spike_key.sh)"
|
|
set -a
|
|
. "$ENV_FILE"
|
|
set +a
|
|
export AWS_ACCESS_KEY_ID="$ACDL_AWS_ACCESS_KEY_ID"
|
|
export AWS_SECRET_ACCESS_KEY="$ACDL_AWS_SECRET_ACCESS_KEY"
|
|
export AWS_DEFAULT_REGION="$AWS_DEFAULT_REGION"
|
|
|
|
echo "=== Step 4: terraform init + validate + plan -lock=false (real AWS) ==="
|
|
cd terraform/spike
|
|
|
|
echo ""
|
|
echo "--- terraform init ---"
|
|
stream "$WORK/tf-init.log" terraform init -reconfigure -lock=false -input=false || fail "terraform init failed"
|
|
|
|
echo ""
|
|
echo "--- terraform validate ---"
|
|
stream "$WORK/tf-validate.log" terraform validate || fail "terraform validate failed"
|
|
|
|
echo ""
|
|
echo "--- terraform plan ---"
|
|
stream "$WORK/tf-plan.log" terraform plan -lock=false -input=false -out=tfplan || fail "terraform plan failed"
|
|
|
|
echo ""
|
|
echo "terraform plan OK (1 to add, 0 to change, 0 to destroy expected)"
|
|
cd "$ROOT"
|
|
|
|
if [ "$PLAN_ONLY" = "1" ]; then
|
|
echo ""
|
|
echo "=== PLATFORM PLAN OK ==="
|
|
exit 0
|
|
fi
|
|
|
|
echo ""
|
|
echo "=== Step 5: run Checkov on terraform/spike/main.tf ==="
|
|
if [ "$QUIET" = "0" ]; then
|
|
checkov -f terraform/spike/main.tf --framework terraform -o json --soft-fail 2>&1 | tee "$WORK/checkov.json"
|
|
else
|
|
checkov -f terraform/spike/main.tf --framework terraform -o json --soft-fail > "$WORK/checkov.json" 2> "$WORK/checkov.err"
|
|
fi
|
|
[ -s "$WORK/checkov.json" ] || fail "checkov produced no output"
|
|
echo ""
|
|
echo "checkov summary: $(python3 -c "import json; d=json.load(open('$WORK/checkov.json')); print(len(d.get('results',{}).get('failed_checks',[])), 'failed,', len(d.get('results',{}).get('passed_checks',[])), 'passed')")"
|
|
|
|
echo ""
|
|
echo "=== Step 6: Checkov adapter -> PolicyCheckResult (compliance details) ==="
|
|
python3 adapters/terraform/policy/checkov_adapter.py "$WORK/checkov.json" "$CONTRACT_ID" > "$WORK/pcr.json" || fail "checkov adapter failed"
|
|
python3 -c "
|
|
import json
|
|
pcrs = json.load(open('$WORK/pcr.json'))
|
|
print(f'PolicyCheckResult: {len(pcrs)} record(s)')
|
|
print()
|
|
for pcr in pcrs:
|
|
sev = pcr.get('severity', 'info')
|
|
res = pcr.get('result', 'unknown')
|
|
rule = pcr.get('ruleId', 'unknown')
|
|
msg = pcr.get('message', '')
|
|
marker = 'PASS' if res == 'pass' else 'FAIL' if res == 'fail' else 'SKIP' if res == 'skipped' else res.upper()
|
|
print(f' [{marker}] {sev:8s} {rule:30s} {msg}')
|
|
"
|
|
|
|
echo ""
|
|
echo "=== Step 7: confidence signal compute ==="
|
|
python3 <<PY > "$WORK/signal.json" || fail "confidence signal failed"
|
|
import json
|
|
import acdl_platform.confidence_signal as c
|
|
pcr = json.load(open("$WORK/pcr.json"))
|
|
inputs = {
|
|
"policy": pcr,
|
|
"validation": {"schema": True, "stack_resolved": True, "tf_validated": True, "tf_planned": True},
|
|
"freshness": {"age_days": 0, "max_age_days": 7},
|
|
"source": {"submitter": "consumer", "commit_sha": "consumer-sha", "signed": False},
|
|
"history": {"prior_rollbacks": 0, "prior_policy_fails": 0},
|
|
"nfrs": {"conformance": None},
|
|
}
|
|
sig = c.compute("$CONTRACT_ID", "dev", inputs)
|
|
print(json.dumps({"score": sig.score, "band": sig.band, "perInput": sig.perInput, "reasonCodes": sig.reasonCodes}, indent=2))
|
|
PY
|
|
BAND=$(python3 -c "import json; print(json.load(open('$WORK/signal.json'))['band'])")
|
|
SCORE=$(python3 -c "import json; print(round(json.load(open('$WORK/signal.json'))['score'],3))")
|
|
echo "confidence: score=$SCORE band=$BAND"
|
|
[ "$BAND" = "pass" ] || fail "confidence band is $BAND, expected pass for dev"
|
|
|
|
echo ""
|
|
echo "=== Step 8: write evidence event to DynamoDB outbox ==="
|
|
STACK_NAME=$(python3 -c "import json; print(json.load(open('$WORK/stack.json'))['stack']['name'])")
|
|
python3 <<PY > "$WORK/event.json" || fail "event build failed"
|
|
import json, datetime
|
|
sig = json.load(open("$WORK/signal.json"))
|
|
event = {
|
|
"contractId": "$CONTRACT_ID",
|
|
"eventType": "CONFIDENCE_COMPUTED",
|
|
"ts": datetime.datetime.now(datetime.timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"),
|
|
"environment": "dev",
|
|
"stack": "$STACK_NAME",
|
|
"score": sig["score"],
|
|
"band": sig["band"],
|
|
"prev_event_hash": "GENESIS",
|
|
}
|
|
print(json.dumps(event, indent=2))
|
|
PY
|
|
python3 acdl_platform/outbox_writer.py "$WORK/event.json" > "$WORK/outbox_item.json" || fail "outbox write failed"
|
|
echo "outbox: $(python3 -c "import json; d=json.load(open('$WORK/outbox_item.json')); print('contractId=', d['contractId'], 'hash=', d['hash'][:16]+'...')")"
|
|
|
|
echo ""
|
|
echo "=== PLATFORM E2E OK ==="
|
|
echo "contract -> resolver -> stack -> terraform plan -> Checkov -> confidence ($BAND) -> outbox"
|
|
exit 0 |