Merge pull request #68027 from dwoz/merge/3007.x/3006.x-2025-05-16

Merge forward 3006.x into 3007.x

Author: dwoz

.github/actions/setup-relenv/action.yml

@@ -48,6 +48,7 @@ runs:
       env:
         RELENV_FETCH_VERSION: "${{ inputs.version }}"
       run: |
+        python3 -m pip install relenv[toolchain]
         python3 -m relenv toolchain fetch --arch=${{ inputs.arch }}
 
     - name: Fetch Native Python Build

changelog/65514.fixed.md

@@ -0,0 +1 @@
+Make sure the comment field is populated when test=True for the reg state

changelog/67903.fixed.md

@@ -0,0 +1 @@
+Fixed if arguments are passed to the key delete all, -D, it will throw an error

doc/conf.py

@@ -352,7 +352,6 @@
 ]
 
 man_pages = [
-    ("contents", "salt", "Salt Documentation", authors, 7),
     ("ref/cli/salt", "salt", "salt", authors, 1),
     ("ref/cli/salt-master", "salt-master", "salt-master Documentation", authors, 1),
     ("ref/cli/salt-minion", "salt-minion", "salt-minion Documentation", authors, 1),

pkg/debian/rules

@@ -26,6 +26,7 @@ override_dh_auto_build:
 	export PY=$$(build/onedir/venv/bin/python3 -c 'import sys; sys.stdout.write("{}.{}".format(*sys.version_info)); sys.stdout.flush()') \
 		&& build/onedir/venv/bin/python3 -m pip install -r requirements/static/ci/py$${PY}/tools.txt
 	build/onedir/venv/bin/relenv fetch --python=$${SALT_PYTHON_VERSION}
+	build/onedir/venv/bin/pip3 install relenv[toolchain]
 	build/onedir/venv/bin/relenv toolchain fetch
 	build/onedir/venv/bin/tools pkg build onedir-dependencies --arch $${SALT_PACKAGE_ARCH} --relenv-version=$${SALT_RELENV_VERSION} --python-version $${SALT_PYTHON_VERSION} --package-name build/onedir/salt --platform linux
 

pkg/rpm/salt.spec

@@ -179,6 +179,7 @@ cd $RPM_BUILD_DIR
   export PY=$(build/venv/bin/python3 -c 'import sys; sys.stdout.write("{}.{}".format(*sys.version_info)); sys.stdout.flush()')
   build/venv/bin/python3 -m pip install -r %{_salt_src}/requirements/static/ci/py${PY}/tools.txt
   build/venv/bin/relenv fetch --python=${SALT_PYTHON_VERSION}
+  build/venv/bin/pip3 install relenv[toolchain]
   build/venv/bin/relenv toolchain fetch
   cd %{_salt_src}
 	$RPM_BUILD_DIR/build/venv/bin/tools pkg build onedir-dependencies --arch ${SALT_PACKAGE_ARCH} --relenv-version=${SALT_RELENV_VERSION} --python-version ${SALT_PYTHON_VERSION} --package-name $RPM_BUILD_DIR/build/salt --platform linux

salt/states/reg.py

@@ -72,6 +72,8 @@
 import logging
 
 import salt.utils.stringutils
+import salt.utils.win_dacl as dacl
+import salt.utils.win_reg as reg
 
 log = logging.getLogger(__name__)
 
@@ -80,31 +82,6 @@ def __virtual__():
     """
     Load this state if the reg module exists
     """
-    if "reg.read_value" not in __utils__:
-        return (
-            False,
-            "reg state module failed to load: missing util function: reg.read_value",
-        )
-
-    if "reg.set_value" not in __utils__:
-        return (
-            False,
-            "reg state module failed to load: missing util function: reg.set_value",
-        )
-
-    if "reg.delete_value" not in __utils__:
-        return (
-            False,
-            "reg state module failed to load: missing util function: reg.delete_value",
-        )
-
-    if "reg.delete_key_recursive" not in __utils__:
-        return (
-            False,
-            "reg state module failed to load: "
-            "missing util function: reg.delete_key_recursive",
-        )
-
     return "reg"
 
 
@@ -396,12 +373,12 @@ def present(
     hive, key = _parse_key(name)
 
     # Determine what to do
-    reg_current = __utils__["reg.read_value"](
+    reg_current = reg.read_value(
         hive=hive, key=key, vname=vname, use_32bit_registry=use_32bit_registry
     )
 
     # Cast the vdata according to the vtype
-    vdata_decoded = __utils__["reg.cast_vdata"](vdata=vdata, vtype=vtype)
+    vdata_decoded = reg.cast_vdata(vdata=vdata, vtype=vtype)
 
     # Check if the key already exists
     # If so, check perms
@@ -411,7 +388,7 @@ def present(
             salt.utils.stringutils.to_unicode(vname, "utf-8") if vname else "(Default)",
             salt.utils.stringutils.to_unicode(name, "utf-8"),
         )
-        return __utils__["dacl.check_perms"](
+        return dacl.check_perms(
             obj_name="\\".join([hive, key]),
             obj_type="registry32" if use_32bit_registry else "registry",
             ret=ret,
@@ -437,10 +414,11 @@ def present(
     if __opts__["test"]:
         ret["result"] = None
         ret["changes"] = {"reg": {"Will add": add_change}}
+        ret["comment"] = rf"Will add {vname} to {hive}\{key}"
         return ret
 
     # Configure the value
-    ret["result"] = __utils__["reg.set_value"](
+    ret["result"] = reg.set_value(
         hive=hive,
         key=key,
         vname=vname,
@@ -457,7 +435,7 @@ def present(
         ret["comment"] = rf"Added {vname} to {hive}\{key}"
 
     if ret["result"]:
-        ret = __utils__["dacl.check_perms"](
+        ret = dacl.check_perms(
             obj_name="\\".join([hive, key]),
             obj_type="registry32" if use_32bit_registry else "registry",
             ret=ret,
@@ -517,7 +495,7 @@ def absent(name, vname=None, use_32bit_registry=False):
     hive, key = _parse_key(name)
 
     # Determine what to do
-    reg_check = __utils__["reg.read_value"](
+    reg_check = reg.read_value(
         hive=hive, key=key, vname=vname, use_32bit_registry=use_32bit_registry
     )
     if not reg_check["success"] or reg_check["vdata"] == "(value not set)":
@@ -533,10 +511,11 @@ def absent(name, vname=None, use_32bit_registry=False):
     if __opts__["test"]:
         ret["result"] = None
         ret["changes"] = {"reg": {"Will remove": remove_change}}
+        ret["comment"] = rf"Will remove {vname} to {hive}\{key}"
         return ret
 
     # Delete the value
-    ret["result"] = __utils__["reg.delete_value"](
+    ret["result"] = reg.delete_value(
         hive=hive, key=key, vname=vname, use_32bit_registry=use_32bit_registry
     )
     if not ret["result"]:
@@ -595,26 +574,27 @@ def key_absent(name, use_32bit_registry=False):
     hive, key = _parse_key(name)
 
     # Determine what to do
-    if not __utils__["reg.read_value"](
-        hive=hive, key=key, use_32bit_registry=use_32bit_registry
-    )["success"]:
+    if not reg.read_value(hive=hive, key=key, use_32bit_registry=use_32bit_registry)[
+        "success"
+    ]:
         ret["comment"] = f"{name} is already absent"
         return ret
 
     ret["changes"] = {"reg": {"Removed": {"Key": rf"{hive}\{key}"}}}
+    ret["comment"] = rf"Removed {hive}\{key}"
 
     # Check for test option
     if __opts__["test"]:
         ret["result"] = None
+        ret["changes"] = {"reg": {"Will remove": {"Key": rf"{hive}\{key}"}}}
+        ret["comment"] = rf"Will remove {hive}\{key}"
         return ret
 
     # Delete the value
-    __utils__["reg.delete_key_recursive"](
-        hive=hive, key=key, use_32bit_registry=use_32bit_registry
-    )
-    if __utils__["reg.read_value"](
-        hive=hive, key=key, use_32bit_registry=use_32bit_registry
-    )["success"]:
+    reg.delete_key_recursive(hive=hive, key=key, use_32bit_registry=use_32bit_registry)
+    if reg.read_value(hive=hive, key=key, use_32bit_registry=use_32bit_registry)[
+        "success"
+    ]:
         ret["result"] = False
         ret["changes"] = {}
         ret["comment"] = f"Failed to remove registry key {name}"

tests/pytests/functional/states/test_reg.py

@@ -281,7 +281,7 @@ def test_present_string_dword_existing(reg_vars, clean):
 
 def test_present_test_true(reg_vars, clean):
     expected = {
-        "comment": "",
+        "comment": f"Will add {reg_vars.vname} to {reg_vars.name}",
         "changes": {
             "reg": {
                 "Will add": {
@@ -362,7 +362,7 @@ def test_absent(reg_vars, reset):
 
 def test_absent_test_true(reg_vars, reset):
     expected = {
-        "comment": "",
+        "comment": f"Will remove {reg_vars.vname} to {reg_vars.name}",
         "changes": {
             "reg": {"Will remove": {"Entry": reg_vars.vname, "Key": reg_vars.name}}
         },
@@ -400,3 +400,55 @@ def test_absent_already_absent_test_true(reg_vars, clean):
     with patch.dict(reg.__opts__, {"test": True}):
         ret = reg.absent(reg_vars.name, reg_vars.vname)
     assert ret == expected
+
+
+def test_key_absent(reg_vars, reset):
+    """
+    Test to remove a registry key entry.
+    """
+    expected = {
+        "comment": f"Removed {reg_vars.name}",
+        "changes": {"reg": {"Removed": {"Key": reg_vars.name}}},
+        "name": reg_vars.name,
+        "result": True,
+    }
+    assert reg.key_absent(reg_vars.name) == expected
+
+
+def test_key_absent_already_absent(reg_vars, clean):
+    """
+    Test to remove a registry key entry.
+    """
+    expected = {
+        "comment": f"{reg_vars.name} is already absent",
+        "changes": {},
+        "name": reg_vars.name,
+        "result": True,
+    }
+    assert reg.key_absent(reg_vars.name) == expected
+
+
+def test_key_absent_test_true(reg_vars, reset):
+    expected = {
+        "comment": f"Will remove {reg_vars.name}",
+        "changes": {"reg": {"Will remove": {"Key": reg_vars.name}}},
+        "name": reg_vars.name,
+        "result": None,
+    }
+    with patch.dict(reg.__opts__, {"test": True}):
+        ret = reg.key_absent(reg_vars.name)
+    assert ret == expected
+
+
+def test_key_absent_already_absent_test_true(reg_vars, clean):
+    """
+    Test to remove a registry entry.
+    """
+    expected = {
+        "comment": f"{reg_vars.name} is already absent",
+        "changes": {},
+        "name": reg_vars.name,
+        "result": True,
+    }
+    with patch.dict(reg.__opts__, {"test": True}):
+        assert reg.key_absent(reg_vars.name) == expected