mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adding aliases for field attributes and renaming async attribute (#33141)
* Adding aliases for field attributes and renaming async attribute As of Python 3.7, the use of async raises an error, whereas before the use of the reserved word was ignored. This adds an alias field for field attrs so that both async and async_val (interally) work. This allows us to be backwards-compatible with 3rd party plugins that may still reference Task.async, but for the core engine to work on Py3.7+. * Remove files fixed for 'async' usage from the python 3.7 skip list
This commit is contained in:
James Cammarata
Matt Clay
parent
23f8833e87
commit
d8ae4dfbf2
14 changed files with 43 additions and 36 deletions
|
|
@ -537,7 +537,7 @@ class TaskExecutor:
|
|||
if self._task.register:
|
||||
vars_copy[self._task.register] = wrap_var(result.copy())
|
||||
|
||||
if self._task.async > 0:
|
||||
if self._task.async_val > 0:
|
||||
if self._task.poll > 0 and not result.get('skipped') and not result.get('failed'):
|
||||
result = self._poll_async_result(result=result, templar=templar, task_vars=vars_copy)
|
||||
# FIXME callback 'v2_runner_on_async_poll' here
|
||||
|
|
@ -668,7 +668,7 @@ class TaskExecutor:
|
|||
shared_loader_obj=self._shared_loader_obj,
|
||||
)
|
||||
|
||||
time_left = self._task.async
|
||||
time_left = self._task.async_val
|
||||
while time_left > 0:
|
||||
time.sleep(self._task.poll)
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ from copy import deepcopy
|
|||
class Attribute:
|
||||
|
||||
def __init__(self, isa=None, private=False, default=None, required=False, listof=None, priority=0, class_type=None, always_post_validate=False,
|
||||
inherit=True):
|
||||
inherit=True, alias=None):
|
||||
"""
|
||||
:class:`Attribute` specifies constraints for attributes of objects which
|
||||
derive from playbook data. The attributes of the object are basically
|
||||
|
|
@ -53,6 +53,8 @@ class Attribute:
|
|||
:kwarg inherit: A boolean value, which controls whether the object
|
||||
containing this field should attempt to inherit the value from its
|
||||
parent object if the local value is None.
|
||||
:kwarg alias: An alias to use for the attribute name, for situations where
|
||||
the attribute name may conflict with a Python reserved word.
|
||||
"""
|
||||
|
||||
self.isa = isa
|
||||
|
|
@ -64,6 +66,7 @@ class Attribute:
|
|||
self.class_type = class_type
|
||||
self.always_post_validate = always_post_validate
|
||||
self.inherit = inherit
|
||||
self.alias = alias
|
||||
|
||||
if default is not None and self.isa in ('list', 'dict', 'set'):
|
||||
self.default = deepcopy(default)
|
||||
|
|
|
|||
|
|
@ -109,6 +109,11 @@ class BaseMeta(type):
|
|||
dst_dict['_valid_attrs'][attr_name] = value
|
||||
dst_dict['_attributes'][attr_name] = value.default
|
||||
|
||||
if value.alias is not None:
|
||||
dst_dict[value.alias] = property(getter, setter, deleter)
|
||||
dst_dict['_valid_attrs'][value.alias] = value
|
||||
dst_dict['_alias_attrs'][value.alias] = attr_name
|
||||
|
||||
def _process_parents(parents, dst_dict):
|
||||
'''
|
||||
Helper method which creates attributes from all parent objects
|
||||
|
|
@ -124,6 +129,7 @@ class BaseMeta(type):
|
|||
# create some additional class attributes
|
||||
dct['_attributes'] = dict()
|
||||
dct['_valid_attrs'] = dict()
|
||||
dct['_alias_attrs'] = dict()
|
||||
|
||||
# now create the attributes based on the FieldAttributes
|
||||
# available, including from parent (and grandparent) objects
|
||||
|
|
@ -235,12 +241,15 @@ class Base(with_metaclass(BaseMeta, object)):
|
|||
# so that certain fields can be loaded before others, if they are dependent.
|
||||
for name, attr in sorted(iteritems(self._valid_attrs), key=operator.itemgetter(1)):
|
||||
# copy the value over unless a _load_field method is defined
|
||||
target_name = name
|
||||
if name in self._alias_attrs:
|
||||
target_name = self._alias_attrs[name]
|
||||
if name in ds:
|
||||
method = getattr(self, '_load_%s' % name, None)
|
||||
if method:
|
||||
self._attributes[name] = method(name, ds[name])
|
||||
self._attributes[target_name] = method(name, ds[name])
|
||||
else:
|
||||
self._attributes[name] = ds[name]
|
||||
self._attributes[target_name] = ds[name]
|
||||
|
||||
# run early, non-critical validation
|
||||
self.validate()
|
||||
|
|
@ -279,13 +288,16 @@ class Base(with_metaclass(BaseMeta, object)):
|
|||
# walk all fields in the object
|
||||
for (name, attribute) in iteritems(self._valid_attrs):
|
||||
|
||||
if name in self._alias_attrs:
|
||||
name = self._alias_attrs[name]
|
||||
|
||||
# run validator only if present
|
||||
method = getattr(self, '_validate_%s' % name, None)
|
||||
if method:
|
||||
method(attribute, name, getattr(self, name))
|
||||
else:
|
||||
# and make sure the attribute is of the type it should be
|
||||
value = getattr(self, name)
|
||||
value = self._attributes[name]
|
||||
if value is not None:
|
||||
if attribute.isa == 'string' and isinstance(value, (list, dict)):
|
||||
raise AnsibleParserError(
|
||||
|
|
@ -314,6 +326,8 @@ class Base(with_metaclass(BaseMeta, object)):
|
|||
new_me = self.__class__()
|
||||
|
||||
for name in self._valid_attrs.keys():
|
||||
if name in self._alias_attrs:
|
||||
continue
|
||||
new_me._attributes[name] = shallowcopy(self._attributes[name])
|
||||
|
||||
new_me._loader = self._loader
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ class Task(Base, Conditional, Taggable, Become):
|
|||
_args = FieldAttribute(isa='dict', default=dict())
|
||||
_action = FieldAttribute(isa='string')
|
||||
|
||||
_async = FieldAttribute(isa='int', default=0)
|
||||
_async_val = FieldAttribute(isa='int', default=0, alias='async')
|
||||
_changed_when = FieldAttribute(isa='list', default=[])
|
||||
_delay = FieldAttribute(isa='int', default=5)
|
||||
_delegate_to = FieldAttribute(isa='string')
|
||||
|
|
|
|||
|
|
@ -93,11 +93,11 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
|||
|
||||
result = {}
|
||||
|
||||
if self._task.async and not self._supports_async:
|
||||
if self._task.async_val and not self._supports_async:
|
||||
raise AnsibleActionFail('async is not supported for this task.')
|
||||
elif self._play_context.check_mode and not self._supports_check_mode:
|
||||
raise AnsibleActionSkip('check mode is not supported for this task.')
|
||||
elif self._task.async and self._play_context.check_mode:
|
||||
elif self._task.async_val and self._play_context.check_mode:
|
||||
raise AnsibleActionFail('check mode and async cannot be used on same task.')
|
||||
|
||||
return result
|
||||
|
|
@ -159,7 +159,7 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
|||
|
||||
(module_data, module_style, module_shebang) = modify_module(module_name, module_path, module_args,
|
||||
task_vars=task_vars, module_compression=self._play_context.module_compression,
|
||||
async_timeout=self._task.async, become=self._play_context.become,
|
||||
async_timeout=self._task.async_val, become=self._play_context.become,
|
||||
become_method=self._play_context.become_method, become_user=self._play_context.become_user,
|
||||
become_password=self._play_context.become_pass,
|
||||
environment=final_environment)
|
||||
|
|
@ -703,7 +703,7 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
|||
self._transfer_data(remote_async_module_path, async_module_data)
|
||||
remote_files.append(remote_async_module_path)
|
||||
|
||||
async_limit = self._task.async
|
||||
async_limit = self._task.async_val
|
||||
async_jid = str(random.randint(0, 999999999999))
|
||||
|
||||
# call the interpreter for async_wrapper directly
|
||||
|
|
|
|||
|
|
@ -114,7 +114,7 @@ class ActionModule(ActionBase):
|
|||
display.vvvv('Running implementation module %s' % module)
|
||||
result.update(self._execute_module(module_name=module,
|
||||
module_args=new_module_args, task_vars=task_vars,
|
||||
wrap_async=self._task.async))
|
||||
wrap_async=self._task.async_val))
|
||||
|
||||
display.vvvv('Caching network OS %s in facts' % play_context.network_os)
|
||||
result['ansible_facts'] = {'network_os': play_context.network_os}
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ class ActionModule(ActionBase):
|
|||
del results['invocation']['module_args']
|
||||
|
||||
# FUTURE: better to let _execute_module calculate this internally?
|
||||
wrap_async = self._task.async and not self._connection.has_native_async
|
||||
wrap_async = self._task.async_val and not self._connection.has_native_async
|
||||
|
||||
# do work!
|
||||
results = merge_hash(results, self._execute_module(tmp=tmp, task_vars=task_vars, wrap_async=wrap_async))
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ class ActionModule(ActionBase):
|
|||
del new_module_args['use']
|
||||
|
||||
display.vvvv("Running %s" % module)
|
||||
result.update(self._execute_module(module_name=module, module_args=new_module_args, task_vars=task_vars, wrap_async=self._task.async))
|
||||
result.update(self._execute_module(module_name=module, module_args=new_module_args, task_vars=task_vars, wrap_async=self._task.async_val))
|
||||
else:
|
||||
result['failed'] = True
|
||||
result['msg'] = 'Could not detect which package manager to use. Try gathering facts or setting the "use" option.'
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ class ActionModule(ActionBase):
|
|||
self._display.warning('Ignoring "%s" as it is not used in "%s"' % (unused, module))
|
||||
|
||||
self._display.vvvv("Running %s" % module)
|
||||
result.update(self._execute_module(module_name=module, module_args=new_module_args, task_vars=task_vars, wrap_async=self._task.async))
|
||||
result.update(self._execute_module(module_name=module, module_args=new_module_args, task_vars=task_vars, wrap_async=self._task.async_val))
|
||||
else:
|
||||
result['failed'] = True
|
||||
result['msg'] = 'Could not detect which service manager to use. Try gathering facts or setting the "use" option.'
|
||||
|
|
|
|||
|
|
@ -1,13 +1,3 @@
|
|||
lib/ansible/cli/adhoc.py
|
||||
lib/ansible/executor/task_executor.py
|
||||
lib/ansible/modules/packaging/os/yum_repository.py
|
||||
lib/ansible/plugins/action/__init__.py
|
||||
lib/ansible/plugins/action/net_base.py
|
||||
lib/ansible/plugins/action/normal.py
|
||||
lib/ansible/plugins/action/package.py
|
||||
lib/ansible/plugins/action/service.py
|
||||
test/units/executor/test_task_executor.py
|
||||
test/units/modules/network/nuage/test_nuage_vspk.py
|
||||
test/units/plugins/action/test_action.py
|
||||
test/units/plugins/action/test_raw.py
|
||||
test/units/plugins/action/test_synchronize.py
|
||||
|
|
|
|||
|
|
@ -370,11 +370,11 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_task.changed_when = None
|
||||
mock_task.failed_when = None
|
||||
mock_task.post_validate.return_value = None
|
||||
# mock_task.async cannot be left unset, because on Python 3 MagicMock()
|
||||
# mock_task.async_val cannot be left unset, because on Python 3 MagicMock()
|
||||
# > 0 raises a TypeError There are two reasons for using the value 1
|
||||
# here: on Python 2 comparing MagicMock() > 0 returns True, and the
|
||||
# other reason is that if I specify 0 here, the test fails. ;)
|
||||
mock_task.async = 1
|
||||
mock_task.async_val = 1
|
||||
mock_task.poll = 0
|
||||
|
||||
mock_play_context = MagicMock()
|
||||
|
|
@ -431,7 +431,7 @@ class TestTaskExecutor(unittest.TestCase):
|
|||
mock_host = MagicMock()
|
||||
|
||||
mock_task = MagicMock()
|
||||
mock_task.async = 0.1
|
||||
mock_task.async_val = 0.1
|
||||
mock_task.poll = 0.05
|
||||
|
||||
mock_play_context = MagicMock()
|
||||
|
|
|
|||
|
|
@ -75,12 +75,12 @@ class TestActionBase(unittest.TestCase):
|
|||
|
||||
play_context = PlayContext()
|
||||
|
||||
mock_task.async = None
|
||||
mock_task.async_val = None
|
||||
action_base = DerivedActionBase(mock_task, mock_connection, play_context, None, None, None)
|
||||
results = action_base.run()
|
||||
self.assertEqual(results, dict())
|
||||
|
||||
mock_task.async = 0
|
||||
mock_task.async_val = 0
|
||||
action_base = DerivedActionBase(mock_task, mock_connection, play_context, None, None, None)
|
||||
results = action_base.run()
|
||||
self.assertEqual(results, {})
|
||||
|
|
@ -92,7 +92,7 @@ class TestActionBase(unittest.TestCase):
|
|||
# create our fake task
|
||||
mock_task = MagicMock()
|
||||
mock_task.action = "copy"
|
||||
mock_task.async = 0
|
||||
mock_task.async_val = 0
|
||||
|
||||
# create a mock connection, so we don't actually try and connect to things
|
||||
mock_connection = MagicMock()
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ class TestCopyResultExclude(unittest.TestCase):
|
|||
|
||||
play_context = Mock()
|
||||
task = MagicMock(Task)
|
||||
task.async = False
|
||||
task.async_val = False
|
||||
connection = Mock()
|
||||
|
||||
task.args = {'_raw_params': 'Args1'}
|
||||
|
|
@ -60,7 +60,7 @@ class TestCopyResultExclude(unittest.TestCase):
|
|||
|
||||
play_context = Mock()
|
||||
task = MagicMock(Task)
|
||||
task.async = False
|
||||
task.async_val = False
|
||||
connection = Mock()
|
||||
|
||||
task.args = {'_raw_params': 'Args1'}
|
||||
|
|
@ -75,7 +75,7 @@ class TestCopyResultExclude(unittest.TestCase):
|
|||
|
||||
play_context = Mock()
|
||||
task = MagicMock(Task)
|
||||
task.async = False
|
||||
task.async_val = False
|
||||
connection = Mock()
|
||||
|
||||
task.args = {'_raw_params': 'Args1'}
|
||||
|
|
@ -92,7 +92,7 @@ class TestCopyResultExclude(unittest.TestCase):
|
|||
|
||||
play_context = Mock()
|
||||
task = MagicMock(Task)
|
||||
task.async = False
|
||||
task.async_val = False
|
||||
connection = Mock()
|
||||
|
||||
task.args = {'_raw_params': 'Args1'}
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ class TaskMock(object):
|
|||
args = {'src': u'/tmp/deleteme',
|
||||
'dest': '/tmp/deleteme',
|
||||
'rsync_path': 'rsync'}
|
||||
async = None
|
||||
async_val = None
|
||||
become = None
|
||||
become_user = None
|
||||
become_method = None
|
||||
|
|
|
|||
Loading…
Reference in a new issue