cloudstack: fix spelling of "affinity_type" #33231
Merged
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
ansibot
added
affects_2.5
|
The test |
ansibot
added
ci_verified
|
Unsure about the best way to fix this E309 error. |
resmo
suggested changes
Nov 25, 2017
There was a problem hiding this comment.
Salut @vincentbernat
It looks I screwed... with the argument name, didn't I? :)
I would suggest to deprecate the old argument and add some infos in the description. The old agument has to be kept for 4 releases according policy. That is why we can remove it in 2.9 (2.5-2.8).
Optionally, a pass a set of the two args as mutually_exclusive to AnsibleModule, to ensure only one could be used (see https://github.com/ansible/ansible/blob/devel/lib/ansible/module_utils/basic.py#L774).
Thanks!
| @@ -160,7 +160,7 @@ def get_affinity_group(self): | |||
| return self.affinity_group | |||
|
|
|||
| def get_affinity_type(self): | |||
| affinity_type = self.module.params.get('affinty_type') | |||
| affinity_type = self.module.params.get('affinity_type') | |||
There was a problem hiding this comment.
- affinity_type = self.module.params.get('affinty_type')
+ affinity_type = self.module.params.get('affinity_type') or self.module.params.get('affinty_type')| @@ -217,7 +217,7 @@ def main(): | |||
| argument_spec = cs_argument_spec() | |||
| argument_spec.update(dict( | |||
| name=dict(required=True), | |||
| affinty_type=dict(), | |||
| affinity_type=dict(aliases=['affinty_type']), | |||
There was a problem hiding this comment.
Lets deprecate the "old" param:
- affinty_type=dict(),
+ affinty_type=dict(removed_in_version='2.9'),
+ affinity_type=dict(),| @@ -36,7 +36,7 @@ | |||
| description: | |||
| - Name of the affinity group. | |||
| required: true | |||
| affinty_type: | |||
| affinity_type: | |||
| description: | |||
| - Type of the affinity group. If not specified, first found affinity type is used. | |||
| required: false | |||
There was a problem hiding this comment.
Please add the old value as an alias here:
...
- Type of the affinity group. If not specified, first found affinity type is used.
+ - The misspelled C(affinty_type) has been corrected in 2.5. For backwards compatibility it is used as an alias and will be removed in version 2.9.
required: false
+ aliases: [ affinty_type ]
ansibot
removed
the
needs_triage
The previous spelling, "affinty_type" is marked as deprecated and will be removed in Ansible 2.9. Both spelling are mutually exclusives.
vincentbernat
force-pushed
the
fix/cs-affinity-type
branch
from
5c5092e
to
e39d92f
Compare
ansibot
removed
the
ci_verified
|
I have updated the commit with the requested changes. |
ansibot
added
community_review
|
Thanks. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
SUMMARY
Fix spelling of
affinity_type(notaffinty_type).However, to not break existing playbook, add an undocumented alias for
affinty_type.ISSUE TYPE
COMPONENT NAME
cloudstack
ANSIBLE VERSION
2.4.0.0