1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
import logging
import time
from threading import Thread
from unittest.mock import patch
import pytest
from pip._internal.utils.logging import (
BrokenStdoutLoggingError,
IndentingFormatter,
RichPipStreamHandler,
indent_log,
)
from pip._internal.utils.misc import captured_stderr, captured_stdout
logger = logging.getLogger(__name__)
class TestIndentingFormatter:
"""Test ``pip._internal.utils.logging.IndentingFormatter``."""
def make_record(self, msg: str, level_name: str) -> logging.LogRecord:
level_number = getattr(logging, level_name)
attrs = dict(
msg=msg,
created=1547704837.040001 + time.timezone,
msecs=40,
levelname=level_name,
levelno=level_number,
)
record = logging.makeLogRecord(attrs)
return record
@pytest.mark.parametrize(
"level_name, expected",
[
("DEBUG", "hello\nworld"),
("INFO", "hello\nworld"),
("WARNING", "WARNING: hello\nworld"),
("ERROR", "ERROR: hello\nworld"),
("CRITICAL", "ERROR: hello\nworld"),
],
)
def test_format(self, level_name: str, expected: str) -> None:
"""
Args:
level_name: a logging level name (e.g. "WARNING").
"""
record = self.make_record("hello\nworld", level_name=level_name)
f = IndentingFormatter(fmt="%(message)s")
assert f.format(record) == expected
@pytest.mark.parametrize(
"level_name, expected",
[
("INFO", "2019-01-17T06:00:37,040 hello\n2019-01-17T06:00:37,040 world"),
(
"WARNING",
"2019-01-17T06:00:37,040 WARNING: hello\n"
"2019-01-17T06:00:37,040 world",
),
],
)
def test_format_with_timestamp(self, level_name: str, expected: str) -> None:
record = self.make_record("hello\nworld", level_name=level_name)
f = IndentingFormatter(fmt="%(message)s", add_timestamp=True)
assert f.format(record) == expected
@pytest.mark.parametrize(
"level_name, expected",
[
("WARNING", "DEPRECATION: hello\nworld"),
("ERROR", "DEPRECATION: hello\nworld"),
("CRITICAL", "DEPRECATION: hello\nworld"),
],
)
def test_format_deprecated(self, level_name: str, expected: str) -> None:
"""
Test that logged deprecation warnings coming from deprecated()
don't get another prefix.
"""
record = self.make_record(
"DEPRECATION: hello\nworld",
level_name=level_name,
)
f = IndentingFormatter(fmt="%(message)s")
assert f.format(record) == expected
def test_thread_safety_base(self) -> None:
record = self.make_record(
"DEPRECATION: hello\nworld",
level_name="WARNING",
)
f = IndentingFormatter(fmt="%(message)s")
results = []
def thread_function() -> None:
results.append(f.format(record))
thread_function()
thread = Thread(target=thread_function)
thread.start()
thread.join()
assert results[0] == results[1]
def test_thread_safety_indent_log(self) -> None:
record = self.make_record(
"DEPRECATION: hello\nworld",
level_name="WARNING",
)
f = IndentingFormatter(fmt="%(message)s")
results = []
def thread_function() -> None:
with indent_log():
results.append(f.format(record))
thread_function()
thread = Thread(target=thread_function)
thread.start()
thread.join()
assert results[0] == results[1]
class TestColorizedStreamHandler:
def _make_log_record(self) -> logging.LogRecord:
attrs = {
"msg": "my error",
}
record = logging.makeLogRecord(attrs)
return record
def test_broken_pipe_in_stderr_flush(self) -> None:
"""
Test sys.stderr.flush() raising BrokenPipeError.
This error should _not_ trigger an error in the logging framework.
"""
record = self._make_log_record()
with captured_stderr() as stderr:
handler = RichPipStreamHandler(stream=stderr, no_color=True)
with patch("sys.stderr.flush") as mock_flush:
mock_flush.side_effect = BrokenPipeError()
# The emit() call raises no exception.
handler.emit(record)
err_text = stderr.getvalue()
assert err_text.startswith("my error")
# Check that the logging framework tried to log the exception.
assert "Logging error" in err_text
assert "BrokenPipeError" in err_text
assert "Message: 'my error'" in err_text
def test_broken_pipe_in_stdout_write(self) -> None:
"""
Test sys.stdout.write() raising BrokenPipeError.
This error _should_ trigger an error in the logging framework.
"""
record = self._make_log_record()
with captured_stdout() as stdout:
handler = RichPipStreamHandler(stream=stdout, no_color=True)
with patch("sys.stdout.write") as mock_write:
mock_write.side_effect = BrokenPipeError()
with pytest.raises(BrokenStdoutLoggingError):
handler.emit(record)
def test_broken_pipe_in_stdout_flush(self) -> None:
"""
Test sys.stdout.flush() raising BrokenPipeError.
This error _should_ trigger an error in the logging framework.
"""
record = self._make_log_record()
with captured_stdout() as stdout:
handler = RichPipStreamHandler(stream=stdout, no_color=True)
with patch("sys.stdout.flush") as mock_flush:
mock_flush.side_effect = BrokenPipeError()
with pytest.raises(BrokenStdoutLoggingError):
handler.emit(record)
output = stdout.getvalue()
# Sanity check that the log record was written, since flush() happens
# after write().
assert output.startswith("my error")
|
