fix: Fix base url regression to ensure trailing /

Signed-off-by: Steve Hipwell <[email protected]>

Author: stevehipwell

github/config.go

@@ -2,7 +2,6 @@ package github
 
 import (
 	"context"
-	"fmt"
 	"net/http"
 	"net/url"
 	"path"
@@ -45,6 +44,9 @@ const DotComHost = "api.github.com"
 // https://[hostname].ghe.com/ instances expect paths that behave similar to GitHub.com, not GitHub Enterprise Server.
 var GHECDataResidencyHostMatch = regexp.MustCompile(`^[a-zA-Z0-9.\-]+\.ghe\.com\/?$`)
 
+// GHESAPISuffixMatch is a regex to match GitHub Enterprise Server API suffixes.
+var GHESAPISuffixMatch = regexp.MustCompile(`api/v3\/?$`)
+
 func RateLimitedHTTPClient(client *http.Client, writeDelay, readDelay, retryDelay time.Duration, parallelRequests bool, retryableErrors map[int]bool, maxRetries int) *http.Client {
 	client.Transport = NewEtagTransport(client.Transport)
 	client.Transport = NewRateLimitTransport(client.Transport, WithWriteDelay(writeDelay), WithReadDelay(readDelay), WithParallelRequests(parallelRequests))
@@ -103,16 +105,15 @@ func (c *Config) NewRESTClient(client *http.Client) (*github.Client, error) {
 	}
 
 	hostname := uv3.Hostname()
-	if hostname != DotComHost && !GHECDataResidencyHostMatch.MatchString(hostname) {
-		uv3.Path = fmt.Sprintf("%s/", path.Join(uv3.Path, "api/v3"))
-	}
-
-	v3client, err := github.NewClient(client).WithEnterpriseURLs(uv3.String(), "")
-	if err != nil {
-		return nil, err
+	if hostname != DotComHost && !GHECDataResidencyHostMatch.MatchString(hostname) && !GHESAPISuffixMatch.MatchString(uv3.Path) {
+		uv3.Path = path.Join(uv3.Path, "api/v3/")
 	}
 
+	v3client := github.NewClient(client)
 	v3client.BaseURL = uv3
+	if !strings.HasSuffix(v3client.BaseURL.Path, "/") {
+		v3client.BaseURL.Path += "/"
+	}
 
 	return v3client, nil
 }

github/config_test.go

@@ -65,6 +65,141 @@ func TestGHECDataResidencyHostMatch(t *testing.T) {
 	}
 }
 
+func TestConfigMeta(t *testing.T) {
+	dotcomURL := "https://api.github.com/"
+	ghecURL := "https://customer.ghe.com/"
+	ghesURL := "https://example.com/api/v3/"
+	ghesPathURL := "https://example.com/test/api/v3/"
+
+	t.Run("returns a v3 rest api client for dotcom", func(t *testing.T) {
+		config := Config{
+			BaseURL: dotcomURL,
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != dotcomURL {
+			t.Fatalf("expected base URL %q, got %q", dotcomURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for dotcom with a base url missing a slash", func(t *testing.T) {
+		config := Config{
+			BaseURL: "https://api.github.com",
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != dotcomURL {
+			t.Fatalf("expected base URL %q, got %q", dotcomURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for ghec", func(t *testing.T) {
+		config := Config{
+			BaseURL: ghecURL,
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != ghecURL {
+			t.Fatalf("expected base URL %q, got %q", ghecURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for ghec with a base url missing a slash", func(t *testing.T) {
+		config := Config{
+			BaseURL: "https://customer.ghe.com",
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != ghecURL {
+			t.Fatalf("expected base URL %q, got %q", ghecURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for ghes with the api suffix", func(t *testing.T) {
+		config := Config{
+			BaseURL: ghesURL,
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != ghesURL {
+			t.Fatalf("expected base URL %q, got %q", ghesURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for ghes with the api suffix missing a slash", func(t *testing.T) {
+		config := Config{
+			BaseURL: "https://example.com/api/v3",
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != ghesURL {
+			t.Fatalf("expected base URL %q, got %q", ghesURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for ghes", func(t *testing.T) {
+		config := Config{
+			BaseURL: "https://example.com/",
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != ghesURL {
+			t.Fatalf("expected base URL %q, got %q", ghesURL, got)
+		}
+	})
+
+	t.Run("returns a v3 rest api client for ghes with a path", func(t *testing.T) {
+		config := Config{
+			BaseURL: ghesPathURL,
+		}
+		meta, err := config.Meta()
+		if err != nil {
+			t.Fatalf("failed to return meta without error: %s", err.Error())
+		}
+
+		client := meta.(*Owner).v3client
+		got := client.BaseURL.String()
+		if got != ghesPathURL {
+			t.Fatalf("expected base URL %q, got %q", ghesPathURL, got)
+		}
+	})
+}
+
 func TestAccConfigMeta(t *testing.T) {
 	// FIXME: Skip test runs during travis lint checking
 	if testToken == "" {