File: test_console.py

package info (click to toggle)
streamlink 8.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,564 kB
  • sloc: python: 51,188; sh: 184; makefile: 152
file content (392 lines) | stat: -rw-r--r-- 14,234 bytes parent folder | download | duplicates (4)
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
387
388
389
390
391
392
from __future__ import annotations

from io import BytesIO, TextIOWrapper
from textwrap import dedent
from typing import TextIO
from unittest.mock import Mock

import pytest

from streamlink_cli.console import ConsoleOutputStream
from streamlink_cli.console.console import ConsoleOutput
from streamlink_cli.console.user_input import ConsoleUserInputRequester


def getvalue(output: TextIO | None, size: int = -1):
    if output is None:
        return None

    output.seek(0)

    return output.read(size)


def build_stream(params: dict, wrap: bool = False):
    if not params.pop("exists", True):
        return None

    isatty = params.pop("isatty", True)
    params.setdefault("encoding", "utf-8")
    params.setdefault("errors", "backslashreplace")
    stream: TextIO
    orig = TextIOWrapper(BytesIO(), **params)
    if wrap:
        stream = ConsoleOutputStream(orig)
    else:
        stream = orig

    setattr(stream, "isatty", lambda: isatty)  # noqa: B010

    return stream


@pytest.fixture(autouse=True)
def stdin(request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch):
    params = getattr(request, "param", {})
    stdin = build_stream(params)
    monkeypatch.setattr("sys.stdin", stdin)

    return stdin


@pytest.fixture(autouse=True)
def _console_output_stream(monkeypatch: pytest.MonkeyPatch):
    monkeypatch.setattr(ConsoleOutputStream, "__new__", lambda *_, **__: object.__new__(ConsoleOutputStream))


@pytest.fixture()
def console_output(request: pytest.FixtureRequest):
    return build_stream(getattr(request, "param", {}), wrap=True)


@pytest.fixture()
def file_output(request: pytest.FixtureRequest):
    return build_stream(getattr(request, "param", {}), wrap=False)


@pytest.mark.parametrize(
    ("console_output", "file_output", "has_file_output", "expected_console_output", "expected_file_output"),
    [
        pytest.param(
            {"exists": False},
            {"exists": False},
            False,
            None,
            None,
            id="no-output-streams",
        ),
        pytest.param(
            {"isatty": True},
            {"exists": False},
            False,
            'foo\n{\n  "foo": "bar"\n}\n',
            None,
            id="console-output-is-a-tty",
        ),
        pytest.param(
            {"isatty": False},
            {"exists": False},
            False,
            'foo\n{\n  "foo": "bar"\n}\n',
            None,
            id="console-output-is-not-a-tty",
        ),
        pytest.param(
            {},
            {"isatty": True},
            False,
            'foo\n{\n  "foo": "bar"\n}\n',
            "",
            id="file-output-is-a-tty",
        ),
        pytest.param(
            {},
            {"isatty": False},
            True,
            'foo\n{\n  "foo": "bar"\n}\n',
            'foo\n{\n  "foo": "bar"\n}\n',
            id="file-output-is-not-a-tty",
        ),
    ],
    indirect=["console_output", "file_output"],
)
def test_streams(
    console_output: ConsoleOutputStream | None,
    file_output: TextIO | None,
    has_file_output: bool,
    expected_console_output: str,
    expected_file_output: str,
):
    console = ConsoleOutput()
    assert console.console_output is None
    assert console.file_output is None

    console.console_output = console_output
    console.file_output = file_output
    assert console.console_output is console_output
    assert console.file_output is (file_output if has_file_output else None)

    console.msg("foo")
    console.json = True
    console.msg_json(foo="bar")
    assert getvalue(console_output) == expected_console_output
    assert getvalue(file_output) == expected_file_output


@pytest.mark.parametrize("method_raises", ["write", "flush"])
def test_broken_stream(monkeypatch: pytest.MonkeyPatch, console_output: ConsoleOutputStream, method_raises: str):
    monkeypatch.setattr(console_output, method_raises, Mock(side_effect=BrokenPipeError))
    console = ConsoleOutput(console_output=console_output)
    console.msg("foo")
    console.msg("bar")


def test_close(console_output: ConsoleOutputStream, file_output: TextIO):
    console = ConsoleOutput(console_output=console_output, file_output=file_output)
    console.msg("foo")
    assert getvalue(console_output) == "foo\n"
    assert getvalue(file_output) == "foo\n"
    assert not console_output.closed
    assert not file_output.closed

    console.close()
    assert console_output.closed
    assert file_output.closed


