ansible-core 2.17.5rc1__py3-none-any.whl → 2.18.0rc1__py3-none-any.whl

ansible/playbook/base.py

@@ -4,6 +4,7 @@
 
 from __future__ import annotations
 
+import decimal
 import itertools
 import operator
 import os
@@ -386,13 +387,13 @@ class FieldAttributeBase:
         return fq_group_name, resolved_actions
 
     def _resolve_action(self, action_name, mandatory=True):
-        context = module_loader.find_plugin_with_context(action_name)
+        context = module_loader.find_plugin_with_context(action_name, ignore_deprecated=(not mandatory))
         if context.resolved and not context.action_plugin:
-            prefer = action_loader.find_plugin_with_context(action_name)
+            prefer = action_loader.find_plugin_with_context(action_name, ignore_deprecated=(not mandatory))
             if prefer.resolved:
                 context = prefer
         elif not context.resolved:
-            context = action_loader.find_plugin_with_context(action_name)
+            context = action_loader.find_plugin_with_context(action_name, ignore_deprecated=(not mandatory))
 
         if context.resolved:
             return context.resolved_fqcn
@@ -440,7 +441,13 @@ class FieldAttributeBase:
         if attribute.isa == 'string':
             value = to_text(value)
         elif attribute.isa == 'int':
-            value = int(value)
+            if not isinstance(value, int):
+                try:
+                    if (decimal_value := decimal.Decimal(value)) != (int_value := int(decimal_value)):
+                        raise decimal.DecimalException(f'Floating-point value {value!r} would be truncated.')
+                    value = int_value
+                except decimal.DecimalException as e:
+                    raise ValueError from e
         elif attribute.isa == 'float':
             value = float(value)
         elif attribute.isa == 'bool':
@@ -574,9 +581,7 @@ class FieldAttributeBase:
 
     def _load_vars(self, attr, ds):
         '''
-        Vars in a play can be specified either as a dictionary directly, or
-        as a list of dictionaries. If the later, this method will turn the
-        list into a single dictionary.
+        Vars in a play must be specified as a dictionary.
         '''
 
         def _validate_variable_keys(ds):
@@ -588,22 +593,6 @@ class FieldAttributeBase:
             if isinstance(ds, dict):
                 _validate_variable_keys(ds)
                 return combine_vars(self.vars, ds)
-            elif isinstance(ds, list):
-                line_file = getattr(ds, 'ansible_pos', ("unknown", 0))
-                display.deprecated(
-                    (
-                        'Specifying a list of dictionaries for vars is deprecated in favor of '
-                        'specifying a dictionary. Error occurred in the file: %s, line: %d' % (line_file[0], line_file[1])
-                    ),
-                    version='2.18'
-                )
-                all_vars = self.vars
-                for item in ds:
-                    if not isinstance(item, dict):
-                        raise ValueError
-                    _validate_variable_keys(item)
-                    all_vars = combine_vars(all_vars, item)
-                return all_vars
             elif ds is None:
                 return {}
             else:

ansible/playbook/helpers.py

