Add CREDHUB_HOME env variable to override default home

README.md

@@ -47,4 +47,8 @@ CredHub CLI can be used to manage credentials stored in a CredHub server. You mu
 
 To see the API calls made by each CLI command, `export CREDHUB_DEBUG=true`.
 
+#### Config Location:
+
+By default, the CLI stores its configuration (`config.json`) in a `.credhub` directory inside the current user's home directory (`$HOME` on Linux/macOS, `%USERPROFILE%` on Windows). Set `CREDHUB_HOME` to override this and store the configuration under a different directory instead.
+
 [1]:https://docs.cloudfoundry.org/api/credhub/

config/config_unix.go

@@ -8,7 +8,11 @@ import (
 )
 
 func userHomeDir() string {
-	return os.Getenv("HOME")
+	home := os.Getenv("CREDHUB_HOME")
+	if home == "" {
+		home = os.Getenv("HOME")
+	}
+	return home
 }
 
 func makeDirectory() error {

config/config_unix_test.go

@@ -40,4 +40,38 @@ var _ = Describe("Config", func() {
 		fileStat, _ := os.Stat(config.ConfigPath())
 		Expect(fileStat.Mode().String()).To(Equal("-rw-------"))
 	})
+
+	Describe("CREDHUB_HOME", func() {
+		var originalCredhubHome string
+		var originalHome string
+		var hadCredhubHome bool
+
+		BeforeEach(func() {
+			originalCredhubHome, hadCredhubHome = os.LookupEnv("CREDHUB_HOME")
+			originalHome = os.Getenv("HOME")
+		})
+
+		AfterEach(func() {
+			if hadCredhubHome {
+				os.Setenv("CREDHUB_HOME", originalCredhubHome)
+			} else {
+				os.Unsetenv("CREDHUB_HOME")
+			}
+			os.Setenv("HOME", originalHome)
+		})
+
+		It("uses CREDHUB_HOME instead of HOME when set", func() {
+			os.Setenv("HOME", "/home/original-user")
+			os.Setenv("CREDHUB_HOME", "/custom/credhub/home")
+
+			Expect(config.ConfigDir()).To(Equal("/custom/credhub/home/.credhub"))
+		})
+
+		It("falls back to HOME when CREDHUB_HOME is not set", func() {
+			os.Setenv("HOME", "/home/original-user")
+			os.Unsetenv("CREDHUB_HOME")
+
+			Expect(config.ConfigDir()).To(Equal("/home/original-user/.credhub"))
+		})
+	})
 })

config/config_win.go

@@ -9,6 +9,11 @@ import (
 )
 
 func userHomeDir() string {
+	home := os.Getenv("CREDHUB_HOME")
+	if home != "" {
+		return home
+	}
+
 	home := os.Getenv("HOMEDRIVE") + os.Getenv("HOMEPATH")
 	if home == "" {
 		home = os.Getenv("USERPROFILE")

config/config_win_test.go

@@ -4,6 +4,7 @@
 package config_test
 
 import (
+	"os"
 	"syscall"
 
 	"code.cloudfoundry.org/credhub-cli/config"
@@ -35,4 +36,38 @@ var _ = Describe("Config (windows specific)", func() {
 
 		Expect(attrs & syscall.FILE_ATTRIBUTE_HIDDEN).To(Equal(uint32(syscall.FILE_ATTRIBUTE_HIDDEN)))
 	})
+
+	Describe("CREDHUB_HOME", func() {
+		var originalCredhubHome string
+		var originalUserProfile string
+		var hadCredhubHome bool
+
+		BeforeEach(func() {
+			originalCredhubHome, hadCredhubHome = os.LookupEnv("CREDHUB_HOME")
+			originalUserProfile = os.Getenv("USERPROFILE")
+		})
+
+		AfterEach(func() {
+			if hadCredhubHome {
+				os.Setenv("CREDHUB_HOME", originalCredhubHome)
+			} else {
+				os.Unsetenv("CREDHUB_HOME")
+			}
+			os.Setenv("USERPROFILE", originalUserProfile)
+		})
+
+		It("uses CREDHUB_HOME instead of USERPROFILE when set", func() {
+			os.Setenv("USERPROFILE", `C:\Users\original-user`)
+			os.Setenv("CREDHUB_HOME", `C:\custom\credhub\home`)
+
+			Expect(config.ConfigDir()).To(Equal(`C:\custom\credhub\home\.credhub`))
+		})
+
+		It("falls back to USERPROFILE when CREDHUB_HOME is not set", func() {
+			os.Setenv("USERPROFILE", `C:\Users\original-user`)
+			os.Unsetenv("CREDHUB_HOME")
+
+			Expect(config.ConfigDir()).To(Equal(`C:\Users\original-user\.credhub`))
+		})
+	})
 })