salt/tests/unit/modules/test_pf.py

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

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

# Import Salt Libs
import salt.modules.pf as pf

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


class PfTestCase(TestCase, LoaderModuleMockMixin):
    '''
    test modules.pf functions
    '''
    def setup_loader_modules(self):
        return {pf: {}}

    def test_enable_when_disabled(self):
        '''
        Tests enabling pf when it's not enabled yet.
        '''
        ret = {}
        ret['stderr'] = 'pf enabled'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertTrue(pf.enable()['changes'])

    def test_enable_when_enabled(self):
        '''
        Tests enabling pf when it already enabled.
        '''
        ret = {}
        ret['stderr'] = 'pfctl: pf already enabled'
        ret['retcode'] = 1
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertFalse(pf.enable()['changes'])

    def test_disable_when_enabled(self):
        '''
        Tests disabling pf when it's enabled.
        '''
        ret = {}
        ret['stderr'] = 'pf disabled'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertTrue(pf.disable()['changes'])

    def test_disable_when_disabled(self):
        '''
        Tests disabling pf when it already disabled.
        '''
        ret = {}
        ret['stderr'] = 'pfctl: pf not enabled'
        ret['retcode'] = 1
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertFalse(pf.disable()['changes'])

    def test_loglevel(self):
        '''
        Tests setting a loglevel.
        '''
        ret = {}
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            res = pf.loglevel('crit')
            mock_cmd.assert_called_once_with('pfctl -x crit',
                    output_loglevel='trace', python_shell=False)
            self.assertTrue(res['changes'])

    def test_load(self):
        '''
        Tests loading ruleset.
        '''
        ret = {}
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            res = pf.load()
            mock_cmd.assert_called_once_with(['pfctl', '-f', '/etc/pf.conf'],
                    output_loglevel='trace', python_shell=False)
            self.assertTrue(res['changes'])

    def test_load_noop(self):
        '''
        Tests evaluating but not actually loading ruleset.
        '''
        ret = {}
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            res = pf.load(noop=True)
            mock_cmd.assert_called_once_with(['pfctl', '-f', '/etc/pf.conf', '-n'],
                    output_loglevel='trace', python_shell=False)
            self.assertFalse(res['changes'])

    def test_flush(self):
        '''
        Tests a regular flush command.
        '''
        ret = {}
        ret['stderr'] = 'pf: statistics cleared'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            res = pf.flush('info')
            mock_cmd.assert_called_once_with('pfctl -v -F info',
                    output_loglevel='trace', python_shell=False)
            self.assertTrue(res['changes'])

    def test_flush_capital(self):
        '''
        Tests a flush command starting with a capital letter.
        '''
        ret = {}
        ret['stderr'] = '2 tables cleared'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            res = pf.flush('tables')
            mock_cmd.assert_called_once_with('pfctl -v -F Tables',
                    output_loglevel='trace', python_shell=False)
            self.assertTrue(res['changes'])

    def test_flush_without_changes(self):
        '''
        Tests a flush command that has no changes.
        '''
        ret = {}
        ret['stderr'] = '0 tables cleared'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertFalse(pf.flush('tables')['changes'])

    def test_table(self):
        '''
        Tests a regular table command.
        '''
        ret = {}
        ret['stderr'] = '42 addresses deleted'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertTrue(pf.table('flush', table='bad_hosts')['changes'])

    def test_table_expire(self):
        '''
        Tests the table expire command.
        '''
        ret = {}
        ret['stderr'] = '1/1 addresses expired.'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertTrue(pf.table('expire', table='bad_hosts', number=300)['changes'])

    def test_table_add_addresses(self):
        '''
        Tests adding addresses to a table.
        '''
        ret = {}
        ret['stderr'] = '2/2 addressess added.'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertTrue(pf.table('add', table='bad_hosts', addresses=['1.2.3.4', '5.6.7.8'])['changes'])

    def test_table_test_address(self):
        '''
        Tests testing addresses in a table.
        '''
        ret = {}
        ret['stderr'] = '1/2 addressess match.'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertTrue(pf.table('test', table='bad_hosts', addresses=['1.2.3.4'])['matches'])

    def test_table_no_changes(self):
        '''
        Tests a table command that has no changes.
        '''
        ret = {}
        ret['stderr'] = '0/1 addresses expired.'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertFalse(pf.table('expire', table='bad_hosts', number=300)['changes'])

    def test_table_show(self):
        '''
        Tests showing table contents.
        '''
        ret = {}
        ret['stdout'] = '1.2.3.4\n5.6.7.8'
        ret['retcode'] = 0
        expected = ['1.2.3.4', '5.6.7.8']
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertListEqual(pf.table('show', table='bad_hosts')['comment'], expected)

    def test_show(self):
        '''
        Tests a regular show command.
        '''
        ret = {}
        ret['stdout'] = 'block return\npass'
        ret['retcode'] = 0
        expected = ['block return', 'pass']
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            self.assertListEqual(pf.show('rules')['comment'], expected)

    def test_show_capital(self):
        '''
        Tests a show command starting with a capital letter.
        '''
        ret = {}
        ret['stdout'] = 'bad_hosts'
        ret['retcode'] = 0
        mock_cmd = MagicMock(return_value=ret)
        with patch.dict(pf.__salt__, {'cmd.run_all': mock_cmd}):
            res = pf.show('tables')
            mock_cmd.assert_called_once_with('pfctl -s Tables',
                    output_loglevel='trace', python_shell=False)
            self.assertFalse(res['changes'])