ansible-core 2.18.7__py3-none-any.whl → 2.19.0__py3-none-any.whl

ansible_test/_internal/util.py

@@ -1,4 +1,5 @@
 """Miscellaneous utility functions and classes."""
+
 from __future__ import annotations
 
 import abc
@@ -253,12 +254,29 @@ def filter_args(args: list[str], filters: dict[str, int]) -> list[str]:
     """Return a filtered version of the given command line arguments."""
     remaining = 0
     result = []
+    pass_through_args: list[str] = []
+    pass_through_explicit = False
+    pass_through_implicit = False
 
     for arg in args:
+        if pass_through_explicit:
+            pass_through_args.append(arg)
+            continue
+
+        if arg == '--':
+            pass_through_explicit = True
+            continue
+
         if not arg.startswith('-') and remaining:
             remaining -= 1
+            pass_through_implicit = not remaining
             continue
 
+        if not arg.startswith('-') and pass_through_implicit:
+            pass_through_args.append(arg)
+            continue
+
+        pass_through_implicit = False
         remaining = 0
 
         parts = arg.split('=', 1)
@@ -270,6 +288,9 @@ def filter_args(args: list[str], filters: dict[str, int]) -> list[str]:
 
         result.append(arg)
 
+    if pass_through_args:
+        result += ['--'] + pass_through_args
+
     return result
 
 
