ansible-core 2.18.5rc1__py3-none-any.whl → 2.19.0b2__py3-none-any.whl

ansible/modules/gather_facts.py

@@ -1,11 +1,11 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2017 Ansible Project
+# Copyright: Contributors to the Ansible project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: gather_facts
 version_added: 2.8
@@ -57,7 +57,7 @@ notes:
       Order is not guaranteed, when doing parallel gathering on multiple modules.
 author:
     - "Ansible Core Team"
-'''
+"""
 
 RETURN = """
 # depends on the fact module called

ansible/modules/get_url.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: get_url
 short_description: Downloads files from HTTP, HTTPS, or FTP to node
@@ -219,9 +219,9 @@ seealso:
 - module: ansible.windows.win_get_url
 author:
 - Jan-Piet Mens (@jpmens)
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Download foo.conf
   ansible.builtin.get_url:
     url: http://example.com/path/file.conf
@@ -272,9 +272,9 @@ EXAMPLES = r'''
     dest: /etc/foo.conf
     username: bar
     password: '{{ mysecret }}'
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 backup_file:
     description: name of backup file created after download
     returned: changed and if backup=yes
@@ -365,17 +365,18 @@ url:
     returned: always
     type: str
     sample: https://www.ansible.com/
-'''
+"""
 
+import email.message
 import os
 import re
 import shutil
 import tempfile
-import traceback
+
+from datetime import datetime, timezone
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.six.moves.urllib.parse import urlsplit
-from ansible.module_utils.compat.datetime import utcnow, utcfromtimestamp
 from ansible.module_utils.common.text.converters import to_native
 from ansible.module_utils.urls import fetch_url, url_argument_spec
 
@@ -398,10 +399,10 @@ def url_get(module, url, dest, use_proxy, last_mod_time, force, timeout=10, head
     Return (tempfile, info about the request)
     """
 
-    start = utcnow()
+    start = datetime.now(timezone.utc)
     rsp, info = fetch_url(module, url, use_proxy=use_proxy, force=force, last_mod_time=last_mod_time, timeout=timeout, headers=headers, method=method,
                           unredirected_headers=unredirected_headers, decompress=decompress, ciphers=ciphers, use_netrc=use_netrc)
-    elapsed = (utcnow() - start).seconds
+    elapsed = (datetime.now(timezone.utc) - start).seconds
 
     if info['status'] == 304:
         module.exit_json(url=url, dest=dest, changed=False, msg=info.get('msg', ''), status_code=info['status'], elapsed=elapsed)
@@ -432,30 +433,23 @@ def url_get(module, url, dest, use_proxy, last_mod_time, force, timeout=10, head
         shutil.copyfileobj(rsp, f)
     except Exception as e:
         os.remove(tempname)
-        module.fail_json(msg="failed to create temporary content file: %s" % to_native(e), elapsed=elapsed, exception=traceback.format_exc())
+        module.fail_json(msg="failed to create temporary content file: %s" % to_native(e), elapsed=elapsed)
     f.close()
     rsp.close()
     return tempname, info
 
 
 def extract_filename_from_headers(headers):
-    """
-    Extracts a filename from the given dict of HTTP headers.
+    """Extracts a filename from the given dict of HTTP headers.
 
-    Looks for the content-disposition header and applies a regex.
-    Returns the filename if successful, else None."""
-    cont_disp_regex = 'attachment; ?filename="?([^"]+)'
-    res = None
-
-    if 'content-disposition' in headers:
-        cont_disp = headers['content-disposition']
-        match = re.match(cont_disp_regex, cont_disp)
-        if match:
-            res = match.group(1)
-            # Try preventing any funny business.
-            res = os.path.basename(res)
-
-    return res
+    Returns the filename if successful, else None.
+    """
+    msg = email.message.Message()
+    msg['content-disposition'] = headers.get('content-disposition', '')
+    if filename := msg.get_param('filename', header='content-disposition'):
+        # Avoid directory traversal
+        filename = os.path.basename(filename)
+    return filename
 
 
 def is_url(checksum):
@@ -466,6 +460,37 @@ def is_url(checksum):
     return urlsplit(checksum).scheme in supported_schemes
 
 
+def parse_digest_lines(filename, lines):
+    """Returns a list of tuple containing the filename and digest depending upon
+      the lines provided
+
+    Args:
+        filename (str): Name of the filename, used only when the digest is one-liner
+        lines (list): A list of lines containing filenames and checksums
+    """
+    checksum_map = []
+    BSD_DIGEST_LINE = re.compile(r'^(\w+) ?\((?P<path>.+)\) ?= (?P<digest>[\w.]+)$')
+    GNU_DIGEST_LINE = re.compile(r'^(?P<digest>[\w.]+) ([ *])(?P<path>.+)$')
+
+    if len(lines) == 1 and len(lines[0].split()) == 1:
+        # Only a single line with a single string
+        # treat it as a checksum only file
+        checksum_map.append((lines[0], filename))
+        return checksum_map
+    # The assumption here is the file is in the format of
+    # checksum filename
+    for line in lines:
+        match = BSD_DIGEST_LINE.match(line)
+        if match:
+            checksum_map.append((match.group('digest'), match.group('path')))
+        else:
+            match = GNU_DIGEST_LINE.match(line)
+            if match:
+                checksum_map.append((match.group('digest'), match.group('path').lstrip("./")))
+
+    return checksum_map
+
+
 # ==============================================================
 # main
 
@@ -533,31 +558,13 @@ def main():
         if is_url(checksum):
             checksum_url = checksum
             # download checksum file to checksum_tmpsrc
-            checksum_tmpsrc, checksum_info = url_get(module, checksum_url, dest, use_proxy, last_mod_time, force, timeout, headers, tmp_dest,
-                                                     unredirected_headers=unredirected_headers, ciphers=ciphers, use_netrc=use_netrc)
+            checksum_tmpsrc, _dummy = url_get(module, checksum_url, dest, use_proxy, last_mod_time, force, timeout, headers, tmp_dest,
+                                              unredirected_headers=unredirected_headers, ciphers=ciphers, use_netrc=use_netrc)
             with open(checksum_tmpsrc) as f:
                 lines = [line.rstrip('\n') for line in f]
             os.remove(checksum_tmpsrc)
-            checksum_map = []
             filename = url_filename(url)
-            if len(lines) == 1 and len(lines[0].split()) == 1:
-                # Only a single line with a single string
-                # treat it as a checksum only file
-                checksum_map.append((lines[0], filename))
-            else:
-                # The assumption here is the file is in the format of
-                # checksum filename
-                for line in lines:
-                    # Split by one whitespace to keep the leading type char ' ' (whitespace) for text and '*' for binary
-                    parts = line.split(" ", 1)
-                    if len(parts) == 2:
-                        # Remove the leading type char, we expect
-                        if parts[1].startswith((" ", "*",)):
-                            parts[1] = parts[1][1:]
-
-                        # Append checksum and path without potential leading './'
-                        checksum_map.append((parts[0], parts[1].lstrip("./")))
-
+            checksum_map = parse_digest_lines(filename=filename, lines=lines)
             # Look through each line in the checksum file for a hash corresponding to
             # the filename in the url, returning the first hash that is found.
             for cksum in (s for (s, f) in checksum_map if f == filename):
@@ -601,7 +608,7 @@ def main():
         # If the file already exists, prepare the last modified time for the
         # request.
         mtime = os.path.getmtime(dest)
-        last_mod_time = utcfromtimestamp(mtime)
+        last_mod_time = datetime.fromtimestamp(mtime, timezone.utc)
 
         # If the checksum does not match we have to force the download
         # because last_mod_time may be newer than on remote
@@ -609,11 +616,11 @@ def main():
             force = True
 
     # download to tmpsrc
-    start = utcnow()
+    start = datetime.now(timezone.utc)
     method = 'HEAD' if module.check_mode else 'GET'
     tmpsrc, info = url_get(module, url, dest, use_proxy, last_mod_time, force, timeout, headers, tmp_dest, method,
                            unredirected_headers=unredirected_headers, decompress=decompress, ciphers=ciphers, use_netrc=use_netrc)
-    result['elapsed'] = (utcnow() - start).seconds
+    result['elapsed'] = (datetime.now(timezone.utc) - start).seconds
     result['src'] = tmpsrc
 
     # Now the request has completed, we can finally generate the final
@@ -683,8 +690,7 @@ def main():
         except Exception as e:
             if os.path.exists(tmpsrc):
                 os.remove(tmpsrc)
-            module.fail_json(msg="failed to copy %s to %s: %s" % (tmpsrc, dest, to_native(e)),
-                             exception=traceback.format_exc(), **result)
+            module.fail_json(msg="failed to copy %s to %s: %s" % (tmpsrc, dest, to_native(e)), **result)
         result['changed'] = True
     else:
         result['changed'] = False

ansible/modules/getent.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: getent
 short_description: A wrapper to the unix getent utility
@@ -58,9 +58,9 @@ notes:
    - Not all databases support enumeration, check system documentation for details.
 author:
 - Brian Coca (@bcoca)
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Get root user info
   ansible.builtin.getent:
     database: passwd
@@ -97,9 +97,9 @@ EXAMPLES = '''
 - ansible.builtin.debug:
     var: ansible_facts.getent_shadow
 
