Merge pull request #139 from carolynvs/symlink-foo

Resolve PORTER_HOME when it's symlinked

pkg/config/config.go

@@ -23,9 +23,16 @@ const (
 	EnvACTION = "CNAB_ACTION"
 )
 
+// These are functions that afero doesn't support, so this lets us stub them out for tests to set the
+// location of the current executable porter binary and resolve PORTER_HOME.
+var getExecutable = os.Executable
+var evalSymlinks = filepath.EvalSymlinks
+
 type Config struct {
 	*context.Context
 	Manifest *Manifest
+
+	porterHome string
 }
 
 // New Config initializes a default porter configuration.
@@ -37,19 +44,34 @@ func New() *Config {
 
 // GetHomeDir determines the path to the porter home directory.
 func (c *Config) GetHomeDir() (string, error) {
-	home, ok := os.LookupEnv(EnvHOME)
-	if ok {
-		return home, nil
+	if c.porterHome != "" {
+		return c.porterHome, nil
 	}
 
-	porterPath, err := os.Executable()
-	if err != nil {
-		return "", errors.Wrap(err, "could not get path to the executing porter binary")
-	}
+	home := os.Getenv(EnvHOME)
 
-	porterDir := filepath.Dir(porterPath)
+	if home == "" {
+		porterPath, err := getExecutable()
+		if err != nil {
+			return "", errors.Wrap(err, "could not get path to the executing porter binary")
+		}
+
+		// This is for the scenario when someone symlinks the ~/.porter/porter binary to /usr/local/porter
+		// We try to resolve back to the original location so that we can find the mixins, etc next to it.
+		hardPath, err := evalSymlinks(porterPath)
+		if err != nil { // if we have trouble resolving symlinks, skip trying to help people who used symlinks
+			fmt.Fprintln(c.Err, errors.Wrapf(err, "WARNING could not resolve %s for symbolic links\n", porterPath))
+		} else if hardPath != porterPath {
+			if c.Debug {
+				fmt.Fprintf(c.Err, "Resolved porter binary from %s to %s\n", porterPath, hardPath)
+			}
+			porterPath = hardPath
+		}
+		home = filepath.Dir(porterPath)
+	}
 
-	return porterDir, nil
+	c.porterHome = home
+	return c.porterHome, nil
 }
 
 // GetTemplatesDir determines the path to the templates directory.

pkg/config/config_test.go

@@ -12,28 +12,33 @@ import (
 
 func TestConfig_GetHomeDir(t *testing.T) {
 	c := NewTestConfig(t)
-
-	// Set up a test porter home
-	testEntrypoint, err := os.Executable()
-	testHome := filepath.Dir(testEntrypoint)
-	require.NoError(t, err)
-	err = c.FileSystem.MkdirAll(testHome, os.ModePerm)
-	require.NoError(t, err)
+	c.SetupPorterHome()
 
 	home, err := c.GetHomeDir()
 	require.NoError(t, err)
 
-	assert.Equal(t, testHome, home)
+	assert.Equal(t, "/root/.porter", home)
 }
 
-func TestConfig_GetHomeDir_HomeSet(t *testing.T) {
+func TestConfig_GetHomeDirFromSymlink(t *testing.T) {
 	c := NewTestConfig(t)
 	c.SetupPorterHome()
 
+	// Set up no PORTER_HOME, and /usr/local/bin/porter -> ~/.porter/porter
+	os.Unsetenv(EnvHOME)
+	getExecutable = func() (string, error) {
+		return "/usr/local/bin/porter", nil
+	}
+	evalSymlinks = func(path string) (string, error) {
+		return "/root/.porter/porter", nil
+	}
+
 	home, err := c.GetHomeDir()
 	require.NoError(t, err)
 
-	assert.Equal(t, "/root/.porter", home)
+	// The reason why we do filepath.join here and not above is because resolving symlinks gets the OS involved
+	// and on Windows, that means flipping the afero `/` to `\`.
+	assert.Equal(t, filepath.Join("/root", ".porter"), home)
 }
 
 func TestConfig_GetPorterConfigTemplate(t *testing.T) {