ansible-core 2.19.4__py3-none-any.whl → 2.20.0__py3-none-any.whl

ansible/modules/cron.py

@@ -219,20 +219,20 @@ import os
 import platform
 import pwd
 import re
+import shlex
 import sys
 import tempfile
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.file import S_IRWU_RWG_RWO
 from ansible.module_utils.common.text.converters import to_bytes, to_native
-from ansible.module_utils.six.moves import shlex_quote
 
 
 class CronTabError(Exception):
     pass
 
 
-class CronTab(object):
+class CronTab:
     """
         CronTab object to write time based crontab file
 
@@ -243,8 +243,8 @@ class CronTab(object):
     def __init__(self, module, user=None, cron_file=None):
         self.module = module
         self.user = user
-        self.root = (os.getuid() == 0)
-        self.lines = None
+        self.root = os.getuid() == 0
+        self.lines = []
         self.ansible = "#Ansible: "
         self.n_existing = ''
         self.cron_cmd = self.module.get_bin_path('crontab', required=True)
@@ -264,7 +264,6 @@ class CronTab(object):
 
     def read(self):
         # Read in the crontab from the system
-        self.lines = []
         if self.cron_file:
             # read the cronfile
             try:
@@ -280,7 +279,7 @@ class CronTab(object):
             # FIXME: using safely quoted shell for now, but this really should be two non-shell calls instead.
             (rc, out, err) = self.module.run_command(self._read_user_execute(), use_unsafe_shell=True)
 
-            if rc != 0 and rc != 1:  # 1 can mean that there are no jobs.
+            if rc not in (0, 1):  # 1 can mean that there are no jobs.
                 raise CronTabError("Unable to read crontab")
 
             self.n_existing = out
@@ -300,11 +299,10 @@ class CronTab(object):
     def is_empty(self):
         if len(self.lines) == 0:
             return True
-        else:
-            for line in self.lines:
-                if line.strip():
-                    return False
-            return True
+        for line in self.lines:
+            if line.strip():
+                return False
+        return True
 
     def write(self, backup_file=None):
         """
@@ -451,13 +449,10 @@ class CronTab(object):
         if special:
             if self.cron_file:
                 return "%s@%s %s %s" % (disable_prefix, special, self.user, job)
-            else:
-                return "%s@%s %s" % (disable_prefix, special, job)
-        else:
-            if self.cron_file:
-                return "%s%s %s %s %s %s %s %s" % (disable_prefix, minute, hour, day, month, weekday, self.user, job)
-            else:
-                return "%s%s %s %s %s %s %s" % (disable_prefix, minute, hour, day, month, weekday, job)
+            return "%s@%s %s" % (disable_prefix, special, job)
+        if self.cron_file:
+            return "%s%s %s %s %s %s %s %s" % (disable_prefix, minute, hour, day, month, weekday, self.user, job)
+        return "%s%s %s %s %s %s %s" % (disable_prefix, minute, hour, day, month, weekday, job)
 
     def get_jobnames(self):
         jobnames = []
@@ -495,8 +490,7 @@ class CronTab(object):
 
         if len(newlines) == 0:
             return True
-        else:
-            return False  # TODO add some more error testing
+        return False  # TODO add some more error testing
 
     def _update_env(self, name, decl, addenvfunction):
         newlines = []
@@ -529,13 +523,13 @@ class CronTab(object):
         user = ''
         if self.user:
             if platform.system() == 'SunOS':
-                return "su %s -c '%s -l'" % (shlex_quote(self.user), shlex_quote(self.cron_cmd))
-            elif platform.system() == 'AIX':
-                return "%s -l %s" % (shlex_quote(self.cron_cmd), shlex_quote(self.user))
-            elif platform.system() == 'HP-UX':
-                return "%s %s %s" % (self.cron_cmd, '-l', shlex_quote(self.user))
-            elif pwd.getpwuid(os.getuid())[0] != self.user:
-                user = '-u %s' % shlex_quote(self.user)
+                return "su %s -c '%s -l'" % (shlex.quote(self.user), shlex.quote(self.cron_cmd))
+            if platform.system() == 'AIX':
+                return "%s -l %s" % (shlex.quote(self.cron_cmd), shlex.quote(self.user))
+            if platform.system() == 'HP-UX':
+                return "%s %s %s" % (self.cron_cmd, '-l', shlex.quote(self.user))
+            if pwd.getpwuid(os.getuid())[0] != self.user:
+                user = '-u %s' % shlex.quote(self.user)
         return "%s %s %s" % (self.cron_cmd, user, '-l')
 
     def _write_execute(self, path):
