-
Notifications
You must be signed in to change notification settings - Fork 638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add loadoptions to configure BaseEndpoint #2837
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"id": "024e7efa-fa27-4001-b867-7eb90bd32260", | ||
"type": "feature", | ||
"description": "Adds the LoadOptions hook `WithBaseEndpoint` for setting global endpoint override in-code.", | ||
"modules": [ | ||
"config" | ||
] | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,187 @@ | ||
package main | ||
|
||
import ( | ||
"context" | ||
"os" | ||
"testing" | ||
|
||
"github.com/aws/aws-sdk-go-v2/aws" | ||
"github.com/aws/aws-sdk-go-v2/config" | ||
"github.com/aws/aws-sdk-go-v2/service/s3" | ||
) | ||
|
||
// From the SEP: | ||
// Service-specific endpoint configuration MUST be resolved with an endpoint URL provider chain with the following precedence: | ||
// - The value provided through code to an AWS SDK or tool via a command line | ||
// parameter or a client or configuration constructor; for example the | ||
// --endpoint-url command line parameter or the endpoint_url parameter | ||
// provided to the Python SDK client. | ||
// - The value provided by a service-specific environment variable. | ||
// - The value provided by the global endpoint environment variable | ||
// (AWS_ENDPOINT_URL). | ||
// - The value provided by a service-specific parameter from a services | ||
// definition section referenced in a profile in the shared configuration | ||
// file. | ||
// - The value provided by the global parameter from a profile in the shared | ||
// configuration file. | ||
// - The value resolved through the methods provided by the SDK or tool when | ||
// no explicit endpoint URL is provided. | ||
|
||
func TestEndpointURL(t *testing.T) { | ||
for name, tt := range map[string]struct { | ||
Env map[string]string | ||
SharedConfig string | ||
LoadOpts []func(*config.LoadOptions) error | ||
ClientOpts []func(*s3.Options) | ||
Expect string | ||
}{ | ||
"no values": { | ||
SharedConfig: ` | ||
[default] | ||
`, | ||
Expect: "", | ||
}, | ||
|
||
"precedence 0: in-code, set via s3.Options": { | ||
Env: map[string]string{ | ||
"AWS_ENDPOINT_URL": "https://global-env.com", | ||
"AWS_ENDPOINT_URL_S3": "https://service-env.com", | ||
}, | ||
SharedConfig: ` | ||
[default] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. thought, non blocking: I understand why multi-line strings are like this, but boy are they not pretty to read |
||
endpoint_url = https://global-cfg.com | ||
services = service_cfg | ||
|
||
[services service_cfg] | ||
s3 = | ||
endpoint_url = https://service-cfg.com | ||
`, | ||
LoadOpts: []func(*config.LoadOptions) error{ | ||
config.WithBaseEndpoint("https://loadopts.com"), | ||
}, | ||
ClientOpts: []func(*s3.Options){ | ||
func(o *s3.Options) { | ||
o.BaseEndpoint = aws.String("https://clientopts.com") | ||
}, | ||
}, | ||
Expect: "https://clientopts.com", | ||
}, | ||
|
||
"precedence 0: in-code, set via config.LoadOptions": { | ||
Env: map[string]string{ | ||
"AWS_ENDPOINT_URL": "https://global-env.com", | ||
"AWS_ENDPOINT_URL_S3": "https://service-env.com", | ||
}, | ||
SharedConfig: ` | ||
[default] | ||
endpoint_url = https://global-cfg.com | ||
services = service_cfg | ||
|
||
[services service_cfg] | ||
s3 = | ||
endpoint_url = https://service-cfg.com | ||
`, | ||
LoadOpts: []func(*config.LoadOptions) error{ | ||
config.WithBaseEndpoint("https://loadopts.com"), | ||
}, | ||
Expect: "https://loadopts.com", | ||
}, | ||
|
||
"precedence 1: service env": { | ||
Env: map[string]string{ | ||
"AWS_ENDPOINT_URL": "https://global-env.com", | ||
"AWS_ENDPOINT_URL_S3": "https://service-env.com", | ||
}, | ||
SharedConfig: ` | ||
[default] | ||
endpoint_url = https://global-cfg.com | ||
services = service_cfg | ||
|
||
[services service_cfg] | ||
s3 = | ||
endpoint_url = https://service-cfg.com | ||
`, | ||
Expect: "https://service-env.com", | ||
}, | ||
|
||
"precedence 2: global env": { | ||
Env: map[string]string{ | ||
"AWS_ENDPOINT_URL": "https://global-env.com", | ||
}, | ||
SharedConfig: ` | ||
[default] | ||
endpoint_url = https://global-cfg.com | ||
services = service_cfg | ||
|
||
[services service_cfg] | ||
s3 = | ||
endpoint_url = https://service-cfg.com | ||
`, | ||
Expect: "https://global-env.com", | ||
}, | ||
|
||
"precedence 3: service cfg": { | ||
SharedConfig: ` | ||
[default] | ||
endpoint_url = https://global-cfg.com | ||
services = service_cfg | ||
|
||
[services service_cfg] | ||
s3 = | ||
endpoint_url = https://service-cfg.com | ||
`, | ||
Expect: "https://service-cfg.com", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. love the urls <3 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. excellent url naming |
||
}, | ||
|
||
"precedence 4: global cfg": { | ||
SharedConfig: ` | ||
[default] | ||
endpoint_url = https://global-cfg.com | ||
`, | ||
Expect: "https://global-cfg.com", | ||
}, | ||
} { | ||
t.Run(name, func(t *testing.T) { | ||
reset, err := mockEnvironment(tt.Env, tt.SharedConfig) | ||
if err != nil { | ||
t.Fatalf("mock environment: %v", err) | ||
} | ||
defer reset() | ||
|
||
loadopts := append(tt.LoadOpts, | ||
config.WithSharedConfigFiles([]string{"test_shared_config"})) | ||
cfg, err := config.LoadDefaultConfig(context.Background(), loadopts...) | ||
if err != nil { | ||
t.Fatalf("load config: %v", err) | ||
} | ||
|
||
svc := s3.NewFromConfig(cfg, tt.ClientOpts...) | ||
actual := aws.ToString(svc.Options().BaseEndpoint) | ||
if tt.Expect != actual { | ||
t.Errorf("expect endpoint: %q != %q", tt.Expect, actual) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func mockEnvironment(env map[string]string, sharedCfg string) (func(), error) { | ||
for k, v := range env { | ||
os.Setenv(k, v) | ||
} | ||
f, err := os.Create("test_shared_config") | ||
if err != nil { | ||
return nil, err | ||
} | ||
if _, err := f.Write([]byte(sharedCfg)); err != nil { | ||
return nil, err | ||
} | ||
|
||
return func() { | ||
for k := range env { | ||
os.Unsetenv(k) | ||
} | ||
if err := os.Remove("test_shared_config"); err != nil { | ||
panic(err) | ||
} | ||
}, nil | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this package being main is tripping the integ tests
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also 100% did not apply the integration test flag so that needs fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed