Files
beads/cmd/bd/hooks_test.go
Steve Yegge 3050fd2ef8 feat(hooks): implement thin shim pattern (GH#615)
Replace full shell script hooks with thin shims that delegate to
'bd hooks run <hook-name>'. This eliminates hook version drift -
upgrading bd automatically updates hook behavior.

Changes:
- Add 'bd hooks run' subcommand with hook logic in Go
- Convert templates to minimal shims (~17 lines each)
- Shims use '# bd-shim v1' marker (format version, not bd version)
- Update version checking to recognize shim format
- Shims are never marked as "outdated"

Benefits:
- No more manual 'bd hooks install --force' after upgrades
- Hook logic always matches installed bd version
- Follows pattern used by husky, pre-commit, lefthook

Migration: Run 'bd hooks install --force' one final time.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2025-12-20 02:38:56 -08:00

341 lines
9.0 KiB
Go

package main
import (
"os"
"os/exec"
"path/filepath"
"runtime"
"testing"
"github.com/steveyegge/beads/internal/git"
)
func TestGetEmbeddedHooks(t *testing.T) {
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
expectedHooks := []string{"pre-commit", "post-merge", "pre-push", "post-checkout"}
for _, hookName := range expectedHooks {
content, ok := hooks[hookName]
if !ok {
t.Errorf("Missing hook: %s", hookName)
continue
}
if len(content) == 0 {
t.Errorf("Hook %s has empty content", hookName)
}
// Verify it's a shell script
if content[:2] != "#!" {
t.Errorf("Hook %s doesn't start with shebang: %s", hookName, content[:50])
}
}
}
func TestInstallHooks(t *testing.T) {
// Create temp directory and init git repo
tmpDir := t.TempDir()
// Change to temp directory
t.Chdir(tmpDir)
// Initialize a real git repo (required for git rev-parse)
if err := exec.Command("git", "init").Run(); err != nil {
t.Skipf("Skipping test: git init failed: %v", err)
}
gitDirPath, err := git.GetGitDir()
if err != nil {
t.Fatalf("git.GetGitDir() failed: %v", err)
}
gitDir := filepath.Join(gitDirPath, "hooks")
// Get embedded hooks
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
// Install hooks
if err := installHooks(hooks, false, false); err != nil {
t.Fatalf("installHooks() failed: %v", err)
}
// Verify hooks were installed
for hookName := range hooks {
hookPath := filepath.Join(gitDir, hookName)
if _, err := os.Stat(hookPath); os.IsNotExist(err) {
t.Errorf("Hook %s was not installed", hookName)
}
// Windows does not support POSIX executable bits, so skip the check there.
if runtime.GOOS == "windows" {
continue
}
info, err := os.Stat(hookPath)
if err != nil {
t.Errorf("Failed to stat %s: %v", hookName, err)
continue
}
if info.Mode()&0111 == 0 {
t.Errorf("Hook %s is not executable", hookName)
}
}
}
func TestInstallHooksBackup(t *testing.T) {
// Create temp directory and init git repo
tmpDir := t.TempDir()
// Change to temp directory
t.Chdir(tmpDir)
// Initialize a real git repo (required for git rev-parse)
if err := exec.Command("git", "init").Run(); err != nil {
t.Skipf("Skipping test: git init failed: %v", err)
}
gitDirPath, err := git.GetGitDir()
if err != nil {
t.Fatalf("git.GetGitDir() failed: %v", err)
}
gitDir := filepath.Join(gitDirPath, "hooks")
// Ensure hooks directory exists
if err := os.MkdirAll(gitDir, 0750); err != nil {
t.Fatalf("Failed to create hooks directory: %v", err)
}
// Create an existing hook
existingHook := filepath.Join(gitDir, "pre-commit")
existingContent := "#!/bin/sh\necho old hook\n"
if err := os.WriteFile(existingHook, []byte(existingContent), 0755); err != nil {
t.Fatalf("Failed to create existing hook: %v", err)
}
// Get embedded hooks
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
// Install hooks (should backup existing)
if err := installHooks(hooks, false, false); err != nil {
t.Fatalf("installHooks() failed: %v", err)
}
// Verify backup was created
backupPath := existingHook + ".backup"
if _, err := os.Stat(backupPath); os.IsNotExist(err) {
t.Errorf("Backup was not created")
}
// Verify backup has original content
backupContent, err := os.ReadFile(backupPath)
if err != nil {
t.Fatalf("Failed to read backup: %v", err)
}
if string(backupContent) != existingContent {
t.Errorf("Backup content mismatch: got %q, want %q", string(backupContent), existingContent)
}
}
func TestInstallHooksForce(t *testing.T) {
// Create temp directory and init git repo
tmpDir := t.TempDir()
// Change to temp directory first, then init
t.Chdir(tmpDir)
// Initialize a real git repo (required for git rev-parse)
if err := exec.Command("git", "init").Run(); err != nil {
t.Skipf("Skipping test: git init failed: %v", err)
}
gitDirPath, err := git.GetGitDir()
if err != nil {
t.Fatalf("git.GetGitDir() failed: %v", err)
}
gitDir := filepath.Join(gitDirPath, "hooks")
// Ensure hooks directory exists
if err := os.MkdirAll(gitDir, 0750); err != nil {
t.Fatalf("Failed to create hooks directory: %v", err)
}
// Create an existing hook
existingHook := filepath.Join(gitDir, "pre-commit")
if err := os.WriteFile(existingHook, []byte("old"), 0755); err != nil {
t.Fatalf("Failed to create existing hook: %v", err)
}
// Get embedded hooks
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
// Install hooks with force (should not create backup)
if err := installHooks(hooks, true, false); err != nil {
t.Fatalf("installHooks() failed: %v", err)
}
// Verify no backup was created
backupPath := existingHook + ".backup"
if _, err := os.Stat(backupPath); !os.IsNotExist(err) {
t.Errorf("Backup should not have been created with --force")
}
}
func TestUninstallHooks(t *testing.T) {
// Create temp directory and init git repo
tmpDir := t.TempDir()
// Change to temp directory first, then init
t.Chdir(tmpDir)
// Initialize a real git repo (required for git rev-parse)
if err := exec.Command("git", "init").Run(); err != nil {
t.Skipf("Skipping test: git init failed: %v", err)
}
gitDirPath, err := git.GetGitDir()
if err != nil {
t.Fatalf("git.GetGitDir() failed: %v", err)
}
gitDir := filepath.Join(gitDirPath, "hooks")
// Get embedded hooks and install them
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
if err := installHooks(hooks, false, false); err != nil {
t.Fatalf("installHooks() failed: %v", err)
}
// Uninstall hooks
if err := uninstallHooks(); err != nil {
t.Fatalf("uninstallHooks() failed: %v", err)
}
// Verify hooks were removed
hookNames := []string{"pre-commit", "post-merge", "pre-push", "post-checkout"}
for _, hookName := range hookNames {
hookPath := filepath.Join(gitDir, hookName)
if _, err := os.Stat(hookPath); !os.IsNotExist(err) {
t.Errorf("Hook %s was not removed", hookName)
}
}
}
func TestHooksCheckGitHooks(t *testing.T) {
// Create temp directory and init git repo
tmpDir := t.TempDir()
// Change to temp directory first, then init
t.Chdir(tmpDir)
// Initialize a real git repo (required for git rev-parse)
if err := exec.Command("git", "init").Run(); err != nil {
t.Skipf("Skipping test: git init failed: %v", err)
}
// Initially no hooks installed
statuses := CheckGitHooks()
for _, status := range statuses {
if status.Installed {
t.Errorf("Hook %s should not be installed initially", status.Name)
}
}
// Install hooks
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
if err := installHooks(hooks, false, false); err != nil {
t.Fatalf("installHooks() failed: %v", err)
}
// Check again
statuses = CheckGitHooks()
for _, status := range statuses {
if !status.Installed {
t.Errorf("Hook %s should be installed", status.Name)
}
// Thin shims use version format "v1" (shim format version, not bd version)
if !status.IsShim {
t.Errorf("Hook %s should be a thin shim", status.Name)
}
if status.Version != "v1" {
t.Errorf("Hook %s shim version mismatch: got %s, want v1", status.Name, status.Version)
}
if status.Outdated {
t.Errorf("Hook %s should not be outdated", status.Name)
}
}
}
func TestInstallHooksShared(t *testing.T) {
// Create temp directory
tmpDir := t.TempDir()
// Change to temp directory
t.Chdir(tmpDir)
// Initialize a real git repo (needed for git config command)
if err := exec.Command("git", "init").Run(); err != nil {
t.Skipf("Skipping test: git init failed (git may not be available): %v", err)
}
// Get embedded hooks
hooks, err := getEmbeddedHooks()
if err != nil {
t.Fatalf("getEmbeddedHooks() failed: %v", err)
}
// Install hooks in shared mode
if err := installHooks(hooks, false, true); err != nil {
t.Fatalf("installHooks() with shared=true failed: %v", err)
}
// Verify hooks were installed to .beads-hooks/
sharedHooksDir := ".beads-hooks"
for hookName := range hooks {
hookPath := filepath.Join(sharedHooksDir, hookName)
if _, err := os.Stat(hookPath); os.IsNotExist(err) {
t.Errorf("Hook %s was not installed to .beads-hooks/", hookName)
}
// Windows does not support POSIX executable bits, so skip the check there.
if runtime.GOOS == "windows" {
continue
}
info, err := os.Stat(hookPath)
if err != nil {
t.Errorf("Failed to stat %s: %v", hookName, err)
continue
}
if info.Mode()&0111 == 0 {
t.Errorf("Hook %s is not executable", hookName)
}
}
// Verify hooks were NOT installed to .git/hooks/
gitDirPath, err := git.GetGitDir()
if err != nil {
t.Fatalf("git.GetGitDir() failed: %v", err)
}
standardHooksDir := filepath.Join(gitDirPath, "hooks")
for hookName := range hooks {
hookPath := filepath.Join(standardHooksDir, hookName)
if _, err := os.Stat(hookPath); !os.IsNotExist(err) {
t.Errorf("Hook %s should not be in .git/hooks/ when using --shared", hookName)
}
}
}