mirror of
https://github.com/mulgadc/spinifex.git
synced 2026-10-15 09:01:31 +00:00
Josh Siviour
fd8be8a814
* refactor(test): route duplicated NATS bootstraps through testutil Thirteen test sites hand-rolled a NATS or JetStream server bootstrap that spinifex/testutil already provides, and one seedKV clone duplicated testutil.SeedKV. Route them through the shared helpers. Sites whose options genuinely diverge are left alone: fixed ports needed for reconnect and restart scenarios, custom TLS and token auth, a custom MaxPayload, and TestMain entry points that have no testing.TB for t.Cleanup. The natgw and routetable seedKV clones use CreateOrUpdateKeyValue rather than CreateKeyValue, so their failure behaviour differs and they stay as they are. Also moves eight test files to external test packages where they declare no helper used by a sibling in the same package. Coverage is unaffected: Go compiles internal and external test packages into one binary per package, so attribution is identical either way. * chore(test): require new test files to use an external test package Adds a preflight check that fails when a newly added test file declares an in-package test. External test packages bind tests to the exported API and let packages share test doubles, which an in-package double cannot be. Only added files are checked, so the existing in-package tests are untouched. e2e and integration suites are exempt: both share a package-level fixture built in main_test.go, so their files cannot move individually. A file that needs unexported access can opt out with a //test:in-package comment.
87 lines
2.8 KiB
Bash
Executable File
87 lines
2.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
|
|
# Requires newly added test files to use an external test package.
|
|
#
|
|
# `package foo_test` binds tests to the exported API, so internals can be
|
|
# refactored without rewriting tests, and it lets packages share test doubles
|
|
# (an in-package double is invisible to every other package). Coverage is
|
|
# unaffected — Go compiles internal and external test packages into a single
|
|
# binary per package, so attribution is identical either way.
|
|
#
|
|
# Only ADDED files are checked; existing in-package tests are left alone.
|
|
# A file that genuinely needs unexported access can either opt out with a
|
|
# `//go:build` free marker comment (see ALLOW_MARKER) or move the unexported
|
|
# hook into an export_test.go.
|
|
#
|
|
# Usage: scripts/check-test-package.sh [--base <ref>]
|
|
#
|
|
# Base ref auto-detection matches diff-coverage.sh:
|
|
# main branch → HEAD~1
|
|
# dev branch → origin/main
|
|
# other branch → origin/dev
|
|
|
|
BASE_REF=""
|
|
QUIET="${QUIET:-}"
|
|
ALLOW_MARKER="//test:in-package"
|
|
|
|
while [[ $# -gt 0 ]]; do
|
|
case "$1" in
|
|
--base) BASE_REF="$2"; shift 2 ;;
|
|
-*) echo "Unknown option: $1" >&2; exit 1 ;;
|
|
*) echo "Unexpected argument: $1" >&2; exit 1 ;;
|
|
esac
|
|
done
|
|
|
|
if [[ -z "$BASE_REF" ]]; then
|
|
BRANCH="${GITHUB_REF_NAME:-$(git rev-parse --abbrev-ref HEAD)}"
|
|
case "$BRANCH" in
|
|
main) BASE_REF="HEAD~1" ;;
|
|
dev) BASE_REF="origin/main" ;;
|
|
*) BASE_REF="origin/dev" ;;
|
|
esac
|
|
[[ -z "$QUIET" ]] && echo "Base ref: $BASE_REF (branch: $BRANCH)"
|
|
fi
|
|
|
|
if ! git rev-parse --verify "$BASE_REF" &>/dev/null; then
|
|
echo "Error: base ref '$BASE_REF' not reachable." >&2
|
|
echo "Fetch it first: git fetch origin <branch>" >&2
|
|
exit 1
|
|
fi
|
|
|
|
# e2e and integration suites share a package-level fixture built in
|
|
# main_test.go, so their files cannot move individually.
|
|
ADDED=$(git diff "$BASE_REF" HEAD --name-only --diff-filter=A -- '*_test.go' \
|
|
':!tests/e2e/*' ':!tests/integration/*' || true)
|
|
|
|
if [[ -z "$ADDED" ]]; then
|
|
[[ -z "$QUIET" ]] && echo "No new test files — skipping test package check."
|
|
exit 0
|
|
fi
|
|
|
|
VIOLATIONS=()
|
|
for f in $ADDED; do
|
|
[[ -f "$f" ]] || continue
|
|
if grep -qF "$ALLOW_MARKER" "$f"; then
|
|
continue
|
|
fi
|
|
pkg=$(awk '/^package /{print $2; exit}' "$f")
|
|
if [[ -n "$pkg" && "$pkg" != *_test ]]; then
|
|
VIOLATIONS+=("$f (package $pkg)")
|
|
fi
|
|
done
|
|
|
|
if [[ ${#VIOLATIONS[@]} -gt 0 ]]; then
|
|
echo "ERROR: new test files must use an external test package (package <pkg>_test):" >&2
|
|
for v in "${VIOLATIONS[@]}"; do
|
|
echo " $v" >&2
|
|
done
|
|
echo "" >&2
|
|
echo "Move unexported hooks into export_test.go, or add the comment" >&2
|
|
echo "'$ALLOW_MARKER' to the file with a reason if in-package access is required." >&2
|
|
exit 1
|
|
fi
|
|
|
|
[[ -z "$QUIET" ]] && echo "Test package check OK ($(echo "$ADDED" | wc -w) new file(s))"
|
|
exit 0
|