Skip to content

test: support hermetic local API reference #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
apcha-oai merged 1 commit into from
Jul 27, 2026
+9 −0
Merged

test: support hermetic local API reference #316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions scripts/mock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ cd "$(dirname "$0")/.."
if [[ -n "$1" && "$1" != '--'* ]]; then
URL="$1"
shift
elif [[ -f .castiron.stats.yml && -f api_reference/openapi.transformed.yml ]]; then

@HAYDEN-OAI HAYDEN-OAI Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Consume the actual Castiron local-reference contract. The Castiron producer checks in .castiron/api-definition.yaml and .castiron/generation-inputs.json; the descriptor's api_reference records the canonical repo-relative path and a SHA-256 hash. See https://github.com/openai/openai/blob/23bc2f67b559457998cb0facddccb8b9763ed9f4/api/sdk-worker/sdk_worker/api_ref_artifacts/castiron_repo_inputs.py#L16-L20 and https://github.com/openai/openai/blob/23bc2f67b559457998cb0facddccb8b9763ed9f4/api/sdk-worker/sdk_worker/api_ref_artifacts/castiron_repo_inputs.py#L175-L206. .castiron.stats.yml has only schema_version, generation_id, openapi_spec_hash, config_hash, and codegen_sha; its parser explicitly rejects additional fields, so openapi_transformed_spec_hash cannot be added to make this work: https://github.com/openai/openai/blob/23bc2f67b559457998cb0facddccb8b9763ed9f4/api/sdk-worker/sdk_worker/api_ref_artifacts/castiron_candidate_flow.py#L106-L133. Consequently, a real generated checkout never enters this branch and instead downloads the stale/network spec, breaking offline hermetic runs; if api_reference/openapi.transformed.yml is present alongside valid Castiron stats, EXPECTED_HASH is always empty and scripts/mock/scripts/test exit before starting Steady. I reproduced both behaviors against this exact script. Please discover the API reference from .castiron/generation-inputs.json, require its canonical .castiron/api-definition.yaml path, verify the descriptor's SHA-256 against the file, and preserve the existing .stats.yml URL fallback only when no checked-in Castiron reference is present.

URL="api_reference/openapi.transformed.yml"
EXPECTED_HASH="$(awk '$1 == "openapi_transformed_spec_hash:" { print $2; exit }' .castiron.stats.yml)"
ACTUAL_HASH="$(node -e 'process.stdout.write(require("node:crypto").createHash("md5").update(require("node:fs").readFileSync(process.argv[1])).digest("hex"))' "$URL")"

if [[ -z "$EXPECTED_HASH" || "$ACTUAL_HASH" != "$EXPECTED_HASH" ]]; then
echo "Error: Local OpenAPI specification does not match generation metadata" >&2
exit 1
fi
Comment on lines +15 to +18
else
URL="$(grep 'openapi_spec_url' .stats.yml | cut -d' ' -f2)"
fi
Expand Down