Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e9e5a84a4c | |||
| 36bcf8a2e1 | |||
| 7c24b6acea |
@@ -1,20 +1,20 @@
|
||||
# Task 06G4WDJ06G7FK00QF73Z9DDBT4
|
||||
# Task 06G4XAFH1MBPC35VSJN7V3NS14
|
||||
|
||||
Sort the check names in --list-checks
|
||||
Print the check count in the summary header
|
||||
|
||||
- Project: test-e2e
|
||||
- Source: gitea:test-e2e/27
|
||||
- Source: gitea:test-e2e/34
|
||||
- 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. Add a header line `running <n> checks` before those lines, where n is the number about to run.
|
||||
|
||||
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. 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.
|
||||
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 prints the header before its per-check lines.
|
||||
- --quiet suppresses it, and every other flag is unchanged.
|
||||
|
||||
## Completion
|
||||
|
||||
|
||||
@@ -64,6 +64,9 @@ 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.
|
||||
@@ -76,17 +79,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 a check count header and one line per check, before the success message.\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 +97,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 +106,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,20 +131,19 @@ 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 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
|
||||
for name in $CHECKS; do
|
||||
if "check_$name"; then
|
||||
@@ -158,10 +153,6 @@ main() {
|
||||
fi
|
||||
done
|
||||
|
||||
local format=text
|
||||
[ -n "$quiet" ] && format=none
|
||||
[ -n "$json" ] && format=json
|
||||
|
||||
if [ "$FAILED" -gt 0 ]; then
|
||||
local entry
|
||||
for entry in $RESULTS; do
|
||||
|
||||
+10
-11
@@ -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 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')"
|
||||
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
|
||||
@@ -86,6 +76,15 @@ case "$summary_out" in
|
||||
*) 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
|
||||
|
||||
# --timing prints an elapsed line, and composes with --json and --quiet.
|
||||
contains 'healthchecks:' '--timing' --timing
|
||||
contains '"timings":{"healthchecks":' '--timing --json' --timing --json
|
||||
|
||||
Reference in New Issue
Block a user