smolkik_adm/agency-agents
1
0
Fork 0
mirror of https://github.com/msitarzewski/agency-agents.git synced 2026-10-12 05:35:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(cli): an unknown option exits 1; convert.sh --help shows every option

Browse Source 
Both scripts handled an unknown option with `error ...; usage`, and usage()
always ended in `exit 0`:

  $ ./scripts/convert.sh --tol codex; echo $?
  [ERR] Unknown option: --tol
  ...usage...
  0

so a mistyped flag in CI or a wrapper script read as success. usage() now
takes a status. --help still prints to stdout and exits 0; an unknown
option prints the usage text to stderr and exits 1, the same as a bad
--tool or --division value already does.

convert.sh --help also printed a hard-coded `sed -n '3,28p'`. The option
notes live on lines 33-34, so --parallel and --jobs never appeared, and
--out was only in the synopsis. It now uses USAGE-START/END sentinels, as
install.sh has for a while, and the option list covers --tool and --out.

test-cli-usage.sh checks both scripts: an unknown option exits non-zero
with its name and the usage on stderr and nothing on stdout, --help exits 0
without printing the sentinels, and convert.sh --help describes --tool,
--out, --parallel and --jobs. It fails on main at the first check and runs
in check-tools.yml.
This commit is contained in:
hotragn
2026-09-30 05:02:50 -04:00
parent 765be42358
commit bdb3143fcd
4 changed files with 64 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/test-cli-usage.sh
Executable
+35
View File
@@ -0,0 +1,35 @@
#!/usr/bin/env bash
# convert.sh and install.sh: --help documents every option and exits 0; an
# unknown option exits non-zero with the usage text on stderr.
#
# Both scripts used to call usage() after "Unknown option", and usage() always
# exited 0, so `convert.sh --tol codex` in CI or a wrapper read as success.
# convert.sh's --help also printed a hard-coded line range that stopped above
# --parallel, --jobs and --out.
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
tmp="$(mktemp -d "${TMPDIR:-/tmp}/agency-cli-usage.XXXXXX")"
trap 'rm -rf "$tmp"' EXIT
fail() { echo "FAIL: $*" >&2; exit 1; }
for script in convert.sh install.sh; do
status=0
bash "$SCRIPT_DIR/$script" --no-such-flag > "$tmp/out" 2> "$tmp/err" || status=$?
[[ "$status" -ne 0 ]] || fail "$script --no-such-flag exited 0"
grep -q 'Unknown option: --no-such-flag' "$tmp/err" || fail "$script did not name the unknown option on stderr"
grep -q 'Usage:' "$tmp/err" || fail "$script did not print usage on stderr for an unknown option"
[[ ! -s "$tmp/out" ]] || fail "$script wrote to stdout for an unknown option"
bash "$SCRIPT_DIR/$script" --help > "$tmp/help" 2>&1 || fail "$script --help exited non-zero"
grep -q 'Usage:' "$tmp/help" || fail "$script --help printed no usage"
! grep -q 'USAGE-START\|USAGE-END' "$tmp/help" || fail "$script --help printed its sentinel lines"
done
for opt in --tool --out --parallel --jobs; do
grep -q -- "^ $opt " <(bash "$SCRIPT_DIR/convert.sh" --help) \
|| fail "convert.sh --help does not describe $opt"
done
echo "PASS: unknown options exit non-zero with usage on stderr; --help documents every convert.sh option"