Merge pull request 'Route the healthcheck output through one helper' (#16) from orchestra/06G4GWWJ8SWFREF06HDYEBAG0C into master

TASK.md

@@ -1,63 +1,20 @@
-# Task 06G4FT0MB733H2ZCZ237WFHFD8
+# Task 06G4GWWJ8SWFREF06HDYEBAG0C
 
-Give the healthcheck a self-test and a machine-readable mode
+Route the healthcheck output through one helper
 
 - Project: test-e2e
-- Source: gitea:test-e2e/10
+- Source: gitea:test-e2e/15
 - Priority: 0
 
 ## Instructions
 
-Three pieces of work, in order. Plan them as exactly three phases in that order.
+`scripts/orchestra_e2e_healthcheck.sh` prints its success line from more than one place. Centralise the output so every path goes through one helper, and give that helper an explicit format argument rather than reading a global.
 
-## Phase 1 — a self-test for the healthcheck
-
-New file `scripts/orchestra_e2e_selftest.sh`, executable, `#!/usr/bin/env bash`.
-
-It runs `scripts/orchestra_e2e_healthcheck.sh`, then asserts:
-
-- exit status is 0
-- stdout contains `OK`
-
-On failure it prints which assertion failed and exits 1. On success it prints `selftest: ok` and exits 0.
-
-Verification for this phase is automated only. The one check is:
-
-    - run: ["bash", "-n", "scripts/orchestra_e2e_selftest.sh"]
-
-Do not add a manual step to this phase.
-
-## Phase 2 — `--json` on the healthcheck
-
-`scripts/orchestra_e2e_healthcheck.sh --json` prints exactly one line:
-
-    {"status":"ok","checks":1}
-
-and exits 0. Without `--json` the existing human output is unchanged, and `--help` keeps working. `--json` and `--help` together behave as `--help`.
-
-Verification for this phase must include both an automated check and a manual step. The JSON shape is a judgement a human confirms by reading it, so state the manual step as the exact command a human runs and the exact line they should see.
-
-## Phase 3 — teach the self-test about `--json`
-
-Extend `scripts/orchestra_e2e_selftest.sh` to run the healthcheck twice: once plain and once with `--json`. Assert the plain run still contains `OK`, and assert the `--json` run prints one line beginning with `{"status":`.
-
-Verification for this phase is automated only:
-
-    - run: ["bash", "-n", "scripts/orchestra_e2e_selftest.sh"]
-    - run: ["bash", "scripts/orchestra_e2e_healthcheck.sh"]
-
-## Constraints
-
-The project's verification policy allows exactly two command shapes:
-
-    ["bash", "-n", "<one file>"]
-    ["bash", "scripts/orchestra_e2e_healthcheck.sh"]
-
-A `run:` line outside those is refused when the plan seals, not later.
+Behaviour must not change. The plain run, `--quiet`, `--help` and `--json` all keep their current output and exit statuses, and `scripts/test_healthcheck.sh` keeps passing.
 
 ## Research first
 
-Before planning, establish at least three findings and label their confidence honestly: at least one `fact`, one `inference`, and one `assumption`. The plan must cite at least two of them in References.
+Establish at least three findings with distinct confidence: at least one `fact`, one `inference`, one `assumption`.
 
 
 ## Completion

scripts/orchestra_e2e_healthcheck.sh

@@ -1,14 +1,23 @@
 #!/usr/bin/env bash
 
+# 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'
       exit 0
     elif [ "$arg" = --quiet ]; then
       quiet=1
@@ -17,12 +26,16 @@ main() {
     fi
   done
 
-  if [ -n "$json" ]; then
-    printf '{"status":"ok","checks":1}\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
 
-  [ -n "$quiet" ] || printf 'OK - all healthchecks passed\n'
+  emit "$format" 'OK - all healthchecks passed\n'
   exit 0
 }