Merge pull request #582 from milkpirate/win

feat(window / git bash): Make assh work on Windows cmd and Git bash

pkg/commands/commands.go

@@ -5,6 +5,8 @@ import (
 	"os"
 	"path/filepath"
 
+	"moul.io/assh/v2/pkg/utils"
+
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -42,6 +44,8 @@ func init() {
 	if err != nil {
 		log.Fatal(err)
 	}
+	abspath = filepath.ToSlash(abspath)
+	abspath = utils.EscapeSpaces(abspath)
 	config.SetASSHBinaryPath(abspath)
 
 	RootCmd.Flags().BoolP("help", "h", false, "print usage")

pkg/utils/env.go

@@ -3,9 +3,15 @@ package utils
 import (
 	"errors"
 	"os"
+	"path/filepath"
 	"strings"
 )
 
+// EscapeSpaces escapes all space characters with a backslash (\)
+func EscapeSpaces(s string) string {
+	return strings.ReplaceAll(s, " ", "\\ ")
+}
+
 // GetHomeDir returns '~' as a path
 func GetHomeDir() string {
 	if homeDir := os.Getenv("HOME"); homeDir != "" {
@@ -42,14 +48,18 @@ func ExpandUser(path string) (string, error) {
 	// Expand variables
 	path = ExpandEnvSafe(path)
 
-	if path[:2] == "~/" {
+	if strings.HasPrefix(path, "~/") {
 		homeDir := GetHomeDir()
 		if homeDir == "" {
 			return "", errors.New("user home directory not found")
 		}
 
-		return strings.Replace(path, "~", homeDir, 1), nil
+		path = strings.Replace(path, "~", homeDir, 1)
 	}
+
+	path = filepath.FromSlash(path) // OS-agnostic slashes
+	path = EscapeSpaces(path)
+
 	return path, nil
 }
 

pkg/utils/env_test.go

@@ -2,11 +2,30 @@ package utils
 
 import (
 	"os"
+	"runtime"
 	"testing"
 
 	. "github.com/smartystreets/goconvey/convey"
 )
 
+func TestEscapeSpaces(t *testing.T) {
+	Convey("Testing EscapeSpaces", t, func() {
+		So(EscapeSpaces("foo bar"), ShouldEqual, "foo\\ bar")
+		So(EscapeSpaces("/a/b c/d"), ShouldEqual, "/a/b\\ c/d")
+	})
+}
+
+func TestExpandEnvSafe(t *testing.T) {
+	Convey("Testing ExpandEnvSafe", t, func() {
+		So(os.Setenv("FOO", "bar"), ShouldBeNil)
+		So(ExpandEnvSafe("/a/$FOO/c"), ShouldEqual, "/a/bar/c")
+		So(ExpandEnvSafe("/a/${FOO}/c"), ShouldEqual, "/a/bar/c")
+		So(ExpandEnvSafe("/a/${FOO}/c/$FOO"), ShouldEqual, "/a/bar/c/bar")
+		So(ExpandEnvSafe("/a/$(FOO)/c"), ShouldEqual, "/a/$(FOO)/c")
+		So(ExpandEnvSafe(""), ShouldEqual, "")
+	})
+}
+
 func TestGetHomeDir(t *testing.T) {
 	Convey("Testing GetHomeDir", t, func() {
 		oldHome := os.Getenv("HOME")
@@ -42,38 +61,46 @@ func TestGetHomeDir(t *testing.T) {
 }
 
 func TestExpandUser(t *testing.T) {
+	expected := "/a/b/c/test"
+	expectedEscaped := "/a/b/c/test\\ dir"
+
+	if runtime.GOOS == "windows" {
+		expected = "\\a\\b\\c\\test"
+		expectedEscaped = "\\a\\b\\c\\test\\ dir"
+	}
+
 	Convey("Testing ExpandUser", t, func() {
 		oldHome := os.Getenv("HOME")
 		oldUserProfile := os.Getenv("USERPROFILE")
 
 		So(os.Setenv("HOME", "/a/b/c"), ShouldBeNil)
 		So(os.Setenv("USERPROFILE", ""), ShouldBeNil)
-		dir, err := ExpandUser("~/test")
-		So(dir, ShouldEqual, "/a/b/c/test")
+		dir, err := ExpandUser("~/test dir")
+		So(dir, ShouldEqual, expectedEscaped)
 		So(err, ShouldBeNil)
 
-		So(os.Setenv("HOME", "/a/b/d"), ShouldBeNil)
+		So(os.Setenv("HOME", "/a/b/c"), ShouldBeNil)
 		So(os.Setenv("USERPROFILE", ""), ShouldBeNil)
 		dir, err = ExpandUser("~/test")
-		So(dir, ShouldEqual, "/a/b/d/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
-		So(os.Setenv("HOME", "/a/b/d"), ShouldBeNil)
-		So(os.Setenv("USERPROFILE", "/a/b/e"), ShouldBeNil)
+		So(os.Setenv("HOME", "/a/b/c"), ShouldBeNil)
+		So(os.Setenv("USERPROFILE", ""), ShouldBeNil)
 		dir, err = ExpandUser("~/test")
-		So(dir, ShouldEqual, "/a/b/d/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
-		So(os.Setenv("HOME", ""), ShouldBeNil)
-		So(os.Setenv("USERPROFILE", "/a/b/f"), ShouldBeNil)
+		So(os.Setenv("HOME", "/a/b/c"), ShouldBeNil)
+		So(os.Setenv("USERPROFILE", "/a/b/e"), ShouldBeNil)
 		dir, err = ExpandUser("~/test")
-		So(dir, ShouldEqual, "/a/b/f/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
 		So(os.Setenv("HOME", ""), ShouldBeNil)
-		So(os.Setenv("USERPROFILE", "/a/b/g"), ShouldBeNil)
+		So(os.Setenv("USERPROFILE", "/a/b/c"), ShouldBeNil)
 		dir, err = ExpandUser("~/test")
-		So(dir, ShouldEqual, "/a/b/g/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
 		So(os.Setenv("HOME", ""), ShouldBeNil)
@@ -85,25 +112,25 @@ func TestExpandUser(t *testing.T) {
 		So(os.Setenv("HOME", ""), ShouldBeNil)
 		So(os.Setenv("USERPROFILE", ""), ShouldBeNil)
 		dir, err = ExpandUser("/a/b/c/test")
-		So(dir, ShouldEqual, "/a/b/c/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
 		So(os.Setenv("HOME", "/e/f"), ShouldBeNil)
 		So(os.Setenv("USERPROFILE", ""), ShouldBeNil)
 		dir, err = ExpandUser("/a/b/c/test")
-		So(dir, ShouldEqual, "/a/b/c/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
 		So(os.Setenv("HOME", ""), ShouldBeNil)
 		So(os.Setenv("USERPROFILE", "/e/g"), ShouldBeNil)
 		dir, err = ExpandUser("/a/b/c/test")
-		So(dir, ShouldEqual, "/a/b/c/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
 		So(os.Setenv("HOME", "/e/h"), ShouldBeNil)
 		So(os.Setenv("USERPROFILE", "/e/i"), ShouldBeNil)
 		dir, err = ExpandUser("/a/b/c/test")
-		So(dir, ShouldEqual, "/a/b/c/test")
+		So(dir, ShouldEqual, expected)
 		So(err, ShouldBeNil)
 
 		So(os.Setenv("HOME", oldHome), ShouldBeNil)