Validate plugin option type 'dict' / 'dictionary' #71928
Conversation
ansibot
added
affects_2.11
core_review
…s of dicts and dicts.
ansibot
added
core_review
ansibot
added
needs_ci
|
/rebuild_failed |
ansibot
added
has_issue
core_review
| @@ -56,7 +56,7 @@ class ModuleDocFragment(object): | |||
| vars: | |||
| - name: ansible_async_dir | |||
| environment: | |||
| type: dict | |||
| type: dict or list | |||
There was a problem hiding this comment.
these are for modules, handled by argspec, this change should not be part of this PR
There was a problem hiding this comment.
They are (also) used by the shell plugins (https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/shell/sh.py#L15, https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/shell/powershell.py#L16, https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/shell/cmd.py#L14), and these will stop working without this change. Without this change (and the one in shell_windows.py) CI looks like this: https://app.shippable.com/github/ansible/ansible/runs/174226/summary/console
There was a problem hiding this comment.
(Also I'm not aware of any module using these docs fragments.)
There was a problem hiding this comment.
type: dict or list skips validation because that isn't a known type. The convention we've used for that in the past is type: raw. But environment should just be a list, since it's coming from the field attribute anyway.
There was a problem hiding this comment.
I changed it to type: list as discussed in the meeting.
samdoran
removed
the
needs_triage
* Validate option type 'dict' / 'dictionary'. * Add changelog fragment. * Change type of 'environment' to list.
SUMMARY
Until now, the type
dict/dictionarywas not validated inensure_type()in lib/ansible/config/manager.py, even though that type is used also in plugins included with ansible/ansible (see for example https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/lookup/url.py#L39).ISSUE TYPE
COMPONENT NAME
lib/ansible/config/manager.py