orchestra: pre-release WIP snapshot (orchestra-06g4w2tmz9mw9sebm5mgtm5288-89c1c97d)

TASK.md

@@ -1,24 +1,43 @@
-# Task 06G4WDJ06G7FK00QF73Z9DDBT4
+# Task 06G4W2TMZ9MW9SEBM5MGTM5288
 
-Sort the check names in --list-checks
+Describe each healthcheck check in one line
 
 - Project: test-e2e
-- Source: gitea:test-e2e/27
+- Source: gitea:test-e2e/24
 - Priority: 0
 
 ## Instructions
 
-`--list-checks` prints the ten check names in the order they run. Add a `--sorted` modifier that prints them in alphabetical order instead, leaving run order untouched.
+scripts/orchestra_e2e_healthcheck.sh now runs ten named checks. Give each one a one-line description, and print those descriptions where the names are already printed.
 
-Plan this as THREE phases:
+The descriptions, one per check:
 
-1. A helper that returns the check names in alphabetical order, with no caller yet.
-2. `--sorted` accepted alongside `--list-checks`, using that helper. Alone, `--sorted` changes nothing.
-3. The usage text in `--help`, and assertions in scripts/test_healthcheck.sh for both orders.
+- repo_root_readable: the repository root exists and is readable
+- scripts_dir_present: the scripts directory exists
+- healthcheck_executable_bit: this script is executable
+- selftest_present: the selftest script is present
+- test_healthcheck_present: the healthcheck test is present
+- readme_present: README.md is present
+- no_crlf_line_endings: no tracked text file uses CRLF endings
+- no_tabs_in_scripts: no script indents with tabs
+- shebang_is_bash: every script declares the bash shebang
+- usage_text_mentions_every_flag: the usage text lists every flag
+
+Where they appear:
+
+- `--list-checks` prints `<name>: <description>`, one per line.
+- `--help` prints the same description beside each name in its Checks section.
+- `--summary` is unchanged and keeps printing `<name>: ok`.
+
+Plan this as FIVE phases, two checks per phase, in the order listed above.
 
 ## Work one phase at a time
 
-Implement phase N, request its verification, and only then begin phase N+1.
+Implement phase N, request its verification, and only then begin phase N+1. Do not write the whole change first and verify the phases afterwards.
+
+## Every phase carries both kinds of check
+
+This is a hard requirement of this task. Each phase must have at least one automated check from the policy below. Each phase must also have at least one manual check, confirmed by a human reading the printed output. Orchestra runs the automated ones. A human owns the manual ones, and the phase is not finished until that human signs it off.
 
 ## Verification policy for this project
 
@@ -27,16 +46,25 @@ 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. Give every phase at least one automated check from that list and at least one manual check.
+Anything else is refused when you seal the plan.
+
+## Behaviour that must not change
+
+Every existing flag keeps its current behaviour and exit status: --quiet, --json, --summary, --timing, --strict, --help. The success line is unchanged.
 
 ## Research first
 
 Establish at least three findings with distinct confidence: at least one fact, one inference, one assumption.
 
+## Handoff behaviour
+
+Behave normally. If Orchestra asks you to write a handoff report, write it and stop.
+
 Acceptance:
-- `--list-checks --sorted` prints the ten names alphabetically.
-- `--list-checks` alone keeps run order.
-- Every other flag is unchanged.
+- Each of the ten checks has a one-line description in exactly one place in the script.
+- --list-checks prints name and description for all ten.
+- --help lists all ten names with their descriptions.
+- --summary, --timing, --strict, --json and --quiet behave exactly as before.
 
 ## Completion
 

scripts/orchestra_e2e_healthcheck.sh

@@ -73,10 +73,39 @@ emit() {
   [ "$format" = none ] || printf "$@"
 }
 
