ansible-core 2.19.0rc2__py3-none-any.whl → 2.19.1rc1__py3-none-any.whl

ansible_test/_internal/commands/integration/coverage.py

@@ -167,7 +167,7 @@ class PosixCoverageHandler(CoverageHandler[PosixConfig]):
         coverage_config_path = os.path.join(self.common_temp_path, COVERAGE_CONFIG_NAME)
         coverage_output_path = os.path.join(self.common_temp_path, ResultType.COVERAGE.name)
 
-        coverage_config = generate_coverage_config(self.args)
+        coverage_config = generate_coverage_config()
 
         write_text_file(coverage_config_path, coverage_config, create_directories=True)
 
@@ -260,7 +260,7 @@ class PosixCoverageHandler(CoverageHandler[PosixConfig]):
         """Return a dictionary of variables for setup and teardown of POSIX coverage."""
         return dict(
             common_temp_dir=self.common_temp_path,
-            coverage_config=generate_coverage_config(self.args),
+            coverage_config=generate_coverage_config(),
             coverage_config_path=os.path.join(self.common_temp_path, COVERAGE_CONFIG_NAME),
             coverage_output_path=os.path.join(self.common_temp_path, ResultType.COVERAGE.name),
             mode_directory=f'{MODE_DIRECTORY:04o}',

ansible_test/_internal/commands/shell/__init__.py

@@ -2,11 +2,16 @@
 
 from __future__ import annotations
 
+import contextlib
 import dataclasses
 import os
 import sys
 import typing as t
 
+from ...data import (
+    data_context,
+)
+
 from ...util import (
     ApplicationError,
     OutputStream,
@@ -101,19 +106,33 @@ def command_shell(args: ShellConfig) -> None:
     if args.export:
         return
 
-    if args.cmd:
-        # Running a command is assumed to be non-interactive. Only a shell (no command) is interactive.
-        # If we want to support interactive commands in the future, we'll need an `--interactive` command line option.
-        # Command stderr output is allowed to mix with our own output, which is all sent to stderr.
-        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)
+        # HACK: ensure the debugger 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.debugger_port)
 
-    with metadata_context(args):
-        interactive_shell(args, target_profile, con)
+    with contextlib.nullcontext() if data_context().content.unsupported else metadata_context(args):
+        if args.cmd:
+            non_interactive_shell(args, target_profile, con)
+        else:
+            interactive_shell(args, target_profile, con)
+
+
+def non_interactive_shell(
+    args: ShellConfig,
+    target_profile: SshTargetHostProfile,
+    con: Connection,
+) -> None:
+    """Run a non-interactive shell command."""
+    if isinstance(target_profile, PosixProfile):
+        env = get_environment_variables(args, target_profile, con)
+        cmd = get_env_command(env) + args.cmd
+    else:
+        cmd = args.cmd
+
+    # Running a command is assumed to be non-interactive. Only a shell (no command) is interactive.
+    # If we want to support interactive commands in the future, we'll need an `--interactive` command line option.
+    # Command stderr output is allowed to mix with our own output, which is all sent to stderr.
+    con.run(cmd, capture=False, interactive=False, output_stream=OutputStream.ORIGINAL)
 
 
 def interactive_shell(
@@ -135,23 +154,8 @@ def interactive_shell(
             python = target_profile.python  # make sure the python interpreter has been initialized before opening a shell
             display.info(f'Target Python {python.version} is at: {python.path}')
 
-            optional_vars = (
-                'TERM',  # keep backspace working
-            )
-
-            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()]
+            env = get_environment_variables(args, target_profile, con)
+            cmd = get_env_command(env)
 
         cmd += [shell, '-i']
     else:
@@ -175,3 +179,38 @@ def interactive_shell(
             raise HostConnectionError(f'SSH shell connection failed for host {target_profile.config}: {ex}', callback) from ex
 
         raise
+
+
+def get_env_command(env: dict[str, str]) -> list[str]:
+    """Get an `env` command to set the given environment variables, if any."""
+    if not env:
+        return []
+
+    return ['/usr/bin/env'] + [f'{name}={value}' for name, value in env.items()]
+
+
+def get_environment_variables(
+    args: ShellConfig,
+    target_profile: PosixProfile,
+    con: Connection,
+) -> dict[str, str]:
+    """Get the environment variables to expose to the shell."""
+    if data_context().content.unsupported:
+        return {}
+
+    optional_vars = (
+        'TERM',  # keep backspace working
+    )
+
+    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())
+
+    return env

ansible_test/_internal/coverage_util.py

@@ -6,11 +6,10 @@ import dataclasses
 import os
 import sqlite3
 import tempfile
+import textwrap
 import typing as t
 
 from .config import (
-    IntegrationConfig,
-    SanityConfig,
     TestConfig,
 )
 
@@ -217,7 +216,7 @@ def get_coverage_config(args: TestConfig) -> str:
     except AttributeError:
         pass
 
-    coverage_config = generate_coverage_config(args)
+    coverage_config = generate_coverage_config()
 
     if args.explain:
         temp_dir = '/tmp/coverage-temp-dir'
@@ -235,10 +234,10 @@ def get_coverage_config(args: TestConfig) -> str:
     return path
 
 
-def generate_coverage_config(args: TestConfig) -> str:
+def generate_coverage_config() -> str:
     """Generate code coverage configuration for tests."""
     if data_context().content.collection:
-        coverage_config = generate_collection_coverage_config(args)
+        coverage_config = generate_collection_coverage_config()
     else:
         coverage_config = generate_ansible_coverage_config()
 
@@ -265,12 +264,29 @@ omit =
     */test/results/*
 """
 
+    coverage_config = coverage_config.lstrip()
+
     return coverage_config
 
 
-def generate_collection_coverage_config(args: TestConfig) -> str:
+def generate_collection_coverage_config() -> str:
     """Generate code coverage configuration for Ansible Collection tests."""
-    coverage_config = """
+    include_patterns = [
+        # {base}/ansible_collections/{ns}/{col}/*
+        os.path.join(data_context().content.root, '*'),
+        # */ansible_collections/{ns}/{col}/* (required to pick up AnsiballZ coverage)
+        os.path.join('*', data_context().content.collection.directory, '*'),
+    ]
+
+    omit_patterns = [
+        # {base}/ansible_collections/{ns}/{col}/tests/output/*
+        os.path.join(data_context().content.root, data_context().content.results_path, '*'),
+    ]
+
+    include = textwrap.indent('\n'.join(include_patterns), ' ' * 4)
+    omit = textwrap.indent('\n'.join(omit_patterns), ' ' * 4)
+
+    coverage_config = f"""
 [run]
 branch = True
 concurrency =
@@ -279,28 +295,15 @@ concurrency =
 parallel = True
 disable_warnings =
     no-data-collected
-"""
 
-    if isinstance(args, IntegrationConfig):
-        coverage_config += """
-include =
-    %s/*
-    */%s/*
-""" % (data_context().content.root, data_context().content.collection.directory)
-    elif isinstance(args, SanityConfig):
-        # temporary work-around for import sanity test
-        coverage_config += """
 include =
-    %s/*
+{include}
 
 omit =
-    %s/*
-""" % (data_context().content.root, os.path.join(data_context().content.root, data_context().content.results_path))
-    else:
-        coverage_config += """
-include =
-     %s/*
-""" % data_context().content.root
+{omit}
+"""
+
+    coverage_config = coverage_config.lstrip()
 
     return coverage_config