@@ -546,10 +540,10 @@ class CronTab(object):
         if self.user:
             if platform.system() in ['SunOS', 'HP-UX', 'AIX']:
                 return "chown %s %s ; su '%s' -c '%s %s'" % (
-                    shlex_quote(self.user), shlex_quote(path), shlex_quote(self.user), self.cron_cmd, shlex_quote(path))
-            elif pwd.getpwuid(os.getuid())[0] != self.user:
-                user = '-u %s' % shlex_quote(self.user)
-        return "%s %s %s" % (self.cron_cmd, user, shlex_quote(path))
+                    shlex.quote(self.user), shlex.quote(path), shlex.quote(self.user), self.cron_cmd, shlex.quote(path))
+            if pwd.getpwuid(os.getuid())[0] != self.user:
+                user = '-u %s' % shlex.quote(self.user)
+        return "%s %s %s" % (self.cron_cmd, user, shlex.quote(path))
 
 
 def main():
@@ -668,7 +662,7 @@ def main():
 
     # if requested make a backup before making a change
     if backup and not module.check_mode:
-        (backuph, backup_file) = tempfile.mkstemp(prefix='crontab')
+        (dummy, backup_file) = tempfile.mkstemp(prefix='crontab')
         crontab.write(backup_file)
 
     if env:
@@ -763,9 +757,6 @@ def main():
 
     module.exit_json(**res_args)
 
-    # --- should never get here
-    module.exit_json(msg="Unable to execute cron task.")
-
 
 if __name__ == '__main__':
     main()

ansible/modules/deb822_repository.py

@@ -67,6 +67,17 @@ options:
         - Determines the path to the C(InRelease) file, relative to the normal
           position of an C(InRelease) file.
         type: str
+    install_python_debian:
+        description:
+        - Whether to automatically try to install the Python C(debian) library or not, if it is not already installed.
+          Without this library, the module does not work.
+            - Runs C(apt install python3-debian).
+            - Only works with the system Python. If you are using a Python on the remote that is not
+              the system Python, set O(install_python_debian=false) and ensure that the Python C(debian) library
+              for your Python version is installed some other way.
+        type: bool
+        default: false
+        version_added: '2.20'
     languages:
         description:
         - Defines which languages information such as translated
@@ -228,6 +239,7 @@ key_filename:
 
 import os
 import re
+import sys
 import tempfile
 import textwrap
 
@@ -235,9 +247,9 @@ from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.basic import missing_required_lib
 from ansible.module_utils.common.collections import is_sequence
 from ansible.module_utils.common.file import S_IRWXU_RXG_RXO, S_IRWU_RG_RO
+from ansible.module_utils.common.respawn import has_respawned, probe_interpreters_for_module, respawn_module
 from ansible.module_utils.common.text.converters import to_bytes
 from ansible.module_utils.common.text.converters import to_native
-from ansible.module_utils.six import raise_from  # type: ignore[attr-defined]
 from ansible.module_utils.urls import generic_urlparse
 from ansible.module_utils.urls import open_url
 from ansible.module_utils.urls import get_user_agent
@@ -326,7 +338,7 @@ def write_signed_by_key(module, v, slug):
         try:
             r = open_url(v, http_agent=get_user_agent())
         except Exception as exc:
-            raise_from(RuntimeError(to_native(exc)), exc)
+            raise RuntimeError('Could not fetch signed_by key.') from exc
         else:
             b_data = r.read()
     else:
@@ -357,6 +369,21 @@ def write_signed_by_key(module, v, slug):
     return changed, filename, None
 
 
