salt/tests/unit/states/test_postgres.py

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

# Import python libs
from __future__ import absolute_import, unicode_literals, print_function

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

# Import salt libs
import salt.modules.postgres as postgresmod
import salt.states.postgres_database as postgres_database
import salt.states.postgres_user as postgres_user
import salt.states.postgres_group as postgres_group
import salt.states.postgres_extension as postgres_extension
import salt.states.postgres_schema as postgres_schema


class PostgresUserTestCase(TestCase, LoaderModuleMockMixin):

    def setup_loader_modules(self):
        patcher = patch('salt.utils.path.which', Mock(return_value='/usr/bin/pgsql'))
        patcher.start()
        self.addCleanup(patcher.stop)
        self.salt_stub = {
            'config.option': Mock(),
            'cmd.run_all': Mock(),
            'file.chown': Mock(),
            'file.remove': Mock(),
        }
        self.addCleanup(delattr, self, 'salt_stub')
        return {
            postgres_database: {},
            postgres_group: {},
            postgres_extension: {},
            postgres_schema: {},
            postgres_user: {
                '__grains__': {'os_family': 'Linux'},
                '__salt__': self.salt_stub,
                '__opts__': {'test': False},
            }
        }

    def test_present__creation(self):
        # test=True
        with patch.dict(postgres_user.__salt__, {'postgres.role_get': Mock(return_value=None),
                                                 'postgres.user_create': MagicMock()}):
            with patch.dict(postgres_user.__opts__, {'test': True}):
                ret = postgres_user.present('foo')
                self.assertEqual(
                    ret,
                    {'comment': 'User foo is set to be created',
                     'changes': {}, 'name': 'foo', 'result': None}
                )
                self.assertEqual(self.salt_stub['postgres.user_create'].call_count, 0)

            # test=False
            ret = postgres_user.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'The user foo has been created',
                 'changes': {'foo': 'Present'}, 'name': 'foo', 'result': True}
            )
            self.salt_stub['postgres.user_create'].assert_called_once_with(username='foo',
                                                                           superuser=None,
                                                                           encrypted=True,
                                                                           runas=None,
                                                                           inherit=None,
                                                                           rolepassword=None,
                                                                           port=None,
                                                                           replication=None,
                                                                           host=None,
                                                                           createroles=None,
                                                                           user=None,
                                                                           groups=None,
                                                                           maintenance_db=None,
                                                                           login=None,
                                                                           password=None,
                                                                           valid_until=None,
                                                                           createdb=None)

    def test_present__update(self):
        # test=True
        with patch.dict(postgres_user.__salt__, {'postgres.role_get': Mock(return_value={
                                                     'can create databases': False,
                                                     'can create roles': False,
                                                     'can login': False,
                                                     'can update system catalogs': False,
                                                     'connections': None,
                                                     'defaults variables': {},
                                                     'expiry time': None,
                                                     'inherits privileges': True,
                                                     'replication': False,
                                                     'superuser': False,
                                                 }),
                                                 'postgres.user_update': MagicMock()}):
            with patch.dict(postgres_user.__opts__, {'test': True}):
                ret = postgres_user.present('foo', login=True, replication=False)
                self.assertEqual(
                    ret,
                    {'comment': 'User foo is set to be updated',
                     'changes': {'foo': {'login': True}}, 'name': 'foo', 'result': None}
                )
                self.assertEqual(self.salt_stub['postgres.user_update'].call_count, 0)

            # test=False
            ret = postgres_user.present('foo', login=True, replication=False)
            self.assertEqual(
                ret,
                {'comment': 'The user foo has been updated',
                 'changes': {'foo': {'login': True}}, 'name': 'foo', 'result': True}
            )
            self.salt_stub['postgres.user_update'].assert_called_once_with(username='foo',
                                                                           superuser=None,
                                                                           encrypted=True,
                                                                           runas=None,
                                                                           inherit=None,
                                                                           rolepassword=None,
                                                                           port=None,
                                                                           replication=False,
                                                                           host=None,
                                                                           createroles=None,
                                                                           user=None,
                                                                           groups=None,
                                                                           maintenance_db=None,
                                                                           login=True,
                                                                           password=None,
                                                                           valid_until=None,
                                                                           createdb=None)

    def test_present__no_update(self):
        # test=True
        with patch.dict(postgres_user.__salt__, {'postgres.role_get': Mock(return_value={
                                                    'can create databases': False,
                                                    'can create roles': False,
                                                    'can login': False,
                                                    'can update system catalogs': False,
                                                    'connections': None,
                                                    'defaults variables': {},
                                                    'expiry time': None,
                                                    'inherits privileges': True,
                                                    'replication': False,
                                                    'superuser': False,
                                                 }),
                                                 'postgres.user_update': MagicMock()}):
            with patch.dict(postgres_user.__opts__, {'test': True}):
                ret = postgres_user.present('foo', login=False, replication=False)
                self.assertEqual(
                    ret,
                    {'comment': 'User foo is already present',
                     'changes': {}, 'name': 'foo', 'result': True}
                )
                self.assertEqual(self.salt_stub['postgres.user_update'].call_count, 0)

            # test=False
            ret = postgres_user.present('foo', login=False, replication=False)
            self.assertEqual(
                ret,
                {'comment': 'User foo is already present',
                 'changes': {}, 'name': 'foo', 'result': True}
            )
            self.assertEqual(self.salt_stub['postgres.user_update'].call_count, 0)


