fixes saltstack/salt#64418 configurable_test_state should be able to return False result in test mode

changelog/64418.added.md

@@ -0,0 +1 @@
+Add ability to return False result in test mode of configurable_test_state

salt/states/test.py

@@ -173,7 +173,14 @@ def fail_with_changes(name, **kwargs):  # pylint: disable=unused-argument
     return ret
 
 
-def configurable_test_state(name, changes=True, result=True, comment="", warnings=None):
+def configurable_test_state(
+    name,
+    changes=True,
+    result=True,
+    comment="",
+    warnings=None,
+    allow_test_mode_failure=False,
+):
     """
     .. versionadded:: 2014.7.0
 
@@ -221,6 +228,13 @@ def configurable_test_state(name, changes=True, result=True, comment="", warning
         Default is None
 
         .. versionadded:: 3000
+
+    allow_test_mode_failure
+        When False, running this state in test mode can only return a True
+        or None result. When set to True and result is set to False, the
+        test mode result will be False. Default is False
+
+        .. versionadded:: 3007.0
     """
     ret = {"name": name, "changes": {}, "result": False, "comment": comment}
     change_data = {
@@ -276,7 +290,11 @@ def configurable_test_state(name, changes=True, result=True, comment="", warning
         )
 
     if __opts__["test"]:
-        ret["result"] = True if changes is False else None
+        if allow_test_mode_failure and result is False:
+            test_result = result
+        else:
+            test_result = True if changes is False else None
+        ret["result"] = test_result
         ret["comment"] = "This is a test" if not comment else comment
 
     return ret

tests/pytests/unit/states/test_test.py

@@ -354,7 +354,6 @@ def test_configurable_test_state_test():
         ret = test.configurable_test_state(mock_name)
         assert ret == mock_ret
 
-    with patch.dict(test.__opts__, {"test": True}):
         mock_ret = {
             "name": mock_name,
             "changes": mock_changes,
@@ -364,7 +363,6 @@ def test_configurable_test_state_test():
         ret = test.configurable_test_state(mock_name, comment=mock_comment)
         assert ret == mock_ret
 
-    with patch.dict(test.__opts__, {"test": True}):
         mock_ret = {
             "name": mock_name,
             "changes": mock_changes,
@@ -376,7 +374,6 @@ def test_configurable_test_state_test():
         )
         assert ret == mock_ret
 
-    with patch.dict(test.__opts__, {"test": True}):
         mock_ret = {
             "name": mock_name,
             "changes": {},
@@ -388,6 +385,30 @@ def test_configurable_test_state_test():
         )
         assert ret == mock_ret
 
+        # normal test mode operation doesn't allow False result
+        mock_ret = {
+            "name": mock_name,
+            "changes": {},
+            "result": True,
+            "comment": "This is a test",
+        }
+        ret = test.configurable_test_state(
+            mock_name, changes=False, result=False, allow_test_mode_failure=False
+        )
+        assert ret == mock_ret
+
+        # test allow False result in test mode
+        mock_ret = {
+            "name": mock_name,
+            "changes": {},
+            "result": False,
+            "comment": "This is a test",
+        }
+        ret = test.configurable_test_state(
+            mock_name, changes=False, result=False, allow_test_mode_failure=True
+        )
+        assert ret == mock_ret
+
 
 def test_mod_watch():
     """