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

ansible/modules/systemd.py

@@ -34,7 +34,7 @@ options:
         choices: [ reloaded, restarted, started, stopped ]
     enabled:
         description:
-            - Whether the unit should start on boot. B(At least one of state and enabled are required.)
+            - Whether the unit should start on boot. At least one of O(state) and O(enabled) are required.
             - If set, requires O(name).
         type: bool
     force:
@@ -49,8 +49,8 @@ options:
         type: bool
     daemon_reload:
         description:
-            - Run daemon-reload before doing any other operations, to make sure systemd has read any changes.
-            - When set to V(true), runs daemon-reload even if the module does not start or stop anything.
+            - Run C(daemon-reload) before doing any other operations, to make sure systemd has read any changes.
+            - When set to V(true), runs C(daemon-reload) even if the module does not start or stop anything.
         type: bool
         default: no
         aliases: [ daemon-reload ]
@@ -63,9 +63,9 @@ options:
         version_added: "2.8"
     scope:
         description:
-            - Run systemctl within a given service manager scope, either as the default system scope V(system),
+            - Run C(systemctl) within a given service manager scope, either as the default system scope V(system),
               the current user's scope V(user), or the scope of all users V(global).
-            - "For systemd to work with 'user', the executing user must have its own instance of dbus started and accessible (systemd requirement)."
+            - "For systemd to work with V(user), the executing user must have its own instance of dbus started and accessible (systemd requirement)."
             - "The user dbus process is normally started during normal login, but not during the run of Ansible tasks.
               Otherwise you will probably get a 'Failed to connect to bus: no such file or directory' error."
             - The user must have access, normally given via setting the C(XDG_RUNTIME_DIR) variable, see the example below.
@@ -95,7 +95,7 @@ notes:
     - Globs are not supported in name, in other words, C(postgres*.service).
     - The service names might vary by specific OS/distribution.
     - The order of execution when having multiple properties is to first enable/disable, then mask/unmask and then deal with the service state.
-      It has been reported that systemctl can behave differently depending on the order of operations if you do the same manually.
+      It has been reported that C(systemctl) can behave differently depending on the order of operations if you do the same manually.
 requirements:
     - A system managed by systemd.
 '''
@@ -495,6 +495,8 @@ def main():
                     if rc != 0:
                         # some versions of system CAN mask/unmask non existing services, we only fail on missing if they don't
                         fail_if_missing(module, found, unit, msg='host')
+                        # here if service was not missing, but failed for other reasons
+                        module.fail_json(msg=f"Failed to {action} the service ({unit}): {err.strip()}")
 
         # Enable/disable service startup at boot if requested
         if module.params['enabled'] is not None:
@@ -512,11 +514,15 @@ def main():
 
             # check systemctl result or if it is a init script
             if rc == 0:
-                enabled = True
-                # Check if the service is indirect or alias and if out contains exactly 1 line of string 'indirect'/ 'alias' it's disabled
-                if out.splitlines() == ["indirect"] or out.splitlines() == ["alias"]:
+                # https://www.freedesktop.org/software/systemd/man/systemctl.html#is-enabled%20UNIT%E2%80%A6
+                if out.rstrip() in (
+                        "enabled-runtime",  # transiently enabled but we're trying to set a permanent enabled
+                        "indirect",  # We've been asked to enable this unit so do so despite possible reasons
+                                     # that systemctl may have for thinking it's enabled already.
+                        "alias"):  # Let systemd handle the alias as we can't be sure what's needed.
                     enabled = False
-
+                else:
+                    enabled = True
             elif rc == 1:
                 # if not a user or global user service and both init script and unit file exist stdout should have enabled/disabled, otherwise use rc entries
                 if module.params['scope'] == 'system' and \

ansible/modules/systemd_service.py

@@ -34,7 +34,7 @@ options:
         choices: [ reloaded, restarted, started, stopped ]
     enabled:
         description:
-            - Whether the unit should start on boot. B(At least one of state and enabled are required.)
+            - Whether the unit should start on boot. At least one of O(state) and O(enabled) are required.
             - If set, requires O(name).
         type: bool
     force:
@@ -49,8 +49,8 @@ options:
         type: bool
     daemon_reload:
         description:
-            - Run daemon-reload before doing any other operations, to make sure systemd has read any changes.
-            - When set to V(true), runs daemon-reload even if the module does not start or stop anything.
+            - Run C(daemon-reload) before doing any other operations, to make sure systemd has read any changes.
+            - When set to V(true), runs C(daemon-reload) even if the module does not start or stop anything.
         type: bool
         default: no
         aliases: [ daemon-reload ]
@@ -63,9 +63,9 @@ options:
         version_added: "2.8"
     scope:
         description:
-            - Run systemctl within a given service manager scope, either as the default system scope V(system),
+            - Run C(systemctl) within a given service manager scope, either as the default system scope V(system),
               the current user's scope V(user), or the scope of all users V(global).
-            - "For systemd to work with 'user', the executing user must have its own instance of dbus started and accessible (systemd requirement)."
+            - "For systemd to work with V(user), the executing user must have its own instance of dbus started and accessible (systemd requirement)."
             - "The user dbus process is normally started during normal login, but not during the run of Ansible tasks.
               Otherwise you will probably get a 'Failed to connect to bus: no such file or directory' error."
             - The user must have access, normally given via setting the C(XDG_RUNTIME_DIR) variable, see the example below.
@@ -95,7 +95,7 @@ notes:
     - Globs are not supported in name, in other words, C(postgres*.service).
     - The service names might vary by specific OS/distribution.
     - The order of execution when having multiple properties is to first enable/disable, then mask/unmask and then deal with the service state.
-      It has been reported that systemctl can behave differently depending on the order of operations if you do the same manually.
+      It has been reported that C(systemctl) can behave differently depending on the order of operations if you do the same manually.
 requirements:
     - A system managed by systemd.
 '''
