raphael
8a55137e57
Interface cleanup so the report_* family matches the typo-safe ethos of eq.names instead of leaking raw protobuf errors on a misspelled value. - Milestone / ModuleState / JobState: importable str-enums (member == its wire name, so plain strings still work) — autocomplete + a typo-checked happy path. The clean rule: equipment-specific *names* live on eq.names; fixed protocol *value-sets* are enums. - _enum_value(): resolves an enum-or-string arg client-side and, on a bad value, raises ValueError with a close-match hint *before* the wire. Wired into report_job / report_substrate / report_module / request_control_state (all previously raised a raw protobuf ValueError). - Equipment is now a context manager (with Equipment(...) as eq: ...). - examples/wafer_tool.py: a cluster tool tracking one wafer through one module end-to-end (E90 + E157), showing the enums + context manager. - tests/test_enums.py: asserts the enums stay in lockstep with the proto and that the typo path is helpful. Wired into run_interop.sh (pyclient step). - Interop drives both the enum and string forms on the wire + the ValueError typo path. Docs (ch16/ch42) updated; names-vs-enums rule documented. All Python unit tests + 25 pyclient interop checks pass. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
164 lines
6.4 KiB
Bash
Executable File
164 lines
6.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Run EVERY external-validation harness in one shot, with a PASS/FAIL summary.
|
|
#
|
|
# The unit suite is partly self-referential (our parsers validate our
|
|
# builders); these harnesses are the real oracle — independent implementations
|
|
# (secsgem-py, secs4java8, Wireshark) judging our wire behaviour. This script
|
|
# exists so they run routinely, not "when someone remembers".
|
|
#
|
|
# tools/run_interop.sh # everything
|
|
# SKIP_SECS4J=1 tools/run_interop.sh # skip the (slow) Java image build
|
|
#
|
|
# Steps (each independently PASS/FAIL, all attempted, nonzero exit if any fail):
|
|
# build compose builder (cmake + ninja, includes secs_gemd)
|
|
# unit secsgem_tests (full C++ suite)
|
|
# daemon-unit secs_gemd_tests (in-process gRPC service tests)
|
|
# py-host secsgem-py active host vs C++ secs_server (31 checks)
|
|
# conformance secs_conformance C++ host vs C++ secs_server (47 checks)
|
|
# daemon gRPC tool + secsgem-py host vs secs_gemd (bridge proof)
|
|
# pyclient published secsgem-client package vs secs_gemd (13 checks)
|
|
# spool spool persistence across a server restart
|
|
# daemon-ops unix-socket gRPC + Prometheus gauges + graceful SIGTERM
|
|
# fab randomized virtual fab: FAB_N daemons x (host + tool) actors
|
|
# tshark Wireshark HSMS dissector on a live capture
|
|
# secs4j secs4java8 Java host vs C++ secs_server (55 checks)
|
|
#
|
|
# Requires: docker compose. Runs from any cwd.
|
|
set -u
|
|
cd "$(dirname "${BASH_SOURCE[0]}")/.."
|
|
|
|
declare -a NAMES RESULTS
|
|
overall=0
|
|
|
|
note() { printf '\n\033[1m== %s ==\033[0m\n' "$*"; }
|
|
record() { # record <name> <exit-code>
|
|
NAMES+=("$1"); RESULTS+=("$2")
|
|
if [ "$2" -ne 0 ]; then overall=1; fi
|
|
}
|
|
|
|
compose() { docker compose "$@"; }
|
|
|
|
stop_services() { compose stop server gemd server-spool fab >/dev/null 2>&1 || true; }
|
|
trap stop_services EXIT
|
|
|
|
# ---- build -----------------------------------------------------------------
|
|
# -j 2: unbounded ninja at -O3 OOM-kills cc1plus in memory-constrained Docker
|
|
# VMs (macOS Docker Desktop). Two jobs is reliably safe and still fast.
|
|
note "build (compose builder, -j 2)"
|
|
compose run --rm builder bash -lc \
|
|
"cmake -S /app -B /app/build -G Ninja -DCMAKE_BUILD_TYPE=Release && \
|
|
cmake --build /app/build -j 2"
|
|
build_rc=$?
|
|
record build $build_rc
|
|
if [ "$build_rc" -ne 0 ]; then
|
|
echo "build failed — aborting (everything below needs the binaries)"
|
|
exit 1
|
|
fi
|
|
|
|
# ---- unit suites -----------------------------------------------------------
|
|
note "unit: secsgem_tests"
|
|
compose run --rm builder /app/build/secsgem_tests; record unit $?
|
|
|
|
note "daemon-unit: secs_gemd_tests"
|
|
if compose run --rm builder test -x /app/build/secs_gemd_tests; then
|
|
compose run --rm builder /app/build/secs_gemd_tests; record daemon-unit $?
|
|
else
|
|
echo "secs_gemd_tests not built (grpc missing from toolchain?) — FAIL"
|
|
record daemon-unit 1
|
|
fi
|
|
|
|
# ---- secsgem-py host vs C++ server ------------------------------------------
|
|
note "py-host: secsgem-py GemHostHandler vs secs_server"
|
|
compose up -d --no-deps server
|
|
sleep 2
|
|
compose run --rm --no-deps interop python3 host_vs_cpp_server.py --host server
|
|
record py-host $?
|
|
compose stop server >/dev/null 2>&1
|
|
|
|
# ---- C++ conformance host vs C++ server -------------------------------------
|
|
note "conformance: secs_conformance vs secs_server"
|
|
compose up -d --no-deps server
|
|
sleep 2
|
|
compose run --rm builder /app/build/secs_conformance --host server --port 5000
|
|
record conformance $?
|
|
compose stop server >/dev/null 2>&1
|
|
|
|
# ---- daemon: gRPC tool + secsgem-py host vs secs_gemd ------------------------
|
|
note "daemon: gRPC + secsgem-py vs secs_gemd"
|
|
compose up -d --no-deps gemd
|
|
sleep 2
|
|
compose run --rm --no-deps interop \
|
|
python3 daemon_interop.py --grpc gemd:50051 --hsms-host gemd
|
|
record daemon $?
|
|
compose stop gemd >/dev/null 2>&1
|
|
|
|
# ---- Python client package vs secs_gemd --------------------------------------
|
|
note "pyclient: secsgem_client package + secsgem-py host vs secs_gemd"
|
|
(
|
|
set -e
|
|
compose run --rm --no-deps -e PYTHONPATH=/app/clients/python interop \
|
|
python3 /app/clients/python/tests/test_values.py
|
|
compose run --rm --no-deps -e PYTHONPATH=/app/clients/python interop \
|
|
python3 /app/clients/python/tests/test_enums.py
|
|
compose up -d --no-deps gemd
|
|
sleep 2
|
|
compose run --rm --no-deps -e PYTHONPATH=/app/clients/python interop \
|
|
python3 pyclient_interop.py --grpc gemd:50051 --hsms-host gemd
|
|
)
|
|
record pyclient $?
|
|
compose stop gemd >/dev/null 2>&1
|
|
|
|
# ---- spool persistence across restart ---------------------------------------
|
|
note "spool: persistence across server restart"
|
|
(
|
|
set -e
|
|
compose up -d --no-deps server-spool
|
|
sleep 2
|
|
compose run --rm --no-deps interop \
|
|
python3 spool_persistence_test.py --phase enqueue --host server-spool
|
|
compose restart server-spool
|
|
sleep 2
|
|
compose run --rm --no-deps interop \
|
|
python3 spool_persistence_test.py --phase drain --host server-spool
|
|
)
|
|
record spool $?
|
|
compose stop server-spool >/dev/null 2>&1
|
|
|
|
# ---- daemon operations: unix socket + metrics + graceful shutdown ------------
|
|
note "daemon-ops: unix socket, Prometheus gauges, SIGTERM drains cleanly"
|
|
compose run --rm builder bash tools/check_daemon_ops.sh
|
|
record daemon-ops $?
|
|
|
|
# ---- randomized virtual fab ----------------------------------------------------
|
|
note "fab: ${FAB_N:-3} equipment x (secsgem-py host + secsgem-client tool), seeded random traffic"
|
|
compose up -d --no-deps fab
|
|
sleep 3
|
|
compose run --rm --no-deps -e PYTHONPATH=/app/clients/python interop \
|
|
python3 virtual_fab.py --host fab --n "${FAB_N:-3}" --seconds "${FAB_SECONDS:-20}"
|
|
record fab $?
|
|
compose stop fab >/dev/null 2>&1
|
|
|
|
# ---- Wireshark dissector ------------------------------------------------------
|
|
note "tshark: Wireshark HSMS dissector"
|
|
compose run --rm builder bash interop/tshark_validate.sh
|
|
record tshark $?
|
|
|
|
# ---- secs4java8 ---------------------------------------------------------------
|
|
if [ "${SKIP_SECS4J:-0}" = "1" ]; then
|
|
echo "secs4j skipped (SKIP_SECS4J=1)"
|
|
else
|
|
note "secs4j: secs4java8 host vs secs_server"
|
|
bash interop/secs4j_validate.sh; record secs4j $?
|
|
fi
|
|
|
|
# ---- summary -----------------------------------------------------------------
|
|
printf '\n\033[1m== interop summary ==\033[0m\n'
|
|
for i in "${!NAMES[@]}"; do
|
|
if [ "${RESULTS[$i]}" -eq 0 ]; then
|
|
printf ' \033[32mPASS\033[0m %s\n' "${NAMES[$i]}"
|
|
else
|
|
printf ' \033[31mFAIL\033[0m %s (exit %s)\n' "${NAMES[$i]}" "${RESULTS[$i]}"
|
|
fi
|
|
done
|
|
exit $overall
|