ansible-core 2.17.6rc1__py3-none-any.whl → 2.18.0__py3-none-any.whl

ansible/galaxy/data/apb/tests/test.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 ---
 - hosts: localhost
   gather_facts: no

ansible/galaxy/data/apb/vars/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # vars file for {{ role_name }}

ansible/galaxy/data/collections_galaxy_meta.yml

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 # Copyright (c) 2019 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 

ansible/galaxy/data/container/defaults/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # defaults file for {{ role_name }}

ansible/galaxy/data/container/handlers/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # handlers file for {{ role_name }}

ansible/galaxy/data/container/meta/container.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 # Add your Ansible Container service definitions here.
 # For example:
   #

ansible/galaxy/data/container/meta/main.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 galaxy_info:
   author: {{ author }}
   description: {{ description }}

ansible/galaxy/data/container/tasks/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # tasks file for {{ role_name }}

ansible/galaxy/data/container/tests/ansible.cfg

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 [defaults]
 inventory=./inventory

ansible/galaxy/data/container/tests/inventory

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 localhost
 
 

ansible/galaxy/data/container/tests/test.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 ---
 - hosts: localhost
   gather_facts: no

ansible/galaxy/data/container/vars/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # vars file for {{ role_name }}

ansible/galaxy/data/default/collection/README.md.j2