@@ -512,16 +533,23 @@ def raw_command(
 
     try:
         try:
-            cmd_bytes = [to_bytes(arg) for arg in cmd]
-            env_bytes = dict((to_bytes(k), to_bytes(v)) for k, v in env.items())
-            process = subprocess.Popen(cmd_bytes, env=env_bytes, stdin=stdin, stdout=stdout, stderr=stderr, cwd=cwd)  # pylint: disable=consider-using-with
+            process = subprocess.Popen(cmd, env=env, stdin=stdin, stdout=stdout, stderr=stderr, cwd=cwd)  # pylint: disable=consider-using-with
         except FileNotFoundError as ex:
             raise ApplicationError('Required program "%s" not found.' % cmd[0]) from ex
 
         if communicate:
             data_bytes = to_optional_bytes(data)
-            stdout_bytes, stderr_bytes = communicate_with_process(process, data_bytes, stdout == subprocess.PIPE, stderr == subprocess.PIPE, capture=capture,
-                                                                  output_stream=output_stream)
+
+            stdout_bytes, stderr_bytes = communicate_with_process(
+                name=cmd[0],
+                process=process,
+                stdin=data_bytes,
+                stdout=stdout == subprocess.PIPE,
+                stderr=stderr == subprocess.PIPE,
+                capture=capture,
+                output_stream=output_stream,
+            )
+
             stdout_text = to_optional_text(stdout_bytes, str_errors) or ''
             stderr_text = to_optional_text(stderr_bytes, str_errors) or ''
         else:
@@ -545,6 +573,7 @@ def raw_command(
 
 
 def communicate_with_process(
+    name: str,
     process: subprocess.Popen,
     stdin: t.Optional[bytes],
     stdout: bool,
@@ -562,16 +591,16 @@ def communicate_with_process(
         reader = OutputThread
 
     if stdin is not None:
-        threads.append(WriterThread(process.stdin, stdin))
+        threads.append(WriterThread(process.stdin, stdin, name))
 
     if stdout:
-        stdout_reader = reader(process.stdout, output_stream.get_buffer(sys.stdout.buffer))
+        stdout_reader = reader(process.stdout, output_stream.get_buffer(sys.stdout.buffer), name)
         threads.append(stdout_reader)
     else:
         stdout_reader = None
 
     if stderr:
-        stderr_reader = reader(process.stderr, output_stream.get_buffer(sys.stderr.buffer))
+        stderr_reader = reader(process.stderr, output_stream.get_buffer(sys.stderr.buffer), name)
         threads.append(stderr_reader)
     else:
         stderr_reader = None
@@ -603,8 +632,8 @@ def communicate_with_process(
 class WriterThread(WrappedThread):
     """Thread to write data to stdin of a subprocess."""
 
-    def __init__(self, handle: t.IO[bytes], data: bytes) -> None:
-        super().__init__(self._run)
+    def __init__(self, handle: t.IO[bytes], data: bytes, name: str) -> None:
+        super().__init__(self._run, f'{self.__class__.__name__}: {name}')
 
         self.handle = handle
         self.data = data
@@ -621,8 +650,8 @@ class WriterThread(WrappedThread):
 class ReaderThread(WrappedThread, metaclass=abc.ABCMeta):
     """Thread to read stdout from a subprocess."""
 
-    def __init__(self, handle: t.IO[bytes], buffer: t.BinaryIO) -> None:
-        super().__init__(self._run)
+    def __init__(self, handle: t.IO[bytes], buffer: t.BinaryIO, name: str) -> None:
+        super().__init__(self._run, f'{self.__class__.__name__}: {name}')
 
         self.handle = handle
         self.buffer = buffer

ansible_test/_internal/util_common.py

@@ -1,4 +1,5 @@
 """Common utility code that depends on CommonConfig."""
+
 from __future__ import annotations
 
 import collections.abc as c
@@ -65,6 +66,7 @@ CHECK_YAML_VERSIONS: dict[str, t.Any] = {}
 
 class ExitHandler:
     """Simple exit handler implementation."""
+
     _callbacks: list[tuple[t.Callable, tuple[t.Any, ...], dict[str, t.Any]]] = []
 
     @staticmethod
@@ -175,6 +177,7 @@ class CommonConfig:
         self.debug: bool = args.debug
         self.truncate: int = args.truncate
         self.redact: bool = args.redact
+        self.display_traceback: str = args.display_traceback
 
         self.display_stderr: bool = False
 
@@ -410,7 +413,7 @@ def create_interpreter_wrapper(interpreter: str, injected_interpreter: str) -> N
     # injected_interpreter could be a script from the system or our own wrapper created for the --venv option
     shebang_interpreter = sys.executable
 
-    code = textwrap.dedent('''
+    code = textwrap.dedent("""
     #!%s
 
     from __future__ import annotations
@@ -421,7 +424,7 @@ def create_interpreter_wrapper(interpreter: str, injected_interpreter: str) -> N
     python = '%s'
 
     execv(python, [python] + argv[1:])
-    ''' % (shebang_interpreter, interpreter)).lstrip()
+    """ % (shebang_interpreter, interpreter)).lstrip()
 
     write_text_file(injected_interpreter, code)
 
@@ -448,10 +451,20 @@ def intercept_python(
     """
     Run a command while intercepting invocations of Python to control the version used.
     If the specified Python is an ansible-test managed virtual environment, it will be added to PATH to activate it.
-    Otherwise a temporary directory will be created to ensure the correct Python can be found in PATH.
+    Otherwise, a temporary directory will be created to ensure the correct Python can be found in PATH.
     """
-    env = env.copy()
     cmd = list(cmd)
+    env = get_injector_env(python, env)
+
+    return run_command(args, cmd, capture=capture, env=env, data=data, cwd=cwd, always=always)
+
+
+def get_injector_env(
+    python: PythonConfig,
+    env: dict[str, str],
+) -> dict[str, str]:
+    """Get the environment variables needed to inject the given Python interpreter into the environment."""
+    env = env.copy()
     inject_path = get_injector_path()
 
     # make sure scripts (including injector.py) find the correct Python interpreter
@@ -464,7 +477,7 @@ def intercept_python(
     env['ANSIBLE_TEST_PYTHON_VERSION'] = python.version
     env['ANSIBLE_TEST_PYTHON_INTERPRETER'] = python.path
 
-    return run_command(args, cmd, capture=capture, env=env, data=data, cwd=cwd, always=always)
+    return env
 
 
 def run_command(

ansible_test/_internal/venv.py

@@ -1,4 +1,5 @@
 """Virtual environment management."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_util/controller/sanity/code-smell/action-plugin-docs.py

@@ -1,4 +1,5 @@
 """Test to verify action plugins have an associated module to provide documentation."""
+
 from __future__ import annotations
 
 import os

ansible_test/_util/controller/sanity/code-smell/changelog/sphinx.py

@@ -1,4 +1,5 @@
 """Block the sphinx module from being loaded."""
+
 from __future__ import annotations
 
 raise ImportError('The sphinx module has been prevented from loading to maintain consistent test results.')

ansible_test/_util/controller/sanity/code-smell/changelog.py

@@ -1,4 +1,5 @@
 """Check changelog fragment naming, syntax, etc."""
+
 from __future__ import annotations
 
 import os

ansible_test/_util/controller/sanity/code-smell/empty-init.py

@@ -1,4 +1,5 @@
 """Require empty __init__.py files."""
+
 from __future__ import annotations
 
 import os

ansible_test/_util/controller/sanity/code-smell/line-endings.py

@@ -1,4 +1,5 @@
 """Require Unix line endings."""
+
 from __future__ import annotations
 
 import sys

ansible_test/_util/controller/sanity/code-smell/no-assert.py

@@ -1,4 +1,5 @@
 """Disallow use of assert."""
+
 from __future__ import annotations
 
 import re

ansible_test/_util/controller/sanity/code-smell/no-get-exception.py

@@ -1,4 +1,5 @@
 """Disallow use of the get_exception function."""
+
 from __future__ import annotations
 
 import re

ansible_test/_util/controller/sanity/code-smell/no-illegal-filenames.py

@@ -3,6 +3,7 @@ Check for illegal filenames on various operating systems.
 The main rules are derived from restrictions on Windows:
 https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file#naming-conventions
 """
+
 from __future__ import annotations
 
 import os

ansible_test/_util/controller/sanity/code-smell/no-smart-quotes.py

@@ -1,4 +1,5 @@
 """Disallow use of Unicode quotes."""
+
 # -*- coding: utf-8 -*-
 from __future__ import annotations
 

ansible_test/_util/controller/sanity/code-smell/replace-urlopen.py

@@ -1,4 +1,5 @@
 """Disallow use of the urlopen function."""
+
 from __future__ import annotations
 
 import re

ansible_test/_util/controller/sanity/code-smell/runtime-metadata.py

@@ -1,4 +1,5 @@
 """Schema validation of ansible-core's ansible_builtin_runtime.yml and collection's meta/runtime.yml"""
+
 from __future__ import annotations
 
 import datetime
@@ -6,6 +7,7 @@ import os
 import re
 import sys
 
+from collections.abc import Sequence, Mapping
 from functools import partial
 
 import yaml
@@ -29,6 +31,15 @@ def fqcr(value):
     return value
 
 
+def fqcr_or_shortname(value):
+    """Validate a FQCR or a shortname."""
+    if not isinstance(value, string_types):
+        raise Invalid('Must be a string that is a FQCR or a short name')
+    if '.' in value and not AnsibleCollectionRef.is_valid_fqcr(value):
+        raise Invalid('Must be a FQCR or a short name')
+    return value
+
+
 def isodate(value, check_deprecation_date=False, is_tombstone=False):
     """Validate a datetime.date or ISO 8601 date string."""
     # datetime.date objects come from YAML dates, these are ok
@@ -264,6 +275,22 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
     list_dict_import_redirection_schema = [{str_type: import_redirection_schema}
                                            for str_type in string_types]
 
+    # action_groups schema
+
+    def at_most_one_dict(value):
+        if isinstance(value, Sequence):
+            if sum(1 for v in value if isinstance(v, Mapping)) > 1:
+                raise Invalid('List must contain at most one dictionary')
+        return value
+
+    metadata_dict = Schema({
+        Required('metadata'): Schema({
+            'extend_group': [fqcr_or_shortname],
+        }, extra=PREVENT_EXTRA)
+    }, extra=PREVENT_EXTRA)
+    action_group_schema = All([metadata_dict, fqcr_or_shortname], at_most_one_dict)
+    list_dict_action_groups_schema = [{str_type: action_group_schema} for str_type in string_types]
+
     # top level schema
 
     schema = Schema({
@@ -272,7 +299,7 @@ def validate_metadata_file(path, is_ansible, check_deprecation_dates=False):
         ('import_redirection'): Any(None, *list_dict_import_redirection_schema),
         # requires_ansible: In the future we should validate this with SpecifierSet
         ('requires_ansible'): Any(*string_types),
-        ('action_groups'): dict,
+        ('action_groups'): Any(*list_dict_action_groups_schema),
     }, extra=PREVENT_EXTRA)
 
     # Ensure schema is valid

ansible_test/_util/controller/sanity/code-smell/shebang.py

@@ -1,4 +1,5 @@
 """Check shebangs, execute bits and byte order marks."""
+
 from __future__ import annotations
 
 import os

ansible_test/_util/controller/sanity/code-smell/symlinks.py

@@ -1,4 +1,5 @@
 """Check for unwanted symbolic links."""
+
 from __future__ import annotations
 
 import os

ansible_test/_util/controller/sanity/code-smell/use-argspec-type-path.py

@@ -1,4 +1,5 @@
 """Disallow use of the expanduser function."""
+
 from __future__ import annotations
 
 import re

ansible_test/_util/controller/sanity/code-smell/use-compat-six.py

@@ -1,4 +1,5 @@
 """Disallow importing of the six module."""
+
 from __future__ import annotations
 
 import re

ansible_test/_util/controller/sanity/integration-aliases/yaml_to_json.py

@@ -1,4 +1,5 @@
 """Read YAML from stdin and write JSON to stdout."""
+
 from __future__ import annotations
 
 import json
@@ -9,6 +10,6 @@ from yaml import load
 try:
     from yaml import CSafeLoader as SafeLoader
 except ImportError:
-    from yaml import SafeLoader
+    from yaml import SafeLoader  # type: ignore[assignment]
 
 json.dump(load(sys.stdin, Loader=SafeLoader), sys.stdout)

ansible_test/_util/controller/sanity/pep8/current-ignore.txt

@@ -7,3 +7,7 @@ E741
 # Unfortunately this means it also conflicts with the output from `black`.
 # See: https://github.com/PyCQA/pycodestyle/issues/373
 E203
+
+# The "multiple statements on one line" rules conflict with `black` for no-impl class and method defs.
+E701
+E704

ansible_test/_util/controller/sanity/pylint/config/ansible-test-target.cfg

@@ -1,6 +1,13 @@
-[MESSAGES CONTROL]
+[pylint]
+
+max-line-length=160
+
+load-plugins=
+    pylint.extensions.docstyle,
 
 disable=
+    bad-super-call,  # flakey test, can report false positives due to inference issue when using deprecate_calls plugin
+    docstring-first-line-empty,
     consider-using-f-string,  # Python 2.x support still required
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     deprecated-argument,  # results vary by Python version
@@ -28,8 +35,6 @@ disable=
     use-dict-literal,  # ignoring as a common style issue
     useless-return,  # complains about returning None when the return type is optional
 
-[BASIC]
-
 bad-names=
     _,
     bar,
@@ -52,8 +57,6 @@ attr-rgx=[a-z_][a-z0-9_]{1,40}$
 method-rgx=[a-z_][a-z0-9_]{1,40}$
 function-rgx=[a-z_][a-z0-9_]{1,40}$
 
-[IMPORTS]
-
 preferred-modules =
     distutils.version:ansible.module_utils.compat.version,
 

ansible_test/_util/controller/sanity/pylint/config/ansible-test.cfg

@@ -1,6 +1,13 @@
-[MESSAGES CONTROL]
+[pylint]
+
+max-line-length=160
+
+load-plugins=
+    pylint.extensions.docstyle,
 
 disable=
+    bad-super-call,  # flakey test, can report false positives due to inference issue when using deprecate_calls plugin
+    docstring-first-line-empty,
     consider-using-f-string,  # many occurrences
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     deprecated-argument,  # results vary by Python version
@@ -27,8 +34,6 @@ disable=
     unspecified-encoding,  # always run with UTF-8 encoding enforced
     useless-return,  # complains about returning None when the return type is optional
 
-[BASIC]
-
 bad-names=
     _,
     bar,
@@ -55,8 +60,6 @@ function-rgx=[a-z_][a-z0-9_]{1,40}$
 # See: https://github.com/PyCQA/pylint/pull/7322
 typevar-rgx=^_{0,2}(?:[^\W\da-z_]+|(?:[^\W\da-z_]+[^\WA-Z_]+)+T?(?<!Type))(?:_co(?:ntra)?)?$
 
-[IMPORTS]
-
 preferred-modules =
     distutils.version:ansible.module_utils.compat.version,
 

ansible_test/_util/controller/sanity/pylint/config/code-smell.cfg

@@ -1,6 +1,13 @@
-[MESSAGES CONTROL]
+[pylint]
+
+max-line-length=160
+
+load-plugins=
+    pylint.extensions.docstyle,
 
 disable=
+    bad-super-call,  # flakey test, can report false positives due to inference issue when using deprecate_calls plugin
+    docstring-first-line-empty,
     consider-using-f-string,  # many occurrences
     cyclic-import,  # consistent results require running with --jobs 1 and testing all files
     deprecated-argument,  # results vary by Python version
@@ -26,8 +33,6 @@ disable=
     unspecified-encoding,  # always run with UTF-8 encoding enforced
     useless-return,  # complains about returning None when the return type is optional
 
-[BASIC]
-
 bad-names=
     _,
     bar,
@@ -51,8 +56,6 @@ method-rgx=[a-z_][a-z0-9_]{1,40}$
 function-rgx=[a-z_][a-z0-9_]{1,40}$
 module-rgx=[a-z_][a-z0-9_-]{2,40}$
 
-[IMPORTS]
-
 preferred-modules =
     distutils.version:ansible.module_utils.compat.version,
 

ansible_test/_util/controller/sanity/pylint/config/collection.cfg

@@ -1,4 +1,6 @@
-[MESSAGES CONTROL]
+[pylint]
+
+max-line-length=160
 
 disable=
     abstract-method,
@@ -9,6 +11,7 @@ disable=
     attribute-defined-outside-init,
     bad-indentation,
     bad-mcs-classmethod-argument,
+    bad-super-call,  # flakey test, can report false positives due to inference issue when using deprecate_calls plugin
     broad-exception-caught,
     broad-exception-raised,
     c-extension-no-member,
@@ -127,8 +130,6 @@ disable=
     wrong-import-order,
     wrong-import-position,
 
-[BASIC]
-
 bad-names=
     _,
     bar,
@@ -145,7 +146,5 @@ good-names=
     k,
     Run,
 
-[TYPECHECK]
-
 ignored-modules=
     _MovedItems,

ansible_test/_util/controller/sanity/pylint/config/default.cfg

@@ -1,6 +1,12 @@
-[MESSAGES CONTROL]
+[pylint]
+
+max-line-length=160
+
+load-plugins=
+    pylint.extensions.docstyle,
 
 disable=
+    docstring-first-line-empty,
     import-outside-toplevel,  # common pattern in ansible related code
     abstract-method,
     access-member-before-definition,
@@ -10,6 +16,7 @@ disable=
     attribute-defined-outside-init,
     bad-indentation,
     bad-mcs-classmethod-argument,
+    bad-super-call,  # flakey test, can report false positives due to inference issue when using deprecate_calls plugin
     broad-exception-caught,
     broad-exception-raised,
     c-extension-no-member,
@@ -118,8 +125,6 @@ disable=
     wrong-import-order,
     wrong-import-position,
 
-[BASIC]
-
 bad-names=
     _,
     bar,
@@ -136,12 +141,8 @@ good-names=
     k,
     Run,
 
-[TYPECHECK]
-
 ignored-modules=
     _MovedItems,
 
-[IMPORTS]
-
 preferred-modules =
     distutils.version:ansible.module_utils.compat.version,