Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 49635d38e6 | |||
| 0312dd9871 |
@@ -1,25 +1,42 @@
|
|||||||
# Task 06G4M6HF1Z3EREX1X3NEKSHP24
|
# Task 06G4WDJ06G7FK00QF73Z9DDBT4
|
||||||
|
|
||||||
Name the healthcheck success message once
|
Sort the check names in --list-checks
|
||||||
|
|
||||||
- Project: test-e2e
|
- Project: test-e2e
|
||||||
- Source: burnin/run14-a
|
- Source: gitea:test-e2e/27
|
||||||
- Priority: 0
|
- Priority: 0
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
scripts/orchestra_e2e_healthcheck.sh spells its success message inline. Give it a single named constant beside the existing VERSION constant and use that constant everywhere the message is printed.
|
`--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.
|
||||||
|
|
||||||
Behaviour must not change. The plain run, --quiet and --help keep their current output and exit statuses, and scripts/test_healthcheck.sh keeps passing.
|
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.
|
||||||
|
|
||||||
|
## Work one phase at a time
|
||||||
|
|
||||||
|
Implement phase N, request its verification, and only then begin phase N+1.
|
||||||
|
|
||||||
|
## Verification policy for this project
|
||||||
|
|
||||||
|
Only two commands may appear on a run: line, exactly:
|
||||||
|
|
||||||
|
- ["bash", "-n", "<path>"]
|
||||||
|
- ["bash", "scripts/orchestra_e2e_healthcheck.sh"]
|
||||||
|
|
||||||
|
Anything else is refused when you seal the plan. Give every phase at least one automated check from that list and at least one manual check.
|
||||||
|
|
||||||
## Research first
|
## Research first
|
||||||
|
|
||||||
Establish at least three findings with distinct confidence: at least one `fact`, one `inference`, one `assumption`.
|
Establish at least three findings with distinct confidence: at least one fact, one inference, one assumption.
|
||||||
|
|
||||||
|
Acceptance:
|
||||||
## Quality gate
|
- `--list-checks --sorted` prints the ten names alphabetically.
|
||||||
|
- `--list-checks` alone keeps run order.
|
||||||
bash -n scripts/*.sh && bash scripts/orchestra_e2e_healthcheck.sh
|
- Every other flag is unchanged.
|
||||||
|
|
||||||
## Completion
|
## Completion
|
||||||
|
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ emit() {
|
|||||||
# usage <format>: the --help body. Also the source check_usage_text_mentions_every_flag
|
# usage <format>: the --help body. Also the source check_usage_text_mentions_every_flag
|
||||||
# reads, so the flag list has exactly one home.
|
# reads, so the flag list has exactly one home.
|
||||||
usage() {
|
usage() {
|
||||||
emit "$1" 'Usage: %s [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks]\n\n' "${0##*/}"
|
emit "$1" 'Usage: %s [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks] [--sorted]\n\n' "${0##*/}"
|
||||||
emit "$1" 'Healthcheck script for Orchestra E2E tests.\n'
|
emit "$1" 'Healthcheck script for Orchestra E2E tests.\n'
|
||||||
emit "$1" 'Exits 0 with a success message if all checks pass.\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" ' --quiet Suppress the success message; still exits 0.\n'
|
||||||
@@ -86,6 +86,7 @@ usage() {
|
|||||||
emit "$1" ' --timing Print elapsed milliseconds for the run.\n'
|
emit "$1" ' --timing Print elapsed milliseconds for the run.\n'
|
||||||
emit "$1" ' --strict Reject an unrecognised flag: exits 2.\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" ' --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'
|
emit "$1" '\nChecks:\n'
|
||||||
local name
|
local name
|
||||||
for name in $CHECKS; do
|
for name in $CHECKS; do
|
||||||
@@ -94,6 +95,12 @@ usage() {
|
|||||||
emit "$1" '\nVersion: %s\n' "$VERSION"
|
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() {
|
main() {
|
||||||
local start_us
|
local start_us
|
||||||
start_us=$(now_us)
|
start_us=$(now_us)
|
||||||
@@ -103,16 +110,16 @@ main() {
|
|||||||
local timing=
|
local timing=
|
||||||
local strict=
|
local strict=
|
||||||
local unknown=
|
local unknown=
|
||||||
|
local list=
|
||||||
|
local sorted=
|
||||||
for arg in "$@"; do
|
for arg in "$@"; do
|
||||||
if [ "$arg" = --help ]; then
|
if [ "$arg" = --help ]; then
|
||||||
usage text
|
usage text
|
||||||
exit 0
|
exit 0
|
||||||
elif [ "$arg" = --list-checks ]; then
|
elif [ "$arg" = --list-checks ]; then
|
||||||
local listed
|
list=1
|
||||||
for listed in $CHECKS; do
|
elif [ "$arg" = --sorted ]; then
|
||||||
emit text '%s\n' "$listed"
|
sorted=1
|
||||||
done
|
|
||||||
exit 0
|
|
||||||
elif [ "$arg" = --quiet ]; then
|
elif [ "$arg" = --quiet ]; then
|
||||||
quiet=1
|
quiet=1
|
||||||
elif [ "$arg" = --json ]; then
|
elif [ "$arg" = --json ]; then
|
||||||
@@ -128,6 +135,15 @@ main() {
|
|||||||
fi
|
fi
|
||||||
done
|
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
|
if [ -n "$strict" ] && [ -n "$unknown" ]; then
|
||||||
printf 'unknown flag: %s\n' "$unknown" >&2
|
printf 'unknown flag: %s\n' "$unknown" >&2
|
||||||
exit 2
|
exit 2
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ NAMES='repo_root_readable scripts_dir_present healthcheck_executable_bit
|
|||||||
selftest_present test_healthcheck_present readme_present
|
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'
|
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] [--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')"
|
||||||
fails=0
|
fails=0
|
||||||
|
|
||||||
check() { # check <expected-stdout> <label> [args...]
|
check() { # check <expected-stdout> <label> [args...]
|
||||||
@@ -63,6 +63,16 @@ if [ "$listed" != "$want_listed" ]; then
|
|||||||
fails=$((fails + 1))
|
fails=$((fails + 1))
|
||||||
fi
|
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 prints one name: outcome line per check, then the success line.
|
||||||
summary_out=$(bash "$HC" --summary 2>/dev/null)
|
summary_out=$(bash "$HC" --summary 2>/dev/null)
|
||||||
for name in $NAMES; do
|
for name in $NAMES; do
|
||||||
|
|||||||
Reference in New Issue
Block a user