# -*- coding: utf-8 -*- # Import Python libs from __future__ import absolute_import from distutils.version import LooseVersion # pylint: disable=import-error,no-name-in-module # Import Salt Testing libs from salttesting.unit import skipIf, TestCase from salttesting.mock import NO_MOCK, NO_MOCK_REASON, patch from salttesting.helpers import ensure_in_syspath ensure_in_syspath('../../') # Import Salt libs import salt.config import salt.loader from salt.modules import boto_iot # Import 3rd-party libs import logging # Import Mock libraries from salttesting.mock import NO_MOCK, NO_MOCK_REASON, MagicMock, patch # pylint: disable=import-error,no-name-in-module try: import boto3 from botocore.exceptions import ClientError HAS_BOTO = True except ImportError: HAS_BOTO = False # pylint: enable=import-error,no-name-in-module # the boto_iot module relies on the connect_to_region() method # which was added in boto 2.8.0 # https://github.com/boto/boto/commit/33ac26b416fbb48a60602542b4ce15dcc7029f12 required_boto3_version = '1.2.1' region = 'us-east-1' access_key = 'GKTADJGHEIQSXMKKRBJ08H' secret_key = 'askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs' conn_parameters = {'region': region, 'key': access_key, 'keyid': secret_key, 'profile': {}} error_message = 'An error occurred (101) when calling the {0} operation: Test-defined error' if HAS_BOTO: not_found_error = ClientError({ 'Error': { 'Code': 'ResourceNotFoundException', 'Message': "Test-defined error" } }, 'msg') topic_rule_not_found_error = ClientError({ 'Error': { 'Code': 'UnauthorizedException', 'Message': "Test-defined error" } }, 'msg') error_content = { 'Error': { 'Code': 101, 'Message': "Test-defined error" } } policy_ret = dict(policyName='testpolicy', policyDocument='{"Version": "2012-10-17", "Statement": [{"Action": ["iot:Publish"], "Resource": ["*"], "Effect": "Allow"}]}', policyArn='arn:aws:iot:us-east-1:123456:policy/my_policy', policyVersionId=1, defaultVersionId=1) topic_rule_ret = dict(ruleName='testrule', sql="SELECT * FROM 'iot/test'", description='topic rule description', createdAt='1970-01-01', actions=[{'lambda': {'functionArn': 'arn:aws:::function'}}], ruleDisabled=True) log = logging.getLogger(__name__) opts = salt.config.DEFAULT_MINION_OPTS context = {} utils = salt.loader.utils(opts, whitelist=['boto3'], context=context) boto_iot.__utils__ = utils boto_iot.__init__(opts) boto_iot.__salt__ = {} def _has_required_boto(): ''' Returns True/False boolean depending on if Boto is installed and correct version. ''' if not HAS_BOTO: return False elif LooseVersion(boto3.__version__) < LooseVersion(required_boto3_version): return False else: return True class BotoIoTTestCaseBase(TestCase): conn = None # Set up MagicMock to replace the boto3 session def setUp(self): context.clear() self.patcher = patch('boto3.session.Session') self.addCleanup(self.patcher.stop) mock_session = self.patcher.start() session_instance = mock_session.return_value self.conn = MagicMock() session_instance.client.return_value = self.conn class BotoIoTTestCaseMixin(object): pass @skipIf(HAS_BOTO is False, 'The boto module must be installed.') @skipIf(_has_required_boto() is False, 'The boto3 module must be greater than' ' or equal to version {0}' .format(required_boto3_version)) @skipIf(NO_MOCK, NO_MOCK_REASON) class BotoIoTPolicyTestCase(BotoIoTTestCaseBase, BotoIoTTestCaseMixin): ''' TestCase for salt.modules.boto_iot module ''' def test_that_when_checking_if_a_policy_exists_and_a_policy_exists_the_policy_exists_method_returns_true(self): ''' Tests checking iot policy existence when the iot policy already exists ''' self.conn.get_policy.return_value = {'policy': policy_ret} result = boto_iot.policy_exists(policyName=policy_ret['policyName'], **conn_parameters) self.assertTrue(result['exists']) def test_that_when_checking_if_a_policy_exists_and_a_policy_does_not_exist_the_policy_exists_method_returns_false(self): ''' Tests checking iot policy existence when the iot policy does not exist ''' self.conn.get_policy.side_effect = not_found_error result = boto_iot.policy_exists(policyName='mypolicy', **conn_parameters) self.assertFalse(result['exists']) def test_that_when_checking_if_a_policy_exists_and_boto3_returns_an_error_the_policy_exists_method_returns_error(self): ''' Tests checking iot policy existence when boto returns an error ''' self.conn.get_policy.side_effect = ClientError(error_content, 'get_policy') result = boto_iot.policy_exists(policyName='mypolicy', **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('get_policy')) def test_that_when_creating_a_policy_succeeds_the_create_policy_method_returns_true(self): ''' tests True policy created. ''' self.conn.create_policy.return_value = policy_ret result = boto_iot.create_policy(policyName=policy_ret['policyName'], policyDocument=policy_ret['policyDocument'], **conn_parameters) self.assertTrue(result['created']) def test_that_when_creating_a_policy_fails_the_create_policy_method_returns_error(self): ''' tests False policy not created. ''' self.conn.create_policy.side_effect = ClientError(error_content, 'create_policy') result = boto_iot.create_policy(policyName=policy_ret['policyName'], policyDocument=policy_ret['policyDocument'], **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('create_policy')) def test_that_when_deleting_a_policy_succeeds_the_delete_policy_method_returns_true(self): ''' tests True policy deleted. ''' result = boto_iot.delete_policy(policyName='testpolicy', **conn_parameters) self.assertTrue(result['deleted']) def test_that_when_deleting_a_policy_fails_the_delete_policy_method_returns_false(self): ''' tests False policy not deleted. ''' self.conn.delete_policy.side_effect = ClientError(error_content, 'delete_policy') result = boto_iot.delete_policy(policyName='testpolicy', **conn_parameters) self.assertFalse(result['deleted']) def test_that_when_describing_policy_it_returns_the_dict_of_properties_returns_true(self): ''' Tests describing parameters if policy exists ''' self.conn.get_policy.return_value = {'policy': policy_ret} result = boto_iot.describe_policy(policyName=policy_ret['policyName'], **conn_parameters) self.assertTrue(result['policy']) def test_that_when_describing_policy_it_returns_the_dict_of_properties_returns_false(self): ''' Tests describing parameters if policy does not exist ''' self.conn.get_policy.side_effect = not_found_error result = boto_iot.describe_policy(policyName='testpolicy', **conn_parameters) self.assertFalse(result['policy']) def test_that_when_describing_policy_on_client_error_it_returns_error(self): ''' Tests describing parameters failure ''' self.conn.get_policy.side_effect = ClientError(error_content, 'get_policy') result = boto_iot.describe_policy(policyName='testpolicy', **conn_parameters) self.assertTrue('error' in result) def test_that_when_checking_if_a_policy_version_exists_and_a_policy_version_exists_the_policy_version_exists_method_returns_true(self): ''' Tests checking iot policy existence when the iot policy version already exists ''' self.conn.get_policy.return_value = {'policy': policy_ret} result = boto_iot.policy_version_exists(policyName=policy_ret['policyName'], policyVersionId=1, **conn_parameters) self.assertTrue(result['exists']) def test_that_when_checking_if_a_policy_version_exists_and_a_policy_version_does_not_exist_the_policy_version_exists_method_returns_false(self): ''' Tests checking iot policy_version existence when the iot policy_version does not exist ''' self.conn.get_policy_version.side_effect = not_found_error result = boto_iot.policy_version_exists(policyName=policy_ret['policyName'], policyVersionId=1, **conn_parameters) self.assertFalse(result['exists']) def test_that_when_checking_if_a_policy_version_exists_and_boto3_returns_an_error_the_policy_version_exists_method_returns_error(self): ''' Tests checking iot policy_version existence when boto returns an error ''' self.conn.get_policy_version.side_effect = ClientError(error_content, 'get_policy_version') result = boto_iot.policy_version_exists(policyName=policy_ret['policyName'], policyVersionId=1, **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('get_policy_version')) def test_that_when_creating_a_policy_version_succeeds_the_create_policy_version_method_returns_true(self): ''' tests True policy_version created. ''' self.conn.create_policy_version.return_value = policy_ret result = boto_iot.create_policy_version(policyName=policy_ret['policyName'], policyDocument=policy_ret['policyDocument'], **conn_parameters) self.assertTrue(result['created']) def test_that_when_creating_a_policy_version_fails_the_create_policy_version_method_returns_error(self): ''' tests False policy_version not created. ''' self.conn.create_policy_version.side_effect = ClientError(error_content, 'create_policy_version') result = boto_iot.create_policy_version(policyName=policy_ret['policyName'], policyDocument=policy_ret['policyDocument'], **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('create_policy_version')) def test_that_when_deleting_a_policy_version_succeeds_the_delete_policy_version_method_returns_true(self): ''' tests True policy_version deleted. ''' result = boto_iot.delete_policy_version(policyName='testpolicy', policyVersionId=1, **conn_parameters) self.assertTrue(result['deleted']) def test_that_when_deleting_a_policy_version_fails_the_delete_policy_version_method_returns_false(self): ''' tests False policy_version not deleted. ''' self.conn.delete_policy_version.side_effect = ClientError(error_content, 'delete_policy_version') result = boto_iot.delete_policy_version(policyName='testpolicy', policyVersionId=1, **conn_parameters) self.assertFalse(result['deleted']) def test_that_when_describing_policy_version_it_returns_the_dict_of_properties_returns_true(self): ''' Tests describing parameters if policy_version exists ''' self.conn.get_policy_version.return_value = {'policy': policy_ret} result = boto_iot.describe_policy_version(policyName=policy_ret['policyName'], policyVersionId=1, **conn_parameters) self.assertTrue(result['policy']) def test_that_when_describing_policy_version_it_returns_the_dict_of_properties_returns_false(self): ''' Tests describing parameters if policy_version does not exist ''' self.conn.get_policy_version.side_effect = not_found_error result = boto_iot.describe_policy_version(policyName=policy_ret['policyName'], policyVersionId=1, **conn_parameters) self.assertFalse(result['policy']) def test_that_when_describing_policy_version_on_client_error_it_returns_error(self): ''' Tests describing parameters failure ''' self.conn.get_policy_version.side_effect = ClientError(error_content, 'get_policy_version') result = boto_iot.describe_policy_version(policyName=policy_ret['policyName'], policyVersionId=1, **conn_parameters) self.assertTrue('error' in result) def test_that_when_listing_policies_succeeds_the_list_policies_method_returns_true(self): ''' tests True policies listed. ''' self.conn.list_policies.return_value = {'policies': [policy_ret]} result = boto_iot.list_policies(**conn_parameters) self.assertTrue(result['policies']) def test_that_when_listing_policy_fails_the_list_policy_method_returns_false(self): ''' tests False no policy listed. ''' self.conn.list_policies.return_value = {'policies': []} result = boto_iot.list_policies(**conn_parameters) self.assertFalse(result['policies']) def test_that_when_listing_policy_fails_the_list_policy_method_returns_error(self): ''' tests False policy error. ''' self.conn.list_policies.side_effect = ClientError(error_content, 'list_policies') result = boto_iot.list_policies(**conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('list_policies')) def test_that_when_listing_policy_versions_succeeds_the_list_policy_versions_method_returns_true(self): ''' tests True policy versions listed. ''' self.conn.list_policy_versions.return_value = {'policyVersions': [policy_ret]} result = boto_iot.list_policy_versions(policyName='testpolicy', **conn_parameters) self.assertTrue(result['policyVersions']) def test_that_when_listing_policy_versions_fails_the_list_policy_versions_method_returns_false(self): ''' tests False no policy versions listed. ''' self.conn.list_policy_versions.return_value = {'policyVersions': []} result = boto_iot.list_policy_versions(policyName='testpolicy', **conn_parameters) self.assertFalse(result['policyVersions']) def test_that_when_listing_policy_versions_fails_the_list_policy_versions_method_returns_error(self): ''' tests False policy versions error. ''' self.conn.list_policy_versions.side_effect = ClientError(error_content, 'list_policy_versions') result = boto_iot.list_policy_versions(policyName='testpolicy', **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('list_policy_versions')) def test_that_when_setting_default_policy_version_succeeds_the_set_default_policy_version_method_returns_true(self): ''' tests True policy version set. ''' result = boto_iot.set_default_policy_version(policyName='testpolicy', policyVersionId=1, **conn_parameters) self.assertTrue(result['changed']) def test_that_when_set_default_policy_version_fails_the_set_default_policy_version_method_returns_error(self): ''' tests False policy version error. ''' self.conn.set_default_policy_version.side_effect = \ ClientError(error_content, 'set_default_policy_version') result = boto_iot.set_default_policy_version(policyName='testpolicy', policyVersionId=1, **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('set_default_policy_version')) def test_that_when_list_principal_policies_succeeds_the_list_principal_policies_method_returns_true(self): ''' tests True policies listed. ''' self.conn.list_principal_policies.return_value = {'policies': [policy_ret]} result = boto_iot.list_principal_policies(principal='us-east-1:GUID-GUID-GUID', **conn_parameters) self.assertTrue(result['policies']) def test_that_when_list_principal_policies_fails_the_list_principal_policies_method_returns_error(self): ''' tests False policy version error. ''' self.conn.list_principal_policies.side_effect = \ ClientError(error_content, 'list_principal_policies') result = boto_iot.list_principal_policies(principal='us-east-1:GUID-GUID-GUID', **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('list_principal_policies')) def test_that_when_attach_principal_policy_succeeds_the_attach_principal_policy_method_returns_true(self): ''' tests True policy attached. ''' result = boto_iot.attach_principal_policy(policyName='testpolicy', principal='us-east-1:GUID-GUID-GUID', **conn_parameters) self.assertTrue(result['attached']) def test_that_when_attach_principal_policy_version_fails_the_attach_principal_policy_version_method_returns_error(self): ''' tests False policy version error. ''' self.conn.attach_principal_policy.side_effect = \ ClientError(error_content, 'attach_principal_policy') result = boto_iot.attach_principal_policy(policyName='testpolicy', principal='us-east-1:GUID-GUID-GUID', **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('attach_principal_policy')) def test_that_when_detach_principal_policy_succeeds_the_detach_principal_policy_method_returns_true(self): ''' tests True policy detached. ''' result = boto_iot.detach_principal_policy(policyName='testpolicy', principal='us-east-1:GUID-GUID-GUID', **conn_parameters) self.assertTrue(result['detached']) def test_that_when_detach_principal_policy_version_fails_the_detach_principal_policy_version_method_returns_error(self): ''' tests False policy version error. ''' self.conn.detach_principal_policy.side_effect = \ ClientError(error_content, 'detach_principal_policy') result = boto_iot.detach_principal_policy(policyName='testpolicy', principal='us-east-1:GUID-GUID-GUID', **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('detach_principal_policy')) @skipIf(HAS_BOTO is False, 'The boto module must be installed.') @skipIf(_has_required_boto() is False, 'The boto3 module must be greater than' ' or equal to version {0}' .format(required_boto3_version)) @skipIf(NO_MOCK, NO_MOCK_REASON) class BotoIoTTopicRuleTestCase(BotoIoTTestCaseBase, BotoIoTTestCaseMixin): ''' TestCase for salt.modules.boto_iot module ''' def test_that_when_checking_if_a_topic_rule_exists_and_a_topic_rule_exists_the_topic_rule_exists_method_returns_true(self): ''' Tests checking iot topic_rule existence when the iot topic_rule already exists ''' self.conn.get_topic_rule.return_value = {'rule': topic_rule_ret} result = boto_iot.topic_rule_exists(ruleName=topic_rule_ret['ruleName'], **conn_parameters) self.assertTrue(result['exists']) def test_that_when_checking_if_a_rule_exists_and_a_rule_does_not_exist_the_topic_rule_exists_method_returns_false(self): ''' Tests checking iot rule existence when the iot rule does not exist ''' self.conn.get_topic_rule.side_effect = topic_rule_not_found_error result = boto_iot.topic_rule_exists(ruleName='mypolicy', **conn_parameters) self.assertFalse(result['exists']) def test_that_when_checking_if_a_topic_rule_exists_and_boto3_returns_an_error_the_topic_rule_exists_method_returns_error(self): ''' Tests checking iot topic_rule existence when boto returns an error ''' self.conn.get_topic_rule.side_effect = ClientError(error_content, 'get_topic_rule') result = boto_iot.topic_rule_exists(ruleName='myrule', **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('get_topic_rule')) def test_that_when_creating_a_topic_rule_succeeds_the_create_topic_rule_method_returns_true(self): ''' tests True topic_rule created. ''' self.conn.create_topic_rule.return_value = topic_rule_ret result = boto_iot.create_topic_rule(ruleName=topic_rule_ret['ruleName'], sql=topic_rule_ret['sql'], description=topic_rule_ret['description'], actions=topic_rule_ret['actions'], **conn_parameters) self.assertTrue(result['created']) def test_that_when_creating_a_topic_rule_fails_the_create_topic_rule_method_returns_error(self): ''' tests False topic_rule not created. ''' self.conn.create_topic_rule.side_effect = ClientError(error_content, 'create_topic_rule') result = boto_iot.create_topic_rule(ruleName=topic_rule_ret['ruleName'], sql=topic_rule_ret['sql'], description=topic_rule_ret['description'], actions=topic_rule_ret['actions'], **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('create_topic_rule')) def test_that_when_replacing_a_topic_rule_succeeds_the_replace_topic_rule_method_returns_true(self): ''' tests True topic_rule replaced. ''' self.conn.replace_topic_rule.return_value = topic_rule_ret result = boto_iot.replace_topic_rule(ruleName=topic_rule_ret['ruleName'], sql=topic_rule_ret['sql'], description=topic_rule_ret['description'], actions=topic_rule_ret['actions'], **conn_parameters) self.assertTrue(result['replaced']) def test_that_when_replacing_a_topic_rule_fails_the_replace_topic_rule_method_returns_error(self): ''' tests False topic_rule not replaced. ''' self.conn.replace_topic_rule.side_effect = ClientError(error_content, 'replace_topic_rule') result = boto_iot.replace_topic_rule(ruleName=topic_rule_ret['ruleName'], sql=topic_rule_ret['sql'], description=topic_rule_ret['description'], actions=topic_rule_ret['actions'], **conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('replace_topic_rule')) def test_that_when_deleting_a_topic_rule_succeeds_the_delete_topic_rule_method_returns_true(self): ''' tests True topic_rule deleted. ''' result = boto_iot.delete_topic_rule(ruleName='testrule', **conn_parameters) self.assertTrue(result['deleted']) def test_that_when_deleting_a_topic_rule_fails_the_delete_topic_rule_method_returns_false(self): ''' tests False topic_rule not deleted. ''' self.conn.delete_topic_rule.side_effect = ClientError(error_content, 'delete_topic_rule') result = boto_iot.delete_topic_rule(ruleName='testrule', **conn_parameters) self.assertFalse(result['deleted']) def test_that_when_describing_topic_rule_it_returns_the_dict_of_properties_returns_true(self): ''' Tests describing parameters if topic_rule exists ''' self.conn.get_topic_rule.return_value = {'rule': topic_rule_ret} result = boto_iot.describe_topic_rule(ruleName=topic_rule_ret['ruleName'], **conn_parameters) self.assertTrue(result['rule']) def test_that_when_describing_topic_rule_on_client_error_it_returns_error(self): ''' Tests describing parameters failure ''' self.conn.get_topic_rule.side_effect = ClientError(error_content, 'get_topic_rule') result = boto_iot.describe_topic_rule(ruleName='testrule', **conn_parameters) self.assertTrue('error' in result) def test_that_when_listing_topic_rules_succeeds_the_list_topic_rules_method_returns_true(self): ''' tests True topic_rules listed. ''' self.conn.list_topic_rules.return_value = {'rules': [topic_rule_ret]} result = boto_iot.list_topic_rules(**conn_parameters) self.assertTrue(result['rules']) def test_that_when_listing_topic_rules_fails_the_list_topic_rules_method_returns_error(self): ''' tests False policy error. ''' self.conn.list_topic_rules.side_effect = ClientError(error_content, 'list_topic_rules') result = boto_iot.list_topic_rules(**conn_parameters) self.assertEqual(result.get('error', {}).get('message'), error_message.format('list_topic_rules')) if __name__ == '__main__': from integration import run_tests # pylint: disable=import-error run_tests(BotoIoTPolicyTestCase, needs_daemon=False) run_tests(BotoIoTTopicRuleTestCase, needs_daemon=False)