@@ -495,6 +495,8 @@ def main():
                     if rc != 0:
                         # some versions of system CAN mask/unmask non existing services, we only fail on missing if they don't
                         fail_if_missing(module, found, unit, msg='host')
+                        # here if service was not missing, but failed for other reasons
+                        module.fail_json(msg=f"Failed to {action} the service ({unit}): {err.strip()}")
 
         # Enable/disable service startup at boot if requested
         if module.params['enabled'] is not None:
@@ -512,11 +514,15 @@ def main():
 
             # check systemctl result or if it is a init script
             if rc == 0:
-                enabled = True
-                # Check if the service is indirect or alias and if out contains exactly 1 line of string 'indirect'/ 'alias' it's disabled
-                if out.splitlines() == ["indirect"] or out.splitlines() == ["alias"]:
+                # https://www.freedesktop.org/software/systemd/man/systemctl.html#is-enabled%20UNIT%E2%80%A6
+                if out.rstrip() in (
+                        "enabled-runtime",  # transiently enabled but we're trying to set a permanent enabled
+                        "indirect",  # We've been asked to enable this unit so do so despite possible reasons
+                                     # that systemctl may have for thinking it's enabled already.
+                        "alias"):  # Let systemd handle the alias as we can't be sure what's needed.
                     enabled = False
-
+                else:
+                    enabled = True
             elif rc == 1:
                 # if not a user or global user service and both init script and unit file exist stdout should have enabled/disabled, otherwise use rc entries
                 if module.params['scope'] == 'system' and \

ansible/modules/sysvinit.py

@@ -31,7 +31,7 @@ options:
     enabled:
         type: bool
         description:
-            - Whether the service should start on boot. B(At least one of state and enabled are required.)
+            - Whether the service should start on boot. At least one of O(state) and O(enabled) are required.
     sleep:
         default: 1
         description:
@@ -42,7 +42,7 @@ options:
         description:
             - A substring to look for as would be found in the output of the I(ps) command as a stand-in for a status result.
             - If the string is found, the service will be assumed to be running.
-            - "This option is mainly for use with init scripts that don't support the 'status' option."
+            - "This option is mainly for use with init scripts that don't support the C(status) option."
         type: str
     runlevels:
         description:
@@ -74,7 +74,7 @@ attributes:
         platforms: posix
 notes:
     - One option other than name is required.
