ansible-core 2.15.4rc1__py3-none-any.whl → 2.16.0b2__py3-none-any.whl

ansible/plugins/action/group_by.py

@@ -27,6 +27,7 @@ class ActionModule(ActionBase):
     # We need to be able to modify the inventory
     TRANSFERS_FILES = False
     _VALID_ARGS = frozenset(('key', 'parents'))
+    _requires_connection = False
 
     def run(self, tmp=None, task_vars=None):
         if task_vars is None:

ansible/plugins/action/include_vars.py

@@ -10,7 +10,7 @@ import re
 import ansible.constants as C
 from ansible.errors import AnsibleError
 from ansible.module_utils.six import string_types
-from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.plugins.action import ActionBase
 from ansible.utils.vars import combine_vars
 
@@ -23,6 +23,7 @@ class ActionModule(ActionBase):
     VALID_DIR_ARGUMENTS = ['dir', 'depth', 'files_matching', 'ignore_files', 'extensions', 'ignore_unknown_extensions']
     VALID_FILE_ARGUMENTS = ['file', '_raw_params']
     VALID_ALL = ['name', 'hash_behaviour']
+    _requires_connection = False
 
     def _set_dir_defaults(self):
         if not self.depth:
@@ -182,7 +183,7 @@ class ActionModule(ActionBase):
             The default depth is unlimited.
         """
         current_depth = 0
-        sorted_walk = list(walk(self.source_dir, onerror=self._log_walk))
+        sorted_walk = list(walk(self.source_dir, onerror=self._log_walk, followlinks=True))
         sorted_walk.sort(key=lambda x: x[0])
         for current_root, current_dir, current_files in sorted_walk:
             current_depth += 1

ansible/plugins/action/normal.py

@@ -24,12 +24,12 @@ from ansible.utils.vars import merge_hash
 
 class ActionModule(ActionBase):
 
+    _supports_check_mode = True
+    _supports_async = True
+
     def run(self, tmp=None, task_vars=None):
 
         # individual modules might disagree but as the generic the action plugin, pass at this point.
-        self._supports_check_mode = True
-        self._supports_async = True
-
         result = super(ActionModule, self).run(tmp, task_vars)
         del tmp  # tmp no longer has any effect
 

ansible/plugins/action/pause.py

@@ -21,7 +21,7 @@ import datetime
 import time
 
 from ansible.errors import AnsibleError, AnsiblePromptInterrupt, AnsiblePromptNoninteractive
-from ansible.module_utils._text import to_text
+from ansible.module_utils.common.text.converters import to_text
 from ansible.plugins.action import ActionBase
 from ansible.utils.display import Display
 

ansible/plugins/action/reboot.py

@@ -8,10 +8,10 @@ __metaclass__ = type
 import random
 import time
 
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 
 from ansible.errors import AnsibleError, AnsibleConnectionFailure
-from ansible.module_utils._text import to_native, to_text
+from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.module_utils.common.validation import check_type_list, check_type_str
 from ansible.plugins.action import ActionBase
 from ansible.utils.display import Display
@@ -129,7 +129,7 @@ class ActionModule(ActionBase):
         else:
             args = self._get_value_from_facts('SHUTDOWN_COMMAND_ARGS', distribution, 'DEFAULT_SHUTDOWN_COMMAND_ARGS')
 
-            # Convert seconds to minutes. If less that 60, set it to 0.
+            # Convert seconds to minutes. If less than 60, set it to 0.
             delay_min = self.pre_reboot_delay // 60
             reboot_message = self._task.args.get('msg', self.DEFAULT_REBOOT_MESSAGE)
             return args.format(delay_sec=self.pre_reboot_delay, delay_min=delay_min, message=reboot_message)
@@ -236,7 +236,7 @@ class ActionModule(ActionBase):
         display.vvv("{action}: attempting to get system boot time".format(action=self._task.action))
         connect_timeout = self._task.args.get('connect_timeout', self._task.args.get('connect_timeout_sec', self.DEFAULT_CONNECT_TIMEOUT))
 
-        # override connection timeout from defaults to custom value
+        # override connection timeout from defaults to the custom value
         if connect_timeout:
             try:
                 display.debug("{action}: setting connect_timeout to {value}".format(action=self._task.action, value=connect_timeout))
@@ -280,14 +280,15 @@ class ActionModule(ActionBase):
         display.vvv("{action}: system successfully rebooted".format(action=self._task.action))
 
     def do_until_success_or_timeout(self, action, reboot_timeout, action_desc, distribution, action_kwargs=None):
-        max_end_time = datetime.utcnow() + timedelta(seconds=reboot_timeout)
+        max_end_time = datetime.now(timezone.utc) + timedelta(seconds=reboot_timeout)
         if action_kwargs is None:
             action_kwargs = {}
 
         fail_count = 0
         max_fail_sleep = 12
+        last_error_msg = ''
 
-        while datetime.utcnow() < max_end_time:
+        while datetime.now(timezone.utc) < max_end_time:
             try:
                 action(distribution=distribution, **action_kwargs)
                 if action_desc:
@@ -299,7 +300,7 @@ class ActionModule(ActionBase):
                         self._connection.reset()
                     except AnsibleConnectionFailure:
                         pass
-                # Use exponential backoff with a max timout, plus a little bit of randomness
+                # Use exponential backoff with a max timeout, plus a little bit of randomness
                 random_int = random.randint(0, 1000) / 1000
                 fail_sleep = 2 ** fail_count + random_int
                 if fail_sleep > max_fail_sleep:
@@ -310,14 +311,18 @@ class ActionModule(ActionBase):
                         error = to_text(e).splitlines()[-1]
                     except IndexError as e:
                         error = to_text(e)
-                    display.debug("{action}: {desc} fail '{err}', retrying in {sleep:.4} seconds...".format(
-                        action=self._task.action,
-                        desc=action_desc,
-                        err=error,
-                        sleep=fail_sleep))
+                    last_error_msg = f"{self._task.action}: {action_desc} fail '{error}'"
+                    msg = f"{last_error_msg}, retrying in {fail_sleep:.4f} seconds..."
+
+                    display.debug(msg)
+                    display.vvv(msg)
                 fail_count += 1
                 time.sleep(fail_sleep)
 
+        if last_error_msg:
+            msg = f"Last error message before the timeout exception - {last_error_msg}"
+            display.debug(msg)
+            display.vvv(msg)
         raise TimedOutException('Timed out waiting for {desc} (timeout={timeout})'.format(desc=action_desc, timeout=reboot_timeout))
 
     def perform_reboot(self, task_vars, distribution):
@@ -336,7 +341,7 @@ class ActionModule(ActionBase):
             display.debug('{action}: AnsibleConnectionFailure caught and handled: {error}'.format(action=self._task.action, error=to_text(e)))
             reboot_result['rc'] = 0
 
-        result['start'] = datetime.utcnow()
+        result['start'] = datetime.now(timezone.utc)
 
         if reboot_result['rc'] != 0:
             result['failed'] = True
@@ -406,7 +411,7 @@ class ActionModule(ActionBase):
         self._supports_check_mode = True
         self._supports_async = True
 
-        # If running with local connection, fail so we don't reboot ourself
+        # If running with local connection, fail so we don't reboot ourselves
         if self._connection.transport == 'local':
             msg = 'Running {0} with local connection would reboot the control node.'.format(self._task.action)
             return {'changed': False, 'elapsed': 0, 'rebooted': False, 'failed': True, 'msg': msg}
@@ -447,7 +452,7 @@ class ActionModule(ActionBase):
 
         if reboot_result['failed']:
             result = reboot_result
-            elapsed = datetime.utcnow() - reboot_result['start']
+            elapsed = datetime.now(timezone.utc) - reboot_result['start']
             result['elapsed'] = elapsed.seconds
             return result
 
@@ -459,7 +464,7 @@ class ActionModule(ActionBase):
         # Make sure reboot was successful
         result = self.validate_reboot(distribution, original_connection_timeout, action_kwargs={'previous_boot_time': previous_boot_time})
 
-        elapsed = datetime.utcnow() - reboot_result['start']
+        elapsed = datetime.now(timezone.utc) - reboot_result['start']
         result['elapsed'] = elapsed.seconds
 
         return result

ansible/plugins/action/script.py

@@ -23,7 +23,7 @@ import shlex
 
 from ansible.errors import AnsibleError, AnsibleAction, _AnsibleActionDone, AnsibleActionFail, AnsibleActionSkip
 from ansible.executor.powershell import module_manifest as ps_manifest
-from ansible.module_utils._text import to_bytes, to_native, to_text
+from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
 from ansible.plugins.action import ActionBase
 
 
@@ -40,11 +40,25 @@ class ActionModule(ActionBase):
         if task_vars is None:
             task_vars = dict()
 
+        validation_result, new_module_args = self.validate_argument_spec(
+            argument_spec={
+                '_raw_params': {},
+                'cmd': {'type': 'str'},
+                'creates': {'type': 'str'},
+                'removes': {'type': 'str'},
+                'chdir': {'type': 'str'},
+                'executable': {'type': 'str'},
+            },
+            required_one_of=[
+                ['_raw_params', 'cmd']
+            ]
+        )
+
         result = super(ActionModule, self).run(tmp, task_vars)
         del tmp  # tmp no longer has any effect
 
         try:
-            creates = self._task.args.get('creates')
+            creates = new_module_args['creates']
             if creates:
                 # do not run the command if the line contains creates=filename
                 # and the filename already exists. This allows idempotence
@@ -52,7 +66,7 @@ class ActionModule(ActionBase):
                 if self._remote_file_exists(creates):
                     raise AnsibleActionSkip("%s exists, matching creates option" % creates)
 
-            removes = self._task.args.get('removes')
+            removes = new_module_args['removes']
             if removes:
                 # do not run the command if the line contains removes=filename
                 # and the filename does not exist. This allows idempotence
@@ -62,7 +76,7 @@ class ActionModule(ActionBase):
 
             # The chdir must be absolute, because a relative path would rely on
             # remote node behaviour & user config.
-            chdir = self._task.args.get('chdir')
+            chdir = new_module_args['chdir']
             if chdir:
                 # Powershell is the only Windows-path aware shell
                 if getattr(self._connection._shell, "_IS_WINDOWS", False) and \
@@ -75,13 +89,14 @@ class ActionModule(ActionBase):
             # Split out the script as the first item in raw_params using
             # shlex.split() in order to support paths and files with spaces in the name.
             # Any arguments passed to the script will be added back later.
-            raw_params = to_native(self._task.args.get('_raw_params', ''), errors='surrogate_or_strict')
+            raw_params = to_native(new_module_args.get('_raw_params', ''), errors='surrogate_or_strict')
             parts = [to_text(s, errors='surrogate_or_strict') for s in shlex.split(raw_params.strip())]
             source = parts[0]
 
             # Support executable paths and files with spaces in the name.
-            executable = to_native(self._task.args.get('executable', ''), errors='surrogate_or_strict')
-
+            executable = new_module_args['executable']
+            if executable:
+                executable = to_native(new_module_args['executable'], errors='surrogate_or_strict')
             try:
                 source = self._loader.get_real_file(self._find_needle('files', source), decrypt=self._task.args.get('decrypt', True))
             except AnsibleError as e:
@@ -90,7 +105,7 @@ class ActionModule(ActionBase):
             if self._task.check_mode:
                 # check mode is supported if 'creates' or 'removes' are provided
                 # the task has already been skipped if a change would not occur
-                if self._task.args.get('creates') or self._task.args.get('removes'):
+                if new_module_args['creates'] or new_module_args['removes']:
                     result['changed'] = True
                     raise _AnsibleActionDone(result=result)
                 # If the script doesn't return changed in the result, it defaults to True,

ansible/plugins/action/set_fact.py

@@ -30,6 +30,7 @@ import ansible.constants as C
 class ActionModule(ActionBase):
 
     TRANSFERS_FILES = False
+    _requires_connection = False
 
     def run(self, tmp=None, task_vars=None):
         if task_vars is None:

ansible/plugins/action/set_stats.py

@@ -27,6 +27,7 @@ class ActionModule(ActionBase):
 
     TRANSFERS_FILES = False
     _VALID_ARGS = frozenset(('aggregate', 'data', 'per_host'))
+    _requires_connection = False
 
     # TODO: document this in non-empty set_stats.py module
     def run(self, tmp=None, task_vars=None):

ansible/plugins/action/shell.py

@@ -4,6 +4,7 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
+from ansible.errors import AnsibleActionFail
 from ansible.plugins.action import ActionBase
 
 
@@ -15,6 +16,11 @@ class ActionModule(ActionBase):
         # Shell module is implemented via command with a special arg
         self._task.args['_uses_shell'] = True
 
+        # Shell shares the same module code as command. Fail if command
+        # specific options are set.
+        if "expand_argument_vars" in self._task.args:
+            raise AnsibleActionFail(f"Unsupported parameters for ({self._task.action}) module: expand_argument_vars")
+
         command_action = self._shared_loader_obj.action_loader.get('ansible.legacy.command',
                                                                    task=self._task,
                                                                    connection=self._connection,

ansible/plugins/action/template.py

@@ -22,7 +22,7 @@ from jinja2.defaults import (
 from ansible import constants as C
 from ansible.config.manager import ensure_type
 from ansible.errors import AnsibleError, AnsibleFileNotFound, AnsibleAction, AnsibleActionFail
-from ansible.module_utils._text import to_bytes, to_text, to_native
+from ansible.module_utils.common.text.converters import to_bytes, to_text, to_native
 from ansible.module_utils.parsing.convert_bool import boolean
 from ansible.module_utils.six import string_types
 from ansible.plugins.action import ActionBase

ansible/plugins/action/unarchive.py

@@ -21,7 +21,7 @@ __metaclass__ = type
 import os
 
 from ansible.errors import AnsibleError, AnsibleAction, AnsibleActionFail, AnsibleActionSkip
-from ansible.module_utils._text import to_text
+from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.parsing.convert_bool import boolean
 from ansible.plugins.action import ActionBase
 

ansible/plugins/action/uri.py

@@ -10,7 +10,7 @@ __metaclass__ = type
 import os
 
 from ansible.errors import AnsibleError, AnsibleAction, _AnsibleActionDone, AnsibleActionFail
-from ansible.module_utils._text import to_native
+from ansible.module_utils.common.text.converters import to_native
 from ansible.module_utils.common.collections import Mapping, MutableMapping
 from ansible.module_utils.parsing.convert_bool import boolean
 from ansible.plugins.action import ActionBase

ansible/plugins/action/validate_argument_spec.py

@@ -14,6 +14,7 @@ class ActionModule(ActionBase):
     ''' Validate an arg spec'''
 
     TRANSFERS_FILES = False
+    _requires_connection = False
 
     def get_args_from_task_vars(self, argument_spec, task_vars):
         '''

ansible/plugins/action/wait_for_connection.py

@@ -20,9 +20,9 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 import time
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, timezone
 
-from ansible.module_utils._text import to_text
+from ansible.module_utils.common.text.converters import to_text
 from ansible.plugins.action import ActionBase
 from ansible.utils.display import Display
 
@@ -43,10 +43,10 @@ class ActionModule(ActionBase):
     DEFAULT_TIMEOUT = 600
 
     def do_until_success_or_timeout(self, what, timeout, connect_timeout, what_desc, sleep=1):
-        max_end_time = datetime.utcnow() + timedelta(seconds=timeout)
+        max_end_time = datetime.now(timezone.utc) + timedelta(seconds=timeout)
 
         e = None
-        while datetime.utcnow() < max_end_time:
+        while datetime.now(timezone.utc) < max_end_time:
             try:
                 what(connect_timeout)
                 if what_desc:

ansible/plugins/become/__init__.py

@@ -12,7 +12,7 @@ from string import ascii_lowercase
 from gettext import dgettext
 
 from ansible.errors import AnsibleError
-from ansible.module_utils._text import to_bytes
+from ansible.module_utils.common.text.converters import to_bytes
 from ansible.plugins import AnsiblePlugin
 
 

ansible/plugins/become/su.py

@@ -94,7 +94,7 @@ DOCUMENTATION = """
 import re
 import shlex
 
