Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f5d8f90b0e |
@@ -1,24 +1,37 @@
|
||||
# Task 06G54DZYGP30QXM4SXDB1NF1E0
|
||||
# Task 06G4W63545T3RV8SSKGKN11B3G
|
||||
|
||||
Report the slowest check in the summary footer
|
||||
Run a single named check with --only
|
||||
|
||||
- Project: test-e2e
|
||||
- Source: gitea:test-e2e/36
|
||||
- Source: gitea:test-e2e/26
|
||||
- Priority: 0
|
||||
|
||||
## Instructions
|
||||
|
||||
`--summary` prints one line per check. After those lines, print a footer naming the slowest check and its elapsed milliseconds, in the form `slowest: <name> (<n>ms)`.
|
||||
Give scripts/orchestra_e2e_healthcheck.sh a `--only <name>` flag that runs a single named check instead of all ten, then prints the usual success line.
|
||||
|
||||
Plan this as THREE phases:
|
||||
Behaviour:
|
||||
|
||||
1. Record each check's elapsed milliseconds beside its existing result, with no output change.
|
||||
2. The footer printed by --summary from those recorded values.
|
||||
3. The usage text in `--help`, and assertions in scripts/test_healthcheck.sh.
|
||||
- `--only repo_root_readable` runs that check alone and exits 0 when it passes.
|
||||
- `--only nonsense` prints `unknown check: nonsense` on stderr and exits 2.
|
||||
- `--only` composes with `--summary`, `--json` and `--quiet`, each keeping its current shape over the single result.
|
||||
- Without `--only`, every existing flag behaves exactly as it does today.
|
||||
|
||||
Plan this as FIVE phases:
|
||||
|
||||
1. A helper that resolves a name to a check function and reports whether the name is known.
|
||||
2. Flag parsing for `--only <name>`, with the unknown-name refusal and exit 2.
|
||||
3. Running the single resolved check and recording its result through the existing results state.
|
||||
4. Composition with `--summary` and `--json`.
|
||||
5. The usage text in `--help`, and assertions in scripts/test_healthcheck.sh for each behaviour above.
|
||||
|
||||
## Work one phase at a time
|
||||
|
||||
Implement phase N, request its verification, and only then begin phase N+1.
|
||||
Implement phase N, request its verification, and only then begin phase N+1. Do not write the whole change first and verify the phases afterwards.
|
||||
|
||||
## Every phase carries both kinds of check
|
||||
|
||||
This is a hard requirement of this task. Each phase must have at least one automated check from the policy below. Each phase must also have at least one manual check, confirmed by a human reading the printed output. Orchestra runs the automated ones. A human owns the manual ones, and the phase is not finished until that human signs it off.
|
||||
|
||||
## Verification policy for this project
|
||||
|
||||
@@ -27,15 +40,21 @@ 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.
|
||||
Anything else is refused when you seal the plan.
|
||||
|
||||
## Research first
|
||||
|
||||
Establish at least three findings with distinct confidence: at least one fact, one inference, one assumption.
|
||||
|
||||
## Handoff behaviour
|
||||
|
||||
Behave normally. If Orchestra asks you to write a handoff report, write it and stop.
|
||||
|
||||
Acceptance:
|
||||
- --summary ends with the slowest line.
|
||||
- --quiet suppresses it, and every other flag is unchanged.
|
||||
- `--only <name>` runs exactly one check.
|
||||
- An unknown name exits 2 with a message on stderr.
|
||||
- `--only` composes with `--summary`, `--json` and `--quiet`.
|
||||
- Every existing flag is unchanged when `--only` is absent.
|
||||
|
||||
## Completion
|
||||
|
||||
|
||||
@@ -12,8 +12,6 @@ shebang_is_bash usage_text_mentions_every_flag"
|
||||
|
||||
# name=ok / name=fail pairs, in run order.
|
||||
RESULTS=
|
||||
# name=ms pairs, in run order.
|
||||
TIMES=
|
||||
FAILED=0
|
||||
TOTAL=0
|
||||
|
||||
@@ -84,7 +82,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, then the slowest check after it.\n'
|
||||
emit "$1" ' --summary Print 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'
|
||||
@@ -135,15 +133,13 @@ main() {
|
||||
exit 2
|
||||
fi
|
||||
|
||||
local name check_start
|
||||
local name
|
||||
for name in $CHECKS; do
|
||||
check_start=$(now_us)
|
||||
if "check_$name"; then
|
||||
record "$name" ok
|
||||
else
|
||||
record "$name" fail
|
||||
fi
|
||||
TIMES="$TIMES $name=$(elapsed_ms "$check_start")"
|
||||
done
|
||||
|
||||
local format=text
|
||||
@@ -180,19 +176,6 @@ main() {
|
||||
fi
|
||||
|
||||
emit "$format" '%s\n' "$SUCCESS_MESSAGE"
|
||||
|
||||
if [ -n "$summary" ]; then
|
||||
local slow_name= slow_ms=-1 ms
|
||||
for entry in $TIMES; do
|
||||
ms=${entry#*=}
|
||||
if [ "$ms" -gt "$slow_ms" ]; then
|
||||
slow_ms=$ms
|
||||
slow_name=${entry%=*}
|
||||
fi
|
||||
done
|
||||
emit "$format" 'slowest: %s (%sms)\n' "$slow_name" "$slow_ms"
|
||||
fi
|
||||
|
||||
exit 0
|
||||
}
|
||||
|
||||
|
||||
@@ -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, then the slowest check after it.\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 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...]
|
||||
@@ -71,18 +71,10 @@ for name in $NAMES; do
|
||||
*) printf 'FAIL: --summary omits %s\n' "$name"; fails=$((fails + 1)) ;;
|
||||
esac
|
||||
done
|
||||
# The success line, then the slowest footer as the final line.
|
||||
summary_tail=${summary_out##*$'\n'}
|
||||
summary_body=${summary_out%$'\n'*}
|
||||
case "$summary_body" in
|
||||
case "$summary_out" in
|
||||
*"$OK") ;;
|
||||
*) printf 'FAIL: --summary does not end with the success line\n'; fails=$((fails + 1)) ;;
|
||||
esac
|
||||
case "$summary_tail" in
|
||||
'slowest: '*'ms)') ;;
|
||||
*) printf 'FAIL: --summary does not end with the slowest line\n---got---\n%s\n' "$summary_tail"; fails=$((fails + 1)) ;;
|
||||
esac
|
||||
check '' '--quiet --summary' --quiet --summary
|
||||
|
||||
# --timing prints an elapsed line, and composes with --json and --quiet.
|
||||
contains 'healthchecks:' '--timing' --timing
|
||||
|
||||
Reference in New Issue
Block a user