From 7723d9394657cb2b830eb9cffe37b6e42c23ab9c Mon Sep 17 00:00:00 2001 From: Elbaz Date: Sun, 27 Aug 2023 13:55:04 +0300 Subject: [PATCH] export more commons --- internal/backend/remote-state/oss/backend.go | 2 +- internal/backend/remote-state/s3/backend.go | 5 +++-- internal/httpclient/useragent.go | 10 +++++++--- internal/httpclient/useragent_test.go | 2 +- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/internal/backend/remote-state/oss/backend.go b/internal/backend/remote-state/oss/backend.go index e963bab399..d7221c8b04 100644 --- a/internal/backend/remote-state/oss/backend.go +++ b/internal/backend/remote-state/oss/backend.go @@ -439,7 +439,7 @@ func (b *Backend) getOSSEndpointByRegion(access_key, secret_key, security_token, return nil, fmt.Errorf("unable to initialize the location client: %#v", err) } - locationClient.AppendUserAgent(httpclient.TerraformUA, TerraformVersion) + locationClient.AppendUserAgent(httpclient.OpenTFUserAgent, TerraformVersion) endpointsResponse, err := locationClient.DescribeEndpoints(args) if err != nil { return nil, fmt.Errorf("describe oss endpoint using region: %#v got an error: %#v", region, err) diff --git a/internal/backend/remote-state/s3/backend.go b/internal/backend/remote-state/s3/backend.go index 5a39060e9e..bc01c7670b 100644 --- a/internal/backend/remote-state/s3/backend.go +++ b/internal/backend/remote-state/s3/backend.go @@ -6,6 +6,7 @@ package s3 import ( "encoding/base64" "fmt" + "github.com/placeholderplaceholderplaceholder/opentf/internal/httpclient" "os" "strings" @@ -394,8 +395,8 @@ func (b *Backend) Configure(obj cty.Value) tfdiags.Diagnostics { Token: stringAttr(obj, "token"), UserAgentProducts: []*awsbase.UserAgentProduct{ {Name: "APN", Version: "1.0"}, - {Name: "placeholderplaceholderplaceholder", Version: "1.0"}, - {Name: "OpenTF", Version: version.String()}, + {Name: httpclient.OpenTFUserAgent, Version: "1.0"}, + {Name: httpclient.Organization, Version: version.String()}, }, } diff --git a/internal/httpclient/useragent.go b/internal/httpclient/useragent.go index dd811ddccb..2d0d760a51 100644 --- a/internal/httpclient/useragent.go +++ b/internal/httpclient/useragent.go @@ -11,8 +11,12 @@ import ( "strings" ) -const uaEnvVar = "TF_APPEND_USER_AGENT" -const TerraformUA = "placeholderplaceholderplaceholder-OpenTF" +const ( + uaEnvVar = "TF_APPEND_USER_AGENT" + Organization = "placeholderplaceholderplaceholder" + Application = "OpenTF" + OpenTFUserAgent = Organization + "-" + Application +) type userAgentRoundTripper struct { inner http.RoundTripper @@ -28,7 +32,7 @@ func (rt *userAgentRoundTripper) RoundTrip(req *http.Request) (*http.Response, e } func TerraformUserAgent(version string) string { - ua := fmt.Sprintf("%s/%s (+https://www.opentf.org)", TerraformUA, version) + ua := fmt.Sprintf("%s/%s (+https://www.opentf.org)", OpenTFUserAgent, version) if add := os.Getenv(uaEnvVar); add != "" { add = strings.TrimSpace(add) diff --git a/internal/httpclient/useragent_test.go b/internal/httpclient/useragent_test.go index ac0d5f9b7c..71293a9a8c 100644 --- a/internal/httpclient/useragent_test.go +++ b/internal/httpclient/useragent_test.go @@ -12,7 +12,7 @@ import ( ) func TestUserAgentString_env(t *testing.T) { - expectedBase := fmt.Sprintf("%s/%s (+https://www.opentf.org)", TerraformUA, version.Version) + expectedBase := fmt.Sprintf("%s/%s (+https://www.opentf.org)", OpenTFUserAgent, version.Version) if oldenv, isSet := os.LookupEnv(uaEnvVar); isSet { defer os.Setenv(uaEnvVar, oldenv) } else {