Return correct result from module.run state #58752
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
requested a review
from 
Ch3LL
suggested changes
Oct 27, 2020
Contributor
Ch3LL
left a comment
Ch3LL
left a comment
There was a problem hiding this comment.
could you also add a changelog entry as documented here: https://docs.saltstack.com/en/master/topics/development/changelog.html
amendlik
force-pushed
the
module-run-state
branch
2 times, most recently
from
ed38d17 to
810e0d7
Compare
Ch3LL
previously approved these changes
Nov 3, 2020
krionbsd
previously approved these changes
Nov 9, 2020
Contributor
|
@amendlik looks like there are some merge conflicts that need to be cleaned up. |
amendlik
force-pushed
the
module-run-state
branch
from
70928c8 to
e0d13d5
Compare
module.run contained a bug where it would return True when run with test=true. According to the documentation at http://docs.saltstack.com/ref/states/writing.html#return-data the state should return None in test mode if a change would be made without test mode. Since module.run is not idempotent, the appropriate return should always be None, as long as no errors were encountered.
amendlik
force-pushed
the
module-run-state
branch
from
e0d13d5 to
12f2ae8
Compare
Contributor
Author
|
@Ch3LL Ok, I rewrote my changes so they will merge with the updated files. What else do I need to do to get this merged? |
Contributor
Author
|
@Ch3LL I would like to get this merged. What steps remain? |
2 similar comments
Contributor
Author
|
@Ch3LL I would like to get this merged. What steps remain? |
Contributor
Author
|
@Ch3LL I would like to get this merged. What steps remain? |
krionbsd
previously approved these changes
Feb 12, 2021
Contributor
|
re-running the failed windows test to see if it is flakey or not, will check back later today on results |
Ch3LL
previously approved these changes
Feb 23, 2021
s0undt3ch
reviewed
Feb 24, 2021
amendlik
force-pushed
the
module-run-state
branch
from
2265644 to
5193dd1
Compare
s0undt3ch
approved these changes
Feb 24, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Correct two bugs in the
module.runstate where the wrong result is returned.module.runshould returnNone, indicating that changes would be made when not run in test modeFalse, indicating an invocation error.What issues does this PR fix or reference?
None
Previous Behavior
module.runreturnedTrue, which indicates that no change would be made in in live mode. This is wrong becausemodules.runalways executes the configured functionsmodule.runreturnedTrue. This should returnFalseto indicate an error.New Behavior
module.runreturnsNone, which indicates that changes will be made in in live mode.module.runreturnFalse, which indicate an error.Merge requirements satisfied?
Commits signed with GPG?
Yes