-'''
+"""
 
-RETURN = '''
+RETURN = """
 ansible_facts:
   description: Facts to add to ansible_facts.
   returned: always
@@ -112,9 +112,7 @@ ansible_facts:
         - Starting at 2.11 it now returns multiple duplicate entries, previously it only returned the last one
       returned: always
       type: list
-'''
-
-import traceback
+"""
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.common.text.converters import to_native
@@ -156,7 +154,7 @@ def main():
     try:
         rc, out, err = module.run_command(cmd)
     except Exception as e:
-        module.fail_json(msg=to_native(e), exception=traceback.format_exc())
+        module.fail_json(msg=to_native(e))
 
     msg = "Unexpected failure!"
     dbtree = 'getent_%s' % database

ansible/modules/git.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: git
 author:
@@ -21,6 +21,10 @@ options:
     repo:
         description:
             - git, SSH, or HTTP(S) protocol address of the git repository.
+            - Avoid embedding usernames and passwords within Git repository URLs.
+              This practice is insecure and can lead to unauthorized access to your repositories.
+              For secure authentication, configure SSH keys (recommended) or use a credential helper.
+              See Git documentation on SSH keys/credential helpers for instructions.
         type: str
         required: true
         aliases: [ name ]
@@ -236,9 +240,9 @@ notes:
       one solution is to use the option accept_hostkey. Another solution is to
       add the remote host public key in C(/etc/ssh/ssh_known_hosts) before calling
       the git module, with the following command: C(ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts)."
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Git checkout
   ansible.builtin.git:
     repo: 'https://github.com/ansible/ansible.git'
