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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
# Copyright 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
#
# https://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 pytest
from botocore import loaders
from botocore.client import Config
from botocore.exceptions import UnknownServiceError
from boto3 import __version__
from boto3.exceptions import ResourceNotExistsError
from boto3.session import Session
from tests import BaseTestCase, mock
class TestSession(BaseTestCase):
def test_repr(self):
bc_session = self.bc_session_cls.return_value
bc_session.get_credentials.return_value.access_key = 'abc123'
bc_session.get_config_variable.return_value = 'us-west-2'
session = Session('abc123', region_name='us-west-2')
assert repr(session) == 'Session(region_name=\'us-west-2\')'
def test_repr_on_subclasses(self):
bc_session = self.bc_session_cls.return_value
bc_session.get_credentials.return_value.access_key = 'abc123'
bc_session.get_config_variable.return_value = 'us-west-2'
class MySession(Session):
pass
session = MySession('abc123', region_name='us-west-2')
assert repr(session) == 'MySession(region_name=\'us-west-2\')'
def test_can_access_region_name(self):
bc_session = self.bc_session_cls.return_value
bc_session.get_config_variable.return_value = 'us-west-2'
session = Session('abc123', region_name='us-west-2')
bc_session.set_config_variable.assert_called_with(
'region', 'us-west-2'
)
assert session.region_name == 'us-west-2'
def test_arguments_not_required(self):
Session()
assert self.bc_session_cls.called
def test_credentials_can_be_set(self):
bc_session = self.bc_session_cls.return_value
# Set values in constructor
Session(
aws_access_key_id='key',
aws_secret_access_key='secret',
aws_session_token='token',
)
assert self.bc_session_cls.called
assert bc_session.set_credentials.called
bc_session.set_credentials.assert_called_with('key', 'secret', 'token')
def test_can_get_credentials(self):
access_key = 'foo'
secret_key = 'bar'
token = 'baz'
creds = mock.Mock()
creds.access_key = access_key
creds.secret_key = secret_key
creds.token = token
bc_session = self.bc_session_cls.return_value
bc_session.get_credentials.return_value = creds
session = Session(
aws_access_key_id=access_key,
aws_secret_access_key=secret_key,
aws_session_token=token,
)
credentials = session.get_credentials()
assert credentials.access_key == access_key
assert credentials.secret_key == secret_key
assert credentials.token == token
def test_profile_can_be_set(self):
bc_session = self.bc_session_cls.return_value
session = Session(profile_name='foo')
bc_session.set_config_variable.assert_called_with('profile', 'foo')
bc_session.profile = 'foo'
# We should also be able to read the value
assert session.profile_name == 'foo'
def test_profile_default(self):
self.bc_session_cls.return_value.profile = None
session = Session()
assert session.profile_name == 'default'
def test_available_profiles(self):
bc_session = mock.Mock()
bc_session.available_profiles.return_value = ['foo', 'bar']
session = Session(botocore_session=bc_session)
profiles = session.available_profiles
assert len(profiles.return_value) == 2
def test_custom_session(self):
bc_session = self.bc_session_cls()
self.bc_session_cls.reset_mock()
Session(botocore_session=bc_session)
# No new session was created
assert not self.bc_session_cls.called
def test_user_agent(self):
# Here we get the underlying Botocore session, create a Boto3
# session, and ensure that the user-agent is modified as expected
bc_session = self.bc_session_cls.return_value
bc_session.user_agent_name = 'Botocore'
bc_session.user_agent_version = '0.68.0'
bc_session.user_agent_extra = ''
Session(botocore_session=bc_session)
assert bc_session.user_agent_name == 'Boto3'
assert bc_session.user_agent_version == __version__
assert bc_session.user_agent_extra == 'Botocore/0.68.0'
def test_user_agent_extra(self):
# This test is the same as above, but includes custom extra content
# which must still be in the final modified user-agent.
bc_session = self.bc_session_cls.return_value
bc_session.user_agent_name = 'Botocore'
bc_session.user_agent_version = '0.68.0'
bc_session.user_agent_extra = 'foo'
Session(botocore_session=bc_session)
assert bc_session.user_agent_extra == 'foo Botocore/0.68.0'
def test_custom_user_agent(self):
# This test ensures that a customized user-agent is left untouched.
bc_session = self.bc_session_cls.return_value
bc_session.user_agent_name = 'Custom'
bc_session.user_agent_version = '1.0'
bc_session.user_agent_extra = ''
Session(botocore_session=bc_session)
assert bc_session.user_agent_name == 'Custom'
assert bc_session.user_agent_version == '1.0'
assert bc_session.user_agent_extra == ''
def test_get_available_services(self):
bc_session = self.bc_session_cls.return_value
session = Session()
session.get_available_services()
assert bc_session.get_available_services.called
def test_get_available_resources(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.list_available_services.return_value = ['foo', 'bar']
mock_bc_session.get_component.return_value = loader
session = Session(botocore_session=mock_bc_session)
names = session.get_available_resources()
assert names == ['foo', 'bar']
def test_get_available_partitions(self):
bc_session = mock.Mock()
bc_session.get_available_partitions.return_value = ['foo']
session = Session(botocore_session=bc_session)
partitions = session.get_available_partitions()
assert partitions == ['foo']
def test_get_available_regions(self):
bc_session = mock.Mock()
bc_session.get_available_regions.return_value = ['foo']
session = Session(botocore_session=bc_session)
partitions = session.get_available_regions('myservice')
bc_session.get_available_regions.assert_called_with(
service_name='myservice',
partition_name='aws',
allow_non_regional=False,
)
assert partitions == ['foo']
def test_get_partition_for_region(self):
bc_session = mock.Mock()
bc_session.get_partition_for_region.return_value = 'baz'
session = Session(botocore_session=bc_session)
partition = session.get_partition_for_region('foo-bar-1')
bc_session.get_partition_for_region.assert_called_with('foo-bar-1')
assert partition == 'baz'
def test_create_client(self):
session = Session(region_name='us-east-1')
client = session.client('sqs', region_name='us-west-2')
assert client, 'No low-level client was returned'
def test_create_client_with_args(self):
bc_session = self.bc_session_cls.return_value
session = Session(region_name='us-east-1')
session.client('sqs', region_name='us-west-2')
bc_session.create_client.assert_called_with(
'sqs',
aws_secret_access_key=None,
aws_access_key_id=None,
endpoint_url=None,
use_ssl=True,
aws_session_token=None,
verify=None,
region_name='us-west-2',
api_version=None,
config=None,
)
def test_create_resource_with_args(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.determine_latest_version.return_value = '2014-11-02'
loader.load_service_model.return_value = {
'resources': [],
'service': [],
}
mock_bc_session.get_component.return_value = loader
session = Session(botocore_session=mock_bc_session)
session.resource_factory.load_from_definition = mock.Mock()
session.client = mock.Mock()
session.resource('sqs', verify=False)
session.client.assert_called_with(
'sqs',
aws_secret_access_key=None,
aws_access_key_id=None,
endpoint_url=None,
use_ssl=True,
aws_session_token=None,
verify=False,
region_name=None,
api_version='2014-11-02',
config=mock.ANY,
)
client_config = session.client.call_args[1]['config']
assert client_config.user_agent_extra == 'Resource'
assert client_config.signature_version is None
def test_create_resource_with_config(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.determine_latest_version.return_value = '2014-11-02'
loader.load_service_model.return_value = {
'resources': [],
'service': [],
}
mock_bc_session.get_component.return_value = loader
session = Session(botocore_session=mock_bc_session)
session.resource_factory.load_from_definition = mock.Mock()
session.client = mock.Mock()
config = Config(signature_version='v4')
session.resource('sqs', config=config)
session.client.assert_called_with(
'sqs',
aws_secret_access_key=None,
aws_access_key_id=None,
endpoint_url=None,
use_ssl=True,
aws_session_token=None,
verify=None,
region_name=None,
api_version='2014-11-02',
config=mock.ANY,
)
client_config = session.client.call_args[1]['config']
assert client_config.user_agent_extra == 'Resource'
assert client_config.signature_version == 'v4'
def test_create_resource_with_config_override_user_agent_extra(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.determine_latest_version.return_value = '2014-11-02'
loader.load_service_model.return_value = {
'resources': [],
'service': [],
}
mock_bc_session.get_component.return_value = loader
session = Session(botocore_session=mock_bc_session)
session.resource_factory.load_from_definition = mock.Mock()
session.client = mock.Mock()
config = Config(signature_version='v4', user_agent_extra='foo')
session.resource('sqs', config=config)
session.client.assert_called_with(
'sqs',
aws_secret_access_key=None,
aws_access_key_id=None,
endpoint_url=None,
use_ssl=True,
aws_session_token=None,
verify=None,
region_name=None,
api_version='2014-11-02',
config=mock.ANY,
)
client_config = session.client.call_args[1]['config']
assert client_config.user_agent_extra == 'foo'
assert client_config.signature_version == 'v4'
def test_create_resource_latest_version(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.determine_latest_version.return_value = '2014-11-02'
loader.load_service_model.return_value = {
'resources': [],
'service': [],
}
mock_bc_session.get_component.return_value = loader
session = Session(botocore_session=mock_bc_session)
session.resource_factory.load_from_definition = mock.Mock()
session.resource('sqs')
loader.load_service_model.assert_called_with(
'sqs', 'resources-1', None
)
def test_bad_resource_name(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.load_service_model.side_effect = UnknownServiceError(
service_name='foo', known_service_names='asdf'
)
mock_bc_session.get_component.return_value = loader
loader.list_available_services.return_value = ['good-resource']
mock_bc_session.get_available_services.return_value = ['sqs']
session = Session(botocore_session=mock_bc_session)
with pytest.raises(ResourceNotExistsError) as e:
session.resource('sqs')
err_msg = str(e.exception)
# 1. should say the resource doesn't exist.
assert 'resource does not exist' in err_msg
assert 'sqs' in err_msg
# 2. Should list available resources you can choose.
assert 'good-resource' in err_msg
# 3. Should list client if available.
assert 'client' in err_msg
def test_bad_resource_name_with_no_client_has_simple_err_msg(self):
mock_bc_session = mock.Mock()
loader = mock.Mock(spec=loaders.Loader)
loader.load_service_model.side_effect = UnknownServiceError(
service_name='foo', known_service_names='asdf'
)
mock_bc_session.get_component.return_value = loader
loader.list_available_services.return_value = ['good-resource']
mock_bc_session.get_available_services.return_value = ['good-client']
session = Session(botocore_session=mock_bc_session)
with pytest.raises(ResourceNotExistsError) as e:
session.resource('bad-client')
err_msg = str(e.exception)
# Shouldn't mention anything about clients because
# 'bad-client' it not a valid boto3.client(...)
assert 'boto3.client' not in err_msg
def test_can_reach_events(self):
mock_bc_session = self.bc_session_cls()
session = Session(botocore_session=mock_bc_session)
session.events
mock_bc_session.get_component.assert_called_with('event_emitter')
|
