def test_credential_logging_empty(self):
"""
Boto handles invalid --boto-access-key and --boto-secret-key values
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
credential_map = {
ACCESS_KEY: '',
SECRET_KEY: '',
}
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
access_key=credential_map[ACCESS_KEY],
secret_key=credential_map[SECRET_KEY],
logger=mock_logger,
)
# Check the passed boto credentials are correctly set in the mocked os.environ dictionary
self.assertNotIn(ACCESS_KEY, krux_boto.boto.os.environ)
self.assertNotIn(SECRET_KEY, krux_boto.boto.os.environ)
# Verify the warning is logged
for key, val in credential_map.iteritems():
mock_logger.debug.assert_any_call('Passed boto credentials is empty. Falling back to environment variable %s', key)
self.assertTrue(('Setting boto credential %s to %s', key, '<empty>') not in mock_logger.debug.call_args_list)
mock_logger.info.assert_any_call(
'Boto environment credential %s NOT explicitly set -- boto will look for a .boto file somewhere',
key,
)
def test_logging_level(self):
"""
--boto-log-level arguments sets the log level for boto correctly
"""
self.boto = Boto(log_level='info', )
self.assertEqual(INFO,
krux.logging.get_logger('boto').getEffectiveLevel())
def test_region_no_env(self):
"""
Region default correct if environment not set
"""
mock_logger = MagicMock(spec=Logger, autospec=True)
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(logger=mock_logger, )
# Check that the region has correct default
self.assertEqual(self.boto.cli_region, 'us-east-1')
def test_cli_region(self):
"""
--boto-region arguments sets boto.cli_region variable correctly
"""
region = 'us-west-2'
self.boto = Boto(
region=region,
)
self.assertEqual(region, self.boto.cli_region)
def test_region_default(self):
"""
--boto-region sets default region correctly
"""
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', {REGION: 'us-west-2'}):
self.boto = Boto()
# Check the region is correctly set in the mocked os.environ dictionary
self.assertIn(REGION, krux_boto.boto.os.environ)
self.assertEqual(self.boto.cli_region, krux_boto.boto.os.environ[REGION])
def test_cli_arguments_check(self):
"""
Boto warns users correctly when CLI arguments and passed in credentials don't match.
"""
credential_map = {
ACCESS_KEY: {
'CLI': 'ZYXWVUTSR',
'ENV': 'ABCDEFGHI',
'msg': 'boto-access-key',
},
SECRET_KEY: {
'CLI': '0Z9Y8X7W6V5U4T3S2R1',
'ENV': '1A2B3C4D5E6F7G8H9I0',
'msg': 'boto-secret-key',
},
}
# Mocking the parser to trigger the warning
parser = krux.cli.get_parser()
add_boto_cli_arguments(parser)
namespace = parser.parse_args([
'--boto-access-key', credential_map[ACCESS_KEY]['CLI'],
'--boto-secret-key', credential_map[SECRET_KEY]['CLI'],
])
mock_parser = MagicMock(
return_value=MagicMock(
spec=ArgumentParser,
autospec=True,
_action_groups=[],
parse_known_args=MagicMock(return_value=namespace)
)
)
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
mock_env = {
ACCESS_KEY: credential_map[ACCESS_KEY]['ENV'],
SECRET_KEY: credential_map[SECRET_KEY]['ENV'],
}
with patch.dict('krux_boto.boto.os.environ', mock_env, clear=True):
with patch('krux_boto.boto.get_parser', mock_parser):
self.boto = Boto(
logger=mock_logger
)
for key, value in credential_map.iteritems():
msg = 'You set %s as {0} in CLI, but passed %s to the library. ' \
'To avoid this error, consider using get_boto() function. ' \
'For more information, please check README.' \
.format(value['msg'])
cli_key = value['CLI'][0:3] + '[...]' + value['CLI'][-3:]
env_key = value['ENV'][0:3] + '[...]' + value['ENV'][-3:]
mock_logger.warn.assert_any_call(msg, cli_key, env_key)
def test_region_cli_input(self):
"""
--boto-region set correctly with command line input
"""
region = 'us-east-1'
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', {REGION: 'us-west-2'}):
self.boto = Boto(region=region, )
# Check the region is correctly set in the mocked os.environ dictionary
self.assertIn(REGION, krux_boto.boto.os.environ)
self.assertNotEqual(self.boto.cli_region,
krux_boto.boto.os.environ[REGION])
self.assertEqual(self.boto.cli_region, region)
def test_region_no_env_cli(self):
"""
Region CLI input works fine with no environment variable set
"""
region = 'us-west-1'
mock_logger = MagicMock(spec=Logger, autospec=True)
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
logger=mock_logger,
region=region,
)
# Check region can be set with command line argument with no environment variables
self.assertEqual(self.boto.cli_region, region)
def test_region_no_env(self):
"""
Region default correct if environment not set
"""
mock_logger = MagicMock(spec=Logger, autospec=True)
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
logger=mock_logger,
)
# User should be warned if the environment variable is not set.
mock_logger.warn.assert_called_once_with(
"There is not a default region set in your environment variables. Defaulted to 'us-east-1'"
)
# Check that the region has correct default
self.assertEqual(self.boto.cli_region, 'us-east-1')
def test_get_attr_function(self):
"""
Boto functions are accessible directly via krux_boto
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
self.boto = Boto(
logger=mock_logger,
)
# Verify a function can be called directly from krux_boto and returns the correct value
# GOTCHA: connect_ec2 function is arbitrarily chosen. Any function is sufficient to test
self.assertIsInstance(self.boto.connect_ec2(), boto.ec2.EC2Connection)
# Verify logging
mock_logger.debug.assert_any_call('Calling wrapped boto attribute: %s on %s', 'connect_ec2', self.boto)
mock_logger.debug.assert_any_call("Boto attribute '%s' is callable", boto.connect_ec2)
def test_logging_level(self):
"""
--boto-log-level arguments sets the log level for boto correctly
"""
self.boto = Boto(
log_level='info',
)
self.assertEqual(INFO, krux.logging.get_logger('boto').getEffectiveLevel())
def test_region_default(self):
"""
--boto-region sets default region correctly
"""
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', {REGION: 'us-west-2'}):
self.boto = Boto()
# Check the region is correctly set in the mocked os.environ dictionary
self.assertIn(REGION, krux_boto.boto.os.environ)
self.assertEqual(self.boto.cli_region, krux_boto.boto.os.environ[REGION])
def test_region_no_env_cli(self):
"""
Region CLI input works fine with no environment variable set
"""
region = 'us-west-1'
mock_logger = MagicMock(spec=Logger, autospec=True)
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
logger=mock_logger,
region=region,
)
# User should be warned if the environment variable is not set.
mock_logger.warn.assert_called_once_with(
"There is not a default region set in your environment variables. Defaulted to 'us-east-1'"
)
# Check region can be set with command line argument with no environment variables
self.assertEqual(self.boto.cli_region, region)
def test_region_no_env(self):
"""
Region default correct if environment not set
"""
mock_logger = MagicMock(spec=Logger, autospec=True)
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
logger=mock_logger,
)
# Check that the region has correct default
self.assertEqual(self.boto.cli_region, 'us-east-1')
def test_get_attr_property(self):
"""
Boto properties are accessible directly via krux_boto
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
self.boto = Boto(
logger=mock_logger,
)
# GOTCHA: Reset the logger to check only the property calling code, not the constructor
mock_logger.debug.reset_mock()
# Verify a property is returned
# GOTCHA: ec2 property is arbitrarily chosen. Any property is sufficient to test
self.assertEqual(boto.ec2, self.boto.ec2)
# Verify logging
mock_logger.debug.assert_called_once_with('Calling wrapped boto attribute: %s on %s', 'ec2', self.boto)
self.assertTrue(("Boto attribute '%s' is callable", 'connect_ec2') not in mock_logger.debug.call_args_list)
def test_region_cli_input(self):
"""
--boto-region set correctly with command line input
"""
region = 'us-east-1'
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', {REGION: 'us-west-2'}):
self.boto = Boto(
region=region,
)
# Check the region is correctly set in the mocked os.environ dictionary
self.assertIn(REGION, krux_boto.boto.os.environ)
self.assertNotEqual(self.boto.cli_region, krux_boto.boto.os.environ[REGION])
self.assertEqual(self.boto.cli_region, region)
def test_credential_logging_success(self):
"""
--boto-access-key and --boto-secret-key sets corresponding environment variables correctly
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
credential_map = {
ACCESS_KEY: 'ABCDEFGHI',
SECRET_KEY: '1A2B3C4D5E6F7G8H9I0',
}
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
access_key=credential_map[ACCESS_KEY],
secret_key=credential_map[SECRET_KEY],
logger=mock_logger,
)
# Check the passed boto credentials are correctly set in the mocked os.environ dictionary
self.assertIn(ACCESS_KEY, krux_boto.boto.os.environ)
self.assertEqual(credential_map[ACCESS_KEY],
krux_boto.boto.os.environ[ACCESS_KEY])
self.assertIn(SECRET_KEY, krux_boto.boto.os.environ)
self.assertEqual(credential_map[SECRET_KEY],
krux_boto.boto.os.environ[SECRET_KEY])
# Verify logging
for key, val in iteritems(credential_map):
self.assertTrue((
'Passed boto credentials is empty. Falling back to environment variable %s',
key) not in mock_logger.debug.call_args_list)
mock_logger.debug.assert_any_call('Setting boto credential %s',
key)
self.assertTrue((
'Boto environment credential %s NOT explicitly set -- boto will look for a .boto file somewhere',
key) not in mock_logger.info.call_args_list)
def test_region_no_env_cli(self):
"""
Region CLI input works fine with no environment variable set
"""
region = 'us-west-1'
mock_logger = MagicMock(spec=Logger, autospec=True)
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
logger=mock_logger,
region=region,
)
# Check region can be set with command line argument with no environment variables
self.assertEqual(self.boto.cli_region, region)
def test_credential_logging_success(self):
"""
--boto-access-key and --boto-secret-key sets corresponding environment variables correctly
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
credential_map = {
ACCESS_KEY: 'ABCDEFGHI',
SECRET_KEY: '1A2B3C4D5E6F7G8H9I0',
}
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
access_key=credential_map[ACCESS_KEY],
secret_key=credential_map[SECRET_KEY],
logger=mock_logger,
)
# Check the passed boto credentials are correctly set in the mocked os.environ dictionary
self.assertIn(ACCESS_KEY, krux_boto.boto.os.environ)
self.assertEqual(credential_map[ACCESS_KEY], krux_boto.boto.os.environ[ACCESS_KEY])
self.assertIn(SECRET_KEY, krux_boto.boto.os.environ)
self.assertEqual(credential_map[SECRET_KEY], krux_boto.boto.os.environ[SECRET_KEY])
# Verify logging
for key, val in iteritems(credential_map):
self.assertTrue(
('Passed boto credentials is empty. Falling back to environment variable %s', key)
not in mock_logger.debug.call_args_list
)
obsc = val[0:3] + '[...]' + val[-3:]
mock_logger.debug.assert_any_call('Setting boto credential %s to %s', key, obsc)
self.assertTrue(
('Boto environment credential %s NOT explicitly set -- boto will look for a .boto file somewhere', key)
not in mock_logger.info.call_args_list
)
class BotoTest(unittest.TestCase):
def test_cli_region(self):
"""
--boto-region arguments sets boto.cli_region variable correctly
"""
region = 'us-west-2'
self.boto = Boto(
region=region,
)
self.assertEqual(region, self.boto.cli_region)
def test_credential_logging_success(self):
"""
--boto-access-key and --boto-secret-key sets corresponding environment variables correctly
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
credential_map = {
ACCESS_KEY: 'ABCDEFGHI',
SECRET_KEY: '1A2B3C4D5E6F7G8H9I0',
}
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
access_key=credential_map[ACCESS_KEY],
secret_key=credential_map[SECRET_KEY],
logger=mock_logger,
)
# Check the passed boto credentials are correctly set in the mocked os.environ dictionary
self.assertIn(ACCESS_KEY, krux_boto.boto.os.environ)
self.assertEqual(credential_map[ACCESS_KEY], krux_boto.boto.os.environ[ACCESS_KEY])
self.assertIn(SECRET_KEY, krux_boto.boto.os.environ)
self.assertEqual(credential_map[SECRET_KEY], krux_boto.boto.os.environ[SECRET_KEY])
# Verify logging
for key, val in credential_map.iteritems():
self.assertTrue(
('Passed boto credentials is empty. Falling back to environment variable %s', key) not in mock_logger.debug.call_args_list
)
obsc = val[0:3] + '[...]' + val[-3:]
mock_logger.debug.assert_any_call('Setting boto credential %s to %s', key, obsc)
self.assertTrue(
('Boto environment credential %s NOT explicitly set -- boto will look for a .boto file somewhere', key) not in mock_logger.info.call_args_list
)
def test_credential_logging_empty(self):
"""
Boto handles invalid --boto-access-key and --boto-secret-key values
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
credential_map = {
ACCESS_KEY: '',
SECRET_KEY: '',
}
# Mocking the os.environ dictionary as an empty dictionary
with patch.dict('krux_boto.boto.os.environ', clear=True):
self.boto = Boto(
access_key=credential_map[ACCESS_KEY],
secret_key=credential_map[SECRET_KEY],
logger=mock_logger,
)
# Check the passed boto credentials are correctly set in the mocked os.environ dictionary
self.assertNotIn(ACCESS_KEY, krux_boto.boto.os.environ)
self.assertNotIn(SECRET_KEY, krux_boto.boto.os.environ)
# Verify the warning is logged
for key, val in credential_map.iteritems():
mock_logger.debug.assert_any_call('Passed boto credentials is empty. Falling back to environment variable %s', key)
self.assertTrue(('Setting boto credential %s to %s', key, '<empty>') not in mock_logger.debug.call_args_list)
mock_logger.info.assert_any_call(
'Boto environment credential %s NOT explicitly set -- boto will look for a .boto file somewhere',
key,
)
def test_cli_arguments_check(self):
"""
Boto warns users correctly when CLI arguments and passed in credentials don't match.
"""
credential_map = {
ACCESS_KEY: {
'CLI': 'ZYXWVUTSR',
'ENV': 'ABCDEFGHI',
'msg': 'boto-access-key',
},
SECRET_KEY: {
'CLI': '0Z9Y8X7W6V5U4T3S2R1',
'ENV': '1A2B3C4D5E6F7G8H9I0',
'msg': 'boto-secret-key',
},
}
# Mocking the parser to trigger the warning
parser = krux.cli.get_parser()
add_boto_cli_arguments(parser)
namespace = parser.parse_args([
'--boto-access-key', credential_map[ACCESS_KEY]['CLI'],
'--boto-secret-key', credential_map[SECRET_KEY]['CLI'],
])
mock_parser = MagicMock(
return_value=MagicMock(
spec=ArgumentParser,
autospec=True,
_action_groups=[],
parse_known_args=MagicMock(return_value=namespace)
)
)
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
mock_env = {
ACCESS_KEY: credential_map[ACCESS_KEY]['ENV'],
SECRET_KEY: credential_map[SECRET_KEY]['ENV'],
}
with patch.dict('krux_boto.boto.os.environ', mock_env, clear=True):
with patch('krux_boto.boto.get_parser', mock_parser):
self.boto = Boto(
logger=mock_logger
)
for key, value in credential_map.iteritems():
msg = 'You set %s as {0} in CLI, but passed %s to the library. ' \
'To avoid this error, consider using get_boto() function. ' \
'For more information, please check README.' \
.format(value['msg'])
cli_key = value['CLI'][0:3] + '[...]' + value['CLI'][-3:]
env_key = value['ENV'][0:3] + '[...]' + value['ENV'][-3:]
mock_logger.warn.assert_any_call(msg, cli_key, env_key)
def test_logging_level(self):
"""
--boto-log-level arguments sets the log level for boto correctly
"""
self.boto = Boto(
log_level='info',
)
self.assertEqual(INFO, krux.logging.get_logger('boto').getEffectiveLevel())
def test_get_attr_property(self):
"""
Boto properties are accessible directly via krux_boto
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
self.boto = Boto(
logger=mock_logger,
)
# GOTCHA: Reset the logger to check only the property calling code, not the constructor
mock_logger.debug.reset_mock()
# Verify a property is returned
# GOTCHA: ec2 property is arbitrarily chosen. Any property is sufficient to test
self.assertEqual(boto.ec2, self.boto.ec2)
# Verify logging
mock_logger.debug.assert_called_once_with('Calling wrapped boto attribute: %s on %s', 'ec2', self.boto)
self.assertTrue(("Boto attribute '%s' is callable", 'connect_ec2') not in mock_logger.debug.call_args_list)
def test_get_attr_function(self):
"""
Boto functions are accessible directly via krux_boto
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
self.boto = Boto(
logger=mock_logger,
)
# Verify a function can be called directly from krux_boto and returns the correct value
# GOTCHA: connect_ec2 function is arbitrarily chosen. Any function is sufficient to test
self.assertIsInstance(self.boto.connect_ec2(), boto.ec2.EC2Connection)
# Verify logging
mock_logger.debug.assert_any_call('Calling wrapped boto attribute: %s on %s', 'connect_ec2', self.boto)
mock_logger.debug.assert_any_call("Boto attribute '%s' is callable", boto.connect_ec2)
def test_get_attr_function_boto3(self):
"""
Boto3 properties are accessible directly via krux_boto
"""
# Mocking the logger to check for calls later
mock_logger = MagicMock(spec=Logger, autospec=True)
self.boto = Boto3(
logger=mock_logger,
)
# GOTCHA: Reset the logger to check only the property calling code, not the constructor
mock_logger.debug.reset_mock()
# We test the stringified version, because all the classes are autogenerated
# and assertIsIntance is not finding the class of the client. However, we want
# to still be sure the object returned is of the class we thing it is, hence
# the workaround.
self.assertIn('botocore.client.EC2', str(self.boto.client('ec2')))
# Verify logging
mock_logger.debug.assert_any_call('Calling wrapped boto attribute: %s on %s', 'client', self.boto)