@@ -295,9 +299,9 @@ EXAMPLES = '''
   environment:
     GIT_TERMINAL_PROMPT: 0 # reports "terminal prompts disabled" on missing password
     # or GIT_ASKPASS: /bin/true # for git before version 2.3.0, reports "Authentication failed" on missing password
-'''
+"""
 
-RETURN = '''
+RETURN = """
 after:
     description: Last commit revision of the repository retrieved during the update.
     returned: success
@@ -328,7 +332,7 @@ git_dir_before:
     returned: success
     type: str
     sample: /path/to/old/git/dir
-'''
+"""
 
 import filecmp
 import os
@@ -366,16 +370,15 @@ def relocate_repo(module, result, repo_dir, old_repo_dir, worktree_dir):
 
 
 def head_splitter(headfile, remote, module=None, fail_on_error=False):
-    '''Extract the head reference'''
+    """Extract the head reference"""
     # https://github.com/ansible/ansible-modules-core/pull/907
 
     res = None
     if os.path.exists(headfile):
         rawdata = None
         try:
-            f = open(headfile, 'r')
-            rawdata = f.readline()
-            f.close()
+            with open(headfile, 'r') as f:
+                rawdata = f.readline()
         except Exception:
             if fail_on_error and module:
                 module.fail_json(msg="Unable to read %s" % headfile)
@@ -429,11 +432,11 @@ def get_submodule_update_params(module, git_path, cwd):
 
 
 def write_ssh_wrapper(module):
-    '''
+    """
         This writes an shell wrapper for ssh options to be used with git
         this is only relevant for older versions of gitthat cannot
         handle the options themselves. Returns path to the script
-    '''
+    """
     try:
         # make sure we have full permission to the module_dir, which
         # may not be the case if we're sudo'ing to a non-root user
