mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Merge pull request #40567 from terminalmage/fix-pillar-get-merge-lists
Allow pillar.get to merge list as well as dictionaries
This commit is contained in:
Mike Place
GitHub
commit
83f6d3d3bb
2 changed files with 87 additions and 20 deletions
|
|
@ -18,7 +18,7 @@ import salt.ext.six as six
|
|||
import salt.pillar
|
||||
import salt.utils
|
||||
from salt.defaults import DEFAULT_TARGET_DELIM
|
||||
from salt.exceptions import CommandExecutionError, SaltInvocationError
|
||||
from salt.exceptions import CommandExecutionError
|
||||
|
||||
__proxyenabled__ = ['*']
|
||||
|
||||
|
|
@ -51,11 +51,16 @@ def get(key,
|
|||
|
||||
pkg:apache
|
||||
|
||||
merge
|
||||
Specify whether or not the retrieved values should be recursively
|
||||
merged into the passed default.
|
||||
merge : False
|
||||
If ``True``, the retrieved values will be merged into the passed
|
||||
default. When the default and the retrieved value are both
|
||||
dictionaries, the dictionaries will be recursively merged.
|
||||
|
||||
.. versionadded:: 2014.7.0
|
||||
.. versionchanged:: 2016.3.7,2016.11.4,Nitrogen
|
||||
If the default and the retrieved value are not of the same type,
|
||||
then merging will be skipped and the retrieved value will be
|
||||
returned. Earlier releases raised an error in these cases.
|
||||
|
||||
delimiter
|
||||
Specify an alternate delimiter to use when traversing a nested dict.
|
||||
|
|
@ -94,29 +99,50 @@ def get(key,
|
|||
pillar_dict = __pillar__ if saltenv is None else items(saltenv=saltenv)
|
||||
|
||||
if merge:
|
||||
if default is None:
|
||||
log.debug('pillar.get: default is None, skipping merge')
|
||||
else:
|
||||
if not isinstance(default, dict):
|
||||
raise SaltInvocationError(
|
||||
'default must be a dictionary or None when merge=True'
|
||||
)
|
||||
if isinstance(default, dict):
|
||||
ret = salt.utils.traverse_dict_and_list(
|
||||
pillar_dict,
|
||||
key,
|
||||
{},
|
||||
delimiter)
|
||||
if isinstance(ret, collections.Mapping) and \
|
||||
isinstance(default, collections.Mapping):
|
||||
if isinstance(ret, collections.Mapping):
|
||||
default = copy.deepcopy(default)
|
||||
return salt.utils.dictupdate.update(default, ret)
|
||||
else:
|
||||
log.error(
|
||||
'pillar.get: Default (%s) is a dict, but the returned '
|
||||
'pillar value (%s) is of type \'%s\'. Merge will be '
|
||||
'skipped.', default, ret, type(ret).__name__
|
||||
)
|
||||
elif isinstance(default, list):
|
||||
ret = salt.utils.traverse_dict_and_list(
|
||||
pillar_dict,
|
||||
key,
|
||||
[],
|
||||
delimiter)
|
||||
if isinstance(ret, list):
|
||||
default = copy.deepcopy(default)
|
||||
default.extend([x for x in ret if x not in default])
|
||||
return default
|
||||
else:
|
||||
log.error(
|
||||
'pillar.get: Default (%s) is a list, but the returned '
|
||||
'pillar value (%s) is of type \'%s\'. Merge will be '
|
||||
'skipped.', default, ret, type(ret).__name__
|
||||
)
|
||||
else:
|
||||
log.error(
|
||||
'pillar.get: Default (%s) is of type \'%s\', must be a dict '
|
||||
'or list to merge. Merge will be skipped.',
|
||||
default, type(default).__name__
|
||||
)
|
||||
|
||||
ret = salt.utils.traverse_dict_and_list(pillar_dict,
|
||||
key,
|
||||
default,
|
||||
delimiter)
|
||||
if ret is KeyError:
|
||||
raise KeyError("Pillar key not found: {0}".format(key))
|
||||
raise KeyError('Pillar key not found: {0}'.format(key))
|
||||
|
||||
return ret
|
||||
|
||||
|
|
|
|||
|
|
@ -54,16 +54,57 @@ class PillarModuleTestCase(TestCase):
|
|||
def test_ls(self):
|
||||
self.assertEqual(pillarmod.ls(), ['a', 'b'])
|
||||
|
||||
@skipIf(NO_MOCK, NO_MOCK_REASON)
|
||||
def test_pillar_get_default_merge(self):
|
||||
defaults = {'int': 1,
|
||||
'string': 'foo',
|
||||
'list': ['foo'],
|
||||
'dict': {'foo': 'bar', 'subkey': {'foo': 'bar'}}}
|
||||
|
||||
pillarmod.__opts__ = {}
|
||||
pillarmod.__pillar__ = {'key': 'value'}
|
||||
default = {'default': 'plop'}
|
||||
pillarmod.__pillar__ = {'int': 2,
|
||||
'string': 'bar',
|
||||
'list': ['bar', 'baz'],
|
||||
'dict': {'baz': 'qux', 'subkey': {'baz': 'qux'}}}
|
||||
|
||||
res = pillarmod.get(key='key', default=default)
|
||||
self.assertEqual("value", res)
|
||||
# Test that we raise a KeyError when pillar_raise_on_missing is True
|
||||
with patch.dict(pillarmod.__opts__, {'pillar_raise_on_missing': True}):
|
||||
self.assertRaises(KeyError, pillarmod.get, 'missing')
|
||||
# Test that we return an empty string when it is not
|
||||
self.assertEqual(pillarmod.get('missing'), '')
|
||||
|
||||
res = pillarmod.get(key='missing pillar', default=default)
|
||||
self.assertEqual({'default': 'plop'}, res)
|
||||
# Test with no default passed (it should be KeyError) and merge=True.
|
||||
# The merge should be skipped and the value returned from __pillar__
|
||||
# should be returned.
|
||||
for item in pillarmod.__pillar__:
|
||||
self.assertEqual(
|
||||
pillarmod.get(item, merge=True),
|
||||
pillarmod.__pillar__[item]
|
||||
)
|
||||
|
||||
# Test merging when the type of the default value is not the same as
|
||||
# what was returned. Merging should be skipped and the value returned
|
||||
# from __pillar__ should be returned.
|
||||
for default_type in defaults:
|
||||
for data_type in ('dict', 'list'):
|
||||
if default_type == data_type:
|
||||
continue
|
||||
self.assertEqual(
|
||||
pillarmod.get(item, default=defaults[default_type], merge=True),
|
||||
pillarmod.__pillar__[item]
|
||||
)
|
||||
|
||||
# Test recursive dict merging
|
||||
self.assertEqual(
|
||||
pillarmod.get('dict', default=defaults['dict'], merge=True),
|
||||
{'foo': 'bar', 'baz': 'qux', 'subkey': {'foo': 'bar', 'baz': 'qux'}}
|
||||
)
|
||||
|
||||
# Test list merging
|
||||
self.assertEqual(
|
||||
pillarmod.get('list', default=defaults['list'], merge=True),
|
||||
['foo', 'bar', 'baz']
|
||||
)
|
||||
|
||||
def test_pillar_get_default_merge_regression_38558(self):
|
||||
"""Test for pillar.get(key=..., default=..., merge=True)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue