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
|
from __future__ import annotations
import sys
from typing import TYPE_CHECKING
from unittest.mock import Mock, call
import pytest
import trio
from trio.testing import wait_all_tasks_blocked
from streamlink.compat import ExceptionGroup
from streamlink.utils.processoutput import ProcessOutput
if TYPE_CHECKING:
from collections.abc import Awaitable, Callable
from trio.testing import MockClock
TIME_TEST_MAX = 10
# language=python
CODE = """
import signal
import sys
if sys.argv[-1] == "ignoresigterm":
signal.signal(signal.SIGTERM, signal.SIG_IGN)
while line := sys.stdin.readline():
if line[:5] == "exit:":
sys.exit(int(line[5:]))
stream = sys.stdout if line[:7] == "stdout:" else sys.stderr
stream.write(line[7:])
stream.flush()
""".strip()
class FakeProcessOutput(ProcessOutput):
onexit: Mock
onstdout: Mock
onstderr: Mock
onoutput_sender: trio.MemorySendChannel[tuple[str, str]]
onoutput_receiver: trio.MemoryReceiveChannel[tuple[str, str]]
def __init__(self, *args, ignoresigterm: bool = False, **kwargs):
command = [sys.executable, "-c", CODE]
if ignoresigterm:
command.append("ignoresigterm")
kwargs.setdefault("command", command)
super().__init__(*args, **kwargs)
self.onoutput_sender, self.onoutput_receiver = trio.open_memory_channel(10)
def _onoutput(channel, meth):
def _inner(*_args, **_kwargs):
res = meth(*_args, **_kwargs)
try:
return res
finally:
self.onoutput_sender.send_nowait((channel, res))
return _inner
self.onexit = Mock(side_effect=self.onexit)
self.onstdout = Mock(side_effect=_onoutput("stdout", self.onstdout))
self.onstderr = Mock(side_effect=_onoutput("stderr", self.onstderr))
@pytest.fixture()
async def _max_test_time(nursery: trio.Nursery, mock_clock: MockClock): # noqa: RUF029
async def timeout(): # pragma: no cover
await trio.sleep(TIME_TEST_MAX)
mock_clock.autojump_threshold = 0
pytest.fail("Test timed out")
nursery.start_soon(timeout)
@pytest.fixture()
def get_process(monkeypatch: pytest.MonkeyPatch, _max_test_time) -> Callable[[], Awaitable[trio.Process]]:
trio_run_process = trio.run_process
# use a memory channel, so we can wait until the process has launched
sender: trio.MemorySendChannel[trio.Process]
receiver: trio.MemoryReceiveChannel[trio.Process]
sender, receiver = trio.open_memory_channel(1)
async def get_process() -> trio.Process:
return await receiver.receive()
async def fake_trio_run_process(*args, task_status, **kwargs):
task_status_started = task_status.started
def fake_task_status_started(process: trio.Process):
task_status_started(process)
sender.send_nowait(process)
# intercept the task status report
task_status.started = fake_task_status_started
return await trio_run_process(*args, task_status=task_status, **kwargs)
monkeypatch.setattr("trio.run_process", fake_trio_run_process)
return get_process
@pytest.mark.trio()
@pytest.mark.usefixtures("_max_test_time")
async def test_ontimeout(mock_clock: MockClock) -> None:
po = FakeProcessOutput(timeout=2)
result = None
async def run():
nonlocal result
result = await po.arun()
async with trio.open_nursery() as nursery:
nursery.start_soon(run)
await wait_all_tasks_blocked()
assert result is None
mock_clock.jump(4)
assert result is False
assert po.onexit.call_args_list == []
assert po.onstdout.call_args_list == []
assert po.onstderr.call_args_list == []
@pytest.mark.trio()
@pytest.mark.parametrize(
("exit_code", "expected"),
[
pytest.param(0, True, id="success"),
pytest.param(1, False, id="failure"),
],
)
async def test_exit_code(get_process: Callable[[], Awaitable[trio.Process]], exit_code: int, expected: bool):
po = FakeProcessOutput(timeout=4)
result = None
async def run():
nonlocal result
result = await po.arun()
async with trio.open_nursery() as nursery:
nursery.start_soon(run)
process = await get_process()
assert process.stdin
await process.stdin.send_all(f"exit:{exit_code}\n".encode())
assert result is expected
assert po.onexit.call_args_list == [call(exit_code)]
assert po.onstdout.call_args_list == []
assert po.onstderr.call_args_list == []
@pytest.mark.trio()
async def test_stdout_stderr(get_process: Callable[[], Awaitable[trio.Process]]):
po = FakeProcessOutput(timeout=4)
result = None
async def run():
nonlocal result
result = await po.arun()
async with trio.open_nursery() as nursery:
nursery.start_soon(run)
process = await get_process()
assert process.stdin
assert po.onstdout.call_args_list == []
assert po.onstderr.call_args_list == []
await process.stdin.send_all(b"stdout:foo\n")
assert await po.onoutput_receiver.receive() == ("stdout", None)
assert po.onstdout.call_args_list == [call(0, "foo")]
assert po.onstderr.call_args_list == []
await process.stdin.send_all(b"stderr:bar\n")
assert await po.onoutput_receiver.receive() == ("stderr", None)
assert po.onstdout.call_args_list == [call(0, "foo")]
assert po.onstderr.call_args_list == [call(0, "bar")]
# order of items in receive stream is not guaranteed
await process.stdin.send_all(b"stdout:123\nstderr:456\n")
received = []
for _ in range(2):
received.append(await po.onoutput_receiver.receive())
received.sort(key=lambda elem: elem[0])
assert received == [("stderr", None), ("stdout", None)]
await process.stdin.send_all(b"exit:0\n")
assert result is True
assert po.onexit.call_args_list == [call(0)]
assert po.onstdout.call_args_list == [call(0, "foo"), call(1, "123")]
assert po.onstderr.call_args_list == [call(0, "bar"), call(1, "456")]
@pytest.mark.trio()
@pytest.mark.parametrize(
("expected", "return_value"),
[
pytest.param("yes", True, id="success"),
pytest.param("no", False, id="failure"),
],
)
@pytest.mark.parametrize("channel", ["stdout", "stderr"])
async def test_output_callback(
get_process: Callable[[], Awaitable[trio.Process]],
expected: str,
return_value: bool,
channel: str,
):
class CustomProcessOutput(ProcessOutput):
def onstdout(self, idx: int, line: str) -> bool:
return line == expected
def onstderr(self, idx: int, line: str) -> bool:
return line == expected
class CustomFakeProcessOutput(FakeProcessOutput, CustomProcessOutput):
pass
po = CustomFakeProcessOutput(timeout=4)
result = None
async def run():
nonlocal result
result = await po.arun()
async with trio.open_nursery() as nursery:
nursery.start_soon(run)
process = await get_process()
assert process.stdin
await process.stdin.send_all(f"{channel}:yes\n".encode())
assert await po.onoutput_receiver.receive() == (channel, return_value)
await process.stdin.send_all(b"exit:0\n")
assert result is return_value
assert po.onexit.call_args_list == []
assert po.onstdout.call_args_list == ([call(0, "yes")] if channel == "stdout" else [])
assert po.onstderr.call_args_list == ([call(0, "yes")] if channel == "stderr" else [])
@pytest.mark.trio()
async def test_output_exception(get_process: Callable[[], Awaitable[trio.Process]]):
class CustomProcessOutput(ProcessOutput):
def onstdout(self, idx: int, line: str) -> bool:
raise ZeroDivisionError()
class CustomFakeProcessOutput(FakeProcessOutput, CustomProcessOutput):
pass
po = CustomFakeProcessOutput(timeout=4)
# noinspection PyUnusedLocal
process: trio.Process | None = None
with pytest.raises(ExceptionGroup) as exc_info: # noqa: PT012
async with trio.open_nursery() as nursery:
nursery.start_soon(po.arun)
process = await get_process()
assert process.stdin
await process.stdin.send_all(b"stdout:foo\n")
assert await po.onoutput_receiver.receive() == ("stdout", None)
assert process
assert process.poll() is not None
assert exc_info.group_contains(ZeroDivisionError)
@pytest.mark.posix_only()
@pytest.mark.trio()
async def test_kill(monkeypatch: pytest.MonkeyPatch, mock_clock: MockClock, get_process: Callable[[], Awaitable[trio.Process]]):
po = FakeProcessOutput(timeout=2, wait_terminate=4, ignoresigterm=True)
result = None
async def run():
nonlocal result
result = await po.arun()
async with trio.open_nursery() as nursery:
nursery.start_soon(run)
process = await get_process()
assert process.poll() is None
assert process.stdin
# ensure that our Python subprocess has fully initialized and updated its SIGTERM signal handler
await process.stdin.send_all(b"stdout:OK\n")
assert await po.onoutput_receiver.receive() == ("stdout", None)
assert po.onstdout.call_args_list == [call(0, "OK")]
po.onstdout.call_args_list.clear()
mock_terminate = Mock(side_effect=process.terminate)
mock_kill = Mock(side_effect=process.kill)
monkeypatch.setattr(process, "terminate", mock_terminate)
monkeypatch.setattr(process, "kill", mock_kill)
mock_clock.jump(po.timeout)
await wait_all_tasks_blocked()
assert process.poll() is None
assert mock_terminate.call_count == 1
assert mock_kill.call_count == 0
await wait_all_tasks_blocked()
assert process.poll() is None
mock_clock.jump(po.wait_terminate)
await wait_all_tasks_blocked()
assert mock_terminate.call_count == 1
assert mock_kill.call_count == 1
mock_clock.rate = 1
assert result is False
assert po.onexit.call_args_list == []
assert po.onstdout.call_args_list == []
assert po.onstderr.call_args_list == []
|