@@ -466,10 +469,10 @@ def write_ssh_wrapper(module):
 
 
 def set_git_ssh_env(key_file, ssh_opts, git_version, module):
-    '''
+    """
         use environment variables to configure git's ssh execution,
         which varies by version but this function should handle all.
-    '''
+    """
 
     # initialise to existing ssh opts and/or append user provided
     if ssh_opts is None:
@@ -519,7 +522,7 @@ def set_git_ssh_env(key_file, ssh_opts, git_version, module):
 
 
 def get_version(module, git_path, dest, ref="HEAD"):
-    ''' samples the version of the git repo '''
+    """ samples the version of the git repo """
 
     cmd = "%s rev-parse %s" % (git_path, ref)
     rc, stdout, stderr = module.run_command(cmd, cwd=dest)
@@ -571,7 +574,7 @@ def get_submodule_versions(git_path, module, dest, version='HEAD'):
 
 def clone(git_path, module, repo, dest, remote, depth, version, bare,
           reference, refspec, git_version_used, verify_commit, separate_git_dir, result, gpg_allowlist, single_branch):
-    ''' makes a new git repo if it does not already exist '''
+    """ makes a new git repo if it does not already exist """
     dest_dirname = os.path.dirname(dest)
     try:
         os.makedirs(dest_dirname)
@@ -653,17 +656,17 @@ def has_local_mods(module, git_path, dest, bare):
 
 
 def reset(git_path, module, dest):
-    '''
+    """
     Resets the index and working tree to HEAD.
     Discards any changes to tracked files in working
     tree since that commit.
-    '''
+    """
     cmd = "%s reset --hard HEAD" % (git_path,)
     return module.run_command(cmd, check_rc=True, cwd=dest)
 
 
 def get_diff(module, git_path, dest, repo, remote, depth, bare, before, after):
-    ''' Return the difference between 2 versions '''
+    """ Return the difference between 2 versions """
     if before is None:
         return {'prepared': '>> Newly checked out %s' % after}
     elif before != after:
@@ -817,13 +820,13 @@ def get_repo_path(dest, bare):
 
 
 def get_head_branch(git_path, module, dest, remote, bare=False):
-    '''
+    """
     Determine what branch HEAD is associated with.  This is partly
     taken from lib/ansible/utils/__init__.py.  It finds the correct
     path to .git/HEAD and reads from that file the branch that HEAD is
     associated with.  In the case of a detached HEAD, this will look
     up the branch in .git/refs/remotes/<remote>/HEAD.
-    '''
+    """
     try:
         repo_path = get_repo_path(dest, bare)
     except (IOError, ValueError) as err:
@@ -845,7 +848,7 @@ def get_head_branch(git_path, module, dest, remote, bare=False):
 
 
 def get_remote_url(git_path, module, dest, remote):
-    '''Return URL of remote source for repo.'''
+    """Return URL of remote source for repo."""
     command = [git_path, 'ls-remote', '--get-url', remote]
     (rc, out, err) = module.run_command(command, cwd=dest)
     if rc != 0:
@@ -856,7 +859,7 @@ def get_remote_url(git_path, module, dest, remote):
 
 
 def set_remote_url(git_path, module, repo, dest, remote):
-    ''' updates repo from remote sources '''
+    """ updates repo from remote sources """
     # Return if remote URL isn't changing.
     remote_url = get_remote_url(git_path, module, dest, remote)
     if remote_url == repo or unfrackgitpath(remote_url) == unfrackgitpath(repo):
@@ -874,7 +877,7 @@ def set_remote_url(git_path, module, repo, dest, remote):
 
 
 def fetch(git_path, module, repo, dest, version, remote, depth, bare, refspec, git_version_used, force=False):
-    ''' updates repo from remote sources '''
+    """ updates repo from remote sources """
     set_remote_url(git_path, module, repo, dest, remote)
     commands = []
 
@@ -981,7 +984,7 @@ def submodules_fetch(git_path, module, remote, track_submodules, dest):
 
 
 def submodule_update(git_path, module, dest, track_submodules, force=False):
