test(19.3-05): phase gate with bouncer cookie and Turnstile unit suites
- scripts/check-phase19.3.sh: fail-closed gate (go stage, self-test, --all with NOT RUN docker); a required name that fails, skips or is missing fails its stage - cookie_test.go: LoadCookieConfig defaults and errors, TokenCookie attributes and refresh-window Max-Age, forget cookie, refresh and logout handlers with a real Refresh and MemoryBlacklist - turnstile_test.go: open/closed verdict matrix, timeout, form fields, token sources, body restore, statuses and secret-free logs
This commit is contained in:
Jakub Zych
402
scripts/check-phase19.3.sh
Executable file
402
scripts/check-phase19.3.sh
Executable file
@@ -0,0 +1,402 @@
|
||||
#!/usr/bin/env bash
|
||||
# check-phase19.3: fail-closed gate for Phase 19.3, framework transport and
|
||||
# infrastructure. The framework pieces in this repository (bouncer token
|
||||
# cookies and Turnstile, surf CORS hardening, CORS profiles, the api-docs page
|
||||
# and the rate-limit store lookup, cabana's reorder hook, summer.yaml build
|
||||
# tags, the attach S3 build tag, DiskExtension and public_url, and the cooler
|
||||
# module: caches, the Redis rate-limit store, Install and the site-cache
|
||||
# purge), the purge wiring in the FAQ, menu and Journal plugins, and the
|
||||
# shared purge route of the FAQ, menu and Journal Nuxt layers.
|
||||
#
|
||||
# Stages:
|
||||
# go go vet ./... and go vet -tags summercms_s3 ./modules/lagoon/...;
|
||||
# go test -short ./...; then the Docker-free framework suites by
|
||||
# required name, the attach ones in both build-tag modes.
|
||||
# docker Docker host only: the testcontainers suites by required name
|
||||
# (Postgres and Redis) in the framework and the plugins.
|
||||
# plugins go vet ./... and go test -short ./... in the three plugins, then
|
||||
# their Docker-free suites by required name.
|
||||
# layers pnpm test (node --test, TAP) in the three layers with required
|
||||
# test files and names, and cmp equality of the shared purge files
|
||||
# and spec across the layers.
|
||||
# docs TestDocsTree, summer docs:build --check and a check that no file
|
||||
# this phase added to the framework names a consuming application.
|
||||
#
|
||||
# A stage exits non-zero on a failing command, or on a go test -json run that
|
||||
# fails, skips a test, matches zero tests, prints "no tests to run" or misses a
|
||||
# required name; or a TAP run with a "not ok", a fail, cancelled, skipped or
|
||||
# todo count, no passing test or a missing required name.
|
||||
# --self-test proves the detectors fail on planted output.
|
||||
#
|
||||
# --all runs self-test, go, plugins, layers and docs, then docker when a
|
||||
# Docker daemon answers. When none does, --all prints NOT RUN docker and the
|
||||
# Docker suites stay a manual step for a Docker host:
|
||||
# bash scripts/check-phase19.3.sh docker
|
||||
# Set PHASE193_REQUIRE_DOCKER=1 to make --all fail instead.
|
||||
#
|
||||
# Environment overrides (default: the sibling checkouts next to this
|
||||
# repository): PHASE193_ROOT (this repository), FAQ_PLUGIN, MENU_PLUGIN,
|
||||
# JOURNAL_PLUGIN, FAQ_LAYER, MENU_LAYER, JOURNAL_LAYER.
|
||||
set -euo pipefail
|
||||
|
||||
unset FORCE_COLOR
|
||||
export NO_COLOR=1
|
||||
|
||||
ROOT="${PHASE193_ROOT:-$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)}"
|
||||
FAQ_PLUGIN="${FAQ_PLUGIN:-$ROOT/../sm-faq-plugin}"
|
||||
MENU_PLUGIN="${MENU_PLUGIN:-$ROOT/../sm-menu-plugin}"
|
||||
JOURNAL_PLUGIN="${JOURNAL_PLUGIN:-$ROOT/../sm-journal-plugin}"
|
||||
FAQ_LAYER="${FAQ_LAYER:-$ROOT/../vue-faq-layer}"
|
||||
MENU_LAYER="${MENU_LAYER:-$ROOT/../vue-menu-layer}"
|
||||
JOURNAL_LAYER="${JOURNAL_LAYER:-$ROOT/../vue-journal-layer}"
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Required test names. Each list runs with -run '^(a|b|...)$' and every name
|
||||
# must pass; a name that skips or does not run fails the stage.
|
||||
|
||||
# go stage: Docker-free framework suites (-short).
|
||||
BOUNCER_TESTS=(
|
||||
TestLoadCookieConfigDefaults TestLoadCookieConfigErrors
|
||||
TestTokenCookieAttributes TestTokenCookieMaxAgeIsRefreshWindow TestForgetTokenCookie
|
||||
TestCookieRefreshHandlerRotatesAndBlacklists TestCookieRefreshHandlerMissingCookie
|
||||
TestCookieRefreshHandlerRefreshError TestCookieLogoutHandler TestCookieHandlerOptionsValidated
|
||||
TestTurnstileVerifyMatrix TestTurnstileVerifyTimeout TestTurnstileFormFields
|
||||
TestTurnstileMiddlewareTokenSources TestTurnstileMiddlewareRestoresBody
|
||||
TestTurnstileMiddlewareStatuses TestTurnstileNeverLogsSecret
|
||||
)
|
||||
|
||||
# docker stage: testcontainers suites.
|
||||
|
||||
usage() {
|
||||
cat >&2 <<'EOF'
|
||||
usage:
|
||||
check-phase19.3.sh --self-test
|
||||
check-phase19.3.sh go | docker | plugins | layers | docs
|
||||
check-phase19.3.sh --go | --docker | --plugins | --layers | --docs
|
||||
check-phase19.3.sh --all
|
||||
EOF
|
||||
exit 2
|
||||
}
|
||||
|
||||
# detect_go reads go test -json. Exit 1 fail/build, 2 skip, 3 zero/no-tests,
|
||||
# 4 non-JSON, 5 missing required name.
|
||||
detect_go() {
|
||||
python3 - "$1" <<'PY'
|
||||
import json, os, sys
|
||||
path = sys.argv[1]
|
||||
require = [n for n in os.environ.get("REQUIRE_TESTS", "").split() if n]
|
||||
passed = set()
|
||||
failed = []
|
||||
with open(path, encoding="utf-8", errors="replace") as fh:
|
||||
for raw in fh:
|
||||
line = raw.strip()
|
||||
if not line.startswith("{"):
|
||||
continue
|
||||
try:
|
||||
ev = json.loads(line)
|
||||
except json.JSONDecodeError:
|
||||
print("refuse: non-json test output", file=sys.stderr)
|
||||
sys.exit(4)
|
||||
action = ev.get("Action")
|
||||
test = ev.get("Test") or ""
|
||||
pkg = ev.get("Package") or ev.get("ImportPath") or ""
|
||||
if action == "build-fail" or (action == "fail" and ev.get("FailedBuild")):
|
||||
print(f"refuse: build failed {pkg}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
text = ev.get("Output") or ""
|
||||
if action == "output" and "no tests to run" in text:
|
||||
print(f"refuse: no tests to run in {pkg}", file=sys.stderr)
|
||||
sys.exit(3)
|
||||
if action == "skip" and test:
|
||||
print(f"refuse: skipped {pkg} {test}", file=sys.stderr)
|
||||
sys.exit(2)
|
||||
if action == "fail":
|
||||
failed.append(f"{pkg} {test}".strip())
|
||||
if action == "pass" and test:
|
||||
passed.add(test)
|
||||
if failed:
|
||||
print("refuse: failed " + ", ".join(failed), file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if not passed:
|
||||
print("refuse: zero tests", file=sys.stderr)
|
||||
sys.exit(3)
|
||||
missing = [n for n in require if n not in passed]
|
||||
if missing:
|
||||
print("refuse: required tests did not pass: " + ", ".join(missing), file=sys.stderr)
|
||||
sys.exit(5)
|
||||
PY
|
||||
}
|
||||
|
||||
# detect_tap reads node --test --test-reporter=tap output. Exit 1 "not ok" or
|
||||
# a fail/cancelled count, 2 a skip/todo directive or count, 3 no passing test,
|
||||
# 5 a missing required name. REQUIRE_NAMES holds one test name per line.
|
||||
detect_tap() {
|
||||
python3 - "$1" <<'PY'
|
||||
import os, re, sys
|
||||
path = sys.argv[1]
|
||||
require = [n for n in os.environ.get("REQUIRE_NAMES", "").split("\n") if n.strip()]
|
||||
passed = set()
|
||||
counts = {}
|
||||
with open(path, encoding="utf-8", errors="replace") as fh:
|
||||
for raw in fh:
|
||||
line = raw.rstrip("\n")
|
||||
body = line.lstrip()
|
||||
if body.startswith("not ok"):
|
||||
print(f"refuse: {body}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
m = re.match(r"ok \d+ - (.*?)(\s+#\s*(SKIP|TODO)\b.*)?$", body, re.I)
|
||||
if m:
|
||||
if m.group(2):
|
||||
print(f"refuse: {body}", file=sys.stderr)
|
||||
sys.exit(2)
|
||||
passed.add(m.group(1).replace("\\#", "#"))
|
||||
continue
|
||||
m = re.match(r"# (tests|suites|pass|fail|cancelled|skipped|todo) (\d+)$", line)
|
||||
if m:
|
||||
counts[m.group(1)] = int(m.group(2))
|
||||
for key in ("fail", "cancelled"):
|
||||
if counts.get(key, 0) > 0:
|
||||
print(f"refuse: {counts[key]} {key}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
for key in ("skipped", "todo"):
|
||||
if counts.get(key, 0) > 0:
|
||||
print(f"refuse: {counts[key]} {key}", file=sys.stderr)
|
||||
sys.exit(2)
|
||||
if counts.get("pass", 0) < 1 or not passed:
|
||||
print("refuse: no passing tests", file=sys.stderr)
|
||||
sys.exit(3)
|
||||
missing = [n for n in require if n not in passed]
|
||||
if missing:
|
||||
print("refuse: required tests did not pass: " + "; ".join(missing), file=sys.stderr)
|
||||
sys.exit(5)
|
||||
PY
|
||||
}
|
||||
|
||||
go_json() {
|
||||
local dir="$1"
|
||||
shift
|
||||
local log err rc=0 dc=0
|
||||
log="$(mktemp)"
|
||||
err="$(mktemp)"
|
||||
(cd "$dir" && go test -json "$@") >"$log" 2>"$err" || rc=$?
|
||||
detect_go "$log" || dc=$?
|
||||
if [[ "$rc" -ne 0 || "$dc" -ne 0 ]]; then
|
||||
cat "$err" >&2 || true
|
||||
grep -v '^{' "$log" | tail -n 40 >&2 || true
|
||||
python3 -c 'import json,sys
|
||||
for raw in open(sys.argv[1], errors="replace"):
|
||||
try: ev = json.loads(raw)
|
||||
except ValueError: continue
|
||||
if ev.get("Action") == "output" and ("FAIL" in ev.get("Output", "") or "_test.go:" in ev.get("Output", "")):
|
||||
sys.stderr.write(ev["Output"])' "$log" 2>&1 | tail -n 40 >&2 || true
|
||||
rm -f "$log" "$err"
|
||||
echo "refuse: go test $* in $dir (test=$rc detect=$dc)" >&2
|
||||
return 1
|
||||
fi
|
||||
echo "go: $(grep -c '"Action":"pass","Package":"[^"]*","Test":"[^"/]*","Elapsed"' "$log") top-level tests passed in $dir ($*)"
|
||||
rm -f "$log" "$err"
|
||||
}
|
||||
|
||||
# go_named DIR PACKAGES FLAGS NAME... runs exactly the named top-level tests
|
||||
# and requires every one of them to pass. PACKAGES and FLAGS are word-split.
|
||||
go_named() {
|
||||
local dir="$1" pkgs="$2" flags="$3"
|
||||
shift 3
|
||||
if [[ "$#" -eq 0 ]]; then
|
||||
echo "refuse: go_named $pkgs in $dir without required names" >&2
|
||||
return 1
|
||||
fi
|
||||
local names=("$@") regex
|
||||
regex="^($(IFS='|'; echo "${names[*]}"))\$"
|
||||
# shellcheck disable=SC2086
|
||||
REQUIRE_TESTS="${names[*]}" go_json "$dir" $flags -count=1 -run "$regex" $pkgs
|
||||
}
|
||||
|
||||
# go_short DIR runs go test -short ./... in DIR; on failure it prints the tail
|
||||
# of the output and fails.
|
||||
go_short() {
|
||||
local out
|
||||
if ! out="$(cd "$1" && go test -count=1 -short ./... 2>&1)"; then
|
||||
printf '%s\n' "$out" | grep -v '^ok ' | tail -n 60 >&2
|
||||
echo "refuse: go test -short ./... in $1" >&2
|
||||
return 1
|
||||
fi
|
||||
echo "short: $1"
|
||||
}
|
||||
|
||||
expect_detector() {
|
||||
local detector="$1" name="$2" want="$3" payload="$4" log dc=0
|
||||
log="$(mktemp)"
|
||||
printf '%s\n' "$payload" >"$log"
|
||||
"$detector" "$log" >/dev/null 2>&1 || dc=$?
|
||||
rm -f "$log"
|
||||
if [[ "$dc" -ne "$want" ]]; then
|
||||
echo "refuse: self-test $detector $name: exit $dc, want $want" >&2
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
run_self_test() {
|
||||
bash -n "${BASH_SOURCE[0]}"
|
||||
|
||||
expect_detector detect_go pass 0 '{"Action":"pass","Package":"p","Test":"TestTokenCookieAttributes"}'
|
||||
expect_detector detect_go fail 1 '{"Action":"pass","Package":"p","Test":"TestA"}
|
||||
{"Action":"fail","Package":"p","Test":"TestTurnstileVerifyMatrix"}'
|
||||
expect_detector detect_go package-fail 1 '{"Action":"pass","Package":"p","Test":"TestA"}
|
||||
{"Action":"fail","Package":"p"}'
|
||||
expect_detector detect_go build 1 '{"Action":"build-fail","ImportPath":"p"}'
|
||||
expect_detector detect_go skip 2 '{"Action":"pass","Package":"p","Test":"TestA"}
|
||||
{"Action":"skip","Package":"p","Test":"TestCookieLogoutHandler"}'
|
||||
expect_detector detect_go zero 3 '{"Action":"pass","Package":"p"}'
|
||||
expect_detector detect_go no-tests 3 '{"Action":"output","Package":"p","Output":"testing: warning: no tests to run\n"}
|
||||
{"Action":"pass","Package":"p"}'
|
||||
expect_detector detect_go nonjson 4 '{"Action":"pass",'
|
||||
REQUIRE_TESTS="TestTokenCookieAttributes TestTurnstileFormFields" expect_detector detect_go missing-named 5 \
|
||||
'{"Action":"pass","Package":"p","Test":"TestTokenCookieAttributes"}'
|
||||
REQUIRE_TESTS="TestTokenCookie" expect_detector detect_go prefix-is-not-the-test 5 \
|
||||
'{"Action":"pass","Package":"p","Test":"TestTokenCookieAttributes"}'
|
||||
REQUIRE_TESTS="TestRegistry" expect_detector detect_go subtest-is-not-the-test 5 \
|
||||
'{"Action":"pass","Package":"p","Test":"TestOuter/TestRegistry"}
|
||||
{"Action":"pass","Package":"p","Test":"TestOther"}'
|
||||
|
||||
local tok='TAP version 13
|
||||
ok 1 - sitePurge: a plain test
|
||||
ok 2 - sitePurge: escaped \# hash
|
||||
1..2
|
||||
# tests 2
|
||||
# pass 2
|
||||
# fail 0
|
||||
# cancelled 0
|
||||
# skipped 0
|
||||
# todo 0'
|
||||
expect_detector detect_tap pass 0 "$tok"
|
||||
REQUIRE_NAMES=$'sitePurge: a plain test\nsitePurge: escaped # hash' expect_detector detect_tap named 0 "$tok"
|
||||
expect_detector detect_tap not-ok 1 'ok 1 - a
|
||||
not ok 2 - b
|
||||
# pass 1
|
||||
# fail 1'
|
||||
expect_detector detect_tap nested-not-ok 1 ' not ok 1 - sub
|
||||
ok 1 - a
|
||||
# pass 1
|
||||
# fail 0'
|
||||
expect_detector detect_tap fail-count 1 'ok 1 - a
|
||||
# pass 1
|
||||
# fail 1'
|
||||
expect_detector detect_tap cancelled 1 'ok 1 - a
|
||||
# pass 1
|
||||
# cancelled 1'
|
||||
expect_detector detect_tap skip 2 'ok 1 - a # SKIP later
|
||||
# pass 1'
|
||||
expect_detector detect_tap todo-count 2 'ok 1 - a
|
||||
# pass 1
|
||||
# todo 1'
|
||||
expect_detector detect_tap zero 3 '# tests 0
|
||||
# pass 0
|
||||
# fail 0'
|
||||
expect_detector detect_tap no-output 3 ''
|
||||
REQUIRE_NAMES=$'sitePurge: a plain test\nmissing' expect_detector detect_tap missing-named 5 "$tok"
|
||||
|
||||
grep -qF '"${PHASE193_REQUIRE_DOCKER:-0}" == "1"' "${BASH_SOURCE[0]}" || {
|
||||
echo "refuse: --all does not honour PHASE193_REQUIRE_DOCKER" >&2
|
||||
return 1
|
||||
}
|
||||
local mode
|
||||
for mode in self-test go docker plugins layers docs all; do
|
||||
grep -q -- "^ --$mode" "${BASH_SOURCE[0]}" || {
|
||||
echo "refuse: missing mode --$mode" >&2
|
||||
return 1
|
||||
}
|
||||
done
|
||||
echo "phase19.3 self-test passed"
|
||||
}
|
||||
|
||||
require_dir() {
|
||||
[[ -d "$1" ]] || {
|
||||
echo "refuse: $2 $1 not found" >&2
|
||||
return 1
|
||||
}
|
||||
}
|
||||
|
||||
not_wired() {
|
||||
echo "refuse: stage $1 is not wired yet" >&2
|
||||
return 1
|
||||
}
|
||||
|
||||
run_go() {
|
||||
(cd "$ROOT" && go vet ./...)
|
||||
echo "vet: $ROOT"
|
||||
(cd "$ROOT" && go vet -tags summercms_s3 ./modules/lagoon/...)
|
||||
echo "vet -tags summercms_s3: $ROOT/modules/lagoon/..."
|
||||
go_short "$ROOT"
|
||||
go_named "$ROOT" ./modules/bouncer -short "${BOUNCER_TESTS[@]}"
|
||||
echo "phase19.3 go passed"
|
||||
}
|
||||
|
||||
docker_up() {
|
||||
command -v docker >/dev/null 2>&1 && docker info >/dev/null 2>&1
|
||||
}
|
||||
|
||||
run_docker() {
|
||||
if ! docker_up; then
|
||||
echo "refuse: the docker stage needs a reachable Docker daemon (testcontainers); run it on a Docker host" >&2
|
||||
return 1
|
||||
fi
|
||||
not_wired docker
|
||||
}
|
||||
|
||||
run_plugins() {
|
||||
not_wired plugins
|
||||
}
|
||||
|
||||
run_layers() {
|
||||
not_wired layers
|
||||
}
|
||||
|
||||
run_docs() {
|
||||
not_wired docs
|
||||
}
|
||||
|
||||
run_all() {
|
||||
local stage
|
||||
for stage in self-test go plugins layers docs; do
|
||||
if bash "${BASH_SOURCE[0]}" "--$stage"; then
|
||||
echo "PASS $stage"
|
||||
else
|
||||
echo "FAIL $stage"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
if docker_up; then
|
||||
if bash "${BASH_SOURCE[0]}" --docker; then
|
||||
echo "PASS docker"
|
||||
else
|
||||
echo "FAIL docker"
|
||||
exit 1
|
||||
fi
|
||||
elif [[ "${PHASE193_REQUIRE_DOCKER:-0}" == "1" ]]; then
|
||||
echo "FAIL docker: no reachable Docker daemon and PHASE193_REQUIRE_DOCKER=1"
|
||||
exit 1
|
||||
else
|
||||
cat >&2 <<'EOF'
|
||||
************************************************************************
|
||||
NOT RUN docker: no reachable Docker daemon on this host.
|
||||
The testcontainers suites (Postgres and Redis) of the framework and the
|
||||
plugins did NOT run. Run on a Docker host before /msd-verify-work:
|
||||
bash scripts/check-phase19.3.sh docker
|
||||
************************************************************************
|
||||
EOF
|
||||
echo "NOT RUN docker (Docker-host only; see the notice above)"
|
||||
fi
|
||||
echo "Phase 19.3 gate passed"
|
||||
}
|
||||
|
||||
case "${1:---all}" in
|
||||
--self-test | self-test) run_self_test ;;
|
||||
--go | go) run_go ;;
|
||||
--docker | docker) run_docker ;;
|
||||
--plugins | plugins) run_plugins ;;
|
||||
--layers | layers) run_layers ;;
|
||||
--docs | docs) run_docs ;;
|
||||
--all | all) run_all ;;
|
||||
*) usage ;;
|
||||
esac
|
||||
Reference in New Issue
Block a user