mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 17:33:54 +00:00
3184168365
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.
154 lines
5.9 KiB
Python
154 lines
5.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Libs
|
|
import salt.utils.platform
|
|
import salt.modules.status as status
|
|
from salt.exceptions import CommandExecutionError
|
|
|
|
# Import Salt Testing Libs
|
|
from tests.support.mixins import LoaderModuleMockMixin
|
|
from tests.support.unit import TestCase
|
|
from tests.support.mock import (
|
|
MagicMock,
|
|
patch,
|
|
mock_open,
|
|
)
|
|
|
|
|
|
class StatusTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
test modules.status functions
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {status: {}}
|
|
|
|
def _set_up_test_uptime(self):
|
|
'''
|
|
Define common mock data for status.uptime tests
|
|
'''
|
|
class MockData(object):
|
|
'''
|
|
Store mock data
|
|
'''
|
|
|
|
m = MockData()
|
|
m.now = 1477004312
|
|
m.ut = 1540154.00
|
|
m.idle = 3047777.32
|
|
m.ret = {
|
|
'users': 3,
|
|
'seconds': 1540154,
|
|
'since_t': 1475464158,
|
|
'days': 17,
|
|
'since_iso': '2016-10-03T03:09:18',
|
|
'time': '19:49',
|
|
}
|
|
|
|
return m
|
|
|
|
def _set_up_test_uptime_sunos(self):
|
|
'''
|
|
Define common mock data for cmd.run_all for status.uptime on SunOS
|
|
'''
|
|
class MockData(object):
|
|
'''
|
|
Store mock data
|
|
'''
|
|
|
|
m = MockData()
|
|
m.ret = {
|
|
'retcode': 0,
|
|
'stdout': 'unix:0:system_misc:boot_time 1475464158',
|
|
}
|
|
|
|
return m
|
|
|
|
def test_uptime_linux(self):
|
|
'''
|
|
Test modules.status.uptime function for Linux
|
|
'''
|
|
m = self._set_up_test_uptime()
|
|
|
|
with patch.multiple(salt.utils.platform,
|
|
is_linux=MagicMock(return_value=True),
|
|
is_sunos=MagicMock(return_value=False),
|
|
is_darwin=MagicMock(return_value=False),
|
|
is_freebsd=MagicMock(return_value=False),
|
|
is_openbsd=MagicMock(return_value=False),
|
|
is_netbsd=MagicMock(return_value=False)):
|
|
with patch.dict(status.__salt__, {'cmd.run': MagicMock(return_value="1\n2\n3")}):
|
|
with patch('time.time', MagicMock(return_value=m.now)):
|
|
with patch('os.path.exists', MagicMock(return_value=True)):
|
|
proc_uptime = '{0} {1}'.format(m.ut, m.idle)
|
|
with patch('salt.utils.files.fopen', mock_open(read_data=proc_uptime)):
|
|
ret = status.uptime()
|
|
self.assertDictEqual(ret, m.ret)
|
|
|
|
with patch('os.path.exists', MagicMock(return_value=False)):
|
|
with self.assertRaises(CommandExecutionError):
|
|
status.uptime()
|
|
|
|
def test_uptime_sunos(self):
|
|
'''
|
|
Test modules.status.uptime function for SunOS
|
|
'''
|
|
m = self._set_up_test_uptime()
|
|
m2 = self._set_up_test_uptime_sunos()
|
|
with patch.multiple(salt.utils.platform,
|
|
is_linux=MagicMock(return_value=False),
|
|
is_sunos=MagicMock(return_value=True),
|
|
is_darwin=MagicMock(return_value=False),
|
|
is_freebsd=MagicMock(return_value=False),
|
|
is_openbsd=MagicMock(return_value=False),
|
|
is_netbsd=MagicMock(return_value=False)):
|
|
|
|
with patch.dict(status.__salt__, {'cmd.run': MagicMock(return_value="1\n2\n3"),
|
|
'cmd.run_all': MagicMock(return_value=m2.ret)}):
|
|
with patch('time.time', MagicMock(return_value=m.now)):
|
|
ret = status.uptime()
|
|
self.assertDictEqual(ret, m.ret)
|
|
|
|
def test_uptime_macos(self):
|
|
'''
|
|
Test modules.status.uptime function for macOS
|
|
'''
|
|
m = self._set_up_test_uptime()
|
|
|
|
kern_boottime = ('{{ sec = {0}, usec = {1:0<6} }} Mon Oct 03 03:09:18.23 2016'
|
|
''.format(*str(m.now - m.ut).split('.')))
|
|
with patch.multiple(salt.utils.platform,
|
|
is_linux=MagicMock(return_value=False),
|
|
is_sunos=MagicMock(return_value=False),
|
|
is_darwin=MagicMock(return_value=True),
|
|
is_freebsd=MagicMock(return_value=False),
|
|
is_openbsd=MagicMock(return_value=False),
|
|
is_netbsd=MagicMock(return_value=False)):
|
|
with patch.dict(status.__salt__, {'cmd.run': MagicMock(return_value="1\n2\n3"),
|
|
'sysctl.get': MagicMock(return_value=kern_boottime)}):
|
|
with patch('time.time', MagicMock(return_value=m.now)):
|
|
ret = status.uptime()
|
|
self.assertDictEqual(ret, m.ret)
|
|
|
|
with patch.dict(status.__salt__, {'sysctl.get': MagicMock(return_value='')}):
|
|
with self.assertRaises(CommandExecutionError):
|
|
status.uptime()
|
|
|
|
def test_uptime_return_success_not_supported(self):
|
|
'''
|
|
Test modules.status.uptime function for other platforms
|
|
'''
|
|
with patch.multiple(salt.utils.platform,
|
|
is_linux=MagicMock(return_value=False),
|
|
is_sunos=MagicMock(return_value=False),
|
|
is_darwin=MagicMock(return_value=False),
|
|
is_freebsd=MagicMock(return_value=False),
|
|
is_openbsd=MagicMock(return_value=False),
|
|
is_netbsd=MagicMock(return_value=False)):
|
|
exc_mock = MagicMock(side_effect=CommandExecutionError)
|
|
with self.assertRaises(CommandExecutionError):
|
|
with patch.dict(status.__salt__, {'cmd.run': exc_mock}):
|
|
status.uptime()
|