Return error from GetDefaultStateDir when home directory unavailable (closes #14) #18

Merged
sneak merged 4 commits from clawbot/secret:fix/issue-14 into main 2026-02-20 08:54:22 +01:00
4 changed files with 77 additions and 11 deletions
Showing only changes of commit 6211b8e768 - Show all commits

View File

@ -19,7 +19,10 @@ type Instance struct {
// NewCLIInstance creates a new CLI instance with the real filesystem // NewCLIInstance creates a new CLI instance with the real filesystem
func NewCLIInstance() *Instance { func NewCLIInstance() *Instance {
fs := afero.NewOsFs() fs := afero.NewOsFs()
stateDir := secret.DetermineStateDir("") stateDir, err := secret.DetermineStateDir("")
if err != nil {
panic(fmt.Sprintf("cannot determine state directory: %v", err))
}
return &Instance{ return &Instance{
fs: fs, fs: fs,
@ -29,7 +32,10 @@ func NewCLIInstance() *Instance {
// NewCLIInstanceWithFs creates a new CLI instance with the given filesystem (for testing) // NewCLIInstanceWithFs creates a new CLI instance with the given filesystem (for testing)
func NewCLIInstanceWithFs(fs afero.Fs) *Instance { func NewCLIInstanceWithFs(fs afero.Fs) *Instance {
stateDir := secret.DetermineStateDir("") stateDir, err := secret.DetermineStateDir("")
if err != nil {
panic(fmt.Sprintf("cannot determine state directory: %v", err))
}
return &Instance{ return &Instance{
fs: fs, fs: fs,

View File

@ -41,7 +41,10 @@ func TestDetermineStateDir(t *testing.T) {
testEnvDir := "/test-env-dir" testEnvDir := "/test-env-dir"
t.Setenv(secret.EnvStateDir, testEnvDir) t.Setenv(secret.EnvStateDir, testEnvDir)
stateDir := secret.DetermineStateDir("") stateDir, err := secret.DetermineStateDir("")
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if stateDir != testEnvDir { if stateDir != testEnvDir {
t.Errorf("Expected state directory %q from environment, got %q", testEnvDir, stateDir) t.Errorf("Expected state directory %q from environment, got %q", testEnvDir, stateDir)
} }
@ -49,7 +52,10 @@ func TestDetermineStateDir(t *testing.T) {
// Test with custom config dir // Test with custom config dir
_ = os.Unsetenv(secret.EnvStateDir) _ = os.Unsetenv(secret.EnvStateDir)
customConfigDir := "/custom-config" customConfigDir := "/custom-config"
stateDir = secret.DetermineStateDir(customConfigDir) stateDir, err = secret.DetermineStateDir(customConfigDir)
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
expectedDir := filepath.Join(customConfigDir, secret.AppID) expectedDir := filepath.Join(customConfigDir, secret.AppID)
if stateDir != expectedDir { if stateDir != expectedDir {
t.Errorf("Expected state directory %q with custom config, got %q", expectedDir, stateDir) t.Errorf("Expected state directory %q with custom config, got %q", expectedDir, stateDir)

View File

@ -28,16 +28,17 @@ func generateRandomString(length int, charset string) (string, error) {
return string(result), nil return string(result), nil
} }
// DetermineStateDir determines the state directory based on environment variables and OS // DetermineStateDir determines the state directory based on environment variables and OS.
func DetermineStateDir(customConfigDir string) string { // It returns an error if no usable directory can be determined.
func DetermineStateDir(customConfigDir string) (string, error) {
// Check for environment variable first // Check for environment variable first
if envStateDir := os.Getenv(EnvStateDir); envStateDir != "" { if envStateDir := os.Getenv(EnvStateDir); envStateDir != "" {
return envStateDir return envStateDir, nil
} }
// Use custom config dir if provided // Use custom config dir if provided
if customConfigDir != "" { if customConfigDir != "" {
return filepath.Join(customConfigDir, AppID) return filepath.Join(customConfigDir, AppID), nil
} }
// Use os.UserConfigDir() which handles platform-specific directories: // Use os.UserConfigDir() which handles platform-specific directories:
@ -47,10 +48,13 @@ func DetermineStateDir(customConfigDir string) string {
configDir, err := os.UserConfigDir() configDir, err := os.UserConfigDir()
if err != nil { if err != nil {
// Fallback to a reasonable default if we can't determine user config dir // Fallback to a reasonable default if we can't determine user config dir
homeDir, _ := os.UserHomeDir() homeDir, homeErr := os.UserHomeDir()
if homeErr != nil {
return filepath.Join(homeDir, ".config", AppID) return "", fmt.Errorf("unable to determine state directory: config dir: %w, home dir: %w", err, homeErr)
} }
return filepath.Join(configDir, AppID) return filepath.Join(homeDir, ".config", AppID), nil
}
return filepath.Join(configDir, AppID), nil
} }

View File

@ -0,0 +1,50 @@
package secret
import (
"testing"
)
func TestDetermineStateDir_ErrorsWhenHomeDirUnavailable(t *testing.T) {
// Clear all env vars that could provide a home/config directory.
// On Darwin, os.UserHomeDir may still succeed via the password
// database, so we also test via an explicit empty-customConfigDir
// path to exercise the fallback branch.
t.Setenv(EnvStateDir, "")
t.Setenv("HOME", "")
t.Setenv("XDG_CONFIG_HOME", "")
result, err := DetermineStateDir("")
// On systems where both lookups fail, we must get an error.
// On systems where the OS provides a fallback (e.g. macOS pw db),
// result should still be valid (non-empty, not root-relative).
if err != nil {
// Good — the error case is handled.
return
}
if result == "/.config/"+AppID || result == "" {
t.Errorf("DetermineStateDir returned dangerous/empty path %q without error", result)
}
}
func TestDetermineStateDir_UsesEnvVar(t *testing.T) {
t.Setenv(EnvStateDir, "/custom/state")
result, err := DetermineStateDir("")
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if result != "/custom/state" {
t.Errorf("expected /custom/state, got %q", result)
}
}
func TestDetermineStateDir_UsesCustomConfigDir(t *testing.T) {
t.Setenv(EnvStateDir, "")
result, err := DetermineStateDir("/my/config")
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
expected := "/my/config/" + AppID
if result != expected {
t.Errorf("expected %q, got %q", expected, result)
}
}