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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import socket
from tests import unittest
from mock import Mock, patch, sentinel
from botocore.compat import six
from botocore.awsrequest import AWSRequest
from botocore.endpoint import Endpoint, DEFAULT_TIMEOUT
from botocore.endpoint import EndpointCreator
from botocore.exceptions import EndpointConnectionError
from botocore.exceptions import ConnectionClosedError
from botocore.exceptions import HTTPClientError
from botocore.httpsession import URLLib3Session
from botocore.model import OperationModel, ServiceId
from botocore.model import ServiceModel, StructureShape
def request_dict(**kwargs):
base = {
'headers': {},
'body': '',
'url_path': '/',
'query_string': '',
'method': 'POST',
'url': 'https://example.com',
'context': {}
}
base.update(kwargs)
return base
class RecordStreamResets(six.StringIO):
def __init__(self, value):
six.StringIO.__init__(self, value)
self.total_resets = 0
def seek(self, where, whence=0):
self.total_resets += 1
six.StringIO.seek(self, where, whence)
class TestEndpointBase(unittest.TestCase):
def setUp(self):
self.op = Mock()
self.op.has_streaming_output = False
self.op.has_event_stream_output = False
self.op.metadata = {'protocol': 'json'}
self.event_emitter = Mock()
self.event_emitter.emit.return_value = []
self.factory_patch = patch(
'botocore.parsers.ResponseParserFactory')
self.factory = self.factory_patch.start()
self.endpoint = Endpoint(
'https://ec2.us-west-2.amazonaws.com/',
endpoint_prefix='ec2',
event_emitter=self.event_emitter)
self.http_session = Mock()
self.http_session.send.return_value = Mock(
status_code=200, headers={}, content=b'{"Foo": "bar"}',
)
self.endpoint.http_session = self.http_session
def tearDown(self):
self.factory_patch.stop()
def get_emitter_responses(self, num_retries=0, sleep_time=0):
emitter_responses = []
response_request_emitter_responses = [
[(None, None)], # emit() response for request-created
[(None, None)], # emit() response for before-send
[(None, None)], # emit() response for response-received
]
for _ in range(num_retries):
emitter_responses.extend(response_request_emitter_responses)
# emit() response for retry for sleep time
emitter_responses.append([(None, sleep_time)])
emitter_responses.extend(response_request_emitter_responses)
# emit() response for no retry
emitter_responses.append([(None, None)])
return emitter_responses
def get_events_emitted(self, event_emitter):
return [
call_arg[0][0] for call_arg in event_emitter.emit.call_args_list
]
class TestEndpointFeatures(TestEndpointBase):
def test_make_request_with_no_auth(self):
self.endpoint.auth = None
self.endpoint.make_request(self.op, request_dict())
# http_session should be used to send the request.
self.assertTrue(self.http_session.send.called)
prepared_request = self.http_session.send.call_args[0][0]
self.assertNotIn('Authorization', prepared_request.headers)
def test_make_request_no_signature_version(self):
self.endpoint.make_request(self.op, request_dict())
# http_session should be used to send the request.
self.assertTrue(self.http_session.send.called)
prepared_request = self.http_session.send.call_args[0][0]
self.assertNotIn('Authorization', prepared_request.headers)
def test_make_request_with_context(self):
r = request_dict()
r['context'] = {'signing': {'region': 'us-west-2'}}
with patch('botocore.endpoint.Endpoint.prepare_request') as prepare:
self.endpoint.make_request(self.op, r)
request = prepare.call_args[0][0]
self.assertEqual(request.context['signing']['region'], 'us-west-2')
def test_parses_modeled_exception_fields(self):
# Setup the service model to have exceptions to generate the mapping
self.service_model = Mock(spec=ServiceModel)
self.op.service_model = self.service_model
self.exception_shape = Mock(spec=StructureShape)
shape_for_error_code = self.service_model.shape_for_error_code
shape_for_error_code.return_value = self.exception_shape
r = request_dict()
self.http_session.send.return_value = Mock(
status_code=400, headers={}, content=b'',
)
parser = Mock()
parser.parse.side_effect = [
{
'Error': {
'Code': 'ExceptionShape',
'Message': 'Some message',
}
},
{'SomeField': 'Foo'},
]
self.factory.return_value.create_parser.return_value = parser
_, response = self.endpoint.make_request(self.op, r)
# The parser should be called twice, once for the original
# error parse and once again for the modeled exception parse
self.assertEqual(parser.parse.call_count, 2)
parse_calls = parser.parse.call_args_list
self.assertEqual(parse_calls[1][0][1], self.exception_shape)
self.assertEqual(parse_calls[0][0][1], self.op.output_shape)
expected_response = {
'Error': {
'Code': 'ExceptionShape',
'Message': 'Some message',
},
'SomeField': 'Foo',
}
self.assertEqual(response, expected_response)
class TestRetryInterface(TestEndpointBase):
def setUp(self):
super(TestRetryInterface, self).setUp()
self.retried_on_exception = None
self._operation = Mock(spec=OperationModel)
self._operation.name = 'DescribeInstances'
self._operation.metadata = {'protocol': 'query'}
self._operation.service_model.service_id = ServiceId('EC2')
self._operation.has_streaming_output = False
self._operation.has_event_stream_output = False
def assert_events_emitted(self, event_emitter, expected_events):
self.assertEqual(
self.get_events_emitted(event_emitter), expected_events)
def test_retry_events_are_emitted(self):
self.endpoint.make_request(self._operation, request_dict())
call_args = self.event_emitter.emit.call_args
self.assertEqual(call_args[0][0],
'needs-retry.ec2.DescribeInstances')
def test_retry_events_can_alter_behavior(self):
self.event_emitter.emit.side_effect = self.get_emitter_responses(
num_retries=1)
self.endpoint.make_request(self._operation, request_dict())
self.assert_events_emitted(
self.event_emitter,
expected_events=[
'request-created.ec2.DescribeInstances',
'before-send.ec2.DescribeInstances',
'response-received.ec2.DescribeInstances',
'needs-retry.ec2.DescribeInstances',
] * 2
)
def test_retry_on_socket_errors(self):
self.event_emitter.emit.side_effect = self.get_emitter_responses(
num_retries=1)
self.http_session.send.side_effect = HTTPClientError(error='wrapped')
with self.assertRaises(HTTPClientError):
self.endpoint.make_request(self._operation, request_dict())
self.assert_events_emitted(
self.event_emitter,
expected_events=[
'request-created.ec2.DescribeInstances',
'before-send.ec2.DescribeInstances',
'response-received.ec2.DescribeInstances',
'needs-retry.ec2.DescribeInstances',
] * 2
)
def test_retry_attempts_added_to_response_metadata(self):
self.event_emitter.emit.side_effect = self.get_emitter_responses(
num_retries=1)
parser = Mock()
parser.parse.return_value = {'ResponseMetadata': {}}
self.factory.return_value.create_parser.return_value = parser
response = self.endpoint.make_request(self._operation, request_dict())
self.assertEqual(response[1]['ResponseMetadata']['RetryAttempts'], 1)
def test_retry_attempts_is_zero_when_not_retried(self):
self.event_emitter.emit.side_effect = self.get_emitter_responses(
num_retries=0)
parser = Mock()
parser.parse.return_value = {'ResponseMetadata': {}}
self.factory.return_value.create_parser.return_value = parser
response = self.endpoint.make_request(self._operation, request_dict())
self.assertEqual(response[1]['ResponseMetadata']['RetryAttempts'], 0)
class TestS3ResetStreamOnRetry(TestEndpointBase):
def setUp(self):
super(TestS3ResetStreamOnRetry, self).setUp()
def max_attempts_retry_handler(self, attempts, **kwargs):
# Simulate a max requests of 3.
self.total_calls += 1
if attempts == 3:
return None
else:
# Returning anything non-None will trigger a retry,
# but 0 here is so that time.sleep(0) happens.
return 0
def test_reset_stream_on_retry(self):
op = Mock()
body = RecordStreamResets('foobar')
op.name = 'PutObject'
op.has_streaming_output = True
op.has_event_stream_output = False
op.metadata = {'protocol': 'rest-xml'}
request = request_dict()
request['body'] = body
self.event_emitter.emit.side_effect = self.get_emitter_responses(
num_retries=2
)
self.endpoint.make_request(op, request)
# 2 seeks for the resets and 6 (2 per creation) for content-length
self.assertEqual(body.total_resets, 8)
class TestEventStreamBody(TestEndpointBase):
def test_event_stream_body_is_streaming(self):
self.op.has_event_stream_output = True
request = request_dict()
self.endpoint.make_request(self.op, request)
sent_request = self.http_session.send.call_args[0][0]
self.assertTrue(sent_request.stream_output)
class TestEndpointCreator(unittest.TestCase):
def setUp(self):
self.service_model = Mock(
endpoint_prefix='ec2', signature_version='v2',
signing_name='ec2')
self.environ = {}
self.environ_patch = patch('os.environ', self.environ)
self.environ_patch.start()
self.creator = EndpointCreator(Mock())
self.mock_session = Mock(spec=URLLib3Session)
def tearDown(self):
self.environ_patch.stop()
def test_creates_endpoint_with_configured_url(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-east-1',
endpoint_url='https://endpoint.url')
self.assertEqual(endpoint.host, 'https://endpoint.url')
def test_create_endpoint_with_default_timeout(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com',
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('timeout'), DEFAULT_TIMEOUT)
def test_create_endpoint_with_customized_timeout(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com', timeout=123,
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('timeout'), 123)
def test_get_endpoint_default_verify_ssl(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com',
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertTrue(session_args.get('verify'))
def test_verify_ssl_can_be_disabled(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com', verify=False,
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertFalse(session_args.get('verify'))
def test_verify_ssl_can_specify_cert_bundle(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com', verify='/path/cacerts.pem',
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('verify'), '/path/cacerts.pem')
def test_client_cert_can_specify_path(self):
client_cert = '/some/path/cert'
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com', client_cert=client_cert,
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('client_cert'), '/some/path/cert')
def test_honor_cert_bundle_env_var(self):
self.environ['REQUESTS_CA_BUNDLE'] = '/env/cacerts.pem'
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com',
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('verify'), '/env/cacerts.pem')
def test_env_ignored_if_explicitly_passed(self):
self.environ['REQUESTS_CA_BUNDLE'] = '/env/cacerts.pem'
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com', verify='/path/cacerts.pem',
http_session_cls=self.mock_session)
session_args = self.mock_session.call_args[1]
# /path/cacerts.pem wins over the value from the env var.
self.assertEqual(session_args.get('verify'), '/path/cacerts.pem')
def test_can_specify_max_pool_conns(self):
endpoint = self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com',
max_pool_connections=100,
http_session_cls=self.mock_session,
)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('max_pool_connections'), 100)
def test_socket_options(self):
socket_options = [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)]
self.creator.create_endpoint(
self.service_model, region_name='us-west-2',
endpoint_url='https://example.com',
http_session_cls=self.mock_session, socket_options=socket_options)
session_args = self.mock_session.call_args[1]
self.assertEqual(session_args.get('socket_options'), socket_options)
|
