ansible-core 2.19.0b5__py3-none-any.whl → 2.19.0b7__py3-none-any.whl

ansible/modules/replace.py

@@ -256,8 +256,8 @@ def main():
         try:
             with open(path, 'rb') as f:
                 contents = to_text(f.read(), errors='surrogate_or_strict', encoding=encoding)
-        except (OSError, IOError) as e:
-            module.fail_json(msg='Unable to read the contents of %s: %s' % (path, to_text(e)))
+        except OSError as ex:
+            raise Exception(f"Unable to read the contents of {path!r}.") from ex
 
     pattern = u''
     if params['after'] and params['before']:

ansible/modules/slurp.py

@@ -85,7 +85,6 @@ import base64
 import errno
 
 from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.common.text.converters import to_native
 
 
 def main():
@@ -99,20 +98,18 @@ def main():
 
     try:
         with open(source, 'rb') as source_fh:
-            source_content = source_fh.read()
-    except (IOError, OSError) as e:
-        if e.errno == errno.ENOENT:
-            msg = "file not found: %s" % source
-        elif e.errno == errno.EACCES:
-            msg = "file is not readable: %s" % source
-        elif e.errno == errno.EISDIR:
-            msg = "source is a directory and must be a file: %s" % source
+            data = base64.b64encode(source_fh.read())
+    except OSError as ex:
+        if ex.errno == errno.ENOENT:
+            msg = f"File not found: {source}"
+        elif ex.errno == errno.EACCES:
+            msg = f"File is not readable: {source}"
+        elif ex.errno == errno.EISDIR:
+            msg = f"Source is a directory and must be a file: {source}"
         else:
-            msg = "unable to slurp file: %s" % to_native(e, errors='surrogate_then_replace')
+            msg = "Unable to slurp file: {source}"
 
-        module.fail_json(msg)
-
-    data = base64.b64encode(source_content)
+        module.fail_json(msg, exception=ex)
 
     module.exit_json(content=data, source=source, encoding='base64')
 

ansible/modules/stat.py

