Print the healthcheck version in --json output #33

Open
kami wants to merge 2 commits from orchestra/06G4WW6TND26M16CZA6WE5T458 into master
3 changed files with 36 additions and 13 deletions
+26 -10
View File
@@ -1,25 +1,41 @@
# Task 06G4M6HF1Z3EREX1X3NEKSHP24
# Task 06G4WW6TND26M16CZA6WE5T458
Name the healthcheck success message once
Print the healthcheck version in --json output
- Project: test-e2e
- Source: burnin/run14-a
- Source: gitea:test-e2e/32
- 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.
`--json` prints `{"status":"ok","checks":<n>}`. Add the script's VERSION to that object as a `version` field, leaving every other output 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 JSON body as a string, with the current fields and no behaviour change.
2. The `version` field added to that helper's output.
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:
- `--json` carries a version field with the script's VERSION.
- --quiet, --summary, --timing, --strict and --help are unchanged.
## Completion
+7 -2
View File
@@ -73,6 +73,11 @@ emit() {
[ "$format" = none ] || printf "$@"
}
# json_body <checks> <timings>: the --json object, no trailing newline.
json_body() {
printf '{"status":"ok","checks":%d,"version":"%s"%s}' "$1" "$VERSION" "$2"
}
# usage <format>: the --help body. Also the source check_usage_text_mentions_every_flag
# reads, so the flag list has exactly one home.
usage() {
@@ -80,7 +85,7 @@ usage() {
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" ' --json Print a single-line JSON result with the version; 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" ' --timing Print elapsed milliseconds for the run.\n'
@@ -160,7 +165,7 @@ main() {
if [ "$format" = json ]; then
local timings=
[ -n "$timing" ] && timings=",\"timings\":{\"healthchecks\":$elapsed}"
emit "$format" '{"status":"ok","checks":%d%s}\n' "$TOTAL" "$timings"
emit "$format" '%s\n' "$(json_body "$TOTAL" "$timings")"
exit 0
fi
+3 -1
View File
@@ -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 with the version; 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')"
fails=0
check() { # check <expected-stdout> <label> [args...]
@@ -79,6 +79,8 @@ esac
# --timing prints an elapsed line, and composes with --json and --quiet.
contains 'healthchecks:' '--timing' --timing
contains '"timings":{"healthchecks":' '--timing --json' --timing --json
contains '"version":"1.0.0"' '--json version' --json
contains '"version":"1.0.0"' '--timing --json version' --timing --json
check '' '--timing --quiet' --timing --quiet
# --strict rejects an unrecognised flag; on its own it changes nothing.