-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
client_stubs.rb
310 lines (292 loc) · 10.8 KB
/
client_stubs.rb
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
require 'thread'
module Aws
# This module provides the ability to specify the data and/or errors to
# return when a client is using stubbed responses. Pass
# `:stub_responses => true` to a client constructor to enable this
# behavior.
#
# Also allows you to see the requests made by the client by reading the
# api_requests instance variable
module ClientStubs
# @api private
def setup_stubbing
@stubs = {}
@stub_mutex = Mutex.new
if Hash === @config.stub_responses
@config.stub_responses.each do |operation_name, stubs|
apply_stubs(operation_name, Array === stubs ? stubs : [stubs])
end
end
# When a client is stubbed allow the user to access the requests made
@api_requests = []
requests = @api_requests
self.handle do |context|
requests << {
operation_name: context.operation_name,
params: context.params,
context: context
}
@handler.call(context)
end
end
# Configures what data / errors should be returned from the named operation
# when response stubbing is enabled.
#
# ## Basic usage
#
# When you enable response stubbing, the client will generate fake
# responses and will not make any HTTP requests.
#
# client = Aws::S3::Client.new(stub_responses: true)
# client.list_buckets
# #=> #<struct Aws::S3::Types::ListBucketsOutput buckets=[], owner=nil>
#
# You can provide stub data that will be returned by the client.
#
# # stub data in the constructor
# client = Aws::S3::Client.new(stub_responses: {
# list_buckets: { buckets: [{name: 'my-bucket' }] },
# get_object: { body: 'data' },
# })
#
# client.list_buckets.buckets.map(&:name) #=> ['my-bucket']
# client.get_object(bucket:'name', key:'key').body.read #=> 'data'
#
# You can also specify the stub data using {#stub_responses}
#
# client = Aws::S3::Client.new(stub_responses: true)
# client.stub_responses(:list_buckets, {
# buckets: [{ name: 'my-bucket' }]
# })
#
# client.list_buckets.buckets.map(&:name)
# #=> ['my-bucket']
#
# With a Resource class {#stub_responses} on the corresponding client:
#
# s3 = Aws::S3::Resource.new(stub_responses: true)
# s3.client.stub_responses(:list_buckets, {
# buckets: [{ name: 'my-bucket' }]
# })
#
# s3.buckets.map(&:name)
# #=> ['my-bucket']
#
# Lastly, default stubs can be configured via `Aws.config`:
#
# Aws.config[:s3] = {
# stub_responses: {
# list_buckets: { buckets: [{name: 'my-bucket' }] }
# }
# }
#
# Aws::S3::Client.new.list_buckets.buckets.map(&:name)
# #=> ['my-bucket']
#
# Aws::S3::Resource.new.buckets.map(&:name)
# #=> ['my-bucket']
#
# ## Dynamic Stubbing
#
# In addition to creating static stubs, it's also possible to generate
# stubs dynamically based on the parameters with which operations were
# called, by passing a `Proc` object:
#
# s3 = Aws::S3::Resource.new(stub_responses: true)
# s3.client.stub_responses(:put_object, -> (context) {
# s3.client.stub_responses(:get_object, content_type: context.params[:content_type])
# })
#
# The yielded object is an instance of {Seahorse::Client::RequestContext}.
#
# ## Stubbing Errors
#
# When stubbing is enabled, the SDK will default to generate
# fake responses with placeholder values. You can override the data
# returned. You can also specify errors it should raise.
#
# # simulate service errors, give the error code
# client.stub_responses(:get_object, 'NotFound')
# client.get_object(bucket:'aws-sdk', key:'foo')
# #=> raises Aws::S3::Errors::NotFound
#
# # to simulate other errors, give the error class, you must
# # be able to construct an instance with `.new`
# client.stub_responses(:get_object, Timeout::Error)
# client.get_object(bucket:'aws-sdk', key:'foo')
# #=> raises new Timeout::Error
#
# # or you can give an instance of an error class
# client.stub_responses(:get_object, RuntimeError.new('custom message'))
# client.get_object(bucket:'aws-sdk', key:'foo')
# #=> raises the given runtime error object
#
# ## Stubbing HTTP Responses
#
# As an alternative to providing the response data, you can provide
# an HTTP response.
#
# client.stub_responses(:get_object, {
# status_code: 200,
# headers: { 'header-name' => 'header-value' },
# body: "...",
# })
#
# To stub a HTTP response, pass a Hash with all three of the following
# keys set:
#
# * **`:status_code`** - <Integer> - The HTTP status code
# * **`:headers`** - Hash<String,String> - A hash of HTTP header keys and values
# * **`:body`** - <String,IO> - The HTTP response body.
#
# ## Stubbing Multiple Responses
#
# Calling an operation multiple times will return similar responses.
# You can configure multiple stubs and they will be returned in sequence.
#
# client.stub_responses(:head_object, [
# 'NotFound',
# { content_length: 150 },
# ])
#
# client.head_object(bucket:'aws-sdk', key:'foo')
# #=> raises Aws::S3::Errors::NotFound
#
# resp = client.head_object(bucket:'aws-sdk', key:'foo')
# resp.content_length #=> 150
#
# @param [Symbol] operation_name
#
# @param [Mixed] stubs One or more responses to return from the named
# operation.
#
# @return [void]
#
# @raise [RuntimeError] Raises a runtime error when called
# on a client that has not enabled response stubbing via
# `:stub_responses => true`.
#
def stub_responses(operation_name, *stubs)
if config.stub_responses
apply_stubs(operation_name, stubs.flatten)
else
msg = 'stubbing is not enabled; enable stubbing in the constructor '
msg << 'with `:stub_responses => true`'
raise msg
end
end
# Allows you to access all of the requests that the stubbed client has made
#
# @params [Boolean] exclude_presign Setting to true for filtering out not sent requests from
# generating presigned urls. Default to false.
# @return [Array] Returns an array of the api requests made, each request object contains the
# :operation_name, :params, and :context of the request.
# @raise [NotImplementedError] Raises `NotImplementedError` when the client is not stubbed
def api_requests(options = {})
if config.stub_responses
if options[:exclude_presign]
@api_requests.reject {|req| req[:context][:presigned_url] }
else
@api_requests
end
else
msg = 'This method is only implemented for stubbed clients, and is '
msg << 'available when you enable stubbing in the constructor with `stub_responses: true`'
raise NotImplementedError.new(msg)
end
end
# Generates and returns stubbed response data from the named operation.
#
# s3 = Aws::S3::Client.new
# s3.stub_data(:list_buckets)
# #=> #<struct Aws::S3::Types::ListBucketsOutput buckets=[], owner=#<struct Aws::S3::Types::Owner display_name="DisplayName", id="ID">>
#
# In addition to generating default stubs, you can provide data to
# apply to the response stub.
#
# s3.stub_data(:list_buckets, buckets:[{name:'aws-sdk'}])
# #=> #<struct Aws::S3::Types::ListBucketsOutput
# buckets=[#<struct Aws::S3::Types::Bucket name="aws-sdk", creation_date=nil>],
# owner=#<struct Aws::S3::Types::Owner display_name="DisplayName", id="ID">>
#
# @param [Symbol] operation_name
# @param [Hash] data
# @return [Structure] Returns a stubbed response data structure. The
# actual class returned will depend on the given `operation_name`.
def stub_data(operation_name, data = {})
Stubbing::StubData.new(config.api.operation(operation_name)).stub(data)
end
# @api private
def next_stub(context)
operation_name = context.operation_name.to_sym
stub = @stub_mutex.synchronize do
stubs = @stubs[operation_name] || []
case stubs.length
when 0 then default_stub(operation_name)
when 1 then stubs.first
else stubs.shift
end
end
Proc === stub ? convert_stub(operation_name, stub.call(context)) : stub
end
private
def default_stub(operation_name)
stub = stub_data(operation_name)
http_response_stub(operation_name, stub)
end
# This method converts the given stub data and converts it to a
# HTTP response (when possible). This enables the response stubbing
# plugin to provide a HTTP response that triggers all normal events
# during response handling.
def apply_stubs(operation_name, stubs)
@stub_mutex.synchronize do
@stubs[operation_name.to_sym] = stubs.map do |stub|
convert_stub(operation_name, stub)
end
end
end
def convert_stub(operation_name, stub)
case stub
when Proc then stub
when Exception, Class then { error: stub }
when String then service_error_stub(stub)
when Hash then http_response_stub(operation_name, stub)
else { data: stub }
end
end
def service_error_stub(error_code)
{ http: protocol_helper.stub_error(error_code) }
end
def http_response_stub(operation_name, data)
if Hash === data && data.keys.sort == [:body, :headers, :status_code]
{ http: hash_to_http_resp(data) }
else
{ http: data_to_http_resp(operation_name, data) }
end
end
def hash_to_http_resp(data)
http_resp = Seahorse::Client::Http::Response.new
http_resp.status_code = data[:status_code]
http_resp.headers.update(data[:headers])
http_resp.body = data[:body]
http_resp
end
def data_to_http_resp(operation_name, data)
api = config.api
operation = api.operation(operation_name)
ParamValidator.new(operation.output, input: false).validate!(data)
protocol_helper.stub_data(api, operation, data)
end
def protocol_helper
case config.api.metadata['protocol']
when 'json' then Stubbing::Protocols::Json
when 'query' then Stubbing::Protocols::Query
when 'ec2' then Stubbing::Protocols::EC2
when 'rest-json' then Stubbing::Protocols::RestJson
when 'rest-xml' then Stubbing::Protocols::RestXml
when 'api-gateway' then Stubbing::Protocols::ApiGateway
else raise "unsupported protocol"
end.new
end
end
end