[3006.x] module.run: fix result detection from returned dict

[hurzhurz]

What does this PR do?

Fixes #65842 Module.run state returns invalid result when method returns a dict

module.run should also check for a key result in the return of the executed module to determin if it was successful.
But this only works for the legacy- and not the new-style.

This is because in the new-style, the _get_result function is always executed with a actually empty dict as the changes parameter, where it searches for the result key.

Also this changes parameter is not necessary as even, in the case of the legacy-style, it is effectively just a copy of the func_ret parameter.

[bdrx312]

This case is already handled on line 699

salt/salt/states/module.py

Line 669 in 1c23b3d

if isinstance(func_ret, dict) and func_ret.get("retcode", 0) != 0:

[hurzhurz]

You are right, I missed that while changing it from changes_ret to func_ret. I will edit that!

[bdrx312]

There is no longer an else case for when func_ret is not a bool nor a dict, the return will be True. The func_ret not being a bool nor dict is unexpected so should throw an exception or at least return False. Also we are checking isinstance(func_ret, dict) multiple times (also on line 669). We should just check once and have the func_ret.get("retcode", 0) != 0 check be inside it.

[hurzhurz]

There was not really a plain else case before, as the else had the if isinstance(changes_ret, dict) inside which itself had no else case.
And I think it is ok or even wanted to have it return True in such cases: Not every execution module function does give a clear successful/unsuccessful indication.

[bdrx312]

Not every execution module function does give a clear successful/unsuccessful indication.

In that case I would expect func_ret to be None which I recommend we handle in the way you deem correct, but an unexpected data type should either return the truth/bool value of it self (i.e. bool(func_ret) so empty list [] is False and list with value is True) or should throw an exception because we are getting an unexpected value. We should not do the worst case though of returning True that function was successful it wasn't and returned a bad value.

[bdrx312]

typo is is

[bdrx312]

Since we determined the result is already in the dict, I recommend using [] instead of get. Also we don't use the default {} value on line 674 so I recommend using None instead:

if isinstance(func_ret.get("result"), bool):
    res = func_ret["result"]

alternatively we can use the newer python := assignment operator:

if isinstance(bool_res := func_ret.get("result"), bool):
    res = bool_res