File: middleware_test.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie, trixie-backports, trixie-proposed-updates
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (255 lines) | stat: -rw-r--r-- 6,870 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
package middleware_test

import (
	"context"
	"fmt"
	"net/http"
	"sync/atomic"
	"testing"
	"time"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/aws/retry"

	"github.com/aws/aws-sdk-go-v2/aws/middleware"
	internalcontext "github.com/aws/aws-sdk-go-v2/internal/context"
	internalmiddleware "github.com/aws/aws-sdk-go-v2/internal/middleware"
	"github.com/aws/aws-sdk-go-v2/internal/sdk"
	smithymiddleware "github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

type httpClient interface {
	Do(*http.Request) (*http.Response, error)
}

type options struct {
	HTTPClient httpClient
	RetryMode  aws.RetryMode
	Retryer    aws.Retryer
	Offset     *atomic.Int64
}

type MockClient struct {
	options options
}

func addRetry(stack *smithymiddleware.Stack, o options) error {
	attempt := retry.NewAttemptMiddleware(o.Retryer, smithyhttp.RequestCloner, func(m *retry.Attempt) {
		m.LogAttempts = false
	})
	return stack.Finalize.Add(attempt, smithymiddleware.After)
}

func addOffset(stack *smithymiddleware.Stack, o options) error {
	offsetMiddleware := internalmiddleware.AddTimeOffsetMiddleware{Offset: o.Offset}
	err := stack.Build.Add(&offsetMiddleware, smithymiddleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&offsetMiddleware, smithymiddleware.Before)
	if err != nil {
		return err
	}
	return nil
}

// Middleware to set a `Date` object that includes sdk time and offset
type MockAddDateHeader struct {
}

func (l *MockAddDateHeader) ID() string {
	return "MockAddDateHeader"
}

func (l *MockAddDateHeader) HandleFinalize(
	ctx context.Context, in smithymiddleware.FinalizeInput, next smithymiddleware.FinalizeHandler,
) (
	out smithymiddleware.FinalizeOutput, metadata smithymiddleware.Metadata, attemptError error,
) {
	req := in.Request.(*smithyhttp.Request)
	date := sdk.NowTime()
	skew := internalcontext.GetAttemptSkewContext(ctx)
	date = date.Add(skew)
	req.Header.Set("Date", date.Format(time.RFC850))
	return next.HandleFinalize(ctx, in)
}

// Middleware to deserialize the response which just says "OK" if the response is 200
type DeserializeFailIfNotHTTP200 struct {
}

func (*DeserializeFailIfNotHTTP200) ID() string {
	return "DeserializeFailIfNotHTTP200"
}

func (m *DeserializeFailIfNotHTTP200) HandleDeserialize(ctx context.Context, in smithymiddleware.DeserializeInput, next smithymiddleware.DeserializeHandler) (
	out smithymiddleware.DeserializeOutput, metadata smithymiddleware.Metadata, err error,
) {
	out, metadata, err = next.HandleDeserialize(ctx, in)
	if err != nil {
		return out, metadata, err
	}
	response, ok := out.RawResponse.(*smithyhttp.Response)
	if !ok {
		return out, metadata, fmt.Errorf("expected raw response to be set on testing")
	}
	if response.StatusCode != 200 {
		return out, metadata, mockRetryableError{true}
	}
	return out, metadata, err
}

func (c *MockClient) setupMiddleware(stack *smithymiddleware.Stack) error {
	err := error(nil)
	if c.options.Retryer != nil {
		err = addRetry(stack, c.options)
		if err != nil {
			return err
		}
	}
	if c.options.Offset != nil {
		err = addOffset(stack, c.options)
		if err != nil {
			return err
		}
	}
	err = stack.Finalize.Add(&MockAddDateHeader{}, smithymiddleware.After)
	if err != nil {
		return err
	}
	err = middleware.AddRecordResponseTiming(stack)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&DeserializeFailIfNotHTTP200{}, smithymiddleware.After)
	if err != nil {
		return err
	}
	return nil
}

