ansible-core 2.17.4__py3-none-any.whl → 2.18.0b1__py3-none-any.whl

ansible/galaxy/collection/gpg.py

@@ -12,20 +12,14 @@ import contextlib
 import inspect
 import os
 import subprocess
-import sys
 import typing as t
 
 from dataclasses import dataclass, fields as dc_fields
-from functools import partial
 from urllib.error import HTTPError, URLError
 
 if t.TYPE_CHECKING:
     from ansible.utils.display import Display
 
-IS_PY310_PLUS = sys.version_info[:2] >= (3, 10)
-
-frozen_dataclass = partial(dataclass, frozen=True, **({'slots': True} if IS_PY310_PLUS else {}))
-
 
 def get_signature_from_source(source, display=None):  # type: (str, t.Optional[Display]) -> str
     if display is not None:
@@ -128,7 +122,7 @@ def parse_gpg_errors(status_out):  # type: (str) -> t.Iterator[GpgBaseError]
         yield cls(*fields)
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgBaseError(Exception):
     status: str
 
@@ -142,35 +136,35 @@ class GpgBaseError(Exception):
             super(GpgBaseError, self).__setattr__(field_name, field_type(getattr(self, field_name)))
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgExpSig(GpgBaseError):
     """The signature with the keyid is good, but the signature is expired."""
     keyid: str
     username: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgExpKeySig(GpgBaseError):
     """The signature with the keyid is good, but the signature was made by an expired key."""
     keyid: str
     username: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgRevKeySig(GpgBaseError):
     """The signature with the keyid is good, but the signature was made by a revoked key."""
     keyid: str
     username: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgBadSig(GpgBaseError):
     """The signature with the keyid has not been verified okay."""
     keyid: str
     username: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgErrSig(GpgBaseError):
     """"It was not possible to check the signature.  This may be caused by
     a missing public key or an unsupported algorithm.  A RC of 4
@@ -186,24 +180,24 @@ class GpgErrSig(GpgBaseError):
     fpr: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgNoPubkey(GpgBaseError):
     """The public key is not available."""
     keyid: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgMissingPassPhrase(GpgBaseError):
     """No passphrase was supplied."""
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgBadPassphrase(GpgBaseError):
     """The supplied passphrase was wrong or not given."""
     keyid: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgNoData(GpgBaseError):
     """No data has been found.  Codes for WHAT are:
     - 1 :: No armored data.
@@ -215,7 +209,7 @@ class GpgNoData(GpgBaseError):
     what: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgUnexpected(GpgBaseError):
     """No data has been found.  Codes for WHAT are:
     - 1 :: No armored data.
@@ -227,7 +221,7 @@ class GpgUnexpected(GpgBaseError):
     what: str
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgError(GpgBaseError):
     """This is a generic error status message, it might be followed by error location specific data."""
     location: str
@@ -235,30 +229,30 @@ class GpgError(GpgBaseError):
     more: str = ""
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgFailure(GpgBaseError):
     """This is the counterpart to SUCCESS and used to indicate a program failure."""
     location: str
     code: int
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgBadArmor(GpgBaseError):
     """The ASCII armor is corrupted."""
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgKeyExpired(GpgBaseError):
     """The key has expired."""
     timestamp: int
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgKeyRevoked(GpgBaseError):
     """The used key has been revoked by its owner."""
 
 
-@frozen_dataclass
+@dataclass(frozen=True, slots=True)
 class GpgNoSecKey(GpgBaseError):
     """The secret key is not available."""
     keyid: str

ansible/galaxy/data/COPYING

@@ -0,0 +1,7 @@
+All templates, files and files generated from them in the subdirectories of this one
+are subject to the MIT license when applicable.
+
+MIT License:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ansible/galaxy/data/apb/Dockerfile.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 FROM ansibleplaybookbundle/apb-base
 
 LABEL "com.redhat.apb.spec"=\

ansible/galaxy/data/apb/Makefile.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 DOCKERHOST = DOCKERHOST
 DOCKERORG = DOCKERORG
 IMAGENAME = {{ role_name }}

ansible/galaxy/data/apb/README.md

@@ -6,17 +6,21 @@ A brief description of the APB goes here.
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here.
+For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
 
 APB Variables
 --------------
 
-A description of the settable variables for this APB should go here, including any variables that are in defaults/main.yml, vars/main.yml, apb.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (i.e. hostvars, group vars, etc.) should be mentioned here as well.
+A description of the settable variables for this APB should go here, including any variables that are in defaults/main.yml, vars/main.yml, apb.yml, and
+any variables that can/should be set via parameters to the role.
+Any variables that are read from other roles and/or the global scope (i.e. hostvars, group vars, etc.) should be mentioned here as well.
 
 Dependencies
 ------------
 
-A list of other APBs/roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+A list of other APBs/roles hosted on Galaxy should go here, plus any details in regards to
+parameters that may need to be set for other roles, or variables that are used from other roles.
 
 Example Playbook
 ----------------

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

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 version: '1.0.0'
 name: {{ role_name }}
 description: {{ description }}

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

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

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

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

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

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

ansible/galaxy/data/apb/playbooks/deprovision.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 - name: "{{ role_name }} playbook to deprovision the application"
   hosts: localhost
   gather_facts: false

ansible/galaxy/data/apb/playbooks/provision.yml.j2

@@ -1,3 +1,4 @@
+#SPDX-License-Identifier: MIT-0
 - name: "{{ role_name }} playbook to provision the application"
   hosts: localhost
   gather_facts: false

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

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

ansible/galaxy/data/apb/tests/ansible.cfg

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

ansible/galaxy/data/apb/tests/inventory

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

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.4'
+__version__ = '2.18.0b1'
 __author__ = 'Ansible, Inc.'
-__codename__ = "Gallows Pole"
+__codename__ = "Fool in the Rain"