Adding UserAgent string for azidentity telemetry

sdk/azidentity/aad_identity_client.go

@@ -55,6 +55,11 @@ type aadIdentityClient struct {
 // will be used to retrieve tokens and authenticate
 func newAADIdentityClient(authorityHost string, options pipelineOptions) (*aadIdentityClient, error) {
 	logEnvVars()
+	if options.Telemetry.Value == "" {
+		options.Telemetry.Value = UserAgent
+	} else {
+		options.Telemetry.Value += " " + UserAgent
+	}
 	return &aadIdentityClient{authorityHost: authorityHost, pipeline: newDefaultPipeline(options)}, nil
 }
 

sdk/azidentity/aad_identity_client_test.go

@@ -4,8 +4,14 @@
 package azidentity
 
 import (
+	"context"
+	"net/http"
 	"net/url"
+	"strings"
 	"testing"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/internal/mock"
 )
 
 func TestAzurePublicCloudParse(t *testing.T) {
@@ -35,3 +41,62 @@ func TestAzureGovernmentParse(t *testing.T) {
 		t.Fatalf("Failed to parse AzureGovernment authority host: %v", err)
 	}
 }
+func TestTelemetryDefaultUserAgent(t *testing.T) {
+	srv, close := mock.NewServer()
+	defer close()
+	srv.AppendResponse(mock.WithBody([]byte(accessTokenRespSuccess)))
+	options := pipelineOptions{
+		HTTPClient: srv,
+		Telemetry:  azcore.DefaultTelemetryOptions(),
+		Retry:      azcore.DefaultRetryOptions(),
+	}
+	client, err := newAADIdentityClient(srv.URL(), options)
+	if err != nil {
+		t.Fatalf("Unable to create credential. Received: %v", err)
+	}
+	req, err := azcore.NewRequest(context.Background(), http.MethodGet, srv.URL())
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	resp, err := client.pipeline.Do(req)
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	if resp.StatusCode != http.StatusOK {
+		t.Fatalf("unexpected status code: %d", resp.StatusCode)
+	}
+	if ua := resp.Request.Header.Get(azcore.HeaderUserAgent); !strings.HasPrefix(ua, UserAgent) {
+		t.Fatalf("unexpected User-Agent %s", ua)
+	}
+}
+
+func TestTelemetryCustom(t *testing.T) {
+	customTelemetry := "customvalue"
+	srv, close := mock.NewServer()
+	defer close()
+	srv.AppendResponse(mock.WithBody([]byte(accessTokenRespSuccess)))
+	options := pipelineOptions{
+		HTTPClient: srv,
+		Telemetry:  azcore.DefaultTelemetryOptions(),
+		Retry:      azcore.DefaultRetryOptions(),
+	}
+	options.Telemetry.Value = customTelemetry
+	client, err := newAADIdentityClient(srv.URL(), options)
+	if err != nil {
+		t.Fatalf("Unable to create credential. Received: %v", err)
+	}
+	req, err := azcore.NewRequest(context.Background(), http.MethodGet, srv.URL())
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	resp, err := client.pipeline.Do(req)
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	if resp.StatusCode != http.StatusOK {
+		t.Fatalf("unexpected status code: %d", resp.StatusCode)
+	}
+	if ua := resp.Request.Header.Get(azcore.HeaderUserAgent); !strings.HasPrefix(ua, customTelemetry+" "+UserAgent) {
+		t.Fatalf("unexpected User-Agent %s", ua)
+	}
+}

sdk/azidentity/azidentity.go

@@ -186,7 +186,11 @@ func newDefaultMSIPipeline(o ManagedIdentityCredentialOptions) azcore.Pipeline {
 			http.StatusNotExtended,                    // 510
 			http.StatusNetworkAuthenticationRequired), // 511
 	}
