Merge pull request #579 from 9999years/fix-578

Fix when tree root is symlink

Author: brianmcgee

cmd/format/format.go

@@ -221,23 +221,22 @@ func Run(v *viper.Viper, statz *stats.Stats, cmd *cobra.Command, paths []string)
 // Symlinks are allowed in `paths` and we resolve them here, since
 // the readers will ignore symlinks.
 func resolvePaths(paths []string, walkType walk.Type, treeRoot string) error {
-	for i, path := range paths {
-		log.Debugf("Resolving path '%s': %v", path, walkType)
+	// Note: `treeRoot` may itself be or contain a symlink (e.g. it is in
+	// `$TMPDIR` on macOS or a user has set a symlink to shorten the repository
+	// path for path length restrictions), so we resolve it here first.
+	//
+	// See: https://github.com/numtide/treefmt/issues/578
+	treeRoot, err := resolvePath(walkType, treeRoot)
+	if err != nil {
+		return fmt.Errorf("error computing absolute path of %s: %w", treeRoot, err)
+	}
 
-		absolutePath, err := filepath.Abs(path)
+	for i, path := range paths {
+		absolutePath, err := resolvePath(walkType, path)
 		if err != nil {
 			return fmt.Errorf("error computing absolute path of %s: %w", path, err)
 		}
 
-		if walkType != walk.Stdin {
-			realPath, err := filepath.EvalSymlinks(absolutePath)
-			if err != nil {
-				return fmt.Errorf("path %s not found: %w", absolutePath, err)
-			}
-
-			absolutePath = realPath
-		}
-
 		relativePath, err := filepath.Rel(treeRoot, absolutePath)
 		if err != nil {
 			return fmt.Errorf("error computing relative path from %s to %s: %w", treeRoot, absolutePath, err)
@@ -252,3 +251,24 @@ func resolvePaths(paths []string, walkType walk.Type, treeRoot string) error {
 
 	return nil
 }
+
+// Resolve a path to an absolute path, resolving symlinks if necessary.
+func resolvePath(walkType walk.Type, path string) (string, error) {
+	log.Debugf("Resolving path '%s': %v", path, walkType)
+
+	absolutePath, err := filepath.Abs(path)
+	if err != nil {
+		return "", fmt.Errorf("error computing absolute path of %s: %w", path, err)
+	}
+
+	if walkType != walk.Stdin {
+		realPath, err := filepath.EvalSymlinks(absolutePath)
+		if err != nil {
+			return "", fmt.Errorf("path %s not found: %w", absolutePath, err)
+		}
+
+		absolutePath = realPath
+	}
+
+	return absolutePath, nil
+}

cmd/root_test.go

@@ -2099,6 +2099,44 @@ func TestRunInSubdir(t *testing.T) {
 	}
 }
 
+// Check that supplying paths on the command-line works when an element of the
+// project root is a symlink.
+//
+// Regression test for #578.
+//
+// See: https://github.com/numtide/treefmt/issues/578
+func TestProjectRootIsSymlink(t *testing.T) {
+	as := require.New(t)
+
+	tempDir := t.TempDir()
+	realRoot := filepath.Join(tempDir, "/real-root")
+	test.TempExamplesInDir(t, realRoot)
+
+	symlinkRoot := filepath.Join(tempDir, "/project-root")
+	err := os.Symlink(realRoot, symlinkRoot)
+	as.NoError(err)
+
+	test.ChangeWorkDir(t, symlinkRoot)
+
+	// basic config
+	cfg := &config.Config{
+		FormatterConfigs: map[string]*config.Formatter{
+			"echo": {
+				Command:  "echo",
+				Includes: []string{"*"},
+			},
+		},
+	}
+
+	configPath := filepath.Join(symlinkRoot, "/treefmt.toml")
+	test.WriteConfig(t, configPath, cfg)
+
+	treefmt(t,
+		withArgs("-c", "go/main.go"),
+		withNoError(t),
+	)
+}
+
 type options struct {
 	args []string
 	env  map[string]string