WIP: Discourage boolean values in string fields #66631
Open
+15
−0
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
The YAML 1.1 specification mandates converting boolean-like values such as 'yes' and 'no' to a booleans, unless quoted. If the user forgets to quote 'yes' in a module which offers this choice in a string parameter, then Ansible gives a very confusing warning: ``` [WARNING]: The value True (type bool) in a string field was converted to u'True' (type string). If this does not look like what you expect, quote the entire value to ensure it does not change. ``` While one could probably come up with a way to work around this warning, I think that Ansible should discourage module developers from using boolean-like value choices in string fields. This commit adds a deprecation warning in AnsibleModule. The only module in my playlist that showed this warning was the apt module, which this commit also fixes. Future version of Ansible should fail when boolean-like values are valid choices in string parameters.
ansibot
added
affects_2.10
|
The test |
ansibot
added
needs_revision
|
The test |
tremble
suggested changes
Jan 21, 2020
lib/ansible/module_utils/basic.py
Outdated
| 'Update the code and API for this module. AnsibleModule will ' | ||
| 'refuse to accept such choices in the ' | ||
| 'future').format(','.join(map(str, BOOLEANS))) | ||
| self.deprecate(msg, version='2.12') |
There was a problem hiding this comment.
This is a pretty short deprecation cycle, I thought we were supposed to wait for 2.14 at this point
| - If full, performs an aptitude full-upgrade. | ||
| - If dist, performs an apt-get dist-upgrade. | ||
| - 'Note: This does not upgrade a specific package, use state=latest for that.' | ||
| - 'Note: Since 2.4, apt-get is used as a fall-back if aptitude is not present.' | ||
| version_added: "1.1" | ||
| choices: [ dist, full, 'no', safe, 'yes' ] | ||
| default: 'no' | ||
| choices: [ '', safe, dist, full ] |
There was a problem hiding this comment.
This will be an instant break for anyone using 'yes' or 'no' and should probably be deprecated at the same cadence.
cristiklein
changed the title
ansibot
added
the
WIP
|
The test The test |
|
@tremble I made the changes we discussed. Mind taking another look? (I have the feeling that the CI failure is NOT due to external reasons. Please comment if I'm wrong.) |
samdoran
removed
the
needs_triage
ansibot
added
the
stale_ci
ansibot
added
the
needs_rebase
ansibot
added
pre_azp
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.
The YAML 1.1 specification mandates converting boolean-like values such
as 'yes' and 'no' to a booleans, unless quoted. If the user forgets to quote 'yes' in a module which offers this choice in a string parameter, then Ansible
gives a very confusing warning:
While one could probably come up with a way to work around this warning, I
think that Ansible should discourage module developers from using
boolean-like value choices in string fields.
This commit adds a deprecation warning in AnsibleModule. The only module
in my playlist that showed this warning was the apt module, which this
commit also fixes. Future version of Ansible should fail when
boolean-like values are valid choices in string parameters.
SUMMARY
ISSUE TYPE
COMPONENT NAME