@@ -1,3 +1,4 @@
+{# SPDX-License-Identifier: MIT-0 #}
 # Ansible Collection - {{ namespace }}.{{ collection_name }}
 
 Documentation for the collection.

ansible/galaxy/data/default/collection/galaxy.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 ### REQUIRED
 {% for option in required_config %}
 {{ option.description | comment_ify }}

ansible/galaxy/data/default/collection/meta/runtime.yml

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # Collections must specify a minimum required ansible version to upload
 # to galaxy

ansible/galaxy/data/default/collection/plugins/README.md.j2

@@ -1,3 +1,4 @@
+{# SPDX-License-Identifier: MIT-0 #}
 # Collections Plugins Directory
 
 This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that

ansible/galaxy/data/default/role/defaults/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # defaults file for {{ role_name }}

ansible/galaxy/data/default/role/handlers/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # handlers file for {{ role_name }}

ansible/galaxy/data/default/role/meta/main.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 galaxy_info:
   author: {{ author }}
   description: {{ description }}

ansible/galaxy/data/default/role/tasks/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # tasks file for {{ role_name }}

ansible/galaxy/data/default/role/tests/inventory

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 localhost
 

ansible/galaxy/data/default/role/tests/test.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 ---
 - hosts: localhost
   remote_user: root

ansible/galaxy/data/default/role/vars/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # vars file for {{ role_name }}

ansible/galaxy/data/network/cliconf_plugins/example.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/defaults/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # defaults file for {{ role_name }}

ansible/galaxy/data/network/library/example_command.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/library/example_config.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/library/example_facts.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/meta/main.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 galaxy_info:
   author: {{ author }}
   description: {{ description }}

ansible/galaxy/data/network/module_utils/example.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/netconf_plugins/example.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/tasks/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # tasks file for {{ role_name }}

ansible/galaxy/data/network/terminal_plugins/example.py.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 #
 # (c) 2018 Red Hat Inc.
 #

ansible/galaxy/data/network/tests/inventory

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 localhost
 

ansible/galaxy/data/network/tests/test.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 ---
 - hosts: localhost
   connection: network_cli

ansible/galaxy/data/network/vars/main.yml.j2

@@ -1,2 +1,3 @@
+#SPDX-License-Identifier: MIT-0
 ---
 # vars file for {{ role_name }}

ansible/galaxy/dependency_resolution/providers.py

@@ -126,7 +126,7 @@ class CollectionDependencyProviderBase(AbstractProvider):
             the current candidate list
 
           * ``parent`` specifies the candidate that provides
-            (dependend on) the requirement, or `None`
+            (depended on) the requirement, or `None`
             to indicate a root requirement.
 
         resolvelib >=0.7.0, < 0.8.0
@@ -202,7 +202,7 @@ class CollectionDependencyProviderBase(AbstractProvider):
         remote archives), the one-and-only match is returned
 
         For a "named" requirement, Galaxy-compatible APIs are consulted
-        to find concrete candidates for this requirement. Of theres a
+        to find concrete candidates for this requirement. If there's a
         pre-installed candidate, it's prepended in front of others.
 
         resolvelib >=0.5.3, <0.6.0
@@ -437,7 +437,7 @@ class CollectionDependencyProviderBase(AbstractProvider):
         # FIXME: differs. So how do we resolve this case? Priority?
         # FIXME: Taking into account a pinned hash? Exploding on
         # FIXME: any differences?
-        # NOTE: The underlying implmentation currently uses first found
+        # NOTE: The underlying implementation currently uses first found
         req_map = self._api_proxy.get_collection_dependencies(candidate)
 
         # NOTE: This guard expression MUST perform an early exit only

ansible/galaxy/role.py

@@ -256,7 +256,7 @@ class GalaxyRole(object):
             display.display("- downloading role from %s" % archive_url)
 
             try:
-                url_file = open_url(archive_url, validate_certs=self._validate_certs, http_agent=user_agent())
+                url_file = open_url(archive_url, validate_certs=self._validate_certs, http_agent=user_agent(), timeout=60)
                 temp_file = tempfile.NamedTemporaryFile(delete=False)
                 data = url_file.read()
                 while data:

ansible/galaxy/token.py

@@ -21,11 +21,14 @@
 from __future__ import annotations
 
 import base64
-import os
 import json
+import os
+import time
 from stat import S_IRUSR, S_IWUSR
+from urllib.error import HTTPError
 
 from ansible import constants as C
+from ansible.galaxy.api import GalaxyError
 from ansible.galaxy.user_agent import user_agent
 from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
 from ansible.module_utils.common.yaml import yaml_dump, yaml_load
@@ -57,12 +60,16 @@ class KeycloakToken(object):
         self.client_id = client_id
         if self.client_id is None:
             self.client_id = 'cloud-services'
+        self._expiration = None
 
     def _form_payload(self):
         return 'grant_type=refresh_token&client_id=%s&refresh_token=%s' % (self.client_id,
                                                                            self.access_token)
 
     def get(self):
+        if self._expiration and time.time() >= self._expiration:
+            self._token = None
+
         if self._token:
             return self._token
 
@@ -76,15 +83,20 @@ class KeycloakToken(object):
         #         or 'azp' (Authorized party - the party to which the ID Token was issued)
         payload = self._form_payload()
 
-        resp = open_url(to_native(self.auth_url),
-                        data=payload,
-                        validate_certs=self.validate_certs,
-                        method='POST',
-                        http_agent=user_agent())
+        try:
+            resp = open_url(to_native(self.auth_url),
+                            data=payload,
+                            validate_certs=self.validate_certs,
+                            method='POST',
+                            http_agent=user_agent())
+        except HTTPError as e:
+            raise GalaxyError(e, 'Unable to get access token')
 
-        # TODO: handle auth errors
+        data = json.load(resp)
 
-        data = json.loads(to_text(resp.read(), errors='surrogate_or_strict'))
+        # So that we have a buffer, expire the token in ~2/3 the given value
+        expires_in = data['expires_in'] // 3 * 2
+        self._expiration = time.time() + expires_in
 
         # - extract 'access_token'
         self._token = data.get('access_token')

ansible/keyword_desc.yml

@@ -61,7 +61,7 @@ serial: Explicitly define how Ansible batches the execution of the current play
 strategy: Allows you to choose the strategy plugin to use for the play. See :ref:`strategy_plugins`.
 tags: Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
 tasks: Main list of tasks to execute in the play, they run after :term:`roles` and before :term:`post_tasks`.
-timeout: Time limit for the task to execute in, if exceeded Ansible will interrupt and fail the task.
+timeout: Time limit for the task action to execute in, if exceeded, Ansible will interrupt the process. Timeout does not include templating or looping.
 throttle: Limit the number of concurrent task runs on task, block and playbook level. This is independent of the forks and serial settings, but cannot be set higher than those limits. For example, if forks is set to 10 and the throttle is set to 15, at most 10 hosts will be operated on in parallel.
 until: "This keyword implies a ':term:`retries` loop' that will go on until the condition supplied here is met or we hit the :term:`retries` limit."
 vars: Dictionary/map of variables

ansible/module_utils/_internal/_concurrent/_daemon_threading.py

@@ -0,0 +1,28 @@
+"""Proxy stdlib threading module that only supports non-joinable daemon threads."""
+# NB: all new local module attrs are _ prefixed to ensure an identical public attribute surface area to the module we're proxying
+
+from __future__ import annotations as _annotations
+
+import threading as _threading
+import typing as _t
+
+
+class _DaemonThread(_threading.Thread):
+    """
+    Daemon-only Thread subclass; prevents running threads of this type from blocking interpreter shutdown and process exit.
+    The join() method is a no-op.
+    """
+
+    def __init__(self, *args, daemon: bool | None = None, **kwargs) -> None:
+        super().__init__(*args, daemon=daemon or True, **kwargs)
+
+    def join(self, timeout=None) -> None:
+        """ThreadPoolExecutor's atexit handler joins all queue threads before allowing shutdown; prevent them from blocking."""
+
+
+Thread = _DaemonThread  # shadow the real Thread attr with our _DaemonThread
+
+
+def __getattr__(name: str) -> _t.Any:
+    """Delegate anything not defined locally to the real `threading` module."""
+    return getattr(_threading, name)

ansible/module_utils/_internal/_concurrent/_futures.py

@@ -0,0 +1,21 @@
+"""Utilities for concurrent code execution using futures."""
+
+from __future__ import annotations
+
+import concurrent.futures
+import types
+
+from . import _daemon_threading
+
+
+class DaemonThreadPoolExecutor(concurrent.futures.ThreadPoolExecutor):
+    """ThreadPoolExecutor subclass that creates non-joinable daemon threads for non-blocking pool and process shutdown with abandoned threads."""
+
+    atc = concurrent.futures.ThreadPoolExecutor._adjust_thread_count
+
+    # clone the base class `_adjust_thread_count` method with a copy of its globals dict
+    _adjust_thread_count = types.FunctionType(atc.__code__, atc.__globals__.copy(), name=atc.__name__, argdefs=atc.__defaults__, closure=atc.__closure__)
+    # patch the method closure's `threading` module import to use our daemon-only thread factory instead
+    _adjust_thread_count.__globals__.update(threading=_daemon_threading)
+
+    del atc  # don't expose this as a class attribute

ansible/module_utils/ansible_release.py

@@ -17,6 +17,6 @@
 
 from __future__ import annotations
 
-__version__ = '2.17.6rc1'
+__version__ = '2.18.0'
 __author__ = 'Ansible, Inc.'
-__codename__ = "Gallows Pole"
+__codename__ = "Fool in the Rain"

ansible/module_utils/api.py

@@ -28,7 +28,7 @@ from __future__ import annotations
 import copy
 import functools
 import itertools
-import random
+import secrets
 import sys
 import time
 
@@ -131,7 +131,7 @@ def generate_jittered_backoff(retries=10, delay_base=3, delay_threshold=60):
     :param delay_threshold: The maximum time in seconds for any delay.
     """
     for retry in range(0, retries):
-        yield random.randint(0, min(delay_threshold, delay_base * 2 ** retry))
+        yield secrets.randbelow(min(delay_threshold, delay_base * 2 ** retry))
 
 
 def retry_never(exception_or_result):

ansible/module_utils/basic.py

@@ -9,7 +9,7 @@ import sys
 
 # Used for determining if the system is running a new enough python version
 # and should only restrict on our documented minimum versions
-_PY_MIN = (3, 7)
+_PY_MIN = (3, 8)
 
 if sys.version_info < _PY_MIN:
     print(json.dumps(dict(
@@ -458,7 +458,7 @@ class AnsibleModule(object):
         self._selinux_mls_enabled = None
         self._selinux_initial_context = None
 
-        # finally, make sure we're in a sane working dir
+        # finally, make sure we're in a logical working dir
         self._set_cwd()
 
     @property
@@ -1202,6 +1202,7 @@ class AnsibleModule(object):
                     setattr(self, PASS_VARS[k][0], PASS_VARS[k][1])
 
     def safe_eval(self, value, locals=None, include_exceptions=False):
+        # deprecated: description='no longer used in the codebase' core_version='2.21'
         return safe_eval(value, locals, include_exceptions)
 
     def _load_params(self):
@@ -1353,9 +1354,10 @@ class AnsibleModule(object):
         Find system executable in PATH.
 
         :param arg: The executable to find.
-        :param required: if executable is not found and required is ``True``, fail_json
+        :param required: if the executable is not found and required is ``True``, fail_json
         :param opt_dirs: optional list of directories to search in addition to ``PATH``
-        :returns: if found return full path; otherwise return None
+        :returns: if found return full path; otherwise return original arg, unless 'warning' then return None
+        :raises: Sysexit: if arg is not found and required=True (via fail_json)
         '''
 
         bin_path = None
@@ -1364,8 +1366,6 @@ class AnsibleModule(object):
         except ValueError as e:
             if required:
                 self.fail_json(msg=to_text(e))
-            else:
-                return bin_path
 
         return bin_path
 
@@ -1432,7 +1432,7 @@ class AnsibleModule(object):
             kwargs['deprecations'] = deprecations
 
         # preserve bools/none from no_log
-        # TODO: once python version on target high enough, dict comprh
+        # TODO: once python version on target high enough, dict comprehensions
         preserved = {}
         for k, v in kwargs.items():
             if v is None or isinstance(v, bool):
@@ -2061,7 +2061,7 @@ class AnsibleModule(object):
                 # not as exact as above, but should be good enough for most platforms that fail the previous call
                 buffer_size = select.PIPE_BUF
             except Exception:
-                buffer_size = 9000  # use sane default JIC
+                buffer_size = 9000  # use logical default JIC
 
         return buffer_size
 

ansible/module_utils/common/collections.py

@@ -65,7 +65,7 @@ class ImmutableDict(Hashable, Mapping):
 
 
 def is_string(seq):
-    """Identify whether the input has a string-like type (inclding bytes)."""
+    """Identify whether the input has a string-like type (including bytes)."""
     # AnsibleVaultEncryptedUnicode inherits from Sequence, but is expected to be a string like object
     return isinstance(seq, (text_type, binary_type)) or getattr(seq, '__ENCRYPTED__', False)
 

ansible/module_utils/common/file.py

@@ -7,12 +7,6 @@ import os
 import stat
 import re
 
-try:
-    import selinux  # pylint: disable=unused-import
-    HAVE_SELINUX = True
-except ImportError:
-    HAVE_SELINUX = False
-
 
 FILE_ATTRIBUTES = {
     'A': 'noatime',

ansible/module_utils/common/process.py

@@ -12,13 +12,18 @@ from ansible.module_utils.common.warnings import deprecate
 def get_bin_path(arg, opt_dirs=None, required=None):
     '''
     Find system executable in PATH. Raises ValueError if the executable is not found.
-    Optional arguments:
-       - required:  [Deprecated] Before 2.10, if executable is not found and required is true it raises an Exception.
-                    In 2.10 and later, an Exception is always raised. This parameter will be removed in 2.21.
-       - opt_dirs:  optional list of directories to search in addition to PATH
+
+    :param arg: the executable to find
+    :type arg: string
+    :param opt_dirs: optional list of directories to search in addition to PATH
+    :type opt_dirs: list of strings
+    :param required: DEPRECATED. This parameter will be removed in 2.21
+    :type required: boolean
+    :returns: path to arg (should be abs path unless PATH or opt_dirs are relative paths)
+    :raises: ValueError: if arg is not found
+
     In addition to PATH and opt_dirs, this function also looks through /sbin, /usr/sbin and /usr/local/sbin. A lot of
     modules, especially for gathering facts, depend on this behaviour.
-    If found return full path, otherwise raise ValueError.
     '''
     if required is not None:
         deprecate(
@@ -27,26 +32,34 @@ def get_bin_path(arg, opt_dirs=None, required=None):
             collection_name="ansible.builtin",
         )
 
+    paths = []
+    sbin_paths = ['/sbin', '/usr/sbin', '/usr/local/sbin']
     opt_dirs = [] if opt_dirs is None else opt_dirs
 
-    sbin_paths = ['/sbin', '/usr/sbin', '/usr/local/sbin']
-    paths = []
+    # Construct possible paths with precedence
+    # passed in paths
     for d in opt_dirs:
         if d is not None and os.path.exists(d):
             paths.append(d)
+    # system configured paths
     paths += os.environ.get('PATH', '').split(os.pathsep)
-    bin_path = None
-    # mangle PATH to include /sbin dirs
+
+    # existing /sbin dirs, if not there already
     for p in sbin_paths:
         if p not in paths and os.path.exists(p):
             paths.append(p)
+
+    # Search for binary
+    bin_path = None
     for d in paths:
         if not d:
             continue
         path = os.path.join(d, arg)
         if os.path.exists(path) and not os.path.isdir(path) and is_executable(path):
+            # fist found wins
             bin_path = path
             break
+
     if bin_path is None:
         raise ValueError('Failed to find required executable "%s" in paths: %s' % (arg, os.pathsep.join(paths)))
 

ansible/module_utils/common/text/converters.py

@@ -267,14 +267,11 @@ def _json_encode_fallback(obj):
 
 
 def jsonify(data, **kwargs):
-    # After 2.18, we should remove this loop, and hardcode to utf-8 in alignment with requiring utf-8 module responses
-    for encoding in ("utf-8", "latin-1"):
-        try:
-            new_data = container_to_text(data, encoding=encoding)
-        except UnicodeDecodeError:
-            continue
-        return json.dumps(new_data, default=_json_encode_fallback, **kwargs)
-    raise UnicodeError('Invalid unicode encoding encountered')
+    try:
+        new_data = container_to_text(data, encoding='utf-8')
+    except UnicodeDecodeError:
+        raise UnicodeError('Invalid unicode encoding encountered')
+    return json.dumps(new_data, default=_json_encode_fallback, **kwargs)
 
 
 def container_to_bytes(d, encoding='utf-8', errors='surrogate_or_strict'):

ansible/module_utils/common/text/formatters.py

@@ -20,6 +20,18 @@ SIZE_RANGES = {
     'B': 1,
 }
 
+VALID_UNITS = {
+    'B': (('byte', 'B'), ('bit', 'b')),
+    'K': (('kilobyte', 'KB'), ('kilobit', 'Kb')),
+    'M': (('megabyte', 'MB'), ('megabit', 'Mb')),
+    'G': (('gigabyte', 'GB'), ('gigabit', 'Gb')),
+    'T': (('terabyte', 'TB'), ('terabit', 'Tb')),
+    'P': (('petabyte', 'PB'), ('petabit', 'Pb')),
+    'E': (('exabyte', 'EB'), ('exabit', 'Eb')),
+    'Z': (('zetabyte', 'ZB'), ('zetabit', 'Zb')),
+    'Y': (('yottabyte', 'YB'), ('yottabit', 'Yb')),
+}
+
 
 def lenient_lowercase(lst):
     """Lowercase elements of a list.
@@ -53,7 +65,8 @@ def human_to_bytes(number, default_unit=None, isbits=False):
         The function expects 'b' (lowercase) as a bit identifier, e.g. 'Mb'/'Kb'/etc.
         if 'MB'/'KB'/... is passed, the ValueError will be rased.
     """
-    m = re.search(r'^\s*(\d*\.?\d*)\s*([A-Za-z]+)?', str(number), flags=re.IGNORECASE)
+    m = re.search(r'^([0-9]*\.?[0-9]+)(?:\s*([A-Za-z]+))?\s*$', str(number))
+
     if m is None:
         raise ValueError("human_to_bytes() can't interpret following string: %s" % str(number))
     try:
@@ -86,10 +99,13 @@ def human_to_bytes(number, default_unit=None, isbits=False):
         expect_message = 'expect %s%s or %s' % (range_key, unit_class, range_key)
         if range_key == 'B':
             expect_message = 'expect %s or %s' % (unit_class, unit_class_name)
-
-        if unit_class_name in unit.lower():
+        unit_group = VALID_UNITS.get(range_key, None)
+        if unit_group is None:
+            raise ValueError(f"human_to_bytes() can't interpret a valid unit for {range_key}")
+        isbits_flag = 1 if isbits else 0
+        if unit.lower() == unit_group[isbits_flag][0]:
             pass
-        elif unit[1] != unit_class:
+        elif unit != unit_group[isbits_flag][1]:
             raise ValueError("human_to_bytes() failed to convert %s. Value is not a valid string (%s)" % (number, expect_message))
 
     return int(round(num * limit))