Compare commits

..

2 Commits

Author SHA1 Message Date
kami ba72c3624c orchestra: pre-release WIP snapshot (orchestra-06g54dzygp30qxm4sxdb1nf1e0-6f2befa5) 2026-08-30 14:37:20 +04:00
kami fe0453ef16 orchestra: TASK.md 2026-08-30 14:30:02 +04:00
3 changed files with 40 additions and 31 deletions
+7 -7
View File
@@ -1,19 +1,19 @@
# Task 06G4XAFH1MBPC35VSJN7V3NS14
# Task 06G54DZYGP30QXM4SXDB1NF1E0
Print the check count in the summary header
Report the slowest check in the summary footer
- Project: test-e2e
- Source: gitea:test-e2e/34
- Source: gitea:test-e2e/36
- Priority: 0
## Instructions
`--summary` prints one line per check. Add a header line `running <n> checks` before those lines, where n is the number about to run.
`--summary` prints one line per check. After those lines, print a footer naming the slowest check and its elapsed milliseconds, in the form `slowest: <name> (<n>ms)`.
Plan this as THREE phases:
1. A helper that returns the number of checks that will run, with no output change.
2. The header line printed by --summary, using that helper.
1. Record each check's elapsed milliseconds beside its existing result, with no output change.
2. The footer printed by --summary from those recorded values.
3. The usage text in `--help`, and assertions in scripts/test_healthcheck.sh.
## Work one phase at a time
@@ -34,7 +34,7 @@ Anything else is refused when you seal the plan. Give every phase at least one a
Establish at least three findings with distinct confidence: at least one fact, one inference, one assumption.
Acceptance:
- --summary prints the header before its per-check lines.
- --summary ends with the slowest line.
- --quiet suppresses it, and every other flag is unchanged.
## Completion
+23 -13
View File
@@ -12,6 +12,8 @@ shebang_is_bash usage_text_mentions_every_flag"
# name=ok / name=fail pairs, in run order.
RESULTS=
# name=ms pairs, in run order.
TIMES=
FAILED=0
TOTAL=0
@@ -64,9 +66,6 @@ now_us() { printf '%s' "${EPOCHREALTIME//[!0-9]/}"; }
# elapsed_ms <start-us>: whole milliseconds since <start-us>.
elapsed_ms() { printf '%s' "$(( ($(now_us) - $1) / 1000 ))"; }
# check_count: how many checks the run will execute.
check_count() { set -- $CHECKS; printf '%s' "$#"; }
# emit <format> <template> [args...]: the single output path.
# format: text or json print; none suppresses (--quiet). Explicit argument,
# never read from an enclosing variable.
@@ -85,7 +84,7 @@ usage() {
emit "$1" ' --quiet Suppress the success message; still exits 0.\n'
emit "$1" ' --json Print a single-line JSON result; still exits 0.\n'
emit "$1" ' --help Print this usage text and exit 0.\n'
emit "$1" ' --summary Print a check count header and one line per check, before the success message.\n'
emit "$1" ' --summary Print one line per check before the success message, then the slowest check after it.\n'
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'
@@ -136,23 +135,21 @@ main() {
exit 2
fi
local format=text
[ -n "$quiet" ] && format=none
[ -n "$json" ] && format=json
if [ -n "$summary" ] && [ "$format" != json ]; then
emit "$format" 'running %s checks\n' "$(check_count)"
fi
local name
local name check_start
for name in $CHECKS; do
check_start=$(now_us)
if "check_$name"; then
record "$name" ok
else
record "$name" fail
fi
TIMES="$TIMES $name=$(elapsed_ms "$check_start")"
done
local format=text
[ -n "$quiet" ] && format=none
[ -n "$json" ] && format=json
if [ "$FAILED" -gt 0 ]; then
local entry
for entry in $RESULTS; do
@@ -183,6 +180,19 @@ main() {
fi
emit "$format" '%s\n' "$SUCCESS_MESSAGE"
if [ -n "$summary" ]; then
local slow_name= slow_ms=-1 ms
for entry in $TIMES; do
ms=${entry#*=}
if [ "$ms" -gt "$slow_ms" ]; then
slow_ms=$ms
slow_name=${entry%=*}
fi
done
emit "$format" 'slowest: %s (%sms)\n' "$slow_name" "$slow_ms"
fi
exit 0
}
+10 -11
View File
@@ -7,7 +7,7 @@ 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]\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 a check count header and 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 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')"
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, then the slowest check after it.\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 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')"
fails=0
check() { # check <expected-stdout> <label> [args...]
@@ -71,19 +71,18 @@ for name in $NAMES; do
*) printf 'FAIL: --summary omits %s\n' "$name"; fails=$((fails + 1)) ;;
esac
done
case "$summary_out" in
# The success line, then the slowest footer as the final line.
summary_tail=${summary_out##*$'\n'}
summary_body=${summary_out%$'\n'*}
case "$summary_body" in
*"$OK") ;;
*) printf 'FAIL: --summary does not end with the success line\n'; fails=$((fails + 1)) ;;
esac
# --summary opens with a header naming how many checks will run.
want_header="running $(set -- $NAMES; echo $#) checks"
if [ "${summary_out%%$'\n'*}" != "$want_header" ]; then
printf 'FAIL: --summary header\n---got---\n%s\n---want---\n%s\n' \
"${summary_out%%$'\n'*}" "$want_header"
fails=$((fails + 1))
fi
check '' '--summary --quiet' --summary --quiet
case "$summary_tail" in
'slowest: '*'ms)') ;;
*) printf 'FAIL: --summary does not end with the slowest line\n---got---\n%s\n' "$summary_tail"; fails=$((fails + 1)) ;;
esac
check '' '--quiet --summary' --quiet --summary
# --timing prints an elapsed line, and composes with --json and --quiet.
contains 'healthchecks:' '--timing' --timing