Print the check count in the summary header #35
@@ -1,25 +1,41 @@
|
||||
# Task 06G4M6HF1Z3EREX1X3NEKSHP24
|
||||
# Task 06G4XAFH1MBPC35VSJN7V3NS14
|
||||
|
||||
Name the healthcheck success message once
|
||||
Print the check count in the summary header
|
||||
|
||||
- Project: test-e2e
|
||||
- Source: burnin/run14-a
|
||||
- Source: gitea:test-e2e/34
|
||||
- Priority: 0
|
||||
|
||||
## 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.
|
||||
`--summary` prints one line per check. Add a header line `running <n> checks` before those lines, where n is the number about to run.
|
||||
|
||||
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 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
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
|
||||
## Quality gate
|
||||
|
||||
bash -n scripts/*.sh && bash scripts/orchestra_e2e_healthcheck.sh
|
||||
Acceptance:
|
||||
- --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.
|
||||
@@ -82,7 +85,7 @@ usage() {
|
||||
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'
|
||||
@@ -133,6 +136,14 @@ main() {
|
||||
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
|
||||
@@ -142,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
|
||||
|
||||
@@ -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]\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]\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...]
|
||||
@@ -76,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