mirror of
https://github.com/boshu2/agentops.git
synced 2026-09-14 15:08:13 +08:00
boshu
dbbcbde1b8
Advisory-first rollout, deliberately: shell.preamble-ratchet seeds Blocking:false for ONE clean cycle on main, then flips Blocking — the same staged pattern the epic already landed for docs.cli-snippets (egwt.4) and docs.demoted-claims (egwt.6), recorded in the RepairHint. The backing check itself is fail-closed (exit 1) on every violation class: - new/changed top-level scripts/*.sh must source scripts/lib/preamble.sh or carry a non-empty '# preamble-exempt: <reason>' (empty reason rejected) - grandfather authority = base-ref ∩ working snapshot, so appending an entry in the same diff grants nothing (both halves fail independently) - the snapshot is shrink-only vs. its base-ref version; only the initial snapshot commit may introduce it - scripts/lib/** exempt as a class (sourced libs, not entrypoints) Also folds with_tmpdir (trap-EXIT mktemp cleanup, ~79 re-rolls) and require_cmd (command -v + install-hint die, ~62 re-rolls) into the preamble; 18 preamble bats + 10 ratchet bats.
157 lines
6.4 KiB
Bash
157 lines
6.4 KiB
Bash
#!/usr/bin/env bash
|
|
# shellcheck shell=bash
|
|
# scripts/lib/preamble.sh — sourced library: strict mode + REPO_ROOT + portable stat/find.
|
|
#
|
|
# Source it at the top of a script (do NOT execute it):
|
|
# . "$(CDPATH= cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/lib/preamble.sh"
|
|
#
|
|
# Centralizes two recurring portability hazards (age-0dq9.1 / recon P6a):
|
|
# * macOS `find` is frequently the interactive `bfs` shim (which supports
|
|
# `-printf`) while a script's real /usr/bin/find does NOT — so a find call
|
|
# passes when typed by hand and fails when the script actually runs.
|
|
# * mtime: `stat -f %m` (BSD/macOS) vs `stat -c %Y` (GNU/Linux).
|
|
#
|
|
# Helpers are additive and behavior-preserving; callers are migrated in P6b
|
|
# (age-0dq9.2), not here.
|
|
|
|
# Strict mode is the point of sourcing this.
|
|
set -euo pipefail
|
|
|
|
# REPO_ROOT: the root of the repo this LIBRARY lives in, independent of the
|
|
# caller's CWD. We anchor `git rev-parse` at the lib's OWN directory (`git -C`)
|
|
# so a script run from inside a *different* git checkout can't hijack REPO_ROOT
|
|
# to that other tree. Fall back to the lib's fixed position
|
|
# (<root>/scripts/lib/preamble.sh → two dirs up) when not in a git checkout at
|
|
# all (e.g. an extracted release tarball).
|
|
# `CDPATH=` below is an intentional env-prefix (clears CDPATH for that one cd so
|
|
# a caller's CDPATH can't hijack a relative path), not a botched assignment.
|
|
# shellcheck disable=SC1007
|
|
_preamble_dir="$(CDPATH= cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
if ! REPO_ROOT="$(git -C "$_preamble_dir" rev-parse --show-toplevel 2>/dev/null)"; then
|
|
# shellcheck disable=SC1007
|
|
REPO_ROOT="$(CDPATH= cd "$_preamble_dir/../.." && pwd)"
|
|
fi
|
|
unset _preamble_dir
|
|
export REPO_ROOT
|
|
|
|
# portable_mtime FILE → epoch-seconds mtime. Returns non-zero if neither form
|
|
# works (e.g. file gone).
|
|
#
|
|
# GNU/Linux `stat -c %Y` FIRST, then BSD/macOS `stat -f %m` — the order is
|
|
# load-bearing and the reverse is a real cross-platform bug: on GNU stat, `-f`
|
|
# is `--file-system` (NOT a format flag), so `stat -f %m FILE` does NOT fail
|
|
# cleanly — it returns filesystem data instead of the mtime. Probing the GNU
|
|
# form first is safe because BSD/macOS stat has no `-c` and exits non-zero on it,
|
|
# so the fallback to `stat -f %m` fires correctly.
|
|
portable_mtime() {
|
|
stat -c %Y "$1" 2>/dev/null || stat -f %m "$1"
|
|
}
|
|
|
|
# portable_find DIR [find-args...] → run the REAL system find, never the
|
|
# interactive `bfs` shim, and callers must not pass `-printf` (BSD find lacks
|
|
# it). Prefer /usr/bin/find; fall back to whatever `find` PATH resolves only if
|
|
# the canonical path is missing.
|
|
portable_find() {
|
|
local find_bin=/usr/bin/find
|
|
[ -x "$find_bin" ] || find_bin="$(command -v find)"
|
|
"$find_bin" "$@"
|
|
}
|
|
|
|
# newest_by_mtime FILE... → the single newest existing path by mtime (empty if
|
|
# none exist). Uses a global `sort -n | tail`, NOT `find -exec ls -t | head`
|
|
# (which sorts per-exec-batch and can SIGPIPE the producer — see memory
|
|
# macos-bats-portability-sweep).
|
|
newest_by_mtime() {
|
|
local f mt
|
|
for f in "$@"; do
|
|
[ -e "$f" ] || continue
|
|
mt="$(portable_mtime "$f" 2>/dev/null || true)"
|
|
# Explicit `if` (not `mt && printf`) so a falsey test never trips `set -e`.
|
|
if [ -n "$mt" ]; then
|
|
printf '%s\t%s\n' "$mt" "$f"
|
|
fi
|
|
done | sort -n | tail -n1 | cut -f2-
|
|
}
|
|
|
|
# newest_in_dir DIR NAME_GLOB → newest file under DIR matching NAME_GLOB by
|
|
# mtime (empty if none). Built on portable_find + portable_mtime, so it works
|
|
# identically on macOS and Linux and never relies on `-printf`.
|
|
newest_in_dir() {
|
|
local dir="$1" glob="$2" f mt
|
|
[ -d "$dir" ] || return 0
|
|
while IFS= read -r f; do
|
|
[ -n "$f" ] || continue
|
|
mt="$(portable_mtime "$f" 2>/dev/null || true)"
|
|
if [ -n "$mt" ]; then
|
|
printf '%s\t%s\n' "$mt" "$f"
|
|
fi
|
|
done < <(portable_find "$dir" -type f -name "$glob" 2>/dev/null) | sort -n | tail -n1 | cut -f2-
|
|
}
|
|
|
|
# _preamble_tmpdirs: accumulator of tmpdirs created by with_tmpdir, cleaned by a
|
|
# single EXIT trap. NOT exported (a subshell must not inherit and re-clean the
|
|
# parent's dirs). Space-separated because paths under ${TMPDIR:-/tmp}/<label>.XXX
|
|
# never contain spaces.
|
|
_preamble_tmpdirs=""
|
|
|
|
# _preamble_cleanup_tmpdirs: EXIT-trap body — remove every tmpdir with_tmpdir made.
|
|
_preamble_cleanup_tmpdirs() {
|
|
local d
|
|
for d in $_preamble_tmpdirs; do
|
|
[ -n "$d" ] && rm -rf "$d"
|
|
done
|
|
}
|
|
|
|
# with_tmpdir VARNAME [LABEL] → create a fresh `mktemp -d` under ${TMPDIR:-/tmp},
|
|
# assign its absolute path to the caller variable named VARNAME, and register a
|
|
# single EXIT trap that removes it (and every other with_tmpdir dir) on exit —
|
|
# the exact `TMP="$(mktemp -d)"; trap 'rm -rf "$TMP"' EXIT` pattern re-rolled in
|
|
# ~79 scripts, centralized so the cleanup can't be forgotten and multiple
|
|
# tmpdirs all clean up.
|
|
#
|
|
# with_tmpdir work # $work → /tmp/agentops.XXXXXX
|
|
# with_tmpdir cache mycache # $cache → /tmp/mycache.XXXXXX
|
|
#
|
|
# NOTE: because it installs an EXIT trap, callers must NOT set their own EXIT
|
|
# trap afterward (it would clobber this one). If a caller needs more EXIT work,
|
|
# it should run with_tmpdir first, then add to the trap, or do cleanup itself.
|
|
with_tmpdir() {
|
|
local __varname="${1:-}" label="${2:-agentops}" dir
|
|
if [ -z "$__varname" ]; then
|
|
echo "with_tmpdir: VARNAME required" >&2
|
|
return 2
|
|
fi
|
|
dir="$(mktemp -d "${TMPDIR:-/tmp}/${label}.XXXXXX")"
|
|
_preamble_tmpdirs="$_preamble_tmpdirs $dir"
|
|
# Install (or refresh) the single EXIT trap. Idempotent: the trap body always
|
|
# walks the current accumulator, so re-setting it on each call is harmless.
|
|
trap _preamble_cleanup_tmpdirs EXIT
|
|
# Assign to the caller-named variable without eval (printf -v is bash-native).
|
|
printf -v "$__varname" '%s' "$dir"
|
|
}
|
|
|
|
# require_cmd CMD [INSTALL_HINT] → succeed if CMD is on PATH, else print a clear
|
|
# error (with the optional install hint) to stderr and exit non-zero — the
|
|
# `command -v X >/dev/null || <error+exit>` pattern re-rolled in ~62 scripts.
|
|
# Exits 127 (the shell's "command not found" convention) so callers get a
|
|
# consistent, greppable failure code.
|
|
#
|
|
# require_cmd jq
|
|
# require_cmd gocyclo "go install github.com/fzipp/gocyclo/cmd/gocyclo@latest"
|
|
require_cmd() {
|
|
local cmd="${1:-}" hint="${2:-}"
|
|
if [ -z "$cmd" ]; then
|
|
echo "require_cmd: CMD required" >&2
|
|
return 2
|
|
fi
|
|
if command -v "$cmd" >/dev/null 2>&1; then
|
|
return 0
|
|
fi
|
|
if [ -n "$hint" ]; then
|
|
echo "required command not found: $cmd — install with: $hint" >&2
|
|
else
|
|
echo "required command not found: $cmd" >&2
|
|
fi
|
|
exit 127
|
|
}
|