func (c *MockClient) Do(ctx context.Context) (interface{}, error) {
	// setup middlewares
	ctx = smithymiddleware.ClearStackValues(ctx)
	stack := smithymiddleware.NewStack("stack", smithyhttp.NewStackRequest)
	err := c.setupMiddleware(stack)
	if err != nil {
		return nil, err
	}
	handler := smithymiddleware.DecorateHandler(smithyhttp.NewClientHandler(c.options.HTTPClient), stack)
	result, _, err := handler.Handle(ctx, 1)
	if err != nil {
		return nil, err
	}
	return result, err
}

type mockRetryableError struct{ b bool }

func (m mockRetryableError) RetryableError() bool { return m.b }
func (m mockRetryableError) Error() string {
	return fmt.Sprintf("mock retryable %t", m.b)
}

func failRequestIfSkewed() smithyhttp.ClientDoFunc {
	return func(req *http.Request) (*http.Response, error) {
		dateHeader := req.Header.Get("Date")
		if dateHeader == "" {
			return nil, fmt.Errorf("expected `Date` header to be set")
		}
		reqDate, err := time.Parse(time.RFC850, dateHeader)
		if err != nil {
			return nil, err
		}
		parsedReqTime := time.Now().Sub(reqDate)
		parsedReqTime = time.Duration.Abs(parsedReqTime)
		thresholdForSkewError := 4 * time.Minute
		if thresholdForSkewError-parsedReqTime <= 0 {
			return &http.Response{
				StatusCode: 403,
				Header: http.Header{
					"Date": {time.Now().Format(time.RFC850)},
				},
			}, nil
		}
		// else, return OK
		return &http.Response{
			StatusCode: 200,
			Header:     http.Header{},
		}, nil
	}
}

func TestSdkOffsetIsSet(t *testing.T) {
	nowTime := sdk.NowTime
	defer func() {
		sdk.NowTime = nowTime
	}()
	fiveMinuteSkew := func() time.Time {
		return time.Now().Add(5 * time.Minute)
	}
	sdk.NowTime = fiveMinuteSkew
	c := MockClient{
		options{
			HTTPClient: failRequestIfSkewed(),
		},
	}
	resp, err := c.Do(context.Background())
	if err == nil {
		t.Errorf("Expected first request to fail since clock skew logic has not run. Got %v and err %v", resp, err)
	}
}

func TestRetrySetsSkewInContext(t *testing.T) {
	defer resetDefaults(sdk.TestingUseNopSleep())
	fiveMinuteSkew := func() time.Time {
		return time.Now().Add(5 * time.Minute)
	}
	sdk.NowTime = fiveMinuteSkew
	c := MockClient{
		options{
			HTTPClient: failRequestIfSkewed(),
			Retryer: retry.NewStandard(func(s *retry.StandardOptions) {
			}),
		},
	}
	resp, err := c.Do(context.Background())
	if err != nil {
		t.Errorf("Expected request to succeed on retry. Got %v and err %v", resp, err)
	}
}

func TestSkewIsSetOnTheWholeClient(t *testing.T) {
	defer resetDefaults(sdk.TestingUseNopSleep())
	fiveMinuteSkew := func() time.Time {
		return time.Now().Add(5 * time.Minute)
	}
	sdk.NowTime = fiveMinuteSkew
	var offset atomic.Int64
	offset.Store(0)
	c := MockClient{
		options{
			HTTPClient: failRequestIfSkewed(),
			Retryer: retry.NewStandard(func(s *retry.StandardOptions) {
			}),
			Offset: &offset,
		},
	}
	resp, err := c.Do(context.Background())
	if err != nil {
		t.Errorf("Expected request to succeed on retry. Got %v and err %v", resp, err)
	}
	// Remove retryer so it has to succeed on first call
	c.options.Retryer = nil
	// same client, new request
	resp, err = c.Do(context.Background())
	if err != nil {
		t.Errorf("Expected second request to succeed since the skew should be set on the client. Got %v and err %v", resp, err)
	}
}

func resetDefaults(restoreSleepFunc func()) {
	sdk.NowTime = time.Now
	restoreSleepFunc()
}