-    - The service names might vary by specific OS/distribution
+    - The service names might vary by specific OS/distribution.
 requirements:
     - That the service managed has a corresponding init script.
 '''
@@ -203,7 +203,7 @@ def main():
         worked = is_started = get_ps(module, pattern)
     else:
         if location.get('service'):
-            # standard tool that has been 'destandarized' by reimplementation in other OS/distros
+            # standard tool that has been 'destandardized' by reimplementation in other OS/distros
             cmd = '%s %s status' % (location['service'], name)
         elif script:
             # maybe script implements status (not LSB)

ansible/modules/unarchive.py

@@ -241,7 +241,6 @@ uid:
 
 import binascii
 import codecs
-import datetime
 import fnmatch
 import grp
 import os
@@ -260,15 +259,8 @@ from ansible.module_utils.common.process import get_bin_path
 from ansible.module_utils.common.locale import get_best_parsable_locale
 from ansible.module_utils.urls import fetch_file
 
-try:  # python 3.3+
-    from shlex import quote  # type: ignore[attr-defined]
-except ImportError:  # older python
-    from pipes import quote
-
-try:  # python 3.2+
-    from zipfile import BadZipFile  # type: ignore[attr-defined]
-except ImportError:  # older python
-    from zipfile import BadZipfile as BadZipFile
+from shlex import quote
+from zipfile import BadZipFile
 
 # String from tar that shows the tar contents are different from the
 # filesystem
@@ -283,6 +275,8 @@ ZIP_FILE_MODE_RE = re.compile(r'([r-][w-][SsTtx-]){3}')
 INVALID_OWNER_RE = re.compile(r': Invalid owner')
 INVALID_GROUP_RE = re.compile(r': Invalid group')
 SYMLINK_DIFF_RE = re.compile(r': Symlink differs$')
+CONTENT_DIFF_RE = re.compile(r': Contents differ$')
+SIZE_DIFF_RE = re.compile(r': Size differs$')
 
 
 def crc32(path, buffer_size):
@@ -411,6 +405,27 @@ class ZipArchive(object):
             archive.close()
         return self._files_in_archive
 
+    def _valid_time_stamp(self, timestamp_str):
+        """ Return a valid time object from the given time string """
+        DT_RE = re.compile(r'^(\d{4})(\d{2})(\d{2})\.(\d{2})(\d{2})(\d{2})$')
+        match = DT_RE.match(timestamp_str)
+        epoch_date_time = (1980, 1, 1, 0, 0, 0, 0, 0, 0)
+        if match:
+            try:
+                if int(match.groups()[0]) < 1980:
+                    date_time = epoch_date_time
+                elif int(match.groups()[0]) > 2107:
+                    date_time = (2107, 12, 31, 23, 59, 59, 0, 0, 0)
+                else:
+                    date_time = (int(m) for m in match.groups() + (0, 0, 0))
+            except ValueError:
+                date_time = epoch_date_time
+        else:
+            # Assume epoch date
+            date_time = epoch_date_time
+
+        return time.mktime(time.struct_time(date_time))
+
     def is_unarchived(self):
         # BSD unzip doesn't support zipinfo listings with timestamp.
         if self.zipinfoflag:
@@ -609,8 +624,7 @@ class ZipArchive(object):
             # Note: this timestamp calculation has a rounding error
             # somewhere... unzip and this timestamp can be one second off
             # When that happens, we report a change and re-unzip the file
-            dt_object = datetime.datetime(*(time.strptime(pcs[6], '%Y%m%d.%H%M%S')[0:6]))
-            timestamp = time.mktime(dt_object.timetuple())
+            timestamp = self._valid_time_stamp(pcs[6])
 
             # Compare file timestamps
             if stat.S_ISREG(st.st_mode):
@@ -879,16 +893,15 @@ class TgzArchive(object):
                 out += line + '\n'
             if not self.file_args['mode'] and MODE_DIFF_RE.search(line):
                 out += line + '\n'
-            if MOD_TIME_DIFF_RE.search(line):
-                out += line + '\n'
-            if MISSING_FILE_RE.search(line):
-                out += line + '\n'
-            if INVALID_OWNER_RE.search(line):
-                out += line + '\n'
-            if INVALID_GROUP_RE.search(line):
-                out += line + '\n'
-            if SYMLINK_DIFF_RE.search(line):
-                out += line + '\n'
+            differ_regexes = [
+                MOD_TIME_DIFF_RE, MISSING_FILE_RE, INVALID_OWNER_RE,
+                INVALID_GROUP_RE, SYMLINK_DIFF_RE, CONTENT_DIFF_RE,
+                SIZE_DIFF_RE
+            ]
+            for regex in differ_regexes:
+                if regex.search(line):
+                    out += line + '\n'
+
         if out:
             unarchived = False
         return dict(unarchived=unarchived, rc=rc, out=out, err=err, cmd=cmd)

ansible/modules/uri.py

@@ -22,19 +22,19 @@ options:
       - 'When a list is provided, all ciphers are joined in order with V(:)'
       - See the L(OpenSSL Cipher List Format,https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT)
         for more details.
-      - The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions
+      - The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
     type: list
     elements: str
     version_added: '2.14'
   decompress:
     description:
-      - Whether to attempt to decompress gzip content-encoded responses
+      - Whether to attempt to decompress gzip content-encoded responses.
     type: bool
     default: true
     version_added: '2.14'
   url:
     description:
-      - HTTP or HTTPS URL in the form (http|https)://host.domain[:port]/path
+      - HTTP or HTTPS URL in the form (http|https)://host.domain[:port]/path.
     type: str
     required: true
   dest:
@@ -58,17 +58,17 @@ options:
         to V(json) it will take an already formatted JSON string or convert a data structure
         into JSON.
       - If O(body_format) is set to V(form-urlencoded) it will convert a dictionary
-        or list of tuples into an 'application/x-www-form-urlencoded' string. (Added in v2.7)
+        or list of tuples into an C(application/x-www-form-urlencoded) string. (Added in v2.7)
       - If O(body_format) is set to V(form-multipart) it will convert a dictionary
-        into 'multipart/form-multipart' body. (Added in v2.10)
+        into C(multipart/form-multipart) body. (Added in v2.10)
     type: raw
   body_format:
     description:
       - The serialization format of the body. When set to V(json), V(form-multipart), or V(form-urlencoded), encodes
-        the body argument, if needed, and automatically sets the Content-Type header accordingly.
+        the body argument, if needed, and automatically sets the C(Content-Type) header accordingly.
       - As of v2.3 it is possible to override the C(Content-Type) header, when
         set to V(json) or V(form-urlencoded) via the O(headers) option.
-      - The 'Content-Type' header cannot be overridden when using V(form-multipart)
+      - The C(Content-Type) header cannot be overridden when using V(form-multipart).
       - V(form-urlencoded) was added in v2.7.
       - V(form-multipart) was added in v2.10.
     type: str
@@ -86,7 +86,7 @@ options:
     description:
       - Whether or not to return the body of the response as a "content" key in
         the dictionary result no matter it succeeded or failed.
-      - Independently of this option, if the reported Content-type is "application/json", then the JSON is
+      - Independently of this option, if the reported C(Content-Type) is C(application/json), then the JSON is
         always loaded into a key called RV(ignore:json) in the dictionary results.
     type: bool
     default: no
@@ -108,15 +108,15 @@ options:
   follow_redirects:
     description:
       - Whether or not the URI module should follow redirects.
+    type: str
+    default: safe
     choices:
       all: Will follow all redirects.
       none: Will not follow any redirects.
       safe: Only redirects doing GET or HEAD requests will be followed.
       urllib2: Defer to urllib2 behavior (As of writing this follows HTTP redirects).
-      'no': (DEPRECATED, will be removed in the future version) alias of V(none).
-      'yes': (DEPRECATED, will be removed in the future version) alias of V(all).
-    type: str
-    default: safe
+      'no': (DEPRECATED, removed in 2.22) alias of V(none).
+      'yes': (DEPRECATED, removed in 2.22) alias of V(all).
   creates:
     description:
       - A filename, when it already exists, this step will not be run.
@@ -155,7 +155,7 @@ options:
   client_cert:
     description:
       - PEM formatted certificate chain file to be used for SSL client authentication.
-      - This file can also include the key as well, and if the key is included, O(client_key) is not required
+      - This file can also include the key as well, and if the key is included, O(client_key) is not required.
     type: path
     version_added: '2.4'
   client_key:
@@ -166,7 +166,7 @@ options:
     version_added: '2.4'
   ca_path:
     description:
-      - PEM formatted file that contains a CA certificate to be used for validation
+      - PEM formatted file that contains a CA certificate to be used for validation.
     type: path
     version_added: '2.11'
   src:
@@ -195,7 +195,7 @@ options:
     default: true
   unix_socket:
     description:
-    - Path to Unix domain socket to use for connection
+    - Path to Unix domain socket to use for connection.
     type: path
     version_added: '2.8'
   http_agent:
@@ -225,9 +225,9 @@ options:
     version_added: '2.11'
   use_netrc:
     description:
-      - Determining whether to use credentials from ``~/.netrc`` file
-      - By default .netrc is used with Basic authentication headers
-      - When set to False, .netrc credentials are ignored
+      - Determining whether to use credentials from C(~/.netrc) file.
+      - By default C(.netrc) is used with Basic authentication headers.
+      - When V(false), C(.netrc) credentials are ignored.
     type: bool
     default: true
     version_added: '2.14'
@@ -581,6 +581,12 @@ def uri(module, url, dest, body, body_format, method, headers, socket_timeout, c
         # if destination file already exist, only download if file newer
         kwargs['last_mod_time'] = utcfromtimestamp(os.path.getmtime(dest))
 
+    if module.params.get('follow_redirects') in ('no', 'yes'):
+        module.deprecate(
+            "Using 'yes' or 'no' for 'follow_redirects' parameter is deprecated.",
+            version='2.22'
+        )
+
     resp, info = fetch_url(module, url, data=data, headers=headers,
                            method=method, timeout=socket_timeout, unix_socket=module.params['unix_socket'],
                            ca_path=ca_path, unredirected_headers=unredirected_headers,