salt/tests/unit/states/test_win_snmp.py
Erik Johnson 3184168365 Use explicit unicode strings + break up salt.utils
This PR is part of what will be an ongoing effort to use explicit
unicode strings in Salt. Because Python 3 does not suport Python 2's raw
unicode string syntax (i.e. `ur'\d+'`), we must use
`salt.utils.locales.sdecode()` to ensure that the raw string is unicode.
However, because of how `salt/utils/__init__.py` has evolved into the
hulking monstrosity it is today, this means importing a large module in
places where it is not needed, which could negatively impact
performance. For this reason, this PR also breaks out some of the
functions from `salt/utils/__init__.py` into new/existing modules under
`salt/utils/`. The long term goal will be that the modules within this
directory do not depend on importing `salt.utils`.

A summary of the changes in this PR is as follows:

* Moves the following functions from `salt.utils` to new locations
  (including a deprecation warning if invoked from `salt.utils`):
  `to_bytes`, `to_str`, `to_unicode`, `str_to_num`, `is_quoted`,
  `dequote`, `is_hex`, `is_bin_str`, `rand_string`,
  `contains_whitespace`, `clean_kwargs`, `invalid_kwargs`, `which`,
  `which_bin`, `path_join`, `shlex_split`, `rand_str`, `is_windows`,
  `is_proxy`, `is_linux`, `is_darwin`, `is_sunos`, `is_smartos`,
  `is_smartos_globalzone`, `is_smartos_zone`, `is_freebsd`, `is_netbsd`,
  `is_openbsd`, `is_aix`
* Moves the functions already deprecated by @rallytime to the bottom of
  `salt/utils/__init__.py` for better organization, so we can keep the
  deprecated ones separate from the ones yet to be deprecated as we
  continue to break up `salt.utils`
* Updates `salt/*.py` and all files under `salt/client/` to use explicit
  unicode string literals.
* Gets rid of implicit imports of `salt.utils` (e.g. `from salt.utils
  import foo` becomes `import salt.utils.foo as foo`).
* Renames the `test.rand_str` function to `test.random_hash` to more
  accurately reflect what it does
* Modifies `salt.utils.stringutils.random()` (née `salt.utils.rand_string()`)
  such that it returns a string matching the passed size. Previously
  this function would get `size` bytes from `os.urandom()`,
  base64-encode it, and return the result, which would in most cases not
  be equal to the passed size.
2017-08-08 13:33:43 -05:00

98 lines
3.8 KiB
Python

# -*- coding: utf-8 -*-
'''
:synopsis: Unit Tests for Windows SNMP Module 'state.win_snmp'
:platform: Windows
:maturity: develop
.. versionadded:: 2017.7.0
'''
# Import Python Libs
from __future__ import absolute_import
# Import Salt Libs
import salt.states.win_snmp as win_snmp
from salt.ext import six
# Import Salt Testing Libs
from tests.support.mixins import LoaderModuleMockMixin
from tests.support.unit import TestCase, skipIf
from tests.support.mock import (
MagicMock,
patch,
NO_MOCK,
NO_MOCK_REASON,
)
@skipIf(NO_MOCK, NO_MOCK_REASON)
class WinSnmpTestCase(TestCase, LoaderModuleMockMixin):
'''
Test cases for salt.modules.win_snmp
'''
def setup_loader_modules(self):
return {win_snmp: {}}
def test_agent_settings(self):
'''
Test - Manage the SNMP sysContact, sysLocation, and sysServices settings.
'''
kwargs = {'name': 'agent-settings', 'contact': 'TestContact',
'location': 'TestLocation', 'services': ['Internet']}
ret = {
'name': kwargs['name'],
'changes': {},
'comment': 'Agent settings already contain the provided values.',
'result': True
}
# Using this instead of dictionary comprehension in order to make pylint happy.
get_ret = dict((key, value) for (key, value) in six.iteritems(kwargs) if key != 'name')
mock_value_get = MagicMock(return_value=get_ret)
mock_value_set = MagicMock(return_value=True)
with patch.dict(win_snmp.__salt__, {'win_snmp.get_agent_settings': mock_value_get,
'win_snmp.set_agent_settings': mock_value_set}):
with patch.dict(win_snmp.__opts__, {'test': False}):
self.assertEqual(win_snmp.agent_settings(**kwargs), ret)
def test_auth_traps_enabled(self):
'''
Test - Manage the sending of authentication traps.
'''
kwargs = {'name': 'auth-traps', 'status': True}
ret = {
'name': kwargs['name'],
'changes': {
'old': False,
'new': True
},
'comment': 'Set EnableAuthenticationTraps to contain the provided value.',
'result': True
}
mock_value_get = MagicMock(return_value=False)
mock_value_set = MagicMock(return_value=True)
with patch.dict(win_snmp.__salt__, {'win_snmp.get_auth_traps_enabled': mock_value_get,
'win_snmp.set_auth_traps_enabled': mock_value_set}):
with patch.dict(win_snmp.__opts__, {'test': False}):
self.assertEqual(win_snmp.auth_traps_enabled(**kwargs), ret)
with patch.dict(win_snmp.__opts__, {'test': True}):
ret['comment'] = 'EnableAuthenticationTraps will be changed.'
ret['result'] = None
self.assertEqual(win_snmp.auth_traps_enabled(**kwargs), ret)
def test_community_names(self):
'''
Test - Manage the SNMP accepted community names and their permissions.
'''
kwargs = {'name': 'community-names', 'communities': {'TestCommunity': 'Read Create'}}
ret = {
'name': kwargs['name'],
'changes': {},
'comment': 'Communities already contain the provided values.',
'result': True
}
mock_value_get = MagicMock(return_value=kwargs['communities'])
mock_value_set = MagicMock(return_value=True)
with patch.dict(win_snmp.__salt__, {'win_snmp.get_community_names': mock_value_get,
'win_snmp.set_community_names': mock_value_set}):
with patch.dict(win_snmp.__opts__, {'test': False}):
self.assertEqual(win_snmp.community_names(**kwargs), ret)