Integrate the six open burn-in pull requests #23
@@ -6,7 +6,8 @@ readonly ROOT=$(cd "$(dirname "$0")/.." && pwd)
|
||||
# Space-separated check names; each has a check_<name> function.
|
||||
CHECKS="repo_root_readable scripts_dir_present healthcheck_executable_bit
|
||||
selftest_present test_healthcheck_present readme_present
|
||||
no_crlf_line_endings no_tabs_in_scripts"
|
||||
no_crlf_line_endings no_tabs_in_scripts
|
||||
shebang_is_bash usage_text_mentions_every_flag"
|
||||
|
||||
# name=ok / name=fail pairs, in run order.
|
||||
RESULTS=
|
||||
@@ -37,6 +38,25 @@ check_no_tabs_in_scripts() {
|
||||
! grep -q "$(printf '\t')" "$ROOT"/scripts/*.sh 2>/dev/null
|
||||
}
|
||||
|
||||
check_shebang_is_bash() {
|
||||
[ -d "$ROOT/scripts" ] || return 1
|
||||
local f
|
||||
for f in "$ROOT"/scripts/*.sh; do
|
||||
[ "$(head -n 1 "$f")" = '#!/usr/bin/env bash' ] || return 1
|
||||
done
|
||||
}
|
||||
|
||||
check_usage_text_mentions_every_flag() {
|
||||
local text flag
|
||||
text=$(usage text)
|
||||
for flag in --quiet --json --help; do
|
||||
case "$text" in
|
||||
*"$flag"*) ;;
|
||||
*) return 1 ;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
# emit <format> <template> [args...]: the single output path.
|
||||
# format: text or json print; none suppresses (--quiet). Explicit argument,
|
||||
# never read from an enclosing variable.
|
||||
@@ -46,16 +66,29 @@ emit() {
|
||||
[ "$format" = none ] || printf "$@"
|
||||
}
|
||||
|
||||
# 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]\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" '\nChecks:\n'
|
||||
local name
|
||||
for name in $CHECKS; do
|
||||
emit "$1" ' %s\n' "$name"
|
||||
done
|
||||
emit "$1" '\nVersion: %s\n' "$VERSION"
|
||||
}
|
||||
|
||||
main() {
|
||||
local quiet=
|
||||
local json=
|
||||
for arg in "$@"; do
|
||||
if [ "$arg" = --help ]; then
|
||||
emit text 'Usage: %s [--quiet]\n\n' "${0##*/}"
|
||||
emit text 'Healthcheck script for Orchestra E2E tests.\n'
|
||||
emit text 'Exits 0 with a success message if all checks pass.\n'
|
||||
emit text ' --quiet Suppress the success message; still exits 0.\n'
|
||||
emit text 'Version: %s\n' "$VERSION"
|
||||
usage text
|
||||
exit 0
|
||||
elif [ "$arg" = --quiet ]; then
|
||||
quiet=1
|
||||
|
||||
@@ -3,7 +3,11 @@
|
||||
|
||||
HC="$(dirname "$0")/orchestra_e2e_healthcheck.sh"
|
||||
OK='OK - all healthchecks passed'
|
||||
USAGE="$(printf 'Usage: orchestra_e2e_healthcheck.sh [--quiet]\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.\nVersion: 1.0.0')"
|
||||
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]\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\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...]
|
||||
@@ -17,6 +21,18 @@ check() { # check <expected-stdout> <label> [args...]
|
||||
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
|
||||
@@ -24,5 +40,20 @@ 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
|
||||
|
||||
[ "$fails" -eq 0 ] || exit 1
|
||||
printf 'all checks passed\n'
|
||||
|
||||
Reference in New Issue
Block a user