Report the slowest check in the summary footer #37

Open
kami wants to merge 2 commits from orchestra/06G54DZYGP30QXM4SXDB1NF1E0 into master
2 changed files with 29 additions and 4 deletions
Showing only changes of commit ba72c3624c - Show all commits
+19 -2
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
@@ -82,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 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'
@@ -133,13 +135,15 @@ main() {
exit 2
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
@@ -176,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 -2
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 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,10 +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
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