fix: set default userAgent issue

fix golint

refactor

fix ut

Author: andyzhangx

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)
 		}
 	}
 }