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.
66 lines
2.4 KiB
Python
66 lines
2.4 KiB
Python
# coding: utf-8
|
|
|
|
# Import Python libs
|
|
from __future__ import absolute_import
|
|
|
|
|
|
# Import Salt libs
|
|
import salt.utils.locales as locales
|
|
from tests.support.unit import TestCase, skipIf
|
|
from tests.support.mock import patch, NO_MOCK, NO_MOCK_REASON
|
|
|
|
# Import 3rd-part libs
|
|
from salt.ext import six
|
|
from salt.ext.six.moves import reload_module
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class TestLocales(TestCase):
|
|
def test_get_encodings(self):
|
|
# reload locales modules before and after to defeat memoization of
|
|
# get_encodings()
|
|
reload_module(locales)
|
|
with patch('sys.getdefaultencoding', return_value='xyzzy'):
|
|
encodings = locales.get_encodings()
|
|
for enc in (__salt_system_encoding__, 'xyzzy', 'utf-8', 'latin-1'):
|
|
self.assertIn(enc, encodings)
|
|
reload_module(locales)
|
|
|
|
def test_sdecode(self):
|
|
b = six.b('\xe7\xb9\x81\xe4\xbd\x93')
|
|
u = u'\u7e41\u4f53'
|
|
if six.PY2:
|
|
# Under Py3, the above `b` as bytes, will never decode as anything even comparable using `ascii`
|
|
# but no unicode error will be raised, as such, sdecode will return the poorly decoded string
|
|
with patch('salt.utils.locales.get_encodings', return_value=['ascii']):
|
|
self.assertEqual(locales.sdecode(b), b) # no decode
|
|
with patch('salt.utils.locales.get_encodings', return_value=['utf-8']):
|
|
self.assertEqual(locales.sdecode(b), u)
|
|
# Non strings are left untouched
|
|
with patch('salt.utils.locales.get_encodings', return_value=['utf-8']):
|
|
self.assertEqual(locales.sdecode(1), 1)
|
|
|
|
def test_split_locale(self):
|
|
self.assertDictEqual(
|
|
locales.split_locale('ca_ES.UTF-8@valencia utf-8'),
|
|
{'charmap': 'utf-8',
|
|
'modifier': 'valencia',
|
|
'codeset': 'UTF-8',
|
|
'language': 'ca',
|
|
'territory': 'ES'})
|
|
|
|
def test_join_locale(self):
|
|
self.assertEqual(
|
|
locales.join_locale(
|
|
{'charmap': 'utf-8',
|
|
'modifier': 'valencia',
|
|
'codeset': 'UTF-8',
|
|
'language': 'ca',
|
|
'territory': 'ES'}),
|
|
'ca_ES.UTF-8@valencia utf-8')
|
|
|
|
def test_normalize_locale(self):
|
|
self.assertEqual(
|
|
locales.normalize_locale('ca_es.UTF-8@valencia utf-8'),
|
|
'ca_ES.utf8@valencia')
|