class TestMessages:
    @pytest.mark.parametrize(
        ("console_output", "expected_console_output", "expected_file_output"),
        [
            pytest.param(
                {"encoding": "utf-8"},
                "Bär: 🐻\n",
                "Bär: 🐻\n",
                id="utf-8 encoding",
            ),
            pytest.param(
                {"encoding": "ascii"},
                "B\\xe4r: \\U0001f43b\n",  # Unicode character: "Bear Face" (U+1F43B)
                "Bär: 🐻\n",
                id="ascii encoding",
            ),
        ],
        indirect=["console_output"],
    )
    def test_no_json(
        self,
        console_output: ConsoleOutputStream,
        file_output: TextIO,
        expected_console_output: str,
        expected_file_output: str,
    ):
        console = ConsoleOutput(console_output=console_output, file_output=file_output)
        console.msg("Bär: 🐻")
        console.msg_json({"test": 1})
        assert getvalue(console_output) == expected_console_output
        assert getvalue(file_output) == expected_file_output

    @pytest.mark.parametrize(
        ("console_output", "expected_console_output", "expected_file_output"),
        [
            pytest.param(
                {"encoding": "utf-8"},
                '{\n  "test": "Bär: 🐻"\n}\n',
                '{\n  "test": "Bär: 🐻"\n}\n',
                id="utf-8 encoding",
            ),
            pytest.param(
                {"encoding": "ascii"},
                '{\n  "test": "B\\u00e4r: \\ud83d\\udc3b"\n}\n',  # Unicode character: "Bear Face" (U+1F43B)
                '{\n  "test": "Bär: 🐻"\n}\n',
                id="ascii encoding",
            ),
        ],
        indirect=["console_output"],
    )
    def test_json(
        self,
        console_output: ConsoleOutputStream,
        file_output: TextIO,
        expected_console_output: str,
        expected_file_output: str,
    ):
        console = ConsoleOutput(console_output=console_output, file_output=file_output, json=True)
        console.msg("foo")
        console.msg_json({"test": "Bär: 🐻"})
        assert getvalue(console_output) == expected_console_output
        assert getvalue(file_output) == expected_file_output

    def test_msg_json_object(self, console_output: ConsoleOutputStream):
        console = ConsoleOutput(console_output=console_output, json=True)
        console.msg_json(Mock(__json__=lambda: {"test": "Hello world, Γειά σου Κόσμε, こんにちは世界"}))  # noqa: RUF001
        assert getvalue(console_output) == '{\n  "test": "Hello world, Γειά σου Κόσμε, こんにちは世界"\n}\n'  # noqa: RUF001

    def test_msg_json_list(self, console_output: ConsoleOutputStream):
        console = ConsoleOutput(console_output=console_output, json=True)
        test_list = ["Hello world, Γειά σου Κόσμε, こんにちは世界", '"🐻"']  # noqa: RUF001
        console.msg_json(test_list)
        assert getvalue(console_output) == '[\n  "Hello world, Γειά σου Κόσμε, こんにちは世界",\n  "\\"🐻\\""\n]\n'  # noqa: RUF001

    def test_msg_json_merge_object(self, console_output: ConsoleOutputStream):
        console = ConsoleOutput(console_output=console_output, json=True)
        test_obj1 = {"test": 1, "foo": "foo"}
        test_obj2 = Mock(__json__=Mock(return_value={"test": 2}))
        console.msg_json(test_obj1, test_obj2, ["qux"], foo="bar", baz="qux")
        assert (
            getvalue(console_output)
            == dedent("""
                {
                  "test": 2,
                  "foo": "bar",
                  "baz": "qux"
                }
            """).lstrip()
        )
        assert list(test_obj1.items()) == [("test", 1), ("foo", "foo")]

    def test_msg_json_merge_list(self, console_output: ConsoleOutputStream):
        console = ConsoleOutput(console_output=console_output, json=True)
        test_list1 = ["foo", "bar"]
        test_list2 = Mock(__json__=Mock(return_value={"foo": "bar"}))
        console.msg_json(test_list1, ["baz"], test_list2, {"foo": "bar"}, foo="bar", baz="qux")
        assert (
            getvalue(console_output)
            == dedent("""
                [
                  "foo",
                  "bar",
                  "baz",
                  {
                    "foo": "bar"
                  },
                  {
                    "foo": "bar"
                  },
                  {
                    "foo": "bar",
                    "baz": "qux"
                  }
                ]
            """).lstrip()
        )
        assert test_list1 == ["foo", "bar"]

    @pytest.mark.parametrize(
        ("json", "supports_status_messages", "expected"),
        [
            pytest.param(True, False, [], id="json-no-status-messages"),
            pytest.param(True, True, [], id="json-status-messages"),
            pytest.param(False, False, [], id="no-json-no-status-messages"),
            pytest.param(False, True, ["foo"], id="no-json-status-messages"),
        ],
    )
    def test_msg_status(
        self,
        monkeypatch: pytest.MonkeyPatch,
        console_output: ConsoleOutputStream,
        json: bool,
        supports_status_messages: bool,
        expected: list[str],
    ):
        writes: list[str] = []
        monkeypatch.setattr(console_output, "supports_status_messages", Mock(return_value=supports_status_messages))
        monkeypatch.setattr(console_output, "write", writes.append)

        console = ConsoleOutput(console_output=console_output, json=json)
        assert console.supports_status_messages() == supports_status_messages
        console.msg_status("foo")
        assert writes == expected