@@ -293,8 +293,12 @@ def load_list_of_tasks(ds, play, block=None, role=None, task_include=None, use_h
             else:
                 if use_handlers:
                     t = Handler.load(task_ds, block=block, role=role, task_include=task_include, variable_manager=variable_manager, loader=loader)
+                    if t.action in C._ACTION_META and t.args.get('_raw_params') == "end_role":
+                        raise AnsibleParserError("Cannot execute 'end_role' from a handler")
                 else:
                     t = Task.load(task_ds, block=block, role=role, task_include=task_include, variable_manager=variable_manager, loader=loader)
+                    if t.action in C._ACTION_META and t.args.get('_raw_params') == "end_role" and role is None:
+                        raise AnsibleParserError("Cannot execute 'end_role' from outside of a role")
 
                 task_list.append(t)
 

ansible/playbook/loop_control.py

@@ -29,6 +29,7 @@ class LoopControl(FieldAttributeBase):
     pause = NonInheritableFieldAttribute(isa='float', default=0, always_post_validate=True)
     extended = NonInheritableFieldAttribute(isa='bool', always_post_validate=True)
     extended_allitems = NonInheritableFieldAttribute(isa='bool', default=True, always_post_validate=True)
+    break_when = NonInheritableFieldAttribute(isa='list', default=list)
 
     def __init__(self):
         super(LoopControl, self).__init__()
@@ -37,3 +38,10 @@ class LoopControl(FieldAttributeBase):
     def load(data, variable_manager=None, loader=None):
         t = LoopControl()
         return t.load_data(data, variable_manager=variable_manager, loader=loader)
+
+    def _post_validate_break_when(self, attr, value, templar):
+        '''
+        break_when is evaluated after the execution of the loop is complete,
+        and should not be templated during the regular post_validate step.
+        '''
+        return value

ansible/playbook/play.py

@@ -28,7 +28,7 @@ from ansible.playbook.base import Base
 from ansible.playbook.block import Block
 from ansible.playbook.collectionsearch import CollectionSearch
 from ansible.playbook.helpers import load_list_of_blocks, load_list_of_roles
-from ansible.playbook.role import Role, hash_params
+from ansible.playbook.role import Role
 from ansible.playbook.task import Task
 from ansible.playbook.taggable import Taggable
 from ansible.vars.manager import preprocess_vars
@@ -57,11 +57,9 @@ class Play(Base, Taggable, CollectionSearch):
 
     # Facts
     gather_facts = NonInheritableFieldAttribute(isa='bool', default=None, always_post_validate=True)
-
-    # defaults to be deprecated, should be 'None' in future
-    gather_subset = NonInheritableFieldAttribute(isa='list', default=(lambda: C.DEFAULT_GATHER_SUBSET), listof=string_types, always_post_validate=True)
-    gather_timeout = NonInheritableFieldAttribute(isa='int', default=C.DEFAULT_GATHER_TIMEOUT, always_post_validate=True)
-    fact_path = NonInheritableFieldAttribute(isa='string', default=C.DEFAULT_FACT_PATH)
+    gather_subset = NonInheritableFieldAttribute(isa='list', default=None, listof=string_types, always_post_validate=True)
+    gather_timeout = NonInheritableFieldAttribute(isa='int', default=None, always_post_validate=True)
+    fact_path = NonInheritableFieldAttribute(isa='string', default=None)
 
     # Variable Attributes
     vars_files = NonInheritableFieldAttribute(isa='list', default=list, priority=99)
@@ -102,22 +100,6 @@ class Play(Base, Taggable, CollectionSearch):
     def __repr__(self):
         return self.get_name()
 
-    @property
-    def ROLE_CACHE(self):
-        """Backwards compat for custom strategies using ``play.ROLE_CACHE``
-        """
-        display.deprecated(
-            'Play.ROLE_CACHE is deprecated in favor of Play.role_cache, or StrategyBase._get_cached_role',
-            version='2.18',
-        )
-        cache = {}
-        for path, roles in self.role_cache.items():
-            for role in roles:
-                name = role.get_name()
-                hashed_params = hash_params(role._get_hash_dict())
-                cache.setdefault(name, {})[hashed_params] = role
-        return cache
-
     def _validate_hosts(self, attribute, name, value):
         # Only validate 'hosts' if a value was passed in to original data set.
         if 'hosts' in self._ds:

ansible/playbook/play_context.py

@@ -113,22 +113,6 @@ class PlayContext(Base):
     # "PlayContext.force_handlers should not be used, the calling code should be using play itself instead"
     force_handlers = FieldAttribute(isa='bool', default=False)
 
-    @property
-    def verbosity(self):
-        display.deprecated(
-            "PlayContext.verbosity is deprecated, use ansible.utils.display.Display.verbosity instead.",
-            version="2.18"
-        )
-        return self._internal_verbosity
-
-    @verbosity.setter
-    def verbosity(self, value):
-        display.deprecated(
-            "PlayContext.verbosity is deprecated, use ansible.utils.display.Display.verbosity instead.",
-            version="2.18"
-        )
-        self._internal_verbosity = value
-
     def __init__(self, play=None, passwords=None, connection_lockfd=None):
         # Note: play is really not optional.  The only time it could be omitted is when we create
         # a PlayContext just so we can invoke its deserialize method to load it from a serialized

ansible/playbook/playbook_include.py

@@ -90,7 +90,7 @@ class PlaybookInclude(Base, Conditional, Taggable):
             # it is a collection playbook, setup default collections
             AnsibleCollectionConfig.default_collection = playbook_collection
         else:
-            # it is NOT a collection playbook, setup adjecent paths
+            # it is NOT a collection playbook, setup adjacent paths
             AnsibleCollectionConfig.playbook_paths.append(os.path.dirname(os.path.abspath(to_bytes(playbook, errors='surrogate_or_strict'))))
 
         pb._load_playbook_data(file_name=playbook, variable_manager=variable_manager, vars=self.vars.copy())
@@ -123,7 +123,7 @@ class PlaybookInclude(Base, Conditional, Taggable):
 
     def preprocess_data(self, ds):
         '''
-        Regorganizes the data for a PlaybookInclude datastructure to line
+        Reorganizes the data for a PlaybookInclude datastructure to line
         up with what we expect the proper attributes to be
         '''
 

ansible/playbook/role/__init__.py

@@ -107,7 +107,7 @@ class Role(Base, Conditional, Taggable, CollectionSearch, Delegatable):
         self.static = static
 
         # includes (static=false) default to private, while imports (static=true) default to public
-        # but both can be overriden by global config if set
+        # but both can be overridden by global config if set
         if public is None:
             global_private, origin = C.config.get_config_value_and_origin('DEFAULT_PRIVATE_ROLE_VARS')
             if origin == 'default':
@@ -508,7 +508,7 @@ class Role(Base, Conditional, Taggable, CollectionSearch, Delegatable):
         # get exported variables from meta/dependencies
         seen = []
         for dep in self.get_all_dependencies():
-            # Avoid reruning dupe deps since they can have vars from previous invocations and they accumulate in deps
+            # Avoid rerunning dupe deps since they can have vars from previous invocations and they accumulate in deps
             # TODO: re-examine dep loading to see if we are somehow improperly adding the same dep too many times
             if dep not in seen:
                 # only take 'exportable' vars from deps

ansible/plugins/__init__.py

@@ -99,6 +99,7 @@ class AnsiblePlugin(ABC):
 
     def set_option(self, option, value):
         self._options[option] = C.config.get_config_value(option, plugin_type=self.plugin_type, plugin_name=self._load_name, direct={option: value})
+        C.handle_config_noise(display)
 
     def set_options(self, task_keys=None, var_options=None, direct=None):
         '''
@@ -115,6 +116,7 @@ class AnsiblePlugin(ABC):
         if self.allow_extras and var_options and '_extras' in var_options:
             # these are largely unvalidated passthroughs, either plugin or underlying API will validate
             self._options['_extras'] = var_options['_extras']
+        C.handle_config_noise(display)
 
     def has_option(self, option):
         if not self._options:

ansible/plugins/action/__init__.py

@@ -8,8 +8,8 @@ from __future__ import annotations
 import base64
 import json
 import os
-import random
 import re
+import secrets
 import shlex
 import stat
 import tempfile
@@ -146,7 +146,7 @@ class ActionBase(ABC):
         Be cautious when directly passing ``new_module_args`` directly to a
         module invocation, as it will contain the defaults, and not only
         the args supplied from the task. If you do this, the module
-        should not define ``mututally_exclusive`` or similar.
+        should not define ``mutually_exclusive`` or similar.
 
         This code is roughly copied from the ``validate_argument_spec``
         action plugin for use by other action plugins.
@@ -1114,7 +1114,7 @@ class ActionBase(ABC):
             remote_files.append(remote_async_module_path)
 
             async_limit = self._task.async_val
-            async_jid = f'j{random.randint(0, 999999999999)}'
+            async_jid = f'j{secrets.randbelow(999999999999)}'
 
             # call the interpreter for async_wrapper directly
             # this permits use of a script for an interpreter on non-Linux platforms
@@ -1226,15 +1226,13 @@ class ActionBase(ABC):
                 try:
                     _validate_utf8_json(data)
                 except UnicodeEncodeError:
-                    # When removing this, also remove the loop and latin-1 from ansible.module_utils.common.text.converters.jsonify
-                    display.deprecated(
+                    raise ValueError(
                         f'Module "{self._task.resolved_action or self._task.action}" returned non UTF-8 data in '
-                        'the JSON response. This will become an error in the future',
-                        version='2.18',
+                        'the JSON response.',
                     )
 
             data['_ansible_parsed'] = True
-        except ValueError:
+        except ValueError as e:
             # not valid json, lets try to capture error
             data = dict(failed=True, _ansible_parsed=False)
             data['module_stdout'] = res.get('stdout', u'')
@@ -1248,7 +1246,7 @@ class ActionBase(ABC):
                 data['exception'] = data['module_stdout']
 
             # The default
-            data['msg'] = "MODULE FAILURE"
+            data['msg'] = f"MODULE FAILURE: {e}"
 
             # try to figure out if we are missing interpreter
             if self._used_interpreter is not None:

ansible/plugins/action/dnf.py

@@ -41,6 +41,13 @@ class ActionModule(ActionBase):
             facts = self._execute_module(
                 module_name="ansible.legacy.setup", module_args=dict(filter="ansible_pkg_mgr", gather_subset="!all"),
                 task_vars=task_vars)
+
+            if facts.get("failed", False):
+                raise AnsibleActionFail(
+                    f"Failed to fetch ansible_pkg_mgr to determine the dnf action backend: {facts.get('msg')}",
+                    result=facts,
+                )
+
             display.debug("Facts %s" % facts)
             module = facts.get("ansible_facts", {}).get("ansible_pkg_mgr", "auto")
             if (not self._task.delegate_to or self._task.delegate_facts) and module != 'auto':
@@ -75,9 +82,4 @@ class ActionModule(ActionBase):
                 result.update(self._execute_module(
                     module_name=module, module_args=new_module_args, task_vars=task_vars, wrap_async=self._task.async_val))
 
-        # Cleanup
-        if not self._task.async_val:
-            # remove a temporary path we created
-            self._remove_tmp_path(self._connection._shell.tmpdir)
-
         return result

ansible/plugins/action/package.py

@@ -68,6 +68,11 @@ class ActionModule(ActionBase):
                             module_args=dict(filter='ansible_pkg_mgr', gather_subset='!all'),
                             task_vars=task_vars,
                         )
+                        if facts.get("failed", False):
+                            raise AnsibleActionFail(
+                                f"Failed to fetch ansible_pkg_mgr to determine the package action backend: {facts.get('msg')}",
+                                result=facts,
+                            )
                         pmgr = 'ansible_pkg_mgr'
 
                     try:
@@ -103,9 +108,5 @@ class ActionModule(ActionBase):
 
         except AnsibleAction as e:
             result.update(e.result)
-        finally:
-            if not self._task.async_val:
-                # remove a temporary path we created
-                self._remove_tmp_path(self._connection._shell.tmpdir)
 
         return result

ansible/plugins/action/reboot.py

@@ -4,7 +4,7 @@
 
 from __future__ import annotations
 
-import random
+import secrets
 import time
 
 from datetime import datetime, timedelta, timezone
@@ -304,7 +304,7 @@ class ActionModule(ActionBase):
                     except AnsibleConnectionFailure:
                         pass
                 # Use exponential backoff with a max timeout, plus a little bit of randomness
-                random_int = random.randint(0, 1000) / 1000
+                random_int = secrets.randbelow(1000) / 1000
                 fail_sleep = 2 ** fail_count + random_int
                 if fail_sleep > max_fail_sleep:
 

ansible/plugins/become/__init__.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 import shlex
 
 from abc import abstractmethod
-from random import choice
+from secrets import choice
 from string import ascii_lowercase
 from gettext import dgettext
 

ansible/plugins/callback/__init__.py

@@ -22,6 +22,7 @@ import json
 import re
 import sys
 import textwrap
+from typing import TYPE_CHECKING
 
 from collections import OrderedDict
 from collections.abc import MutableMapping
@@ -41,6 +42,9 @@ from ansible.vars.clean import strip_internal_keys, module_response_deepcopy
 
 import yaml
 
+if TYPE_CHECKING:
+    from ansible.executor.task_result import TaskResult
+
 global_display = Display()
 
 
@@ -503,15 +507,52 @@ class CallbackBase(AnsiblePlugin):
     def v2_on_any(self, *args, **kwargs):
         self.on_any(args, kwargs)
 
-    def v2_runner_on_failed(self, result, ignore_errors=False):
+    def v2_runner_on_failed(self, result: TaskResult, ignore_errors: bool = False) -> None:
+        """Get details about a failed task and whether or not Ansible should continue
+        running tasks on the host where the failure occurred, then process the details
+        as required by the callback (output, profiling, logging, notifications, etc.)
+
+        Note: The 'ignore_errors' directive only works when the task can run and returns
+        a value of 'failed'. It does not make Ansible ignore undefined variable errors,
+        connection failures, execution issues (for example, missing packages), or syntax errors.
+
+        Customization note: For more information about the attributes and methods of the
+        TaskResult class, see lib/ansible/executor/task_result.py.
+
+        :param TaskResult result: An object that contains details about the task
+        :param bool ignore_errors: Whether or not Ansible should continue running tasks on the host
+        where the failure occurred
+
+        :return: None
+        """
         host = result._host.get_name()
         self.runner_on_failed(host, result._result, ignore_errors)
 
-    def v2_runner_on_ok(self, result):
+    def v2_runner_on_ok(self, result: TaskResult) -> None:
+        """Get details about a successful task and process them as required by the callback
+        (output, profiling, logging, notifications, etc.)
+
+        Customization note: For more information about the attributes and methods of the
+        TaskResult class, see lib/ansible/executor/task_result.py.
+
+        :param TaskResult result: An object that contains details about the task
+
+        :return: None
+        """
         host = result._host.get_name()
         self.runner_on_ok(host, result._result)
 
-    def v2_runner_on_skipped(self, result):
+    def v2_runner_on_skipped(self, result: TaskResult) -> None:
+        """Get details about a skipped task and process them as required by the callback
+        (output, profiling, logging, notifications, etc.)
+
+        Customization note: For more information about the attributes and methods of the
+        TaskResult class, see lib/ansible/executor/task_result.py.
+
+        :param TaskResult result: An object that contains details about the task
+
+        :return: None
+        """
         if C.DISPLAY_SKIPPED_HOSTS:
             host = result._host.get_name()
             self.runner_on_skipped(host, self._get_item_label(getattr(result._result, 'results', {})))

ansible/plugins/callback/default.py

@@ -293,7 +293,7 @@ class CallbackModule(CallbackBase):
         label = self._get_item_label(included_file._vars)
         if label:
             msg += " => (item=%s)" % label
-        self._display.display(msg, color=C.COLOR_SKIP)
+        self._display.display(msg, color=C.COLOR_INCLUDED)
 
     def v2_playbook_on_stats(self, stats):
         self._display.banner("PLAY RECAP")

ansible/plugins/cliconf/__init__.py

@@ -263,7 +263,7 @@ class CliconfBase(AnsiblePlugin):
                     'supports_commit_comment': <bool>,     # identify if adding comment to commit is supported of not
                     'supports_onbox_diff': <bool>,          # identify if on box diff capability is supported or not
                     'supports_generate_diff': <bool>,       # identify if diff capability is supported within plugin
-                    'supports_multiline_delimiter': <bool>, # identify if multiline demiliter is supported within config
+                    'supports_multiline_delimiter': <bool>, # identify if multiline delimiter is supported within config
                     'supports_diff_match': <bool>,          # identify if match is supported
                     'supports_diff_ignore_lines': <bool>,   # identify if ignore line in diff is supported
                     'supports_config_replace': <bool>,     # identify if running config replace with candidate config is supported

ansible/plugins/connection/paramiko_ssh.py

@@ -111,8 +111,7 @@ DOCUMENTATION = """
       proxy_command:
         default: ''
         description:
-            - Proxy information for running the connection via a jumphost
-            - Also this plugin will scan 'ssh_args', 'ssh_extra_args' and 'ssh_common_args' from the 'ssh' plugin settings for proxy information if set.
+            - Proxy information for running the connection via a jumphost.
         type: string
         env: [{name: ANSIBLE_PARAMIKO_PROXY_COMMAND}]
         ini:
@@ -120,60 +119,6 @@ DOCUMENTATION = """
         vars:
           - name: ansible_paramiko_proxy_command
             version_added: '2.15'
-      ssh_args:
-          description: Only used in parsing ProxyCommand for use in this plugin.
-          default: ''
-          type: string
-          ini:
-              - section: 'ssh_connection'
-                key: 'ssh_args'
-          env:
-              - name: ANSIBLE_SSH_ARGS
-          vars:
-              - name: ansible_ssh_args
-                version_added: '2.7'
-          deprecated:
-              why: In favor of the "proxy_command" option.
-              version: "2.18"
-              alternatives: proxy_command
-      ssh_common_args:
-          description: Only used in parsing ProxyCommand for use in this plugin.
-          type: string
-          ini:
-              - section: 'ssh_connection'
-                key: 'ssh_common_args'
-                version_added: '2.7'
-          env:
-              - name: ANSIBLE_SSH_COMMON_ARGS
-                version_added: '2.7'
-          vars:
-              - name: ansible_ssh_common_args
-          cli:
-              - name: ssh_common_args
-          default: ''
-          deprecated:
-              why: In favor of the "proxy_command" option.
-              version: "2.18"
-              alternatives: proxy_command
-      ssh_extra_args:
-          description: Only used in parsing ProxyCommand for use in this plugin.
-          type: string
-          vars:
-              - name: ansible_ssh_extra_args
-          env:
-            - name: ANSIBLE_SSH_EXTRA_ARGS
-              version_added: '2.7'
-          ini:
-            - key: ssh_extra_args
-              section: ssh_connection
-              version_added: '2.7'
-          cli:
-            - name: ssh_extra_args
-          default: ''
-          deprecated:
-              why: In favor of the "proxy_command" option.
-              version: "2.18"
-              alternatives: proxy_command
       pty:
         default: True
         description: 'SUDO usually requires a PTY, True to give a PTY and False to not give a PTY.'
@@ -399,30 +344,7 @@ class Connection(ConnectionBase):
         self._log_channel = name
 
     def _parse_proxy_command(self, port: int = 22) -> dict[str, t.Any]:
-        proxy_command = None
-        # Parse ansible_ssh_common_args, specifically looking for ProxyCommand
-        ssh_args = [
-            self.get_option('ssh_extra_args'),
-            self.get_option('ssh_common_args'),
-            self.get_option('ssh_args', ''),
-        ]
-
-        args = self._split_ssh_args(' '.join(ssh_args))
-        for i, arg in enumerate(args):
-            if arg.lower() == 'proxycommand':
-                # _split_ssh_args split ProxyCommand from the command itself
-                proxy_command = args[i + 1]
-            else:
-                # ProxyCommand and the command itself are a single string
-                match = SETTINGS_REGEX.match(arg)
-                if match:
-                    if match.group(1).lower() == 'proxycommand':
-                        proxy_command = match.group(2)
-
-            if proxy_command:
-                break
-
-        proxy_command = self.get_option('proxy_command') or proxy_command
+        proxy_command = self.get_option('proxy_command') or None
 
         sock_kwarg = {}
         if proxy_command: