salt/tests/unit/modules/test_pillar.py
2019-01-25 13:00:03 +00:00

151 lines
5.5 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 (
MagicMock,
patch,
NO_MOCK,
NO_MOCK_REASON
)
# Import Salt libs
from salt.ext import six
from salt.utils.odict import OrderedDict
import salt.modules.pillar as pillarmod
pillar_value_1 = dict(a=1, b='very secret')
class PillarModuleTestCase(TestCase, LoaderModuleMockMixin):
def setup_loader_modules(self):
return {pillarmod: {}}
def test_obfuscate_inner_recursion(self):
self.assertEqual(
pillarmod._obfuscate_inner(dict(a=[1, 2],
b=dict(pwd='secret', deeper=('a', 1)))),
dict(a=['<int>', '<int>'],
b=dict(pwd='<str>', deeper=('<str>', '<int>')))
)
def test_obfuscate_inner_more_types(self):
self.assertEqual(pillarmod._obfuscate_inner(OrderedDict([('key', 'value')])),
OrderedDict([('key', '<str>')]))
self.assertEqual(pillarmod._obfuscate_inner(set((1, 2))),
set(['<int>']))
self.assertEqual(pillarmod._obfuscate_inner((1, 2)),
('<int>', '<int>'))
@skipIf(NO_MOCK, NO_MOCK_REASON)
def test_obfuscate(self):
with patch('salt.modules.pillar.items', MagicMock(return_value=pillar_value_1)):
self.assertEqual(pillarmod.obfuscate(),
dict(a='<int>', b='<str>'))
@skipIf(NO_MOCK, NO_MOCK_REASON)
def test_ls(self):
with patch('salt.modules.pillar.items', MagicMock(return_value=pillar_value_1)):
ls = sorted(pillarmod.ls())
if six.PY3:
self.assertCountEqual(ls, ['a', 'b'])
else:
self.assertEqual(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'}}}
pillar_mock = {'int': 2,
'string': 'bar',
'list': ['bar', 'baz'],
'dict': {'baz': 'qux', 'subkey': {'baz': 'qux'}}}
# 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
with patch.dict(pillarmod.__opts__, {}):
self.assertEqual(pillarmod.get('missing'), '')
with patch.dict(pillarmod.__pillar__, pillar_mock):
# 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(data_type, default=defaults[default_type], merge=True),
pillarmod.__pillar__[data_type]
)
# 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)
Do not update the ``default`` value when using ``merge=True``.
See: https://github.com/saltstack/salt/issues/38558
"""
with patch.dict(pillarmod.__pillar__, {'l1': {'l2': {'l3': 42}}}):
res = pillarmod.get(key='l1')
self.assertEqual({'l2': {'l3': 42}}, res)
default = {'l2': {'l3': 43}}
res = pillarmod.get(key='l1', default=default)
self.assertEqual({'l2': {'l3': 42}}, res)
self.assertEqual({'l2': {'l3': 43}}, default)
res = pillarmod.get(key='l1', default=default, merge=True)
self.assertEqual({'l2': {'l3': 42}}, res)
self.assertEqual({'l2': {'l3': 43}}, default)
def test_pillar_get_default_merge_regression_39062(self):
'''
Confirm that we do not raise an exception if default is None and
merge=True.
See https://github.com/saltstack/salt/issues/39062 for more info.
'''
with patch.dict(pillarmod.__pillar__, {'foo': 'bar'}):
self.assertEqual(
pillarmod.get(key='foo', default=None, merge=True),
'bar',
)