-
+	if o.Telemetry.Value == "" {
+		o.Telemetry.Value = UserAgent
+	} else {
+		o.Telemetry.Value += " " + UserAgent
+	}
 	return azcore.NewPipeline(
 		o.HTTPClient,
 		azcore.NewTelemetryPolicy(&o.Telemetry),

sdk/azidentity/go.mod

@@ -3,7 +3,7 @@ module github.com/Azure/azure-sdk-for-go/sdk/azidentity
 go 1.14
 
 require (
-	github.com/Azure/azure-sdk-for-go/sdk/azcore v0.13.1
+	github.com/Azure/azure-sdk-for-go/sdk/azcore v0.13.4
 	github.com/Azure/azure-sdk-for-go/sdk/internal v0.5.0
 	github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4
 	golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897

sdk/azidentity/go.sum

@@ -1,5 +1,5 @@
-github.com/Azure/azure-sdk-for-go/sdk/azcore v0.13.1 h1:YLBIWApuKB/RS0dK/mk/2g6x2+kjI9djMKqViZDTD88=
-github.com/Azure/azure-sdk-for-go/sdk/azcore v0.13.1/go.mod h1:pElNP+u99BvCZD+0jOlhI9OC/NB2IDTOTGZOZH0Qhq8=
+github.com/Azure/azure-sdk-for-go/sdk/azcore v0.13.4 h1:7MfvHEWKfjZSKQNWERlXpHwCRoceEuQef/fB8CWmnQA=
+github.com/Azure/azure-sdk-for-go/sdk/azcore v0.13.4/go.mod h1:pElNP+u99BvCZD+0jOlhI9OC/NB2IDTOTGZOZH0Qhq8=
 github.com/Azure/azure-sdk-for-go/sdk/internal v0.5.0 h1:HG1ggl8L3ZkV/Ydanf7lKr5kkhhPGCpWdnr1J6v7cO4=
 github.com/Azure/azure-sdk-for-go/sdk/internal v0.5.0/go.mod h1:k4KbFSunV/+0hOHL1vyFaPsiYQ1Vmvy1TBpmtvCDLZM=
 github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4 h1:49lOXmGaUpV9Fz3gd7TFZY106KVlPVa5jcYD1gaQf98=

sdk/azidentity/managed_identity_client_test.go

@@ -4,8 +4,14 @@
 package azidentity
 
 import (
+	"context"
+	"net/http"
 	"net/url"
+	"strings"
 	"testing"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/internal/mock"
 )
 
 func TestIMDSEndpointParse(t *testing.T) {
@@ -14,3 +20,55 @@ func TestIMDSEndpointParse(t *testing.T) {
 		t.Fatalf("Failed to parse the IMDS endpoint: %v", err)
 	}
 }
+
+func TestMSITelemetryDefaultUserAgent(t *testing.T) {
+	srv, close := mock.NewServer()
+	defer close()
+	srv.AppendResponse(mock.WithBody([]byte(accessTokenRespSuccess)))
+	options := ManagedIdentityCredentialOptions{
+		HTTPClient: srv,
+		Telemetry:  azcore.DefaultTelemetryOptions(),
+	}
+	pipeline := newDefaultMSIPipeline(options)
+	req, err := azcore.NewRequest(context.Background(), http.MethodGet, srv.URL())
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	resp, err := pipeline.Do(req)
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	if resp.StatusCode != http.StatusOK {
+		t.Fatalf("unexpected status code: %d", resp.StatusCode)
+	}
+	if ua := resp.Request.Header.Get(azcore.HeaderUserAgent); !strings.HasPrefix(ua, UserAgent) {
+		t.Fatalf("unexpected User-Agent %s", ua)
+	}
+}
+
+func TestMSITelemetryCustom(t *testing.T) {
+	customTelemetry := "customvalue"
+	srv, close := mock.NewServer()
+	defer close()
+	srv.AppendResponse(mock.WithBody([]byte(accessTokenRespSuccess)))
+	options := ManagedIdentityCredentialOptions{
+		HTTPClient: srv,
+		Telemetry:  azcore.DefaultTelemetryOptions(),
+	}
+	options.Telemetry.Value = customTelemetry
+	pipeline := newDefaultMSIPipeline(options)
+	req, err := azcore.NewRequest(context.Background(), http.MethodGet, srv.URL())
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	resp, err := pipeline.Do(req)
+	if err != nil {
+		t.Fatalf("Unexpected error: %v", err)
+	}
+	if resp.StatusCode != http.StatusOK {
+		t.Fatalf("unexpected status code: %d", resp.StatusCode)
+	}
+	if ua := resp.Request.Header.Get(azcore.HeaderUserAgent); !strings.HasPrefix(ua, customTelemetry+" "+UserAgent) {
+		t.Fatalf("unexpected User-Agent %s", ua)
+	}
+}

sdk/azidentity/version.go

@@ -0,0 +1,14 @@
+// +build go1.13
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package azidentity
+
+const (
+	// UserAgent is the string to be used in the user agent string when making requests.
+	UserAgent = "azidentity/" + Version
+
+	// Version is the semantic version (see http://semver.org) of this module.
+	Version = "v0.6.1"
+)