Fix some path logic to work on Windows

private/buf/buffetch/internal/reader.go

@@ -27,6 +27,7 @@ import (
 
 	"github.com/bufbuild/buf/private/bufpkg/bufmodule"
 	"github.com/bufbuild/buf/private/pkg/app"
+	"github.com/bufbuild/buf/private/pkg/filepathext"
 	"github.com/bufbuild/buf/private/pkg/git"
 	"github.com/bufbuild/buf/private/pkg/httpauth"
 	"github.com/bufbuild/buf/private/pkg/ioext"
@@ -573,7 +574,7 @@ func getReadWriteBucketForOS(
 		return nil, err
 	}
 	osRootBucket, err := storageosProvider.NewReadWriteBucket(
-		string(os.PathSeparator),
+		filepathext.FSRoot,
 		// TODO: is this right? verify in deleted code
 		storageos.ReadWriteBucketWithSymlinksIfSupported(),
 	)
@@ -584,8 +585,9 @@ func getReadWriteBucketForOS(
 		ctx,
 		logger,
 		osRootBucket,
-		// This makes the path relative to the bucket.
-		absInputDirPath[1:],
+		// This makes the path relative to the bucket. We need to strip away the root of the
+		// absolute path.
+		normalpath.Join(normalpath.Components(absInputDirPath)[1:]...),
 		terminateFunc,
 	)
 	if err != nil {
@@ -606,7 +608,7 @@ func getReadWriteBucketForOS(
 	// Make bucket on: os.PathSeparator + returnMapPath (since absolute)
 	var bucketPath string
 	if filepath.IsAbs(normalpath.Unnormalize(inputDirPath)) {
-		bucketPath = normalpath.Join("/", mapPath)
+		bucketPath = normalpath.Join(filepathext.FSRoot, mapPath)
 	} else {
 		pwd, err := osext.Getwd()
 		if err != nil {
@@ -674,7 +676,7 @@ func getReadBucketCloserForOSProtoFile(
 		return nil, err
 	}
 	osRootBucket, err := storageosProvider.NewReadWriteBucket(
-		"/",
+		filepathext.FSRoot,
 		// TODO: is this right? verify in deleted code
 		storageos.ReadWriteBucketWithSymlinksIfSupported(),
 	)
@@ -687,8 +689,9 @@ func getReadBucketCloserForOSProtoFile(
 		ctx,
 		logger,
 		osRootBucket,
-		// This makes the path relative to the bucket.
-		absProtoFileDirPath[1:],
+		// This makes the path relative to the bucket. We need to strip away the root of the
+		// absolute path.
+		normalpath.Join(normalpath.Components(absProtoFileDirPath)[1:]...),
 		protoFileTerminateFunc,
 	)
 	if err != nil {
@@ -736,7 +739,7 @@ func getReadBucketCloserForOSProtoFile(
 		// We found a buf.yaml or buf.work.yaml, use that directory.
 		// If we found a buf.yaml or buf.work.yaml and the ProtoFileRef path is absolute, use an absolute path, otherwise relative.
 		if filepath.IsAbs(normalpath.Unnormalize(protoFileDirPath)) {
-			protoTerminateFileDirPath = normalpath.Join("/", mapPath)
+			protoTerminateFileDirPath = normalpath.Join(filepathext.FSRoot, mapPath)
 		} else {
 			pwd, err := osext.Getwd()
 			if err != nil {
@@ -861,8 +864,8 @@ func attemptToFixOSRootBucketPathErrors(err error) error {
 			return err
 		}
 		pwd = normalpath.Normalize(pwd)
-		if normalpath.EqualsOrContainsPath(pwd, normalpath.Join("/", pathError.Path), normalpath.Absolute) {
-			relPath, err := normalpath.Rel(pwd, normalpath.Join("/", pathError.Path))
+		if normalpath.EqualsOrContainsPath(pwd, normalpath.Join(filepathext.FSRoot, pathError.Path), normalpath.Absolute) {
+			relPath, err := normalpath.Rel(pwd, normalpath.Join(filepathext.FSRoot, pathError.Path))
 			// Just ignore if this errors and do nothing.
 			if err == nil {
 				// Making a copy just to be super-safe.

private/buf/buffetch/internal/reader_test.go

@@ -120,7 +120,7 @@ func TestGetReadWriteBucketForOSNoTerminateFileName(t *testing.T) {
 	require.Equal(t, ".", readWriteBucket.SubDirPath())
 	fileInfo, err := readWriteBucket.Stat(ctx, "buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 }
 
 func TestGetReadWriteBucketForOSTerminateFileName(t *testing.T) {
@@ -137,10 +137,10 @@ func TestGetReadWriteBucketForOSTerminateFileName(t *testing.T) {
 	require.Equal(t, "four/five", readWriteBucket.SubDirPath())
 	fileInfo, err := readWriteBucket.Stat(ctx, "four/five/buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readWriteBucket.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/bufyaml/one/two/three/buf.work.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/bufyaml/one/two/three/buf.work.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 }
 
 func TestGetReadWriteBucketForOSParentPwd(t *testing.T) {
@@ -168,10 +168,10 @@ func TestGetReadWriteBucketForOSParentPwd(t *testing.T) {
 	require.Equal(t, "four/five", readWriteBucket.SubDirPath())
 	fileInfo, err := readWriteBucket.Stat(ctx, "four/five/buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "five/buf.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "five/buf.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readWriteBucket.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "../buf.work.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "../buf.work.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 }
 
 func TestGetReadWriteBucketForOSAbsPwd(t *testing.T) {
@@ -201,10 +201,10 @@ func TestGetReadWriteBucketForOSAbsPwd(t *testing.T) {
 	require.Equal(t, "four/five", readWriteBucket.SubDirPath())
 	fileInfo, err := readWriteBucket.Stat(ctx, "four/five/buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/four/five/buf.yaml"), fileInfo.ExternalPath())
+	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/four/five/buf.yaml"), filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readWriteBucket.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/buf.work.yaml"), fileInfo.ExternalPath())
+	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/buf.work.yaml"), filepath.ToSlash(fileInfo.ExternalPath()))
 }
 
 func TestGetReadBucketCloserForOSProtoFileNoWorkspaceTerminateFileName(t *testing.T) {
@@ -222,7 +222,7 @@ func TestGetReadBucketCloserForOSProtoFileNoWorkspaceTerminateFileName(t *testin
 	require.Equal(t, ".", readBucketCloser.SubDirPath())
 	fileInfo, err := readBucketCloser.Stat(ctx, "buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	require.NoError(t, readBucketCloser.Close())
 }
 
@@ -241,10 +241,10 @@ func TestGetReadBucketCloserForOSProtoFileTerminateFileName(t *testing.T) {
 	require.Equal(t, "four/five", readBucketCloser.SubDirPath())
 	fileInfo, err := readBucketCloser.Stat(ctx, "four/five/buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/bufyaml/one/two/three/four/five/buf.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readBucketCloser.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/bufyaml/one/two/three/buf.work.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/bufyaml/one/two/three/buf.work.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	require.NoError(t, readBucketCloser.Close())
 }
 
@@ -274,10 +274,10 @@ func TestGetReadBucketCloserForOSProtoFileParentPwd(t *testing.T) {
 	require.Equal(t, "four/five", readBucketCloser.SubDirPath())
 	fileInfo, err := readBucketCloser.Stat(ctx, "four/five/buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "five/buf.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "five/buf.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readBucketCloser.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "../buf.work.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "../buf.work.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	require.NoError(t, readBucketCloser.Close())
 }
 
@@ -309,10 +309,10 @@ func TestGetReadBucketCloserForOSProtoFileAbsPwd(t *testing.T) {
 	require.Equal(t, "four/five", readBucketCloser.SubDirPath())
 	fileInfo, err := readBucketCloser.Stat(ctx, "four/five/buf.yaml")
 	require.NoError(t, err)
-	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/four/five/buf.yaml"), fileInfo.ExternalPath())
+	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/four/five/buf.yaml"), filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readBucketCloser.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/buf.work.yaml"), fileInfo.ExternalPath())
+	require.Equal(t, normalpath.Join(absDirPath, "testdata/bufyaml/one/two/three/buf.work.yaml"), filepath.ToSlash(fileInfo.ExternalPath()))
 	require.NoError(t, readBucketCloser.Close())
 }
 
@@ -331,7 +331,7 @@ func TestGetReadBucketCloserForOSProtoFileNoBufYAMLTerminateFileName(t *testing.
 	require.Equal(t, ".", readBucketCloser.SubDirPath())
 	fileInfo, err := readBucketCloser.Stat(ctx, "four/five/proto/foo.proto")
 	require.NoError(t, err)
-	require.Equal(t, "testdata/nobufyaml/one/two/three/four/five/proto/foo.proto", fileInfo.ExternalPath())
+	require.Equal(t, "testdata/nobufyaml/one/two/three/four/five/proto/foo.proto", filepath.ToSlash(fileInfo.ExternalPath()))
 	require.NoError(t, readBucketCloser.Close())
 }
 
@@ -361,10 +361,10 @@ func TestGetReadBucketCloserForOSProtoFileNoBufYAMLParentPwd(t *testing.T) {
 	require.Equal(t, ".", readBucketCloser.SubDirPath())
 	fileInfo, err := readBucketCloser.Stat(ctx, "four/five/proto/foo.proto")
 	require.NoError(t, err)
-	require.Equal(t, "five/proto/foo.proto", fileInfo.ExternalPath())
+	require.Equal(t, "five/proto/foo.proto", filepath.ToSlash(fileInfo.ExternalPath()))
 	fileInfo, err = readBucketCloser.Stat(ctx, "buf.work.yaml")
 	require.NoError(t, err)
-	require.Equal(t, "../buf.work.yaml", fileInfo.ExternalPath())
+	require.Equal(t, "../buf.work.yaml", filepath.ToSlash(fileInfo.ExternalPath()))
 	require.NoError(t, readBucketCloser.Close())
 }
 

private/buf/cmd/buf/workspace_windows_test.go

@@ -29,7 +29,7 @@ func TestWorkspaceAbsoluteFail(t *testing.T) {
 		nil,
 		1,
 		``,
-		`Failure: directory "C:\buf" listed in testdata\workspace\fail\absolute\windows\buf.work.yaml is invalid: C:\buf: expected to be relative`,
+		`Failure: decode testdata/workspace/fail/absolute/windows/buf.work.yaml: C:\buf: expected to be relative`,
 		"build",
 		filepath.Join("testdata", "workspace", "fail", "absolute", "windows"),
 	)
@@ -38,7 +38,7 @@ func TestWorkspaceAbsoluteFail(t *testing.T) {
 		nil,
 		1,
 		``,
-		`Failure: directory "C:\buf" listed in testdata\workspace\fail\absolute\windows\buf.work.yaml is invalid: C:\buf: expected to be relative`,
+		`Failure: decode testdata/workspace/fail/absolute/windows/buf.work.yaml: C:\buf: expected to be relative`,
 		"build",
 		filepath.Join("testdata", "workspace", "fail", "v2", "absolute", "windows"),
 	)

private/pkg/filepathext/filepathext_unix.go

@@ -0,0 +1,26 @@
+// Copyright 2020-2023 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build aix || darwin || dragonfly || freebsd || (js && wasm) || linux || netbsd || openbsd || solaris
+// +build aix darwin dragonfly freebsd js,wasm linux netbsd openbsd solaris
+
+package filepathext
+
+import (
+	"os"
+)
+
+var (
+	FSRoot = string(os.PathSeparator)
+)

private/pkg/filepathext/filepathext_windows.go

@@ -0,0 +1,30 @@
+// Copyright 2020-2023 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build windows
+// +build windows
+
+package filepathext
+
+import (
+	"os"
+	"path/filepath"
+)
+
+var (
+	// USERPROFILE shows the current user's profile folder. It is being used to parse the volume
+	// for the current user and this is used as the process's context.
+	// https://learn.microsoft.com/en-us/windows/deployment/usmt/usmt-recognized-environment-variables#variables-that-are-processed-for-the-operating-system-and-in-the-context-of-each-user
+	FSRoot = filepath.VolumeName(os.Getenv("USERPROFILE")) + string(os.PathSeparator)
+)