mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +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.
81 lines
3.9 KiB
Python
81 lines
3.9 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 TestCase, skipIf
|
|
from tests.support.mock import NO_MOCK, NO_MOCK_REASON, MagicMock, patch
|
|
|
|
# Import Salt Libs
|
|
import salt.pillar.consul_pillar as consul_pillar
|
|
|
|
# Import 3rd-party libs
|
|
from salt.ext import six
|
|
|
|
OPTS = {'consul_config': {'consul.port': 8500, 'consul.host': '172.17.0.15'}}
|
|
|
|
PILLAR_DATA = [
|
|
{'Value': '/path/to/certs/testsite1.crt', 'Key': u'test-shared/sites/testsite1/ssl/certs/SSLCertificateFile'},
|
|
{'Value': '/path/to/certs/testsite1.key', 'Key': u'test-shared/sites/testsite1/ssl/certs/SSLCertificateKeyFile'},
|
|
{'Value': None, 'Key': u'test-shared/sites/testsite1/ssl/certs/'},
|
|
{'Value': 'True', 'Key': u'test-shared/sites/testsite1/ssl/force'},
|
|
{'Value': None, 'Key': u'test-shared/sites/testsite1/ssl/'},
|
|
{'Value': 'salt://sites/testsite1.tmpl', 'Key': u'test-shared/sites/testsite1/template'},
|
|
{'Value': 'test.example.com', 'Key': u'test-shared/sites/testsite1/uri'},
|
|
{'Value': None, 'Key': u'test-shared/sites/testsite1/'},
|
|
{'Value': None, 'Key': u'test-shared/sites/'},
|
|
{'Value': 'Test User', 'Key': u'test-shared/user/full_name'},
|
|
{'Value': 'adm\nwww-data\nmlocate', 'Key': u'test-shared/user/groups'},
|
|
{'Value': '"adm\nwww-data\nmlocate"', 'Key': u'test-shared/user/dontsplit'},
|
|
{'Value': None, 'Key': u'test-shared/user/blankvalue'},
|
|
{'Value': 'test', 'Key': u'test-shared/user/login'},
|
|
{'Value': None, 'Key': u'test-shared/user/'}
|
|
]
|
|
|
|
SIMPLE_DICT = {'key1': {'key2': 'val1'}}
|
|
|
|
|
|
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
|
@skipIf(not consul_pillar.HAS_CONSUL, 'no consul-python')
|
|
class ConsulPillarTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
Test cases for salt.pillar.consul_pillar
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {
|
|
consul_pillar: {
|
|
'__opts__': OPTS,
|
|
'get_conn': MagicMock(return_value='consul_connection')
|
|
}
|
|
}
|
|
|
|
def test_connection(self):
|
|
with patch.dict(consul_pillar.__salt__, {'grains.get': MagicMock(return_value=({}))}):
|
|
with patch.object(consul_pillar, 'consul_fetch', MagicMock(return_value=('2232', PILLAR_DATA))):
|
|
consul_pillar.ext_pillar('testminion', {}, 'consul_config root=test-shared/')
|
|
consul_pillar.get_conn.assert_called_once_with(OPTS, 'consul_config')
|
|
|
|
def test_pillar_data(self):
|
|
with patch.dict(consul_pillar.__salt__, {'grains.get': MagicMock(return_value=({}))}):
|
|
with patch.object(consul_pillar, 'consul_fetch', MagicMock(return_value=('2232', PILLAR_DATA))):
|
|
pillar_data = consul_pillar.ext_pillar('testminion', {}, 'consul_config root=test-shared/')
|
|
consul_pillar.consul_fetch.assert_called_once_with('consul_connection', 'test-shared/')
|
|
assert list(pillar_data) == [u'user', u'sites']
|
|
self.assertNotIn('blankvalue', pillar_data[u'user'])
|
|
|
|
def test_value_parsing(self):
|
|
with patch.dict(consul_pillar.__salt__, {'grains.get': MagicMock(return_value=({}))}):
|
|
with patch.object(consul_pillar, 'consul_fetch', MagicMock(return_value=('2232', PILLAR_DATA))):
|
|
pillar_data = consul_pillar.ext_pillar('testminion', {}, 'consul_config root=test-shared/')
|
|
assert isinstance(pillar_data[u'user'][u'dontsplit'], six.string_types)
|
|
|
|
def test_dict_merge(self):
|
|
test_dict = {}
|
|
with patch.dict(test_dict, SIMPLE_DICT):
|
|
self.assertDictEqual(consul_pillar.dict_merge(test_dict, SIMPLE_DICT), SIMPLE_DICT)
|
|
with patch.dict(test_dict, {'key1': {'key3': {'key4': 'value'}}}):
|
|
self.assertDictEqual(consul_pillar.dict_merge(test_dict, SIMPLE_DICT),
|
|
{'key1': {'key2': 'val1', 'key3': {'key4': 'value'}}})
|