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,
'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')
def test_can_set_variable(self):
provider = ConfigValueStore()
provider.set_config_variable('fake_variable', 'foo')
value = provider.get_config_variable('fake_variable')
self.assertEquals(value, 'foo')
def test_can_set_variable(self):
provider = ConfigValueStore()
provider.set_config_variable('fake_variable', 'foo')
value = provider.get_config_variable('fake_variable')
self.assertEquals(value, 'foo')