DOCTOR IMPROVEMENTS: visual improvements/grouping + add comprehensive tests + fix gosec warnings (#656)
* test(doctor): add comprehensive tests for fix and check functions Add edge case tests, e2e tests, and improve test coverage for: - database_test.go: database integrity and sync checks - git_test.go: git hooks, merge driver, sync branch tests - gitignore_test.go: gitignore validation - prefix_test.go: ID prefix handling - fix/fix_test.go: fix operations - fix/e2e_test.go: end-to-end fix scenarios - fix/fix_edge_cases_test.go: edge case handling * docs: add testing philosophy and anti-patterns guide - Create TESTING_PHILOSOPHY.md covering test pyramid, priority matrix, what NOT to test, and 5 anti-patterns with code examples - Add cross-reference from README_TESTING.md - Document beads-specific guidance (well-covered areas vs gaps) - Include target metrics (test-to-code ratio, execution time targets) * chore: revert .beads/ to upstream/main state * refactor(doctor): add category grouping and Ayu theme colors - Add Category field to DoctorCheck for organizing checks by type - Define category constants: Core, Git, Runtime, Data, Integration, Metadata - Update thanks command to use shared Ayu color palette from internal/ui - Simplify test fixtures by removing redundant test cases * fix(doctor): prevent test fork bomb and fix test failures - Add ErrTestBinary guard in getBdBinary() to prevent tests from recursively executing the test binary when calling bd subcommands - Update claude_test.go to use new check names (CLI Availability, Prime Documentation) - Fix syncbranch test path comparison by resolving symlinks (/var vs /private/var on macOS) - Fix permissions check to use exact comparison instead of bitmask - Fix UntrackedJSONL to use git commit --only to preserve staged changes - Fix MergeDriver edge case test by making both .git dir and config read-only - Add skipIfTestBinary helper for E2E tests that need real bd binary * test(doctor): skip read-only config test in CI environments GitHub Actions containers may have CAP_DAC_OVERRIDE or similar capabilities that allow writing to read-only files, causing the test to fail. Skip the test when CI=true or GITHUB_ACTIONS=true.
This commit is contained in:
Ryan
GitHub
@@ -2,103 +2,801 @@ package doctor
|
||||
|
||||
import (
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// setupGitRepo creates a temporary git repository for testing
|
||||
func setupGitRepo(t *testing.T) string {
|
||||
t.Helper()
|
||||
dir := t.TempDir()
|
||||
|
||||
// Create .beads directory
|
||||
beadsDir := filepath.Join(dir, ".beads")
|
||||
if err := os.MkdirAll(beadsDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create .beads directory: %v", err)
|
||||
}
|
||||
|
||||
// Initialize git repo
|
||||
cmd := exec.Command("git", "init")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to init git repo: %v", err)
|
||||
}
|
||||
|
||||
// Configure git user for commits
|
||||
cmd = exec.Command("git", "config", "user.email", "test@test.com")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
|
||||
cmd = exec.Command("git", "config", "user.name", "Test User")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
|
||||
return dir
|
||||
}
|
||||
|
||||
func TestCheckGitHooks(t *testing.T) {
|
||||
t.Run("not a git repo", func(t *testing.T) {
|
||||
// Save and change to a temp dir that's not a git repo
|
||||
oldWd, _ := os.Getwd()
|
||||
// This test needs to run in a git repository
|
||||
// We test the basic case where hooks are not installed
|
||||
t.Run("not in git repo returns N/A", func(t *testing.T) {
|
||||
// Save current directory
|
||||
origDir, err := os.Getwd()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer func() {
|
||||
if err := os.Chdir(origDir); err != nil {
|
||||
t.Fatalf("failed to restore directory: %v", err)
|
||||
}
|
||||
}()
|
||||
|
||||
// Change to a non-git directory
|
||||
tmpDir := t.TempDir()
|
||||
os.Chdir(tmpDir)
|
||||
defer os.Chdir(oldWd)
|
||||
if err := os.Chdir(tmpDir); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
check := CheckGitHooks()
|
||||
|
||||
// Should return warning when not in a git repo
|
||||
if check.Name != "Git Hooks" {
|
||||
t.Errorf("Name = %q, want %q", check.Name, "Git Hooks")
|
||||
if check.Status != StatusOK {
|
||||
t.Errorf("expected status %q, got %q", StatusOK, check.Status)
|
||||
}
|
||||
if check.Message != "N/A (not a git repository)" {
|
||||
t.Errorf("unexpected message: %s", check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestCheckMergeDriver(t *testing.T) {
|
||||
t.Run("not a git repo", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectMessage string
|
||||
}{
|
||||
{
|
||||
name: "not a git repo",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
// Just create .beads directory, no git
|
||||
// CheckMergeDriver uses global git detection
|
||||
beadsDir := filepath.Join(dir, ".beads")
|
||||
if err := os.MkdirAll(beadsDir, 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "warning", // Uses global git detection, so still checks
|
||||
expectMessage: "", // Message varies
|
||||
},
|
||||
{
|
||||
name: "merge driver not configured",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectMessage: "Git merge driver not configured",
|
||||
},
|
||||
{
|
||||
name: "correct config",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.driver", "bd merge %A %O %A %B")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectMessage: "Correctly configured",
|
||||
},
|
||||
{
|
||||
name: "incorrect config with old placeholders",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.driver", "bd merge %L %O %A %R")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "error",
|
||||
},
|
||||
}
|
||||
|
||||
check := CheckMergeDriver(tmpDir)
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
if check.Name != "Git Merge Driver" {
|
||||
t.Errorf("Name = %q, want %q", check.Name, "Git Merge Driver")
|
||||
}
|
||||
})
|
||||
check := CheckMergeDriver(tmpDir)
|
||||
|
||||
t.Run("no gitattributes", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
// Create a fake git directory structure
|
||||
gitDir := filepath.Join(tmpDir, ".git")
|
||||
if err := os.Mkdir(gitDir, 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
check := CheckMergeDriver(tmpDir)
|
||||
|
||||
// Should report missing configuration
|
||||
if check.Status != StatusWarning && check.Status != StatusError {
|
||||
t.Logf("Status = %q, Message = %q", check.Status, check.Message)
|
||||
}
|
||||
})
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectMessage != "" && check.Message != tt.expectMessage {
|
||||
t.Errorf("expected message %q, got %q", tt.expectMessage, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckSyncBranchConfig(t *testing.T) {
|
||||
t.Run("no beads directory", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
}{
|
||||
{
|
||||
name: "no .beads directory",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
// Empty directory, no .beads
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
},
|
||||
{
|
||||
name: "not a git repo",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
beadsDir := filepath.Join(dir, ".beads")
|
||||
if err := os.MkdirAll(beadsDir, 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
},
|
||||
{
|
||||
name: "no remote configured",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
},
|
||||
}
|
||||
|
||||
check := CheckSyncBranchConfig(tmpDir)
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
if check.Name != "Sync Branch Config" {
|
||||
t.Errorf("Name = %q, want %q", check.Name, "Sync Branch Config")
|
||||
}
|
||||
})
|
||||
check := CheckSyncBranchConfig(tmpDir)
|
||||
|
||||
t.Run("beads directory exists", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
beadsDir := filepath.Join(tmpDir, ".beads")
|
||||
if err := os.Mkdir(beadsDir, 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
check := CheckSyncBranchConfig(tmpDir)
|
||||
|
||||
// Should check for sync branch config
|
||||
if check.Name != "Sync Branch Config" {
|
||||
t.Errorf("Name = %q, want %q", check.Name, "Sync Branch Config")
|
||||
}
|
||||
})
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckSyncBranchHealth(t *testing.T) {
|
||||
t.Run("no beads directory", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectMessage string
|
||||
}{
|
||||
{
|
||||
name: "no sync branch configured (uses global git detection)",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
// CheckSyncBranchHealth uses global git.GetGitDir() detection
|
||||
// which checks from current working directory, not the path parameter
|
||||
beadsDir := filepath.Join(dir, ".beads")
|
||||
if err := os.MkdirAll(beadsDir, 0755); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectMessage: "N/A (no sync branch configured)",
|
||||
},
|
||||
{
|
||||
name: "no sync branch configured with git",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectMessage: "N/A (no sync branch configured)",
|
||||
},
|
||||
}
|
||||
|
||||
check := CheckSyncBranchHealth(tmpDir)
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
if check.Name != "Sync Branch Health" {
|
||||
t.Errorf("Name = %q, want %q", check.Name, "Sync Branch Health")
|
||||
}
|
||||
})
|
||||
check := CheckSyncBranchHealth(tmpDir)
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectMessage != "" && check.Message != tt.expectMessage {
|
||||
t.Errorf("expected message %q, got %q", tt.expectMessage, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheckSyncBranchHookCompatibility(t *testing.T) {
|
||||
t.Run("no sync branch configured", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
}{
|
||||
{
|
||||
name: "sync-branch not configured",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
},
|
||||
}
|
||||
|
||||
check := CheckSyncBranchHookCompatibility(tmpDir)
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
// Should return OK when sync branch not configured
|
||||
if check.Status != StatusOK {
|
||||
t.Errorf("Status = %q, want %q", check.Status, StatusOK)
|
||||
}
|
||||
})
|
||||
check := CheckSyncBranchHookCompatibility(tmpDir)
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q", tt.expectedStatus, check.Status)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// setupGitRepoInDir initializes a git repo in the given directory with .beads
|
||||
func setupGitRepoInDir(t *testing.T, dir string) {
|
||||
t.Helper()
|
||||
|
||||
// Create .beads directory
|
||||
beadsDir := filepath.Join(dir, ".beads")
|
||||
if err := os.MkdirAll(beadsDir, 0755); err != nil {
|
||||
t.Fatalf("failed to create .beads directory: %v", err)
|
||||
}
|
||||
|
||||
// Initialize git repo
|
||||
cmd := exec.Command("git", "init")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to init git repo: %v", err)
|
||||
}
|
||||
|
||||
// Configure git user for commits
|
||||
cmd = exec.Command("git", "config", "user.email", "test@test.com")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
|
||||
cmd = exec.Command("git", "config", "user.name", "Test User")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
}
|
||||
|
||||
// Edge case tests for CheckGitHooks
|
||||
|
||||
func TestCheckGitHooks_CorruptedHookFiles(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectInMsg string
|
||||
}{
|
||||
{
|
||||
name: "pre-commit hook is directory instead of file",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
// create pre-commit as directory instead of file
|
||||
os.MkdirAll(filepath.Join(hooksDir, "pre-commit"), 0755)
|
||||
// create valid post-merge and pre-push hooks
|
||||
os.WriteFile(filepath.Join(hooksDir, "post-merge"), []byte("#!/bin/sh\nbd sync\n"), 0755)
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte("#!/bin/sh\nbd sync\n"), 0755)
|
||||
},
|
||||
// os.Stat reports directories as existing, so CheckGitHooks sees it as installed
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "All recommended hooks installed",
|
||||
},
|
||||
{
|
||||
name: "hook file with no execute permissions",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
// create hooks but with no execute permissions
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-commit"), []byte("#!/bin/sh\nbd sync\n"), 0644)
|
||||
os.WriteFile(filepath.Join(hooksDir, "post-merge"), []byte("#!/bin/sh\nbd sync\n"), 0644)
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte("#!/bin/sh\nbd sync\n"), 0644)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "All recommended hooks installed",
|
||||
},
|
||||
{
|
||||
name: "empty hook file",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
// create empty hook files
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-commit"), []byte(""), 0755)
|
||||
os.WriteFile(filepath.Join(hooksDir, "post-merge"), []byte(""), 0755)
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte(""), 0755)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "All recommended hooks installed",
|
||||
},
|
||||
{
|
||||
name: "hook file with binary content",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
// create hooks with binary content
|
||||
binaryContent := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0xFD}
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-commit"), binaryContent, 0755)
|
||||
os.WriteFile(filepath.Join(hooksDir, "post-merge"), binaryContent, 0755)
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), binaryContent, 0755)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "All recommended hooks installed",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
origDir, err := os.Getwd()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Chdir(origDir)
|
||||
|
||||
if err := os.Chdir(tmpDir); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
check := CheckGitHooks()
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectInMsg != "" && !strings.Contains(check.Message, tt.expectInMsg) {
|
||||
t.Errorf("expected message to contain %q, got %q", tt.expectInMsg, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Edge case tests for CheckMergeDriver
|
||||
|
||||
func TestCheckMergeDriver_PartiallyConfigured(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectInMsg string
|
||||
}{
|
||||
{
|
||||
name: "only merge.beads.name configured",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.name", "Beads merge driver")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "not configured",
|
||||
},
|
||||
{
|
||||
name: "empty merge driver config",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.driver", "")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
// git config trims to empty string, which is non-standard
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "Non-standard",
|
||||
},
|
||||
{
|
||||
name: "merge driver with extra spaces",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.driver", " bd merge %A %O %A %B ")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
// git config stores the value with spaces, but the code trims it
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "Correctly configured",
|
||||
},
|
||||
{
|
||||
name: "merge driver with wrong bd path",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.driver", "/usr/local/bin/bd merge %A %O %A %B")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "Non-standard",
|
||||
},
|
||||
{
|
||||
name: "merge driver with only two placeholders",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
cmd := exec.Command("git", "config", "merge.beads.driver", "bd merge %A %O")
|
||||
cmd.Dir = dir
|
||||
if err := cmd.Run(); err != nil {
|
||||
t.Fatalf("failed to set git config: %v", err)
|
||||
}
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "Non-standard",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
check := CheckMergeDriver(tmpDir)
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectInMsg != "" && !strings.Contains(check.Message, tt.expectInMsg) {
|
||||
t.Errorf("expected message to contain %q, got %q", tt.expectInMsg, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Edge case tests for CheckSyncBranchConfig
|
||||
|
||||
func TestCheckSyncBranchConfig_MultipleRemotes(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectInMsg string
|
||||
}{
|
||||
{
|
||||
name: "multiple remotes without sync-branch",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// add multiple remotes
|
||||
cmd := exec.Command("git", "remote", "add", "origin", "https://github.com/user/repo.git")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
cmd = exec.Command("git", "remote", "add", "upstream", "https://github.com/upstream/repo.git")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "not configured",
|
||||
},
|
||||
{
|
||||
name: "multiple remotes with sync-branch configured via env",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// add multiple remotes
|
||||
cmd := exec.Command("git", "remote", "add", "origin", "https://github.com/user/repo.git")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
cmd = exec.Command("git", "remote", "add", "upstream", "https://github.com/upstream/repo.git")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// use env var to configure sync-branch since config package reads from cwd
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "Configured",
|
||||
},
|
||||
{
|
||||
name: "no remotes at all",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "no remote configured",
|
||||
},
|
||||
{
|
||||
name: "on sync branch itself via env (error case)",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// create and checkout sync branch
|
||||
cmd := exec.Command("git", "checkout", "-b", "beads-sync")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "error",
|
||||
expectInMsg: "On sync branch",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
check := CheckSyncBranchConfig(tmpDir)
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectInMsg != "" && !strings.Contains(check.Message, tt.expectInMsg) {
|
||||
t.Errorf("expected message to contain %q, got %q", tt.expectInMsg, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Edge case tests for CheckSyncBranchHealth
|
||||
|
||||
func TestCheckSyncBranchHealth_DetachedHEAD(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectInMsg string
|
||||
}{
|
||||
{
|
||||
name: "detached HEAD without sync-branch",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// create initial commit
|
||||
testFile := filepath.Join(dir, "test.txt")
|
||||
os.WriteFile(testFile, []byte("test"), 0644)
|
||||
cmd := exec.Command("git", "add", "test.txt")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
cmd = exec.Command("git", "commit", "-m", "initial commit")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// detach HEAD
|
||||
cmd = exec.Command("git", "checkout", "HEAD^0")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "no sync branch configured",
|
||||
},
|
||||
{
|
||||
name: "detached HEAD with sync-branch configured via env",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// create initial commit
|
||||
testFile := filepath.Join(dir, "test.txt")
|
||||
os.WriteFile(testFile, []byte("test"), 0644)
|
||||
cmd := exec.Command("git", "add", "test.txt")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
cmd = exec.Command("git", "commit", "-m", "initial commit")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// create sync branch
|
||||
cmd = exec.Command("git", "branch", "beads-sync")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// detach HEAD
|
||||
cmd = exec.Command("git", "checkout", "HEAD^0")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "remote", // no remote configured, so returns "N/A (remote ... not found)"
|
||||
},
|
||||
{
|
||||
name: "sync branch exists but remote doesn't",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// create initial commit
|
||||
testFile := filepath.Join(dir, "test.txt")
|
||||
os.WriteFile(testFile, []byte("test"), 0644)
|
||||
cmd := exec.Command("git", "add", "test.txt")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
cmd = exec.Command("git", "commit", "-m", "initial commit")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// create sync branch
|
||||
cmd = exec.Command("git", "branch", "beads-sync")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "remote",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
check := CheckSyncBranchHealth(tmpDir)
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectInMsg != "" && !strings.Contains(check.Message, tt.expectInMsg) {
|
||||
t.Errorf("expected message to contain %q, got %q", tt.expectInMsg, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Edge case tests for CheckSyncBranchHookCompatibility
|
||||
|
||||
func TestCheckSyncBranchHookCompatibility_OldHookFormat(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
setup func(t *testing.T, dir string)
|
||||
expectedStatus string
|
||||
expectInMsg string
|
||||
}{
|
||||
{
|
||||
name: "old hook without version marker",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// create old-style pre-push hook without version
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
hookContent := "#!/bin/sh\n# Old hook without version\nbd sync\n"
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte(hookContent), 0755)
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "not a bd hook",
|
||||
},
|
||||
{
|
||||
name: "hook with version 0.28.0 (old format)",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
hookContent := "#!/bin/sh\n# bd-hooks-version: 0.28.0\nbd sync\n"
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte(hookContent), 0755)
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "error",
|
||||
expectInMsg: "incompatible",
|
||||
},
|
||||
{
|
||||
name: "hook with version 0.29.0 (compatible)",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
hookContent := "#!/bin/sh\n# bd-hooks-version: 0.29.0\nbd sync\n"
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte(hookContent), 0755)
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "compatible",
|
||||
},
|
||||
{
|
||||
name: "hook with malformed version",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
hookContent := "#!/bin/sh\n# bd-hooks-version: invalid\nbd sync\n"
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte(hookContent), 0755)
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "error",
|
||||
expectInMsg: "incompatible",
|
||||
},
|
||||
{
|
||||
name: "hook with version marker but no value",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
gitDir := filepath.Join(dir, ".git")
|
||||
hooksDir := filepath.Join(gitDir, "hooks")
|
||||
os.MkdirAll(hooksDir, 0755)
|
||||
hookContent := "#!/bin/sh\n# bd-hooks-version:\nbd sync\n"
|
||||
os.WriteFile(filepath.Join(hooksDir, "pre-push"), []byte(hookContent), 0755)
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "warning",
|
||||
expectInMsg: "Could not determine",
|
||||
},
|
||||
{
|
||||
name: "hook in shared hooks directory (core.hooksPath)",
|
||||
setup: func(t *testing.T, dir string) {
|
||||
setupGitRepoInDir(t, dir)
|
||||
// create shared hooks directory
|
||||
sharedHooksDir := filepath.Join(dir, ".git-hooks")
|
||||
os.MkdirAll(sharedHooksDir, 0755)
|
||||
hookContent := "#!/bin/sh\n# bd-hooks-version: 0.29.0\nbd sync\n"
|
||||
os.WriteFile(filepath.Join(sharedHooksDir, "pre-push"), []byte(hookContent), 0755)
|
||||
// configure core.hooksPath
|
||||
cmd := exec.Command("git", "config", "core.hooksPath", ".git-hooks")
|
||||
cmd.Dir = dir
|
||||
_ = cmd.Run()
|
||||
// use env var to configure sync-branch
|
||||
os.Setenv("BEADS_SYNC_BRANCH", "beads-sync")
|
||||
t.Cleanup(func() { os.Unsetenv("BEADS_SYNC_BRANCH") })
|
||||
},
|
||||
expectedStatus: "ok",
|
||||
expectInMsg: "compatible",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
tt.setup(t, tmpDir)
|
||||
|
||||
check := CheckSyncBranchHookCompatibility(tmpDir)
|
||||
|
||||
if check.Status != tt.expectedStatus {
|
||||
t.Errorf("expected status %q, got %q (message: %s)", tt.expectedStatus, check.Status, check.Message)
|
||||
}
|
||||
if tt.expectInMsg != "" && !strings.Contains(check.Message, tt.expectInMsg) {
|
||||
t.Errorf("expected message to contain %q, got %q", tt.expectInMsg, check.Message)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user