orchestra: pre-release WIP snapshot (orchestra-06g4m8whgq4p3gqmpeeh0rjrhm-70ced771)

Reviewed-on: #17

TASK.md

@@ -1,14 +1,37 @@
-# Task 06G4E6F69AKP2PA00S28D7ASBC
+# Task 06G4M8WHGQ4P3GQMPEEH0RJRHM
 
-Add a --quiet flag to the healthcheck script
+Give the healthcheck a --list-checks flag
 
 - Project: test-e2e
-- Source: gitea:test-e2e/7
+- Source: burnin/run14-c
 - Priority: 0
 
 ## Instructions
 
-scripts/orchestra_e2e_healthcheck.sh already handles --help. Add a --quiet flag alongside it that suppresses the success line and still exits 0. Leave the default behaviour and the --help output unchanged.
+Give `scripts/orchestra_e2e_healthcheck.sh` a `--list-checks` flag that prints the name of each check it performs, one per line, and exits 0.
+
+This is deliberately two pieces of work, and the plan should carry two phases:
+
+1. Name the checks. The script performs its checks inline. Introduce one list of check names and drive the existing run from that list, with no change to any output or exit status.
+2. Add the flag. `--list-checks` prints the names from that list and exits 0. Add one line to the usage text describing it.
+
+## Verification policy for this project
+
+Only two commands may appear on a `- run:` line, exactly:
+
+- `["bash", "-n", "<path>"]`
+- `["bash", "scripts/orchestra_e2e_healthcheck.sh"]`
+
+Anything else is refused when you seal the plan. `scripts/test_healthcheck.sh` is NOT permitted as an automated command. Update it as a manual step so its expected `--help` text matches, and list that as a manual check.
+
+## Research first
+
+Establish at least three findings with distinct confidence: at least one `fact`, one `inference`, one `assumption`.
+
+
+## Quality gate
+
+bash -n scripts/*.sh && bash scripts/orchestra_e2e_healthcheck.sh
 
 ## Completion
 

scripts/orchestra_e2e_healthcheck.sh

@@ -1,20 +1,51 @@
 #!/usr/bin/env bash
 
+readonly VERSION=1.0.0
+readonly CHECKS=(script-runs)
+
+# emit <format> <template> [args...]: the single output path.
+# format: text or json print; none suppresses (--quiet). Explicit argument,
+# never read from an enclosing variable.
+emit() {
+  local format=$1
+  shift
+  [ "$format" = none ] || printf "$@"
+}
+
 main() {
   local quiet=
+  local json=
   for arg in "$@"; do
     if [ "$arg" = --help ]; then
-      printf 'Usage: %s [--quiet]\n\n' "${0##*/}"
-      printf 'Healthcheck script for Orchestra E2E tests.\n'
-      printf 'Exits 0 with a success message if all checks pass.\n'
-      printf '  --quiet  Suppress the success message; still exits 0.\n'
+      emit text 'Usage: %s [--quiet]\n\n' "${0##*/}"
+      emit text 'Healthcheck script for Orchestra E2E tests.\n'
+      emit text 'Exits 0 with a success message if all checks pass.\n'
+      emit text '  --quiet  Suppress the success message; still exits 0.\n'
+      emit text '  --list-checks  Print the name of each check; exits 0.\n'
+      emit text 'Version: %s\n' "$VERSION"
+      exit 0
+    elif [ "$arg" = --list-checks ]; then
+      for name in "${CHECKS[@]}"; do
+        emit text '%s\n' "$name"
+      done
       exit 0
     elif [ "$arg" = --quiet ]; then
       quiet=1
+    elif [ "$arg" = --json ]; then
+      json=1
     fi
   done
 
-  [ -n "$quiet" ] || printf 'OK - all healthchecks passed\n'
+  local format=text
+  [ -n "$quiet" ] && format=none
+  [ -n "$json" ] && format=json
+
+  if [ "$format" = json ]; then
+    emit "$format" '{"status":"ok","checks":%d}\n' "${#CHECKS[@]}"
+    exit 0
+  fi
+
+  emit "$format" 'OK - all healthchecks passed\n'
   exit 0
 }
 

scripts/orchestra_e2e_selftest.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+# Self-test for the Orchestra E2E healthcheck.
+
+here=$(cd "$(dirname "$0")" && pwd)
+healthcheck="$here/orchestra_e2e_healthcheck.sh"
+
+# fail <assertion> <captured stdout>: always echo what the healthcheck printed,
+# so a red run is diagnosable without rerunning it by hand.
+fail() {
+  printf 'selftest: FAILED %s\n' "$1" >&2
+  printf 'selftest: healthcheck stdout was:\n%s\n' "$2" >&2
+  exit 1
+}
+
+# plain run
+out=$(bash "$healthcheck")
+status=$?
+
+[ "$status" -eq 0 ] || fail "plain run exit status: want 0, got $status" "$out"
+case "$out" in
+  *OK*) ;;
+  *) fail "plain run stdout contains OK" "$out" ;;
+esac
+
+# --json run
+jout=$(bash "$healthcheck" --json)
+jstatus=$?
+
+[ "$jstatus" -eq 0 ] || fail "--json run exit status: want 0, got $jstatus" "$jout"
+jlines=$(printf '%s\n' "$jout" | wc -l)
+[ "$jlines" -eq 1 ] || fail "--json run line count: want 1, got $jlines" "$jout"
+case "$jout" in
+  '{"status":'*) ;;
+  *) fail '--json run stdout prefix: want {"status":' "$jout" ;;
+esac
+
+printf 'selftest: ok\n'

scripts/test_healthcheck.sh

@@ -3,7 +3,7 @@
 
 HC="$(dirname "$0")/orchestra_e2e_healthcheck.sh"
 OK='OK - all healthchecks passed'
-USAGE="$(printf 'Usage: orchestra_e2e_healthcheck.sh [--quiet]\n\nHealthcheck script for Orchestra E2E tests.\nExits 0 with a success message if all checks pass.\n  --quiet  Suppress the success message; still exits 0.')"
+USAGE="$(printf 'Usage: orchestra_e2e_healthcheck.sh [--quiet]\n\nHealthcheck script for Orchestra E2E tests.\nExits 0 with a success message if all checks pass.\n  --quiet  Suppress the success message; still exits 0.\n  --list-checks  Print the name of each check; exits 0.\nVersion: 1.0.0')"
 fails=0
 
 check() { # check <expected-stdout> <label> [args...]