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

ansible_test/_internal/cli/environments.py

@@ -1,9 +1,11 @@
 """Command line parsing for test environments."""
+
 from __future__ import annotations
 
 import argparse
 import enum
 import functools
+import os
 import typing as t
 
 from ..constants import (
@@ -146,8 +148,20 @@ def add_global_options(
         help='install command requirements',
     )
 
+    global_parser.add_argument(
+        '--host-path',
+        help=argparse.SUPPRESS,  # for internal use only by ansible-test
+    )
+
+    global_parser.add_argument(
+        '--metadata',
+        default=os.environ.get('ANSIBLE_TEST_METADATA_PATH'),
+        help=argparse.SUPPRESS,  # for internal use only by ansible-test
+    )
+
     add_global_remote(global_parser, controller_mode)
     add_global_docker(global_parser, controller_mode)
+    add_global_debug(global_parser)
 
 
 def add_composite_environment_options(
@@ -160,11 +174,6 @@ def add_composite_environment_options(
     composite_parser = t.cast(argparse.ArgumentParser, parser.add_argument_group(
         title='composite environment arguments (mutually exclusive with "environment arguments" above)'))
 
-    composite_parser.add_argument(
-        '--host-path',
-        help=argparse.SUPPRESS,
-    )
-
     action_types: list[t.Type[CompositeAction]] = []
 
     def register_action_type(action_type: t.Type[CompositeAction]) -> t.Type[CompositeAction]:
@@ -439,6 +448,44 @@ def add_global_docker(
     )
 
 
+def add_global_debug(
+    parser: argparse.ArgumentParser,
+) -> None:
+    """Add global debug options."""
+    # These `--dev-*` options are experimental features that may change or be removed without regard for backward compatibility.
+    # Additionally, they're features that are not likely to be used by most users.
+    # To avoid confusion, they're hidden from `--help` and tab completion by default, except for ansible-core-ci users.
+    suppress = None if get_ci_provider().supports_core_ci_auth() else argparse.SUPPRESS
+
+    parser.add_argument(
+        '--dev-debug-on-demand',
+        action='store_true',
+        default=False,
+        help=suppress or 'enable remote debugging only under a debugger',
+    )
+
+    parser.add_argument(
+        '--dev-debug-cli',
+        action='store_true',
+        default=False,
+        help=suppress or 'enable remote debugging for the Ansible CLI',
+    )
+
+    parser.add_argument(
+        '--dev-debug-ansiballz',
+        action='store_true',
+        default=False,
+        help=suppress or 'enable remote debugging for AnsiballZ modules',
+    )
+
+    parser.add_argument(
+        '--dev-debug-self',
+        action='store_true',
+        default=False,
+        help=suppress or 'enable remote debugging for ansible-test',
+    )
+
+
 def add_environment_docker(
     exclusive_parser: argparse.ArgumentParser,
     environments_parser: argparse.ArgumentParser,

ansible_test/_internal/cli/epilog.py

@@ -1,4 +1,5 @@
 """Argument parsing epilog generation."""
+
 from __future__ import annotations
 
 from .argparsing import (

ansible_test/_internal/cli/parsers/__init__.py

@@ -1,4 +1,5 @@
 """Composite argument parsers for ansible-test specific command-line arguments."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/cli/parsers/base_argument_parsers.py

@@ -1,4 +1,5 @@
 """Base classes for the primary parsers for composite command line arguments."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/cli/parsers/helpers.py

@@ -1,4 +1,5 @@
 """Helper functions for composite parsers."""
+
 from __future__ import annotations
 
 from ...constants import (

ansible_test/_internal/cli/parsers/host_config_parsers.py

@@ -1,4 +1,5 @@
 """Composite parsers for the various types of hosts."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/cli/parsers/key_value_parsers.py

@@ -1,4 +1,5 @@
 """Composite argument key-value parsers used by other parsers."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/cli/parsers/value_parsers.py

@@ -1,4 +1,5 @@
 """Composite argument value parsers used by other parsers."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/commands/__init__.py

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

ansible_test/_internal/commands/coverage/__init__.py

@@ -1,4 +1,5 @@
 """Common logic for the coverage subcommand."""
+
 from __future__ import annotations
 
 import collections.abc as c
@@ -76,7 +77,7 @@ class CoverageConfig(EnvironmentConfig):
 def initialize_coverage(args: CoverageConfig, host_state: HostState) -> coverage_module:
     """Delegate execution if requested, install requirements, then import and return the coverage module. Raises an exception if coverage is not available."""
     configure_pypi_proxy(args, host_state.controller_profile)  # coverage
-    install_requirements(args, host_state.controller_profile.python, coverage=True)  # coverage
+    install_requirements(args, host_state.controller_profile, host_state.controller_profile.python, coverage=True)  # coverage
 
     try:
         import coverage
@@ -226,7 +227,7 @@ def read_python_coverage_legacy(path: str) -> PythonArcs:
     """Return coverage arcs from the specified coverage file, which must be in the legacy JSON format."""
     try:
         contents = read_text_file(path)
-        contents = re.sub(r'''^!coverage.py: This is a private format, don't read it directly!''', '', contents)
+        contents = re.sub(r"""^!coverage.py: This is a private format, don't read it directly!""", '', contents)
         data = json.loads(contents)
         arcs: PythonArcs = {filename: [t.cast(tuple[int, int], tuple(arc)) for arc in arc_list] for filename, arc_list in data['arcs'].items()}
     except Exception as ex:

ansible_test/_internal/commands/coverage/analyze/__init__.py

@@ -1,4 +1,5 @@
 """Common logic for the `coverage analyze` subcommand."""
+
 from __future__ import annotations
 import typing as t
 

ansible_test/_internal/commands/coverage/analyze/targets/__init__.py

@@ -1,4 +1,5 @@
 """Analyze integration test target code coverage."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/commands/coverage/analyze/targets/combine.py

@@ -1,4 +1,5 @@
 """Combine integration test target code coverage reports."""
+
 from __future__ import annotations
 import typing as t
 

ansible_test/_internal/commands/coverage/analyze/targets/expand.py

@@ -1,4 +1,5 @@
 """Expand target names in an aggregated coverage file."""
+
 from __future__ import annotations
 import typing as t
 

ansible_test/_internal/commands/coverage/analyze/targets/filter.py

@@ -1,4 +1,5 @@
 """Filter an aggregated coverage file, keeping only the specified targets."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/commands/coverage/analyze/targets/generate.py

@@ -1,4 +1,5 @@
 """Analyze code coverage data to determine which integration test targets provide coverage for each arc or line."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/coverage/analyze/targets/missing.py

@@ -1,4 +1,5 @@
 """Identify aggregated coverage in one file missing from another."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/coverage/combine.py

@@ -1,4 +1,5 @@
 """Combine code coverage files."""
+
 from __future__ import annotations
 
 import collections.abc as c
@@ -364,4 +365,4 @@ class CoverageCombineConfig(CoverageConfig):
         self.stub: bool = args.stub
 
         # only available to coverage combine
-        self.export: str = args.export if 'export' in args else False
+        self.export: str | None = args.export if 'export' in args else None

ansible_test/_internal/commands/coverage/erase.py

@@ -1,4 +1,5 @@
 """Erase code coverage files."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/coverage/html.py

@@ -1,4 +1,5 @@
 """Generate HTML code coverage reports."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/coverage/report.py

@@ -1,4 +1,5 @@
 """Generate console code coverage reports."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/coverage/xml.py

@@ -1,4 +1,5 @@
 """Generate XML code coverage reports."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/env/__init__.py

@@ -1,4 +1,5 @@
 """Show information about the test environment."""
+
 from __future__ import annotations
 
 import datetime
@@ -49,6 +50,7 @@ from ...timeout import (
 
 class EnvConfig(CommonConfig):
     """Configuration for the `env` command."""
+
     def __init__(self, args: t.Any) -> None:
         super().__init__(args, 'env')
 

ansible_test/_internal/commands/integration/__init__.py

@@ -1,4 +1,5 @@
 """Ansible integration test infrastructure."""
+
 from __future__ import annotations
 
 import collections.abc as c
@@ -104,6 +105,7 @@ from ...host_profiles import (
     HostProfile,
     PosixProfile,
     SshTargetHostProfile,
+    DebuggableProfile,
 )
 
 from ...provisioning import (
@@ -458,10 +460,10 @@ def command_integration_filtered(
 
         if isinstance(target_profile, ControllerProfile):
             if host_state.controller_profile.python.path != target_profile.python.path:
-                install_requirements(args, target_python, command=True, controller=False)  # integration
+                install_requirements(args, target_profile, target_python, command=True, controller=False)  # integration
         elif isinstance(target_profile, SshTargetHostProfile):
             connection = target_profile.get_controller_target_connections()[0]
-            install_requirements(args, target_python, command=True, controller=False, connection=connection)  # integration
+            install_requirements(args, target_profile, target_python, command=True, controller=False, connection=connection)  # integration
 
     coverage_manager = CoverageManager(args, host_state, inventory_path)
     coverage_manager.setup()
@@ -590,6 +592,9 @@ def command_integration_script(
     """Run an integration test script."""
     display.info('Running %s integration test script' % target.name)
 
+    if not os.access(target.script_path, os.X_OK):
+        raise ApplicationError(f'Unable to run non-executable script {target.script_path!r}. Did you forget to run "chmod +x" on it?')
+
     env_config = None
 
     if isinstance(args, PosixIntegrationConfig):
@@ -612,7 +617,7 @@ def command_integration_script(
         if args.verbosity:
             cmd.append('-' + ('v' * args.verbosity))
 
-        env = integration_environment(args, target, test_dir, test_env.inventory_path, test_env.ansible_config, env_config, test_env)
+        env = integration_environment(args, target, test_dir, test_env.inventory_path, test_env.ansible_config, env_config, test_env, host_state)
         cwd = os.path.join(test_env.targets_dir, target.relative_path)
 
         env.update(
@@ -733,7 +738,7 @@ def command_integration_role(
             if args.verbosity:
                 cmd.append('-' + ('v' * args.verbosity))
 
-            env = integration_environment(args, target, test_dir, test_env.inventory_path, test_env.ansible_config, env_config, test_env)
+            env = integration_environment(args, target, test_dir, test_env.inventory_path, test_env.ansible_config, env_config, test_env, host_state)
             cwd = test_env.integration_dir
 
             env.update(
@@ -789,6 +794,7 @@ def integration_environment(
     ansible_config: t.Optional[str],
     env_config: t.Optional[CloudEnvironmentConfig],
     test_env: IntegrationEnvironment,
+    host_state: HostState,
 ) -> dict[str, str]:
     """Return a dictionary of environment variables to use when running the given integration test target."""
     env = ansible_environment(args, ansible_config=ansible_config)
@@ -809,6 +815,9 @@ def integration_environment(
     if args.debug_strategy:
         env.update(ANSIBLE_STRATEGY='debug')
 
+    if isinstance(host_state.controller_profile, DebuggableProfile):
+        env.update(host_state.controller_profile.get_ansible_cli_environment_variables())
+
     if 'non_local/' in target.aliases:
         if args.coverage:
             display.warning('Skipping coverage reporting on Ansible modules for non-local test: %s' % target.name)
@@ -816,6 +825,7 @@ def integration_environment(
         env.update(ANSIBLE_TEST_REMOTE_INTERPRETER='')
 
     env.update(integration)
+    env.update(target.env_set)
 
     return env
 
@@ -970,6 +980,13 @@ def requirements(host_profile: HostProfile) -> None:
     """Install requirements after bootstrapping and delegation."""
     if isinstance(host_profile, ControllerHostProfile) and host_profile.controller:
         configure_pypi_proxy(host_profile.args, host_profile)  # integration, windows-integration, network-integration
-        install_requirements(host_profile.args, host_profile.python, ansible=True, command=True)  # integration, windows-integration, network-integration
+
+        install_requirements(  # integration, windows-integration, network-integration
+            args=host_profile.args,
+            host_profile=host_profile,
+            python=host_profile.python,
+            ansible=True,
+            command=True,
+        )
     elif isinstance(host_profile, PosixProfile) and not isinstance(host_profile, ControllerProfile):
         configure_pypi_proxy(host_profile.args, host_profile)  # integration

ansible_test/_internal/commands/integration/cloud/__init__.py

@@ -1,4 +1,5 @@
 """Plugin system for cloud providers and environments for use in integration tests."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/commands/integration/cloud/acme.py

@@ -1,4 +1,5 @@
 """ACME plugin for integration tests."""
+
 from __future__ import annotations
 
 import os
@@ -28,7 +29,7 @@ class ACMEProvider(CloudProvider):
         if os.environ.get('ANSIBLE_ACME_CONTAINER'):
             self.image = os.environ.get('ANSIBLE_ACME_CONTAINER')
         else:
-            self.image = 'quay.io/ansible/acme-test-container:2.1.0'
+            self.image = 'quay.io/ansible/acme-test-container:2.3.0'
 
         self.uses_docker = True
 

ansible_test/_internal/commands/integration/cloud/aws.py

@@ -1,4 +1,5 @@
 """AWS plugin for integration tests."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/integration/cloud/azure.py

@@ -1,4 +1,5 @@
 """Azure plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/cloud/cs.py

@@ -1,4 +1,5 @@
 """CloudStack plugin for integration tests."""
+
 from __future__ import annotations
 
 import json

ansible_test/_internal/commands/integration/cloud/digitalocean.py

@@ -1,4 +1,5 @@
 """DigitalOcean plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/cloud/galaxy.py

@@ -1,4 +1,5 @@
 """Galaxy (ansible-galaxy) plugin for integration tests."""
+
 from __future__ import annotations
 
 import os
@@ -69,7 +70,7 @@ SETTINGS = {
 }
 
 
-GALAXY_IMPORTER = b'''
+GALAXY_IMPORTER = b"""
 [galaxy-importer]
 ansible_local_tmp=~/.ansible/tmp
 ansible_test_local_image=false
@@ -84,7 +85,7 @@ run_ansible_doc=false
 run_ansible_lint=false
 run_ansible_test=false
 run_flake8=false
-'''.strip()
+""".strip()
 
 
 class GalaxyProvider(CloudProvider):

ansible_test/_internal/commands/integration/cloud/hcloud.py

@@ -1,4 +1,5 @@
 """Hetzner Cloud plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/cloud/httptester.py

@@ -1,4 +1,5 @@
 """HTTP Tester plugin for integration tests."""
+
 from __future__ import annotations
 
 import os
@@ -31,7 +32,7 @@ class HttptesterProvider(CloudProvider):
     def __init__(self, args: IntegrationConfig) -> None:
         super().__init__(args)
 
-        self.image = os.environ.get('ANSIBLE_HTTP_TEST_CONTAINER', 'quay.io/ansible/http-test-container:3.2.0')
+        self.image = os.environ.get('ANSIBLE_HTTP_TEST_CONTAINER', 'quay.io/ansible/http-test-container:3.3.0')
 
         self.uses_docker = True
 
@@ -70,7 +71,7 @@ class HttptesterProvider(CloudProvider):
             return
 
         # Read the password from the container environment.
-        # This allows the tests to work when re-using an existing container.
+        # This allows the tests to work when reusing an existing container.
         # The password is marked as sensitive, since it may differ from the one we generated.
         krb5_password = descriptor.details.container.env_dict()[KRB5_PASSWORD_ENV]
         display.sensitive.add(krb5_password)

ansible_test/_internal/commands/integration/cloud/nios.py

@@ -1,4 +1,5 @@
 """NIOS plugin for integration tests."""
+
 from __future__ import annotations
 
 import os
@@ -28,7 +29,7 @@ class NiosProvider(CloudProvider):
     #
     # It's source source itself resides at:
     # https://github.com/ansible/nios-test-container
-    DOCKER_IMAGE = 'quay.io/ansible/nios-test-container:5.0.0'
+    DOCKER_IMAGE = 'quay.io/ansible/nios-test-container:7.0.0'
 
     def __init__(self, args: IntegrationConfig) -> None:
         super().__init__(args)

ansible_test/_internal/commands/integration/cloud/opennebula.py

@@ -1,4 +1,5 @@
 """OpenNebula plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/cloud/openshift.py

@@ -1,4 +1,5 @@
 """OpenShift plugin for integration tests."""
+
 from __future__ import annotations
 
 import re

ansible_test/_internal/commands/integration/cloud/scaleway.py

@@ -1,4 +1,5 @@
 """Scaleway plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/cloud/vcenter.py

@@ -1,4 +1,5 @@
 """VMware vCenter plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/cloud/vultr.py

@@ -1,4 +1,5 @@
 """Vultr plugin for integration tests."""
+
 from __future__ import annotations
 
 import configparser

ansible_test/_internal/commands/integration/coverage.py

@@ -1,7 +1,9 @@
 """Code coverage support for integration tests."""
+
 from __future__ import annotations
 
 import abc
+import json
 import os
 import shutil
 import tempfile
@@ -239,9 +241,13 @@ class PosixCoverageHandler(CoverageHandler[PosixConfig]):
             # cause the 'coverage' module to be found, but not imported or enabled
             coverage_file = ''
 
+        coverage_options = dict(
+            config=config_file,
+            output=coverage_file,
+        )
+
         variables = dict(
-            _ANSIBLE_COVERAGE_CONFIG=config_file,
-            _ANSIBLE_COVERAGE_OUTPUT=coverage_file,
+            _ANSIBLE_ANSIBALLZ_COVERAGE_CONFIG=json.dumps(coverage_options),
         )
 
         return variables

ansible_test/_internal/commands/integration/filters.py

@@ -1,4 +1,5 @@
 """Logic for filtering out integration test targets which are unsupported for the currently provided arguments and available hosts."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/commands/integration/network.py

@@ -1,4 +1,5 @@
 """Network integration testing."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/integration/posix.py

@@ -1,4 +1,5 @@
 """POSIX integration testing."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/commands/integration/windows.py

@@ -1,4 +1,5 @@
 """Windows integration testing."""
+
 from __future__ import annotations
 
 import os