Add UserAgent for HTTP headers (#305)

* Update azure-pipeline.yml for Azure Pipelines

* sync with upstream

* Add userAgent for http headers

Co-authored-by: Nicholas M. Iodice <niiodice@microsoft.com>

Author: xuzhang3

azuredevops/provider.go

@@ -55,7 +55,15 @@ func Provider() *schema.Provider {
 
 func providerConfigure(p *schema.Provider) schema.ConfigureFunc {
 	return func(d *schema.ResourceData) (interface{}, error) {
-		client, err := config.GetAzdoClient(d.Get("personal_access_token").(string), d.Get("org_service_url").(string))
+		terraformVersion := p.TerraformVersion
+		if terraformVersion == "" {
+			// Terraform 0.12 introduced this field to the protocol
+			// We can therefore assume that if it's missing it's 0.10 or 0.11
+			terraformVersion = "0.11+compatible"
+		}
+
+		client, err := config.GetAzdoClient(d.Get("personal_access_token").(string), d.Get("org_service_url").(string), terraformVersion)
+
 		return client, err
 	}
 }

azuredevops/utils/config/config.go

@@ -4,8 +4,10 @@ import (
 	"context"
 	"fmt"
 	"log"
+	"os"
 	"strings"
 
+	"github.com/hashicorp/terraform-plugin-sdk/httpclient"
 	"github.com/microsoft/azure-devops-go-api/azuredevops"
 	"github.com/microsoft/azure-devops-go-api/azuredevops/build"
 	"github.com/microsoft/azure-devops-go-api/azuredevops/core"
@@ -15,6 +17,7 @@ import (
 	"github.com/microsoft/azure-devops-go-api/azuredevops/operations"
 	"github.com/microsoft/azure-devops-go-api/azuredevops/serviceendpoint"
 	"github.com/microsoft/azure-devops-go-api/azuredevops/taskagent"
+	"github.com/microsoft/terraform-provider-azuredevops/version"
 )
 
 // AggregatedClient aggregates all of the underlying clients into a single data
@@ -37,7 +40,7 @@ type AggregatedClient struct {
 }
 
 // GetAzdoClient builds and provides a connection to the Azure DevOps API
-func GetAzdoClient(azdoPAT string, organizationURL string) (*AggregatedClient, error) {
+func GetAzdoClient(azdoPAT string, organizationURL string, tfVersion string) (*AggregatedClient, error) {
 	ctx := context.Background()
 
 	if strings.EqualFold(azdoPAT, "") {
@@ -49,6 +52,7 @@ func GetAzdoClient(azdoPAT string, organizationURL string) (*AggregatedClient, e
 	}
 
 	connection := azuredevops.NewPatConnection(organizationURL, azdoPAT)
+	setUserAgent(connection, tfVersion)
 
 	// client for these APIs (includes CRUD for AzDO projects...):
 	//	https://docs.microsoft.com/en-us/rest/api/azure/devops/core/?view=azure-devops-rest-5.1
@@ -121,3 +125,17 @@ func GetAzdoClient(azdoPAT string, organizationURL string) (*AggregatedClient, e
 	log.Printf("getAzdoClient(): Created core, build, operations, and serviceendpoint clients successfully!")
 	return aggregatedClient, nil
 }
+
+// setUserAgent set UserAgent for http headers
+func setUserAgent(connection *azuredevops.Connection, tfVersion string) {
+	tfUserAgent := httpclient.TerraformUserAgent(tfVersion)
+	providerUserAgent := fmt.Sprintf("%s terraform-provider-azuredevops/%s", tfUserAgent, version.ProviderVersion)
+	connection.UserAgent = strings.TrimSpace(fmt.Sprintf("%s %s", connection.UserAgent, providerUserAgent))
+
+	// append the CloudShell version to the user agent if it exists
+	if azureAgent := os.Getenv("AZURE_HTTP_USER_AGENT"); azureAgent != "" {
+		connection.UserAgent = fmt.Sprintf("%s %s", connection.UserAgent, azureAgent)
+	}
+
+	log.Printf("[DEBUG] AzureRM Client User Agent: %s\n", connection.UserAgent)
+}

version/version.go

@@ -0,0 +1,6 @@
+package version
+
+var (
+	// ProviderVersion is set during the release process to the release version of the binary
+	ProviderVersion = "dev"
+)