Sylpheed/tools/port/check-all

#!/usr/bin/env bash
# Run every check this port has, and say which ones assert.
#
#   tools/port/check-all
#
# There are fourteen tools under `tools/port/` (eleven when this was written --
# the count is stated because it dates the sentence) and nothing ran them
# together, so
# each had to be remembered individually. That is the ninth instance of this
# port's recurring shape -- something correct, documented and unexercised -- one
# level up: the checks themselves were the thing nobody was running.
#
# ⚠️ It runs the tools that ASSERT. The exploratory ones -- `screen-strip`,
# `which-focus`, `strip-padding`, `verify-dwell`, `check-capture`,
# `verify-video-audio` -- produce artifacts for a person to look at and have no
# verdict to collect. Listing them here as passes would be inventing six.
set -euo pipefail
cd "${PROJECT_DIR:-/work}"
export DISPLAY="${DISPLAY:-:97}"
OUT="${OUT:-${TMPDIR:-/tmp}/check-all}"; mkdir -p "$OUT"
BIN="${CARGO_TARGET_DIR:-/sylph-home/port/target-container}/debug/sylpheed-export"
fail=0

step() { # name, expectation, command...
  local name="$1" expect="$2"; shift 2
  local log="$OUT/${name}.log" rc=0
  "$@" >"$log" 2>&1 || rc=$?
  case "$expect" in
    must-pass)
      [ $rc -eq 0 ] && printf '  %-24s ok\n' "$name" \
        || { printf '  %-24s 🔴 FAILED (rc=%d) -- %s\n' "$name" "$rc" "$log"; fail=1; }
      ;;
    report-only)
      printf '  %-24s ran (no verdict -- see below)\n' "$name"
      ;;
  esac
}

# 🔴 THE DISPLAY CAN BE GONE, AND EVERY GODOT STEP THEN FAILS FOR ONE REASON.
#
# Xvfb does not survive a container restart, and its socket does: /tmp/.X11-unix
# keeps `X97` after the server is gone, so Godot reports
#
#   ERROR: X11 Display is not available
#
# rather than "no such display", falls back to Wayland, fails that too, and
# exits non-zero. Every Godot-backed step below would then report red, and all of
# it would mean one thing -- there is no display -- which is exactly the wall of
# meaningless failures a check suite exists to avoid. Cost one run on 2026-09-01
# before it was noticed.
#
# Checked with `xdpyinfo` rather than by looking for the socket, because the
# stale socket is what makes the failure confusing in the first place.
if ! DISPLAY="$DISPLAY" timeout 10 xdpyinfo >/dev/null 2>&1; then
  echo "🔴 no X display on $DISPLAY -- every Godot step below would fail for that one reason."
  echo "   Xvfb does not survive a container restart and leaves its socket behind. Start it with:"
  echo "     rm -f /tmp/.X11-unix/X\${DISPLAY#:} ; Xvfb $DISPLAY -screen 0 1280x720x24 -nolisten tcp &"
  exit 3
fi

# 🔴 GODOT'S SCRIPT CLASS LIST IS A BUILD CACHE, AND IT IS GITIGNORED.
#
# `port/.godot/global_script_class_cache.cfg` is what resolves a `class_name`,
# and `.gitignore` excludes `port/.godot/` -- correctly, it is derived. So a
# checkout that MERGES a commit adding a new `class_name` keeps a cache that
# does not list it, and every script referencing the new class fails to parse:
#
#   SCRIPT ERROR: Parse Error: Identifier "Gamepad" not declared in the current scope.
#   ERROR: Failed to load script "res://scripts/boot.gd" with error "Parse error".
#
# The whole project then refuses to load, from `--screen` to `--boot`, and the
# error names the symbol rather than the cache -- so it reads as a missing file
# or a bad merge. This is exactly what merging the human's input fix did on
# 2026-09-01: `gamepad.gd` arrived with `class_name Gamepad`, the cache in this
# container was warm and predated it, and the port did not run at all.
#
# A fresh clone has no `.godot/` and Godot builds one on first run, so nobody
# hits this until they merge into a working tree -- which is every iteration of
# this loop. Reimporting is cheap and idempotent, so it runs unconditionally
# rather than behind a staleness test that would itself need to be right.
echo "godot: reimporting so class_name resolves against a fresh cache"
DISPLAY="$DISPLAY" godot --headless --path port --import >"$OUT/godot-import.log" 2>&1 \
  || { echo "  🔴 godot --import FAILED -- see $OUT/godot-import.log"; fail=1; }