+# describe <name>: the one-line description of a check. One case branch per
+# name; this is the only place a description is written.
+describe() {
+  case "$1" in
+    repo_root_readable) printf 'the repository root exists and is readable' ;;
+    scripts_dir_present) printf 'the scripts directory exists' ;;
+    healthcheck_executable_bit) printf 'this script is executable' ;;
+    selftest_present) printf 'the selftest script is present' ;;
+    test_healthcheck_present) printf 'the healthcheck test is present' ;;
+    readme_present) printf 'README.md is present' ;;
+    no_crlf_line_endings) printf 'no tracked text file uses CRLF endings' ;;
+    no_tabs_in_scripts) printf 'no script indents with tabs' ;;
+    shebang_is_bash) printf 'every script declares the bash shebang' ;;
+    usage_text_mentions_every_flag) printf 'the usage text lists every flag' ;;
+  esac
+}
+
+# label <name>: '<name>: <description>', or bare '<name>' while a name has no
+# description yet.
+label() {
+  local text
+  text=$(describe "$1")
+  if [ -n "$text" ]; then
+    printf '%s: %s' "$1" "$text"
+  else
+    printf '%s' "$1"
+  fi
+}
+
 # usage <format>: the --help body. Also the source check_usage_text_mentions_every_flag
 # reads, so the flag list has exactly one home.
 usage() {
-  emit "$1" 'Usage: %s [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks] [--sorted]\n\n' "${0##*/}"
+  emit "$1" 'Usage: %s [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks]\n\n' "${0##*/}"
   emit "$1" 'Healthcheck script for Orchestra E2E tests.\n'
   emit "$1" 'Exits 0 with a success message if all checks pass.\n'
   emit "$1" '  --quiet  Suppress the success message; still exits 0.\n'
@@ -86,21 +115,14 @@ usage() {
   emit "$1" '  --timing Print elapsed milliseconds for the run.\n'
   emit "$1" '  --strict Reject an unrecognised flag: exits 2.\n'
   emit "$1" '  --list-checks  Print the name of each check; exits 0.\n'
-  emit "$1" '  --sorted  With --list-checks, list the names alphabetically.\n'
   emit "$1" '\nChecks:\n'
   local name
   for name in $CHECKS; do
-    emit "$1" '  %s\n' "$name"
+    emit "$1" '  %s\n' "$(label "$name")"
   done
   emit "$1" '\nVersion: %s\n' "$VERSION"
 }
 
-# sorted_checks: the check names, one per line, in alphabetical order.
-# LC_ALL=C keeps the order fixed if a name with a digit or capital is added.
-sorted_checks() {
-  printf '%s\n' $CHECKS | LC_ALL=C sort
-}
-
 main() {
   local start_us
   start_us=$(now_us)
@@ -110,16 +132,16 @@ main() {
   local timing=
   local strict=
   local unknown=
-  local list=
-  local sorted=
   for arg in "$@"; do
     if [ "$arg" = --help ]; then
       usage text
       exit 0
     elif [ "$arg" = --list-checks ]; then
-      list=1
-    elif [ "$arg" = --sorted ]; then
-      sorted=1
+      local listed
+      for listed in $CHECKS; do
+        emit text '%s\n' "$(label "$listed")"
+      done
+      exit 0
     elif [ "$arg" = --quiet ]; then
       quiet=1
     elif [ "$arg" = --json ]; then
@@ -135,15 +157,6 @@ main() {
     fi
   done
 
-  if [ -n "$list" ]; then
-    if [ -n "$sorted" ]; then
-      sorted_checks
-    else
-      printf '%s\n' $CHECKS
-    fi
-    exit 0
-  fi
-
   if [ -n "$strict" ] && [ -n "$unknown" ]; then
     printf 'unknown flag: %s\n' "$unknown" >&2
     exit 2

scripts/test_healthcheck.sh

@@ -7,7 +7,19 @@ NAMES='repo_root_readable scripts_dir_present healthcheck_executable_bit
 selftest_present test_healthcheck_present readme_present
 no_crlf_line_endings no_tabs_in_scripts
 shebang_is_bash usage_text_mentions_every_flag'
-USAGE="$(printf 'Usage: orchestra_e2e_healthcheck.sh [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks] [--sorted]\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  --json   Print a single-line JSON result; still exits 0.\n  --help   Print this usage text and exit 0.\n  --summary  Print one line per check before the success message.\n  --timing Print elapsed milliseconds for the run.\n  --strict Reject an unrecognised flag: exits 2.\n  --list-checks  Print the name of each check; exits 0.\n  --sorted  With --list-checks, list the names alphabetically.\n\nChecks:\n  repo_root_readable\n  scripts_dir_present\n  healthcheck_executable_bit\n  selftest_present\n  test_healthcheck_present\n  readme_present\n  no_crlf_line_endings\n  no_tabs_in_scripts\n  shebang_is_bash\n  usage_text_mentions_every_flag\n\nVersion: 1.0.0')"
+LABELS='repo_root_readable: the repository root exists and is readable
+scripts_dir_present: the scripts directory exists
+healthcheck_executable_bit: this script is executable
+selftest_present: the selftest script is present
+test_healthcheck_present: the healthcheck test is present
+readme_present: README.md is present
+no_crlf_line_endings: no tracked text file uses CRLF endings
+no_tabs_in_scripts: no script indents with tabs
+shebang_is_bash: every script declares the bash shebang
+usage_text_mentions_every_flag: the usage text lists every flag'
+USAGE="$(printf 'Usage: orchestra_e2e_healthcheck.sh [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks]\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  --json   Print a single-line JSON result; still exits 0.\n  --help   Print this usage text and exit 0.\n  --summary  Print one line per check before the success message.\n  --timing Print elapsed milliseconds for the run.\n  --strict Reject an unrecognised flag: exits 2.\n  --list-checks  Print the name of each check; exits 0.\n\nChecks:\n'
+  while IFS= read -r line; do printf '  %s\n' "$line"; done <<<"$LABELS"
+  printf '\nVersion: 1.0.0')"
 fails=0
 
 check() { # check <expected-stdout> <label> [args...]
@@ -57,22 +69,12 @@ fi
 
 # --list-checks prints one name per line and nothing else.
 listed=$(bash "$HC" --list-checks 2>/dev/null)
-want_listed=$(printf '%s\n' $NAMES)
+want_listed=$LABELS
 if [ "$listed" != "$want_listed" ]; then
   printf 'FAIL: --list-checks\n---got---\n%s\n---want---\n%s\n' "$listed" "$want_listed"
   fails=$((fails + 1))
 fi
 
-# --sorted lists the names alphabetically, in either argument order.
-want_sorted=$(printf '%s\n' $NAMES | LC_ALL=C sort)
-for args in '--list-checks --sorted' '--sorted --list-checks'; do
-  sorted_out=$(bash "$HC" $args 2>/dev/null)
-  if [ "$sorted_out" != "$want_sorted" ]; then
-    printf 'FAIL: %s\n---got---\n%s\n---want---\n%s\n' "$args" "$sorted_out" "$want_sorted"
-    fails=$((fails + 1))
-  fi
-done
-
 # --summary prints one name: outcome line per check, then the success line.
 summary_out=$(bash "$HC" --summary 2>/dev/null)
 for name in $NAMES; do