-    ''' init and update any submodules '''
+    """ init and update any submodules """
 
     # get the valid submodule params
     params = get_submodule_update_params(module, git_path, dest)

ansible/modules/group.py

@@ -6,7 +6,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: group
 version_added: "0.0.2"
@@ -91,9 +91,9 @@ seealso:
 - module: ansible.windows.win_group
 author:
 - Stephen Fromm (@sfromm)
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Ensure group "somegroup" exists
   ansible.builtin.group:
     name: somegroup
@@ -104,9 +104,9 @@ EXAMPLES = '''
     name: docker
     state: present
     gid: 1750
-'''
+"""
 
-RETURN = r'''
+RETURN = r"""
 gid:
   description: Group ID of the group.
   returned: When O(state) is C(present)
@@ -127,7 +127,7 @@ system:
   returned: When O(state) is C(present)
   type: bool
   sample: False
-'''
+"""
 
 import grp
 import os

ansible/modules/group_by.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = r'''
+DOCUMENTATION = r"""
 ---
 module: group_by
 short_description: Create Ansible groups based on facts
@@ -65,9 +65,9 @@ seealso:
 - module: ansible.builtin.add_host
 author:
 - Jeroen Hoekx (@jhoekx)
-'''
+"""
 
-EXAMPLES = r'''
+EXAMPLES = r"""
 - name: Create groups based on the machine architecture
   ansible.builtin.group_by:
     key: machine_{{ ansible_machine }}
@@ -85,4 +85,4 @@ EXAMPLES = r'''
 - name: Add all active hosts to a static group
   ansible.builtin.group_by:
     key: done
-'''
+"""

ansible/modules/hostname.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 
-DOCUMENTATION = '''
+DOCUMENTATION = """
 ---
 module: hostname
 author:
@@ -52,9 +52,9 @@ attributes:
         support: full
     platform:
         platforms: posix
-'''
+"""
 
-EXAMPLES = '''
+EXAMPLES = """
 - name: Set a hostname
   ansible.builtin.hostname:
     name: web01
@@ -63,14 +63,12 @@ EXAMPLES = '''
   ansible.builtin.hostname:
     name: web01
     use: systemd
-'''
+"""
 
 import os
 import platform
 import socket
-import traceback
-
-import ansible.module_utils.compat.typing as t
+import typing as t
 
 from ansible.module_utils.basic import (
     AnsibleModule,
@@ -209,17 +207,14 @@ class FileStrategy(BaseStrategy):
             return get_file_content(self.FILE, default='', strip=True)
         except Exception as e:
             self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+                msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
             with open(self.FILE, 'w+') as f:
                 f.write("%s\n" % name)
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class SLESStrategy(FileStrategy):
@@ -249,8 +244,7 @@ class RedHatStrategy(BaseStrategy):
             )
         except Exception as e:
             self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+                msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
@@ -269,9 +263,7 @@ class RedHatStrategy(BaseStrategy):
             with open(self.NETWORK_FILE, 'w+') as f:
                 f.writelines(lines)
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class AlpineStrategy(FileStrategy):
@@ -361,9 +353,7 @@ class OpenRCStrategy(BaseStrategy):
                 if line.startswith('hostname='):
                     return line[10:].strip('"')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
@@ -377,9 +367,7 @@ class OpenRCStrategy(BaseStrategy):
             with open(self.FILE, 'w') as f:
                 f.write('\n'.join(lines) + '\n')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class OpenBSDStrategy(FileStrategy):
@@ -481,9 +469,7 @@ class FreeBSDStrategy(BaseStrategy):
                 if line.startswith('hostname='):
                     return line[10:].strip('"')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to read hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to read hostname: %s" % to_native(e))
 
     def set_permanent_hostname(self, name):
         try:
@@ -500,9 +486,7 @@ class FreeBSDStrategy(BaseStrategy):
             with open(self.FILE, 'w') as f:
                 f.write('\n'.join(lines) + '\n')
         except Exception as e:
-            self.module.fail_json(
-                msg="failed to update hostname: %s" % to_native(e),
-                exception=traceback.format_exc())
+            self.module.fail_json(msg="failed to update hostname: %s" % to_native(e))
 
 
 class DarwinStrategy(BaseStrategy):