Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| ba72c3624c | |||
| fe0453ef16 |
@@ -1,20 +1,20 @@
|
||||
# Task 06G4WDJ06G7FK00QF73Z9DDBT4
|
||||
# Task 06G54DZYGP30QXM4SXDB1NF1E0
|
||||
|
||||
Sort the check names in --list-checks
|
||||
Report the slowest check in the summary footer
|
||||
|
||||
- Project: test-e2e
|
||||
- Source: gitea:test-e2e/27
|
||||
- Source: gitea:test-e2e/36
|
||||
- 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.
|
||||
`--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 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.
|
||||
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,9 +34,8 @@ 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:
|
||||
- `--list-checks --sorted` prints the ten names alphabetically.
|
||||
- `--list-checks` alone keeps run order.
|
||||
- Every other flag is unchanged.
|
||||
- --summary ends with the slowest line.
|
||||
- --quiet suppresses it, and every other flag is unchanged.
|
||||
|
||||
## Completion
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -76,17 +78,16 @@ emit() {
|
||||
# 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'
|
||||
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'
|
||||
emit "$1" ' --sorted With --list-checks, list the names alphabetically.\n'
|
||||
emit "$1" '\nChecks:\n'
|
||||
local name
|
||||
for name in $CHECKS; do
|
||||
@@ -95,12 +96,6 @@ usage() {
|
||||
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 +105,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' "$listed"
|
||||
done
|
||||
exit 0
|
||||
elif [ "$arg" = --quiet ]; then
|
||||
quiet=1
|
||||
elif [ "$arg" = --json ]; then
|
||||
@@ -135,27 +130,20 @@ 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
|
||||
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
|
||||
@@ -192,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
-12
@@ -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] [--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')"
|
||||
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...]
|
||||
@@ -63,16 +63,6 @@ if [ "$listed" != "$want_listed" ]; then
|
||||
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
|
||||
@@ -81,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
|
||||
|
||||
Reference in New Issue
Block a user