class TestPrompts:
    def test_prompt_exception(self, console_output: ConsoleOutputStream):
        console = ConsoleOutput(console_output=console_output)
        with pytest.raises(BaseException) as exc_info:  # noqa: PT011
            with console._prompt():
                raise EOFError
        assert isinstance(exc_info.value, OSError)
        assert isinstance(exc_info.value.__cause__, EOFError)

    @pytest.mark.parametrize("exception", [OSError, KeyboardInterrupt])
    def test_prompt_exception_passthrough(self, console_output: ConsoleOutputStream, exception: type[Exception]):
        console = ConsoleOutput(console_output=console_output)
        with pytest.raises(BaseException) as exc_info:  # noqa: PT011
            with console._prompt():
                raise exception
        assert isinstance(exc_info.value, exception)

    def test_ask(self, monkeypatch: pytest.MonkeyPatch, console_output: ConsoleOutputStream, file_output: TextIO):
        monkeypatch.setattr("builtins.input", Mock(return_value="hello"))

        console = ConsoleOutput(console_output=console_output, file_output=file_output)
        user_input = ConsoleUserInputRequester(console)
        assert user_input.ask("test") == "hello"
        assert getvalue(console_output) == "test: "
        assert getvalue(file_output) == ""

    @pytest.mark.parametrize(
        ("stdin", "console_output", "expected"),
        [
            pytest.param({"exists": False}, {}, "^No input TTY available$", id="no-stdin"),
            pytest.param({"isatty": False}, {}, "^No input TTY available$", id="stdin-no-tty"),
            pytest.param({}, {"exists": False}, "^No output TTY available$", id="no-output"),
            pytest.param({}, {"isatty": False}, "^No output TTY available$", id="output-no-tty"),
        ],
        indirect=["stdin", "console_output"],
    )
    def test_ask_failure(
        self,
        monkeypatch: pytest.MonkeyPatch,
        stdin: TextIO,
        console_output: ConsoleOutputStream,
        expected: str,
    ):
        mock_input = Mock()
        monkeypatch.setattr("builtins.input", mock_input)

        console = ConsoleOutput(console_output=console_output)
        user_input = ConsoleUserInputRequester(console)
        with pytest.raises(OSError, match=expected):
            user_input.ask("test")
        assert mock_input.call_args_list == []

    def test_ask_password(self, monkeypatch: pytest.MonkeyPatch, console_output: ConsoleOutputStream):
        def getpass(prompt, stream):
            stream.write(prompt)
            stream.flush()

            return "hello"

        monkeypatch.setattr("streamlink_cli.console.console.getpass", getpass)

        console = ConsoleOutput(console_output=console_output)
        user_input = ConsoleUserInputRequester(console)
        assert user_input.ask_password("test") == "hello"
        assert getvalue(console_output) == "test: "

    @pytest.mark.parametrize(
        ("stdin", "console_output", "expected"),
        [
            pytest.param({"exists": False}, {}, "^No input TTY available$", id="no-stdin"),
            pytest.param({"isatty": False}, {}, "^No input TTY available$", id="stdin-no-tty"),
            pytest.param({}, {"exists": False}, "^No output TTY available$", id="no-output"),
            pytest.param({}, {"isatty": False}, "^No output TTY available$", id="output-no-tty"),
        ],
        indirect=["stdin", "console_output"],
    )
    def test_ask_password_failure(
        self,
        monkeypatch: pytest.MonkeyPatch,
        stdin: TextIO,
        console_output: ConsoleOutputStream,
        expected: str,
    ):
        mock_getpass = Mock()
        monkeypatch.setattr("streamlink_cli.console.console.getpass", mock_getpass)

        console = ConsoleOutput(console_output=console_output)
        user_input = ConsoleUserInputRequester(console)
        with pytest.raises(OSError, match=expected):
            user_input.ask_password("test")
        assert mock_getpass.call_args_list == []