Merge pull request #496 from andyzhangx/fix-user-agent

fix: set default userAgent issue

Author: andyzhangx

go.mod

@@ -3,7 +3,7 @@ module sigs.k8s.io/blob-csi-driver
 go 1.16
 
 require (
-	github.com/Azure/azure-sdk-for-go v55.0.0+incompatible
+	github.com/Azure/azure-sdk-for-go v55.8.0+incompatible
 	github.com/Azure/go-autorest/autorest v0.11.19
 	github.com/Azure/go-autorest/autorest/adal v0.9.14
 	github.com/Azure/go-autorest/autorest/to v0.4.0
@@ -13,7 +13,7 @@ require (
 	github.com/imdario/mergo v0.3.9 // indirect
 	github.com/kubernetes-csi/csi-lib-utils v0.9.1
 	github.com/onsi/ginkgo v1.16.4
-	github.com/onsi/gomega v1.14.0
+	github.com/onsi/gomega v1.15.0
 	github.com/pborman/uuid v1.2.0
 	github.com/pelletier/go-toml v1.9.3
 	github.com/stretchr/testify v1.7.0
@@ -65,5 +65,5 @@ replace (
 	k8s.io/sample-apiserver => k8s.io/sample-apiserver v0.21.0
 	k8s.io/sample-cli-plugin => k8s.io/sample-cli-plugin v0.21.0
 	k8s.io/sample-controller => k8s.io/sample-controller v0.21.0
-	sigs.k8s.io/cloud-provider-azure => sigs.k8s.io/cloud-provider-azure v0.7.4-0.20210809074930-0a68438a5d9b
+	sigs.k8s.io/cloud-provider-azure => sigs.k8s.io/cloud-provider-azure v0.7.4-0.20210818035407-eee45743a454
 )

go.sum

@@ -40,8 +40,8 @@ cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20201218220906-28db891af037/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
 github.com/Azure/azure-sdk-for-go v43.0.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc=
-github.com/Azure/azure-sdk-for-go v55.0.0+incompatible h1:L4/vUGbg1Xkw5L20LZD+hJI5I+ibWSytqQ68lTCfLwY=
-github.com/Azure/azure-sdk-for-go v55.0.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc=
+github.com/Azure/azure-sdk-for-go v55.8.0+incompatible h1:EuccMPzxu67cIE95/mrtwQivLv7ETmURi5IUgLNVug8=
+github.com/Azure/azure-sdk-for-go v55.8.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc=
 github.com/Azure/go-ansiterm v0.0.0-20170929234023-d6e3b3328b78/go.mod h1:LmzpDX56iTiv29bbRTIsUNlaFfuhWRQBWjQdVyAevI8=
 github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs=
 github.com/Azure/go-autorest v14.2.0+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24=
@@ -505,8 +505,8 @@ github.com/onsi/gomega v1.5.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1Cpa
 github.com/onsi/gomega v1.7.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=
 github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY=
 github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo=
-github.com/onsi/gomega v1.14.0 h1:ep6kpPVwmr/nTbklSx2nrLNSIO62DoYAhnPNIMhK8gI=
-github.com/onsi/gomega v1.14.0/go.mod h1:cIuvLEne0aoVhAgh/O6ac0Op8WWw9H6eYCriF+tEHG0=
+github.com/onsi/gomega v1.15.0 h1:WjP/FQ/sk43MRmnEcT+MlDw2TFvkrXlprrPST/IudjU=
+github.com/onsi/gomega v1.15.0/go.mod h1:cIuvLEne0aoVhAgh/O6ac0Op8WWw9H6eYCriF+tEHG0=
 github.com/opencontainers/go-digest v0.0.0-20180430190053-c9281466c8b2/go.mod h1:cMLVZDEM3+U2I4VmLI6N8jQYUd2OVphdqWwCJHrFt2s=
 github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U=
 github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM=
@@ -1155,8 +1155,8 @@ rsc.io/quote/v3 v3.1.0/go.mod h1:yEA65RcK8LyAZtP9Kv3t0HmxON59tX3rD+tICJqUlj0=
 rsc.io/sampler v1.3.0/go.mod h1:T1hPZKmBbMNahiBKFy5HrXp6adAjACjK9JXDnKaTXpA=
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.15 h1:4uqm9Mv+w2MmBYD+F4qf/v6tDFUdPOk29C095RbU5mY=
 sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.0.15/go.mod h1:LEScyzhFmoF5pso/YSeBstl57mOzx9xlU9n85RGrDQg=
-sigs.k8s.io/cloud-provider-azure v0.7.4-0.20210809074930-0a68438a5d9b h1:ScCWjOHbypNOU/ofLRz11EY/ijWo1gfSAscBTA2Mvu8=
-sigs.k8s.io/cloud-provider-azure v0.7.4-0.20210809074930-0a68438a5d9b/go.mod h1:Gd+jQgsXRht6tNPCT7Q8VmcqGDIPTKnSatPhqrV8BGE=
+sigs.k8s.io/cloud-provider-azure v0.7.4-0.20210818035407-eee45743a454 h1:4MSCah1sCUji6CPhh2/PVN2dJkHQ6VKfqgAbfB2A6uE=
+sigs.k8s.io/cloud-provider-azure v0.7.4-0.20210818035407-eee45743a454/go.mod h1:VdV8LBAfcNDHKAQkn8nqcVdstFgr9gEUWt/NuPA56XM=
 sigs.k8s.io/kustomize/api v0.8.5/go.mod h1:M377apnKT5ZHJS++6H4rQoCHmWtt6qTpp3mbe7p6OLY=
 sigs.k8s.io/kustomize/cmd/config v0.9.7/go.mod h1:MvXCpHs77cfyxRmCNUQjIqCmZyYsbn5PyQpWiq44nW0=
 sigs.k8s.io/kustomize/kustomize/v4 v4.0.5/go.mod h1:C7rYla7sI8EnxHE/xEhRBSHMNfcL91fx0uKmUlUhrBk=

pkg/blob/azure.go

@@ -35,7 +35,7 @@ import (
 	"k8s.io/klog/v2"
 
 	"sigs.k8s.io/cloud-provider-azure/pkg/auth"
-	azureprovider "sigs.k8s.io/cloud-provider-azure/pkg/provider"
+	azure "sigs.k8s.io/cloud-provider-azure/pkg/provider"
 )
 
 var (
@@ -45,50 +45,74 @@ var (
 )
 
 // IsAzureStackCloud decides whether the driver is running on Azure Stack Cloud.
-func IsAzureStackCloud(cloud *azureprovider.Cloud) bool {
+func IsAzureStackCloud(cloud *azure.Cloud) bool {
 	return strings.EqualFold(cloud.Config.Cloud, "AZURESTACKCLOUD")
 }
 
 // getCloudProvider get Azure Cloud Provider
-func getCloudProvider(kubeconfig, nodeID, secretName, secretNamespace, userAgent string) (*azureprovider.Cloud, error) {
-	az := &azureprovider.Cloud{
-		InitSecretConfig: azureprovider.InitSecretConfig{
+func getCloudProvider(kubeconfig, nodeID, secretName, secretNamespace, userAgent string) (*azure.Cloud, error) {
+	az := &azure.Cloud{
+		InitSecretConfig: azure.InitSecretConfig{
 			SecretName:      secretName,
 			SecretNamespace: secretNamespace,
 			CloudConfigKey:  "cloud-config",
 		},
 	}
-	az.UserAgent = userAgent
+	az.Environment.StorageEndpointSuffix = storage.DefaultBaseURL
+
 	kubeClient, err := getKubeClient(kubeconfig)
-	if err != nil && !os.IsNotExist(err) && err != rest.ErrNotInCluster {
-		return az, fmt.Errorf("failed to get KubeClient: %v", err)
+	if err != nil {
+		klog.Warningf("get kubeconfig(%s) failed with error: %v", kubeconfig, err)
+		if !os.IsNotExist(err) && err != rest.ErrNotInCluster {
+			return az, fmt.Errorf("failed to get KubeClient: %v", err)
+		}
 	}
 
+	var (
+		config     *azure.Config
+		fromSecret bool
+	)
+
 	if kubeClient != nil {
-		klog.V(2).Infof("reading cloud config from secret")
+		klog.V(2).Infof("reading cloud config from secret %s/%s", az.SecretNamespace, az.SecretName)
 		az.KubeClient = kubeClient
-		if err := az.InitializeCloudFromSecret(); err != nil {
-			klog.V(2).Infof("InitializeCloudFromSecret failed with error: %v", err)
+		config, err = az.GetConfigFromSecret()
+		if err == nil && config != nil {
+			fromSecret = true
+		}
+		if err != nil {
+			klog.Warningf("InitializeCloudFromSecret: failed to get cloud config from secret %s/%s: %v", az.SecretNamespace, az.SecretName, err)
 		}
 	}
 
-	if az.TenantID == "" || az.SubscriptionID == "" || az.ResourceGroup == "" {
-		klog.V(2).Infof("could not read cloud config from secret")
+	if config == nil {
+		klog.V(2).Infof("could not read cloud config from secret %s/%s", az.SecretNamespace, az.SecretName)
 		credFile, ok := os.LookupEnv(DefaultAzureCredentialFileEnv)
-		if ok {
+		if ok && strings.TrimSpace(credFile) != "" {
 			klog.V(2).Infof("%s env var set as %v", DefaultAzureCredentialFileEnv, credFile)
 		} else {
 			credFile = DefaultCredFilePath
 			klog.V(2).Infof("use default %s env var: %v", DefaultAzureCredentialFileEnv, credFile)
 		}
 
-		config, errOpenFile := os.Open(credFile)
-		if errOpenFile != nil {
-			err = fmt.Errorf("load azure config from file(%s) failed with %v", credFile, errOpenFile)
+		credFileConfig, err := os.Open(credFile)
+		if err != nil {
+			klog.Warningf("load azure config from file(%s) failed with %v", credFile, err)
 		} else {
-			defer config.Close()
+			defer credFileConfig.Close()
 			klog.V(2).Infof("read cloud config from file: %s successfully", credFile)
-			az, err = azureprovider.NewCloudWithoutFeatureGates(config, false)
+			if config, err = azure.ParseConfig(credFileConfig); err != nil {
+				klog.Warningf("parse config file(%s) failed with error: %v", credFile, err)
+			}
+		}
+	}
+
+	if config == nil {
+		klog.V(2).Infof("no cloud config provided, error: %v, driver will run without cloud config", err)
+	} else {
+		config.UserAgent = userAgent
+		if err = az.InitializeCloudFromConfig(config, fromSecret, false); err != nil {
+			klog.Warningf("InitializeCloudFromConfig failed with error: %v", err)
 		}
 	}
 
@@ -97,13 +121,6 @@ func getCloudProvider(kubeconfig, nodeID, secretName, secretNamespace, userAgent
 		az.KubeClient = kubeClient
 	}
 
-	if err != nil {
-		klog.V(2).Infof("no cloud config provided, error: %v, driver will run without cloud config", err)
-		if az.Environment.StorageEndpointSuffix == "" {
-			az.Environment.StorageEndpointSuffix = storage.DefaultBaseURL
-		}
-	}
-
 	isController := (nodeID == "")
 	if isController {
 		if err == nil {
@@ -117,6 +134,9 @@ func getCloudProvider(kubeconfig, nodeID, secretName, secretNamespace, userAgent
 		klog.V(2).Infof("starting node server on node(%s)", nodeID)
 	}
 
+	if az.Environment.StorageEndpointSuffix == "" {
+		az.Environment.StorageEndpointSuffix = storage.DefaultBaseURL
+	}
 	return az, nil
 }
 

pkg/blob/azure_test.go

@@ -25,6 +25,7 @@ import (
 	"testing"
 
 	"github.com/Azure/azure-sdk-for-go/services/network/mgmt/2021-02-01/network"
+	"github.com/Azure/azure-sdk-for-go/storage"
 	"github.com/golang/mock/gomock"
 
 	"github.com/Azure/go-autorest/autorest/azure"
@@ -81,6 +82,7 @@ users:
 		desc        string
 		kubeconfig  string
 		nodeID      string
+		userAgent   string
 		expectedErr error
 	}{
 		{
@@ -111,6 +113,7 @@ users:
 			desc:        "[success] out of cluster & in cluster, no kubeconfig, a fake credential file",
 			kubeconfig:  "",
 			nodeID:      "",
+			userAgent:   "useragent",
 			expectedErr: nil,
 		},
 	}
@@ -150,12 +153,15 @@ users:
 			}
 			os.Setenv(DefaultAzureCredentialFileEnv, fakeCredFile)
 		}
-		cloud, err := getCloudProvider(test.kubeconfig, test.nodeID, "", "", "")
+		cloud, err := getCloudProvider(test.kubeconfig, test.nodeID, "", "", test.userAgent)
 		if !reflect.DeepEqual(err, test.expectedErr) {
 			t.Errorf("desc: %s,\n input: %q, GetCloudProvider err: %v, expectedErr: %v", test.desc, test.kubeconfig, err, test.expectedErr)
 		}
 		if cloud == nil {
 			t.Errorf("return value of getCloudProvider should not be nil even there is error")
+		} else {
+			assert.Equal(t, cloud.Environment.StorageEndpointSuffix, storage.DefaultBaseURL)
+			assert.Equal(t, cloud.UserAgent, test.userAgent)
 		}
 	}
 }