@@ -354,7 +354,6 @@ stat:
             version_added: 2.3
 """
 
-import errno
 import grp
 import os
 import pwd
@@ -409,7 +408,7 @@ def format_output(module, path, st):
             ('st_blksize', 'block_size'),
             ('st_rdev', 'device_type'),
             ('st_flags', 'flags'),
-            # Some Berkley based
+            # Some Berkeley based
             ('st_gen', 'generation'),
             ('st_birthtime', 'birthtime'),
             # RISCOS
@@ -456,12 +455,11 @@ def main():
             st = os.stat(b_path)
         else:
             st = os.lstat(b_path)
-    except OSError as e:
-        if e.errno == errno.ENOENT:
-            output = {'exists': False}
-            module.exit_json(changed=False, stat=output)
-
-        module.fail_json(msg=e.strerror)
+    except FileNotFoundError:
+        output = {'exists': False}
+        module.exit_json(changed=False, stat=output)
+    except OSError as ex:
+        module.fail_json(msg=ex.strerror, exception=ex)
 
     # process base results
     output = format_output(module, path, st)

ansible/modules/unarchive.py

@@ -1132,8 +1132,8 @@ def main():
             res_args['extract_results'] = handler.unarchive()
             if res_args['extract_results']['rc'] != 0:
                 module.fail_json(msg="failed to unpack %s to %s" % (src, dest), **res_args)
-        except IOError:
-            module.fail_json(msg="failed to unpack %s to %s" % (src, dest), **res_args)
+        except OSError as ex:
+            module.fail_json(f"Failed to unpack {src!r} to {dest!r}.", exception=ex, **res_args)
         else:
             res_args['changed'] = True
 
@@ -1150,8 +1150,8 @@ def main():
 
             try:
                 res_args['changed'] = module.set_fs_attributes_if_different(file_args, res_args['changed'], expand=False)
-            except (IOError, OSError) as e:
-                module.fail_json(msg="Unexpected error when accessing exploded file: %s" % to_native(e), **res_args)
+            except OSError as ex:
+                module.fail_json("Unexpected error when accessing exploded file.", exception=ex, **res_args)
 
             if '/' in filename:
                 top_folder_path = filename.split('/')[0]
@@ -1165,8 +1165,8 @@ def main():
                 file_args['path'] = "%s/%s" % (dest, f)
                 try:
                     res_args['changed'] = module.set_fs_attributes_if_different(file_args, res_args['changed'], expand=False)
-                except (IOError, OSError) as e:
-                    module.fail_json(msg="Unexpected error when accessing exploded file: %s" % to_native(e), **res_args)
+                except OSError as ex:
+                    module.fail_json("Unexpected error when accessing exploded file.", exception=ex, **res_args)
 
     if module.params['list_files']:
         res_args['files'] = handler.files_in_archive

ansible/modules/user.py

@@ -1341,7 +1341,7 @@ class User(object):
         try:
             with open(ssh_public_key_file, 'r') as f:
                 ssh_public_key = f.read().strip()
-        except IOError:
+        except OSError:
             return None
         return ssh_public_key
 

ansible/modules/wait_for.py

@@ -76,6 +76,8 @@ options:
     description:
       - Can be used to match a string in either a file or a socket connection.
       - Defaults to a multiline regex.
+      - When inspecting a system log file and a static string, remember that Ansible by default logs its own actions there;
+        see the notes and examples for information.
     type: str
     version_added: "1.4"
   exclude_hosts:
@@ -105,13 +107,13 @@ attributes:
     platform:
         platforms: posix
 notes:
-  - The ability to use search_regex with a port connection was added in Ansible 1.7.
-  - Prior to Ansible 2.4, testing for the absence of a directory or UNIX socket did not work correctly.
-  - Prior to Ansible 2.4, testing for the presence of a file did not work correctly if the remote user did not have read access to that file.
   - Under some circumstances when using mandatory access control, a path may always be treated as being absent even if it exists, but
     can't be modified or created by the remote user either.
   - When waiting for a path, symbolic links will be followed.  Many other modules that manipulate files do not follow symbolic links,
     so operations on the path using other modules may not work exactly as expected.
+  - When searching a static string within a system log file, it is important to account for potential self-matching against log entries
+    generated by the Ansible modules.  To prevent this, add a regular expression construct into the search string. For example, to match
+    a literal string 'this thing', one could use a regular expression like 'this t[h]ing'.
 seealso:
 - module: ansible.builtin.wait_for_connection
 - module: ansible.windows.win_wait_for
@@ -156,6 +158,11 @@ EXAMPLES = r"""
     path: /tmp/foo
     search_regex: completed
 
+- name: Wait until the string "tomcat up" is in syslog, use regex character set to avoid self match
+  ansible.builtin.wait_for:
+    path: /var/log/syslog
+    search_regex: 'tomcat [u]p'
+
 - name: Wait until regex pattern matches in the file /tmp/foo and print the matched group
   ansible.builtin.wait_for:
     path: /tmp/foo
@@ -380,31 +387,29 @@ class LinuxTCPConnectionInfo(TCPConnectionInfo):
             if not os.path.isfile(self.source_file[family]):
                 continue
             try:
-                f = open(self.source_file[family])
-                for tcp_connection in f.readlines():
-                    tcp_connection = tcp_connection.strip().split()
-                    if tcp_connection[self.local_address_field] == 'local_address':
-                        continue
-                    if (tcp_connection[self.connection_state_field] not in
-                            [get_connection_state_id(_connection_state) for _connection_state in self.module.params['active_connection_states']]):
-                        continue
-                    (local_ip, local_port) = tcp_connection[self.local_address_field].split(':')
-                    if self.port != local_port:
-                        continue
-                    (remote_ip, remote_port) = tcp_connection[self.remote_address_field].split(':')
-                    if (family, remote_ip) in self.exclude_ips:
-                        continue
-                    if any((
-                        (family, local_ip) in self.ips,
-                        (family, self.match_all_ips[family]) in self.ips,
-                        local_ip.startswith(self.ipv4_mapped_ipv6_address['prefix']) and
-                            (family, self.ipv4_mapped_ipv6_address['match_all']) in self.ips,
-                    )):
-                        active_connections += 1
-            except IOError as e:
+                with open(self.source_file[family]) as f:
+                    for tcp_connection in f.readlines():
+                        tcp_connection = tcp_connection.strip().split()
+                        if tcp_connection[self.local_address_field] == 'local_address':
+                            continue
+                        if (tcp_connection[self.connection_state_field] not in
+                                [get_connection_state_id(_connection_state) for _connection_state in self.module.params['active_connection_states']]):
+                            continue
+                        (local_ip, local_port) = tcp_connection[self.local_address_field].split(':')
+                        if self.port != local_port:
+                            continue
+                        (remote_ip, remote_port) = tcp_connection[self.remote_address_field].split(':')
+                        if (family, remote_ip) in self.exclude_ips:
+                            continue
+                        if any((
+                            (family, local_ip) in self.ips,
+                            (family, self.match_all_ips[family]) in self.ips,
+                            local_ip.startswith(self.ipv4_mapped_ipv6_address['prefix']) and
+                                (family, self.ipv4_mapped_ipv6_address['match_all']) in self.ips,
+                        )):
+                            active_connections += 1
+            except OSError:
                 pass
-            finally:
-                f.close()
 
         return active_connections
 
@@ -549,7 +554,7 @@ def main():
                 try:
                     if not os.access(b_path, os.F_OK):
                         break
-                except IOError:
+                except OSError:
                     break
             elif port:
                 try:
@@ -609,7 +614,7 @@ def main():
                                     break
                             except Exception as e:
                                 module.warn('wait_for failed on "%s", unexpected exception(%s): %s.).' % (path, to_native(e.__class__), to_native(e)))
