Merge pull request cli#709 from cli/www-hostname-support

mislav · web-flow · commit 988d36deb454 · 2020-03-30T11:57:52.000+02:00
Support `www.github.com` git remote URLs
diff --git a/internal/ghrepo/repo.go b/internal/ghrepo/repo.go
@@ -8,21 +8,26 @@ import (
 
 const defaultHostname = "github.com"
 
+// Interface describes an object that represents a GitHub repository
 type Interface interface {
 	RepoName() string
 	RepoOwner() string
 }
 
+// New instantiates a GitHub repository from owner and name arguments
 func New(owner, repo string) Interface {
 	return &ghRepo{
 		owner: owner,
 		name:  repo,
 	}
 }
+
+// FullName serializes a GitHub repository into an "OWNER/REPO" string
 func FullName(r Interface) string {
 	return fmt.Sprintf("%s/%s", r.RepoOwner(), r.RepoName())
 }
 
+// FromFullName extracts the GitHub repository inforation from an "OWNER/REPO" string
 func FromFullName(nwo string) Interface {
 	var r ghRepo
 	parts := strings.SplitN(nwo, "/", 2)
@@ -32,8 +37,9 @@ func FromFullName(nwo string) Interface {
 	return &r
 }
 
+// FromURL extracts the GitHub repository information from a URL
 func FromURL(u *url.URL) (Interface, error) {
-	if !strings.EqualFold(u.Hostname(), defaultHostname) {
+	if !strings.EqualFold(u.Hostname(), defaultHostname) && !strings.EqualFold(u.Hostname(), "www."+defaultHostname) {
 		return nil, fmt.Errorf("unsupported hostname: %s", u.Hostname())
 	}
 	parts := strings.SplitN(strings.TrimPrefix(u.Path, "/"), "/", 3)
@@ -43,6 +49,7 @@ func FromURL(u *url.URL) (Interface, error) {
 	return New(parts[0], strings.TrimSuffix(parts[1], ".git")), nil
 }
 
+// IsSame compares two GitHub repositories
 func IsSame(a, b Interface) bool {
 	return strings.EqualFold(a.RepoOwner(), b.RepoOwner()) &&
 		strings.EqualFold(a.RepoName(), b.RepoName())
diff --git a/internal/ghrepo/repo_test.go b/internal/ghrepo/repo_test.go
@@ -1,40 +1,66 @@
 package ghrepo
 
 import (
+	"errors"
+	"fmt"
 	"net/url"
 	"testing"
 )
 
 func Test_repoFromURL(t *testing.T) {
-	u, _ := url.Parse("http://github.com/monalisa/octo-cat.git")
-	repo, err := FromURL(u)
-	if err != nil {
-		t.Fatalf("got error %q", err)
-	}
-	if repo.RepoOwner() != "monalisa" {
-		t.Errorf("got owner %q", repo.RepoOwner())
-	}
-	if repo.RepoName() != "octo-cat" {
-		t.Errorf("got name %q", repo.RepoName())
-	}
-}
-
-func Test_repoFromURL_invalid(t *testing.T) {
-	cases := [][]string{
-		[]string{
-			"https://example.com/one/two",
-			"unsupported hostname: example.com",
+	tests := []struct {
+		name   string
+		input  string
+		result string
+		err    error
+	}{
+		{
+			name:   "github.com URL",
+			input:  "https://github.com/monalisa/octo-cat.git",
+			result: "monalisa/octo-cat",
+			err:    nil,
 		},
-		[]string{
-			"/path/to/disk",
-			"unsupported hostname: ",
+		{
+			name:   "www.github.com URL",
+			input:  "http://www.GITHUB.com/monalisa/octo-cat.git",
+			result: "monalisa/octo-cat",
+			err:    nil,
+		},
+		{
+			name:   "unsupported hostname",
+			input:  "https://example.com/one/two",
+			result: "",
+			err:    errors.New("unsupported hostname: example.com"),
+		},
+		{
+			name:   "filesystem path",
+			input:  "/path/to/file",
+			result: "",
+			err:    errors.New("unsupported hostname: "),
 		},
 	}
-	for _, c := range cases {
-		u, _ := url.Parse(c[0])
-		_, err := FromURL(u)
-		if err == nil || err.Error() != c[1] {
-			t.Errorf("got %q", err)
-		}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			u, err := url.Parse(tt.input)
+			if err != nil {
+				t.Fatalf("got error %q", err)
+			}
+
+			repo, err := FromURL(u)
+			if err != nil {
+				if tt.err == nil {
+					t.Fatalf("got error %q", err)
+				} else if tt.err.Error() == err.Error() {
+					return
+				}
+				t.Fatalf("got error %q", err)
+			}
+
+			got := fmt.Sprintf("%s/%s", repo.RepoOwner(), repo.RepoName())
+			if tt.result != got {
+				t.Errorf("expected %q, got %q", tt.result, got)
+			}
+		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -8,21 +8,26 @@ import (`
`8`	`8`
`9`	`9`	`const defaultHostname = "github.com"`
`10`	`10`
	`11`	`+// Interface describes an object that represents a GitHub repository`
`11`	`12`	`type Interface interface {`
`12`	`13`	`RepoName() string`
`13`	`14`	`RepoOwner() string`
`14`	`15`	`}`
`15`	`16`
	`17`	`+// New instantiates a GitHub repository from owner and name arguments`
`16`	`18`	`func New(owner, repo string) Interface {`
`17`	`19`	`return &ghRepo{`
`18`	`20`	`owner: owner,`
`19`	`21`	`name: repo,`
`20`	`22`	`}`
`21`	`23`	`}`
	`24`	`+`
	`25`	`+// FullName serializes a GitHub repository into an "OWNER/REPO" string`
`22`	`26`	`func FullName(r Interface) string {`
`23`	`27`	`return fmt.Sprintf("%s/%s", r.RepoOwner(), r.RepoName())`
`24`	`28`	`}`
`25`	`29`
	`30`	`+// FromFullName extracts the GitHub repository inforation from an "OWNER/REPO" string`
`26`	`31`	`func FromFullName(nwo string) Interface {`
`27`	`32`	`var r ghRepo`
`28`	`33`	`parts := strings.SplitN(nwo, "/", 2)`
`@@ -32,8 +37,9 @@ func FromFullName(nwo string) Interface {`
`32`	`37`	`return &r`
`33`	`38`	`}`
`34`	`39`
	`40`	`+// FromURL extracts the GitHub repository information from a URL`
`35`	`41`	`func FromURL(u *url.URL) (Interface, error) {`
`36`		`- if !strings.EqualFold(u.Hostname(), defaultHostname) {`
	`42`	`+ if !strings.EqualFold(u.Hostname(), defaultHostname) && !strings.EqualFold(u.Hostname(), "www."+defaultHostname) {`
`37`	`43`	`return nil, fmt.Errorf("unsupported hostname: %s", u.Hostname())`
`38`	`44`	`}`
`39`	`45`	`parts := strings.SplitN(strings.TrimPrefix(u.Path, "/"), "/", 3)`
`@@ -43,6 +49,7 @@ func FromURL(u *url.URL) (Interface, error) {`
`43`	`49`	`return New(parts[0], strings.TrimSuffix(parts[1], ".git")), nil`
`44`	`50`	`}`
`45`	`51`
	`52`	`+// IsSame compares two GitHub repositories`
`46`	`53`	`func IsSame(a, b Interface) bool {`
`47`	`54`	`return strings.EqualFold(a.RepoOwner(), b.RepoOwner()) &&`
`48`	`55`	`strings.EqualFold(a.RepoName(), b.RepoName())`