-from ansible.module_utils._text import to_bytes
+from ansible.module_utils.common.text.converters import to_bytes
 from ansible.plugins.become import BecomeBase
 
 

ansible/plugins/cache/__init__.py

@@ -29,7 +29,7 @@ from collections.abc import MutableMapping
 
 from ansible import constants as C
 from ansible.errors import AnsibleError
-from ansible.module_utils._text import to_bytes, to_text
+from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins import AnsiblePlugin
 from ansible.plugins.loader import cache_loader
 from ansible.utils.collection_loader import resource_from_fqcr

ansible/plugins/callback/junit.py

@@ -88,7 +88,7 @@ import time
 import re
 
 from ansible import constants as C
-from ansible.module_utils._text import to_bytes, to_text
+from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.callback import CallbackBase
 from ansible.utils._junit_xml import (
     TestCase,

ansible/plugins/callback/oneline.py

@@ -12,7 +12,7 @@ DOCUMENTATION = '''
     short_description: oneline Ansible screen output
     version_added: historical
     description:
-        - This is the output callback used by the -o/--one-line command line option.
+        - This is the output callback used by the C(-o)/C(--one-line) command line option.
 '''
 
 from ansible.plugins.callback import CallbackBase

ansible/plugins/callback/tree.py

@@ -31,7 +31,7 @@ DOCUMENTATION = '''
 import os
 
 from ansible.constants import TREE_DIR
-from ansible.module_utils._text import to_bytes, to_text
+from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.callback import CallbackBase
 from ansible.utils.path import makedirs_safe, unfrackpath
 

ansible/plugins/cliconf/__init__.py

@@ -24,7 +24,7 @@ from functools import wraps
 
 from ansible.plugins import AnsiblePlugin
 from ansible.errors import AnsibleError, AnsibleConnectionFailure
-from ansible.module_utils._text import to_bytes, to_text
+from ansible.module_utils.common.text.converters import to_bytes, to_text
 
 try:
     from scp import SCPClient
@@ -276,7 +276,7 @@ class CliconfBase(AnsiblePlugin):
                 'diff_replace': [list of supported replace values],
                 'output': [list of supported command output format]
             }
-        :return: capability as json string
+        :return: capability as dict
         """
         result = {}
         result['rpc'] = self.get_base_rpc()