mirror of
https://github.com/nearai/ironclaw.git
synced 2026-05-23 12:20:15 +08:00
f60c91e9a7
* ci: enforce regression tests for fix commits Add a commit-msg hook and CI workflow that require test changes alongside bug fix commits, ensuring every fix includes a regression test that would have caught the bug. - scripts/commit-msg-regression.sh: local git hook (blocks fix commits without test changes; exempts static/docs-only; bypass via [skip-regression-check] marker) - .github/workflows/regression-test-check.yml: CI mirror on PRs (checks title + commit messages; skip via label) - scripts/dev-setup.sh: install hook in step 6 - .github/scripts/create-labels.sh: add skip-regression-check label - CLAUDE.md: document regression test policy Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: address PR review feedback on regression test enforcement - Use here-strings instead of echo|grep to avoid misinterpreting special characters in variables - Use git diff -W (whole-function context) to detect edits inside existing test functions, not just new #[test] attributes - Honor [skip-regression-check] in commit messages in CI (not just the PR label) - Use git rev-parse --git-path hooks for worktree-safe hook install [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Update .github/workflows/regression-test-check.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
82 lines
3.0 KiB
Bash
Executable File
82 lines
3.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# commit-msg hook: require regression tests for fix commits.
|
|
#
|
|
# Installed by scripts/dev-setup.sh as .git/hooks/commit-msg.
|
|
# Bypass with [skip-regression-check] in the commit message.
|
|
|
|
set -euo pipefail
|
|
|
|
MSG_FILE="$1"
|
|
FIRST_LINE=$(head -1 "$MSG_FILE")
|
|
|
|
# --- 1. Is this a fix commit? ---
|
|
if ! grep -qiE '^(fix(\(.*\))?|hotfix|bugfix):' <<< "$FIRST_LINE"; then
|
|
exit 0
|
|
fi
|
|
|
|
# --- 2. Skip marker ---
|
|
if grep -qF '[skip-regression-check]' "$MSG_FILE"; then
|
|
exit 0
|
|
fi
|
|
|
|
# --- 3. Exempt static-only / docs-only changes ---
|
|
# Get staged files (commit-msg runs after staging is finalized).
|
|
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR)
|
|
|
|
if [ -z "$STAGED_FILES" ]; then
|
|
exit 0
|
|
fi
|
|
|
|
ALL_EXEMPT=true
|
|
while IFS= read -r file; do
|
|
case "$file" in
|
|
src/channels/web/static/*) ;;
|
|
*.md) ;;
|
|
*) ALL_EXEMPT=false; break ;;
|
|
esac
|
|
done <<< "$STAGED_FILES"
|
|
|
|
if [ "$ALL_EXEMPT" = true ]; then
|
|
exit 0
|
|
fi
|
|
|
|
# --- 4. Look for test changes in staged .rs files ---
|
|
|
|
# Fast path: new test attributes or test modules in added lines.
|
|
if git diff --cached -U0 -- '*.rs' | grep -qE '^\+.*(#\[test\]|#\[tokio::test\]|#\[cfg\(test\)\]|mod tests)'; then
|
|
exit 0
|
|
fi
|
|
|
|
# Whole-function context: detect edits inside existing test functions.
|
|
# -W shows the full enclosing function, so #[test] appears in context
|
|
# lines when changes are inside a test function.
|
|
if git diff --cached -W -- '*.rs' | awk '
|
|
/^@@/ { if (has_test && has_add) { found=1; exit } has_test=0; has_add=0 }
|
|
/^ .*#\[test\]/ || /^ .*#\[tokio::test\]/ || /^ .*#\[cfg\(test\)\]/ || /^ .*mod tests/ { has_test=1 }
|
|
/^\+.*#\[test\]/ || /^\+.*#\[tokio::test\]/ || /^\+.*#\[cfg\(test\)\]/ || /^\+.*mod tests/ { has_test=1 }
|
|
/^\+[^+]/ { has_add=1 }
|
|
END { if (has_test && has_add) found=1; exit !found }
|
|
'; then
|
|
exit 0
|
|
fi
|
|
|
|
# Also check for new/modified files under tests/
|
|
if grep -qE '^tests/' <<< "$STAGED_FILES"; then
|
|
exit 0
|
|
fi
|
|
|
|
# --- 5. No test found — block the commit ---
|
|
echo ""
|
|
echo "╔══════════════════════════════════════════════════════════════╗"
|
|
echo "║ REGRESSION TEST REQUIRED ║"
|
|
echo "║ ║"
|
|
echo "║ This commit looks like a bug fix but has no test changes. ║"
|
|
echo "║ Every fix should include a test that reproduces the bug. ║"
|
|
echo "║ ║"
|
|
echo "║ Options: ║"
|
|
echo "║ • Add a #[test] or #[tokio::test] that catches the bug ║"
|
|
echo "║ • Add [skip-regression-check] to your commit message ║"
|
|
echo "╚══════════════════════════════════════════════════════════════╝"
|
|
echo ""
|
|
exit 1
|