107 lines
4.2 KiB
Bash
Executable File
107 lines
4.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Self-check for orchestra_e2e_healthcheck.sh.
|
|
|
|
HC="$(dirname "$0")/orchestra_e2e_healthcheck.sh"
|
|
OK='OK - all healthchecks passed'
|
|
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'
|
|
LABELS='repo_root_readable: the repository root exists and is readable
|
|
scripts_dir_present: the scripts directory exists
|
|
healthcheck_executable_bit: this script is executable
|
|
selftest_present: the selftest script is present
|
|
test_healthcheck_present: the healthcheck test is present
|
|
readme_present: README.md is present
|
|
no_crlf_line_endings: no tracked text file uses CRLF endings
|
|
no_tabs_in_scripts: no script indents with tabs
|
|
shebang_is_bash: every script declares the bash shebang
|
|
usage_text_mentions_every_flag: the usage text lists 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'
|
|
while IFS= read -r line; do printf ' %s\n' "$line"; done <<<"$LABELS"
|
|
printf '\nVersion: 1.0.0')"
|
|
fails=0
|
|
|
|
check() { # check <expected-stdout> <label> [args...]
|
|
local want=$1 label=$2 got status
|
|
shift 2
|
|
got=$(bash "$HC" "$@" 2>/dev/null)
|
|
status=$?
|
|
if [ "$got" != "$want" ] || [ "$status" -ne 0 ]; then
|
|
printf 'FAIL: %s (exit=%s)\n---got---\n%s\n---want---\n%s\n' "$label" "$status" "$got" "$want"
|
|
fails=$((fails + 1))
|
|
fi
|
|
}
|
|
|
|
contains() { # contains <needle> <label> [args...]
|
|
local want=$1 label=$2 got status
|
|
shift 2
|
|
got=$(bash "$HC" "$@" 2>/dev/null)
|
|
status=$?
|
|
if [ "$status" -ne 0 ] || [ "${got#*"$want"}" = "$got" ]; then
|
|
printf 'FAIL: %s (exit=%s)\n---missing---\n%s\n---in---\n%s\n' \
|
|
"$label" "$status" "$want" "$got"
|
|
fails=$((fails + 1))
|
|
fi
|
|
}
|
|
|
|
check "$OK" 'no args'
|
|
check '' '--quiet' --quiet
|
|
check "$USAGE" '--help' --help
|
|
check "$USAGE" '--help --quiet' --help --quiet
|
|
check "$USAGE" '--quiet --help' --quiet --help
|
|
check "$OK" 'unknown flag ignored' --bogus
|
|
|
|
for name in $NAMES; do
|
|
contains "$name" "--help names $name" --help
|
|
done
|
|
|
|
# All ten names in one run's output.
|
|
help_out=$(bash "$HC" --help 2>/dev/null)
|
|
missing=
|
|
for name in $NAMES; do
|
|
[ "${help_out#*"$name"}" = "$help_out" ] && missing="$missing $name"
|
|
done
|
|
if [ -n "$missing" ]; then
|
|
printf 'FAIL: --help lists all ten check names\n---missing---\n%s\n' "$missing"
|
|
fails=$((fails + 1))
|
|
fi
|
|
|
|
# --list-checks prints one name per line and nothing else.
|
|
listed=$(bash "$HC" --list-checks 2>/dev/null)
|
|
want_listed=$LABELS
|
|
if [ "$listed" != "$want_listed" ]; then
|
|
printf 'FAIL: --list-checks\n---got---\n%s\n---want---\n%s\n' "$listed" "$want_listed"
|
|
fails=$((fails + 1))
|
|
fi
|
|
|
|
# --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
|
|
case "$summary_out" in
|
|
*"$name: ok"*) ;;
|
|
*) printf 'FAIL: --summary omits %s\n' "$name"; fails=$((fails + 1)) ;;
|
|
esac
|
|
done
|
|
case "$summary_out" in
|
|
*"$OK") ;;
|
|
*) printf 'FAIL: --summary does not end with the success line\n'; fails=$((fails + 1)) ;;
|
|
esac
|
|
|
|
# --timing prints an elapsed line, and composes with --json and --quiet.
|
|
contains 'healthchecks:' '--timing' --timing
|
|
contains '"timings":{"healthchecks":' '--timing --json' --timing --json
|
|
check '' '--timing --quiet' --timing --quiet
|
|
|
|
# --strict rejects an unrecognised flag; on its own it changes nothing.
|
|
strict_out=$(bash "$HC" --strict --nonsense 2>&1)
|
|
strict_status=$?
|
|
if [ "$strict_status" -ne 2 ] || [ "${strict_out#*unknown flag}" = "$strict_out" ]; then
|
|
printf 'FAIL: --strict --nonsense (exit=%s)\n---got---\n%s\n' "$strict_status" "$strict_out"
|
|
fails=$((fails + 1))
|
|
fi
|
|
check "$OK" '--strict alone' --strict
|
|
|
|
[ "$fails" -eq 0 ] || exit 1
|
|
printf 'all checks passed\n'
|