diff --git a/TASK.md b/TASK.md index c450007..d9b142f 100644 --- a/TASK.md +++ b/TASK.md @@ -1,25 +1,43 @@ -# Task 06G4M6HF1Z3EREX1X3NEKSHP24 +# Task 06G4WJ9T4F35NZC4Z8QQXM9Z6G -Name the healthcheck success message once +Add a --count flag that prints how many checks ran - Project: test-e2e -- Source: burnin/run14-a +- Source: gitea:test-e2e/29 - 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. +Give scripts/orchestra_e2e_healthcheck.sh a `--count` flag that prints `checks: ` before the success line, where n is the number of checks that ran. -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 FOUR phases: + +1. A counter incremented by the existing dispatch loop, with no output change. +2. The `--count` flag parsed and stored, still with no output change. +3. `--count` printing `checks: ` before the success line, and composing with --quiet and --json. +4. 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. Take the phases strictly in order. + +## Verification policy for this project + +Only two commands may appear on a run: line, exactly: + +- ["bash", "-n", ""] +- ["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: +- `--count` prints the number of checks that ran. +- `--quiet` suppresses it, `--json` carries it as a field. +- Every other flag is unchanged. ## Completion diff --git a/scripts/orchestra_e2e_healthcheck.sh b/scripts/orchestra_e2e_healthcheck.sh index f6fa7ee..676b7ca 100755 --- a/scripts/orchestra_e2e_healthcheck.sh +++ b/scripts/orchestra_e2e_healthcheck.sh @@ -13,6 +13,7 @@ shebang_is_bash usage_text_mentions_every_flag" # name=ok / name=fail pairs, in run order. RESULTS= FAILED=0 +# TOTAL is the number of checks that ran, reported by --count. TOTAL=0 # record : append one outcome to the results state. @@ -76,7 +77,7 @@ emit() { # usage : 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]\n\n' "${0##*/}" + emit "$1" 'Usage: %s [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks] [--count]\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' @@ -86,6 +87,7 @@ usage() { 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" ' --count Print the number of checks that ran.\n' emit "$1" '\nChecks:\n' local name for name in $CHECKS; do @@ -102,6 +104,7 @@ main() { local summary= local timing= local strict= + local count= local unknown= for arg in "$@"; do if [ "$arg" = --help ]; then @@ -123,6 +126,8 @@ main() { timing=1 elif [ "$arg" = --strict ]; then strict=1 + elif [ "$arg" = --count ]; then + count=1 else [ -n "$unknown" ] || unknown=$arg fi @@ -175,6 +180,10 @@ main() { emit "$format" 'healthchecks: %sms\n' "$elapsed" fi + if [ -n "$count" ]; then + emit "$format" 'checks: %s\n' "$TOTAL" + fi + emit "$format" '%s\n' "$SUCCESS_MESSAGE" exit 0 } diff --git a/scripts/test_healthcheck.sh b/scripts/test_healthcheck.sh index 3b7cfea..b498388 100755 --- a/scripts/test_healthcheck.sh +++ b/scripts/test_healthcheck.sh @@ -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] [--count]\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 --count Print the number of checks that ran.\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