mirror of
https://github.com/ansible-collections/community.crypto.git
synced 2026-05-06 13:22:58 +00:00
Reformat everything with black.
I had to undo the u string prefix removals to not drop Python 2 compatibility. That's why black isn't enabled in antsibull-nox.toml yet.
This commit is contained in:
Felix Fontein
@@ -71,6 +71,7 @@ try:
|
||||
ModuleArgumentSpecValidator as dummy,
|
||||
)
|
||||
from ansible.module_utils.errors import UnsupportedError
|
||||
|
||||
HAS_ARGSPEC_VALIDATOR = True
|
||||
except ImportError:
|
||||
# For ansible-base 2.10 and Ansible 2.9, we need to use the 'classical' approach
|
||||
@@ -79,6 +80,7 @@ except ImportError:
|
||||
list_deprecations,
|
||||
list_no_log_values,
|
||||
)
|
||||
|
||||
HAS_ARGSPEC_VALIDATOR = False
|
||||
|
||||
|
||||
@@ -89,10 +91,18 @@ class _ModuleExitException(Exception):
|
||||
|
||||
|
||||
class AnsibleActionModule(object):
|
||||
def __init__(self, action_plugin, argument_spec, bypass_checks=False,
|
||||
mutually_exclusive=None, required_together=None,
|
||||
required_one_of=None, supports_check_mode=False,
|
||||
required_if=None, required_by=None):
|
||||
def __init__(
|
||||
self,
|
||||
action_plugin,
|
||||
argument_spec,
|
||||
bypass_checks=False,
|
||||
mutually_exclusive=None,
|
||||
required_together=None,
|
||||
required_one_of=None,
|
||||
supports_check_mode=False,
|
||||
required_if=None,
|
||||
required_by=None,
|
||||
):
|
||||
# Internal data
|
||||
self.__action_plugin = action_plugin
|
||||
self.__warnings = []
|
||||
@@ -143,22 +153,38 @@ class AnsibleActionModule(object):
|
||||
# for our use-case:
|
||||
for d in self._validation_result._deprecations:
|
||||
# Before ansible-core 2.14.2, deprecations were always for aliases:
|
||||
if 'name' in d:
|
||||
if "name" in d:
|
||||
self.deprecate(
|
||||
"Alias '{name}' is deprecated. See the module docs for more information".format(name=d['name']),
|
||||
version=d.get('version'), date=d.get('date'), collection_name=d.get('collection_name'))
|
||||
"Alias '{name}' is deprecated. See the module docs for more information".format(
|
||||
name=d["name"]
|
||||
),
|
||||
version=d.get("version"),
|
||||
date=d.get("date"),
|
||||
collection_name=d.get("collection_name"),
|
||||
)
|
||||
# Since ansible-core 2.14.2, a message is present that can be directly printed:
|
||||
if 'msg' in d:
|
||||
self.deprecate(d['msg'], version=d.get('version'), date=d.get('date'), collection_name=d.get('collection_name'))
|
||||
if "msg" in d:
|
||||
self.deprecate(
|
||||
d["msg"],
|
||||
version=d.get("version"),
|
||||
date=d.get("date"),
|
||||
collection_name=d.get("collection_name"),
|
||||
)
|
||||
|
||||
for w in self._validation_result._warnings:
|
||||
self.warn('Both option {option} and its alias {alias} are set.'.format(option=w['option'], alias=w['alias']))
|
||||
self.warn(
|
||||
"Both option {option} and its alias {alias} are set.".format(
|
||||
option=w["option"], alias=w["alias"]
|
||||
)
|
||||
)
|
||||
|
||||
# Fail for validation errors, even in check mode
|
||||
if error:
|
||||
msg = self._validation_result.errors.msg
|
||||
if isinstance(error, UnsupportedError):
|
||||
msg = "Unsupported parameters for ({name}) {kind}: {msg}".format(name=self._name, kind='module', msg=msg)
|
||||
msg = "Unsupported parameters for ({name}) {kind}: {msg}".format(
|
||||
name=self._name, kind="module", msg=msg
|
||||
)
|
||||
|
||||
self.fail_json(msg=msg)
|
||||
else:
|
||||
@@ -169,7 +195,9 @@ class AnsibleActionModule(object):
|
||||
self.aliases = self._handle_aliases()
|
||||
except (ValueError, TypeError) as e:
|
||||
# Use exceptions here because it is not safe to call fail_json until no_log is processed
|
||||
raise _ModuleExitException(dict(failed=True, msg="Module alias error: %s" % to_native(e)))
|
||||
raise _ModuleExitException(
|
||||
dict(failed=True, msg="Module alias error: %s" % to_native(e))
|
||||
)
|
||||
|
||||
# Save parameter values that should never be logged
|
||||
self._handle_no_log_values()
|
||||
@@ -183,18 +211,18 @@ class AnsibleActionModule(object):
|
||||
self._set_defaults(pre=True)
|
||||
|
||||
self._CHECK_ARGUMENT_TYPES_DISPATCHER = {
|
||||
'str': self._check_type_str,
|
||||
'list': check_type_list,
|
||||
'dict': check_type_dict,
|
||||
'bool': check_type_bool,
|
||||
'int': check_type_int,
|
||||
'float': check_type_float,
|
||||
'path': check_type_path,
|
||||
'raw': check_type_raw,
|
||||
'jsonarg': check_type_jsonarg,
|
||||
'json': check_type_jsonarg,
|
||||
'bytes': check_type_bytes,
|
||||
'bits': check_type_bits,
|
||||
"str": self._check_type_str,
|
||||
"list": check_type_list,
|
||||
"dict": check_type_dict,
|
||||
"bool": check_type_bool,
|
||||
"int": check_type_int,
|
||||
"float": check_type_float,
|
||||
"path": check_type_path,
|
||||
"raw": check_type_raw,
|
||||
"jsonarg": check_type_jsonarg,
|
||||
"json": check_type_jsonarg,
|
||||
"bytes": check_type_bytes,
|
||||
"bits": check_type_bits,
|
||||
}
|
||||
if not bypass_checks:
|
||||
self._check_required_arguments()
|
||||
@@ -210,7 +238,7 @@ class AnsibleActionModule(object):
|
||||
# deal with options sub-spec
|
||||
self._handle_options()
|
||||
|
||||
def _handle_aliases(self, spec=None, param=None, option_prefix=''):
|
||||
def _handle_aliases(self, spec=None, param=None, option_prefix=""):
|
||||
if spec is None:
|
||||
spec = self.argument_spec
|
||||
if param is None:
|
||||
@@ -218,21 +246,32 @@ class AnsibleActionModule(object):
|
||||
|
||||
# this uses exceptions as it happens before we can safely call fail_json
|
||||
alias_warnings = []
|
||||
alias_results, self._legal_inputs = handle_aliases(spec, param, alias_warnings=alias_warnings) # pylint: disable=used-before-assignment
|
||||
alias_results, self._legal_inputs = (
|
||||
handle_aliases( # pylint: disable=used-before-assignment
|
||||
spec, param, alias_warnings=alias_warnings
|
||||
)
|
||||
)
|
||||
for option, alias in alias_warnings:
|
||||
self.warn('Both option %s and its alias %s are set.' % (option_prefix + option, option_prefix + alias))
|
||||
self.warn(
|
||||
"Both option %s and its alias %s are set."
|
||||
% (option_prefix + option, option_prefix + alias)
|
||||
)
|
||||
|
||||
deprecated_aliases = []
|
||||
for i in spec.keys():
|
||||
if 'deprecated_aliases' in spec[i].keys():
|
||||
for alias in spec[i]['deprecated_aliases']:
|
||||
if "deprecated_aliases" in spec[i].keys():
|
||||
for alias in spec[i]["deprecated_aliases"]:
|
||||
deprecated_aliases.append(alias)
|
||||
|
||||
for deprecation in deprecated_aliases:
|
||||
if deprecation['name'] in param.keys():
|
||||
self.deprecate("Alias '%s' is deprecated. See the module docs for more information" % deprecation['name'],
|
||||
version=deprecation.get('version'), date=deprecation.get('date'),
|
||||
collection_name=deprecation.get('collection_name'))
|
||||
if deprecation["name"] in param.keys():
|
||||
self.deprecate(
|
||||
"Alias '%s' is deprecated. See the module docs for more information"
|
||||
% deprecation["name"],
|
||||
version=deprecation.get("version"),
|
||||
date=deprecation.get("date"),
|
||||
collection_name=deprecation.get("collection_name"),
|
||||
)
|
||||
return alias_results
|
||||
|
||||
def _handle_no_log_values(self, spec=None, param=None):
|
||||
@@ -242,17 +281,30 @@ class AnsibleActionModule(object):
|
||||
param = self.params
|
||||
|
||||
try:
|
||||
self.no_log_values.update(list_no_log_values(spec, param)) # pylint: disable=used-before-assignment
|
||||
self.no_log_values.update(
|
||||
list_no_log_values( # pylint: disable=used-before-assignment
|
||||
spec, param
|
||||
)
|
||||
)
|
||||
except TypeError as te:
|
||||
self.fail_json(msg="Failure when processing no_log parameters. Module invocation will be hidden. "
|
||||
"%s" % to_native(te), invocation={'module_args': 'HIDDEN DUE TO FAILURE'})
|
||||
self.fail_json(
|
||||
msg="Failure when processing no_log parameters. Module invocation will be hidden. "
|
||||
"%s" % to_native(te),
|
||||
invocation={"module_args": "HIDDEN DUE TO FAILURE"},
|
||||
)
|
||||
|
||||
for message in list_deprecations(spec, param): # pylint: disable=used-before-assignment
|
||||
self.deprecate(message['msg'], version=message.get('version'), date=message.get('date'),
|
||||
collection_name=message.get('collection_name'))
|
||||
for message in list_deprecations( # pylint: disable=used-before-assignment
|
||||
spec, param
|
||||
):
|
||||
self.deprecate(
|
||||
message["msg"],
|
||||
version=message.get("version"),
|
||||
date=message.get("date"),
|
||||
collection_name=message.get("collection_name"),
|
||||
)
|
||||
|
||||
def _check_arguments(self, spec=None, param=None, legal_inputs=None):
|
||||
self._syslog_facility = 'LOG_USER'
|
||||
self._syslog_facility = "LOG_USER"
|
||||
unsupported_parameters = set()
|
||||
if spec is None:
|
||||
spec = self.argument_spec
|
||||
@@ -268,7 +320,7 @@ class AnsibleActionModule(object):
|
||||
|
||||
for k in PASS_VARS:
|
||||
# handle setting internal properties from internal ansible vars
|
||||
param_key = '_ansible_%s' % k
|
||||
param_key = "_ansible_%s" % k
|
||||
if param_key in param:
|
||||
if k in PASS_BOOLS:
|
||||
setattr(self, PASS_VARS[k][0], self.boolean(param[param_key]))
|
||||
@@ -284,19 +336,29 @@ class AnsibleActionModule(object):
|
||||
setattr(self, PASS_VARS[k][0], PASS_VARS[k][1])
|
||||
|
||||
if unsupported_parameters:
|
||||
msg = "Unsupported parameters for (%s) module: %s" % (self._name, ', '.join(sorted(list(unsupported_parameters))))
|
||||
msg = "Unsupported parameters for (%s) module: %s" % (
|
||||
self._name,
|
||||
", ".join(sorted(list(unsupported_parameters))),
|
||||
)
|
||||
if self._options_context:
|
||||
msg += " found in %s." % " -> ".join(self._options_context)
|
||||
supported_parameters = list()
|
||||
for key in sorted(spec.keys()):
|
||||
if 'aliases' in spec[key] and spec[key]['aliases']:
|
||||
supported_parameters.append("%s (%s)" % (key, ', '.join(sorted(spec[key]['aliases']))))
|
||||
if "aliases" in spec[key] and spec[key]["aliases"]:
|
||||
supported_parameters.append(
|
||||
"%s (%s)" % (key, ", ".join(sorted(spec[key]["aliases"])))
|
||||
)
|
||||
else:
|
||||
supported_parameters.append(key)
|
||||
msg += " Supported parameters include: %s" % (', '.join(supported_parameters))
|
||||
msg += " Supported parameters include: %s" % (
|
||||
", ".join(supported_parameters)
|
||||
)
|
||||
self.fail_json(msg=msg)
|
||||
if self.check_mode and not self.supports_check_mode:
|
||||
self.exit_json(skipped=True, msg="action module (%s) does not support check mode" % self._name)
|
||||
self.exit_json(
|
||||
skipped=True,
|
||||
msg="action module (%s) does not support check mode" % self._name,
|
||||
)
|
||||
|
||||
def _count_terms(self, check, param=None):
|
||||
if param is None:
|
||||
@@ -370,7 +432,7 @@ class AnsibleActionModule(object):
|
||||
self.fail_json(msg=msg)
|
||||
|
||||
def _check_required_if(self, spec, param=None):
|
||||
''' ensure that parameters which conditionally required are present '''
|
||||
"""ensure that parameters which conditionally required are present"""
|
||||
if spec is None:
|
||||
return
|
||||
if param is None:
|
||||
@@ -385,38 +447,47 @@ class AnsibleActionModule(object):
|
||||
self.fail_json(msg=msg)
|
||||
|
||||
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:
|
||||
spec = self.argument_spec
|
||||
if param is None:
|
||||
param = self.params
|
||||
for (k, v) in spec.items():
|
||||
choices = v.get('choices', None)
|
||||
for k, v in spec.items():
|
||||
choices = v.get("choices", None)
|
||||
if choices is None:
|
||||
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 param:
|
||||
# Allow one or more when type='list' param with choices
|
||||
if isinstance(param[k], list):
|
||||
diff_list = ", ".join([item for item in param[k] if item not in choices])
|
||||
diff_list = ", ".join(
|
||||
[item for item in param[k] if item not in choices]
|
||||
)
|
||||
if diff_list:
|
||||
choices_str = ", ".join([to_native(c) for c in choices])
|
||||
msg = "value of %s must be one or more of: %s. Got no match for: %s" % (k, choices_str, diff_list)
|
||||
msg = (
|
||||
"value of %s must be one or more of: %s. Got no match for: %s"
|
||||
% (k, choices_str, diff_list)
|
||||
)
|
||||
if self._options_context:
|
||||
msg += " found in %s" % " -> ".join(self._options_context)
|
||||
msg += " found in %s" % " -> ".join(
|
||||
self._options_context
|
||||
)
|
||||
self.fail_json(msg=msg)
|
||||
elif param[k] not in choices:
|
||||
# PyYaml converts certain strings to bools. If we can unambiguously convert back, do so before checking
|
||||
# the value. If we cannot figure this out, module author is responsible.
|
||||
lowered_choices = None
|
||||
if param[k] == 'False':
|
||||
if param[k] == "False":
|
||||
lowered_choices = lenient_lowercase(choices)
|
||||
overlap = BOOLEANS_FALSE.intersection(choices)
|
||||
if len(overlap) == 1:
|
||||
# Extract from a set
|
||||
(param[k],) = overlap
|
||||
|
||||
if param[k] == 'True':
|
||||
if param[k] == "True":
|
||||
if lowered_choices is None:
|
||||
lowered_choices = lenient_lowercase(choices)
|
||||
overlap = BOOLEANS_TRUE.intersection(choices)
|
||||
@@ -425,12 +496,21 @@ class AnsibleActionModule(object):
|
||||
|
||||
if param[k] not 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, param[k])
|
||||
msg = "value of %s must be one of: %s, got: %s" % (
|
||||
k,
|
||||
choices_str,
|
||||
param[k],
|
||||
)
|
||||
if self._options_context:
|
||||
msg += " found in %s" % " -> ".join(self._options_context)
|
||||
msg += " found in %s" % " -> ".join(
|
||||
self._options_context
|
||||
)
|
||||
self.fail_json(msg=msg)
|
||||
else:
|
||||
msg = "internal error: choices for argument %s are not iterable: %s" % (k, choices)
|
||||
msg = "internal error: choices for argument %s are not iterable: %s" % (
|
||||
k,
|
||||
choices,
|
||||
)
|
||||
if self._options_context:
|
||||
msg += " found in %s" % " -> ".join(self._options_context)
|
||||
self.fail_json(msg=msg)
|
||||
@@ -438,50 +518,50 @@ class AnsibleActionModule(object):
|
||||
def safe_eval(self, value, locals=None, include_exceptions=False):
|
||||
return safe_eval(value, locals, include_exceptions)
|
||||
|
||||
def _check_type_str(self, value, param=None, prefix=''):
|
||||
opts = {
|
||||
'error': False,
|
||||
'warn': False,
|
||||
'ignore': True
|
||||
}
|
||||
def _check_type_str(self, value, param=None, prefix=""):
|
||||
opts = {"error": False, "warn": False, "ignore": True}
|
||||
|
||||
# Ignore, warn, or error when converting to a string.
|
||||
allow_conversion = opts.get(C.STRING_CONVERSION_ACTION, True)
|
||||
try:
|
||||
return check_type_str(value, allow_conversion)
|
||||
except TypeError:
|
||||
common_msg = 'quote the entire value to ensure it does not change.'
|
||||
from_msg = '{0!r}'.format(value)
|
||||
to_msg = '{0!r}'.format(to_text(value))
|
||||
common_msg = "quote the entire value to ensure it does not change."
|
||||
from_msg = "{0!r}".format(value)
|
||||
to_msg = "{0!r}".format(to_text(value))
|
||||
|
||||
if param is not None:
|
||||
if prefix:
|
||||
param = '{0}{1}'.format(prefix, param)
|
||||
param = "{0}{1}".format(prefix, param)
|
||||
|
||||
from_msg = '{0}: {1!r}'.format(param, value)
|
||||
to_msg = '{0}: {1!r}'.format(param, to_text(value))
|
||||
from_msg = "{0}: {1!r}".format(param, value)
|
||||
to_msg = "{0}: {1!r}".format(param, to_text(value))
|
||||
|
||||
if C.STRING_CONVERSION_ACTION == 'error':
|
||||
if C.STRING_CONVERSION_ACTION == "error":
|
||||
msg = common_msg.capitalize()
|
||||
raise TypeError(to_native(msg))
|
||||
elif C.STRING_CONVERSION_ACTION == 'warn':
|
||||
msg = ('The value "{0}" (type {1.__class__.__name__}) was converted to "{2}" (type string). '
|
||||
'If this does not look like what you expect, {3}').format(from_msg, value, to_msg, common_msg)
|
||||
elif C.STRING_CONVERSION_ACTION == "warn":
|
||||
msg = (
|
||||
'The value "{0}" (type {1.__class__.__name__}) was converted to "{2}" (type string). '
|
||||
"If this does not look like what you expect, {3}"
|
||||
).format(from_msg, value, to_msg, common_msg)
|
||||
self.warn(to_native(msg))
|
||||
return to_native(value, errors='surrogate_or_strict')
|
||||
return to_native(value, errors="surrogate_or_strict")
|
||||
|
||||
def _handle_options(self, argument_spec=None, params=None, prefix=''):
|
||||
''' deal with options to create sub spec '''
|
||||
def _handle_options(self, argument_spec=None, params=None, prefix=""):
|
||||
"""deal with options to create sub spec"""
|
||||
if argument_spec is None:
|
||||
argument_spec = self.argument_spec
|
||||
if params is None:
|
||||
params = self.params
|
||||
|
||||
for (k, v) in argument_spec.items():
|
||||
wanted = v.get('type', None)
|
||||
if wanted == 'dict' or (wanted == 'list' and v.get('elements', '') == 'dict'):
|
||||
spec = v.get('options', None)
|
||||
if v.get('apply_defaults', False):
|
||||
for k, v in argument_spec.items():
|
||||
wanted = v.get("type", None)
|
||||
if wanted == "dict" or (
|
||||
wanted == "list" and v.get("elements", "") == "dict"
|
||||
):
|
||||
spec = v.get("options", None)
|
||||
if v.get("apply_defaults", False):
|
||||
if spec is not None:
|
||||
if params.get(k) is None:
|
||||
params[k] = {}
|
||||
@@ -499,23 +579,31 @@ class AnsibleActionModule(object):
|
||||
|
||||
for idx, param in enumerate(elements):
|
||||
if not isinstance(param, dict):
|
||||
self.fail_json(msg="value of %s must be of type dict or list of dict" % k)
|
||||
self.fail_json(
|
||||
msg="value of %s must be of type dict or list of dict" % k
|
||||
)
|
||||
|
||||
new_prefix = prefix + k
|
||||
if wanted == 'list':
|
||||
new_prefix += '[%d]' % idx
|
||||
new_prefix += '.'
|
||||
if wanted == "list":
|
||||
new_prefix += "[%d]" % idx
|
||||
new_prefix += "."
|
||||
|
||||
self._set_fallbacks(spec, param)
|
||||
options_aliases = self._handle_aliases(spec, param, option_prefix=new_prefix)
|
||||
options_aliases = self._handle_aliases(
|
||||
spec, param, option_prefix=new_prefix
|
||||
)
|
||||
|
||||
options_legal_inputs = list(spec.keys()) + list(options_aliases.keys())
|
||||
options_legal_inputs = list(spec.keys()) + list(
|
||||
options_aliases.keys()
|
||||
)
|
||||
|
||||
self._check_arguments(spec, param, options_legal_inputs)
|
||||
|
||||
# check exclusive early
|
||||
if not self.bypass_checks:
|
||||
self._check_mutually_exclusive(v.get('mutually_exclusive', None), param)
|
||||
self._check_mutually_exclusive(
|
||||
v.get("mutually_exclusive", None), param
|
||||
)
|
||||
|
||||
self._set_defaults(pre=True, spec=spec, param=param)
|
||||
|
||||
@@ -524,10 +612,14 @@ class AnsibleActionModule(object):
|
||||
self._check_argument_types(spec, param, new_prefix)
|
||||
self._check_argument_values(spec, param)
|
||||
|
||||
self._check_required_together(v.get('required_together', None), param)
|
||||
self._check_required_one_of(v.get('required_one_of', None), param)
|
||||
self._check_required_if(v.get('required_if', None), param)
|
||||
self._check_required_by(v.get('required_by', None), param)
|
||||
self._check_required_together(
|
||||
v.get("required_together", None), param
|
||||
)
|
||||
self._check_required_one_of(
|
||||
v.get("required_one_of", None), param
|
||||
)
|
||||
self._check_required_if(v.get("required_if", None), param)
|
||||
self._check_required_by(v.get("required_by", None), param)
|
||||
|
||||
self._set_defaults(pre=False, spec=spec, param=param)
|
||||
|
||||
@@ -541,15 +633,18 @@ class AnsibleActionModule(object):
|
||||
# Mostly we want to default to str.
|
||||
# For values set to None explicitly, return None instead as
|
||||
# that allows a user to unset a parameter
|
||||
wanted = 'str'
|
||||
wanted = "str"
|
||||
try:
|
||||
type_checker = self._CHECK_ARGUMENT_TYPES_DISPATCHER[wanted]
|
||||
except KeyError:
|
||||
self.fail_json(msg="implementation error: unknown type %s requested for %s" % (wanted, k))
|
||||
self.fail_json(
|
||||
msg="implementation error: unknown type %s requested for %s"
|
||||
% (wanted, k)
|
||||
)
|
||||
else:
|
||||
# set the type_checker to the callable, and reset wanted to the callable's name (or type if it does not have one, ala MagicMock)
|
||||
type_checker = wanted
|
||||
wanted = getattr(wanted, '__name__', to_native(type(wanted)))
|
||||
wanted = getattr(wanted, "__name__", to_native(type(wanted)))
|
||||
|
||||
return type_checker, wanted
|
||||
|
||||
@@ -559,11 +654,11 @@ class AnsibleActionModule(object):
|
||||
# Get param name for strings so we can later display this value in a useful error message if needed
|
||||
# Only pass 'kwargs' to our checkers and ignore custom callable checkers
|
||||
kwargs = {}
|
||||
if wanted_name == 'str' and isinstance(wanted, string_types):
|
||||
if wanted_name == "str" and isinstance(wanted, string_types):
|
||||
if isinstance(param, string_types):
|
||||
kwargs['param'] = param
|
||||
kwargs["param"] = param
|
||||
elif isinstance(param, dict):
|
||||
kwargs['param'] = list(param.keys())[0]
|
||||
kwargs["param"] = list(param.keys())[0]
|
||||
for value in values:
|
||||
try:
|
||||
validated_params.append(type_checker(value, **kwargs))
|
||||
@@ -571,20 +666,24 @@ class AnsibleActionModule(object):
|
||||
msg = "Elements value for option %s" % param
|
||||
if self._options_context:
|
||||
msg += " found in '%s'" % " -> ".join(self._options_context)
|
||||
msg += " is of type %s and we were unable to convert to %s: %s" % (type(value), wanted_name, to_native(e))
|
||||
msg += " is of type %s and we were unable to convert to %s: %s" % (
|
||||
type(value),
|
||||
wanted_name,
|
||||
to_native(e),
|
||||
)
|
||||
self.fail_json(msg=msg)
|
||||
return validated_params
|
||||
|
||||
def _check_argument_types(self, spec=None, param=None, prefix=''):
|
||||
''' ensure all arguments have the requested type '''
|
||||
def _check_argument_types(self, spec=None, param=None, prefix=""):
|
||||
"""ensure all arguments have the requested type"""
|
||||
|
||||
if spec is None:
|
||||
spec = self.argument_spec
|
||||
if param is None:
|
||||
param = self.params
|
||||
|
||||
for (k, v) in spec.items():
|
||||
wanted = v.get('type', None)
|
||||
for k, v in spec.items():
|
||||
wanted = v.get("type", None)
|
||||
if k not in param:
|
||||
continue
|
||||
|
||||
@@ -596,22 +695,26 @@ class AnsibleActionModule(object):
|
||||
# Get param name for strings so we can later display this value in a useful error message if needed
|
||||
# Only pass 'kwargs' to our checkers and ignore custom callable checkers
|
||||
kwargs = {}
|
||||
if wanted_name == 'str' and isinstance(type_checker, string_types):
|
||||
kwargs['param'] = list(param.keys())[0]
|
||||
if wanted_name == "str" and isinstance(type_checker, string_types):
|
||||
kwargs["param"] = list(param.keys())[0]
|
||||
|
||||
# Get the name of the parent key if this is a nested option
|
||||
if prefix:
|
||||
kwargs['prefix'] = prefix
|
||||
kwargs["prefix"] = prefix
|
||||
|
||||
try:
|
||||
param[k] = type_checker(value, **kwargs)
|
||||
wanted_elements = v.get('elements', None)
|
||||
wanted_elements = v.get("elements", None)
|
||||
if wanted_elements:
|
||||
if wanted != 'list' or not isinstance(param[k], list):
|
||||
if wanted != "list" or not isinstance(param[k], list):
|
||||
msg = "Invalid type %s for option '%s'" % (wanted_name, param)
|
||||
if self._options_context:
|
||||
msg += " found in '%s'." % " -> ".join(self._options_context)
|
||||
msg += ", elements value check is supported only with 'list' type"
|
||||
msg += " found in '%s'." % " -> ".join(
|
||||
self._options_context
|
||||
)
|
||||
msg += (
|
||||
", elements value check is supported only with 'list' type"
|
||||
)
|
||||
self.fail_json(msg=msg)
|
||||
param[k] = self._handle_elements(wanted_elements, k, param[k])
|
||||
|
||||
@@ -619,7 +722,10 @@ class AnsibleActionModule(object):
|
||||
msg = "argument %s is of type %s" % (k, type(value))
|
||||
if self._options_context:
|
||||
msg += " found in '%s'." % " -> ".join(self._options_context)
|
||||
msg += " and we were unable to convert to %s: %s" % (wanted_name, to_native(e))
|
||||
msg += " and we were unable to convert to %s: %s" % (
|
||||
wanted_name,
|
||||
to_native(e),
|
||||
)
|
||||
self.fail_json(msg=msg)
|
||||
|
||||
def _set_defaults(self, pre=True, spec=None, param=None):
|
||||
@@ -627,8 +733,8 @@ class AnsibleActionModule(object):
|
||||
spec = self.argument_spec
|
||||
if param is None:
|
||||
param = self.params
|
||||
for (k, v) in spec.items():
|
||||
default = v.get('default', None)
|
||||
for k, v in spec.items():
|
||||
default = v.get("default", None)
|
||||
if pre is True:
|
||||
# this prevents setting defaults on required items
|
||||
if default is not None and k not in param:
|
||||
@@ -644,8 +750,8 @@ class AnsibleActionModule(object):
|
||||
if param is None:
|
||||
param = self.params
|
||||
|
||||
for (k, v) in spec.items():
|
||||
fallback = v.get('fallback', (None,))
|
||||
for k, v in spec.items():
|
||||
fallback = v.get("fallback", (None,))
|
||||
fallback_strategy = fallback[0]
|
||||
fallback_args = []
|
||||
fallback_kwargs = {}
|
||||
@@ -669,62 +775,76 @@ class AnsibleActionModule(object):
|
||||
|
||||
def deprecate(self, msg, version=None, date=None, collection_name=None):
|
||||
if version is not None and date is not None:
|
||||
raise AssertionError("implementation error -- version and date must not both be set")
|
||||
raise AssertionError(
|
||||
"implementation error -- version and date must not both be set"
|
||||
)
|
||||
|
||||
# Copied from ansible.module_utils.common.warnings:
|
||||
if isinstance(msg, string_types):
|
||||
# For compatibility, we accept that neither version nor date is set,
|
||||
# and treat that the same as if version would haven been set
|
||||
if date is not None:
|
||||
self.__deprecations.append({'msg': msg, 'date': date, 'collection_name': collection_name})
|
||||
self.__deprecations.append(
|
||||
{"msg": msg, "date": date, "collection_name": collection_name}
|
||||
)
|
||||
else:
|
||||
self.__deprecations.append({'msg': msg, 'version': version, 'collection_name': collection_name})
|
||||
self.__deprecations.append(
|
||||
{"msg": msg, "version": version, "collection_name": collection_name}
|
||||
)
|
||||
else:
|
||||
raise TypeError("deprecate requires a string not a %s" % type(msg))
|
||||
|
||||
def _return_formatted(self, kwargs):
|
||||
if 'invocation' not in kwargs:
|
||||
kwargs['invocation'] = {'module_args': self.params}
|
||||
if "invocation" not in kwargs:
|
||||
kwargs["invocation"] = {"module_args": self.params}
|
||||
|
||||
if 'warnings' in kwargs:
|
||||
if isinstance(kwargs['warnings'], list):
|
||||
for w in kwargs['warnings']:
|
||||
if "warnings" in kwargs:
|
||||
if isinstance(kwargs["warnings"], list):
|
||||
for w in kwargs["warnings"]:
|
||||
self.warn(w)
|
||||
else:
|
||||
self.warn(kwargs['warnings'])
|
||||
self.warn(kwargs["warnings"])
|
||||
|
||||
if self.__warnings:
|
||||
kwargs['warnings'] = self.__warnings
|
||||
kwargs["warnings"] = self.__warnings
|
||||
|
||||
if 'deprecations' in kwargs:
|
||||
if isinstance(kwargs['deprecations'], list):
|
||||
for d in kwargs['deprecations']:
|
||||
if "deprecations" in kwargs:
|
||||
if isinstance(kwargs["deprecations"], list):
|
||||
for d in kwargs["deprecations"]:
|
||||
if isinstance(d, SEQUENCETYPE) and len(d) == 2:
|
||||
self.deprecate(d[0], version=d[1])
|
||||
elif isinstance(d, Mapping):
|
||||
self.deprecate(d['msg'], version=d.get('version'), date=d.get('date'),
|
||||
collection_name=d.get('collection_name'))
|
||||
self.deprecate(
|
||||
d["msg"],
|
||||
version=d.get("version"),
|
||||
date=d.get("date"),
|
||||
collection_name=d.get("collection_name"),
|
||||
)
|
||||
else:
|
||||
self.deprecate(d) # pylint: disable=ansible-deprecated-no-version
|
||||
self.deprecate( # pylint: disable=ansible-deprecated-no-version
|
||||
d
|
||||
)
|
||||
else:
|
||||
self.deprecate(kwargs['deprecations']) # pylint: disable=ansible-deprecated-no-version
|
||||
self.deprecate( # pylint: disable=ansible-deprecated-no-version
|
||||
kwargs["deprecations"]
|
||||
)
|
||||
|
||||
if self.__deprecations:
|
||||
kwargs['deprecations'] = self.__deprecations
|
||||
kwargs["deprecations"] = self.__deprecations
|
||||
|
||||
kwargs = remove_values(kwargs, self.no_log_values)
|
||||
raise _ModuleExitException(kwargs)
|
||||
|
||||
def exit_json(self, **kwargs):
|
||||
result = dict(kwargs)
|
||||
if 'failed' not in result:
|
||||
result['failed'] = False
|
||||
if "failed" not in result:
|
||||
result["failed"] = False
|
||||
self._return_formatted(result)
|
||||
|
||||
def fail_json(self, msg, **kwargs):
|
||||
result = dict(kwargs)
|
||||
result['failed'] = True
|
||||
result['msg'] = msg
|
||||
result["failed"] = True
|
||||
result["msg"] = msg
|
||||
self._return_formatted(result)
|
||||
|
||||
|
||||
@@ -738,7 +858,7 @@ class ActionModuleBase(ActionBase):
|
||||
@abc.abstractmethod
|
||||
def run_module(self, module):
|
||||
"""Run module code"""
|
||||
module.fail_json(msg='Not implemented.')
|
||||
module.fail_json(msg="Not implemented.")
|
||||
|
||||
def run(self, tmp=None, task_vars=None):
|
||||
if task_vars is None:
|
||||
@@ -749,14 +869,18 @@ class ActionModuleBase(ActionBase):
|
||||
|
||||
try:
|
||||
argument_spec, kwargs = self.setup_module()
|
||||
module = argument_spec.create_ansible_module_helper(AnsibleActionModule, (self, ), **kwargs)
|
||||
module = argument_spec.create_ansible_module_helper(
|
||||
AnsibleActionModule, (self,), **kwargs
|
||||
)
|
||||
self.run_module(module)
|
||||
raise AnsibleError('Internal error: action module did not call module.exit_json()')
|
||||
raise AnsibleError(
|
||||
"Internal error: action module did not call module.exit_json()"
|
||||
)
|
||||
except _ModuleExitException as mee:
|
||||
result.update(mee.result)
|
||||
return result
|
||||
except Exception:
|
||||
result['failed'] = True
|
||||
result['msg'] = 'MODULE FAILURE'
|
||||
result['exception'] = traceback.format_exc()
|
||||
result["failed"] = True
|
||||
result["msg"] = "MODULE FAILURE"
|
||||
result["exception"] = traceback.format_exc()
|
||||
return result
|
||||
|
||||
Reference in New Issue
Block a user