for c in $(grep -ho '^class_name [A-Za-z_][A-Za-z0-9_]*' port/scripts/*.gd | awk '{print $2}'); do
  grep -q "\"$c\"" port/.godot/global_script_class_cache.cfg 2>/dev/null \
    || { printf '  %-24s 🔴 class_name %s is not in the class cache\n' class-cache "$c"; fail=1; }
done
echo

echo "asserting checks:"
step format-validator must-pass "$BIN" check
# The contract lives on a branch this checkout does not merge: HANDOFF on `main`
# is frozen at 926 lines while the live one is 4 111. Reading 70 unread sections
# by hand is how two days of deliveries went unread. These are the values that
# have been reduced to a check; the rest are still read by eye, or not at all.
step contract-values  must-pass tools/port/contract-check
step contract-control must-pass tools/port/contract-check --control
# 🔴 The control harness itself is asserted. Every --control run says "each check
# fails on a perturbed contract"; none of them said "a broken control reports
# broken". A harness that silently approves a dead check is exactly as useless as
# a check that silently approves a dead value.
step control-harness  must-pass tools/port/contract-check --selftest
step modding-rules    must-pass tools/port/check-modding
# Every `kind` in authored/ is a claim about where a value came from, and until
# 2026-08-30 nothing checked what any of them rested on -- seven were resting on
# a sibling `why` that argued a different claim.
step authored-kinds   must-pass tools/port/audit-kinds
# The classifier is asked whether it can tell grounded from ungrounded at all,
# rather than only what it found. Exit 2 = the harness is broken.
step kinds-harness    must-pass tools/port/audit-kinds --selftest
# Band levels are alignment-free and carry their own known negative on every run;
# the difference-signal half of the same tool stays report-only and asserts
# nothing. See docs/port/DECISIONS.md -- the waveform question is still open.
step transcode-bands  must-pass tools/port/verify-transcode-fidelity
# Asks whether the band measurement is LIVE, not just what it found. An empty
# band list makes every comparison read 0.0 dB and pass; that now exits 2.
step bands-harness    must-pass tools/port/verify-transcode-fidelity --selftest
step capture-controls must-pass tools/port/check-capture-controls
step menu-audio       must-pass env OUT="$OUT/audio" tools/port/verify-menu-audio
# 🔴 ADDED 2026-09-01 after a human found Ⓐ dead on a real controller while the
# unattended P5 walk passed. `--script` sends `InputEventAction`, which BYPASSES
# the input map, so every check here asserted the code BELOW the map and nothing
# about the map -- which was missing a joypad binding for `ui_accept` and
# `ui_cancel` entirely. The same blind spot hid a second defect: an
# `InputEventAction` is not an analog axis, so nothing could see that a held
# stick fired once per jitter.
step input-map        must-pass tools/port/verify-input
step input-control    must-pass tools/port/verify-input --control
# A stale index is worse than none: it answers "is this already decided?" with a
# confident no. That is not hypothetical -- see the entry it was built after.
step decisions-index  must-pass tools/port/index-decisions --check
# A refuted claim asserted outside its correction is a lie the corpus tells a
# reader who greps for it. Registered claims must carry an explicit `[refuted]`.
# 🔴 The register check had NO executable control until 2026-08-31 -- every
# "planted a revival and it failed" in DECISIONS was done by hand, once. Four
# cases now drive it as a subprocess and read its real exit code, including an
# EMPTY REGISTER, which used to report clean forever.
step claims-control   must-pass tools/port/check-claims --control
step refuted-claims   must-pass tools/port/check-claims
echo
echo "reported, not asserted:"
# Not an assertion: being behind a peer's topic branch is the normal state, and a
# red line for it would be scenery within a day. It is here so the affordance is
# visible on every run -- reading a peer's head needs no merge and no human.
step peer-heads       report-only tools/port/peer-head
step oracle-captures  report-only env OUT="$OUT/oracle" tools/port/verify-capture
sed -n '/^screen /,$p' "$OUT/oracle-captures.log" | sed 's/^/    /'
# 🔴 `verify-capture` prints and always exits 0. Its own header is right that the
# numbers are not a target -- the captures carry the game's tone ramp, so RMSE has
# a floor and driving it lower is fitting the ramp. But "not a target" is not the
# same as "not a regression detector", and nothing here would notice `title_plate`
# moving off 0.00 %. Asserting it needs a stored baseline per row, which is a real
# design decision about what a baseline means when the pose is fitted. NAMED, not
# quietly skipped.

echo
echo "consistency (expected to differ, for a stated reason):"
rc=0; env OUT="$OUT/screens" tools/port/verify-screen >"$OUT/verify-screen.log" 2>&1 || rc=$?
differs=$(grep -c DIFFERS "$OUT/verify-screen.log" || true)
# 🔴 THE ALLOWANCE IS DERIVED NOW, NOT LISTED, and that is strictly stronger.
#
# Six screens joined this set on 2026-09-01 and the cause is diagnosed for two of
# them: the port draws some elements ADDITIVE -- transcribed from the Decoder's
# per-draw RB_BLENDCONTROL0 log off the running game -- and the reference has no
# additive path at all (ui_layout.rs has exactly two blend sites, both
# alpha-over, and line 1169 records that it tried additive and refuted it from
# its own composite metrics). So the two renderers disagree ON PURPOSE, and the
# size of the disagreement tracks the size of the additive set: extras has 9
# elements and a mean of 6.74, main_menu has 5 and 3.94, and the screens with
# none sit an order of magnitude below.
#
# Computing the allowance from `authored/rendering.json` rather than listing it
# means a screen is excused BECAUSE it has additive elements the reference
# cannot draw, and a screen that differs WITHOUT them still fails -- which a
# literal list could not express, and which keeps this from going stale against
# the map it is derived from. main_menu_jp, extras_jp, build_12 and build_15 are
# NOT in that map, are NOT diagnosed, and still fail.
# docs/port/verify-screen-blend-divergence.md
additive_screens=$(python3 -c "
import json
d=json.load(open('authored/rendering.json')).get('additive_elements') or {}
print('\n'.join(k for k,v in d.items() if v))" 2>/dev/null)
allow_args=(-e title -e title_jp)
for sc in $additive_screens; do allow_args+=(-e "$sc"); done
printf '  %-24s allowing %s (additive set + 2 legacy)\n' verify-screen \
  "$(echo $additive_screens | tr '\n' ' ')"
unexpected=$(grep DIFFERS "$OUT/verify-screen.log" | awk '{print $1}' \
  | grep -vx "${allow_args[@]}" || true)

# 🔴 THE OLD ALLOWANCE WAS FALSE, AND MY FIRST REPLACEMENT REASON WAS ALSO
# WRONG. Both are recorded because the second error is the more instructive.
#
# It said: "the pin is not on main, so this compares two decoder eras". I
# replaced that with "the eras render identically -- 0 pixels different on three
# screens". 🔴 **That measurement was void**: the two binaries I compared had the
# same md5. I built one in a worktree at the pinned tag and one from the
# workspace, and both commits carry the record-layout fix, so I compared a
# binary with itself and reported the zero as evidence.
#
# Rebuilt properly against `origin/main`, which is the genuinely stale era
# (`rest t=70 [12 70 80 -]` against the fixed `rest t=12 [0 12 70 80]`):
#
#   title      0 px      main_menu  0 px      title_jp  74 507 px
#
# ✅ The eras DO change pixels, and `title_jp` is one of the seven bundles where
# they do -- reproducing the Decoder's figure exactly, under their flags and
# mine. My "--animated masks it" hypothesis was wrong too.
#
# ✅ BUT THE ERA STILL CANNOT EXPLAIN THIS SCRIPT'S ROWS, for a reason I had not
# established: BOTH SIDES OF THIS COMPARISON ARE THE FIXED ERA. The exporter is
# pinned to `formats-pin-2026-08-30` and this reference is built from the
# workspace, and a binary built from each has the SAME md5. There is no era
# mismatch here to explain anything. Right answer, wrong evidence, and the wrong
# evidence was a broken experiment.
#
# The real reasons are per-screen and already documented:
#   title    -- the ptloop SWEEP PHASE residual, max 6 / over3 790, unchanged
#               across every renderer change since P1 (DECISIONS.md).
#   title_jp -- the `--pose=rest` sparkle handling. Adjudicated against the
#               oracle: the port's SHIPPED pose scores r +0.9994 against the
#               game where the reference scores +0.8727, and `--pose=rest` is
#               what this script compares.
#   ⚠️ title_jp is ALSO an era-sensitive bundle, so if this reference is ever
#   built from a different era than the exporter's pin, that row's cause changes
#   and this note stops applying. Check the md5s before trusting it again.
#
# So the allowance is now a NAMED SET, not a count with an excuse. A DIFFERS on
# any other screen fails the run, which a count never could.
# 🔴 SIX MORE SCREENS JOINED THIS SET ON 2026-09-01 AND THE SET WAS NOT WIDENED.
# main_menu, extras, main_menu_jp, extras_jp, build_12, build_15. Measured, not
# diagnosed: the difference is full-frame, it is EXACTLY ZERO on unblended
# pixels (18 081 of them agree to a hundredth of a level) and gamma-shaped on
# every blended one, so it is a blend-SPACE divergence rather than moved content.
# Scored against the live capture the port is 16 % closer than the reference --
# an ordering only, since both sides share this script's --pose=rest
# contamination. Left failing on purpose: this allowance has twice been widened
# with a reason that turned out false, and "I measured it but cannot say which
# renderer is right" is not a reason. docs/port/verify-screen-blend-divergence.md
if [ -n "$unexpected" ]; then
  printf '  %-24s 🔴 DIFFERS on %s -- not in the allowed set\n' verify-screen "$(echo $unexpected | tr '\n' ' ')"
  printf '  %-24s see docs/port/verify-screen-blend-divergence.md -- measured, cause open\n' ""
  fail=1
else
  printf '  %-24s %d DIFFERS, both named and explained per screen:\n' verify-screen "$differs"
  printf '  %-24s title = sweep phase; title_jp = rest-pose sparkles (the port is\n' ""
  printf '  %-24s closer to the GAME there than the reference is).\n' ""
fi

# Separately, and unrelated to the rows above: revert to the path dependency when
# the pin lands. Read from Cargo.toml so it cannot drift out of step again.
pin=$(sed -n 's/.*tag = "\([^"]*\)".*/\1/p' crates/sylpheed-export/Cargo.toml | head -1)
if [ -n "$pin" ] && git merge-base --is-ancestor "$pin" origin/main 2>/dev/null; then
  printf '  %-24s ⚠️  %s has landed on main -- revert Cargo.toml to the path dep\n' pin "$pin"
fi

echo
[ $fail -eq 0 ] && echo "every asserting check passes" || echo "🔴 a check failed"
exit $fail