class PostgresGroupTestCase(TestCase, LoaderModuleMockMixin):

    def setup_loader_modules(self):
        patcher = patch('salt.utils.path.which', Mock(return_value='/usr/bin/pgsql'))
        patcher.start()
        self.addCleanup(patcher.stop)
        self.salt_stub = {
            'config.option': Mock(),
            'cmd.run_all': Mock(),
            'file.chown': Mock(),
            'file.remove': Mock(),
        }
        self.addCleanup(delattr, self, 'salt_stub')
        return {
            postgres_database: {},
            postgres_user: {},
            postgres_extension: {},
            postgres_schema: {},
            postgres_group: {
                '__grains__': {'os_family': 'Linux'},
                '__salt__': self.salt_stub,
                '__opts__': {'test': False},
            }
        }

    def test_present__creation(self):
        # test=True
        with patch.dict(postgres_group.__salt__, {'postgres.role_get': Mock(return_value=None),
                                                  'postgres.group_create': MagicMock()}):
            with patch.dict(postgres_group.__opts__, {'test': True}):
                ret = postgres_group.present('foo')
                self.assertEqual(
                    ret,
                    {'comment': 'Group foo is set to be created',
                     'changes': {}, 'name': 'foo', 'result': None}
                )
                self.assertEqual(self.salt_stub['postgres.group_create'].call_count, 0)

            # test=False
            ret = postgres_group.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'The group foo has been created',
                 'changes': {}, 'name': 'foo', 'result': True}
            )
            self.salt_stub['postgres.group_create'].assert_called_once_with(superuser=None,
                                                                            replication=None,
                                                                            encrypted=True,
                                                                            runas=None,
                                                                            inherit=None,
                                                                            rolepassword=None,
                                                                            port=None,
                                                                            groupname='foo',
                                                                            host=None,
                                                                            createroles=None,
                                                                            user=None,
                                                                            groups=None,
                                                                            maintenance_db=None,
                                                                            login=None,
                                                                            password=None,
                                                                            createdb=None)

    def test_present__update(self):
        # test=True
        with patch.dict(postgres_group.__salt__, {'postgres.role_get': Mock(return_value={
                                                    'can create databases': False,
                                                    'can create roles': False,
                                                    'can login': False,
                                                    'can update system catalogs': False,
                                                    'connections': None,
                                                    'defaults variables': {},
                                                    'expiry time': None,
                                                    'inherits privileges': True,
                                                    'replication': False,
                                                    'superuser': False,
                                                 }),
                                                 'postgres.group_update': MagicMock()}):
            with patch.dict(postgres_group.__opts__, {'test': True}):
                ret = postgres_group.present('foo', login=True, replication=False)
                self.assertEqual(
                    ret,
                    {'comment': 'Group foo is set to be updated',
                     'changes': {'foo': {'login': True}}, 'name': 'foo', 'result': None}
                )
                self.assertEqual(self.salt_stub['postgres.group_update'].call_count, 0)

            # test=False
            ret = postgres_group.present('foo', login=True, replication=False)
            self.assertEqual(
                ret,
                {'comment': 'The group foo has been updated',
                 'changes': {'foo': {'login': True}}, 'name': 'foo', 'result': True}
            )
            self.salt_stub['postgres.group_update'].assert_called_once_with(superuser=None,
                                                                       replication=False,
                                                                       encrypted=True,
                                                                       runas=None,
                                                                       inherit=None,
                                                                       rolepassword=None,
                                                                       port=None,
                                                                       groupname='foo',
                                                                       host=None,
                                                                       createroles=None,
                                                                       user=None,
                                                                       groups=None,
                                                                       maintenance_db=None,
                                                                       login=True,
                                                                       password=None,
                                                                       createdb=None)

    def test_present__no_update(self):
        # test=True
        with patch.dict(postgres_group.__salt__, {'postgres.role_get': Mock(return_value={
                                                    'can create databases': False,
                                                    'can create roles': False,
                                                    'can login': False,
                                                    'can update system catalogs': False,
                                                    'connections': None,
                                                    'defaults variables': {},
                                                    'expiry time': None,
                                                    'inherits privileges': True,
                                                    'replication': False,
                                                    'superuser': False,
                                                 }),
                                                 'postgres.group_update': MagicMock()}):
            with patch.dict(postgres_group.__opts__, {'test': True}):
                ret = postgres_group.present('foo', login=False, replication=False)
                self.assertEqual(
                    ret,
                    {'comment': 'Group foo is already present',
                     'changes': {}, 'name': 'foo', 'result': True}
                )
                self.assertEqual(self.salt_stub['postgres.group_update'].call_count, 0)

            # test=False
            ret = postgres_group.present('foo', login=False, replication=False)
            self.assertEqual(
                ret,
                {'comment': 'Group foo is already present',
                 'changes': {}, 'name': 'foo', 'result': True}
            )
            self.assertEqual(self.salt_stub['postgres.group_update'].call_count, 0)


