salt/tests/unit/modules/test_boto_cognitoidentity.py

# -*- coding: utf-8 -*-

# Import Python libs
from __future__ import absolute_import, print_function, unicode_literals
import logging
import random
import string

# Import Salt Testing libs
from tests.support.mixins import LoaderModuleMockMixin
from tests.support.unit import skipIf, TestCase
from tests.support.mock import MagicMock, patch

# Import Salt libs
import salt.config
import salt.loader
from salt.utils.versions import LooseVersion
import salt.modules.boto_cognitoidentity as boto_cognitoidentity

# Import 3rd-party libs

# pylint: disable=import-error,no-name-in-module
try:
    import boto3
    from botocore.exceptions import ClientError
    HAS_BOTO = True
except ImportError:
    HAS_BOTO = False

from salt.ext.six.moves import range  # pylint: disable=import-error

# pylint: enable=import-error,no-name-in-module

# the boto_lambda 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'
error_content = {
  'Error': {
    'Code': 101,
    'Message': "Test-defined error"
  }
}

first_pool_id = 'first_pool_id'
first_pool_name = 'first_pool'
second_pool_id = 'second_pool_id'
second_pool_name = 'second_pool'
second_pool_name_updated = 'second_pool_updated'
third_pool_id = 'third_pool_id'
third_pool_name = first_pool_name

identity_pools_ret = dict(IdentityPools=[dict(IdentityPoolId=first_pool_id,
                                              IdentityPoolName=first_pool_name),
                                         dict(IdentityPoolId=second_pool_id,
                                              IdentityPoolName=second_pool_name),
                                         dict(IdentityPoolId=third_pool_id,
                                              IdentityPoolName=third_pool_name)])

first_pool_ret = dict(IdentityPoolId=first_pool_id,
                      IdentityPoolName=first_pool_name,
                      AllowUnauthenticatedIdentities=False,
                      SupportedLoginProviders={'accounts.google.com': 'testing123',
                                               'api.twitter.com': 'testing123',
                                               'graph.facebook.com': 'testing123',
                                               'www.amazon.com': 'testing123'},
                      DeveloperProviderName='test_provider',
                      OpenIdConnectProviderARNs=['some_provider_arn',
                                                 'another_provider_arn'])

first_pool_role_ret = dict(IdentityPoolId=first_pool_id,
                           Roles=dict(authenticated='first_pool_auth_role',
                                      unauthenticated='first_pool_unauth_role'))

second_pool_ret = dict(IdentityPoolId=second_pool_id,
                       IdentityPoolName=second_pool_name,
                       AllowUnauthenticatedIdentities=False)

third_pool_ret = dict(IdentityPoolId=third_pool_id,
                      IdentityPoolName=third_pool_name,
                      AllowUnauthenticatedIdentities=False,
                      DeveloperProviderName='test_provider2')

third_pool_role_ret = dict(IdentityPoolId=third_pool_id)

default_pool_ret = dict(IdentityPoolId='default_pool_id',
                        IdentityPoolName='default_pool_name',
                        AllowUnauthenticatedIdentities=False,
                        DeveloperProviderName='test_provider_default')

default_pool_role_ret = dict(IdentityPoolId='default_pool_id')

log = logging.getLogger(__name__)


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 BotoCognitoIdentityTestCaseBase(TestCase, LoaderModuleMockMixin):
    conn = None

    def setup_loader_modules(self):
        self.opts = opts = salt.config.DEFAULT_MINION_OPTS
        utils = salt.loader.utils(
            opts,
            whitelist=['boto3', 'args', 'systemd', 'path', 'platform'],
            context={})
        return {boto_cognitoidentity: {'__utils__': utils}}

    def setUp(self):
        super(BotoCognitoIdentityTestCaseBase, self).setUp()
        boto_cognitoidentity.__init__(self.opts)
        del self.opts

        # Set up MagicMock to replace the boto3 session
        # connections keep getting cached from prior tests, can't find the
        # correct context object to clear it. So randomize the cache key, to prevent any
        # cache hits
        conn_parameters['key'] = ''.join(random.choice(string.ascii_lowercase + string.digits) for _ in range(50))

        self.patcher = patch('boto3.session.Session')
        self.addCleanup(self.patcher.stop)
        self.addCleanup(delattr, self, 'patcher')
        mock_session = self.patcher.start()

        session_instance = mock_session.return_value
        self.conn = MagicMock()
        self.addCleanup(delattr, self, 'conn')
        session_instance.client.return_value = self.conn


