Compare commits

..

1 Commits

Author SHA1 Message Date
kami f5d8f90b0e orchestra: TASK.md 2026-08-29 19:17:00 +04:00
3 changed files with 38 additions and 46 deletions
+31 -13
View File
@@ -1,24 +1,37 @@
# Task 06G4WDJ06G7FK00QF73Z9DDBT4
# Task 06G4W63545T3RV8SSKGKN11B3G
Sort the check names in --list-checks
Run a single named check with --only
- Project: test-e2e
- Source: gitea:test-e2e/27
- Source: gitea:test-e2e/26
- Priority: 0
## Instructions
`--list-checks` prints the ten check names in the order they run. Add a `--sorted` modifier that prints them in alphabetical order instead, leaving run order untouched.
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. A helper that returns the check names in alphabetical order, with no caller yet.
2. `--sorted` accepted alongside `--list-checks`, using that helper. Alone, `--sorted` changes nothing.
3. The usage text in `--help`, and assertions in scripts/test_healthcheck.sh for both orders.
- `--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,16 +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:
- `--list-checks --sorted` prints the ten names alphabetically.
- `--list-checks` alone keeps run order.
- 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
+6 -22
View File
@@ -76,7 +76,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] [--sorted]\n\n' "${0##*/}"
emit "$1" 'Usage: %s [--quiet] [--json] [--summary] [--timing] [--strict] [--list-checks]\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,7 +86,6 @@ 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" ' --sorted With --list-checks, list the names alphabetically.\n'
emit "$1" '\nChecks:\n'
local name
for name in $CHECKS; do
@@ -95,12 +94,6 @@ usage() {
emit "$1" '\nVersion: %s\n' "$VERSION"
}
# sorted_checks: the check names, one per line, in alphabetical order.
# LC_ALL=C keeps the order fixed if a name with a digit or capital is added.
sorted_checks() {
printf '%s\n' $CHECKS | LC_ALL=C sort
}
main() {
local start_us
start_us=$(now_us)
@@ -110,16 +103,16 @@ main() {
local timing=
local strict=
local unknown=
local list=
local sorted=
for arg in "$@"; do
if [ "$arg" = --help ]; then
usage text
exit 0
elif [ "$arg" = --list-checks ]; then
list=1
elif [ "$arg" = --sorted ]; then
sorted=1
local listed
for listed in $CHECKS; do
emit text '%s\n' "$listed"
done
exit 0
elif [ "$arg" = --quiet ]; then
quiet=1
elif [ "$arg" = --json ]; then
@@ -135,15 +128,6 @@ main() {
fi
done
if [ -n "$list" ]; then
if [ -n "$sorted" ]; then
sorted_checks
else
printf '%s\n' $CHECKS
fi
exit 0
fi
if [ -n "$strict" ] && [ -n "$unknown" ]; then
printf 'unknown flag: %s\n' "$unknown" >&2
exit 2
+1 -11
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] [--sorted]\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 --sorted With --list-checks, list the names alphabetically.\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...]
@@ -63,16 +63,6 @@ if [ "$listed" != "$want_listed" ]; then
fails=$((fails + 1))
fi
# --sorted lists the names alphabetically, in either argument order.
want_sorted=$(printf '%s\n' $NAMES | LC_ALL=C sort)
for args in '--list-checks --sorted' '--sorted --list-checks'; do
sorted_out=$(bash "$HC" $args 2>/dev/null)
if [ "$sorted_out" != "$want_sorted" ]; then
printf 'FAIL: %s\n---got---\n%s\n---want---\n%s\n' "$args" "$sorted_out" "$want_sorted"
fails=$((fails + 1))
fi
done
# --summary prints one name: outcome line per check, then the success line.
summary_out=$(bash "$HC" --summary 2>/dev/null)
for name in $NAMES; do