Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4627935410 | |||
| 5703966881 | |||
| 01f7418f18 | |||
| 6d05338510 |
@@ -1,37 +1,25 @@
|
||||
# Task 06G4W63545T3RV8SSKGKN11B3G
|
||||
# Task 06G4WJ9T4F35NZC4Z8QQXM9Z6G
|
||||
|
||||
Run a single named check with --only
|
||||
Add a --count flag that prints how many checks ran
|
||||
|
||||
- Project: test-e2e
|
||||
- Source: gitea:test-e2e/26
|
||||
- Source: gitea:test-e2e/29
|
||||
- Priority: 0
|
||||
|
||||
## Instructions
|
||||
|
||||
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.
|
||||
Give scripts/orchestra_e2e_healthcheck.sh a `--count` flag that prints `checks: <n>` before the success line, where n is the number of checks that ran.
|
||||
|
||||
Behaviour:
|
||||
Plan this as FOUR phases:
|
||||
|
||||
- `--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.
|
||||
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: <n>` 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. 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.
|
||||
Implement phase N, request its verification, and only then begin phase N+1. Take the phases strictly in order.
|
||||
|
||||
## Verification policy for this project
|
||||
|
||||
@@ -40,21 +28,16 @@ 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.
|
||||
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.
|
||||
|
||||
## Handoff behaviour
|
||||
|
||||
Behave normally. If Orchestra asks you to write a handoff report, write it and stop.
|
||||
|
||||
Acceptance:
|
||||
- `--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.
|
||||
- `--count` prints the number of checks that ran.
|
||||
- `--quiet` suppresses it, `--json` carries it as a field.
|
||||
- Every other flag is unchanged.
|
||||
|
||||
## Completion
|
||||
|
||||
|
||||
@@ -10,17 +10,10 @@ selftest_present test_healthcheck_present readme_present
|
||||
no_crlf_line_endings no_tabs_in_scripts
|
||||
shebang_is_bash usage_text_mentions_every_flag"
|
||||
|
||||
# check_exists <name>: true when <name> is one of the CHECKS names.
|
||||
check_exists() {
|
||||
case " $(printf '%s ' $CHECKS) " in
|
||||
*" $1 "*) return 0 ;;
|
||||
esac
|
||||
return 1
|
||||
}
|
||||
|
||||
# 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 <name> <status>: append one outcome to the results state.
|
||||
@@ -84,7 +77,7 @@ emit() {
|
||||
# usage <format>: 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] [--only <name>]\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'
|
||||
@@ -94,7 +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" ' --only <name> Run only the named check; exits 2 if unknown.\n'
|
||||
emit "$1" ' --count Print the number of checks that ran.\n'
|
||||
emit "$1" '\nChecks:\n'
|
||||
local name
|
||||
for name in $CHECKS; do
|
||||
@@ -111,17 +104,10 @@ main() {
|
||||
local summary=
|
||||
local timing=
|
||||
local strict=
|
||||
local count=
|
||||
local unknown=
|
||||
local only=
|
||||
local expect_only=
|
||||
for arg in "$@"; do
|
||||
if [ -n "$expect_only" ]; then
|
||||
only=$arg
|
||||
expect_only=
|
||||
continue
|
||||
elif [ "$arg" = --only ]; then
|
||||
expect_only=1
|
||||
elif [ "$arg" = --help ]; then
|
||||
if [ "$arg" = --help ]; then
|
||||
usage text
|
||||
exit 0
|
||||
elif [ "$arg" = --list-checks ]; then
|
||||
@@ -140,31 +126,20 @@ main() {
|
||||
timing=1
|
||||
elif [ "$arg" = --strict ]; then
|
||||
strict=1
|
||||
elif [ "$arg" = --count ]; then
|
||||
count=1
|
||||
else
|
||||
[ -n "$unknown" ] || unknown=$arg
|
||||
fi
|
||||
done
|
||||
|
||||
if [ -n "$expect_only" ]; then
|
||||
printf -- '--only requires a check name\n' >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
if [ -n "$only" ] && ! check_exists "$only"; then
|
||||
printf 'unknown check: %s\n' "$only" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
if [ -n "$strict" ] && [ -n "$unknown" ]; then
|
||||
printf 'unknown flag: %s\n' "$unknown" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
local to_run=$CHECKS
|
||||
[ -n "$only" ] && to_run=$only
|
||||
|
||||
local name
|
||||
for name in $to_run; do
|
||||
for name in $CHECKS; do
|
||||
if "check_$name"; then
|
||||
record "$name" ok
|
||||
else
|
||||
@@ -205,12 +180,12 @@ 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
|
||||
}
|
||||
|
||||
main "$@"
|
||||
|
||||
# Rig: an operator edit made after phase-1 was signed off.
|
||||
|
||||
# Rig: a second tree move, with no new sign-off.
|
||||
|
||||
@@ -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] [--only <name>]\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 --only <name> Run only the named check; exits 2 if unknown.\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 <expected-stdout> <label> [args...]
|
||||
@@ -90,35 +90,13 @@ if [ "$strict_status" -ne 2 ] || [ "${strict_out#*unknown flag}" = "$strict_out"
|
||||
fi
|
||||
check "$OK" '--strict alone' --strict
|
||||
|
||||
# --only runs exactly one check and composes with the output flags.
|
||||
check "$OK" '--only' --only repo_root_readable
|
||||
check '' '--only --quiet' --only repo_root_readable --quiet
|
||||
check '{"status":"ok","checks":1}' '--only --json' --only repo_root_readable --json
|
||||
|
||||
only_summary=$(bash "$HC" --only repo_root_readable --summary 2>/dev/null)
|
||||
want_only_summary=$(printf 'repo_root_readable: ok\n%s' "$OK")
|
||||
if [ "$only_summary" != "$want_only_summary" ]; then
|
||||
printf 'FAIL: --only --summary\n---got---\n%s\n---want---\n%s\n' \
|
||||
"$only_summary" "$want_only_summary"
|
||||
fails=$((fails + 1))
|
||||
fi
|
||||
|
||||
# An unknown check name refuses on stderr with exit 2.
|
||||
only_out=$(bash "$HC" --only nonsense 2>&1)
|
||||
only_status=$?
|
||||
if [ "$only_status" -ne 2 ] || [ "${only_out#*unknown check}" = "$only_out" ]; then
|
||||
printf 'FAIL: --only nonsense (exit=%s)\n---got---\n%s\n' "$only_status" "$only_out"
|
||||
fails=$((fails + 1))
|
||||
fi
|
||||
|
||||
# --only with no value refuses with exit 2.
|
||||
missing_only=$(bash "$HC" --only 2>&1)
|
||||
missing_status=$?
|
||||
if [ "$missing_status" -ne 2 ]; then
|
||||
printf 'FAIL: --only with no value (exit=%s)\n---got---\n%s\n' \
|
||||
"$missing_status" "$missing_only"
|
||||
fails=$((fails + 1))
|
||||
fi
|
||||
# --count prints the number of checks that ran, and composes with the others.
|
||||
check "checks: 10
|
||||
$OK" '--count' --count
|
||||
check '' '--count --quiet' --count --quiet
|
||||
check '{"status":"ok","checks":10}' '--count --json' --count --json
|
||||
check "checks: 10
|
||||
$OK" '--strict --count' --strict --count
|
||||
|
||||
[ "$fails" -eq 0 ] || exit 1
|
||||
printf 'all checks passed\n'
|
||||
|
||||
Reference in New Issue
Block a user