salt/tests/unit/proxy/test_esxcluster.py

# -*- coding: utf-8 -*-
'''
    :codeauthor: :email:`Alexandru Bleotu <alexandru.bleotu@morganstanley.com>`

    Tests for esxcluster proxy
'''

# Import Python Libs
from __future__ import absolute_import, print_function, unicode_literals

# Import external libs
try:
    import jsonschema
    HAS_JSONSCHEMA = True
except ImportError:
    HAS_JSONSCHEMA = False

# Import Salt Libs
import salt.proxy.esxcluster as esxcluster
import salt.exceptions
from salt.config.schemas.esxcluster import EsxclusterProxySchema

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


@skipIf(not HAS_JSONSCHEMA, 'jsonschema is required')
class InitTestCase(TestCase, LoaderModuleMockMixin):
    '''Tests for salt.proxy.esxcluster.init'''
    def setup_loader_modules(self):
        return {esxcluster: {'__virtual__':
                             MagicMock(return_value='esxcluster'),
                             'DETAILS': {}, '__pillar__': {}}}

    def setUp(self):
        self.opts_userpass = {'proxy': {'proxytype': 'esxcluster',
                                        'vcenter': 'fake_vcenter',
                                        'datacenter': 'fake_dc',
                                        'cluster': 'fake_cluster',
                                        'mechanism': 'userpass',
                                        'username': 'fake_username',
                                        'passwords': ['fake_password'],
                                        'protocol': 'fake_protocol',
                                        'port': 100}}
        self.opts_sspi = {'proxy': {'proxytype': 'esxcluster',
                                    'vcenter': 'fake_vcenter',
                                    'datacenter': 'fake_dc',
                                    'cluster': 'fake_cluster',
                                    'mechanism': 'sspi',
                                    'domain': 'fake_domain',
                                    'principal': 'fake_principal',
                                    'protocol': 'fake_protocol',
                                    'port': 100}}
        patches = (('salt.proxy.esxcluster.merge',
                    MagicMock(return_value=self.opts_sspi['proxy'])),)
        for mod, mock in patches:
            patcher = patch(mod, mock)
            patcher.start()
            self.addCleanup(patcher.stop)

    def test_merge(self):
        mock_pillar_proxy = MagicMock()
        mock_opts_proxy = MagicMock()
        mock_merge = MagicMock(return_value=self.opts_sspi['proxy'])
        with patch.dict(esxcluster.__pillar__,
                        {'proxy': mock_pillar_proxy}):
            with patch('salt.proxy.esxcluster.merge', mock_merge):
                esxcluster.init(opts={'proxy': mock_opts_proxy})
        mock_merge.assert_called_once_with(mock_opts_proxy, mock_pillar_proxy)

    def test_esxcluster_schema(self):
        mock_json_validate = MagicMock()
        serialized_schema = EsxclusterProxySchema().serialize()
        with patch('salt.proxy.esxcluster.jsonschema.validate',
                   mock_json_validate):
            esxcluster.init(self.opts_sspi)
        mock_json_validate.assert_called_once_with(
            self.opts_sspi['proxy'], serialized_schema)

    def test_invalid_proxy_input_error(self):
        with patch('salt.proxy.esxcluster.jsonschema.validate',
                   MagicMock(side_effect=jsonschema.exceptions.ValidationError(
                       'Validation Error'))):
            with self.assertRaises(salt.exceptions.InvalidConfigError) as \
                    excinfo:
                esxcluster.init(self.opts_userpass)
        self.assertEqual(excinfo.exception.strerror,
                         'Validation Error')

    def test_no_username(self):
        opts = self.opts_userpass.copy()
        del opts['proxy']['username']
        with patch('salt.proxy.esxcluster.merge',
                   MagicMock(return_value=opts['proxy'])):
            with self.assertRaises(salt.exceptions.InvalidConfigError) as \
                    excinfo:
                esxcluster.init(opts)
        self.assertEqual(excinfo.exception.strerror,
                         'Mechanism is set to \'userpass\', but no '
                         '\'username\' key found in proxy config.')

    def test_no_passwords(self):
        opts = self.opts_userpass.copy()
        del opts['proxy']['passwords']
        with patch('salt.proxy.esxcluster.merge',
                   MagicMock(return_value=opts['proxy'])):
            with self.assertRaises(salt.exceptions.InvalidConfigError) as \
                    excinfo:
                esxcluster.init(opts)
        self.assertEqual(excinfo.exception.strerror,
                         'Mechanism is set to \'userpass\', but no '
                         '\'passwords\' key found in proxy config.')

    def test_no_domain(self):
        opts = self.opts_sspi.copy()
        del opts['proxy']['domain']
        with patch('salt.proxy.esxcluster.merge',
                   MagicMock(return_value=opts['proxy'])):
            with self.assertRaises(salt.exceptions.InvalidConfigError) as \
                    excinfo:
                esxcluster.init(opts)
        self.assertEqual(excinfo.exception.strerror,
                         'Mechanism is set to \'sspi\', but no '
                         '\'domain\' key found in proxy config.')

    def test_no_principal(self):
        opts = self.opts_sspi.copy()
        del opts['proxy']['principal']
        with patch('salt.proxy.esxcluster.merge',
                   MagicMock(return_value=opts['proxy'])):
            with self.assertRaises(salt.exceptions.InvalidConfigError) as \
                    excinfo:
                esxcluster.init(opts)
        self.assertEqual(excinfo.exception.strerror,
                         'Mechanism is set to \'sspi\', but no '
                         '\'principal\' key found in proxy config.')

    def test_find_credentials(self):
        mock_find_credentials = MagicMock(return_value=('fake_username',
                                                        'fake_password'))
        with patch('salt.proxy.esxcluster.merge',
                   MagicMock(return_value=self.opts_userpass['proxy'])):
            with patch('salt.proxy.esxcluster.find_credentials',
                       mock_find_credentials):
                esxcluster.init(self.opts_userpass)
        mock_find_credentials.assert_called_once_with()

    def test_details_userpass(self):
        mock_find_credentials = MagicMock(return_value=('fake_username',
                                                        'fake_password'))
        with patch('salt.proxy.esxcluster.merge',
                   MagicMock(return_value=self.opts_userpass['proxy'])):
            with patch('salt.proxy.esxcluster.find_credentials',
                       mock_find_credentials):
                esxcluster.init(self.opts_userpass)
        self.assertDictEqual(esxcluster.DETAILS,
                             {'vcenter': 'fake_vcenter',
                              'datacenter': 'fake_dc',
                              'cluster': 'fake_cluster',
                              'mechanism': 'userpass',
                              'username': 'fake_username',
                              'password': 'fake_password',
                              'passwords': ['fake_password'],
                              'protocol': 'fake_protocol',
                              'port': 100})

    def test_details_sspi(self):
        esxcluster.init(self.opts_sspi)
        self.assertDictEqual(esxcluster.DETAILS,
                             {'vcenter': 'fake_vcenter',
                              'datacenter': 'fake_dc',
                              'cluster': 'fake_cluster',
                              'mechanism': 'sspi',
                              'domain': 'fake_domain',
                              'principal': 'fake_principal',
                              'protocol': 'fake_protocol',
                              'port': 100})