fix: first tests of ignoring symlinks

Author: gabyx

cmd/format/format.go

@@ -88,8 +88,8 @@ func Run(v *viper.Viper, statz *stats.Stats, cmd *cobra.Command, paths []string)
 
 		// ensure db is closed after we're finished
 		defer func() {
-			if err := db.Close(); err != nil {
-				log.Errorf("failed to close cache: %v", err)
+			if e := db.Close(); e != nil {
+				log.Errorf("failed to close cache: %v", e)
 			}
 		}()
 	}
@@ -129,27 +129,36 @@ func Run(v *viper.Viper, statz *stats.Stats, cmd *cobra.Command, paths []string)
 	// checks all paths are contained within the tree root and exist
 	// also "normalize" paths so they're relative to cfg.TreeRoot
 	for i, path := range paths {
-		absolutePath, err := filepath.Abs(path)
-		if err != nil {
-			return fmt.Errorf("error computing absolute path of %s: %w", path, err)
+		absolutePath, e := filepath.Abs(path)
+		if e != nil {
+			return fmt.Errorf("error computing absolute path of %s: %w", path, e)
 		}
 
-		relativePath, err := filepath.Rel(cfg.TreeRoot, absolutePath)
-		if err != nil {
-			return fmt.Errorf("error computing relative path from %s to %s: %w", cfg.TreeRoot, absolutePath, err)
+		if walkType != walk.Stdin {
+			if _, e = os.Stat(absolutePath); e != nil {
+				return fmt.Errorf("path %s not found", path)
+			}
+
+			// // symlinks are allowed on `paths` input, we resolve them here, since
+			// // the readers will k
+			// realPath, ee := filepath.EvalSymlinks(absolutePath)
+			// if ee != nil {
+			// 	return fmt.Errorf("could not determine real path of %s (evaluating all symlinks)", absolutePath)
+			// }
+			//
+			// absolutePath = realPath
+		}
+
+		relativePath, e := filepath.Rel(cfg.TreeRoot, absolutePath)
+		if e != nil {
+			return fmt.Errorf("error computing relative path from %s to %s: %w", cfg.TreeRoot, absolutePath, e)
 		}
 
 		if strings.HasPrefix(relativePath, "..") {
 			return fmt.Errorf("path %s not inside the tree root %s", path, cfg.TreeRoot)
 		}
 
 		paths[i] = relativePath
-
-		if walkType != walk.Stdin {
-			if _, err = os.Stat(absolutePath); err != nil {
-				return fmt.Errorf("path %s not found", path)
-			}
-		}
 	}
 
 	// create a composite formatter which will handle applying the correct formatters to each file we traverse

test/examples/yaml/test-rel-symlink.yaml

@@ -0,0 +1 @@
+../yaml/test.yaml

walk/git.go

@@ -91,7 +91,8 @@ LOOP:
 
 				g.log.Debugf("processing file: %s", path)
 
-				info, err := os.Stat(path)
+				info, err := os.Lstat(path)
+
 				if os.IsNotExist(err) {
 					// the underlying file might have been removed
 					g.log.Warnf(
@@ -101,13 +102,18 @@ LOOP:
 					continue
 				} else if err != nil {
 					return n, fmt.Errorf("failed to stat %s: %w", path, err)
+				} else if info.Mode()&os.ModeSymlink == os.ModeSymlink {
+					// we skip reporting symlinks stored in Git, they should
+					// point to local files which we would list anyway.
+					continue
 				}
 
 				files[n] = &File{
 					Path:    path,
 					RelPath: filepath.Join(g.path, entry),
 					Info:    info,
 				}
+
 				n++
 			} else {
 				// nothing more to read

walk/walk.go

@@ -233,6 +233,9 @@ func NewReader(
 	return reader, err
 }
 
+// NewCompositeReader returns a composite reader for the `root` and all `paths`. It
+// never follows symlinks.
+//
 //nolint:ireturn
 func NewCompositeReader(
 	walkType Type,
@@ -267,16 +270,21 @@ func NewCompositeReader(
 		// create a clean absolute path
 		path := filepath.Clean(filepath.Join(root, relPath))
 
-		// check the path exists
+		// check the path exists (don't follow symlinks)
 		info, err = os.Lstat(path)
 		if err != nil {
 			return nil, fmt.Errorf("failed to stat %s: %w", path, err)
 		}
 
-		if info.IsDir() {
+		switch {
+		case info.Mode()&os.ModeSymlink == os.ModeSymlink:
+			// for symlinks -> we ignore them since it does not make sense to follow them
+			// as normal files in the `root` will be picked up nevertheless.
+			continue
+		case info.IsDir():
 			// for directories, we honour the walk type as we traverse them
 			readers[idx], err = NewReader(walkType, root, relPath, db, statz)
-		} else {
+		default:
 			// for files, we enforce a simple filesystem read
 			readers[idx], err = NewReader(Filesystem, root, relPath, db, statz)
 		}