class BotoCognitoIdentityTestCaseMixin(object):
    pass


@skipIf(True, 'Skip these tests while investigating failures')
@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))
class BotoCognitoIdentityTestCase(BotoCognitoIdentityTestCaseBase, BotoCognitoIdentityTestCaseMixin):
    '''
    TestCase for salt.modules.boto_cognitoidentity module
    '''

    def _describe_identity_pool_side_effect(self, *args, **kwargs):
        if kwargs.get('IdentityPoolId') == first_pool_id:
            return first_pool_ret
        elif kwargs.get('IdentityPoolId') == third_pool_id:
            return third_pool_ret
        else:
            return default_pool_ret

    def test_that_when_describing_a_named_identity_pool_and_pool_exists_the_describe_identity_pool_method_returns_pools_properties(self):
        '''
        Tests describing identity pool when the pool's name exists
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        self.conn.describe_identity_pool.side_effect = self._describe_identity_pool_side_effect
        result = boto_cognitoidentity.describe_identity_pools(IdentityPoolName=first_pool_name, **conn_parameters)
        self.assertEqual(result.get('identity_pools'), [first_pool_ret, third_pool_ret])

    def test_that_when_describing_a_identity_pool_by_its_id_and_pool_exists_the_desribe_identity_pool_method_returns_pools_properties(self):
        '''
        Tests describing identity pool when the given pool's id exists
        '''
        self.conn.describe_identity_pool.return_value = third_pool_ret
        result = boto_cognitoidentity.describe_identity_pools(IdentityPoolName='', IdentityPoolId=third_pool_id, **conn_parameters)
        self.assertEqual(result.get('identity_pools'), [third_pool_ret])
        self.assertTrue(self.conn.list_identity_pools.call_count == 0)

    def test_that_when_describing_a_named_identity_pool_and_pool_does_not_exist_the_describe_identity_pool_method_returns_none(self):
        '''
        Tests describing identity pool when the pool's name doesn't exist
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        self.conn.describe_identity_pool.return_value = first_pool_ret
        result = boto_cognitoidentity.describe_identity_pools(IdentityPoolName='no_such_pool', **conn_parameters)
        self.assertEqual(result.get('identity_pools', 'no such key'), None)

    def test_that_when_describing_a_named_identity_pool_and_error_thrown_the_describe_identity_pool_method_returns_error(self):
        '''
        Tests describing identity pool returns error when there is an exception to boto3 calls
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        self.conn.describe_identity_pool.side_effect = ClientError(error_content, 'error on describe identity pool')
        result = boto_cognitoidentity.describe_identity_pools(IdentityPoolName=first_pool_name, **conn_parameters)
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('error on describe identity pool'))

    def test_that_when_create_identity_pool_the_create_identity_pool_method_returns_created_identity_pool(self):
        '''
        Tests the positive case where create identity pool succeeds
        '''
        return_val = default_pool_ret.copy()
        return_val.pop('DeveloperProviderName', None)
        self.conn.create_identity_pool.return_value = return_val
        result = boto_cognitoidentity.create_identity_pool(IdentityPoolName='default_pool_name', **conn_parameters)
        mock_calls = self.conn.mock_calls
        #name, args, kwargs = mock_calls[0]
        self.assertTrue(result.get('created'))
        self.assertEqual(len(mock_calls), 1)
        self.assertEqual(mock_calls[0][0], 'create_identity_pool')
        self.assertNotIn('DeveloperProviderName', mock_calls[0][2])

    def test_that_when_create_identity_pool_and_error_thrown_the_create_identity_pool_method_returns_error(self):
        '''
        Tests the negative case where create identity pool has a boto3 client error
        '''
        self.conn.create_identity_pool.side_effect = ClientError(error_content, 'create_identity_pool')
        result = boto_cognitoidentity.create_identity_pool(IdentityPoolName='default_pool_name', **conn_parameters)
        self.assertIs(result.get('created'), False)
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('create_identity_pool'))

    def test_that_when_delete_identity_pools_with_multiple_matching_pool_names_the_delete_identity_pools_methos_returns_true_and_deleted_count(self):
        '''
        Tests that given 2 matching pool ids, the operation returns deleted status of true and
        count 2
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        self.conn.delete_identity_pool.return_value = None
        result = boto_cognitoidentity.delete_identity_pools(IdentityPoolName=first_pool_name, **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertTrue(result.get('deleted'))
        self.assertEqual(result.get('count'), 2)
        self.assertEqual(len(mock_calls), 3)
        self.assertEqual(mock_calls[1][0], 'delete_identity_pool')
        self.assertEqual(mock_calls[2][0], 'delete_identity_pool')
        self.assertEqual(mock_calls[1][2].get('IdentityPoolId'), first_pool_id)
        self.assertEqual(mock_calls[2][2].get('IdentityPoolId'), third_pool_id)

    def test_that_when_delete_identity_pools_with_no_matching_pool_names_the_delete_identity_pools_method_returns_false(self):
        '''
        Tests that the given pool name does not exist, the operation returns deleted status of false
        and count 0
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        result = boto_cognitoidentity.delete_identity_pools(IdentityPoolName='no_such_pool_name', **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertIs(result.get('deleted'), False)
        self.assertEqual(result.get('count'), 0)
        self.assertEqual(len(mock_calls), 1)

    def test_that_when_delete_identity_pools_and_error_thrown_the_delete_identity_pools_method_returns_false_and_the_error(self):
        '''
        Tests that the delete_identity_pool method throws an exception
        '''
        self.conn.delete_identity_pool.side_effect = ClientError(error_content, 'delete_identity_pool')
        # try to delete an unexistent pool id "no_such_pool_id"
        result = boto_cognitoidentity.delete_identity_pools(IdentityPoolName=first_pool_name, IdentityPoolId='no_such_pool_id', **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertIs(result.get('deleted'), False)
        self.assertIs(result.get('count'), None)
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('delete_identity_pool'))
        self.assertEqual(len(mock_calls), 1)

    def _get_identity_pool_roles_side_effect(self, *args, **kwargs):
        if kwargs.get('IdentityPoolId') == first_pool_id:
            return first_pool_role_ret
        elif kwargs.get('IdentityPoolId') == third_pool_id:
            return third_pool_role_ret
        else:
            return default_pool_role_ret

    def test_that_when_get_identity_pool_roles_with_matching_pool_names_the_get_identity_pool_roles_method_returns_pools_role_properties(self):
        '''
        Tests that the given 2 pool id's matching the given pool name, the results are
        passed through as a list of identity_pool_roles
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        self.conn.get_identity_pool_roles.side_effect = self._get_identity_pool_roles_side_effect
        result = boto_cognitoidentity.get_identity_pool_roles(IdentityPoolName=first_pool_name, **conn_parameters)
        id_pool_roles = result.get('identity_pool_roles')
        self.assertIsNot(id_pool_roles, None)
        self.assertEqual(result.get('error', 'key_should_not_be_there'), 'key_should_not_be_there')
        self.assertEqual(len(id_pool_roles), 2)
        self.assertEqual(id_pool_roles[0], first_pool_role_ret)
        self.assertEqual(id_pool_roles[1], third_pool_role_ret)

    def test_that_when_get_identity_pool_roles_with_no_matching_pool_names_the_get_identity_pool_roles_method_returns_none(self):
        '''
        Tests that the given no pool id's matching the given pool name, the results returned is
        None and get_identity_pool_roles should never be called
        '''
        self.conn.list_identity_pools.return_value = identity_pools_ret
        result = boto_cognitoidentity.get_identity_pool_roles(IdentityPoolName="no_such_pool_name", **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertIs(result.get('identity_pool_roles', 'key_should_be_there'), None)
        self.assertEqual(len(mock_calls), 1)
        self.assertEqual(result.get('error', 'key_should_not_be_there'), 'key_should_not_be_there')

    def test_that_when_get_identity_pool_roles_and_error_thrown_due_to_invalid_pool_id_the_get_identity_pool_roles_method_returns_error(self):
        '''
        Tests that given an invalid pool id, we properly handle error generated from get_identity_pool_roles
        '''
        self.conn.get_identity_pool_roles.side_effect = ClientError(error_content, 'get_identity_pool_roles')
        # try to delete an unexistent pool id "no_such_pool_id"
        result = boto_cognitoidentity.get_identity_pool_roles(IdentityPoolName='', IdentityPoolId='no_such_pool_id', **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('get_identity_pool_roles'))
        self.assertEqual(len(mock_calls), 1)

    def test_that_when_set_identity_pool_roles_with_invalid_pool_id_the_set_identity_pool_roles_method_returns_set_false_and_error(self):
        '''
        Tests that given an invalid pool id, we properly handle error generated from set_identity_pool_roles
        '''
        self.conn.set_identity_pool_roles.side_effect = ClientError(error_content, 'set_identity_pool_roles')
        result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='no_such_pool_id', **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertIs(result.get('set'), False)
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('set_identity_pool_roles'))
        self.assertEqual(len(mock_calls), 1)

    def test_that_when_set_identity_pool_roles_with_no_roles_specified_the_set_identity_pool_roles_method_unset_the_roles(self):
        '''
        Tests that given a valid pool id, and no other roles given, the role for the pool is cleared.
        '''
        self.conn.set_identity_pool_roles.return_value = None
        result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='some_id', **conn_parameters)
        mock_calls = self.conn.mock_calls
        self.assertTrue(result.get('set'))
        self.assertEqual(len(mock_calls), 1)
        self.assertEqual(mock_calls[0][2].get('Roles'), {})

    def test_that_when_set_identity_pool_roles_with_only_auth_role_specified_the_set_identity_pool_roles_method_only_set_the_auth_role(self):
        '''
        Tests that given a valid pool id, and only other given role is the AuthenticatedRole, the auth role for the
        pool is set and unauth role is cleared.
        '''
        self.conn.set_identity_pool_roles.return_value = None
        with patch.dict(boto_cognitoidentity.__salt__, {'boto_iam.describe_role': MagicMock(return_value={'arn': 'my_auth_role_arn'})}):
            expected_roles = dict(authenticated='my_auth_role_arn')
            result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='some_id', AuthenticatedRole='my_auth_role', **conn_parameters)
            mock_calls = self.conn.mock_calls
            self.assertTrue(result.get('set'))
            self.assertEqual(len(mock_calls), 1)
            self.assertEqual(mock_calls[0][2].get('Roles'), expected_roles)

    def test_that_when_set_identity_pool_roles_with_only_unauth_role_specified_the_set_identity_pool_roles_method_only_set_the_unauth_role(self):
        '''
        Tests that given a valid pool id, and only other given role is the UnauthenticatedRole, the unauth role for the
        pool is set and the auth role is cleared.
        '''
        self.conn.set_identity_pool_roles.return_value = None
        with patch.dict(boto_cognitoidentity.__salt__, {'boto_iam.describe_role': MagicMock(return_value={'arn': 'my_unauth_role_arn'})}):
            expected_roles = dict(unauthenticated='my_unauth_role_arn')
            result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='some_id', UnauthenticatedRole='my_unauth_role', **conn_parameters)
            mock_calls = self.conn.mock_calls
            self.assertTrue(result.get('set'))
            self.assertEqual(len(mock_calls), 1)
            self.assertEqual(mock_calls[0][2].get('Roles'), expected_roles)

    def test_that_when_set_identity_pool_roles_with_both_roles_specified_the_set_identity_pool_role_method_set_both_roles(self):
        '''
        Tests setting of both roles to valid given roles
        '''
        self.conn.set_identity_pool_roles.return_value = None
        with patch.dict(boto_cognitoidentity.__salt__, {'boto_iam.describe_role': MagicMock(return_value={'arn': 'my_unauth_role_arn'})}):
            expected_roles = dict(authenticated='arn:aws:iam:my_auth_role',
                                  unauthenticated='my_unauth_role_arn')
            result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='some_id', AuthenticatedRole='arn:aws:iam:my_auth_role', UnauthenticatedRole='my_unauth_role', **conn_parameters)
            mock_calls = self.conn.mock_calls
            self.assertTrue(result.get('set'))
            self.assertEqual(len(mock_calls), 1)
            self.assertEqual(mock_calls[0][2].get('Roles'), expected_roles)

    def test_that_when_set_identity_pool_roles_given_invalid_auth_role_the_set_identity_pool_method_returns_set_false_and_error(self):
        '''
        Tests error handling for invalid auth role
        '''
        with patch.dict(boto_cognitoidentity.__salt__, {'boto_iam.describe_role': MagicMock(return_value=False)}):
            result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='some_id', AuthenticatedRole='no_such_auth_role', **conn_parameters)
            mock_calls = self.conn.mock_calls
            self.assertIs(result.get('set'), False)
            self.assertIn('no_such_auth_role', result.get('error', ''))
            self.assertEqual(len(mock_calls), 0)

    def test_that_when_set_identity_pool_roles_given_invalid_unauth_role_the_set_identity_pool_method_returns_set_false_and_error(self):
        '''
        Tests error handling for invalid unauth role
        '''
        with patch.dict(boto_cognitoidentity.__salt__, {'boto_iam.describe_role': MagicMock(return_value=False)}):
            result = boto_cognitoidentity.set_identity_pool_roles(IdentityPoolId='some_id', AuthenticatedRole='arn:aws:iam:my_auth_role', UnauthenticatedRole='no_such_unauth_role', **conn_parameters)
            mock_calls = self.conn.mock_calls
            self.assertIs(result.get('set'), False)
            self.assertIn('no_such_unauth_role', result.get('error', ''))
            self.assertEqual(len(mock_calls), 0)

    def test_that_when_update_identity_pool_given_invalid_pool_id_the_update_identity_pool_method_returns_updated_false_and_error(self):
        '''
        Tests error handling for invalid pool id
        '''
        self.conn.describe_identity_pool.side_effect = ClientError(error_content, 'error on describe identity pool with pool id')
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId='no_such_pool_id', **conn_parameters)
        self.assertIs(result.get('updated'), False)
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('error on describe identity pool with pool id'))

    def test_that_when_update_identity_pool_given_only_valid_pool_id_the_update_identity_pool_method_returns_udpated_identity(self):
        '''
        Tests the base case of calling update_identity_pool with only the pool id, verify
        that the passed parameters into boto3 update_identity_pool has at least all the
        expected required parameters in IdentityPoolId, IdentityPoolName and AllowUnauthenticatedIdentities
        '''
        self.conn.describe_identity_pool.return_value = second_pool_ret
        self.conn.update_identity_pool.return_value = second_pool_ret
        expected_params = second_pool_ret
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=second_pool_id, **conn_parameters)
        self.assertTrue(result.get('updated'))
        self.assertEqual(result.get('identity_pool'), second_pool_ret)
        self.conn.update_identity_pool.assert_called_with(**expected_params)

    def test_that_when_update_identity_pool_given_valid_pool_id_and_pool_name_the_update_identity_pool_method_returns_updated_identity_pool(self):
        '''
        Tests successful update of a pool's name
        '''
        self.conn.describe_identity_pool.return_value = second_pool_ret
        second_pool_updated_ret = second_pool_ret.copy()
        second_pool_updated_ret['IdentityPoolName'] = second_pool_name_updated
        self.conn.update_identity_pool.return_value = second_pool_updated_ret
        expected_params = second_pool_updated_ret
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=second_pool_id, IdentityPoolName=second_pool_name_updated, **conn_parameters)
        self.assertTrue(result.get('updated'))
        self.assertEqual(result.get('identity_pool'), second_pool_updated_ret)
        self.conn.update_identity_pool.assert_called_with(**expected_params)

    def test_that_when_update_identity_pool_given_empty_dictionary_for_supported_login_providers_the_update_identity_pool_method_is_called_with_proper_request_params(self):
        '''
        Tests the request parameters to boto3 update_identity_pool's AllowUnauthenticatedIdentities is {}
        '''
        self.conn.describe_identity_pool.return_value = first_pool_ret
        first_pool_updated_ret = first_pool_ret.copy()
        first_pool_updated_ret.pop('SupportedLoginProviders')
        self.conn.update_identity_pool.return_value = first_pool_updated_ret
        expected_params = first_pool_ret.copy()
        expected_params['SupportedLoginProviders'] = {}
        expected_params.pop('DeveloperProviderName')
        expected_params.pop('OpenIdConnectProviderARNs')
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=first_pool_id, SupportedLoginProviders={}, **conn_parameters)
        self.assertTrue(result.get('updated'))
        self.assertEqual(result.get('identity_pool'), first_pool_updated_ret)
        self.conn.update_identity_pool.assert_called_with(**expected_params)

    def test_that_when_update_identity_pool_given_empty_list_for_openid_connect_provider_arns_the_update_identity_pool_method_is_called_with_proper_request_params(self):
        '''
        Tests the request parameters to boto3 update_identity_pool's OpenIdConnectProviderARNs is []
        '''
        self.conn.describe_identity_pool.return_value = first_pool_ret
        first_pool_updated_ret = first_pool_ret.copy()
        first_pool_updated_ret.pop('OpenIdConnectProviderARNs')
        self.conn.update_identity_pool.return_value = first_pool_updated_ret
        expected_params = first_pool_ret.copy()
        expected_params.pop('SupportedLoginProviders')
        expected_params.pop('DeveloperProviderName')
        expected_params['OpenIdConnectProviderARNs'] = []
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=first_pool_id, OpenIdConnectProviderARNs=[], **conn_parameters)
        self.assertTrue(result.get('updated'))
        self.assertEqual(result.get('identity_pool'), first_pool_updated_ret)
        self.conn.update_identity_pool.assert_called_with(**expected_params)

    def test_that_when_update_identity_pool_given_developer_provider_name_when_developer_provider_name_was_set_previously_the_udpate_identity_pool_method_is_called_without_developer_provider_name_param(self):
        '''
        Tests the request parameters do not include 'DeveloperProviderName' if this was previously set
        for the given pool id
        '''
        self.conn.describe_identity_pool.return_value = first_pool_ret
        self.conn.update_identity_pool.return_value = first_pool_ret
        expected_params = first_pool_ret.copy()
        expected_params.pop('SupportedLoginProviders')
        expected_params.pop('DeveloperProviderName')
        expected_params.pop('OpenIdConnectProviderARNs')
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=first_pool_id, DeveloperProviderName='this should not change', **conn_parameters)
        self.assertTrue(result.get('updated'))
        self.assertEqual(result.get('identity_pool'), first_pool_ret)
        self.conn.update_identity_pool.assert_called_with(**expected_params)

    def test_that_when_update_identity_pool_given_developer_provider_name_is_included_in_the_params_when_associated_for_the_first_time(self):
        '''
        Tests the request parameters include 'DeveloperProviderName' when the pool did not have this
        property set previously.
        '''
        self.conn.describe_identity_pool.return_value = second_pool_ret
        second_pool_updated_ret = second_pool_ret.copy()
        second_pool_updated_ret['DeveloperProviderName'] = 'added_developer_provider'
        self.conn.update_identity_pool.return_value = second_pool_updated_ret
        expected_params = second_pool_updated_ret.copy()
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=second_pool_id, DeveloperProviderName='added_developer_provider', **conn_parameters)
        self.assertTrue(result.get('updated'))
        self.assertEqual(result.get('identity_pool'), second_pool_updated_ret)
        self.conn.update_identity_pool.assert_called_with(**expected_params)

    def test_that_the_update_identity_pool_method_handles_exception_from_boto3(self):
        '''
        Tests the error handling of exception generated by boto3 update_identity_pool
        '''
        self.conn.describe_identity_pool.return_value = second_pool_ret
        second_pool_updated_ret = second_pool_ret.copy()
        second_pool_updated_ret['DeveloperProviderName'] = 'added_developer_provider'
        self.conn.update_identity_pool.side_effect = ClientError(error_content, 'update_identity_pool')
        result = boto_cognitoidentity.update_identity_pool(IdentityPoolId=second_pool_id, DeveloperProviderName='added_developer_provider', **conn_parameters)
        self.assertIs(result.get('updated'), False)
        self.assertEqual(result.get('error', {}).get('message'), error_message.format('update_identity_pool'))