saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge pull request #65326 from garethgreenaway/65080_require_included_sls

Browse source 
[master] Account for included states that only include other states used as requisites
This commit is contained in:
David Murphy 2023-12-08 10:32:09 -07:00 • committed by GitHub
commit 41d69cff5a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 177 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog/65080.fixed.md Normal file
View file

@ -0,0 +1 @@
Keep track when an included file only includes sls files but is a requisite.

23
salt/state.py
View file

@ -107,6 +107,7 @@ STATE_RUNTIME_KEYWORDS = frozenset(
"__env__",
"__sls__",
"__id__",
"__sls_included_from__",
"__orchestration_jid__",
"__pub_user",
"__pub_arg",
@ -669,6 +670,8 @@ class Compiler:
chunk["__sls__"] = body["__sls__"]
if "__env__" in body:
chunk["__env__"] = body["__env__"]
if "__sls_included_from__" in body:
chunk["__sls_included_from__"] = body["__sls_included_from__"]
chunk["__id__"] = name
for arg in run:
if isinstance(arg, str):
@ -1719,6 +1722,8 @@ class State:
chunk["__sls__"] = body["__sls__"]
if "__env__" in body:
chunk["__env__"] = body["__env__"]
if "__sls_included_from__" in body:
chunk["__sls_included_from__"] = body["__sls_included_from__"]
chunk["__id__"] = name
for arg in run:
if isinstance(arg, str):
@ -2928,7 +2933,9 @@ class State:
for chunk in chunks:
if req_key == "sls":
# Allow requisite tracking of entire sls files
if fnmatch.fnmatch(chunk["__sls__"], req_val):
if fnmatch.fnmatch(
chunk["__sls__"], req_val
) or req_val in chunk.get("__sls_included_from__", []):
found = True
reqs[r_state].append(chunk)
continue
@ -3143,7 +3150,9 @@ class State:
continue
if req_key == "sls":
# Allow requisite tracking of entire sls files
if fnmatch.fnmatch(chunk["__sls__"], req_val):
if fnmatch.fnmatch(
chunk["__sls__"], req_val
) or req_val in chunk.get("__sls_included_from__", []):
if requisite == "prereq":
chunk["__prereq__"] = True
reqs.append(chunk)
@ -4486,6 +4495,16 @@ class BaseHighState:
context=context,
)
if nstate:
for item in nstate:
# Skip existing state keywords
if item.startswith("__"):
continue
if "__sls_included_from__" not in nstate[item]:
nstate[item]["__sls_included_from__"] = []
nstate[item]["__sls_included_from__"].append(
sls
)
self.merge_included_states(state, nstate, errors)
state.update(nstate)
if err:

154
tests/pytests/integration/states/test_include.py
View file

@ -38,3 +38,157 @@ def test_issue_64111(salt_master, salt_minion, salt_call_cli):
with tf("common/file1.sls", file1_sls):
ret = salt_call_cli.run("state.apply", "common")
assert ret.returncode == 0
@pytest.mark.slow_test
def test_issue_65080(salt_master, salt_minion, salt_call_cli):
"""
Test scenario when a state includes another state that only includes a third state
"""
only_include_sls = """
include:
- includetest.another-include
"""
another_include_sls = """
/tmp/from-test-file.txt:
file.managed:
- contents: Hello from test-file.sls
"""
init_sls = """
include:
- includetest.only-include
/tmp/from-init.txt:
file.managed:
- contents: Hello from init.sls
- require:
- sls: includetest.only-include
"""
tf = salt_master.state_tree.base.temp_file
with tf("includetest/init.sls", init_sls):
with tf("includetest/another-include.sls", another_include_sls):
with tf("includetest/only-include.sls", only_include_sls):
ret = salt_call_cli.run("state.apply", "includetest")
assert ret.returncode == 0
ret = salt_call_cli.run("state.show_low_sls", "includetest")
assert "__sls_included_from__" in ret.data[0]
assert (
"includetest.only-include" in ret.data[0]["__sls_included_from__"]
)
@pytest.mark.slow_test
def test_issue_65080_multiple_includes(salt_master, salt_minion, salt_call_cli):
"""
Test scenario when a state includes another state that only includes a third state
"""
only_include_one_sls = """
include:
- includetest.include-one
"""
only_include_two_sls = """
include:
- includetest.include-two
"""
include_one_sls = """
/tmp/from-test-file1.txt:
file.managed:
- contents: Hello from test-file.sls
"""
include_two_sls = """
/tmp/from-test-file2.txt:
file.managed:
- contents: Hello from test-file.sls
"""
init_sls = """
include:
- includetest.only-include-one
- includetest.only-include-two
/tmp/from-init.txt:
file.managed:
- contents: Hello from init.sls
- require:
- sls: includetest.only-include-one
- sls: includetest.only-include-two
"""
tf = salt_master.state_tree.base.temp_file
with tf("includetest/init.sls", init_sls):
with tf("includetest/include-one.sls", include_one_sls), tf(
"includetest/include-two.sls", include_two_sls
):
with tf("includetest/only-include-one.sls", only_include_one_sls), tf(
"includetest/only-include-two.sls", only_include_two_sls
):
ret = salt_call_cli.run("state.apply", "includetest")
assert ret.returncode == 0
ret = salt_call_cli.run("state.show_low_sls", "includetest")
assert "__sls_included_from__" in ret.data[0]
assert (
"includetest.only-include-one"
in ret.data[0]["__sls_included_from__"]
)
assert "__sls_included_from__" in ret.data[1]
assert (
"includetest.only-include-two"
in ret.data[1]["__sls_included_from__"]
)
@pytest.mark.slow_test
def test_issue_65080_saltenv(salt_master, salt_minion, salt_call_cli):
"""
Test scenario when a state includes another state that only includes a third state
"""
only_include_sls = """
include:
- includetest.another-include
"""
another_include_sls = """
/tmp/from-test-file.txt:
file.managed:
- contents: Hello from test-file.sls
"""
init_sls = """
include:
- prod: includetest.only-include
/tmp/from-init.txt:
file.managed:
- contents: Hello from init.sls
- require:
- sls: includetest.only-include
"""
base_tf = salt_master.state_tree.base.temp_file
prod_tf = salt_master.state_tree.prod.temp_file
with base_tf("includetest/init.sls", init_sls):
with prod_tf("includetest/only-include.sls", only_include_sls):
with prod_tf("includetest/another-include.sls", another_include_sls):
ret = salt_call_cli.run("state.apply", "includetest")
assert ret.returncode == 0
ret = salt_call_cli.run("state.show_low_sls", "includetest")
assert "__sls_included_from__" in ret.data[0]
assert (
"includetest.only-include" in ret.data[0]["__sls_included_from__"]
)

1
tests/pytests/unit/state/test_state_highstate.py
View file

@ -323,6 +323,7 @@ def test_dont_extend_in_excluded_sls_file(highstate, state_tree_dir):
),
("__sls__", "test2"),
("__env__", "base"),
("__sls_included_from__", ["test1"]),
]
),
),