fix: ensure role is idempotent and supports check mode #41
Conversation
This file contains 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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
[citest] |
spetrosi
reviewed
Feb 20, 2024
|
|
||
| - name: Print out response | ||
| debug: | ||
| var: snapshot_cmd.stdout | ||
| var: snapshot_cmd_raw |
There was a problem hiding this comment.
Suggested change
| var: snapshot_cmd_raw | |
| var: snapshot_cmd_raw.stdout |
Should it print only stdout as it was before?
There was a problem hiding this comment.
No - would prefer to see all of the fields rather than just stdout
|
|
||
| - name: Assert no changes for umount | ||
| assert: | ||
| that: not snapshot_cmd["changed"] |
There was a problem hiding this comment.
Cool way to test idempotency!
There was a problem hiding this comment.
We do this in a few roles - have the module (or script in this case) return "changed" as a variable that can be used elsewhere - unfortunately Ansible doesn't expose the internal "changed" counter or state
| snapshot_cmd.stderr_lines is search(__snapshot_failed_regex) | ||
| - snapshot_cmd_raw is failed | ||
| - snapshot_cmd["return_code"] != 0 | ||
| - snapshot_cmd["errors"] is search(__snapshot_failed_regex) | ||
| msg: "{{ __snapshot_failed_msg }}" |
There was a problem hiding this comment.
Suggested change
| msg: "{{ __snapshot_failed_msg }}" | |
| var: __snapshot_failed_msg |
There was a problem hiding this comment.
Looks like var is not a valid parameter for assert
_VALID_ARGS = frozenset(('fail_msg', 'msg', 'quiet', 'success_msg', 'that'))
msg is an alias for fail_msg
Cause: Role was not idempotent, and did not support check mode. Consequence: Users could not use role to ensure idempotence or check state. Fix: The role has been fixed to return `"changed": true` if the role changed the state of the system, and `false` otherwise. This means that some operations that used to return an error, such as trying to snapshot a volume that already had a snapshot, or trying to remove a snapshot that does not exist, will no longer return an error, but will instead just report `"changed": false`. Users should use the `list` operation to examine state of the system. Result: The role is idempotent and supports check mode. Signed-off-by: Rich Megginson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Cause: Role was not idempotent, and did not support check mode.
Consequence: Users could not use role to ensure idempotence or
check state.
Fix: The role has been fixed to return
"changed": trueif therole changed the state of the system, and
falseotherwise. Thismeans that some operations that used to return an error, such as
trying to snapshot a volume that already had a snapshot, or trying
to remove a snapshot that does not exist, will no longer return
an error, but will instead just report
"changed": false. Usersshould use the
listoperation to examine state of the system.Result: The role is idempotent and supports check mode.
Signed-off-by: Rich Megginson [email protected]