1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00
pip/tests/functional/test_broken_stdout.py

81 lines
2.3 KiB
Python

import os
import subprocess
from typing import List, Tuple
from tests.lib.path import Path
_BROKEN_STDOUT_RETURN_CODE = 120
def setup_broken_stdout_test(
args: List[str], deprecated_python: bool
) -> Tuple[str, int]:
proc = subprocess.Popen(
args,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
# Call close() on stdout to cause a broken pipe.
assert proc.stdout is not None
proc.stdout.close()
returncode = proc.wait()
assert proc.stderr is not None
stderr = proc.stderr.read().decode("utf-8")
expected_msg = "ERROR: Pipe to stdout was broken"
if deprecated_python:
assert expected_msg in stderr
else:
assert stderr.startswith(expected_msg)
return stderr, returncode
def test_broken_stdout_pipe(deprecated_python: bool) -> None:
"""
Test a broken pipe to stdout.
"""
stderr, returncode = setup_broken_stdout_test(
["pip", "list"],
deprecated_python=deprecated_python,
)
# Check that no traceback occurs.
assert "raise BrokenStdoutLoggingError()" not in stderr
assert stderr.count("Traceback") == 0
assert returncode == _BROKEN_STDOUT_RETURN_CODE
def test_broken_stdout_pipe__log_option(deprecated_python: bool, tmpdir: Path) -> None:
"""
Test a broken pipe to stdout when --log is passed.
"""
log_path = os.path.join(str(tmpdir), "log.txt")
stderr, returncode = setup_broken_stdout_test(
["pip", "--log", log_path, "list"],
deprecated_python=deprecated_python,
)
# Check that no traceback occurs.
assert "raise BrokenStdoutLoggingError()" not in stderr
assert stderr.count("Traceback") == 0
assert returncode == _BROKEN_STDOUT_RETURN_CODE
def test_broken_stdout_pipe__verbose(deprecated_python: bool) -> None:
"""
Test a broken pipe to stdout with verbose logging enabled.
"""
stderr, returncode = setup_broken_stdout_test(
["pip", "-vv", "list"],
deprecated_python=deprecated_python,
)
# Check that a traceback occurs and that it occurs at most once.
# We permit up to two because the exception can be chained.
assert "raise BrokenStdoutLoggingError()" in stderr
assert 1 <= stderr.count("Traceback") <= 2
assert returncode == _BROKEN_STDOUT_RETURN_CODE