mirror of
https://github.com/valitydev/salt.git
synced 2024-11-08 09:23:56 +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.
240 lines
11 KiB
Python
240 lines
11 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
:codeauthor: :email:`Rupesh Tare <rupesht@saltstack.com>`
|
|
'''
|
|
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing Libs
|
|
from tests.support.mixins import LoaderModuleMockMixin
|
|
from tests.support.unit import TestCase, skipIf
|
|
from tests.support.mock import (
|
|
MagicMock,
|
|
Mock,
|
|
patch,
|
|
NO_MOCK,
|
|
NO_MOCK_REASON
|
|
)
|
|
|
|
# Import Salt Libs
|
|
import salt.modules.localemod as localemod
|
|
from salt.exceptions import CommandExecutionError
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class LocalemodTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
Test cases for salt.modules.localemod
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {localemod: {}}
|
|
|
|
def test_list_avail(self):
|
|
'''
|
|
Test for Lists available (compiled) locales
|
|
'''
|
|
with patch.dict(localemod.__salt__,
|
|
{'cmd.run': MagicMock(return_value='A\nB')}):
|
|
self.assertEqual(localemod.list_avail(), ['A', 'B'])
|
|
|
|
def test_get_locale(self):
|
|
'''
|
|
Test for Get the current system locale
|
|
'''
|
|
with patch.dict(localemod.__context__, {'salt.utils.systemd.booted': True}):
|
|
with patch.dict(localemod.__grains__, {'os_family': ['Unknown']}):
|
|
with patch.multiple(localemod,
|
|
_parse_dbus_locale=MagicMock(return_value={'LANG': 'A'}),
|
|
HAS_DBUS=True):
|
|
self.assertEqual('A', localemod.get_locale())
|
|
localemod._parse_dbus_locale.assert_called_once_with()
|
|
|
|
with patch.multiple(localemod,
|
|
_parse_localectl=MagicMock(return_value={'LANG': 'A'}),
|
|
HAS_DBUS=False):
|
|
self.assertEqual('A', localemod.get_locale())
|
|
localemod._parse_localectl.assert_called_once_with()
|
|
|
|
with patch.dict(localemod.__context__, {'salt.utils.systemd.booted': False}):
|
|
with patch.dict(localemod.__grains__, {'os_family': ['Gentoo']}):
|
|
with patch.dict(localemod.__salt__, {'cmd.run': MagicMock(return_value='A')}):
|
|
with patch.object(localemod,
|
|
'_parse_localectl',
|
|
return_value={'LANG': 'A'}):
|
|
self.assertEqual(localemod.get_locale(), 'A')
|
|
|
|
with patch.dict(localemod.__grains__, {'os_family': ['RedHat']}):
|
|
with patch.dict(localemod.__salt__, {'cmd.run': MagicMock(return_value='A=B')}):
|
|
with patch.object(localemod,
|
|
'_parse_localectl',
|
|
return_value={'LANG': 'B'}):
|
|
self.assertEqual(localemod.get_locale(), 'B')
|
|
|
|
with patch.dict(localemod.__grains__, {'os_family': ['Unknown']}):
|
|
with patch.dict(localemod.__salt__, {'cmd.run': MagicMock(return_value='A=B')}):
|
|
self.assertRaises(CommandExecutionError, localemod.get_locale)
|
|
|
|
def test_set_locale(self):
|
|
'''
|
|
Test for Sets the current system locale
|
|
'''
|
|
with patch.dict(localemod.__context__, {'salt.utils.systemd.booted': True}):
|
|
with patch.dict(localemod.__grains__, {'os_family': ['Unknown']}):
|
|
with patch.object(localemod, '_localectl_set', return_value=True):
|
|
self.assertTrue(localemod.set_locale('l'))
|
|
|
|
with patch.dict(localemod.__context__, {'salt.utils.systemd.booted': False}):
|
|
with patch.dict(localemod.__grains__, {'os_family': ['Gentoo']}):
|
|
with patch.dict(localemod.__salt__, {'cmd.retcode': MagicMock(return_value='A')}):
|
|
with patch.object(localemod,
|
|
'_parse_localectl',
|
|
return_value={'LANG': 'B'}):
|
|
self.assertFalse(localemod.set_locale('l'))
|
|
|
|
with patch.dict(localemod.__grains__, {'os_family': ['A']}):
|
|
with patch.dict(localemod.__salt__, {'cmd.retcode': MagicMock(return_value=0)}):
|
|
with patch('salt.utils.systemd.booted', return_value=False):
|
|
self.assertRaises(CommandExecutionError, localemod.set_locale, 'A')
|
|
|
|
def test_avail(self):
|
|
'''
|
|
Test for Check if a locale is available
|
|
'''
|
|
with patch('salt.utils.locales.normalize_locale',
|
|
MagicMock(return_value='en_US.UTF-8 UTF-8')):
|
|
with patch.dict(localemod.__salt__,
|
|
{'locale.list_avail':
|
|
MagicMock(return_value=['A', 'B'])}):
|
|
self.assertTrue(localemod.avail('locale'))
|
|
|
|
def test_gen_locale_not_valid(self):
|
|
'''
|
|
Tests the return of gen_locale when the provided locale is not found
|
|
'''
|
|
with patch.dict(localemod.__grains__, {'os': 'Debian'}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch.dict(localemod.__salt__,
|
|
{'file.search': MagicMock(return_value=False)}):
|
|
self.assertFalse(localemod.gen_locale('foo'))
|
|
|
|
def test_gen_locale_debian(self):
|
|
'''
|
|
Tests the return of successful gen_locale on Debian system
|
|
'''
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__grains__, {'os': 'Debian'}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch.dict(localemod.__salt__,
|
|
{'file.search': MagicMock(return_value=True),
|
|
'file.replace': MagicMock(return_value=True),
|
|
'cmd.run_all': MagicMock(return_value=ret)}):
|
|
self.assertTrue(localemod.gen_locale('en_US.UTF-8 UTF-8'))
|
|
|
|
def test_gen_locale_debian_no_charmap(self):
|
|
'''
|
|
Tests the return of successful gen_locale on Debian system without a charmap
|
|
'''
|
|
def file_search(search, pattern, flags):
|
|
'''
|
|
mock file.search
|
|
'''
|
|
if len(pattern.split()) == 1:
|
|
return False
|
|
else: # charmap was supplied
|
|
return True
|
|
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__grains__, {'os': 'Debian'}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch.dict(localemod.__salt__,
|
|
{'file.search': file_search,
|
|
'file.replace': MagicMock(return_value=True),
|
|
'cmd.run_all': MagicMock(return_value=ret)}):
|
|
self.assertTrue(localemod.gen_locale('en_US.UTF-8'))
|
|
|
|
def test_gen_locale_ubuntu(self):
|
|
'''
|
|
Test the return of successful gen_locale on Ubuntu system
|
|
'''
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__salt__,
|
|
{'file.replace': MagicMock(return_value=True),
|
|
'file.touch': MagicMock(return_value=None),
|
|
'file.append': MagicMock(return_value=None),
|
|
'cmd.run_all': MagicMock(return_value=ret)}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch('os.listdir', MagicMock(return_value=['en_US'])), \
|
|
patch.dict(localemod.__grains__, {'os': 'Ubuntu'}):
|
|
self.assertTrue(localemod.gen_locale('en_US.UTF-8'))
|
|
|
|
def test_gen_locale_gentoo(self):
|
|
'''
|
|
Tests the return of successful gen_locale on Gentoo system
|
|
'''
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__grains__, {'os_family': 'Gentoo'}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch('os.listdir', MagicMock(return_value=['en_US.UTF-8'])), \
|
|
patch.dict(localemod.__salt__,
|
|
{'file.search': MagicMock(return_value=True),
|
|
'file.replace': MagicMock(return_value=True),
|
|
'cmd.run_all': MagicMock(return_value=ret)}):
|
|
self.assertTrue(localemod.gen_locale('en_US.UTF-8 UTF-8'))
|
|
|
|
def test_gen_locale_gentoo_no_charmap(self):
|
|
'''
|
|
Tests the return of successful gen_locale on Gentoo system without a charmap
|
|
'''
|
|
def file_search(search, pattern, flags):
|
|
'''
|
|
mock file.search
|
|
'''
|
|
if len(pattern.split()) == 1:
|
|
return False
|
|
else: # charmap was supplied
|
|
return True
|
|
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__grains__, {'os_family': 'Gentoo'}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch('os.listdir', MagicMock(return_value=['en_US.UTF-8'])), \
|
|
patch.dict(localemod.__salt__,
|
|
{'file.search': file_search,
|
|
'file.replace': MagicMock(return_value=True),
|
|
'cmd.run_all': MagicMock(return_value=ret)}):
|
|
self.assertTrue(localemod.gen_locale('en_US.UTF-8'))
|
|
|
|
def test_gen_locale(self):
|
|
'''
|
|
Tests the return of successful gen_locale
|
|
'''
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__salt__,
|
|
{'cmd.run_all': MagicMock(return_value=ret),
|
|
'file.replace': MagicMock()}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch('os.listdir', MagicMock(return_value=['en_US'])):
|
|
self.assertTrue(localemod.gen_locale('en_US.UTF-8'))
|
|
|
|
def test_gen_locale_verbose(self):
|
|
'''
|
|
Tests the return of successful gen_locale
|
|
'''
|
|
ret = {'stdout': 'saltines', 'stderr': 'biscuits', 'retcode': 0, 'pid': 1337}
|
|
with patch.dict(localemod.__salt__,
|
|
{'cmd.run_all': MagicMock(return_value=ret),
|
|
'file.replace': MagicMock()}), \
|
|
patch('salt.utils.path.which', MagicMock(return_value='/some/dir/path')), \
|
|
patch('os.listdir', MagicMock(return_value=['en_US'])):
|
|
self.assertEqual(localemod.gen_locale('en_US.UTF-8', verbose=True), ret)
|
|
|
|
def test_parse_localectl(self):
|
|
localectl_out = (' System Locale: LANG=en_US.UTF-8\n'
|
|
' LANGUAGE=en_US:en\n'
|
|
' VC Keymap: n/a')
|
|
mock_cmd = Mock(return_value=localectl_out)
|
|
with patch.dict(localemod.__salt__, {'cmd.run': mock_cmd}):
|
|
ret = localemod._parse_localectl()
|
|
self.assertEqual({'LANG': 'en_US.UTF-8', 'LANGUAGE': 'en_US:en'}, ret)
|