From 54b0fbdf770674af1fec82e74212f532725dfd2c Mon Sep 17 00:00:00 2001
From: Anthony Nandaa <profnandaa@gmail.com>
Date: Tue, 10 Sep 2024 00:55:17 -0700
Subject: [PATCH] fix: util/path: CheckSystemDriveAndRemoveDriveLetter to
 preserve `/`

The call to CheckSystemDriveAndRemoveDriveLetter() does not preserve
the trailing `/` or `\\`. This happens because `filepath.Clean()`
strips away any trailing slashes. For example `/sample/` will be
`\\sample` on Windows and `/sample` on Linux.
This function was mainly written for Windows scenarios, which
have System Drive Letters like C:/, etc.

This was causing cases like `COPY testfile /testdir/` to
be intepreted as `COPY testfile /testdir`, and if `testdir` is
not explictly created before the call, it ends up being treated
as a destination file other than a directory.

Fix this by checking that if we have a trailing `/` or `\\`, we
preserve it after the call to `filepath.Clean()`.

Fixes #5249

PS. Also fixed for cross-building from Linux scenario, taking care
for paths like `\\sample\\` that are not changed when run
through `filepath.Clean()`, hence the platform specific
`hasTrailingSlash` function.

Signed-off-by: Anthony Nandaa <profnandaa@gmail.com>
---
 frontend/dockerfile/dockerfile_test.go | 37 ++++++++++++++++++++++++++
 util/system/path.go                    | 18 +++++++++++--
 util/system/path_unix.go               | 10 +++++++
 util/system/path_windows.go            |  9 +++++++
 4 files changed, 72 insertions(+), 2 deletions(-)
 create mode 100644 util/system/path_unix.go
 create mode 100644 util/system/path_windows.go

diff --git a/frontend/dockerfile/dockerfile_test.go b/frontend/dockerfile/dockerfile_test.go
index b34c95b4ec73..26a946badfda 100644
--- a/frontend/dockerfile/dockerfile_test.go
+++ b/frontend/dockerfile/dockerfile_test.go
@@ -152,6 +152,7 @@ var allTests = integration.TestFuncs(
 	testNamedMultiplatformInputContext,
 	testNamedFilteredContext,
 	testEmptyDestDir,
+	testPreserveDestDirSlash,
 	testCopyLinkDotDestDir,
 	testCopyLinkEmptyDestDir,
 	testCopyChownCreateDest,
@@ -547,6 +548,42 @@ RUN cmd /V:on /C "set /p tfcontent=<testfile \
 	require.NoError(t, err)
 }
 
+func testPreserveDestDirSlash(t *testing.T, sb integration.Sandbox) {
+	f := getFrontend(t, sb)
+
+	dockerfile := []byte(integration.UnixOrWindows(
+		`
+FROM busybox
+COPY testfile /sample/
+RUN [ "$(cat /sample/testfile)" == "contents0" ]
+`,
+		`
+FROM nanoserver
+COPY testfile /sample/
+RUN cmd /V:on /C "set /p tfcontent=<\sample\testfile \
+	& if !tfcontent! NEQ contents0 (exit 1)"
+`,
+	))
+
+	dir := integration.Tmpdir(
+		t,
+		fstest.CreateFile("Dockerfile", dockerfile, 0600),
+		fstest.CreateFile("testfile", []byte("contents0"), 0600),
+	)
+
+	c, err := client.New(sb.Context(), sb.Address())
+	require.NoError(t, err)
+	defer c.Close()
+
+	_, err = f.Solve(sb.Context(), c, client.SolveOpt{
+		LocalMounts: map[string]fsutil.FS{
+			dockerui.DefaultLocalNameDockerfile: dir,
+			dockerui.DefaultLocalNameContext:    dir,
+		},
+	}, nil)
+	require.NoError(t, err)
+}
+
 func testCopyLinkDotDestDir(t *testing.T, sb integration.Sandbox) {
 	integration.SkipOnPlatform(t, "windows")
 	f := getFrontend(t, sb)
diff --git a/util/system/path.go b/util/system/path.go
index cdfff68007f5..03b7e7fa8cae 100644
--- a/util/system/path.go
+++ b/util/system/path.go
@@ -193,9 +193,11 @@ func CheckSystemDriveAndRemoveDriveLetter(path string, inputOS string) (string,
 	}
 
 	parts := strings.SplitN(path, ":", 2)
+
 	// Path does not have a drive letter. Just return it.
 	if len(parts) < 2 {
-		return ToSlash(filepath.Clean(path), inputOS), nil
+		cleanedPath := filepath.Clean(path)
+		return ToSlash(keepTrailingSlash(cleanedPath, path, inputOS), inputOS), nil
 	}
 
 	// We expect all paths to be in C:
@@ -220,5 +222,17 @@ func CheckSystemDriveAndRemoveDriveLetter(path string, inputOS string) (string,
 	//
 	// We must return the second element of the split path, as is, without attempting to convert
 	// it to an absolute path. We have no knowledge of the CWD; that is treated elsewhere.
-	return ToSlash(filepath.Clean(parts[1]), inputOS), nil
+	cleanedPath := filepath.Clean(parts[1])
+	return ToSlash(keepTrailingSlash(cleanedPath, parts[1], inputOS), inputOS), nil
+}
+
+// Checks if a path other than root has a trailing slash
+// and retains it. See https://github.com/moby/buildkit/issues/5249
+// Expects cleanedPath to have gone through filepath.Clean()
+func keepTrailingSlash(cleanedPath, origPath, inputOS string) string {
+	if len(cleanedPath) > 1 && hasTrailingSlash(origPath) && inputOS == "windows" {
+		// cleanedPath already comes with platform specific separators
+		return cleanedPath + string(filepath.Separator)
+	}
+	return cleanedPath
 }
diff --git a/util/system/path_unix.go b/util/system/path_unix.go
new file mode 100644
index 000000000000..1cc02782435b
--- /dev/null
+++ b/util/system/path_unix.go
@@ -0,0 +1,10 @@
+//go:build !windows
+// +build !windows
+
+package system
+
+import "strings"
+
+func hasTrailingSlash(origPath string) bool {
+	return strings.HasSuffix(origPath, "/")
+}
diff --git a/util/system/path_windows.go b/util/system/path_windows.go
new file mode 100644
index 000000000000..8bb70e732090
--- /dev/null
+++ b/util/system/path_windows.go
@@ -0,0 +1,9 @@
+package system
+
+import "strings"
+
+func hasTrailingSlash(origPath string) bool {
+	// Windows allows for both \\ and / as path separators.
+	return strings.HasSuffix(origPath, "\\") ||
+		strings.HasSuffix(origPath, "/")
+}