Compare commits

...

12 Commits

4 changed files with 108 additions and 10 deletions
+28 -4
View File
@@ -1,14 +1,38 @@
# Task 06G4E6F69AKP2PA00S28D7ASBC
# Task 06G4SWEVP71FYYKAV5FV0ZK5ZG
Add a --quiet flag to the healthcheck script
Give the healthcheck a --summary flag
- Project: test-e2e
- Source: gitea:test-e2e/7
- Source: burnin/run16-rotation
- 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 --summary flag that prints one line per check with its result, then the usual success line.
Plan this as three phases, because each piece is independently verifiable:
1. Introduce a results list. Record each check's name and outcome as it runs, with no change to any existing output or exit status.
2. Add the --summary flag. It prints one line per recorded result, then the existing success line.
3. Update the usage text and scripts/test_healthcheck.sh so the expected --help output matches.
## 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. Give every phase at least one automated check from that list, and add a manual check where a human should confirm the printed text.
## 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
+42 -5
View File
@@ -1,20 +1,57 @@
#!/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=
local summary=
local -a results=()
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] [--summary]\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 ' --summary Print one line per check before the success message.\n'
emit text 'Version: %s\n' "$VERSION"
exit 0
elif [ "$arg" = --quiet ]; then
quiet=1
elif [ "$arg" = --json ]; then
json=1
elif [ "$arg" = --summary ]; then
summary=1
fi
done
[ -n "$quiet" ] || printf 'OK - all healthchecks passed\n'
results+=("healthcheck ok")
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
if [ -n "$summary" ]; then
for r in "${results[@]}"; do
emit "$format" '%s: %s\n' "${r%% *}" "${r#* }"
done
fi
emit "$format" 'OK - all healthchecks passed\n'
exit 0
}
+37
View File
@@ -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'
+1 -1
View File
@@ -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] [--summary]\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 --summary Print one line per check before the success message.\nVersion: 1.0.0')"
fails=0
check() { # check <expected-stdout> <label> [args...]