Skip to content

fix(bootstrap): define the warn helper #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
royosherove wants to merge 1 commit into
base: main
Choose a base branch
from
+71 −0
Open

fix(bootstrap): define the warn helper #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions deploy/bootstrap.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ step() {
ok() { echo "[OK] $(date -u '+%H:%M:%S') $1"; }
fail() { echo "[FAIL] $(date -u '+%H:%M:%S') $1"; }
info() { echo "[INFO] $(date -u '+%H:%M:%S') $1"; }
warn() { echo "[WARN] $(date -u '+%H:%M:%S') $1"; }

usage() {
cat <<EOF
Expand Down
70 changes: 70 additions & 0 deletions tests/test-bootstrap-helpers.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#!/usr/bin/env bash
# tests/test-bootstrap-helpers.sh — Contract test for the log helpers in
# deploy/bootstrap.sh.
#
# bootstrap.sh runs with "set -euo pipefail". If the script calls a log helper
# (step, ok, fail, info, warn) that it does not define, bash exits with
# "command not found" and the bootstrap stops. This test reads the top-level
# script (it skips heredoc bodies, because they run in a different shell) and
# makes sure that each helper the script calls is also defined.
#
# No AWS required. Run standalone or via CI (discovered by pack-tests.yml).
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
BOOTSTRAP="$REPO_ROOT/deploy/bootstrap.sh"

if [[ ! -f "$BOOTSTRAP" ]]; then
echo "FAIL: bootstrap.sh not found at $BOOTSTRAP" >&2
exit 1
fi

RED='\033[0;31m'; GREEN='\033[0;32m'; BOLD='\033[1m'; NC='\033[0m'
PASS=0; FAIL=0

pass() { printf "${GREEN} \xE2\x9C\x93${NC} %s\n" "$1"; PASS=$((PASS + 1)); }
fail() { printf "${RED} \xE2\x9C\x97${NC} %s\n" "$1"; FAIL=$((FAIL + 1)); }

printf "${BOLD}deploy/bootstrap.sh log helpers${NC}\n"

# Print the top-level lines of the script. Lines inside a heredoc body are
# removed, because a heredoc body is data or a script for a different shell.
top_level() {
awk '
delim != "" { if ($0 == delim) delim = ""; next }
{
print
if (match($0, /<<-?[ \t]*["\047]?[A-Za-z_][A-Za-z0-9_]*["\047]?/)) {
d = substr($0, RSTART, RLENGTH)
sub(/^<<-?[ \t]*/, "", d)
gsub(/["\047]/, "", d)
delim = d
}
}
' "$BOOTSTRAP"
}

TOP="$(top_level)"

for helper in step ok fail info warn; do
defined=0
called=0
if grep -Eq "^${helper}\(\)" <<<"$TOP"; then defined=1; fi
# A call is the helper name at the start of a command: line start, or
# after "&&", "||", ";" or "then"/"else"/"do".
if grep -Eq "(^|&&|\|\||;|then|else|do)[[:space:]]*${helper}[[:space:]]+[\"\$]" <<<"$TOP"; then
called=1
fi
if [[ $called -eq 0 ]]; then
pass "$helper is not called at top level"
elif [[ $defined -eq 1 ]]; then
pass "$helper is called and defined at top level"
else
fail "$helper is called at top level but not defined"
fi
done

echo ""
echo "Passed: $PASS Failed: $FAIL"
[[ $FAIL -eq 0 ]]
Loading