Merge pull request #451 from bishtawi/sb/user-agent

Enable custom UserAgent

Author: nicholasklick

gitlab/config.go

@@ -21,7 +21,7 @@ type Config struct {
 }
 
 // Client returns a *gitlab.Client to interact with the configured gitlab instance
-func (c *Config) Client() (interface{}, error) {
+func (c *Config) Client() (*gitlab.Client, error) {
 	// Configure TLS/SSL
 	tlsConfig := &tls.Config{}
 

gitlab/provider.go

@@ -5,14 +5,15 @@ import (
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/httpclient"
 	"github.com/hashicorp/terraform-plugin-sdk/terraform"
 )
 
 // Provider returns a terraform.ResourceProvider.
 func Provider() terraform.ResourceProvider {
 
 	// The actual provider
-	return &schema.Provider{
+	provider := &schema.Provider{
 		Schema: map[string]*schema.Schema{
 			"token": {
 				Type:        schema.TypeString,
@@ -93,9 +94,13 @@ func Provider() terraform.ResourceProvider {
 			"gitlab_project_mirror":             resourceGitlabProjectMirror(),
 			"gitlab_project_level_mr_approvals": resourceGitlabProjectLevelMRApprovals(),
 		},
+	}
 
-		ConfigureFunc: providerConfigure,
+	provider.ConfigureFunc = func(d *schema.ResourceData) (interface{}, error) {
+		return providerConfigure(provider, d)
 	}
+
+	return provider
 }
 
 var descriptions map[string]string
@@ -116,7 +121,7 @@ func init() {
 	}
 }
 
-func providerConfigure(d *schema.ResourceData) (interface{}, error) {
+func providerConfigure(p *schema.Provider, d *schema.ResourceData) (interface{}, error) {
 	config := Config{
 		Token:      d.Get("token").(string),
 		BaseURL:    d.Get("base_url").(string),
@@ -126,13 +131,22 @@ func providerConfigure(d *schema.ResourceData) (interface{}, error) {
 		ClientKey:  d.Get("client_key").(string),
 	}
 
-	return config.Client()
+	client, err := config.Client()
+	if err != nil {
+		return nil, err
+	}
+
+	// NOTE: httpclient.TerraformUserAgent is deprecated and removed in Terraform SDK v2
+	// After upgrading the SDK to v2 replace with p.UserAgent("terraform-provider-gitlab")
+	client.UserAgent = httpclient.TerraformUserAgent(p.TerraformVersion) + " terraform-provider-gitlab"
+
+	return client, err
 }
 
 func validateApiURLVersion(value interface{}, key string) (ws []string, es []error) {
 	v := value.(string)
 	if strings.HasSuffix(v, "/api/v3") || strings.HasSuffix(v, "/api/v3/") {
-		es = append(es, fmt.Errorf("terraform-gitlab-provider does not support v3 api; please upgrade to /api/v4 in %s", v))
+		es = append(es, fmt.Errorf("terraform-provider-gitlab does not support v3 api; please upgrade to /api/v4 in %s", v))
 	}
 	return
 }