Merge pull request #657 from ibrasho-forks/fix-symlink-copying

internal/fs: handle symlinks in copyFile()

Author: sdboyer

internal/fs/fs.go

@@ -248,6 +248,13 @@ func CopyDir(src, dst string) error {
 // of the source file. The file mode will be copied from the source and
 // the copied data is synced/flushed to stable storage.
 func copyFile(src, dst string) (err error) {
+	if sym, err := IsSymlink(src); err != nil {
+		return err
+	} else if sym {
+		err := copySymlink(src, dst)
+		return err
+	}
+
 	in, err := os.Open(src)
 	if err != nil {
 		return
@@ -286,6 +293,22 @@ func copyFile(src, dst string) (err error) {
 	return
 }
 
+// copySymlink will resolve the src symlink and create a new symlink in dst.
+// If src is a relative symlink, dst will also be a relative symlink.
+func copySymlink(src, dst string) error {
+	resolved, err := os.Readlink(src)
+	if err != nil {
+		return errors.Wrap(err, "failed to resolve symlink")
+	}
+
+	err = os.Symlink(resolved, dst)
+	if err != nil {
+		return errors.Wrapf(err, "failed to create symlink %s to %s", src, resolved)
+	}
+
+	return nil
+}
+
 // IsDir determines is the path given is a directory or not.
 func IsDir(name string) (bool, error) {
 	// TODO: lstat?
@@ -343,3 +366,13 @@ func IsRegular(name string) (bool, error) {
 	}
 	return true, nil
 }
+
+// IsSymlink determines if the given path is a symbolic link.
+func IsSymlink(path string) (bool, error) {
+	l, err := os.Lstat(path)
+	if err != nil {
+		return false, err
+	}
+
+	return l.Mode()&os.ModeSymlink == os.ModeSymlink, nil
+}

internal/fs/fs_test.go

@@ -461,6 +461,75 @@ func TestCopyFile(t *testing.T) {
 	}
 }
 
+func TestCopyFileSymlink(t *testing.T) {
+	dir, err := ioutil.TempDir("", "dep")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	srcPath := filepath.Join(dir, "src")
+	symlinkPath := filepath.Join(dir, "symlink")
+	dstPath := filepath.Join(dir, "dst")
+
+	srcf, err := os.Create(srcPath)
+	if err != nil {
+		t.Fatal(err)
+	}
+	srcf.Close()
+
+	if err = os.Symlink(srcPath, symlinkPath); err != nil {
+		t.Fatalf("could not create symlink: %s", err)
+	}
+
+	if err = copyFile(symlinkPath, dstPath); err != nil {
+		t.Fatalf("failed to copy symlink: %s", err)
+	}
+
+	resolvedPath, err := os.Readlink(dstPath)
+	if err != nil {
+		t.Fatalf("could not resolve symlink: %s", err)
+	}
+
+	if resolvedPath != srcPath {
+		t.Fatalf("resolved path is incorrect. expected %s, got %s", srcPath, resolvedPath)
+	}
+}
+
+func TestCopyFileSymlinkToDirectory(t *testing.T) {
+	dir, err := ioutil.TempDir("", "dep")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	srcPath := filepath.Join(dir, "src")
+	symlinkPath := filepath.Join(dir, "symlink")
+	dstPath := filepath.Join(dir, "dst")
+
+	err = os.MkdirAll(srcPath, 0777)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if err = os.Symlink(srcPath, symlinkPath); err != nil {
+		t.Fatalf("could not create symlink: %v", err)
+	}
+
+	if err = copyFile(symlinkPath, dstPath); err != nil {
+		t.Fatalf("failed to copy symlink: %s", err)
+	}
+
+	resolvedPath, err := os.Readlink(dstPath)
+	if err != nil {
+		t.Fatalf("could not resolve symlink: %s", err)
+	}
+
+	if resolvedPath != srcPath {
+		t.Fatalf("resolved path is incorrect. expected %s, got %s", srcPath, resolvedPath)
+	}
+}
+
 func TestCopyFileFail(t *testing.T) {
 	if runtime.GOOS == "windows" {
 		// XXX: setting permissions works differently in
@@ -659,7 +728,6 @@ func TestIsDir(t *testing.T) {
 			t.Fatalf("expected %t for %s, got %t", want.exists, f, got)
 		}
 	}
-
 }
 
 func TestIsEmpty(t *testing.T) {
@@ -702,3 +770,85 @@ func TestIsEmpty(t *testing.T) {
 		}
 	}
 }
+
+func TestIsSymlink(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		// XXX: creating symlinks is not supported in Go on
+		// Microsoft Windows. Skipping this this until a solution
+		// for creating symlinks is is provided.
+		t.Skip("skipping on windows")
+	}
+
+	dir, err := ioutil.TempDir("", "dep")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	dirPath := filepath.Join(dir, "directory")
+	if err = os.MkdirAll(dirPath, 0777); err != nil {
+		t.Fatal(err)
+	}
+
+	filePath := filepath.Join(dir, "file")
+	f, err := os.Create(filePath)
+	if err != nil {
+		t.Fatal(err)
+	}
+	f.Close()
+
+	dirSymlink := filepath.Join(dir, "dirSymlink")
+	fileSymlink := filepath.Join(dir, "fileSymlink")
+	if err = os.Symlink(dirPath, dirSymlink); err != nil {
+		t.Fatal(err)
+	}
+	if err = os.Symlink(filePath, fileSymlink); err != nil {
+		t.Fatal(err)
+	}
+
+	var (
+		inaccessibleFile    string
+		inaccessibleSymlink string
+	)
+
+	err, cleanup := setupInaccessibleDir(func(dir string) error {
+		inaccessibleFile = filepath.Join(dir, "file")
+		if fh, err := os.Create(inaccessibleFile); err != nil {
+			return err
+		} else if err = fh.Close(); err != nil {
+			return err
+		}
+
+		inaccessibleSymlink = filepath.Join(dir, "symlink")
+		return os.Symlink(inaccessibleFile, inaccessibleSymlink)
+	})
+	defer cleanup()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	tests := map[string]struct {
+		expected bool
+		err      bool
+	}{
+		dirPath:             {false, false},
+		filePath:            {false, false},
+		dirSymlink:          {true, false},
+		fileSymlink:         {true, false},
+		inaccessibleFile:    {false, true},
+		inaccessibleSymlink: {false, true},
+	}
+
+	for path, want := range tests {
+		got, err := IsSymlink(path)
+		if err != nil {
+			if !want.err {
+				t.Errorf("expected no error, got %v", err)
+			}
+		}
+
+		if got != want.expected {
+			t.Errorf("expected %t for %s, got %t", want.expected, path, got)
+		}
+	}
+}