Merge pull request 'Late handoff rig: add a --version line to the healthcheck usage text' (#17) from orchestra/06G4JX6MSQEP7N0D5JWW9EP5X4 into master

Reviewed-on: #17

TASK.md

@@ -1,49 +1,23 @@
-# Task 06G4E83E4KRXM8DS90M2648MGM
+# Task 06G4JX6MSQEP7N0D5JWW9EP5X4
 
-Add a --quiet flag to the healthcheck script
+Late handoff rig: add a --version line to the healthcheck usage text
 
 - Project: test-e2e
-- Source: gitea:test-e2e/8
+- Source: burnin/late-handoff-1
 - Priority: 0
 
 ## Instructions
 
-## Goal
+Add the version string to the usage text printed by scripts/orchestra_e2e_healthcheck.sh --help. Keep every existing line and exit status unchanged, and keep scripts/test_healthcheck.sh passing.
 
-Add a --quiet flag to the healthcheck script
+## Research first
 
-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.
+Establish at least three findings with distinct confidence: at least one `fact`, one `inference`, one `assumption`.
 
-## Verification
 
-- `bash -n scripts/*.sh && bash scripts/orchestra_e2e_healthcheck.sh` exited 0
-- commit: 41dee802416aaa9020a2e31ae5b79fa084a4f150
-- independent review of 41dee802416aaa9020a2e31ae5b79fa084a4f150: pass
-- accepted plan: 6c62e3cde23ed9aca296ed5b60295384b35cdad9fe0e1e45fa381d5801fb9af3
+## Quality gate
 
-## Behavioural changes
-
-- none reported
-
-## Deviations from plan
-
-- none reported
-
-## Remaining risks
-
-- none reported
-
-## Review hotspots
-
-- none reported
-
-The sections above are derived from Orchestra state. The reported
-changes, deviations, risks, and hotspots are the implementing agent's
-own account and are not verified.
-
-## Acceptance criteria
-
-- not stated in the task contract
+bash -n scripts/*.sh && bash scripts/orchestra_e2e_healthcheck.sh
 
 ## Completion
 

scripts/orchestra_e2e_healthcheck.sh

@@ -1,16 +1,44 @@
 #!/usr/bin/env bash
 
+readonly VERSION=1.0.0
+
+# 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\n\n' "${0##*/}"
-      printf 'Healthcheck script for Orchestra E2E tests.\n'
-      printf 'Exits 0 with a success message if all checks pass.\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 'Version: %s\n' "$VERSION"
       exit 0
+    elif [ "$arg" = --quiet ]; then
+      quiet=1
+    elif [ "$arg" = --json ]; then
+      json=1
     fi
   done
 
-  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":1}\n'
+    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

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# Self-check for orchestra_e2e_healthcheck.sh.
+
+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.\nVersion: 1.0.0')"
+fails=0
+
+check() { # check <expected-stdout> <label> [args...]
+  local want=$1 label=$2 got status
+  shift 2
+  got=$(bash "$HC" "$@" 2>/dev/null)
+  status=$?
+  if [ "$got" != "$want" ] || [ "$status" -ne 0 ]; then
+    printf 'FAIL: %s (exit=%s)\n---got---\n%s\n---want---\n%s\n' "$label" "$status" "$got" "$want"
+    fails=$((fails + 1))
+  fi
+}
+
+check "$OK" 'no args'
+check '' '--quiet' --quiet
+check "$USAGE" '--help' --help
+check "$USAGE" '--help --quiet' --help --quiet
+check "$USAGE" '--quiet --help' --quiet --help
+check "$OK" 'unknown flag ignored' --bogus
+
+[ "$fails" -eq 0 ] || exit 1
+printf 'all checks passed\n'