@@ -8,17 +8,23 @@ import (
88 "testing"
99
1010 "github.com/aws/aws-sdk-go-v2/service/ec2"
11+ elb "github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing"
12+ elbv2 "github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2"
13+
1114 "github.com/stretchr/testify/assert"
1215 "k8s.io/cloud-provider-aws/pkg/providers/v1/config"
1316)
1417
1518// Given an override, a custom endpoint should be used when making API requests
16- func TestComputeEndpointOverride (t * testing.T ) {
19+ func TestClientsEndpointOverride (t * testing.T ) {
1720 usedCustomEndpoint := false
21+ // Dummy server that sets usedCustomEndpoint when called
1822 testServer := httptest .NewServer (http .HandlerFunc (func (w http.ResponseWriter , r * http.Request ) {
1923 usedCustomEndpoint = true
2024 }))
2125
26+ // Pass in the test server URL through a CloudConfig, which is used by each client's custom endpoint
27+ // resolver to override the URL for a request (see EC2Resolver.ResolveEndpoint for an example)
2228 cfgWithServiceOverride := config.CloudConfig {
2329 ServiceOverride : map [string ]* struct {
2430 Service string
@@ -29,7 +35,21 @@ func TestComputeEndpointOverride(t *testing.T) {
2935 SigningName string
3036 }{
3137 "1" : {
32- Service : "EC2" ,
38+ Service : ec2 .ServiceID ,
39+ Region : "us-west-2" ,
40+ URL : testServer .URL ,
41+ SigningRegion : "signingRegion" ,
42+ SigningName : "signingName" ,
43+ },
44+ "2" : {
45+ Service : elb .ServiceID ,
46+ Region : "us-west-2" ,
47+ URL : testServer .URL ,
48+ SigningRegion : "signingRegion" ,
49+ SigningName : "signingName" ,
50+ },
51+ "3" : {
52+ Service : elbv2 .ServiceID ,
3353 Region : "us-west-2" ,
3454 URL : testServer .URL ,
3555 SigningRegion : "signingRegion" ,
@@ -42,17 +62,35 @@ func TestComputeEndpointOverride(t *testing.T) {
4262 regionDelayers : make (map [string ]* CrossRequestRetryDelay ),
4363 }
4464
65+ // EC2 Client
4566 ec2Client , err := mockProvider .Compute (context .TODO (), "us-west-2" , nil )
4667 if err != nil {
4768 t .Errorf ("error creating client, %v" , err )
4869 }
4970 _ , err = ec2Client .DescribeInstances (context .TODO (), & ec2.DescribeInstancesInput {})
5071 assert .True (t , usedCustomEndpoint == true , "custom endpoint was not used for EC2 Client" )
72+
73+ usedCustomEndpoint = false // reset boolean flag for next request
74+ elbClient , err := mockProvider .LoadBalancing (context .TODO (), "us-west-2" , nil )
75+ if err != nil {
76+ t .Errorf ("error creating client, %v" , err )
77+ }
78+ _ , err = elbClient .DescribeLoadBalancers (context .TODO (), & elb.DescribeLoadBalancersInput {})
79+ assert .True (t , usedCustomEndpoint == true , "custom endpoint was not used for ELB Client" )
80+
81+ usedCustomEndpoint = false
82+ elbv2Client , err := mockProvider .LoadBalancingV2 (context .TODO (), "us-west-2" , nil )
83+ if err != nil {
84+ t .Errorf ("error creating client, %v" , err )
85+ }
86+ _ , err = elbv2Client .DescribeLoadBalancers (context .TODO (), & elbv2.DescribeLoadBalancersInput {})
87+ assert .True (t , usedCustomEndpoint == true , "custom endpoint was not used for ELBV2 Client" )
5188}
5289
53- // When a nonRetryableError is thrown, an API request should not be retried
54- func TestComputeNoRetry (t * testing.T ) {
90+ // Test whether SDK clients refrain from retrying an API request when given a nonRetryableError.
91+ func TestClientsNoRetry (t * testing.T ) {
5592 attemptCount := 0
93+ // Dummy server that counts attempts and returns a nonRetryableError
5694 testServer := httptest .NewServer (http .HandlerFunc (func (w http.ResponseWriter , r * http.Request ) {
5795 attemptCount ++
5896 w .Header ().Set ("Content-Type" , "text/xml" )
@@ -74,6 +112,7 @@ func TestComputeNoRetry(t *testing.T) {
74112 }))
75113 defer testServer .Close ()
76114
115+ // Override service endpoints with dummy server URL
77116 cfgWithServiceOverride := config.CloudConfig {
78117 ServiceOverride : map [string ]* struct {
79118 Service string
@@ -84,7 +123,21 @@ func TestComputeNoRetry(t *testing.T) {
84123 SigningName string
85124 }{
86125 "1" : {
87- Service : "EC2" ,
126+ Service : ec2 .ServiceID ,
127+ Region : "us-west-2" ,
128+ URL : testServer .URL ,
129+ SigningRegion : "signingRegion" ,
130+ SigningName : "signingName" ,
131+ },
132+ "2" : {
133+ Service : elb .ServiceID ,
134+ Region : "us-west-2" ,
135+ URL : testServer .URL ,
136+ SigningRegion : "signingRegion" ,
137+ SigningName : "signingName" ,
138+ },
139+ "3" : {
140+ Service : elbv2 .ServiceID ,
88141 Region : "us-west-2" ,
89142 URL : testServer .URL ,
90143 SigningRegion : "signingRegion" ,
@@ -97,23 +150,45 @@ func TestComputeNoRetry(t *testing.T) {
97150 regionDelayers : make (map [string ]* CrossRequestRetryDelay ),
98151 }
99152
153+ // EC2 Client
100154 ec2Client , err := mockProvider .Compute (context .TODO (), "us-west-2" , nil )
101155 if err != nil {
102156 t .Errorf ("error creating client, %v" , err )
103157 }
104158 _ , err = ec2Client .DescribeInstances (context .TODO (), & ec2.DescribeInstancesInput {})
105- assert .True (t , attemptCount == 1 , fmt .Sprintf ("expected an attempt count of 1, got %d" , attemptCount ))
159+ // Ensure that only 1 attempt was made, signifying no retries
160+ assert .True (t , attemptCount == 1 , fmt .Sprintf ("expected an attempt count of 1 for EC2 client, got %d" , attemptCount ))
161+
162+ // ELB Client
163+ attemptCount = 0 // reset attempt count for next request
164+ elbClient , err := mockProvider .LoadBalancing (context .TODO (), "us-west-2" , nil )
165+ if err != nil {
166+ t .Errorf ("error creating client, %v" , err )
167+ }
168+ _ , err = elbClient .DescribeLoadBalancers (context .TODO (), & elb.DescribeLoadBalancersInput {})
169+ assert .True (t , attemptCount == 1 , fmt .Sprintf ("expected an attempt count of 1 for ELB client, got %d" , attemptCount ))
170+
171+ // ELBV2 Client
172+ attemptCount = 0
173+ elbv2Client , err := mockProvider .LoadBalancingV2 (context .TODO (), "us-west-2" , nil )
174+ if err != nil {
175+ t .Errorf ("error creating client, %v" , err )
176+ }
177+ _ , err = elbv2Client .DescribeLoadBalancers (context .TODO (), & elbv2.DescribeLoadBalancersInput {})
178+ assert .True (t , attemptCount == 1 , fmt .Sprintf ("expected an attempt count of 1 for ELBV2 client, got %d" , attemptCount ))
106179}
107180
108- // When a retryable error is thrown, an API request should be retried
109- func TestComputeWithRetry (t * testing.T ) {
181+ // Test whether SDK clients retry an API request when given a retryable error code.
182+ func TestClientsWithRetry (t * testing.T ) {
110183 attemptCount := 0
184+ // Dummy server that counts attempts and returns a retryable error
111185 testServer := httptest .NewServer (http .HandlerFunc (func (w http.ResponseWriter , r * http.Request ) {
112186 attemptCount ++
113187 // 500 status codes are retried by SDK (see https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws/retry)
114188 http .Error (w , "RequestTimeout" , 500 )
115189 }))
116190
191+ // Override service endpoints with dummy server URL
117192 cfgWithServiceOverride := config.CloudConfig {
118193 ServiceOverride : map [string ]* struct {
119194 Service string
@@ -124,7 +199,21 @@ func TestComputeWithRetry(t *testing.T) {
124199 SigningName string
125200 }{
126201 "1" : {
127- Service : "EC2" ,
202+ Service : ec2 .ServiceID ,
203+ Region : "us-west-2" ,
204+ URL : testServer .URL ,
205+ SigningRegion : "signingRegion" ,
206+ SigningName : "signingName" ,
207+ },
208+ "2" : {
209+ Service : elb .ServiceID ,
210+ Region : "us-west-2" ,
211+ URL : testServer .URL ,
212+ SigningRegion : "signingRegion" ,
213+ SigningName : "signingName" ,
214+ },
215+ "3" : {
216+ Service : elbv2 .ServiceID ,
128217 Region : "us-west-2" ,
129218 URL : testServer .URL ,
130219 SigningRegion : "signingRegion" ,
@@ -137,10 +226,30 @@ func TestComputeWithRetry(t *testing.T) {
137226 regionDelayers : make (map [string ]* CrossRequestRetryDelay ),
138227 }
139228
229+ // EC2 Client
140230 ec2Client , err := mockProvider .Compute (context .TODO (), "us-west-2" , nil )
141231 if err != nil {
142232 t .Errorf ("error creating client, %v" , err )
143233 }
144234 _ , err = ec2Client .DescribeInstances (context .TODO (), & ec2.DescribeInstancesInput {})
145- assert .True (t , attemptCount > 1 , fmt .Sprintf ("expected an attempt count >1, got %d" , attemptCount ))
235+ // Ensure that more than 1 attempt was made, signifying retries
236+ assert .True (t , attemptCount > 1 , fmt .Sprintf ("expected an attempt count of >1 for EC2 client, got %d" , attemptCount ))
237+
238+ // ELB Client
239+ attemptCount = 0 // Reset the attempt count before the next request
240+ elbClient , err := mockProvider .LoadBalancing (context .TODO (), "us-west-2" , nil )
241+ if err != nil {
242+ t .Errorf ("error creating client, %v" , err )
243+ }
244+ _ , err = elbClient .DescribeLoadBalancers (context .TODO (), & elb.DescribeLoadBalancersInput {})
245+ assert .True (t , attemptCount > 1 , fmt .Sprintf ("expected an attempt count of >1 for ELB client, got %d" , attemptCount ))
246+
247+ // ELBV2 Client
248+ attemptCount = 0
249+ elbv2Client , err := mockProvider .LoadBalancingV2 (context .TODO (), "us-west-2" , nil )
250+ if err != nil {
251+ t .Errorf ("error creating client, %v" , err )
252+ }
253+ _ , err = elbv2Client .DescribeLoadBalancers (context .TODO (), & elbv2.DescribeLoadBalancersInput {})
254+ assert .True (t , attemptCount > 1 , fmt .Sprintf ("expected an attempt count of >1 for ELB client, got %d" , attemptCount ))
146255}
0 commit comments