Merge pull request #129 from hashicorp/b/git-scp

Allow SCP-style URLs for Git

Author: mitchellh

detect.go

@@ -23,6 +23,7 @@ var Detectors []Detector
 func init() {
 	Detectors = []Detector{
 		new(GitHubDetector),
+		new(GitDetector),
 		new(BitBucketDetector),
 		new(S3Detector),
 		new(FileDetector),

detect_git.go

@@ -0,0 +1,26 @@
+package getter
+
+// GitDetector implements Detector to detect Git SSH URLs such as
+// [email protected]:dir1/dir2 and converts them to proper URLs.
+type GitDetector struct{}
+
+func (d *GitDetector) Detect(src, _ string) (string, bool, error) {
+	if len(src) == 0 {
+		return "", false, nil
+	}
+
+	u, err := detectSSH(src)
+	if err != nil {
+		return "", true, err
+	}
+	if u == nil {
+		return "", false, nil
+	}
+
+	// We require the username to be "git" to assume that this is a Git URL
+	if u.User.Username() != "git" {
+		return "", false, nil
+	}
+
+	return "git::" + u.String(), true, nil
+}

detect_git_test.go

@@ -0,0 +1,58 @@
+package getter
+
+import (
+	"testing"
+)
+
+func TestGitDetector(t *testing.T) {
+	cases := []struct {
+		Input  string
+		Output string
+	}{
+		{"[email protected]:hashicorp/foo.git", "git::ssh://[email protected]/hashicorp/foo.git"},
+		{
+			"[email protected]:org/project.git?ref=test-branch",
+			"git::ssh://[email protected]/org/project.git?ref=test-branch",
+		},
+		{
+			"[email protected]:hashicorp/foo.git//bar",
+			"git::ssh://[email protected]/hashicorp/foo.git//bar",
+		},
+		{
+			"[email protected]:hashicorp/foo.git?foo=bar",
+			"git::ssh://[email protected]/hashicorp/foo.git?foo=bar",
+		},
+		{
+			"[email protected]:org/project.git",
+			"git::ssh://[email protected]/org/project.git",
+		},
+		{
+			"[email protected]:org/project.git?ref=test-branch",
+			"git::ssh://[email protected]/org/project.git?ref=test-branch",
+		},
+		{
+			"[email protected]:org/project.git//module/a",
+			"git::ssh://[email protected]/org/project.git//module/a",
+		},
+		{
+			"[email protected]:org/project.git//module/a?ref=test-branch",
+			"git::ssh://[email protected]/org/project.git//module/a?ref=test-branch",
+		},
+	}
+
+	pwd := "/pwd"
+	f := new(GitDetector)
+	for i, tc := range cases {
+		output, ok, err := f.Detect(tc.Input, pwd)
+		if err != nil {
+			t.Fatalf("err: %s", err)
+		}
+		if !ok {
+			t.Fatal("not ok")
+		}
+
+		if output != tc.Output {
+			t.Fatalf("%d: bad: %#v", i, output)
+		}
+	}
+}

detect_github.go

@@ -17,8 +17,6 @@ func (d *GitHubDetector) Detect(src, _ string) (string, bool, error) {
 
 	if strings.HasPrefix(src, "github.com/") {
 		return d.detectHTTP(src)
-	} else if strings.HasPrefix(src, "[email protected]:") {
-		return d.detectSSH(src)
 	}
 
 	return "", false, nil
@@ -47,27 +45,3 @@ func (d *GitHubDetector) detectHTTP(src string) (string, bool, error) {
 
 	return "git::" + url.String(), true, nil
 }
-
-func (d *GitHubDetector) detectSSH(src string) (string, bool, error) {
-	idx := strings.Index(src, ":")
-	qidx := strings.Index(src, "?")
-	if qidx == -1 {
-		qidx = len(src)
-	}
-
-	var u url.URL
-	u.Scheme = "ssh"
-	u.User = url.User("git")
-	u.Host = "github.com"
-	u.Path = src[idx+1 : qidx]
-	if qidx < len(src) {
-		q, err := url.ParseQuery(src[qidx+1:])
-		if err != nil {
-			return "", true, fmt.Errorf("error parsing GitHub SSH URL: %s", err)
-		}
-
-		u.RawQuery = q.Encode()
-	}
-
-	return "git::" + u.String(), true, nil
-}

detect_github_test.go

@@ -24,17 +24,6 @@ func TestGitHubDetector(t *testing.T) {
 			"github.com/hashicorp/foo.git?foo=bar",
 			"git::https://github.com/hashicorp/foo.git?foo=bar",
 		},
-
-		// SSH
-		{"[email protected]:hashicorp/foo.git", "git::ssh://[email protected]/hashicorp/foo.git"},
-		{
-			"[email protected]:hashicorp/foo.git//bar",
-			"git::ssh://[email protected]/hashicorp/foo.git//bar",
-		},
-		{
-			"[email protected]:hashicorp/foo.git?foo=bar",
-			"git::ssh://[email protected]/hashicorp/foo.git?foo=bar",
-		},
 	}
 
 	pwd := "/pwd"

detect_ssh.go

@@ -0,0 +1,49 @@
+package getter
+
+import (
+	"fmt"
+	"net/url"
+	"regexp"
+	"strings"
+)
+
+// Note that we do not have an SSH-getter currently so this file serves
+// only to hold the detectSSH helper that is used by other detectors.
+
+// sshPattern matches SCP-like SSH patterns (user@host:path)
+var sshPattern = regexp.MustCompile("^(?:([^@]+)@)?([^:]+):/?(.+)$")
+
+// detectSSH determines if the src string matches an SSH-like URL and
+// converts it into a net.URL compatible string. This returns nil if the
+// string doesn't match the SSH pattern.
+//
+// This function is tested indirectly via detect_git_test.go
+func detectSSH(src string) (*url.URL, error) {
+	matched := sshPattern.FindStringSubmatch(src)
+	if matched == nil {
+		return nil, nil
+	}
+
+	user := matched[1]
+	host := matched[2]
+	path := matched[3]
+	qidx := strings.Index(path, "?")
+	if qidx == -1 {
+		qidx = len(path)
+	}
+
+	var u url.URL
+	u.Scheme = "ssh"
+	u.User = url.User(user)
+	u.Host = host
+	u.Path = path[0:qidx]
+	if qidx < len(path) {
+		q, err := url.ParseQuery(path[qidx+1:])
+		if err != nil {
+			return nil, fmt.Errorf("error parsing GitHub SSH URL: %s", err)
+		}
+		u.RawQuery = q.Encode()
+	}
+
+	return &u, nil
+}

detect_test.go

@@ -1,6 +1,7 @@
 package getter
 
 import (
+	"fmt"
 	"testing"
 )
 
@@ -37,21 +38,55 @@ func TestDetect(t *testing.T) {
 			"git::https://github.com/hashicorp/consul.git",
 			false,
 		},
+		{
+			"git::https://[email protected]/foo/bar",
+			"",
+			"git::https://[email protected]/foo/bar",
+			false,
+		},
+		{
+			"git::https://[email protected]/foo/bar",
+			"/bar",
+			"git::https://[email protected]/foo/bar",
+			false,
+		},
 		{
 			"./foo/archive//*",
 			"/bar",
 			"file:///bar/foo/archive//*",
 			false,
 		},
+
+		// https://github.com/hashicorp/go-getter/pull/124
+		{
+			"git::ssh://[email protected]/dir1/dir2",
+			"",
+			"git::ssh://[email protected]/dir1/dir2",
+			false,
+		},
+		{
+			"git::[email protected]:dir1/dir2",
+			"/foo",
+			"git::ssh://[email protected]/dir1/dir2",
+			false,
+		},
+		{
+			"git::[email protected]:dir1/dir2",
+			"",
+			"git::ssh://[email protected]/dir1/dir2",
+			false,
+		},
 	}
 
 	for i, tc := range cases {
-		output, err := Detect(tc.Input, tc.Pwd, Detectors)
-		if err != nil != tc.Err {
-			t.Fatalf("%d: bad err: %s", i, err)
-		}
-		if output != tc.Output {
-			t.Fatalf("%d: bad output: %s\nexpected: %s", i, output, tc.Output)
-		}
+		t.Run(fmt.Sprintf("%d %s", i, tc.Input), func(t *testing.T) {
+			output, err := Detect(tc.Input, tc.Pwd, Detectors)
+			if err != nil != tc.Err {
+				t.Fatalf("%d: bad err: %s", i, err)
+			}
+			if output != tc.Output {
+				t.Fatalf("%d: bad output: %s\nexpected: %s", i, output, tc.Output)
+			}
+		})
 	}
 }

get_git.go

@@ -78,6 +78,26 @@ func (g *GitGetter) Get(dst string, u *url.URL) error {
 		}
 	}
 
+	// For SSH-style URLs, if they use the SCP syntax of host:path, then
+	// the URL will be mangled. We detect that here and correct the path.
+	// Example: host:path/bar will turn into host/path/bar
+	if u.Scheme == "ssh" {
+		if idx := strings.Index(u.Host, ":"); idx > -1 {
+			// Copy the URL so we don't modify the input
+			var newU url.URL = *u
+			u = &newU
+
+			// Path includes the part after the ':'.
+			u.Path = u.Host[idx+1:] + u.Path
+			if u.Path[0] != '/' {
+				u.Path = "/" + u.Path
+			}
+
+			// Host trims up to the :
+			u.Host = u.Host[:idx]
+		}
+	}
+
 	// Clone or update the repository
 	_, err := os.Stat(dst)
 	if err != nil && !os.IsNotExist(err) {