Merge pull request #97 from arixmkii/fix-windows-escape

Make argument quotation compatible with cygwin/msys2/gitbash on Windows

Author: AkihiroSuda

.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         go-version: [1.23.x, 1.24.x]
-        platform: [ubuntu-latest, macos-latest]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
     - uses: actions/checkout@v4
@@ -20,5 +20,6 @@ jobs:
       with:
         go-version: ${{ matrix.go-version }}
     - run: make
-    - run: sudo make install
+    - if: "${{ matrix.platform != 'windows-latest' }}"
+      run: sudo make install
     - run: go test -covermode=atomic -race -v ./...

pkg/reversesshfs/reversesshfs.go

@@ -52,7 +52,7 @@ func (rsf *ReverseSSHFS) Prepare() error {
 		sshArgs = append(sshArgs, "-p", strconv.Itoa(rsf.Port))
 	}
 	sshArgs = append(sshArgs, rsf.Host, "--")
-	sshArgs = append(sshArgs, "mkdir", "-p", strconv.Quote(rsf.RemotePath))
+	sshArgs = append(sshArgs, "mkdir", "-p", addQuotes(rsf.RemotePath))
 	sshCmd := exec.Command(sshBinary, sshArgs...)
 	logrus.Debugf("executing ssh for preparing sshfs: %s %v", sshCmd.Path, sshCmd.Args)
 	out, err := sshCmd.CombinedOutput()
@@ -141,7 +141,7 @@ func (rsf *ReverseSSHFS) Start() error {
 		sshArgs = append(sshArgs, "-p", strconv.Itoa(rsf.Port))
 	}
 	sshArgs = append(sshArgs, rsf.Host, "--")
-	sshArgs = append(sshArgs, "sshfs", strconv.Quote(":"+rsf.LocalPath), strconv.Quote(rsf.RemotePath), "-o", "slave")
+	sshArgs = append(sshArgs, "sshfs", addQuotes(":"+rsf.LocalPath), addQuotes(rsf.RemotePath), "-o", "slave")
 	if rsf.Readonly {
 		sshArgs = append(sshArgs, "-o", "ro")
 	}
@@ -252,6 +252,18 @@ func (rsf *ReverseSSHFS) Start() error {
 	return nil
 }
 
+func addQuotes(input string) string {
+	input = strconv.Quote(input)
+	// exec.Command on Windows would escape wrapping double quotes in a way, which is not compatible
+	// with passing arguments into bash shell over ssh, replacing with single quotes as a workaround.
+	if runtime.GOOS == "windows" {
+		input = strings.TrimPrefix(input, "\"")
+		input = strings.TrimSuffix(input, "\"")
+		return fmt.Sprintf(`'%s'`, input)
+	}
+	return input
+}
+
 func (rsf *ReverseSSHFS) waitForRemoteReady() error {
 	scriptName := "wait-for-remote-ready"
 	scriptTemplate := `#!/bin/sh

pkg/reversesshfs/reversesshfs_test.go

@@ -0,0 +1,35 @@
+package reversesshfs
+
+import (
+	"runtime"
+	"testing"
+)
+
+func TestAddQuotes(t *testing.T) {
+	type testCase struct {
+		input    string
+		expected string
+	}
+	var testCases []testCase
+	if runtime.GOOS != "windows" {
+		testCases = []testCase{
+			{
+				input:    "/user/test/path",
+				expected: "\"/user/test/path\"",
+			},
+		}
+	} else {
+		testCases = []testCase{
+			{
+				input:    "/user/test/path",
+				expected: "'/user/test/path'",
+			},
+		}
+	}
+	for i, tc := range testCases {
+		got := addQuotes(tc.input)
+		if got != tc.expected {
+			t.Errorf("#%d: expected %q, got %q", i, tc.expected, got)
+		}
+	}
+}