mirror of
https://github.com/saltstack/salt.git
synced 2025-04-16 09:40:20 +00:00
state.orchestrate_single does not pass pillar=None
Passing a pillar to state.single can results in state functions not working when they don't accept a pillar keyword argument. One example where this is the case is salt.wait_for_event. When no pillar is provided, it does not need to be passed.
This commit is contained in:
parent
8af493bdbd
commit
2c03915529
3 changed files with 50 additions and 3 deletions
3
changelog/61092.fixed
Normal file
3
changelog/61092.fixed
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
state.orchestrate_single only passes a pillar if it is set to the state
|
||||||
|
function. This allows it to be used with state functions that don't accept a
|
||||||
|
pillar keyword argument.
|
|
@ -150,12 +150,16 @@ def orchestrate_single(fun, name, test=None, queue=False, pillar=None, **kwargs)
|
||||||
|
|
||||||
salt-run state.orchestrate_single fun=salt.wheel name=key.list_all
|
salt-run state.orchestrate_single fun=salt.wheel name=key.list_all
|
||||||
"""
|
"""
|
||||||
if pillar is not None and not isinstance(pillar, dict):
|
if pillar is not None:
|
||||||
raise SaltInvocationError("Pillar data must be formatted as a dictionary")
|
if isinstance(pillar, dict):
|
||||||
|
kwargs["pillar"] = pillar
|
||||||
|
else:
|
||||||
|
raise SaltInvocationError("Pillar data must be formatted as a dictionary")
|
||||||
|
|
||||||
__opts__["file_client"] = "local"
|
__opts__["file_client"] = "local"
|
||||||
minion = salt.minion.MasterMinion(__opts__)
|
minion = salt.minion.MasterMinion(__opts__)
|
||||||
running = minion.functions["state.single"](
|
running = minion.functions["state.single"](
|
||||||
fun, name, test=None, queue=False, pillar=pillar, **kwargs
|
fun, name, test=None, queue=False, **kwargs
|
||||||
)
|
)
|
||||||
ret = {minion.opts["id"]: running}
|
ret = {minion.opts["id"]: running}
|
||||||
__jid_event__.fire_event({"data": ret, "outputter": "highstate"}, "progress")
|
__jid_event__.fire_event({"data": ret, "outputter": "highstate"}, "progress")
|
||||||
|
|
40
tests/pytests/unit/runners/test_state.py
Normal file
40
tests/pytests/unit/runners/test_state.py
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from salt.runners import state as state_runner
|
||||||
|
from tests.support.mock import Mock, patch
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def configure_loader_modules():
|
||||||
|
return {state_runner: {"__opts__": {}, "__jid_event__": Mock()}}
|
||||||
|
|
||||||
|
|
||||||
|
def test_orchestrate_single_passes_pillar():
|
||||||
|
"""
|
||||||
|
test state.orchestrate_single passes given pillar to state.single
|
||||||
|
"""
|
||||||
|
mock_master_minion = Mock()
|
||||||
|
mock_state_single = Mock()
|
||||||
|
mock_master_minion.functions = {"state.single": mock_state_single}
|
||||||
|
mock_master_minion.opts = {"id": "dummy"}
|
||||||
|
test_pillar = {"test_entry": "exists"}
|
||||||
|
with patch("salt.minion.MasterMinion", Mock(return_value=mock_master_minion)):
|
||||||
|
state_runner.orchestrate_single(
|
||||||
|
fun="pillar.get", name="test_entry", pillar=test_pillar
|
||||||
|
)
|
||||||
|
assert mock_state_single.call_args.kwargs["pillar"] == test_pillar
|
||||||
|
|
||||||
|
|
||||||
|
def test_orchestrate_single_does_not_pass_none_pillar():
|
||||||
|
"""
|
||||||
|
test state.orchestrate_single does not pass pillar=None to state.single
|
||||||
|
"""
|
||||||
|
mock_master_minion = Mock()
|
||||||
|
mock_state_single = Mock()
|
||||||
|
mock_master_minion.functions = {"state.single": mock_state_single}
|
||||||
|
mock_master_minion.opts = {"id": "dummy"}
|
||||||
|
with patch("salt.minion.MasterMinion", Mock(return_value=mock_master_minion)):
|
||||||
|
state_runner.orchestrate_single(
|
||||||
|
fun="pillar.get", name="test_entry", pillar=None
|
||||||
|
)
|
||||||
|
assert "pillar" not in mock_state_single.call_args.kwargs
|
Loading…
Add table
Reference in a new issue