class PostgresExtensionTestCase(TestCase, LoaderModuleMockMixin):

    def setup_loader_modules(self):
        patcher = patch('salt.utils.path.which', Mock(return_value='/usr/bin/pgsql'))
        patcher.start()
        self.addCleanup(patcher.stop)
        self.salt_stub = {
            'config.option': Mock(),
            'cmd.run_all': Mock(),
            'file.chown': Mock(),
            'file.remove': Mock(),
        }
        self.addCleanup(delattr, self, 'salt_stub')
        return {
            postgres_database: {},
            postgres_user: {},
            postgres_group: {},
            postgres_schema: {},
            postgres_extension: {
                '__grains__': {'os_family': 'Linux'},
                '__salt__': self.salt_stub,
                '__opts__': {'test': False},
            }
        }

    def test_present_failed(self):
        '''
        scenario of creating upgrading extensions with possible schema and
        version specifications
        '''
        with patch.dict(postgres_extension.__salt__, {
                    'postgres.create_metadata': Mock(side_effect=[
                        [postgresmod._EXTENSION_NOT_INSTALLED],
                        [postgresmod._EXTENSION_TO_MOVE, postgresmod._EXTENSION_INSTALLED],

                    ]),
                    'postgres.create_extension': Mock(side_effect=[
                        False, False,
                    ])}):
            ret = postgres_extension.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'Failed to install extension foo',
                 'changes': {}, 'name': 'foo', 'result': False},
            )
            ret = postgres_extension.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'Failed to upgrade extension foo',
                 'changes': {}, 'name': 'foo', 'result': False}
            )

    def test_present(self):
        '''
        scenario of creating upgrading extensions with possible schema and
        version specifications
        '''
        with patch.dict(postgres_extension.__salt__, {
                    'postgres.create_metadata': Mock(side_effect=[
                        [postgresmod._EXTENSION_NOT_INSTALLED],
                        [postgresmod._EXTENSION_INSTALLED],
                        [postgresmod._EXTENSION_TO_MOVE, postgresmod._EXTENSION_INSTALLED],

                    ]),
                    'postgres.create_extension': Mock(side_effect=[
                        True, True, True,
                    ])}):
            ret = postgres_extension.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'The extension foo has been installed',
                 'changes': {'foo': 'Installed'}, 'name': 'foo', 'result': True}
            )
            ret = postgres_extension.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'Extension foo is already present',
                 'changes': {}, 'name': 'foo', 'result': True}
            )
            ret = postgres_extension.present('foo')
            self.assertEqual(
                ret,
                {'comment': 'The extension foo has been upgraded',
                 'changes': {'foo': 'Upgraded'}, 'name': 'foo', 'result': True}
            )

    def test_presenttest(self):
        '''
        scenario of creating upgrading extensions with possible schema and
        version specifications
        '''
        with patch.dict(postgres_extension.__salt__, {
                    'postgres.create_metadata': Mock(side_effect=[
                        [postgresmod._EXTENSION_NOT_INSTALLED],
                        [postgresmod._EXTENSION_INSTALLED],
                        [postgresmod._EXTENSION_TO_MOVE, postgresmod._EXTENSION_INSTALLED],

                    ]),
                    'postgres.create_extension': Mock(side_effect=[
                        True, True, True,
                    ])}):
            with patch.dict(postgres_extension.__opts__, {'test': True}):
                ret = postgres_extension.present('foo')
                self.assertEqual(
                    ret,
                    {'comment': 'Extension foo is set to be installed',
                     'changes': {}, 'name': 'foo', 'result': None}

                )
                ret = postgres_extension.present('foo')
                self.assertEqual(
                    ret,
                    {'comment': "Extension foo is already present",
                     'changes': {}, 'name': 'foo', 'result': True}

                )
                ret = postgres_extension.present('foo')
                self.assertEqual(
                    ret,
                    {'comment': "Extension foo is set to be upgraded",
                     'changes': {}, 'name': 'foo', 'result': None}
                )

    def test_absent(self):
        '''
        scenario of creating upgrading extensions with possible schema and
        version specifications
        '''
        with patch.dict(postgres_extension.__salt__, {
                    'postgres.is_installed_extension': Mock(side_effect=[
                        True, False,
                    ]),
                    'postgres.drop_extension': Mock(side_effect=[
                        True, True,
                    ])}):
            ret = postgres_extension.absent('foo')
            self.assertEqual(
                ret,
                {'comment': 'Extension foo has been removed',
                 'changes': {'foo': 'Absent'}, 'name': 'foo', 'result': True}
            )
            ret = postgres_extension.absent('foo')
            self.assertEqual(
                ret,
                {'comment': (
                    'Extension foo is not present, '
                    'so it cannot be removed'),
                 'changes': {}, 'name': 'foo', 'result': True}

            )

    def test_absent_failed(self):
        '''
        scenario of creating upgrading extensions with possible schema and
        version specifications
        '''
        with patch.dict(postgres_extension.__opts__, {'test': False}):
            with patch.dict(postgres_extension.__salt__, {
                        'postgres.is_installed_extension': Mock(side_effect=[
                            True, True,
                        ]),
                        'postgres.drop_extension': Mock(side_effect=[
                            False, False,
                        ])}):
                ret = postgres_extension.absent('foo')
                self.assertEqual(
                    ret,
                    {'comment': 'Extension foo failed to be removed',
                     'changes': {}, 'name': 'foo', 'result': False}
                )

    def test_absent_failedtest(self):
        with patch.dict(postgres_extension.__salt__, {
                    'postgres.is_installed_extension': Mock(side_effect=[
                        True, True,
                    ]),
                    'postgres.drop_extension': Mock(side_effect=[
                        False, False,
                    ])}):
            with patch.dict(postgres_extension.__opts__, {'test': True}):
                ret = postgres_extension.absent('foo')
            self.assertEqual(
                ret,
                {'comment': 'Extension foo is set to be removed',
                 'changes': {}, 'name': 'foo', 'result': None}
            )


