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.
314 lines
7.7 KiB
Python
314 lines
7.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Import python libs
|
|
from __future__ import absolute_import
|
|
import copy
|
|
|
|
# Import Salt Testing libs
|
|
from tests.support.unit import TestCase
|
|
|
|
# Import Salt libs
|
|
import salt.utils.configcomparer as configcomparer
|
|
|
|
|
|
class UtilConfigcomparerTestCase(TestCase):
|
|
|
|
base_config = {
|
|
'attr1': 'value1',
|
|
'attr2': [
|
|
'item1',
|
|
'item2',
|
|
'item3',
|
|
],
|
|
'attr3': [],
|
|
'attr4': {},
|
|
'attr5': {
|
|
'subattr1': 'value1',
|
|
'subattr2': [
|
|
'item1',
|
|
],
|
|
},
|
|
}
|
|
|
|
def test_compare_and_update_config(self):
|
|
|
|
# empty config
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual({}, changes)
|
|
self.assertEqual(self.base_config, to_update)
|
|
|
|
# simple, new value
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attrx': 'value1',
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attrx': {
|
|
'new': 'value1',
|
|
'old': None,
|
|
},
|
|
},
|
|
changes,
|
|
)
|
|
self.assertEqual('value1', to_update['attrx'])
|
|
self.assertEqual('value1', to_update['attr1'])
|
|
# simple value
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr1': 'value2',
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr1': {
|
|
'new': 'value2',
|
|
'old': 'value1',
|
|
},
|
|
},
|
|
changes,
|
|
)
|
|
self.assertEqual('value2', to_update['attr1'])
|
|
self.assertEqual(
|
|
{
|
|
'attr1': 'value2',
|
|
'attr2': [
|
|
'item1',
|
|
'item2',
|
|
'item3',
|
|
],
|
|
'attr3': [],
|
|
'attr4': {},
|
|
'attr5': {
|
|
'subattr1': 'value1',
|
|
'subattr2': [
|
|
'item1',
|
|
],
|
|
},
|
|
},
|
|
to_update,
|
|
)
|
|
|
|
# empty list
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr3': [],
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual({}, changes)
|
|
self.assertEqual(self.base_config, to_update)
|
|
|
|
# list value (add)
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr2': [
|
|
'item1',
|
|
'item2',
|
|
'item3',
|
|
'item4',
|
|
],
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr2[3]': {
|
|
'new': 'item4',
|
|
'old': None,
|
|
},
|
|
},
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr1': 'value1',
|
|
'attr2': [
|
|
'item1',
|
|
'item2',
|
|
'item3',
|
|
'item4',
|
|
],
|
|
'attr3': [],
|
|
'attr4': {},
|
|
'attr5': {
|
|
'subattr1': 'value1',
|
|
'subattr2': [
|
|
'item1',
|
|
],
|
|
},
|
|
},
|
|
to_update,
|
|
)
|
|
|
|
# list value (remove and modify)
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr2': [
|
|
'itemx',
|
|
'item2',
|
|
],
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr2[0]': {
|
|
'new': 'itemx',
|
|
'old': 'item1',
|
|
},
|
|
'attr2[2]': {
|
|
'new': None,
|
|
'old': 'item3',
|
|
},
|
|
},
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr1': 'value1',
|
|
'attr2': [
|
|
'itemx',
|
|
'item2',
|
|
],
|
|
'attr3': [],
|
|
'attr4': {},
|
|
'attr5': {
|
|
'subattr1': 'value1',
|
|
'subattr2': [
|
|
'item1',
|
|
],
|
|
},
|
|
},
|
|
to_update,
|
|
)
|
|
|
|
# empty dict
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr4': {}
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual({}, changes)
|
|
self.assertEqual(self.base_config, to_update)
|
|
|
|
# dict value (add)
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr5': {
|
|
'subattr3': 'value1',
|
|
},
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr5.subattr3': {
|
|
'new': 'value1',
|
|
'old': None,
|
|
},
|
|
},
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr1': 'value1',
|
|
'attr2': [
|
|
'item1',
|
|
'item2',
|
|
'item3',
|
|
],
|
|
'attr3': [],
|
|
'attr4': {},
|
|
'attr5': {
|
|
'subattr1': 'value1',
|
|
'subattr2': [
|
|
'item1',
|
|
],
|
|
'subattr3': 'value1',
|
|
},
|
|
},
|
|
to_update,
|
|
)
|
|
|
|
# dict value (remove and modify)
|
|
to_update = copy.deepcopy(self.base_config)
|
|
changes = {}
|
|
configcomparer.compare_and_update_config(
|
|
{
|
|
'attr5': {
|
|
'subattr1': 'value2',
|
|
'subattr2': [
|
|
'item1',
|
|
'item2',
|
|
],
|
|
},
|
|
},
|
|
to_update,
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr5.subattr1': {
|
|
'new': 'value2',
|
|
'old': 'value1',
|
|
},
|
|
'attr5.subattr2[1]': {
|
|
'new': 'item2',
|
|
'old': None,
|
|
},
|
|
},
|
|
changes,
|
|
)
|
|
self.assertEqual(
|
|
{
|
|
'attr1': 'value1',
|
|
'attr2': [
|
|
'item1',
|
|
'item2',
|
|
'item3',
|
|
],
|
|
'attr3': [],
|
|
'attr4': {},
|
|
'attr5': {
|
|
'subattr1': 'value2',
|
|
'subattr2': [
|
|
'item1',
|
|
'item2',
|
|
],
|
|
},
|
|
},
|
|
to_update,
|
|
)
|