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.
111 lines
4.3 KiB
Python
111 lines
4.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
'''
|
|
unittests for highstate outputter
|
|
'''
|
|
|
|
# Import Python Libs
|
|
from __future__ import absolute_import
|
|
|
|
# Import Salt Testing Libs
|
|
from tests.support.mixins import LoaderModuleMockMixin
|
|
from tests.support.unit import TestCase
|
|
|
|
# Import Salt Libs
|
|
import salt.utils
|
|
import salt.utils.stringutils
|
|
import salt.output.highstate as highstate
|
|
|
|
# Import 3rd-party libs
|
|
from salt.ext import six
|
|
|
|
|
|
class JsonTestCase(TestCase, LoaderModuleMockMixin):
|
|
'''
|
|
Test cases for salt.output.highstate
|
|
'''
|
|
def setup_loader_modules(self):
|
|
return {
|
|
highstate: {
|
|
'__opts__': {
|
|
'extension_modules': '',
|
|
'color': False,
|
|
}
|
|
}
|
|
}
|
|
|
|
def setUp(self):
|
|
self.data = {
|
|
'data': {
|
|
'master': {
|
|
'salt_|-call_sleep_state_|-call_sleep_state_|-state': {
|
|
'__id__': 'call_sleep_state',
|
|
'__jid__': '20170418153529810135',
|
|
'__run_num__': 0,
|
|
'__sls__': 'orch.simple',
|
|
'changes': {
|
|
'out': 'highstate',
|
|
'ret': {
|
|
'minion': {
|
|
'module_|-simple-ping_|-test.ping_|-run': {
|
|
'__id__': 'simple-ping',
|
|
'__run_num__': 0,
|
|
'__sls__': 'simple-ping',
|
|
'changes': {'ret': True},
|
|
'comment': 'Module function test.ping executed',
|
|
'duration': 56.179,
|
|
'name': 'test.ping',
|
|
'result': True,
|
|
'start_time': '15:35:31.282099'
|
|
}
|
|
},
|
|
'sub_minion': {
|
|
'module_|-simple-ping_|-test.ping_|-run': {
|
|
'__id__': 'simple-ping',
|
|
'__run_num__': 0,
|
|
'__sls__': 'simple-ping',
|
|
'changes': {'ret': True},
|
|
'comment': 'Module function test.ping executed',
|
|
'duration': 54.103,
|
|
'name': 'test.ping',
|
|
'result': True,
|
|
'start_time': '15:35:31.005606'
|
|
}
|
|
}
|
|
}
|
|
},
|
|
'comment': 'States ran successfully. Updating sub_minion, minion.',
|
|
'duration': 1638.047,
|
|
'name': 'call_sleep_state',
|
|
'result': True,
|
|
'start_time': '15:35:29.762657'
|
|
}
|
|
}
|
|
},
|
|
'outputter': 'highstate',
|
|
'retcode': 0
|
|
}
|
|
self.addCleanup(delattr, self, 'data')
|
|
|
|
def test_default_output(self):
|
|
ret = highstate.output(self.data)
|
|
self.assertIn('Succeeded: 1 (changed=1)', ret)
|
|
self.assertIn('Failed: 0', ret)
|
|
self.assertIn('Total states run: 1', ret)
|
|
|
|
def test_output_comment_is_not_unicode(self):
|
|
entry = None
|
|
for key in ('data', 'master', 'salt_|-call_sleep_state_|-call_sleep_state_|-state',
|
|
'changes', 'ret', 'minion', 'module_|-simple-ping_|-test.ping_|-run'):
|
|
if entry is None:
|
|
entry = self.data[key]
|
|
continue
|
|
entry = entry[key]
|
|
if six.PY2:
|
|
entry['comment'] = salt.utils.stringutils.to_unicode(entry['comment'])
|
|
else:
|
|
entry['comment'] = salt.utils.stringutils.to_bytes(entry['comment'])
|
|
ret = highstate.output(self.data)
|
|
self.assertIn('Succeeded: 1 (changed=1)', ret)
|
|
self.assertIn('Failed: 0', ret)
|
|
self.assertIn('Total states run: 1', ret)
|