Merge pull request #136 from fluxcd/gitlab-custom-domain

Ensure that the baseURL for the gitlab client includes a scheme

Author: yiannistri

gitlab/auth.go

@@ -17,6 +17,8 @@ limitations under the License.
 package gitlab
 
 import (
+	"net/url"
+
 	"github.com/fluxcd/go-git-providers/gitprovider"
 	gogitlab "github.com/xanzy/go-gitlab"
 )
@@ -37,6 +39,21 @@ func NewClient(token string, tokenType string, optFns ...gitprovider.ClientOptio
 		return nil, err
 	}
 
+	// Ensure that the URL includes a scheme when using a custom domain.
+	if opts.Domain != nil && *opts.Domain != "" {
+		d, err := url.Parse(*opts.Domain)
+		if err != nil {
+			return nil, err
+		}
+		if d.Scheme != "http" && d.Scheme != "https" {
+			u := url.URL{
+				Scheme: "https",
+				Host:   *opts.Domain,
+			}
+			*opts.Domain = u.String()
+		}
+	}
+
 	// Create a *http.Client using the transport chain
 	httpClient, err := gitprovider.BuildClientFromTransportChain(opts.GetTransportChain())
 	if err != nil {

gitlab/auth_test.go

@@ -20,9 +20,10 @@ import (
 	"testing"
 
 	"github.com/fluxcd/go-git-providers/gitprovider"
+	gogitlab "github.com/xanzy/go-gitlab"
 )
 
-func Test_DomainVariations(t *testing.T) {
+func TestSupportedDomain(t *testing.T) {
 	tests := []struct {
 		name         string
 		opts         gitprovider.ClientOption
@@ -39,16 +40,31 @@ func Test_DomainVariations(t *testing.T) {
 			opts: gitprovider.WithDomain("my-gitlab.dev.com"),
 			want: "https://my-gitlab.dev.com",
 		},
+		{
+			name: "custom domain without protocol with port",
+			opts: gitprovider.WithDomain("my-gitlab.dev.com:1234"),
+			want: "https://my-gitlab.dev.com:1234",
+		},
 		{
 			name: "custom domain with https protocol",
 			opts: gitprovider.WithDomain("https://my-gitlab.dev.com"),
 			want: "https://my-gitlab.dev.com",
 		},
+		{
+			name: "custom domain with https protocol with port",
+			opts: gitprovider.WithDomain("https://my-gitlab.dev.com:1234"),
+			want: "https://my-gitlab.dev.com:1234",
+		},
 		{
 			name: "custom domain with http protocol",
 			opts: gitprovider.WithDomain("http://my-gitlab.dev.com"),
 			want: "http://my-gitlab.dev.com",
 		},
+		{
+			name: "custom domain with http protocol with port",
+			opts: gitprovider.WithDomain("http://my-gitlab.dev.com:1234"),
+			want: "http://my-gitlab.dev.com:1234",
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -61,6 +77,61 @@ func Test_DomainVariations(t *testing.T) {
 	}
 }
 
+func TestBaseURL(t *testing.T) {
+	tests := []struct {
+		name     string
+		opts     gitprovider.ClientOption
+		expected string
+	}{
+		{
+			name:     "gitlab.com domain",
+			opts:     gitprovider.WithDomain("gitlab.com"),
+			expected: "https://gitlab.com/api/v4/",
+		},
+		{
+			name:     "custom domain without protocol",
+			opts:     gitprovider.WithDomain("my-gitlab.dev.com"),
+			expected: "https://my-gitlab.dev.com/api/v4/",
+		},
+		{
+			name:     "custom domain without protocol with port",
+			opts:     gitprovider.WithDomain("my-gitlab.dev.com:1234"),
+			expected: "https://my-gitlab.dev.com:1234/api/v4/",
+		},
+		{
+			name:     "custom domain with https protocol",
+			opts:     gitprovider.WithDomain("https://my-gitlab.dev.com"),
+			expected: "https://my-gitlab.dev.com/api/v4/",
+		},
+		{
+			name:     "custom domain with https protocol with port",
+			opts:     gitprovider.WithDomain("https://my-gitlab.dev.com:1234"),
+			expected: "https://my-gitlab.dev.com:1234/api/v4/",
+		},
+		{
+			name:     "custom domain with http protocol",
+			opts:     gitprovider.WithDomain("http://my-gitlab.dev.com"),
+			expected: "http://my-gitlab.dev.com/api/v4/",
+		},
+		{
+			name:     "custom domain with http protocol with port",
+			opts:     gitprovider.WithDomain("http://my-gitlab.dev.com:1234"),
+			expected: "http://my-gitlab.dev.com:1234/api/v4/",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c1, _ := NewClient("token", "oauth2", tt.opts)
+			gc1 := c1.Raw().(*gogitlab.Client)
+			assertEqual(t, tt.expected, gc1.BaseURL().String())
+
+			c2, _ := NewClient("token", "pat", tt.opts)
+			gc2 := c2.Raw().(*gogitlab.Client)
+			assertEqual(t, tt.expected, gc2.BaseURL().String())
+		})
+	}
+}
+
 func assertEqual(t *testing.T, a interface{}, b interface{}) {
 	if a != b {
 		t.Fatalf("%s != %s", a, b)

gitlab/util.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
+	"net/url"
 	"strings"
 
 	"github.com/fluxcd/go-git-providers/gitprovider"
@@ -191,6 +192,17 @@ func validateOrganizationRef(ref gitprovider.OrganizationRef, expectedDomain str
 // validateIdentityFields makes sure the type of the IdentityRef is supported, and the domain is as expected.
 func validateIdentityFields(ref gitprovider.IdentityRef, expectedDomain string) error {
 	// Make sure the expected domain is used
+
+	// For custom domains ensure the expected domain only includes host
+	// and port information but not the scheme.
+	if expectedDomain != DefaultDomain {
+		d, err := url.Parse(expectedDomain)
+		if err != nil {
+			return err
+		}
+		expectedDomain = d.Host
+	}
+
 	if ref.GetDomain() != expectedDomain {
 		return fmt.Errorf("domain %q not supported by this client: %w", ref.GetDomain(), gitprovider.ErrDomainUnsupported)
 	}