Clean up test style to match project conventions

Shorten verbose docstrings in unit and integration tests to single-line
summaries (or remove entirely where function names are self-explanatory),
and shorten overly long integration test function names.  This aligns the
new TTY-related tests with the existing test style in the same files.

Signed-off-by: xz-dev <xiangzhedev@gmail.com>

Author: xz-dev

src/ansible_runner/config/_base.py

@@ -487,7 +487,6 @@ def _handle_ansible_cmd_options_bind_mounts(self, args_list: list[str], cmdline_
 
             self._update_volume_mount_paths(args_list, optional_arg_value)
 
-
     def _should_allocate_tty(self) -> bool:
         if self.runner_mode == 'pexpect':
             return True

test/integration/containerized/test_container_management.py

@@ -181,25 +181,8 @@ def test_registry_auth_file_cleanup(tmp_path, cli, runtime):
 
 
 @pytest.mark.test_all_runtimes
-def test_containerized_run_command_no_tty_when_input_fd_is_not_a_terminal(tmp_path, runtime, container_image):
-    """Verify --tty is not passed to the container when input_fd is not a real TTY.
-
-    Regression test for ansible-runner PR#1306 (partial fix for
-    ansible-navigator#1607).  When ansible-navigator runs in a CI/CD
-    pipeline or cron job, sys.stdin is not a terminal, yet it is still
-    forwarded to ansible-runner as input_fd.  Before the fix, any truthy
-    input_fd caused --tty to be added, making the container allocate a
-    pseudo-terminal and polluting output with ANSI escape sequences.
-
-    This test uses a regular file as input_fd (isatty() == False) to
-    simulate the non-TTY scenario and asserts that the containerized
-    ``ansible-config init`` output is clean.
-
-    NOTE: the original issue also manifests when stdin *is* a TTY but
-    stdout is redirected (``> ansible.cfg``).  That scenario is not
-    covered here because it requires a different fix (e.g. checking
-    output_fd.isatty() or handling it on the navigator side).
-    """
+def test_containerized_no_tty_when_stdin_not_terminal(tmp_path, runtime, container_image):
+    """Regression for ansible-navigator#1607: no --tty when input_fd is not a real TTY."""
     input_path = tmp_path / 'stdin.txt'
     output_path = tmp_path / 'ansible.cfg'
     error_path = tmp_path / 'stderr.txt'
@@ -230,23 +213,8 @@ def test_containerized_run_command_no_tty_when_input_fd_is_not_a_terminal(tmp_pa
 
 
 @pytest.mark.test_all_runtimes
-def test_containerized_run_command_no_ansi_when_stdout_redirected_but_stdin_is_tty(
-    tmp_path, runtime, container_image,
-):
-    """Reproduce the exact ansible-navigator#1607 scenario.
-
-    The user runs ``ansible-navigator config init -m stdout > ansible.cfg``
-    from a real terminal.  ansible-navigator forwards sys.stdin (a TTY) as
-    input_fd and sys.stdout (redirected to a file, not a TTY) as output_fd.
-
-    The container must not receive --tty in this situation; otherwise
-    ``ansible-config init`` detects a pseudo-terminal inside the container
-    and emits ANSI escape sequences / launches a pager.
-
-    This test uses pty.openpty() to obtain an input_fd where isatty()
-    is True, while output_fd is a regular file (isatty() == False),
-    matching the real-world trigger exactly.
-    """
+def test_containerized_no_tty_when_stdout_redirected(tmp_path, runtime, container_image):
+    """Regression for ansible-navigator#1607: no --tty when stdin is TTY but stdout is redirected."""
     output_path = tmp_path / 'ansible.cfg'
     error_path = tmp_path / 'stderr.txt'
 

test/unit/config/test__base.py

@@ -372,7 +372,6 @@ def test_containerization_unsafe_write_setting(tmp_path, runtime, mocker):
 
 
 def test_should_allocate_tty_pexpect_mode(tmp_path, mocker):
-    """pexpect mode always allocates a TTY even when input_fd is not a terminal."""
     rc = BaseConfig(private_data_dir=str(tmp_path))
     rc.runner_mode = 'pexpect'
     rc.input_fd = mocker.Mock()
@@ -381,14 +380,12 @@ def test_should_allocate_tty_pexpect_mode(tmp_path, mocker):
 
 
 def test_should_allocate_tty_subprocess_no_input_fd(tmp_path):
-    """subprocess mode without input_fd does not allocate TTY (AWX scenario)."""
     rc = BaseConfig(private_data_dir=str(tmp_path))
     rc.runner_mode = 'subprocess'
     assert rc._should_allocate_tty() is False
 
 
 def test_should_allocate_tty_subprocess_both_tty(tmp_path, mocker):
-    """subprocess mode with both input_fd and output_fd as TTY allocates TTY."""
     rc = BaseConfig(private_data_dir=str(tmp_path))
     rc.runner_mode = 'subprocess'
     rc.input_fd = mocker.Mock()
@@ -399,11 +396,6 @@ def test_should_allocate_tty_subprocess_both_tty(tmp_path, mocker):
 
 
 def test_should_allocate_tty_subprocess_input_fd_is_pipe(tmp_path, mocker):
-    """subprocess mode with a pipe input_fd does not allocate TTY.
-
-    When ansible-navigator runs in CI/CD where stdin is not a terminal,
-    --tty must not be added to prevent ANSI escape pollution.
-    """
     rc = BaseConfig(private_data_dir=str(tmp_path))
     rc.runner_mode = 'subprocess'
     rc.input_fd = mocker.Mock()
@@ -414,13 +406,6 @@ def test_should_allocate_tty_subprocess_input_fd_is_pipe(tmp_path, mocker):
 
 
 def test_should_allocate_tty_subprocess_output_fd_is_pipe(tmp_path, mocker):
-    """subprocess mode with TTY stdin but redirected stdout does not allocate TTY.
-
-    This is the exact ansible-navigator#1607 scenario: the user runs
-    ``ansible-navigator config init -m stdout > ansible.cfg`` from a real
-    terminal.  stdin is a TTY but stdout is redirected to a file.
-    --tty must not be added to prevent ANSI escapes in the output.
-    """
     rc = BaseConfig(private_data_dir=str(tmp_path))
     rc.runner_mode = 'subprocess'
     rc.input_fd = mocker.Mock()

test/unit/config/test_command.py

@@ -128,8 +128,7 @@ def test_prepare_run_command_with_containerization(tmp_path, runtime, mocker):
 
 @pytest.mark.parametrize('runtime', ('docker', 'podman'))
 def test_prepare_run_command_containerized_subprocess_no_tty_when_piped(tmp_path, runtime, mocker):
-    """Reproduce ansible-navigator#1607: when input_fd is not a tty
-    (output redirected to file), --tty must not appear in container args."""
+    """Regression for ansible-navigator#1607: input_fd is not a tty, --tty must not appear."""
     mocker.patch.dict('os.environ', {'HOME': str(tmp_path)}, clear=True)
     tmp_path.joinpath('.ssh').mkdir()
 
@@ -156,7 +155,7 @@ def test_prepare_run_command_containerized_subprocess_no_tty_when_piped(tmp_path
 
 @pytest.mark.parametrize('runtime', ('docker', 'podman'))
 def test_prepare_run_command_containerized_subprocess_tty_when_interactive(tmp_path, runtime, mocker):
-    """When both input_fd and output_fd are real terminals, --tty should be present."""
+    """Both input_fd and output_fd are real terminals, --tty should be present."""
     mocker.patch.dict('os.environ', {'HOME': str(tmp_path)}, clear=True)
     tmp_path.joinpath('.ssh').mkdir()
 
@@ -185,8 +184,7 @@ def test_prepare_run_command_containerized_subprocess_tty_when_interactive(tmp_p
 
 @pytest.mark.parametrize('runtime', ('docker', 'podman'))
 def test_prepare_run_command_containerized_subprocess_no_tty_when_stdout_redirected(tmp_path, runtime, mocker):
-    """Reproduce ansible-navigator#1607: stdin is a TTY but stdout is
-    redirected to a file (``> ansible.cfg``).  --tty must not appear."""
+    """Regression for ansible-navigator#1607: stdin is TTY but stdout is redirected, --tty must not appear."""
     mocker.patch.dict('os.environ', {'HOME': str(tmp_path)}, clear=True)
     tmp_path.joinpath('.ssh').mkdir()
 
@@ -215,7 +213,7 @@ def test_prepare_run_command_containerized_subprocess_no_tty_when_stdout_redirec
 
 @pytest.mark.parametrize('runtime', ('docker', 'podman'))
 def test_prepare_run_command_containerized_subprocess_no_tty_without_input_fd(tmp_path, runtime, mocker):
-    """Without input_fd (AWX/Controller), subprocess mode should not get --tty."""
+    """Without input_fd (AWX/Controller scenario), subprocess mode should not get --tty."""
     mocker.patch.dict('os.environ', {'HOME': str(tmp_path)}, clear=True)
     tmp_path.joinpath('.ssh').mkdir()