Skip to content

Uniquify requisite_in'd states checks. #68409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: 3006.x
Choose a base branch
from
+269 −38
Open

Uniquify requisite_in'd states checks. #68409

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fa5de69
Uniquify requisite_in'd states checks.
gpernot-celeste Oct 17, 2025
db7d658
fix: remove no-op
gpernot-celeste Oct 19, 2025
aa56dc4
clarifications
gpernot-celeste Oct 20, 2025
3ef0957
bug fix and improved tests
gpernot-celeste Oct 20, 2025
57081d2
Merge branch 'salt-fix-requisites-2' into salt-fix-requisites
gpernot-celeste Oct 20, 2025
b44d1f6
rename _req_module to _state_args
gpernot-celeste Oct 21, 2025
be6dba0
rename _mod_req to state_arg
gpernot-celeste Oct 23, 2025
574e90d
add changelog for #68408
gpernot-celeste Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 47 additions & 38 deletions salt/state.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1903,6 +1903,44 @@ def apply_exclude(self, high):
high.pop(id_)
return high

@staticmethod
def _add_to_extend(
extend,
id_to_extend,
state_mod_name,
req_type,
req_id,
req_state_mod_name,
):
"""
Add req_id as a requisite for id_to_extend
"""

if id_to_extend not in extend:
# The state does not exist yet: create it
extend[id_to_extend] = HashableOrderedDict()

if (_req_module := extend[id_to_extend].get(state_mod_name)) is None:
# The state module is not present yet, create it and initialize it
extend[id_to_extend][state_mod_name] = [
{req_type: [{req_state_mod_name: req_id}]}
]
return

# Lookup req_type in _req_module
for _mod_req in _req_module:
if (req_items := _mod_req.get(req_type)) is not None:
for req_item in req_items:
if req_item.get(req_state_mod_name) == req_id:
# (req_state_mode_name, req_id) is already defined as a requisiste
return
else:
# Extending again
_mod_req[req_type].append({req_state_mod_name: req_id})
return
# req_type does not exist already for this state module
_req_module.append({req_type: [{req_state_mod_name: req_id}]})

