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
|
#!/usr/bin/env
# Copyright 2016 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
import botocore.config
from tests import unittest
import mock
from botocore import args
from botocore import exceptions
from botocore.client import ClientEndpointBridge
from botocore.config import Config
from botocore.configprovider import ConfigValueStore
from botocore.hooks import HierarchicalEmitter
from botocore.model import ServiceModel
class TestCreateClientArgs(unittest.TestCase):
def setUp(self):
self.event_emitter = mock.Mock(HierarchicalEmitter)
self.config_store = ConfigValueStore()
self.args_create = args.ClientArgsCreator(
self.event_emitter, None, None, None, None, self.config_store)
self.service_name = 'ec2'
self.region = 'us-west-2'
self.endpoint_url = 'https://ec2/'
self.service_model = self._get_service_model()
self.bridge = mock.Mock(ClientEndpointBridge)
self._set_endpoint_bridge_resolve()
self.default_socket_options = [
(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
]
def _get_service_model(self, service_name=None):
if service_name is None:
service_name = self.service_name
service_model = mock.Mock(ServiceModel)
service_model.service_name = service_name
service_model.endpoint_prefix = service_name
service_model.metadata = {
'serviceFullName': 'MyService',
'protocol': 'query'
}
service_model.operation_names = []
return service_model
def _set_endpoint_bridge_resolve(self, **override_kwargs):
ret_val = {
'region_name': self.region,
'signature_version': 'v4',
'endpoint_url': self.endpoint_url,
'signing_name': self.service_name,
'signing_region': self.region,
'metadata': {}
}
ret_val.update(**override_kwargs)
self.bridge.resolve.return_value = ret_val
def call_get_client_args(self, **override_kwargs):
call_kwargs = {
'service_model': self.service_model,
'region_name': self.region,
'is_secure': True,
'endpoint_url': self.endpoint_url,
'verify': True,
'credentials': None,
'scoped_config': {},
'client_config': None,
'endpoint_bridge': self.bridge
}
call_kwargs.update(**override_kwargs)
return self.args_create.get_client_args(**call_kwargs)
def assert_create_endpoint_call(self, mock_endpoint, **override_kwargs):
call_kwargs = {
'endpoint_url': self.endpoint_url,
'region_name': self.region,
'response_parser_factory': None,
'timeout': (60, 60),
'verify': True,
'max_pool_connections': 10,
'proxies': None,
'proxies_config': None,
'socket_options': self.default_socket_options,
'client_cert': None,
}
call_kwargs.update(**override_kwargs)
mock_endpoint.return_value.create_endpoint.assert_called_with(
self.service_model, **call_kwargs
)
def test_compute_s3_configuration(self):
self.assertIsNone(self.args_create.compute_s3_config(None))
def test_compute_s3_config_only_config_store(self):
self.config_store.set_config_variable(
's3', {'use_accelerate_endpoint': True})
self.assertEqual(
self.args_create.compute_s3_config(None),
{'use_accelerate_endpoint': True}
)
def test_client_s3_accelerate_from_client_config(self):
self.assertEqual(
self.args_create.compute_s3_config(
client_config=Config(s3={'use_accelerate_endpoint': True})
),
{'use_accelerate_endpoint': True}
)
def test_client_s3_accelerate_client_config_overrides_config_store(self):
self.config_store.set_config_variable(
's3', {'use_accelerate_endpoint': False})
self.assertEqual(
self.args_create.compute_s3_config(
client_config=Config(s3={'use_accelerate_endpoint': True})
),
# client_config beats scoped_config
{'use_accelerate_endpoint': True}
)
def test_max_pool_from_client_config_forwarded_to_endpoint_creator(self):
config = botocore.config.Config(max_pool_connections=20)
with mock.patch('botocore.args.EndpointCreator') as m:
self.call_get_client_args(client_config=config)
self.assert_create_endpoint_call(m, max_pool_connections=20)
def test_proxies_from_client_config_forwarded_to_endpoint_creator(self):
proxies = {'http': 'http://foo.bar:1234',
'https': 'https://foo.bar:4321'}
config = botocore.config.Config(proxies=proxies)
with mock.patch('botocore.args.EndpointCreator') as m:
self.call_get_client_args(client_config=config)
self.assert_create_endpoint_call(m, proxies=proxies)
def test_s3_with_endpoint_url_still_resolves_region(self):
self.service_model.endpoint_prefix = 's3'
self.service_model.metadata = {'protocol': 'rest-xml'}
self.bridge.resolve.side_effect = [
{
'region_name': None, 'signature_version': 's3v4',
'endpoint_url': 'http://other.com/', 'signing_name': 's3',
'signing_region': None, 'metadata': {}
},
{
'region_name': 'us-west-2', 'signature_version': 's3v4',
'enpoint_url': 'https://s3-us-west-2.amazonaws.com',
'signing_name': 's3', 'signing_region': 'us-west-2',
'metadata': {}
}
]
client_args = self.call_get_client_args(
endpoint_url='http://other.com/')
self.assertEqual(
client_args['client_config'].region_name, 'us-west-2')
def test_region_does_not_resolve_if_not_s3_and_endpoint_url_provided(self):
self.service_model.endpoint_prefix = 'ec2'
self.service_model.metadata = {'protocol': 'query'}
self.bridge.resolve.side_effect = [{
'region_name': None, 'signature_version': 'v4',
'endpoint_url': 'http://other.com/', 'signing_name': 'ec2',
'signing_region': None, 'metadata': {}
}]
client_args = self.call_get_client_args(
endpoint_url='http://other.com/')
self.assertEqual(client_args['client_config'].region_name, None)
def test_tcp_keepalive_enabled(self):
scoped_config = {'tcp_keepalive': 'true'}
with mock.patch('botocore.args.EndpointCreator') as m:
self.call_get_client_args(scoped_config=scoped_config)
self.assert_create_endpoint_call(
m, socket_options=self.default_socket_options + [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
]
)
def test_tcp_keepalive_not_specified(self):
scoped_config = {}
with mock.patch('botocore.args.EndpointCreator') as m:
self.call_get_client_args(scoped_config=scoped_config)
self.assert_create_endpoint_call(
m, socket_options=self.default_socket_options)
def test_tcp_keepalive_explicitly_disabled(self):
scoped_config = {'tcp_keepalive': 'false'}
with mock.patch('botocore.args.EndpointCreator') as m:
self.call_get_client_args(scoped_config=scoped_config)
self.assert_create_endpoint_call(
m, socket_options=self.default_socket_options)
def test_tcp_keepalive_enabled_case_insensitive(self):
scoped_config = {'tcp_keepalive': 'True'}
with mock.patch('botocore.args.EndpointCreator') as m:
self.call_get_client_args(scoped_config=scoped_config)
self.assert_create_endpoint_call(
m, socket_options=self.default_socket_options + [
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
]
)
def test_sts_override_resolved_endpoint_for_legacy_region(self):
self.config_store.set_config_variable(
'sts_regional_endpoints', 'legacy')
client_args = self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='us-west-2', endpoint_url=None
)
self.assertEqual(
client_args['endpoint'].host, 'https://sts.amazonaws.com')
self.assertEqual(
client_args['request_signer'].region_name, 'us-east-1')
def test_sts_use_resolved_endpoint_for_nonlegacy_region(self):
resolved_endpoint = 'https://resolved-endpoint'
resolved_region = 'resolved-region'
self._set_endpoint_bridge_resolve(
endpoint_url=resolved_endpoint,
signing_region=resolved_region
)
self.config_store.set_config_variable(
'sts_regional_endpoints', 'legacy')
client_args = self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='ap-east-1', endpoint_url=None
)
self.assertEqual(client_args['endpoint'].host, resolved_endpoint)
self.assertEqual(
client_args['request_signer'].region_name, resolved_region)
def test_sts_use_resolved_endpoint_for_regional_configuration(self):
resolved_endpoint = 'https://resolved-endpoint'
resolved_region = 'resolved-region'
self._set_endpoint_bridge_resolve(
endpoint_url=resolved_endpoint,
signing_region=resolved_region
)
self.config_store.set_config_variable(
'sts_regional_endpoints', 'regional')
client_args = self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='us-west-2', endpoint_url=None
)
self.assertEqual(client_args['endpoint'].host, resolved_endpoint)
self.assertEqual(
client_args['request_signer'].region_name, resolved_region)
def test_sts_with_endpoint_override_and_legacy_configured(self):
override_endpoint = 'https://override-endpoint'
self._set_endpoint_bridge_resolve(endpoint_url=override_endpoint)
self.config_store.set_config_variable(
'sts_regional_endpoints', 'legacy')
client_args = self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='us-west-2', endpoint_url=override_endpoint
)
self.assertEqual(client_args['endpoint'].host, override_endpoint)
def test_sts_http_scheme_for_override_endpoint(self):
self.config_store.set_config_variable(
'sts_regional_endpoints', 'legacy')
client_args = self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='us-west-2', endpoint_url=None, is_secure=False,
)
self.assertEqual(
client_args['endpoint'].host, 'http://sts.amazonaws.com')
def test_sts_regional_endpoints_defaults_to_legacy_if_not_set(self):
self.config_store.set_config_variable(
'sts_regional_endpoints', None)
client_args = self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='us-west-2', endpoint_url=None
)
self.assertEqual(
client_args['endpoint'].host, 'https://sts.amazonaws.com')
self.assertEqual(
client_args['request_signer'].region_name, 'us-east-1')
def test_invalid_sts_regional_endpoints(self):
self.config_store.set_config_variable(
'sts_regional_endpoints', 'invalid')
with self.assertRaises(
exceptions.InvalidSTSRegionalEndpointsConfigError):
self.call_get_client_args(
service_model=self._get_service_model('sts'),
region_name='us-west-2', endpoint_url=None
)
def test_provides_total_max_attempts(self):
config = botocore.config.Config(retries={'total_max_attempts': 10})
client_args = self.call_get_client_args(client_config=config)
self.assertEqual(
client_args['client_config'].retries['total_max_attempts'], 10)
def test_provides_total_max_attempts_has_precedence(self):
config = botocore.config.Config(retries={'total_max_attempts': 10,
'max_attempts': 5})
client_args = self.call_get_client_args(client_config=config)
self.assertEqual(
client_args['client_config'].retries['total_max_attempts'], 10)
self.assertNotIn('max_attempts', client_args['client_config'].retries)
def test_provide_retry_config_maps_total_max_attempts(self):
config = botocore.config.Config(retries={'max_attempts': 10})
client_args = self.call_get_client_args(client_config=config)
self.assertEqual(
client_args['client_config'].retries['total_max_attempts'], 11)
self.assertNotIn('max_attempts', client_args['client_config'].retries)
def test_can_merge_max_attempts(self):
self.config_store.set_config_variable('max_attempts', 4)
config = self.call_get_client_args()['client_config']
self.assertEqual(config.retries['total_max_attempts'], 4)
def test_uses_config_value_if_present_for_max_attempts(self):
config = self.call_get_client_args(
client_config=Config(retries={'max_attempts': 2})
)['client_config']
self.assertEqual(config.retries['total_max_attempts'], 3)
def test_uses_client_config_over_config_store_max_attempts(self):
self.config_store.set_config_variable('max_attempts', 4)
config = self.call_get_client_args(
client_config=Config(retries={'max_attempts': 2})
)['client_config']
self.assertEqual(config.retries['total_max_attempts'], 3)
def test_uses_client_config_total_over_config_store_max_attempts(self):
self.config_store.set_config_variable('max_attempts', 4)
config = self.call_get_client_args(
client_config=Config(retries={'total_max_attempts': 2})
)['client_config']
self.assertEqual(config.retries['total_max_attempts'], 2)
def test_max_attempts_unset_if_retries_is_none(self):
config = self.call_get_client_args(
client_config=Config(retries=None)
)['client_config']
self.assertEqual(config.retries, {'mode': 'legacy'})
def test_retry_mode_set_on_config_store(self):
self.config_store.set_config_variable('retry_mode', 'standard')
config = self.call_get_client_args()['client_config']
self.assertEqual(config.retries['mode'], 'standard')
def test_retry_mode_set_on_client_config(self):
config = self.call_get_client_args(
client_config=Config(retries={'mode': 'standard'})
)['client_config']
self.assertEqual(config.retries['mode'], 'standard')
def test_client_config_beats_config_store(self):
self.config_store.set_config_variable('retry_mode', 'adaptive')
config = self.call_get_client_args(
client_config=Config(retries={'mode': 'standard'})
)['client_config']
self.assertEqual(config.retries['mode'], 'standard')
|
