ansible-core 2.18.5rc1__py3-none-any.whl → 2.19.0b1__py3-none-any.whl

ansible_test/_internal/delegation.py

@@ -1,4 +1,5 @@
 """Delegate test execution to another environment."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/dev/__init__.py

@@ -1,2 +1,3 @@
 """Development and testing support code. Enabled through the use of `--dev-*` command line options."""
+
 from __future__ import annotations

ansible_test/_internal/dev/container_probe.py

@@ -1,4 +1,5 @@
 """Diagnostic utilities to probe container cgroup behavior during development and testing (both manual and integration)."""
+
 from __future__ import annotations
 
 import dataclasses

ansible_test/_internal/diff.py

@@ -1,4 +1,5 @@
 """Diff parsing functions and classes."""
+
 from __future__ import annotations
 
 import re
@@ -128,14 +129,14 @@ class DiffParser:
             try:
                 self.action()
             except Exception as ex:
-                message = textwrap.dedent('''
+                message = textwrap.dedent("""
                 %s
 
                      Line: %d
                  Previous: %s
                   Current: %s
                 %s
-                ''').strip() % (
+                """).strip() % (
                     ex,
                     self.line_number,
                     self.previous_line or '',

ansible_test/_internal/docker_util.py

@@ -1,4 +1,5 @@
 """Functions for accessing docker via the docker cli."""
+
 from __future__ import annotations
 
 import dataclasses
@@ -49,7 +50,7 @@ DOCKER_COMMANDS = [
     'podman',
 ]
 
-UTILITY_IMAGE = 'quay.io/ansible/ansible-test-utility-container:3.1.0'
+UTILITY_IMAGE = 'quay.io/ansible/ansible-test-utility-container:3.2.0'
 
 # Max number of open files in a docker container.
 # Passed with --ulimit option to the docker run command.

ansible_test/_internal/encoding.py

@@ -1,4 +1,5 @@
 """Functions for encoding and decoding strings."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/executor.py

@@ -1,4 +1,5 @@
 """Execute Ansible tests."""
+
 from __future__ import annotations
 
 import typing as t

ansible_test/_internal/git.py

@@ -1,4 +1,5 @@
 """Wrapper around git command-line tools."""
+
 from __future__ import annotations
 
 import re

ansible_test/_internal/host_configs.py

@@ -1,4 +1,5 @@
 """Configuration for the test hosts requested by the user."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/host_profiles.py

@@ -1,4 +1,5 @@
 """Profiles to represent individual test hosts or a user-provided inventory file."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/http.py

@@ -1,4 +1,5 @@
 """A simple HTTP client."""
+
 from __future__ import annotations
 
 import http.client

ansible_test/_internal/init.py

@@ -1,4 +1,5 @@
 """Early initialization for ansible-test before most other imports have been performed."""
+
 from __future__ import annotations
 
 import resource

ansible_test/_internal/inventory.py

@@ -1,7 +1,9 @@
 """Inventory creation from host profiles."""
+
 from __future__ import annotations
 
 import shutil
+import sys
 import typing as t
 
 from .config import (
@@ -13,6 +15,11 @@ from .util import (
     exclude_none_values,
 )
 
+from .host_configs import (
+    ControllerConfig,
+    PosixRemoteConfig,
+)
+
 from .host_profiles import (
     ControllerHostProfile,
     ControllerProfile,
@@ -30,12 +37,37 @@ from .ssh import (
 )
 
 
+def get_common_variables(target_profile: HostProfile, controller: bool = False) -> dict[str, t.Any]:
+    """Get variables common to all scenarios, but dependent on the target profile."""
+    target_config = target_profile.config
+
+    if controller or isinstance(target_config, ControllerConfig):
+        # The current process is running on the controller, so consult the controller directly when it is the target.
+        macos = sys.platform == 'darwin'
+    elif isinstance(target_config, PosixRemoteConfig):
+        # The target is not the controller, so consult the remote config for that target.
+        macos = target_config.name.startswith('macos/')
+    else:
+        # The target is a type which either cannot be macOS or for which the OS is unknown.
+        # There is currently no means for the user to override this for user provided hosts.
+        macos = False
+
+    common_variables: dict[str, t.Any] = {}
+
+    if macos:
+        # When using sudo on macOS we may encounter permission denied errors when dropping privileges due to inability to access the current working directory.
+        # To compensate for this we'll perform a `cd /` before running any commands after `sudo` succeeds.
+        common_variables.update(ansible_sudo_chdir='/')
+
+    return common_variables
+
+
 def create_controller_inventory(args: EnvironmentConfig, path: str, controller_host: ControllerHostProfile) -> None:
     """Create and return inventory for use in controller-only integration tests."""
     inventory = Inventory(
         host_groups=dict(
             testgroup=dict(
-                testhost=dict(
+                testhost=get_common_variables(controller_host, controller=True) | dict(
                     ansible_connection='local',
                     ansible_pipelining='yes',
                     ansible_python_interpreter=controller_host.python.path,
@@ -129,7 +161,7 @@ def create_posix_inventory(args: EnvironmentConfig, path: str, target_hosts: lis
         inventory = Inventory(
             host_groups=dict(
                 testgroup=dict(
-                    testhost=dict(
+                    testhost=get_common_variables(target_host) | dict(
                         ansible_connection='local',
                         ansible_pipelining='yes',
                         ansible_python_interpreter=target_host.python.path,
@@ -145,7 +177,7 @@ def create_posix_inventory(args: EnvironmentConfig, path: str, target_hosts: lis
 
         ssh = connections[0]
 
-        testhost: dict[str, t.Optional[t.Union[str, int]]] = dict(
+        testhost: dict[str, t.Optional[t.Union[str, int]]] = get_common_variables(target_host) | dict(
             ansible_connection='ssh',
             ansible_pipelining='yes',
             ansible_python_interpreter=ssh.settings.python_interpreter,

ansible_test/_internal/io.py

@@ -1,4 +1,5 @@
 """Functions for disk IO."""
+
 from __future__ import annotations
 
 import io

ansible_test/_internal/metadata.py

@@ -1,4 +1,5 @@
 """Test metadata for passing data to delegated tests."""
+
 from __future__ import annotations
 import typing as t
 

ansible_test/_internal/payload.py

@@ -1,4 +1,5 @@
 """Payload management for sending Ansible files and test content to other systems (VMs, containers)."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/provider/__init__.py

@@ -1,4 +1,5 @@
 """Provider (plugin) infrastructure for ansible-test."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/provider/layout/__init__.py

@@ -1,4 +1,5 @@
 """Code for finding content."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/provider/layout/ansible.py

@@ -1,4 +1,5 @@
 """Layout provider for Ansible source."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/provider/layout/collection.py

@@ -1,4 +1,5 @@
 """Layout provider for Ansible collections."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/provider/layout/unsupported.py

@@ -1,4 +1,5 @@
 """Layout provider for an unsupported directory layout."""
+
 from __future__ import annotations
 
 from . import (

ansible_test/_internal/provider/source/__init__.py

@@ -1,4 +1,5 @@
 """Common code for source providers."""
+
 from __future__ import annotations
 
 import abc

ansible_test/_internal/provider/source/git.py

@@ -1,4 +1,5 @@
 """Source provider for a content root managed by git version control."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/provider/source/installed.py

@@ -1,4 +1,5 @@
 """Source provider for content which has been installed."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/provider/source/unsupported.py

@@ -1,4 +1,5 @@
 """Source provider to use when the layout is unsupported."""
+
 from __future__ import annotations
 
 from . import (

ansible_test/_internal/provider/source/unversioned.py

@@ -1,4 +1,5 @@
 """Fallback source provider when no other provider matches the content root."""
+
 from __future__ import annotations
 
 import os

ansible_test/_internal/provisioning.py

@@ -1,4 +1,5 @@
 """Provision hosts for running tests."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/pypi_proxy.py

@@ -1,4 +1,5 @@
 """PyPI proxy management."""
+
 from __future__ import annotations
 
 import os
@@ -69,7 +70,7 @@ def run_pypi_proxy(args: EnvironmentConfig, targets_use_pypi: bool) -> None:
         display.warning('Unable to use the PyPI proxy because Docker is not available. Installation of packages using `pip` may fail.')
         return
 
-    image = 'quay.io/ansible/pypi-test-container:3.2.0'
+    image = 'quay.io/ansible/pypi-test-container:3.3.0'
     port = 3141
 
     run_support_container(
@@ -134,11 +135,11 @@ def configure_target_pypi_proxy(args: EnvironmentConfig, profile: HostProfile, p
 def configure_pypi_proxy_pip(args: EnvironmentConfig, profile: HostProfile, pypi_endpoint: str, pypi_hostname: str) -> None:
     """Configure a custom index for pip based installs."""
     pip_conf_path = os.path.expanduser('~/.pip/pip.conf')
-    pip_conf = '''
+    pip_conf = """
 [global]
 index-url = {0}
 trusted-host = {1}
-'''.format(pypi_endpoint, pypi_hostname).strip()
+""".format(pypi_endpoint, pypi_hostname).strip()
 
     def pip_conf_cleanup() -> None:
         """Remove custom pip PyPI config."""
