Added support to fetch UserAgent from env var

Author: ravinitp

internal/globalvar/constants.go

@@ -20,6 +20,8 @@ const (
 	TestTerraformCLIVersion               = "test"
 	UserAgentFormatter                    = "Oracle-GoSDK/%s (go/%s; %s/%s; terraform/%s; terraform-cli/%s) %s/%s"
 	UserAgentProviderNameEnv              = "USER_AGENT_PROVIDER_NAME"
+	UserAgentTerraformNameEnv             = "TF_APPEND_USER_AGENT"
+	UserAgentSDKNameEnv                   = "OCI_SDK_APPEND_USER_AGENT"
 	DomainNameOverrideEnv                 = "domain_name_override"
 	HasCorrectDomainNameEnv               = "has_correct_domain_name"
 	ClientHostOverridesEnv                = "CLIENT_HOST_OVERRIDES"

internal/provider/provider.go

@@ -45,6 +45,7 @@ var ApiKeyConfigAttributes = [5]string{globalvar.UserOcidAttrName, globalvar.Fin
 var ociProvider *schema.Provider
 
 var TerraformCLIVersion = globalvar.UnknownTerraformCLIVersion
+var schemaMultiEnvDefaultFuncVar = schema.MultiEnvDefaultFunc
 var AvoidWaitingForDeleteTarget bool
 
 // creating an interface to aid in unit tests
@@ -569,12 +570,23 @@ func BuildHttpClient() (httpClient *http.Client) {
 	return
 }
 
+func UserAgentFromEnv() string {
+
+	userAgentFromEnv, err := schemaMultiEnvDefaultFuncVar([]string{globalvar.UserAgentProviderNameEnv, globalvar.UserAgentSDKNameEnv, globalvar.UserAgentTerraformNameEnv}, globalvar.DefaultUserAgentProviderName)()
+
+	if err != nil {
+		log.Printf("[ERROR] Error while fetching user agent from env var: %v", err)
+		return globalvar.DefaultUserAgentProviderName
+	}
+	return userAgentFromEnv.(string)
+}
+
 func BuildConfigureClientFn(configProvider oci_common.ConfigurationProvider, httpClient *http.Client) (tf_client.ConfigureClient, error) {
 
 	if ociProvider != nil && len(ociProvider.TerraformVersion) > 0 {
 		TerraformCLIVersion = ociProvider.TerraformVersion
 	}
-	userAgentProviderName := utils.GetEnvSettingWithDefault(globalvar.UserAgentProviderNameEnv, globalvar.DefaultUserAgentProviderName)
+	userAgentProviderName := UserAgentFromEnv()
 	userAgent := fmt.Sprintf(globalvar.UserAgentFormatter, oci_common.Version(), runtime.Version(), runtime.GOOS, runtime.GOARCH, sdkMeta.SDKVersionString(), TerraformCLIVersion, userAgentProviderName, globalvar.Version)
 
 	useOboToken, err := strconv.ParseBool(utils.GetEnvSettingWithDefault("use_obo_token", "false"))

internal/provider/provider_test.go

@@ -851,3 +851,28 @@ func TestUnit_OciVarName(t *testing.T) {
 		})
 	}
 }
+func TestUnitUserAgentFromEnv(t *testing.T) {
+	tests := []struct {
+		name string
+		want string
+		mock func() (interface{}, error)
+	}{{
+		"env value",
+		"agent/terraform",
+		func() (interface{}, error) { return "agent/terraform", nil },
+	},
+		{
+			"default value",
+			globalvar.DefaultUserAgentProviderName,
+			func() (interface{}, error) { return globalvar.DefaultUserAgentProviderName, nil },
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			schemaMultiEnvDefaultFuncVar = func(ks []string, dv interface{}) schema.SchemaDefaultFunc {
+				return tt.mock
+			}
+			assert.Equalf(t, tt.want, UserAgentFromEnv(), tt.name)
+		})
+	}
+}