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

ansible_test/_internal/commands/sanity/__init__.py

@@ -1,4 +1,5 @@
 """Execute Ansible sanity tests."""
+
 from __future__ import annotations
 
 import abc
@@ -75,6 +76,7 @@ from ...python_requirements import (
     PipInstall,
     collect_requirements,
     run_pip,
+    install_requirements,
 )
 
 from ...config import (
@@ -177,6 +179,7 @@ def command_sanity(args: SanityConfig) -> None:
     if args.delegate:
         raise Delegate(host_state=host_state, require=changes, exclude=args.exclude)
 
+    install_requirements(args, host_state.controller_profile, host_state.controller_profile.python)  # sanity
     configure_pypi_proxy(args, host_state.controller_profile)  # sanity
 
     if disabled:
@@ -302,7 +305,7 @@ def command_sanity(args: SanityConfig) -> None:
 
     if created_venvs and isinstance(controller, DockerConfig) and controller.name == 'default' and not args.prime_venvs:
         names = ', '.join(created_venvs)
-        display.warning(f'There following sanity test virtual environments are out-of-date in the "default" container: {names}')
+        display.warning(f'The following sanity test virtual environments are out-of-date in the "default" container: {names}')
 
     if failed:
         message = 'The %d sanity test(s) listed below (out of %d) failed. See error output above for details.\n%s' % (
@@ -872,6 +875,7 @@ class SanityScript(SanityTest, metaclass=abc.ABCMeta):
 
             self.__all_targets: bool = self.config.get('all_targets')
             self.__no_targets: bool = self.config.get('no_targets')
+            self.__split_targets: bool = self.config.get('split_targets')
             self.__include_directories: bool = self.config.get('include_directories')
             self.__include_symlinks: bool = self.config.get('include_symlinks')
             self.__error_code: str | None = self.config.get('error_code', None)
@@ -889,6 +893,7 @@ class SanityScript(SanityTest, metaclass=abc.ABCMeta):
 
             self.__all_targets = False
             self.__no_targets = True
+            self.__split_targets = False
             self.__include_directories = False
             self.__include_symlinks = False
             self.__error_code = None
@@ -925,6 +930,11 @@ class SanityScript(SanityTest, metaclass=abc.ABCMeta):
         """True if the test does not use test targets. Mutually exclusive with all_targets."""
         return self.__no_targets
 
+    @property
+    def split_targets(self) -> bool:
+        """True if the test requires target paths to be split between controller-only and target paths."""
+        return self.__split_targets
+
     @property
     def include_directories(self) -> bool:
         """True if the test targets should include directories."""
@@ -992,6 +1002,7 @@ class SanityScript(SanityTest, metaclass=abc.ABCMeta):
             ANSIBLE_TEST_TARGET_PYTHON_VERSION=python.version,
             ANSIBLE_TEST_CONTROLLER_PYTHON_VERSIONS=','.join(CONTROLLER_PYTHON_VERSIONS),
             ANSIBLE_TEST_REMOTE_ONLY_PYTHON_VERSIONS=','.join(REMOTE_ONLY_PYTHON_VERSIONS),
+            ANSIBLE_TEST_FIX_MODE=str(int(args.fix)),
         )
 
         if self.min_max_python_only:
@@ -1018,6 +1029,12 @@ class SanityScript(SanityTest, metaclass=abc.ABCMeta):
                 raise ApplicationError('Unsupported output type: %s' % self.output)
 
         if not self.no_targets:
+            if self.split_targets:
+                target_paths = set(target.path for target in self.filter_remote_targets(list(targets.targets)))
+                controller_path_list = sorted(set(paths) - target_paths)
+                target_path_list = sorted(set(paths) & target_paths)
+                paths = controller_path_list + ['--'] + target_path_list
+
             data = '\n'.join(paths)
 
             if data:
@@ -1070,7 +1087,7 @@ class SanityScript(SanityTest, metaclass=abc.ABCMeta):
 
 
 class SanityVersionNeutral(SanityTest, metaclass=abc.ABCMeta):
-    """Base class for sanity test plugins which are idependent of the python version being used."""
+    """Base class for sanity test plugins which are independent of the python version being used."""
 
     @abc.abstractmethod
     def test(self, args: SanityConfig, targets: SanityTargets) -> TestResult:

ansible_test/_internal/commands/sanity/ansible_doc.py

@@ -1,4 +1,5 @@
 """Sanity test for ansible-doc."""
+
 from __future__ import annotations
 
 import collections

ansible_test/_internal/commands/sanity/bin_symlinks.py

@@ -1,4 +1,5 @@
 """Sanity test for symlinks in the bin directory."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/sanity/compile.py

@@ -1,4 +1,5 @@
 """Sanity test for proper python syntax."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/sanity/ignores.py

@@ -1,4 +1,5 @@
 """Sanity test for the sanity ignore file."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/sanity/import.py

@@ -1,4 +1,5 @@
 """Sanity test for proper import exception handling."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/commands/sanity/integration_aliases.py

@@ -1,4 +1,5 @@
 """Sanity test to check integration test aliases."""
+
 from __future__ import annotations
 
 import dataclasses
@@ -180,6 +181,8 @@ class IntegrationAliasesTest(SanitySingleVersion):
         group_numbers = self.ci_test_groups.get(name, None)
 
         if group_numbers:
+            group_numbers = [num for num in group_numbers if num not in (6, 7)]  # HACK: ignore special groups 6 and 7
+
             if min(group_numbers) != 1:
                 display.warning('Min test group "%s" in %s is %d instead of 1.' % (name, self.CI_YML, min(group_numbers)), unique=True)
 
@@ -290,6 +293,9 @@ class IntegrationAliasesTest(SanitySingleVersion):
             if target.name == 'ansible-test-container':
                 continue  # special test target which uses group 6 -- nothing else should be in that group
 
+            if target.name in ('dnf-oldest', 'dnf-latest'):
+                continue  # special test targets which use group 7 -- nothing else should be in that group
+
             if f'{self.TEST_ALIAS_PREFIX}/posix/' not in target.aliases:
                 continue
 
@@ -350,6 +356,12 @@ class IntegrationAliasesTest(SanitySingleVersion):
             if path == 'test/integration/targets/ansible-test-container':
                 continue  # special test target which uses group 6 -- nothing else should be in that group
 
+            if path in (
+                'test/integration/targets/dnf-oldest',
+                'test/integration/targets/dnf-latest',
+            ):
+                continue  # special test targets which use group 7 -- nothing else should be in that group
+
             messages.append(SanityMessage(unassigned_message, '%s/aliases' % path))
 
         for path in conflicting_paths:

ansible_test/_internal/commands/sanity/pep8.py

@@ -1,4 +1,5 @@
 """Sanity test for PEP 8 style guidelines using pycodestyle."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/sanity/pslint.py

@@ -1,4 +1,5 @@
 """Sanity test using PSScriptAnalyzer."""
+
 from __future__ import annotations
 
 import json

ansible_test/_internal/commands/sanity/pylint.py

@@ -1,4 +1,5 @@
 """Sanity test using pylint."""
+
 from __future__ import annotations
 
 import collections.abc as c
@@ -6,7 +7,6 @@ import itertools
 import json
 import os
 import datetime
-import configparser
 import typing as t
 
 from . import (
@@ -227,17 +227,6 @@ class PylintTest(SanitySingleVersion):
             else:
                 rcfile = os.path.join(SANITY_ROOT, 'pylint', 'config', 'default.cfg')
 
-        parser = configparser.ConfigParser()
-        parser.read(rcfile)
-
-        if parser.has_section('ansible-test'):
-            config = dict(parser.items('ansible-test'))
-        else:
-            config = {}
-
-        disable_plugins = set(i.strip() for i in config.get('disable-plugins', '').split(',') if i)
-        load_plugins = set(plugin_names + ['pylint.extensions.mccabe']) - disable_plugins
-
         if is_target:
             context_label = 'target'
             min_python_version = REMOTE_ONLY_PYTHON_VERSIONS[0]
@@ -245,24 +234,34 @@ class PylintTest(SanitySingleVersion):
             context_label = 'controller'
             min_python_version = CONTROLLER_PYTHON_VERSIONS[0]
 
-        cmd = [
-            python.path,
-            '-m', 'pylint',
-            '--jobs', '0',
-            '--reports', 'n',
-            '--max-line-length', '160',
-            '--max-complexity', '20',
-            '--rcfile', rcfile,
-            '--output-format', 'json',
-            '--load-plugins', ','.join(sorted(load_plugins)),
-            '--py-version', min_python_version,
-        ] + paths  # fmt: skip
+        load_plugins = set(plugin_names)
+        plugin_options: dict[str, str] = {}
 
+        # plugin: deprecated (ansible-test)
         if data_context().content.collection:
-            cmd.extend(['--collection-name', data_context().content.collection.full_name])
+            plugin_options.update({'--collection-name': data_context().content.collection.full_name})
+            plugin_options.update({'--collection-path': os.path.join(data_context().content.collection.root, data_context().content.collection.directory)})
 
             if collection_detail and collection_detail.version:
-                cmd.extend(['--collection-version', collection_detail.version])
+                plugin_options.update({'--collection-version': collection_detail.version})
+
+        # plugin: pylint.extensions.mccabe
+        if args.enable_optional_errors:
+            load_plugins.add('pylint.extensions.mccabe')
+            plugin_options.update({'--max-complexity': '20'})
+
+        options = {
+            '--py-version': min_python_version,
+            '--load-plugins': ','.join(sorted(load_plugins)),
+            '--rcfile': rcfile,
+            '--jobs': '0',
+            '--reports': 'n',
+            '--output-format': 'json',
+        }
+
+        cmd = [python.path, '-m', 'pylint']
+        cmd.extend(itertools.chain.from_iterable((options | plugin_options).items()))
+        cmd.extend(paths)
 
         append_python_path = [plugin_dir]
 

ansible_test/_internal/commands/sanity/shellcheck.py

@@ -1,4 +1,5 @@
 """Sanity test using shellcheck."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/sanity/validate_modules.py

@@ -1,4 +1,5 @@
 """Sanity test using validate-modules."""
+
 from __future__ import annotations
 
 import collections

ansible_test/_internal/commands/sanity/yamllint.py

@@ -1,4 +1,5 @@
 """Sanity test using yamllint."""
+
 from __future__ import annotations
 
 import json

ansible_test/_internal/commands/shell/__init__.py

@@ -1,6 +1,8 @@
 """Open a shell prompt inside an ansible-test environment."""
+
 from __future__ import annotations
 
+import dataclasses
 import os
 import sys
 import typing as t
@@ -13,6 +15,10 @@ from ...util import (
     HostConnectionError,
 )
 
+from ...ansible_util import (
+    ansible_environment,
+)
+
 from ...config import (
     ShellConfig,
 )
@@ -31,6 +37,7 @@ from ...host_profiles import (
     ControllerProfile,
     PosixProfile,
     SshTargetHostProfile,
+    DebuggableProfile,
 )
 
 from ...provisioning import (
@@ -38,7 +45,6 @@ from ...provisioning import (
 )
 
 from ...host_configs import (
-    ControllerConfig,
     OriginConfig,
 )
 
@@ -47,12 +53,21 @@ from ...inventory import (
     create_posix_inventory,
 )
 
+from ...python_requirements import (
+    install_requirements,
+)
+
+from ...util_common import (
+    get_injector_env,
+)
+
+from ...delegation import (
+    metadata_context,
+)
+
 
 def command_shell(args: ShellConfig) -> None:
     """Entry point for the `shell` command."""
-    if args.raw and isinstance(args.targets[0], ControllerConfig):
-        raise ApplicationError('The --raw option has no effect on the controller.')
-
     if not args.export and not args.cmd and not sys.stdin.isatty():
         raise ApplicationError('Standard input must be a TTY to launch a shell.')
 
@@ -61,6 +76,8 @@ def command_shell(args: ShellConfig) -> None:
     if args.delegate:
         raise Delegate(host_state=host_state)
 
+    install_requirements(args, host_state.controller_profile, host_state.controller_profile.python)  # shell
+
     if args.raw and not isinstance(args.controller, OriginConfig):
         display.warning('The --raw option will only be applied to the target.')
 
@@ -91,6 +108,20 @@ def command_shell(args: ShellConfig) -> None:
         con.run(args.cmd, capture=False, interactive=False, output_stream=OutputStream.ORIGINAL)
         return
 
+    if isinstance(con, LocalConnection) and isinstance(target_profile, DebuggableProfile) and target_profile.debugging_enabled:
+        # HACK: ensure the pydevd port visible in the shell is the forwarded port, not the original
+        args.metadata.debugger_settings = dataclasses.replace(args.metadata.debugger_settings, port=target_profile.pydevd_port)
+
+    with metadata_context(args):
+        interactive_shell(args, target_profile, con)
+
+
+def interactive_shell(
+    args: ShellConfig,
+    target_profile: SshTargetHostProfile,
+    con: Connection,
+) -> None:
+    """Run an interactive shell."""
     if isinstance(con, SshConnection) and args.raw:
         cmd: list[str] = []
     elif isinstance(target_profile, PosixProfile):
@@ -110,6 +141,15 @@ def command_shell(args: ShellConfig) -> None:
 
             env = {name: os.environ[name] for name in optional_vars if name in os.environ}
 
+            if isinstance(con, LocalConnection):  # configure the controller environment
+                env.update(ansible_environment(args))
+                env.update(get_injector_env(target_profile.python, env))
+                env.update(ANSIBLE_TEST_METADATA_PATH=os.path.abspath(args.metadata_path))
+
+                if isinstance(target_profile, DebuggableProfile):
+                    env.update(target_profile.get_ansiballz_environment_variables())
+                    env.update(target_profile.get_ansible_cli_environment_variables())
+
             if env:
                 cmd = ['/usr/bin/env'] + [f'{name}={value}' for name, value in env.items()]
 

ansible_test/_internal/commands/units/__init__.py

@@ -1,4 +1,5 @@
 """Execute unit tests using pytest."""
+
 from __future__ import annotations
 
 import os
@@ -63,6 +64,7 @@ from ...executor import (
 
 from ...python_requirements import (
     install_requirements,
+    post_install,
 )
 
 from ...content_config import (
@@ -229,7 +231,9 @@ def command_units(args: UnitsConfig) -> None:
         controller = any(test_context == TestContext.controller for test_context, python, paths, env in final_candidates)
 
         if args.requirements_mode != 'skip':
-            install_requirements(args, target_profile.python, ansible=controller, command=True, controller=False)  # units
+            install_requirements(args, target_profile, target_profile.python, ansible=controller, command=True, controller=False)  # units
+        else:
+            post_install(target_profile)
 
         test_sets.extend(final_candidates)
 

ansible_test/_internal/compat/__init__.py

@@ -1,2 +1,3 @@
 """Nearly empty __init__.py to keep pylint happy."""
+
 from __future__ import annotations

ansible_test/_internal/compat/packaging.py

@@ -1,4 +1,5 @@
 """Packaging compatibility."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/compat/yaml.py

@@ -1,4 +1,5 @@
 """PyYAML compatibility."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/completion.py

@@ -1,4 +1,5 @@
 """Loading, parsing and storing of completion configurations."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/config.py

@@ -1,4 +1,5 @@
 """Configuration classes."""
+
 from __future__ import annotations
 
 import dataclasses
@@ -19,6 +20,7 @@ from .util_common import (
 
 from .metadata import (
     Metadata,
+    DebuggerFlags,
 )
 
 from .data import (
@@ -117,6 +119,26 @@ class EnvironmentConfig(CommonConfig):
         self.dev_systemd_debug: bool = args.dev_systemd_debug
         self.dev_probe_cgroups: t.Optional[str] = args.dev_probe_cgroups
 
+        debugger_flags = DebuggerFlags(
+            on_demand=args.dev_debug_on_demand,
+            cli=args.dev_debug_cli,
+            ansiballz=args.dev_debug_ansiballz,
+            self=args.dev_debug_self,
+        )
+
+        self.metadata = Metadata.from_file(args.metadata) if args.metadata else Metadata(debugger_flags=debugger_flags)
+        self.metadata_path: t.Optional[str] = None
+
+        def metadata_callback(payload_config: PayloadConfig) -> None:
+            """Add the metadata file to the payload file list."""
+            config = self
+            files = payload_config.files
+
+            if config.metadata_path:
+                files.append((os.path.abspath(config.metadata_path), config.metadata_path))
+
+        data_context().register_payload_callback(metadata_callback)
+
         def host_callback(payload_config: PayloadConfig) -> None:
             """Add the host files to the payload file list."""
             config = self
@@ -219,22 +241,9 @@ class TestConfig(EnvironmentConfig):
         self.junit: bool = getattr(args, 'junit', False)
         self.failure_ok: bool = getattr(args, 'failure_ok', False)
 
-        self.metadata = Metadata.from_file(args.metadata) if args.metadata else Metadata()
-        self.metadata_path: t.Optional[str] = None
-
         if self.coverage_check:
             self.coverage = True
 
-        def metadata_callback(payload_config: PayloadConfig) -> None:
-            """Add the metadata file to the payload file list."""
-            config = self
-            files = payload_config.files
-
-            if config.metadata_path:
-                files.append((os.path.abspath(config.metadata_path), config.metadata_path))
-
-        data_context().register_payload_callback(metadata_callback)
-
 
 class ShellConfig(EnvironmentConfig):
     """Configuration for the shell command."""
@@ -262,6 +271,7 @@ class SanityConfig(TestConfig):
         self.allow_disabled: bool = args.allow_disabled
         self.enable_optional_errors: bool = args.enable_optional_errors
         self.prime_venvs: bool = args.prime_venvs
+        self.fix: bool = getattr(args, 'fix', False)
 
         self.display_stderr = self.lint or self.list_tests
 

ansible_test/_internal/connections.py

@@ -1,4 +1,5 @@
 """Connection abstraction for interacting with test hosts."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/constants.py

@@ -1,4 +1,5 @@
 """Constants used by ansible-test. Imports should not be used in this file (other than to import the target common constants)."""
+
 from __future__ import annotations
 
 from .._util.target.common.constants import (

ansible_test/_internal/containers.py

@@ -1,4 +1,5 @@
 """High level functions for working with containers."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/content_config.py

@@ -1,4 +1,5 @@
 """Content configuration."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/core_ci.py

@@ -1,4 +1,5 @@
 """Access Ansible Core CI remote services."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/coverage_util.py

@@ -1,4 +1,5 @@
 """Utility code for facilitating collection of code coverage when running tests."""
+
 from __future__ import annotations
 
 import dataclasses
@@ -246,7 +247,7 @@ def generate_coverage_config(args: TestConfig) -> str:
 
 def generate_ansible_coverage_config() -> str:
     """Generate code coverage configuration for Ansible tests."""
-    coverage_config = '''
+    coverage_config = """
 [run]
 branch = True
 concurrency =
@@ -262,14 +263,14 @@ omit =
     */pytest
     */AnsiballZ_*.py
     */test/results/*
-'''
+"""
 
     return coverage_config
 
 
 def generate_collection_coverage_config(args: TestConfig) -> str:
     """Generate code coverage configuration for Ansible Collection tests."""
-    coverage_config = '''
+    coverage_config = """
 [run]
 branch = True
 concurrency =
@@ -278,28 +279,28 @@ concurrency =
 parallel = True
 disable_warnings =
     no-data-collected
-'''
+"""
 
     if isinstance(args, IntegrationConfig):
-        coverage_config += '''
+        coverage_config += """
 include =
     %s/*
     */%s/*
-''' % (data_context().content.root, data_context().content.collection.directory)
+""" % (data_context().content.root, data_context().content.collection.directory)
     elif isinstance(args, SanityConfig):
         # temporary work-around for import sanity test
-        coverage_config += '''
+        coverage_config += """
 include =
     %s/*
 
 omit =
     %s/*
-''' % (data_context().content.root, os.path.join(data_context().content.root, data_context().content.results_path))
+""" % (data_context().content.root, os.path.join(data_context().content.root, data_context().content.results_path))
     else:
-        coverage_config += '''
+        coverage_config += """
 include =
      %s/*
-''' % data_context().content.root
+""" % data_context().content.root
 
     return coverage_config
 

ansible_test/_internal/data.py

@@ -1,4 +1,5 @@
 """Context information for the current invocation of ansible-test."""
+
 from __future__ import annotations
 
 import collections.abc as c