def requisite_in(self, high):
"""
Extend the data reference with requisite_in arguments
Expand Down Expand Up @@ -1953,11 +1991,7 @@ def requisite_in(self, high):
if isinstance(items, dict):
# Formatted as a single req_in
for _state, name in items.items():

# Not a use requisite_in
found = False
if name not in extend:
extend[name] = HashableOrderedDict()
if "." in _state:
errors.append(
"Invalid requisite in {}: {} for "
Expand All @@ -1971,23 +2005,12 @@ def requisite_in(self, high):
)
)
_state = _state.split(".")[0]
if _state not in extend[name]:
extend[name][_state] = []
self._add_to_extend(
extend, name, _state, rkey, id_, state
)
extend[name]["__env__"] = body["__env__"]
extend[name]["__sls__"] = body["__sls__"]
for ind in range(len(extend[name][_state])):
if next(iter(extend[name][_state][ind])) == rkey:
# Extending again
extend[name][_state][ind][rkey].append(
{state: id_}
)
found = True
if found:
continue
# The rkey is not present yet, create it
extend[name][_state].append({rkey: [{state: id_}]})

if isinstance(items, list):
elif isinstance(items, list):
# Formed as a list of requisite additions
hinges = []
for ind in items:
Expand Down Expand Up @@ -2123,27 +2146,13 @@ def requisite_in(self, high):
continue
extend[id_][state].append(arg)
continue
found = False
if name not in extend:
extend[name] = HashableOrderedDict()
if _state not in extend[name]:
extend[name][_state] = []
self._add_to_extend(
extend, name, _state, rkey, id_, state
)

extend[name]["__env__"] = body["__env__"]
extend[name]["__sls__"] = body["__sls__"]
for ind in range(len(extend[name][_state])):
if (
next(iter(extend[name][_state][ind]))
== rkey
):
# Extending again
extend[name][_state][ind][rkey].append(
{state: id_}
)
found = True
if found:
continue
# The rkey is not present yet, create it
extend[name][_state].append({rkey: [{state: id_}]})

high["__extend__"] = []
for key, val in extend.items():
high["__extend__"].append({key: val})
Expand Down
222 changes: 222 additions & 0 deletions tests/pytests/unit/state/test_add_to_extend.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
from copy import deepcopy

import pytest

import salt.state
from salt.utils.odict import HashableOrderedDict

pytestmark = [
pytest.mark.core_test,
]


simple_extend_test_cases = [
(
# Simple addition
#
# add_to_extend:
# foo:
# file.managed:
# - required_in:
# - file: bar
{}, # extend
"bar", # id_to_extend
"file", # state_mod_name
"require", # req_type
"foo", # req_id
"file", # req_state_mod_name
{"bar": {"file": [{"require": [{"file": "foo"}]}]}}, # expected
),
(
# Requisite already exists
#
# bar:
# file.managed:
# require:
# - file: foo
# baz:
# file.managed:
# - require:
# - file: foo
#
# add_to_extend:
# foo:
# file.managed:
# - required_in:
# - file: baz
{ # extend
"bar": {
"file": [{"require": [{"file": "foo"}]}],
},
"baz": {
"file": [{"require": [{"file": "foo"}]}],
},
},
"baz", # id_to_extend
"file", # state_mod_name
"require", # req_type
"foo", # req_id
"file", # req_state_mod_name
{ # expected
"bar": {
"file": [{"require": [{"file": "foo"}]}],
},
"baz": {
"file": [{"require": [{"file": "foo"}]}],
},
},
),
(
# Append requisite
#
# bar:
# file.managed:
# require:
# - file: foo
# baz:
# file.managed:
# - require:
# - file: foo
#
# add_to_extend:
# bar:
# file.managed:
# - require_in:
# - file: baz
{ # extend
"bar": HashableOrderedDict(
[
("file", [{"require": [{"file": "foo"}]}]),
]
),
"baz": HashableOrderedDict(
[
("file", [{"require": [{"file": "foo"}]}]),
]
),
},
"baz", # id_to_extend
"file", # state_mod_name
"require", # req_type
"bar", # req_id
"file", # req_state_mod_name
{ # expected
"bar": HashableOrderedDict(
[
("file", [{"require": [{"file": "foo"}]}]),
]
),
"baz": HashableOrderedDict(
[
("file", [{"require": [{"file": "foo"}, {"file": "bar"}]}]),
]
),
},
),
(
# Append with different requisite type
#
# bar:
# file.managed:
# require:
# - file: foo
# baz:
# file.managed:
# - require:
# - file: foo
#
# add_to_extend:
# bar:
# file.managed:
# - prereq_in:
# - file: baz
{ # extend
"bar": {
"file": [{"require": [{"file": "foo"}]}],
},
"baz": {
"file": [{"require": [{"file": "foo"}]}],
},
},
"baz", # id_to_extend
"file", # state_mod_name
"prereq", # req_type
"bar", # req_id
"file", # req_state_mod_name
{ # expected
"bar": {
"file": [
{
"require": [
{"file": "foo"},
]
},
],
},
"baz": {
"file": [
{
"require": [
{"file": "foo"},
]
},
{
"prereq": [
{"file": "bar"},
]
},
],
},
},
),
]


def _flatten_extend(a):
return {
(k1, k2, k4, k6, v6)
for k1, v1 in a.items()
for k2, v2 in v1.items()
for v3 in v2
for k4, v4 in v3.items()
for v5 in v4
for k6, v6 in v5.items()
}


def test_flatten():
a = {
"bar": {"file": [{"require": [{"file": "foo"}]}]},
"baz": {
"file": [
{"require": [{"file": "foo"}]},
{"prereq": [{"file": "bar"}]},
]
},
}
b = {
"baz": {
"file": [
{"prereq": [{"file": "bar"}]},
{"require": [{"file": "foo"}]},
]
},
"bar": {"file": [{"require": [{"file": "foo"}]}]},
}
assert _flatten_extend(a) == _flatten_extend(b)


@pytest.mark.parametrize(
"extend,id_to_extend,state_mod_name,req_type,req_id,req_state_mod_name,expected",
simple_extend_test_cases,
)
def test_simple_extend(
extend, id_to_extend, state_mod_name, req_type, req_id, req_state_mod_name, expected
):
# local copy of extend, as it is modified by _add_to_extend
_extend = deepcopy(extend)

salt.state.State._add_to_extend(
_extend, id_to_extend, state_mod_name, req_type, req_id, req_state_mod_name
)
assert _flatten_extend(_extend) == _flatten_extend(expected)