@@ -159,10 +160,10 @@ trusted-host = {1}
 def configure_pypi_proxy_easy_install(args: EnvironmentConfig, profile: HostProfile, pypi_endpoint: str) -> None:
     """Configure a custom index for easy_install based installs."""
     pydistutils_cfg_path = os.path.expanduser('~/.pydistutils.cfg')
-    pydistutils_cfg = '''
+    pydistutils_cfg = """
 [easy_install]
 index_url = {0}
-'''.format(pypi_endpoint).strip()
+""".format(pypi_endpoint).strip()
 
     if os.path.exists(pydistutils_cfg_path) and not profile.config.is_managed:
         raise ApplicationError('Refusing to overwrite existing file: %s' % pydistutils_cfg_path)

ansible_test/_internal/python_requirements.py

@@ -1,4 +1,5 @@
 """Python requirements management"""
+
 from __future__ import annotations
 
 import base64

ansible_test/_internal/ssh.py

@@ -1,4 +1,5 @@
 """High level functions for working with SSH."""
+
 from __future__ import annotations
 
 import dataclasses

ansible_test/_internal/target.py

@@ -1,4 +1,5 @@
 """Test target identification, iteration and inclusion/exclusion."""
+
 from __future__ import annotations
 
 import collections

ansible_test/_internal/test.py

@@ -1,4 +1,5 @@
 """Classes for storing and processing test results."""
+
 from __future__ import annotations
 
 import collections.abc as c
@@ -141,12 +142,12 @@ class TestTimeout(TestResult):
 
         # Include a leading newline to improve readability on Shippable "Tests" tab.
         # Without this, the first line becomes indented.
-        output = '''
+        output = """
 One or more of the following situations may be responsible:
 
 - Code changes have resulted in tests that hang or run for an excessive amount of time.
 - Tests have been added which exceed the time limit when combined with existing tests.
-- Test infrastructure and/or external dependencies are operating slower than normal.'''
+- Test infrastructure and/or external dependencies are operating slower than normal."""
 
         if args.coverage:
             output += '\n- Additional overhead from collecting code coverage has resulted in tests exceeding the time limit.'

ansible_test/_internal/thread.py

@@ -1,4 +1,5 @@
 """Python threading tools."""
+
 from __future__ import annotations
 
 import collections.abc as c

ansible_test/_internal/timeout.py

@@ -1,4 +1,5 @@
 """Timeout management for tests."""
+
 from __future__ import annotations
 
 import dataclasses

ansible_test/_internal/util.py

@@ -1,4 +1,5 @@
 """Miscellaneous utility functions and classes."""
+
 from __future__ import annotations
 
 import abc

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)
 

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