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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
|
from __future__ import annotations
from io import BytesIO, TextIOWrapper
from os import linesep
from typing import TYPE_CHECKING
from unittest.mock import Mock
import pytest
from streamlink_cli.console.stream import (
ConsoleOutputStream,
ConsoleOutputStreamANSI,
ConsoleOutputStreamWindows,
ConsoleStatusMessage,
)
if TYPE_CHECKING:
from typing_extensions import Buffer
nl = linesep.encode("ascii")
@pytest.fixture()
def buffer():
return BytesIO()
@pytest.fixture()
def stream(buffer: BytesIO):
# stdout/stderr is line buffered, which implies flushes when writing \n or \r
return TextIOWrapper(buffer, encoding="utf-8", line_buffering=True)
@pytest.fixture()
def console_output_stream(stream: TextIOWrapper):
return ConsoleOutputStream(stream)
class TestConsoleOutputStreamFeatureDetection:
@pytest.fixture(autouse=True)
def _mock_is_win32(self, request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch):
monkeypatch.setattr("streamlink_cli.console.stream.is_win32", getattr(request, "param", False))
@pytest.fixture(autouse=True)
def _mock_windows_console(self, request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch):
value = getattr(request, "param", None)
mock_windows_console = Mock(supports_virtual_terminal_processing=Mock(return_value=value))
MockWindowsConsole = Mock(return_value=mock_windows_console if value is not None else None)
monkeypatch.setattr("streamlink_cli.console.stream.WindowsConsole", MockWindowsConsole)
@pytest.fixture()
def stream(self, request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch, stream: TextIOWrapper):
isatty = getattr(request, "param", True)
setattr(stream, "isatty", lambda: isatty) # noqa: B010
return stream
# noinspection PyTestParametrized
@pytest.mark.parametrize(
("_mock_is_win32", "stream", "os_environ", "_mock_windows_console", "expected"),
[
pytest.param(False, False, {}, None, ConsoleOutputStream, id="posix-notatty"),
pytest.param(False, True, {}, None, ConsoleOutputStreamANSI, id="posix-isatty"),
pytest.param(False, True, {"TERM": "dumb"}, None, ConsoleOutputStream, id="posix-TERM=dumb"),
pytest.param(False, True, {"TERM": "unknown"}, None, ConsoleOutputStream, id="posix-TERM=unknown"),
pytest.param(True, False, {}, None, ConsoleOutputStream, id="win32-notatty"),
pytest.param(True, True, {}, None, ConsoleOutputStreamANSI, id="win32-nowindowsconsole"),
pytest.param(True, True, {}, True, ConsoleOutputStreamANSI, id="win32-windowsconsole-virtprocessing"),
pytest.param(True, True, {}, False, ConsoleOutputStreamWindows, id="win32-windowsconsole-novirtprocessing"),
],
indirect=["_mock_is_win32", "os_environ", "stream", "_mock_windows_console"],
)
def test_class_type(self, os_environ: dict, console_output_stream: ConsoleOutputStream, expected: ConsoleOutputStream):
assert type(console_output_stream) is expected
class TestConsoleOutputStream:
@pytest.fixture(autouse=True)
def _mock_new(self, monkeypatch: pytest.MonkeyPatch):
monkeypatch.setattr(ConsoleOutputStream, "__new__", lambda *_, **__: object.__new__(ConsoleOutputStream))
def test_supports_status_messages(self, console_output_stream: ConsoleOutputStream):
assert not console_output_stream.supports_status_messages()
def test_write(self, buffer: BytesIO, console_output_stream: ConsoleOutputStream):
assert buffer.getvalue() == b""
assert console_output_stream.write("foo") == 0
assert buffer.getvalue() == b""
assert console_output_stream._line_buffer == ["foo"]
assert console_output_stream.write("bar") == 0
assert buffer.getvalue() == b""
assert console_output_stream._line_buffer == ["foo", "bar"]
assert console_output_stream.write("baz\n123\n456\n") == (6 + 4) + 4 + 4
assert buffer.getvalue() == b"foobarbaz" + nl + b"123" + nl + b"456" + nl
assert console_output_stream._line_buffer == []
assert console_output_stream.write("abc") == 0
console_output_stream.flush()
assert buffer.getvalue() == b"foobarbaz" + nl + b"123" + nl + b"456" + nl + b"abc"
assert console_output_stream._line_buffer == []
console_output_stream.writelines(["QWERTY\n", "ASDF"])
assert buffer.getvalue() == b"foobarbaz" + nl + b"123" + nl + b"456" + nl + b"abcQWERTY" + nl
assert console_output_stream._line_buffer == ["ASDF"]
console_output_stream.flush()
assert buffer.getvalue() == b"foobarbaz" + nl + b"123" + nl + b"456" + nl + b"abcQWERTY" + nl + b"ASDF"
def test_write_status_message(self, buffer: BytesIO, console_output_stream: ConsoleOutputStream):
assert console_output_stream.write(ConsoleStatusMessage("foo")) == 0
assert console_output_stream._line_buffer == []
console_output_stream.flush()
assert buffer.getvalue() == b""
def test_close(self, buffer: BytesIO, console_output_stream: ConsoleOutputStream):
def fakewrite(s: Buffer) -> int:
msg = bytes(s)
fakebuffer.append(msg)
return len(msg)
fakebuffer: list[Buffer] = []
buffer.write = fakewrite # type: ignore[method-assign]
assert console_output_stream.write("foo") == 0
assert fakebuffer == []
assert console_output_stream._line_buffer == ["foo"]
assert not console_output_stream.closed
console_output_stream.close()
assert fakebuffer == [b"foo"]
assert console_output_stream._line_buffer == []
assert console_output_stream.closed
console_output_stream.close() # noop - does not raise
with pytest.raises(ValueError, match=r"^I/O operation on closed file\.$"):
console_output_stream.write("foo")
with pytest.raises(ValueError, match=r"^I/O operation on closed file\.$"):
console_output_stream.writelines(["foo", "bar"])
with pytest.raises(ValueError, match=r"^I/O operation on closed file\.$"):
console_output_stream.flush()
class TestConsoleOutputStreamANSI:
@pytest.fixture(autouse=True)
def _mock_new(self, monkeypatch: pytest.MonkeyPatch):
monkeypatch.setattr(ConsoleOutputStream, "__new__", lambda *_, **__: object.__new__(ConsoleOutputStreamANSI))
@pytest.fixture()
def fakebuffer(self, buffer: BytesIO):
def fakewrite(s: Buffer) -> int:
msg = bytes(s)
fakebuffer.append(msg)
return len(msg)
fakebuffer: list[Buffer] = []
buffer.write = fakewrite # type: ignore[method-assign]
return fakebuffer
def test_supports_status_messages(self, console_output_stream: ConsoleOutputStreamANSI):
assert console_output_stream.supports_status_messages()
def test_write(self, buffer: BytesIO, console_output_stream: ConsoleOutputStreamANSI):
clr_eol = console_output_stream._CR_CLREOL.encode("ascii")
len_clr_eol = len(clr_eol)
assert len_clr_eol == 4
assert console_output_stream.write("foo") == 0
assert buffer.getvalue() == b""
assert console_output_stream._line_buffer == ["foo"]
assert console_output_stream._last_status == ""
assert console_output_stream.write("bar\n") == 3 + 4
assert buffer.getvalue() == b"foobar" + nl
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert console_output_stream.write(ConsoleStatusMessage("123\n")) == 3
assert buffer.getvalue() == b"foobar" + nl + b"123"
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "123"
assert console_output_stream.write(ConsoleStatusMessage("456\n")) == len_clr_eol + 3
assert buffer.getvalue() == b"foobar" + nl + b"123" + clr_eol + b"456"
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "456"
assert console_output_stream.write("abc") == 0
assert buffer.getvalue() == b"foobar" + nl + b"123" + clr_eol + b"456"
assert console_output_stream._line_buffer == ["abc"]
assert console_output_stream._last_status == "456"
assert console_output_stream.write(ConsoleStatusMessage("789\n")) == len_clr_eol + 3
assert buffer.getvalue() == b"foobar" + nl + b"123" + clr_eol + b"456" + clr_eol + b"789"
assert console_output_stream._line_buffer == ["abc"]
assert console_output_stream._last_status == "789"
assert console_output_stream.write("def\n") == 3 + 4 + len_clr_eol + len(console_output_stream._last_status)
assert buffer.getvalue() == (
b"foobar" + nl + b"123" + clr_eol + b"456" + clr_eol + b"789" + clr_eol + b"abcdef" + nl + b"789"
)
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "789"
def test_close(self, console_output_stream: ConsoleOutputStreamANSI):
console_output_stream.close()
with pytest.raises(ValueError, match=r"^I/O operation on closed file\.$"):
console_output_stream.write("foo")
with pytest.raises(ValueError, match=r"^I/O operation on closed file\.$"):
console_output_stream.writelines(["foo", "bar"])
with pytest.raises(ValueError, match=r"^I/O operation on closed file\.$"):
console_output_stream.flush()
def test_close_without_line_buffer_without_status(
self,
fakebuffer: list[bytes],
console_output_stream: ConsoleOutputStreamANSI,
):
assert console_output_stream.write("foo\n") == 4
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert not console_output_stream.closed
console_output_stream.close()
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert console_output_stream.closed
console_output_stream.close() # noop - does not raise
def test_close_with_line_buffer_without_status(
self,
fakebuffer: list[bytes],
console_output_stream: ConsoleOutputStreamANSI,
):
assert console_output_stream.write("foo\n") == 4
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert not console_output_stream.closed
assert console_output_stream.write("bar") == 0
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == ["bar"]
assert console_output_stream._last_status == ""
assert not console_output_stream.closed
console_output_stream.close()
assert fakebuffer == [b"foo" + nl, b"bar" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert console_output_stream.closed
console_output_stream.close() # noop - does not raise
def test_close_without_line_buffer_with_status(
self,
fakebuffer: list[bytes],
console_output_stream: ConsoleOutputStreamANSI,
):
assert console_output_stream.write("foo\n") == 4
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert not console_output_stream.closed
assert console_output_stream.write(ConsoleStatusMessage("123\n")) == 3
assert fakebuffer == [b"foo" + nl, b"123"]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "123"
assert not console_output_stream.closed
console_output_stream.close()
assert fakebuffer == [b"foo" + nl, b"123", nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert console_output_stream.closed
console_output_stream.close() # noop - does not raise
def test_close_with_line_buffer_with_status(
self,
fakebuffer: list[bytes],
console_output_stream: ConsoleOutputStreamANSI,
):
clr_eol = console_output_stream._CR_CLREOL.encode("ascii")
assert console_output_stream.write("foo\n") == 4
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert not console_output_stream.closed
assert console_output_stream.write("bar") == 0
assert fakebuffer == [b"foo" + nl]
assert console_output_stream._line_buffer == ["bar"]
assert console_output_stream._last_status == ""
assert not console_output_stream.closed
assert console_output_stream.write(ConsoleStatusMessage("123\n")) == 3
assert fakebuffer == [b"foo" + nl, b"123"]
assert console_output_stream._line_buffer == ["bar"]
assert console_output_stream._last_status == "123"
assert not console_output_stream.closed
console_output_stream.close()
assert fakebuffer == [b"foo" + nl, b"123", clr_eol + b"bar" + nl + b"123" + nl]
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert console_output_stream.closed
console_output_stream.close() # noop - does not raise
class TestConsoleOutputStreamWindows:
@pytest.fixture(autouse=True)
def _mock_new(self, monkeypatch: pytest.MonkeyPatch):
monkeypatch.setattr(ConsoleOutputStream, "__new__", lambda *_, **__: object.__new__(ConsoleOutputStreamWindows))
@pytest.fixture(autouse=True)
def mock_windows_console(self, monkeypatch: pytest.MonkeyPatch):
mock_windows_console = Mock()
monkeypatch.setattr(ConsoleOutputStreamWindows, "windows_console", mock_windows_console, raising=False)
return mock_windows_console
def test_supports_status_messages(self) -> None:
writer = ConsoleOutputStream(TextIOWrapper(BytesIO(), encoding="utf-8"))
assert writer.supports_status_messages()
def test_write(self, buffer: BytesIO, console_output_stream: ConsoleOutputStreamWindows, mock_windows_console: Mock):
assert console_output_stream.write("foo") == 0
assert buffer.getvalue() == b""
assert console_output_stream._line_buffer == ["foo"]
assert console_output_stream._last_status == ""
assert mock_windows_console.clear_line.call_count == 0
assert console_output_stream.write("bar\n") == 3 + 4
assert buffer.getvalue() == b"foobar" + nl
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == ""
assert mock_windows_console.clear_line.call_count == 0
assert console_output_stream.write(ConsoleStatusMessage("123\n")) == 3
assert buffer.getvalue() == b"foobar" + nl + b"123"
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "123"
assert mock_windows_console.clear_line.call_count == 0
assert console_output_stream.write(ConsoleStatusMessage("456\n")) == 3
assert buffer.getvalue() == b"foobar" + nl + b"123456"
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "456"
assert mock_windows_console.clear_line.call_count == 1
assert console_output_stream.write("abc") == 0
assert buffer.getvalue() == b"foobar" + nl + b"123456"
assert console_output_stream._line_buffer == ["abc"]
assert console_output_stream._last_status == "456"
assert mock_windows_console.clear_line.call_count == 1
assert console_output_stream.write(ConsoleStatusMessage("789\n")) == 3
assert buffer.getvalue() == b"foobar" + nl + b"123456789"
assert console_output_stream._line_buffer == ["abc"]
assert console_output_stream._last_status == "789"
assert mock_windows_console.clear_line.call_count == 2
assert console_output_stream.write("def\n") == 3 + 4 + len(console_output_stream._last_status)
assert buffer.getvalue() == b"foobar" + nl + b"123456789abcdef" + nl + b"789"
assert console_output_stream._line_buffer == []
assert console_output_stream._last_status == "789"
assert mock_windows_console.clear_line.call_count == 3
|