-                    except IOError:
+                    except OSError:
                         pass
             elif port:
                 alt_connect_timeout = math.ceil(
@@ -648,8 +653,8 @@ def main():
                         # Shutdown the client socket
                         try:
                             s.shutdown(socket.SHUT_RDWR)
-                        except socket.error as e:
-                            if e.errno != errno.ENOTCONN:
+                        except OSError as ex:
+                            if ex.errno != errno.ENOTCONN:
                                 raise
                         # else, the server broke the connection on its end, assume it's not ready
                         else:
@@ -661,8 +666,8 @@ def main():
                         # Connection established, success!
                         try:
                             s.shutdown(socket.SHUT_RDWR)
-                        except socket.error as e:
-                            if e.errno != errno.ENOTCONN:
+                        except OSError as ex:
+                            if ex.errno != errno.ENOTCONN:
                                 raise
                         # else, the server broke the connection on its end, assume it's not ready
                         else:

ansible/modules/yum_repository.py

@@ -502,10 +502,11 @@ class YumRepo:
             try:
                 with open(self.dest, 'w') as fd:
                     self.repofile.write(fd)
-            except IOError as e:
+            except OSError as ex:
                 self.module.fail_json(
-                    msg=f"Problems handling file {self.dest}.",
-                    details=to_native(e),
+                    msg=f"Problems handling file {self.dest!r}.",
+                    details=str(ex),
+                    exception=ex,
                 )
         else:
             try:

ansible/parsing/dataloader.py

@@ -217,7 +217,7 @@ class DataLoader:
         except FileNotFoundError as ex:
             # DTFIX-FUTURE: why not just let the builtin one fly?
             raise AnsibleFileNotFound("Unable to retrieve file contents.", file_name=file_name) from ex
-        except (IOError, OSError) as ex:
+        except OSError as ex:
             raise AnsibleParserError(f"An error occurred while trying to read the file {file_name!r}.") from ex
 
         data = Origin(path=file_name).tag(data)
@@ -448,7 +448,7 @@ class DataLoader:
 
             return real_path
 
-        except (IOError, OSError) as ex:
+        except OSError as ex:
             raise AnsibleParserError(f"an error occurred while trying to read the file {to_text(real_path)!r}.") from ex
 
     def cleanup_tmp_file(self, file_path: str) -> None:

ansible/parsing/mod_args.py

@@ -20,17 +20,17 @@ from __future__ import annotations
 import ansible.constants as C
 from ansible.errors import AnsibleParserError, AnsibleError, AnsibleAssertionError
 from ansible.module_utils._internal._datatag import AnsibleTagHelper
-from ansible.module_utils.six import string_types
 from ansible.module_utils.common.sentinel import Sentinel
 from ansible.module_utils.common.text.converters import to_text
 from ansible.parsing.splitter import parse_kv, split_args
 from ansible.parsing.vault import EncryptedString
 from ansible.plugins.loader import module_loader, action_loader
-from ansible._internal._templating._engine import TemplateEngine
+from ansible._internal._templating import _jinja_bits
+from ansible.utils.display import Display
 from ansible.utils.fqcn import add_internal_fqcns
 
 
-# modules formated for user msg
+# modules formatted for user msg
 _BUILTIN_RAW_PARAM_MODULES_SIMPLE = set([
     'include_vars',
     'include_tasks',
@@ -152,38 +152,43 @@ class ModuleArgsParser:
         arguments can be fuzzy.  Deal with all the forms.
         """
 
-        additional_args = {} if additional_args is None else additional_args
-
         # final args are the ones we'll eventually return, so first update
         # them with any additional args specified, which have lower priority
         # than those which may be parsed/normalized next
         final_args = dict()
-        if additional_args:
-            if isinstance(additional_args, (str, EncryptedString)):
-                # DTFIX5: should this be is_possibly_template?
-                if TemplateEngine().is_template(additional_args):
-                    final_args['_variable_params'] = additional_args
-                else:
-                    raise AnsibleParserError("Complex args containing variables cannot use bare variables (without Jinja2 delimiters), "
-                                             "and must use the full variable style ('{{var_name}}')")
+
+        if additional_args is not Sentinel:
+            if isinstance(additional_args, str) and _jinja_bits.is_possibly_all_template(additional_args):
+                final_args['_variable_params'] = additional_args
             elif isinstance(additional_args, dict):
                 final_args.update(additional_args)
+            elif additional_args is None:
+                Display().deprecated(
+                    msg="Ignoring empty task `args` keyword.",
+                    version="2.23",
+                    help_text='A mapping or template which resolves to a mapping is required.',
+                    obj=self._task_ds,
+                )
             else:
-                raise AnsibleParserError('Complex args must be a dictionary or variable string ("{{var}}").')
+                raise AnsibleParserError(
+                    message='The value of the task `args` keyword is invalid.',
+                    help_text='A mapping or template which resolves to a mapping is required.',
+                    obj=additional_args,
+                )
 
         # how we normalize depends if we figured out what the module name is
         # yet.  If we have already figured it out, it's a 'new style' invocation.
         # otherwise, it's not
 
         if action is not None:
-            args = self._normalize_new_style_args(thing, action)
+            args = self._normalize_new_style_args(thing, action, additional_args)
         else:
             (action, args) = self._normalize_old_style_args(thing)
 
             # this can occasionally happen, simplify
             if args and 'args' in args:
                 tmp_args = args.pop('args')
-                if isinstance(tmp_args, string_types):
+                if isinstance(tmp_args, str):
                     tmp_args = parse_kv(tmp_args)
                 args.update(tmp_args)
 
@@ -206,7 +211,7 @@ class ModuleArgsParser:
 
         return (action, final_args)
 
-    def _normalize_new_style_args(self, thing, action):
+    def _normalize_new_style_args(self, thing, action, additional_args):
         """
         deals with fuzziness in new style module invocations
         accepting key=value pairs and dictionaries, and returns
@@ -222,11 +227,23 @@ class ModuleArgsParser:
         if isinstance(thing, dict):
             # form is like: { xyz: { x: 2, y: 3 } }
             args = thing
-        elif isinstance(thing, string_types):
+        elif isinstance(thing, str):
             # form is like: copy: src=a dest=b
             check_raw = action in FREEFORM_ACTIONS
             args = parse_kv(thing, check_raw=check_raw)
+            args_keys = set(args) - {'_raw_params'}
+
+            if args_keys and additional_args is not Sentinel:
+                kv_args = ', '.join(repr(arg) for arg in sorted(args_keys))
+
+                Display().deprecated(
+                    msg=f"Merging legacy k=v args ({kv_args}) into task args.",
+                    help_text="Include all task args in the task `args` mapping.",
+                    version="2.23",
+                    obj=thing,
+                )
         elif isinstance(thing, EncryptedString):
+            # k=v parsing intentionally omitted
             args = dict(_raw_params=thing)
         elif thing is None:
             # this can happen with modules which take no params, like ping:
@@ -253,6 +270,7 @@ class ModuleArgsParser:
 
         if isinstance(thing, dict):
             # form is like:  action: { module: 'copy', src: 'a', dest: 'b' }
+            Display().deprecated("Using a mapping for `action` is deprecated.", version='2.23', help_text='Use a string value for `action`.', obj=thing)
             thing = thing.copy()
             if 'module' in thing:
                 action, module_args = self._split_module_string(thing['module'])
@@ -261,7 +279,7 @@ class ModuleArgsParser:
                 args.update(parse_kv(module_args, check_raw=check_raw))
                 del args['module']
 
-        elif isinstance(thing, string_types):
+        elif isinstance(thing, str):
             # form is like:  action: copy src=a dest=b
             (action, args) = self._split_module_string(thing)
             check_raw = action in FREEFORM_ACTIONS
@@ -287,7 +305,7 @@ class ModuleArgsParser:
         # This is the standard YAML form for command-type modules. We grab
         # the args and pass them in as additional arguments, which can/will
         # be overwritten via dict updates from the other arg sources below
-        additional_args = self._task_ds.get('args', dict())
+        additional_args = self._task_ds.get('args', Sentinel)
 
         # We can have one of action, local_action, or module specified
         # action

ansible/parsing/vault/__init__.py

@@ -17,7 +17,6 @@
 
 from __future__ import annotations
 
-import errno
 import fcntl
 import functools
 import os
@@ -414,8 +413,8 @@ class FileVaultSecret(VaultSecret):
         try:
             with open(filename, "rb") as f:
                 vault_pass = f.read().strip()
-        except (OSError, IOError) as e:
-            raise AnsibleError("Could not read vault password file %s: %s" % (filename, e))
+        except OSError as ex:
+            raise AnsibleError(f"Could not read vault password file {filename!r}.") from ex
 
         b_vault_data, dummy = self.loader._decrypt_if_vault_data(vault_pass)
 
@@ -571,8 +570,8 @@ def match_encrypt_secret(secrets, encrypt_vault_id=None):
         return match_encrypt_vault_id_secret(secrets,
                                              encrypt_vault_id=encrypt_vault_id)
 
-    # Find the best/first secret from secrets since we didnt specify otherwise
-    # ie, consider all of the available secrets as matches
+    # Find the best/first secret from secrets since we didn't specify otherwise
+    # ie, consider all the available secrets as matches
     _vault_id_matchers = [_vault_id for _vault_id, dummy in secrets]
     best_secret = match_best_secret(secrets, _vault_id_matchers)
 
@@ -1071,13 +1070,10 @@ class VaultEditor:
                 try:
                     # create file with secure permissions
                     fd = os.open(thefile, os.O_CREAT | os.O_EXCL | os.O_RDWR | os.O_TRUNC, mode)
-                except OSError as ose:
-                    # Want to catch FileExistsError, which doesn't exist in Python 2, so catch OSError
-                    # and compare the error number to get equivalent behavior in Python 2/3
-                    if ose.errno == errno.EEXIST:
-                        raise AnsibleError('Vault file got recreated while we were operating on it: %s' % to_native(ose))
-
-                    raise AnsibleError('Problem creating temporary vault file: %s' % to_native(ose))
+                except FileExistsError as ex:
+                    raise AnsibleError('Vault file got recreated while we were operating on it.') from ex
+                except OSError as ex:
+                    raise AnsibleError('Problem creating temporary vault file.') from ex
 
                 try:
                     # now write to the file and ensure ours is only data in it
@@ -1417,7 +1413,7 @@ class EncryptedString(AnsibleTaggedObject):
             'ljust',
             'lower',
             'lstrip',
-            'maketrans',  # static, but implemented for simplicty/consistency
+            'maketrans',  # static, but implemented for simplicity/consistency
             'partition',
             'removeprefix',
             'removesuffix',

ansible/playbook/base.py

@@ -83,6 +83,11 @@ class _ClassProperty:
 
 class FieldAttributeBase:
 
+    _post_validate_object = False
+    """
+    `False` skips FieldAttribute post-validation on intermediate objects and mixins for attributes without `always_post_validate`.
+    Leaf objects (e.g., `Task`) should set this attribute `True` to opt-in to post-validation.
+    """
     fattributes = _ClassProperty()
 
     @classmethod
@@ -216,8 +221,6 @@ class FieldAttributeBase:
 
     def validate(self, all_vars=None):
         """ validation that is done at parse time, not load time """
-        all_vars = {} if all_vars is None else all_vars
-
         if not self._validated:
             # walk all fields in the object
             for (name, attribute) in self.fattributes.items():
@@ -566,8 +569,8 @@ class FieldAttributeBase:
             # only import_role is checked here because import_tasks never reaches this point
             return Sentinel
 
-        # FIXME: compare types, not strings
-        if not attribute.always_post_validate and self.__class__.__name__ not in ('Task', 'Handler', 'PlayContext', 'IncludeRole', 'TaskInclude'):
+        # Skip post validation unless always_post_validate is True, or the object requires post validation.
+        if not attribute.always_post_validate and not self._post_validate_object:
             # Intermediate objects like Play() won't have their fields validated by
             # default, as their values are often inherited by other objects and validated
             # later, so we don't want them to fail out early

ansible/playbook/helpers.py

@@ -122,7 +122,7 @@ def load_list_of_tasks(ds, play, block=None, role=None, task_include=None, use_h
             except AnsibleParserError as ex:
                 # if the raises exception was created with obj=ds args, then it includes the detail
                 # so we dont need to add it so we can just re raise.
-                if ex.obj:
+                if ex.obj is not None:
                     raise
                 # But if it wasn't, we can add the yaml object now to get more detail
                 # DTFIX-FUTURE: this *should* be unnecessary- check code coverage.

ansible/playbook/included_file.py

@@ -144,7 +144,9 @@ class IncludedFile:
                                     parent_include_dir = parent_include._role_path
                                 else:
                                     try:
-                                        parent_include_dir = os.path.dirname(parent_include.args.get('_raw_params'))
+                                        # FUTURE: Since the parent include path has already been resolved, it should be used here.
+                                        #         Unfortunately it's not currently stored anywhere, so it must be calculated again.
+                                        parent_include_dir = os.path.dirname(templar.template(parent_include.args.get('_raw_params')))
                                     except AnsibleError as e:
                                         parent_include_dir = ''
                                         display.warning(

ansible/playbook/play_context.py

@@ -71,6 +71,8 @@ class PlayContext(Base):
     connection/authentication information.
     """
 
+    _post_validate_object = True
+
     # base
     module_compression = FieldAttribute(isa='string', default=C.DEFAULT_MODULE_COMPRESSION)
     shell = FieldAttribute(isa='string')