+def install_python_debian(module, deb_pkg_name):
+
+    if not module.check_mode:
+        apt_path = module.get_bin_path('apt', required=True)
+        if apt_path:
+            rc, so, se = module.run_command([apt_path, 'update'])
+            if rc != 0:
+                module.fail_json(msg=f"Failed update while auto installing {deb_pkg_name} due to '{se.strip()}'")
+            rc, so, se = module.run_command([apt_path, 'install', deb_pkg_name, '-y', '-q'])
+            if rc != 0:
+                module.fail_json(msg=f"Failed to auto-install {deb_pkg_name} due to : '{se.strip()}'")
+    else:
+        module.fail_json(msg=f"{deb_pkg_name} must be installed to use check mode")
+
+
 def main():
     module = AnsibleModule(
         argument_spec={
@@ -395,6 +422,10 @@ def main():
             'inrelease_path': {
                 'type': 'str',
             },
+            'install_python_debian': {
+                'type': 'bool',
+                'default': False,
+            },
             'languages': {
                 'elements': 'str',
                 'type': 'list',
@@ -453,8 +484,53 @@ def main():
     )
 
     if not HAS_DEBIAN:
-        module.fail_json(msg=missing_required_lib("python3-debian"),
-                         exception=DEBIAN_IMP_ERR)
+        deb_pkg_name = 'python3-debian'
+        # This interpreter can't see the debian Python library- we'll do the following to try and fix that as per
+        # the apt_repository module:
+        # 1) look in common locations for system-owned interpreters that can see it; if we find one, respawn under it
+        # 2) finding none, try to install a matching python-debian package for the current interpreter version;
+        #    we limit to the current interpreter version to try and avoid installing a whole other Python just
+        #    for deb support
+        # 3) if we installed a support package, try to respawn under what we think is the right interpreter (could be
+        #    the current interpreter again, but we'll let it respawn anyway for simplicity)
+        # 4) if still not working, return an error and give up (some corner cases not covered, but this shouldn't be
+        #    made any more complex than it already is to try and cover more, eg, custom interpreters taking over
+        #    system locations)
+
+        if has_respawned():
+            # this shouldn't be possible; short-circuit early if it happens...
+            module.fail_json(msg=f"{deb_pkg_name} must be installed and visible from {sys.executable}.")
+
+        interpreters = ['/usr/bin/python3', '/usr/bin/python']
+
+        interpreter = probe_interpreters_for_module(interpreters, 'debian')
+
+        if interpreter:
+            # found the Python bindings; respawn this module under the interpreter where we found them
+            respawn_module(interpreter)
+            # this is the end of the line for this process, it will exit here once the respawned module has completed
+
+        # don't make changes if we're in check_mode
+        if module.check_mode:
+            module.fail_json(msg=f"{deb_pkg_name} must be installed to use check mode. If run with install_python_debian, this module can auto-install it.")
+
+        if module.params['install_python_debian']:
+            install_python_debian(module, deb_pkg_name)
+        else:
+            module.fail_json(msg=f'{deb_pkg_name} is not installed, and install_python_debian is False')
+
+        # try again to find the bindings in common places
+        interpreter = probe_interpreters_for_module(interpreters, 'debian')
+
+        if interpreter:
+            # found the Python bindings; respawn this module under the interpreter where we found them
+            # NB: respawn is somewhat wasteful if it's this interpreter, but simplifies the code
+            respawn_module(interpreter)
+            # this is the end of the line for this process, it will exit here once the respawned module has completed
+        else:
+            # we've done all we can do; just tell the user it's busted and get out
+            module.fail_json(msg=missing_required_lib(deb_pkg_name),
+                             exception=DEBIAN_IMP_ERR)
 
     check_mode = module.check_mode
 
@@ -510,14 +586,9 @@ def main():
         elif is_sequence(value):
             value = format_list(value)
         elif key == 'signed_by':
-            try:
-                key_changed, signed_by_filename, signed_by_data = write_signed_by_key(module, value, slug)
-                value = signed_by_filename or signed_by_data
-                changed |= key_changed
-            except RuntimeError as exc:
-                module.fail_json(
-                    msg='Could not fetch signed_by key: %s' % to_native(exc)
-                )
+            key_changed, signed_by_filename, signed_by_data = write_signed_by_key(module, value, slug)
+            value = signed_by_filename or signed_by_data
+            changed |= key_changed
 
         if value.count('\n') > 0:
             value = format_multiline(value)

ansible/modules/dnf.py

@@ -213,13 +213,6 @@ options:
     type: bool
     default: "no"
     version_added: "2.7"
-  install_repoquery:
-    description:
-      - This is effectively a no-op in DNF as it is not needed with DNF.
-      - This option is deprecated and will be removed in ansible-core 2.20.
-    type: bool
-    default: "yes"
-    version_added: "2.7"
   download_only:
     description:
       - Only download the packages, do not install them.
@@ -544,6 +537,9 @@ class DnfModule(YumDnf):
         conf.sslverify = sslverify
 
         # Set installroot
+        if not os.path.isdir(installroot):
+            self.module.fail_json(msg=f"Installroot {installroot} must be a directory")
+
         conf.installroot = installroot
 
         # Load substitutions from the filesystem

ansible/modules/dnf5.py

@@ -182,12 +182,6 @@ options:
         using this in combination with wildcard characters in O(name) may result in an unexpected results.
     type: bool
     default: "no"
-  install_repoquery:
-    description:
-      - This is effectively a no-op in DNF as it is not needed with DNF.
-      - This option is deprecated and will be removed in ansible-core 2.20.
-    type: bool
-    default: "yes"
   download_only:
     description:
       - Only download the packages, do not install them.
@@ -601,6 +595,10 @@ class Dnf5Module(YumDnf):
         conf.localpkg_gpgcheck = not self.disable_gpg_check
         conf.sslverify = self.sslverify
         conf.clean_requirements_on_remove = self.autoremove
+
+        if not os.path.isdir(self.installroot):
+            self.module.fail_json(msg=f"Installroot {self.installroot} must be a directory")
+
         conf.installroot = self.installroot
         conf.use_host_config = True  # needed for installroot
         conf.cacheonly = "all" if self.cacheonly else "none"

ansible/modules/expect.py

@@ -249,9 +249,6 @@ def main():
     end_date = datetime.datetime.now()
     delta = end_date - start_date
 
-    if b_out is None:
-        b_out = b''
-
     result = dict(
         cmd=args,
         stdout=to_native(b_out).rstrip('\r\n'),

ansible/modules/find.py

@@ -291,7 +291,6 @@ import time
 
 from ansible.module_utils.common.text.converters import to_text, to_native
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six import string_types
 
 
 class _Object:
@@ -496,7 +495,7 @@ def main():
 
     params = module.params
 
-    if params['mode'] and not isinstance(params['mode'], string_types):
+    if params['mode'] and not isinstance(params['mode'], str):
         module.fail_json(
             msg="argument 'mode' is not a string and conversion is not allowed, value is of type %s" % params['mode'].__class__.__name__
         )

ansible/modules/get_url.py

@@ -374,9 +374,9 @@ import shutil
 import tempfile
 
 from datetime import datetime, timezone
+from urllib.parse import urlsplit
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.six.moves.urllib.parse import urlsplit
 from ansible.module_utils.common.text.converters import to_native
 from ansible.module_utils.urls import fetch_url, url_argument_spec
 

ansible/modules/git.py

@@ -343,7 +343,6 @@ from ansible.module_utils.common.text.converters import to_native, to_text
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.locale import get_best_parsable_locale
 from ansible.module_utils.common.process import get_bin_path
-from ansible.module_utils.six import b, string_types
 
 
 def relocate_repo(module, result, repo_dir, old_repo_dir, worktree_dir):
@@ -443,12 +442,12 @@ def write_ssh_wrapper(module):
         fd, wrapper_path = tempfile.mkstemp()
 
     # use existing git_ssh/ssh_command, fallback to 'ssh'
-    template = b("""#!/bin/sh
+    template = """#!/bin/sh
 %s $GIT_SSH_OPTS "$@"
-""" % os.environ.get('GIT_SSH', os.environ.get('GIT_SSH_COMMAND', 'ssh')))
+""" % os.environ.get('GIT_SSH', os.environ.get('GIT_SSH_COMMAND', 'ssh'))
 
     # write it
-    with os.fdopen(fd, 'w+b') as fh:
+    with os.fdopen(fd, 'w') as fh:
         fh.write(template)
 
     # set execute
@@ -1257,7 +1256,7 @@ def main():
 
     # evaluate and set the umask before doing anything else
     if umask is not None:
-        if not isinstance(umask, string_types):
+        if not isinstance(umask, str):
             module.fail_json(msg="umask must be defined as a quoted octal integer")
         try:
             umask = int(umask, 8)

ansible/modules/include_vars.py

@@ -66,7 +66,7 @@ options:
     description:
       - Ignore unknown file extensions within the directory.
       - This allows users to specify a directory containing vars files that are intermingled with non-vars files extension types
-        (e.g. a directory with a README in it and vars files).
+        (for example, a directory with a README in it and vars files).
     type: bool
     default: no
     version_added: "2.7"

ansible/modules/known_hosts.py

@@ -225,7 +225,13 @@ def sanity_check(module, host, key, sshkeygen):
         rc, stdout, stderr = module.run_command(sshkeygen_command)
 
     if stdout == '':  # host not found
-        module.fail_json(msg="Host parameter does not match hashed host field in supplied key")
+        results = {
+            "msg": "Host parameter does not match hashed host field in supplied key",
+            "rc": rc,
+        }
+        if stderr:
+            results["stderr"] = stderr
+        module.fail_json(**results)
 
 
 def search_for_host_key(module, host, key, path, sshkeygen):