Files
beads/internal/hooks/hooks_test.go
Ross Gardler 6b0d0901d0 hooks: harden timeout kill and add platform split
- Move runHook into build-tagged implementations (unix/windows) to keep unix syscalls off Windows builds.
- In unix implementation, guard nil Process, return wrapped kill errors except ESRCH, and document linkage to TestRunSync_KillsDescendants.
- On Windows, best-effort kill on timeout retains prior behavior.
- In tests, move testing.Short earlier and keep descendant-kill coverage on Linux.
2025-12-16 22:38:45 -08:00

388 lines
9.7 KiB
Go

package hooks
import (
"os"
"path/filepath"
"runtime"
"strconv"
"strings"
"testing"
"time"
"github.com/steveyegge/beads/internal/types"
)
func TestNewRunner(t *testing.T) {
runner := NewRunner("/tmp/hooks")
if runner == nil {
t.Fatal("NewRunner returned nil")
}
if runner.hooksDir != "/tmp/hooks" {
t.Errorf("hooksDir = %q, want %q", runner.hooksDir, "/tmp/hooks")
}
if runner.timeout != 10*time.Second {
t.Errorf("timeout = %v, want %v", runner.timeout, 10*time.Second)
}
}
func TestNewRunnerFromWorkspace(t *testing.T) {
runner := NewRunnerFromWorkspace("/workspace")
if runner == nil {
t.Fatal("NewRunnerFromWorkspace returned nil")
}
expected := filepath.Join("/workspace", ".beads", "hooks")
if runner.hooksDir != expected {
t.Errorf("hooksDir = %q, want %q", runner.hooksDir, expected)
}
}
func TestEventToHook(t *testing.T) {
tests := []struct {
event string
expected string
}{
{EventCreate, HookOnCreate},
{EventUpdate, HookOnUpdate},
{EventClose, HookOnClose},
{EventMessage, HookOnMessage},
{"unknown", ""},
{"", ""},
}
for _, tt := range tests {
t.Run(tt.event, func(t *testing.T) {
result := eventToHook(tt.event)
if result != tt.expected {
t.Errorf("eventToHook(%q) = %q, want %q", tt.event, result, tt.expected)
}
})
}
}
func TestHookExists_NoHook(t *testing.T) {
tmpDir := t.TempDir()
runner := NewRunner(tmpDir)
if runner.HookExists(EventCreate) {
t.Error("HookExists returned true for non-existent hook")
}
}
func TestHookExists_NotExecutable(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
// Create a non-executable file
if err := os.WriteFile(hookPath, []byte("#!/bin/sh\necho test"), 0644); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
if runner.HookExists(EventCreate) {
t.Error("HookExists returned true for non-executable hook")
}
}
func TestHookExists_Executable(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
// Create an executable file
if err := os.WriteFile(hookPath, []byte("#!/bin/sh\necho test"), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
if !runner.HookExists(EventCreate) {
t.Error("HookExists returned false for executable hook")
}
}
func TestHookExists_Directory(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
// Create a directory instead of a file
if err := os.MkdirAll(hookPath, 0755); err != nil {
t.Fatalf("Failed to create directory: %v", err)
}
runner := NewRunner(tmpDir)
if runner.HookExists(EventCreate) {
t.Error("HookExists returned true for directory")
}
}
func TestRunSync_NoHook(t *testing.T) {
tmpDir := t.TempDir()
runner := NewRunner(tmpDir)
issue := &types.Issue{ID: "bd-test", Title: "Test"}
// Should not error when hook doesn't exist
err := runner.RunSync(EventCreate, issue)
if err != nil {
t.Errorf("RunSync returned error for non-existent hook: %v", err)
}
}
func TestRunSync_NotExecutable(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
// Create a non-executable file
if err := os.WriteFile(hookPath, []byte("#!/bin/sh\necho test"), 0644); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
issue := &types.Issue{ID: "bd-test", Title: "Test"}
// Should not error when hook is not executable
err := runner.RunSync(EventCreate, issue)
if err != nil {
t.Errorf("RunSync returned error for non-executable hook: %v", err)
}
}
func TestRunSync_Success(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
outputFile := filepath.Join(tmpDir, "output.txt")
// Create a hook that writes to a file
hookScript := `#!/bin/sh
echo "$1 $2" > ` + outputFile
if err := os.WriteFile(hookPath, []byte(hookScript), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
issue := &types.Issue{ID: "bd-test", Title: "Test Issue"}
err := runner.RunSync(EventCreate, issue)
if err != nil {
t.Errorf("RunSync returned error: %v", err)
}
// Verify the hook ran and received correct arguments
output, err := os.ReadFile(outputFile)
if err != nil {
t.Fatalf("Failed to read output file: %v", err)
}
expected := "bd-test create\n"
if string(output) != expected {
t.Errorf("Hook output = %q, want %q", string(output), expected)
}
}
func TestRunSync_ReceivesJSON(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnMessage)
outputFile := filepath.Join(tmpDir, "stdin.txt")
// Create a hook that captures stdin
hookScript := `#!/bin/sh
cat > ` + outputFile
if err := os.WriteFile(hookPath, []byte(hookScript), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
issue := &types.Issue{
ID: "bd-msg",
Title: "Test Message",
Sender: "alice",
Assignee: "bob",
}
err := runner.RunSync(EventMessage, issue)
if err != nil {
t.Errorf("RunSync returned error: %v", err)
}
// Verify JSON was passed to stdin
output, err := os.ReadFile(outputFile)
if err != nil {
t.Fatalf("Failed to read output file: %v", err)
}
// Just check that it contains expected fields
if len(output) == 0 {
t.Error("Hook did not receive JSON input")
}
if string(output) == "" || output[0] != '{' {
t.Errorf("Hook input doesn't look like JSON: %s", string(output))
}
}
func TestRunSync_Timeout(t *testing.T) {
if testing.Short() {
t.Skip("Skipping timeout test in short mode")
}
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
// Create a hook that sleeps for longer than timeout
hookScript := `#!/bin/sh
sleep 60`
if err := os.WriteFile(hookPath, []byte(hookScript), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := &Runner{
hooksDir: tmpDir,
timeout: 500 * time.Millisecond, // Short timeout
}
issue := &types.Issue{ID: "bd-test", Title: "Test"}
start := time.Now()
err := runner.RunSync(EventCreate, issue)
elapsed := time.Since(start)
if err == nil {
t.Error("RunSync should have returned error for timeout")
}
// Should have returned within timeout + some buffer
if elapsed > 5*time.Second {
t.Errorf("RunSync took too long: %v", elapsed)
}
}
func TestRunSync_KillsDescendants(t *testing.T) {
if runtime.GOOS != "linux" {
t.Skip("TestRunSync_KillsDescendants requires Linux /proc")
}
if testing.Short() {
t.Skip("Skipping long-running descendant kill test in short mode")
}
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnCreate)
pidFile := filepath.Join(tmpDir, "child.pid")
// Hook starts a background sleep, writes its pid, and waits for it.
// Parent will remain alive until the child exits, so killing the
// process group should terminate both.
hookScript := `#!/bin/sh
(sleep 60 & echo $! > ` + pidFile + ` ; wait)`
if err := os.WriteFile(hookPath, []byte(hookScript), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := &Runner{
hooksDir: tmpDir,
timeout: 500 * time.Millisecond,
}
issue := &types.Issue{ID: "bd-test", Title: "Test"}
err := runner.RunSync(EventCreate, issue)
if err == nil {
t.Fatal("Expected RunSync to return an error on timeout")
}
// Read the child PID and ensure it's not running anymore.
data, err := os.ReadFile(pidFile)
if err != nil {
t.Fatalf("Failed to read pid file: %v", err)
}
pidStr := strings.TrimSpace(string(data))
pid, err := strconv.Atoi(pidStr)
if err != nil {
t.Fatalf("Invalid pid in pid file: %v", err)
}
// Check /proc/<pid> does not exist
if _, err := os.Stat(filepath.Join("/proc", strconv.Itoa(pid))); err == nil {
t.Fatalf("Child process %d still exists after timeout", pid)
}
}
func TestRunSync_HookFailure(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnUpdate)
// Create a hook that exits with error
hookScript := `#!/bin/sh
exit 1`
if err := os.WriteFile(hookPath, []byte(hookScript), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
issue := &types.Issue{ID: "bd-test", Title: "Test"}
err := runner.RunSync(EventUpdate, issue)
if err == nil {
t.Error("RunSync should have returned error for failed hook")
}
}
func TestRun_Async(t *testing.T) {
tmpDir := t.TempDir()
hookPath := filepath.Join(tmpDir, HookOnClose)
outputFile := filepath.Join(tmpDir, "async_output.txt")
// Create a hook that writes to a file
hookScript := `#!/bin/sh
echo "async" > ` + outputFile
if err := os.WriteFile(hookPath, []byte(hookScript), 0755); err != nil {
t.Fatalf("Failed to create hook file: %v", err)
}
runner := NewRunner(tmpDir)
issue := &types.Issue{ID: "bd-test", Title: "Test"}
// Run should return immediately
runner.Run(EventClose, issue)
// Wait for the async hook to complete with retries
var output []byte
var err error
for i := 0; i < 10; i++ {
time.Sleep(100 * time.Millisecond)
output, err = os.ReadFile(outputFile)
if err == nil {
break
}
}
if err != nil {
t.Fatalf("Failed to read output file after retries: %v", err)
}
expected := "async\n"
if string(output) != expected {
t.Errorf("Hook output = %q, want %q", string(output), expected)
}
}
func TestAllHookEvents(t *testing.T) {
// Verify all event constants have corresponding hook names
events := []struct {
event string
hook string
}{
{EventCreate, HookOnCreate},
{EventUpdate, HookOnUpdate},
{EventClose, HookOnClose},
{EventMessage, HookOnMessage},
}
for _, e := range events {
t.Run(e.event, func(t *testing.T) {
result := eventToHook(e.event)
if result != e.hook {
t.Errorf("eventToHook(%q) = %q, want %q", e.event, result, e.hook)
}
})
}
}