ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

pass params to validate against

Browse source
This commit is contained in:
Brian Coca 2017-02-08 18:53:54 -05:00 • committed by Brian Coca
parent 25de905c6e
commit 9a05113daf
1 changed files with 23 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

40
lib/ansible/module_utils/basic.py
View file

@ -1481,14 +1481,16 @@ class AnsibleModule(object):
if 0 in counts: if 0 in counts:
self.fail_json(msg="parameters are required together: %s" % (check,)) self.fail_json(msg="parameters are required together: %s" % (check,))
def _check_required_arguments(self, spec=None): def _check_required_arguments(self, spec=None, param=None ):
''' ensure all required arguments are present ''' ''' ensure all required arguments are present '''
missing = [] missing = []
if spec is None: if spec is None:
spec = self.argument_spec spec = self.argument_spec
if param is None:
param = self.params
for (k,v) in spec.items(): for (k,v) in spec.items():
required = v.get('required', False) required = v.get('required', False)
if required and k not in self.params: if required and k not in param:
missing.append(k) missing.append(k)
if len(missing) > 0: if len(missing) > 0:
self.fail_json(msg="missing required arguments: %s" % ",".join(missing)) self.fail_json(msg="missing required arguments: %s" % ",".join(missing))
@ -1519,39 +1521,41 @@ class AnsibleModule(object):
if len(missing) and len(missing) >= max_missing_count: if len(missing) and len(missing) >= max_missing_count:
self.fail_json(msg="%s is %s but the following are missing: %s" % (key, val, ','.join(missing))) self.fail_json(msg="%s is %s but the following are missing: %s" % (key, val, ','.join(missing)))
def _check_argument_values(self, spec=None): def _check_argument_values(self, spec=None, param=None):
''' ensure all arguments have the requested values, and there are no stray arguments ''' ''' ensure all arguments have the requested values, and there are no stray arguments '''
if spec is None: if spec is None:
spec = self.argument_spec spec = self.argument_spec
if param is None:
param = self.params
for (k,v) in spec.items(): for (k,v) in spec.items():
choices = v.get('choices',None) choices = v.get('choices',None)
if choices is None: if choices is None:
continue continue
if isinstance(choices, SEQUENCETYPE) and not isinstance(choices, (binary_type, text_type)): if isinstance(choices, SEQUENCETYPE) and not isinstance(choices, (binary_type, text_type)):
if k in self.params: if k in param:
if self.params[k] not in choices: if param[k] not in choices:
# PyYaml converts certain strings to bools. If we can unambiguously convert back, do so before checking # PyYaml converts certain strings to bools. If we can unambiguously convert back, do so before checking
# the value. If we can't figure this out, module author is responsible. # the value. If we can't figure this out, module author is responsible.
lowered_choices = None lowered_choices = None
if self.params[k] == 'False': if param[k] == 'False':
lowered_choices = _lenient_lowercase(choices) lowered_choices = _lenient_lowercase(choices)
FALSEY = frozenset(BOOLEANS_FALSE) FALSEY = frozenset(BOOLEANS_FALSE)
overlap = FALSEY.intersection(choices) overlap = FALSEY.intersection(choices)
if len(overlap) == 1: if len(overlap) == 1:
# Extract from a set # Extract from a set
(self.params[k],) = overlap (param[k],) = overlap
if self.params[k] == 'True': if param[k] == 'True':
if lowered_choices is None: if lowered_choices is None:
lowered_choices = _lenient_lowercase(choices) lowered_choices = _lenient_lowercase(choices)
TRUTHY = frozenset(BOOLEANS_TRUE) TRUTHY = frozenset(BOOLEANS_TRUE)
overlap = TRUTHY.intersection(choices) overlap = TRUTHY.intersection(choices)
if len(overlap) == 1: if len(overlap) == 1:
(self.params[k],) = overlap (param[k],) = overlap
if self.params[k] not in choices: if param[k] not in choices:
choices_str=",".join([to_native(c) for c in choices]) choices_str=",".join([to_native(c) for c in choices])
msg="value of %s must be one of: %s, got: %s" % (k, choices_str, self.params[k]) msg="value of %s must be one of: %s, got: %s" % (k, choices_str, param[k])
self.fail_json(msg=msg) self.fail_json(msg=msg)
else: else:
self.fail_json(msg="internal error: choices for argument %s are not iterable: %s" % (k, choices)) self.fail_json(msg="internal error: choices for argument %s are not iterable: %s" % (k, choices))
@ -1706,14 +1710,16 @@ class AnsibleModule(object):
except ValueError: except ValueError:
raise TypeError('%s cannot be converted to a Bit value' % type(value)) raise TypeError('%s cannot be converted to a Bit value' % type(value))
def _check_argument_types(self, spec=None): def _check_argument_types(self, spec=None, param=None):
''' ensure all arguments have the requested type ''' ''' ensure all arguments have the requested type '''
if spec is None: if spec is None:
spec = self.argument_spec spec = self.argument_spec
if param is None:
param= self.params
for (k, v) in spec.items(): for (k, v) in spec.items():
wanted = v.get('type', None) wanted = v.get('type', None)
if k not in self.params: if k not in param:
continue continue
if wanted is None: if wanted is None:
# Mostly we want to default to str. # Mostly we want to default to str.
@ -1737,14 +1743,14 @@ class AnsibleModule(object):
e = get_exception() e = get_exception()
self.fail_json(msg="argument %s is of type %s and we were unable to convert to %s: %s" % (k, type(value), wanted, e)) self.fail_json(msg="argument %s is of type %s and we were unable to convert to %s: %s" % (k, type(value), wanted, e))
spec = None
# deal with subspecs # deal with subspecs
spec = None
if wanted == 'dict' or (wanted == 'list' and v.get('elements', '') == 'dict'): if wanted == 'dict' or (wanted == 'list' and v.get('elements', '') == 'dict'):
spec = v.get('spec', None) spec = v.get('spec', None)
if spec: if spec:
self._check_required_arguments(spec) self._check_required_arguments(spec, param[k])
self._check_argument_types(spec) self._check_argument_types(spec, param[k])
self._check_argument_values(spec) self._check_argument_values(spec, param[k])
def _set_defaults(self, pre=True): def _set_defaults(self, pre=True):
for (k,v) in self.argument_spec.items(): for (k,v) in self.argument_spec.items():