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.
95 lines
2.6 KiB
Python
95 lines
2.6 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 (
|
|
patch,
|
|
NO_MOCK,
|
|
NO_MOCK_REASON
|
|
)
|
|
|
|
# Import Salt Libs
|
|
import salt.modules.mod_random as mod_random
|
|
import salt.utils.pycrypto
|
|
from salt.exceptions import SaltInvocationError
|
|
|
|
# Import 3rd-party libs
|
|
from salt.ext import six
|
|
|
|
|
|
def _test_hashlib():
|
|
try:
|
|
import hashlib
|
|
except ImportError:
|
|
return False
|
|
|
|
if six.PY2:
|
|
algorithms_attr_name = 'algorithms'
|
|
else:
|
|
algorithms_attr_name = 'algorithms_guaranteed'
|
|
|
|
if not hasattr(hashlib, algorithms_attr_name):
|
|
return False
|
|
else:
|
|
return True
|
|
|
|
SUPPORTED_HASHLIB = _test_hashlib()
|
|
|
|
|
|
@skipIf(not SUPPORTED_HASHLIB, 'Hashlib does not contain needed functionality')
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class ModrandomTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
Test cases for salt.modules.mod_random
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {mod_random: {}}
|
|
|
|
def test_hash(self):
|
|
'''
|
|
Test for Encodes a value with the specified encoder.
|
|
'''
|
|
self.assertEqual(mod_random.hash('value')[0:4], 'ec2c')
|
|
|
|
self.assertRaises(SaltInvocationError,
|
|
mod_random.hash, 'value', 'algorithm')
|
|
|
|
def test_str_encode(self):
|
|
'''
|
|
Test for The value to be encoded.
|
|
'''
|
|
self.assertRaises(SaltInvocationError,
|
|
mod_random.str_encode, 'None', 'abc')
|
|
|
|
self.assertRaises(SaltInvocationError,
|
|
mod_random.str_encode, None)
|
|
|
|
if six.PY2:
|
|
self.assertEqual(mod_random.str_encode('A'), 'QQ==\n')
|
|
else:
|
|
# We're using the base64 module which does not include the trailing new line
|
|
self.assertEqual(mod_random.str_encode('A'), 'QQ==')
|
|
|
|
def test_get_str(self):
|
|
'''
|
|
Test for Returns a random string of the specified length.
|
|
'''
|
|
with patch.object(salt.utils.pycrypto,
|
|
'secure_password', return_value='A'):
|
|
self.assertEqual(mod_random.get_str(), 'A')
|
|
|
|
def test_shadow_hash(self):
|
|
'''
|
|
Test for Generates a salted hash suitable for /etc/shadow.
|
|
'''
|
|
with patch.object(salt.utils.pycrypto,
|
|
'gen_hash', return_value='A'):
|
|
self.assertEqual(mod_random.shadow_hash(), 'A')
|