mirror of
https://github.com/valitydev/salt.git
synced 2024-11-09 01:36:48 +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.
98 lines
3.2 KiB
Python
98 lines
3.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import Python Libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing libs
|
|
from tests.support.mixins import LoaderModuleMockMixin
|
|
from tests.support.unit import skipIf, TestCase
|
|
from tests.support.mock import (
|
|
NO_MOCK,
|
|
NO_MOCK_REASON,
|
|
MagicMock,
|
|
patch
|
|
)
|
|
|
|
# Import Salt libs
|
|
import salt.renderers.gpg as gpg
|
|
from salt.exceptions import SaltRenderError
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
class GPGTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
unit test GPG renderer
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {gpg: {}}
|
|
|
|
def test__get_gpg_exec(self):
|
|
'''
|
|
test _get_gpg_exec
|
|
'''
|
|
gpg_exec = '/bin/gpg'
|
|
|
|
with patch('salt.utils.path.which', MagicMock(return_value=gpg_exec)):
|
|
self.assertEqual(gpg._get_gpg_exec(), gpg_exec)
|
|
|
|
with patch('salt.utils.path.which', MagicMock(return_value=False)):
|
|
self.assertRaises(SaltRenderError, gpg._get_gpg_exec)
|
|
|
|
def test__decrypt_ciphertext(self):
|
|
'''
|
|
test _decrypt_ciphertext
|
|
'''
|
|
key_dir = '/etc/salt/gpgkeys'
|
|
secret = 'Use more salt.'
|
|
crypted = '!@#$%^&*()_+'
|
|
|
|
class GPGDecrypt(object):
|
|
def communicate(self, *args, **kwargs):
|
|
return [secret, None]
|
|
|
|
class GPGNotDecrypt(object):
|
|
def communicate(self, *args, **kwargs):
|
|
return [None, 'decrypt error']
|
|
|
|
with patch('salt.renderers.gpg._get_key_dir', MagicMock(return_value=key_dir)), \
|
|
patch('salt.utils.path.which', MagicMock()):
|
|
with patch('salt.renderers.gpg.Popen', MagicMock(return_value=GPGDecrypt())):
|
|
self.assertEqual(gpg._decrypt_ciphertext(crypted), secret)
|
|
with patch('salt.renderers.gpg.Popen', MagicMock(return_value=GPGNotDecrypt())):
|
|
self.assertEqual(gpg._decrypt_ciphertext(crypted), crypted)
|
|
|
|
def test__decrypt_object(self):
|
|
'''
|
|
test _decrypt_object
|
|
'''
|
|
|
|
secret = 'Use more salt.'
|
|
crypted = '-----BEGIN PGP MESSAGE-----!@#$%^&*()_+'
|
|
|
|
secret_map = {'secret': secret}
|
|
crypted_map = {'secret': crypted}
|
|
|
|
secret_list = [secret]
|
|
crypted_list = [crypted]
|
|
|
|
with patch('salt.renderers.gpg._decrypt_ciphertext', MagicMock(return_value=secret)):
|
|
self.assertEqual(gpg._decrypt_object(secret), secret)
|
|
self.assertEqual(gpg._decrypt_object(crypted), secret)
|
|
self.assertEqual(gpg._decrypt_object(crypted_map), secret_map)
|
|
self.assertEqual(gpg._decrypt_object(crypted_list), secret_list)
|
|
self.assertEqual(gpg._decrypt_object(None), None)
|
|
|
|
def test_render(self):
|
|
'''
|
|
test render
|
|
'''
|
|
|
|
key_dir = '/etc/salt/gpgkeys'
|
|
secret = 'Use more salt.'
|
|
crypted = '-----BEGIN PGP MESSAGE-----!@#$%^&*()_+'
|
|
|
|
with patch('salt.renderers.gpg._get_gpg_exec', MagicMock(return_value=True)):
|
|
with patch('salt.renderers.gpg._get_key_dir', MagicMock(return_value=key_dir)):
|
|
with patch('salt.renderers.gpg._decrypt_object', MagicMock(return_value=secret)):
|
|
self.assertEqual(gpg.render(crypted), secret)
|