johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: isolate TestSetupGlobalGitIgnore_ReadOnly from user's git config (#1045)

Browse Source 
The test was failing because it called 'git config --global core.excludesfile'
which returned the real user's gitignore path instead of using the test's
temp directory.

Fix: Set GIT_CONFIG_GLOBAL env var to an empty temp config file, ensuring
the test uses the temp directory's .config/git/ignore path as intended.

Also extracted the isolation logic into a reusable setupIsolatedGitConfig helper.

Co-authored-by: Ismar Iljazovic <ismar@gmail.com>
This commit is contained in:
Ismar
2026-01-13 01:42:30 +01:00
committed by GitHub
parent 75f03b782f
commit dc28efe9d1
1 changed files with 28 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
cmd/bd/init_test.go
View File

@@ -49,7 +49,7 @@ func TestInitCommand(t *testing.T) {
origDBPath := dbPath
defer func() { dbPath = origDBPath }()
dbPath = ""
// Reset Cobra command state
rootCmd.SetArgs([]string{})
initCmd.Flags().Set("prefix", "")
@@ -141,19 +141,19 @@ func TestInitCommand(t *testing.T) {
// Verify database was created (always beads.db now)
dbPath := filepath.Join(beadsDir, "beads.db")
if _, err := os.Stat(dbPath); os.IsNotExist(err) {
t.Errorf("Database file was not created at %s", dbPath)
t.Errorf("Database file was not created at %s", dbPath)
}
// Verify database has correct prefix
// Note: This database was already created by init command, just open it
store, err := openExistingTestDB(t, dbPath)
store, err := openExistingTestDB(t, dbPath)
if err != nil {
t.Fatalf("Failed to open database: %v", err)
}
defer store.Close()
t.Fatalf("Failed to open database: %v", err)
}
defer store.Close()
ctx := context.Background()
prefix, err := store.GetConfig(ctx, "issue_prefix")
ctx := context.Background()
prefix, err := store.GetConfig(ctx, "issue_prefix")
if err != nil {
t.Fatalf("Failed to get issue prefix from database: %v", err)
}
@@ -436,14 +436,14 @@ func TestInitWithCustomDBPath(t *testing.T) {
}
})
// Test with multiple BEADS_DB variations
// Test with multiple BEADS_DB variations
t.Run("BEADS_DB with subdirectories", func(t *testing.T) {
dbPath = "" // Reset global
envPath := filepath.Join(tmpDir, "env", "subdirs", "test.db")
os.Setenv("BEADS_DB", envPath)
defer os.Unsetenv("BEADS_DB")
rootCmd.SetArgs([]string{"init", "--prefix", "envtest2", "--quiet"})
if err := rootCmd.Execute(); err != nil {
@@ -454,7 +454,7 @@ func TestInitWithCustomDBPath(t *testing.T) {
if _, err := os.Stat(envPath); os.IsNotExist(err) {
t.Errorf("Database was not created at BEADS_DB path %s", envPath)
}
// Verify .beads/ directory was NOT created in work directory
if _, err := os.Stat(filepath.Join(workDir, ".beads")); err == nil {
t.Error(".beads/ directory should not be created in CWD when BEADS_DB is set")
@@ -1188,8 +1188,8 @@ func TestInitBranchPersistsToConfigYaml(t *testing.T) {
// The bug: sync-branch remains commented as "# sync-branch:" instead of "sync-branch:"
// This test should FAIL on the current codebase to prove the bug exists
if strings.Contains(configStr, "# sync-branch:") && !strings.Contains(configStr, "\nsync-branch:") {
t.Errorf("BUG: --branch flag did not persist to config.yaml\n"+
"Expected uncommented 'sync-branch: \"beads-sync\"'\n"+
t.Errorf("BUG: --branch flag did not persist to config.yaml\n" +
"Expected uncommented 'sync-branch: \"beads-sync\"'\n" +
"Got commented '# sync-branch:' (only set in database, not config.yaml)")
}
@@ -1257,11 +1257,24 @@ func TestInitReinitWithBranch(t *testing.T) {
}
}
// setupIsolatedGitConfig creates an empty git config in tmpDir and sets GIT_CONFIG_GLOBAL
// to prevent tests from using the real user's global git config.
func setupIsolatedGitConfig(t *testing.T, tmpDir string) {
t.Helper()
gitConfigPath := filepath.Join(tmpDir, ".gitconfig")
if err := os.WriteFile(gitConfigPath, []byte(""), 0644); err != nil {
t.Fatal(err)
}
t.Setenv("GIT_CONFIG_GLOBAL", gitConfigPath)
}
// TestSetupGlobalGitIgnore_ReadOnly verifies graceful handling when the
// gitignore file cannot be written (prints manual instructions instead of failing).
func TestSetupGlobalGitIgnore_ReadOnly(t *testing.T) {
t.Run("read-only file", func(t *testing.T) {
tmpDir := t.TempDir()
setupIsolatedGitConfig(t, tmpDir)
configDir := filepath.Join(tmpDir, ".config", "git")
if err := os.MkdirAll(configDir, 0755); err != nil {
t.Fatal(err)
@@ -1290,6 +1303,7 @@ func TestSetupGlobalGitIgnore_ReadOnly(t *testing.T) {
t.Run("symlink to read-only file", func(t *testing.T) {
tmpDir := t.TempDir()
setupIsolatedGitConfig(t, tmpDir)
// Target file in a separate location
targetDir := filepath.Join(tmpDir, "target")