class PostgresSchemaTestCase(TestCase, LoaderModuleMockMixin):

    def setup_loader_modules(self):
        patcher = patch('salt.utils.path.which', Mock(return_value='/usr/bin/pgsql'))
        patcher.start()
        self.addCleanup(patcher.stop)
        self.salt_stub = {
            'config.option': Mock(),
            'cmd.run_all': Mock(),
            'file.chown': Mock(),
            'file.remove': Mock(),
        }
        self.addCleanup(delattr, self, 'salt_stub')
        return {
            postgres_database: {},
            postgres_user: {},
            postgres_extension: {},
            postgres_group: {},
            postgres_schema: {
                '__grains__': {'os_family': 'Linux'},
                '__salt__': self.salt_stub,
                '__opts__': {'test': False},
            }
        }

    def test_present_creation(self):
        with patch.dict(postgres_schema.__salt__, {'postgres.schema_get': Mock(return_value=None),
                                                   'postgres.schema_create': MagicMock()}):
            ret = postgres_schema.present('dbname', 'foo')
            self.assertEqual(
                ret,
                {'comment': 'Schema foo has been created in database dbname',
                 'changes': {'foo': 'Present'},
                 'dbname': 'dbname',
                 'name': 'foo',
                 'result': True}
                )
            self.assertEqual(self.salt_stub['postgres.schema_create'].call_count, 1)

    def test_present_nocreation(self):
        with patch.dict(postgres_schema.__salt__, {
                            'postgres.schema_get': Mock(return_value={'foo':
                                                                      {'acl': '',
                                                                       'owner': 'postgres'}
                                                                      }),
                            'postgres.schema_create': MagicMock()}):
            ret = postgres_schema.present('dbname', 'foo')
            self.assertEqual(
                ret,
                {'comment': 'Schema foo already exists in database dbname',
                 'changes': {},
                 'dbname': 'dbname',
                 'name': 'foo',
                 'result': True}
                )
            self.assertEqual(self.salt_stub['postgres.schema_create'].call_count, 0)

    def test_absent_remove(self):
        with patch.dict(postgres_schema.__salt__, {'postgres.schema_exists': Mock(return_value=True),
                                                   'postgres.schema_remove': MagicMock()}):
            ret = postgres_schema.absent('dbname', 'foo')
            self.assertEqual(
                ret,
                {'comment': 'Schema foo has been removed from database dbname',
                 'changes': {'foo': 'Absent'},
                 'dbname': 'dbname',
                 'name': 'foo',
                 'result': True}
                )
            self.assertEqual(self.salt_stub['postgres.schema_remove'].call_count, 1)

    def test_absent_noremove(self):
        with patch.dict(postgres_schema.__salt__, {'postgres.schema_exists': Mock(return_value=False),
                                                   'postgres.schema_remove': MagicMock()}):
            ret = postgres_schema.absent('dbname', 'foo')
            self.assertEqual(
                ret,
                {'comment': 'Schema foo is not present in database dbname,'
                            ' so it cannot be removed',
                 'changes': {},
                 'dbname': 'dbname',
                 'name': 'foo',
                 'result': True}
                )
            self.assertEqual(self.salt_stub['postgres.schema_remove'].call_count, 0)