mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Merge pull request #54942 from dwoz/fix-54941
Fix for 54941 pillar_refresh regression
This commit is contained in:
Daniel Wozniak
GitHub
commit
2f817bc600
3 changed files with 192 additions and 9 deletions
|
|
@ -433,13 +433,14 @@ class MinionBase(object):
|
|||
|
||||
salt '*' sys.reload_modules
|
||||
'''
|
||||
self.opts['pillar'] = salt.pillar.get_pillar(
|
||||
self.opts,
|
||||
self.opts['grains'],
|
||||
self.opts['id'],
|
||||
self.opts['saltenv'],
|
||||
pillarenv=self.opts.get('pillarenv'),
|
||||
).compile_pillar()
|
||||
if initial_load:
|
||||
self.opts['pillar'] = salt.pillar.get_pillar(
|
||||
self.opts,
|
||||
self.opts['grains'],
|
||||
self.opts['id'],
|
||||
self.opts['saltenv'],
|
||||
pillarenv=self.opts.get('pillarenv'),
|
||||
).compile_pillar()
|
||||
|
||||
self.utils = salt.loader.utils(self.opts)
|
||||
self.functions = salt.loader.minion_mods(self.opts, utils=self.utils)
|
||||
|
|
@ -2205,6 +2206,8 @@ class Minion(MinionBase):
|
|||
self.module_refresh(force_refresh)
|
||||
self.matchers_refresh()
|
||||
self.beacons_refresh()
|
||||
evt = salt.utils.event.get_event('minion', opts=self.opts)
|
||||
evt.fire_event({'complete': True}, tag='/salt/minion/minion_pillar_refresh_complete')
|
||||
|
||||
def manage_schedule(self, tag, data):
|
||||
'''
|
||||
|
|
|
|||
|
|
@ -1027,10 +1027,16 @@ def refresh_matchers():
|
|||
return ret
|
||||
|
||||
|
||||
def refresh_pillar():
|
||||
def refresh_pillar(wait=False, timeout=30):
|
||||
'''
|
||||
Signal the minion to refresh the pillar data.
|
||||
|
||||
:param wait: Wait for pillar refresh to complete, defaults to False.
|
||||
:type wait: bool, optional
|
||||
:param timeout: How long to wait in seconds, only used when wait is True, defaults to 30.
|
||||
:type timeout: int, optional
|
||||
:return: Boolean status, True when the pillar_refresh event was fired successfully.
|
||||
|
||||
CLI Example:
|
||||
|
||||
.. code-block:: bash
|
||||
|
|
@ -1042,6 +1048,13 @@ def refresh_pillar():
|
|||
except KeyError:
|
||||
log.error('Event module not available. Module refresh failed.')
|
||||
ret = False # Effectively a no-op, since we can't really return without an event system
|
||||
if wait:
|
||||
eventer = salt.utils.event.get_event('minion', opts=__opts__, listen=True)
|
||||
event_ret = eventer.get_event(
|
||||
tag='/salt/minion/minion_pillar_refresh_complete',
|
||||
wait=timeout)
|
||||
if not event_ret or event_ret['complete'] is False:
|
||||
log.warn("Pillar refresh did not complete within timeout %s", timeout)
|
||||
return ret
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,8 @@ import subprocess
|
|||
from tests.support.case import ModuleCase
|
||||
from tests.support.paths import TMP, TMP_CONF_DIR
|
||||
from tests.support.unit import skipIf
|
||||
from tests.support.helpers import requires_system_grains
|
||||
from tests.support.helpers import requires_system_grains, dedent
|
||||
from tests.support.runtests import RUNTIME_VARS
|
||||
|
||||
# Import salt libs
|
||||
import salt.utils.files
|
||||
|
|
@ -490,3 +491,169 @@ class DecryptGPGPillarTest(ModuleCase):
|
|||
expected['secrets']['vault']['baz'])
|
||||
self.assertEqual(ret['secrets']['vault']['qux'],
|
||||
expected['secrets']['vault']['qux'])
|
||||
|
||||
|
||||
class RefreshPillarTest(ModuleCase):
|
||||
'''
|
||||
These tests validate the behavior defined in the documentation:
|
||||
|
||||
https://docs.saltstack.com/en/latest/topics/pillar/#in-memory-pillar-data-vs-on-demand-pillar-data
|
||||
|
||||
These tests also serve as a regression test for:
|
||||
|
||||
https://github.com/saltstack/salt/issues/54941
|
||||
'''
|
||||
|
||||
def cleanup_pillars(self, top_path, pillar_path):
|
||||
os.remove(top_path)
|
||||
os.remove(pillar_path)
|
||||
self.run_function('saltutil.refresh_pillar', arg=(True,))
|
||||
|
||||
def create_pillar(self, key):
|
||||
'''
|
||||
Utility method to create a pillar for the minion and a value of true,
|
||||
this method also removes and cleans up the pillar at the end of the
|
||||
test.
|
||||
'''
|
||||
top_path = os.path.join(RUNTIME_VARS.TMP_PILLAR_TREE, 'top.sls')
|
||||
pillar_path = os.path.join(RUNTIME_VARS.TMP_PILLAR_TREE, 'test_pillar.sls')
|
||||
with salt.utils.files.fopen(top_path, 'w') as fd:
|
||||
fd.write(dedent('''
|
||||
base:
|
||||
'minion':
|
||||
- test_pillar
|
||||
'''))
|
||||
with salt.utils.files.fopen(pillar_path, 'w') as fd:
|
||||
fd.write(dedent('''
|
||||
{}: true
|
||||
'''.format(key)))
|
||||
self.addCleanup(self.cleanup_pillars, top_path, pillar_path)
|
||||
|
||||
def test_pillar_refresh_pillar_raw(self):
|
||||
'''
|
||||
Validate the minion's pillar.raw call behavior for new pillars
|
||||
'''
|
||||
key = 'issue-54941-raw'
|
||||
|
||||
# We do not expect to see the pillar beacuse it does not exist yet
|
||||
val = self.run_function('pillar.raw', arg=(key,))
|
||||
assert val == {}
|
||||
|
||||
self.create_pillar(key)
|
||||
|
||||
# The pillar exists now but raw reads it from in-memory pillars
|
||||
val = self.run_function('pillar.raw', arg=(key,))
|
||||
assert val == {}
|
||||
|
||||
# Calling refresh_pillar to update in-memory pillars
|
||||
ret = self.run_function('saltutil.refresh_pillar', arg=(True,))
|
||||
|
||||
# The pillar can now be read from in-memory pillars
|
||||
val = self.run_function('pillar.raw', arg=(key,))
|
||||
assert val is True, repr(val)
|
||||
|
||||
def test_pillar_refresh_pillar_get(self):
|
||||
'''
|
||||
Validate the minion's pillar.get call behavior for new pillars
|
||||
'''
|
||||
key = 'issue-54941-get'
|
||||
|
||||
# We do not expect to see the pillar beacuse it does not exist yet
|
||||
val = self.run_function('pillar.get', arg=(key,))
|
||||
assert val == ''
|
||||
top_path = os.path.join(RUNTIME_VARS.TMP_PILLAR_TREE, 'top.sls')
|
||||
pillar_path = os.path.join(RUNTIME_VARS.TMP_PILLAR_TREE, 'test_pillar.sls')
|
||||
|
||||
self.create_pillar(key)
|
||||
|
||||
# The pillar exists now but get reads it from in-memory pillars, no
|
||||
# refresh happens
|
||||
val = self.run_function('pillar.get', arg=(key,))
|
||||
assert val == ''
|
||||
|
||||
# Calling refresh_pillar to update in-memory pillars
|
||||
ret = self.run_function('saltutil.refresh_pillar', arg=(True,))
|
||||
assert ret is True
|
||||
|
||||
# The pillar can now be read from in-memory pillars
|
||||
val = self.run_function('pillar.get', arg=(key,))
|
||||
assert val is True, repr(val)
|
||||
|
||||
def test_pillar_refresh_pillar_item(self):
|
||||
'''
|
||||
Validate the minion's pillar.item call behavior for new pillars
|
||||
'''
|
||||
key = 'issue-54941-item'
|
||||
|
||||
# We do not expect to see the pillar beacuse it does not exist yet
|
||||
val = self.run_function('pillar.item', arg=(key,))
|
||||
assert key in val
|
||||
assert val[key] == ''
|
||||
|
||||
self.create_pillar(key)
|
||||
|
||||
# The pillar exists now but get reads it from in-memory pillars, no
|
||||
# refresh happens
|
||||
val = self.run_function('pillar.item', arg=(key,))
|
||||
assert key in val
|
||||
assert val[key] == ''
|
||||
|
||||
# Calling refresh_pillar to update in-memory pillars
|
||||
ret = self.run_function('saltutil.refresh_pillar', arg=(True,))
|
||||
assert ret is True
|
||||
|
||||
# The pillar can now be read from in-memory pillars
|
||||
val = self.run_function('pillar.item', arg=(key,))
|
||||
assert key in val
|
||||
assert val[key] is True
|
||||
|
||||
def test_pillar_refresh_pillar_items(self):
|
||||
'''
|
||||
Validate the minion's pillar.item call behavior for new pillars
|
||||
'''
|
||||
key = 'issue-54941-items'
|
||||
|
||||
# We do not expect to see the pillar beacuse it does not exist yet
|
||||
val = self.run_function('pillar.items')
|
||||
assert key not in val
|
||||
|
||||
self.create_pillar(key)
|
||||
|
||||
# A pillar.items call sees the pillar right away because a
|
||||
# refresh_pillar event is fired.
|
||||
val = self.run_function('pillar.items')
|
||||
assert key in val
|
||||
assert val[key] is True
|
||||
|
||||
def test_pillar_refresh_pillar_ping(self):
|
||||
'''
|
||||
Validate the minion's test.ping does not update pillars
|
||||
|
||||
See: https://github.com/saltstack/salt/issues/54941
|
||||
'''
|
||||
key = 'issue-54941-ping'
|
||||
|
||||
# We do not expect to see the pillar beacuse it does not exist yet
|
||||
val = self.run_function('pillar.item', arg=(key,))
|
||||
assert key in val
|
||||
assert val[key] == ''
|
||||
|
||||
self.create_pillar(key)
|
||||
|
||||
val = self.run_function('test.ping')
|
||||
assert val is True
|
||||
|
||||
# The pillar exists now but get reads it from in-memory pillars, no
|
||||
# refresh happens
|
||||
val = self.run_function('pillar.item', arg=(key,))
|
||||
assert key in val
|
||||
assert val[key] == ''
|
||||
|
||||
# Calling refresh_pillar to update in-memory pillars
|
||||
ret = self.run_function('saltutil.refresh_pillar', arg=(True,))
|
||||
assert ret is True
|
||||
|
||||
# The pillar can now be read from in-memory pillars
|
||||
val = self.run_function('pillar.item', arg=(key,))
|
||||
assert key in val
|
||||
assert val[key] is True
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue