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
|
from __future__ import annotations
import os
import platform
import sys
from collections.abc import Callable
from pathlib import Path
from subprocess import CalledProcessError
from textwrap import dedent
from typing import Any
import pytest
from pytest import FixtureRequest
from anyio import (
CancelScope,
ClosedResourceError,
create_task_group,
open_process,
run_process,
)
from anyio.streams.buffered import BufferedByteReceiveStream
pytestmark = pytest.mark.anyio
@pytest.mark.parametrize(
"shell, command",
[
pytest.param(
True,
f'{sys.executable} -c "import sys; print(sys.stdin.read()[::-1])"',
id="shell",
),
pytest.param(
False,
[sys.executable, "-c", "import sys; print(sys.stdin.read()[::-1])"],
id="exec",
),
],
)
async def test_run_process(
shell: bool, command: str | list[str], anyio_backend_name: str
) -> None:
process = await run_process(command, input=b"abc")
assert process.returncode == 0
assert process.stdout.rstrip() == b"cba"
async def test_run_process_checked() -> None:
with pytest.raises(CalledProcessError) as exc:
await run_process(
[
sys.executable,
"-c",
'import sys; print("stderr-text", file=sys.stderr); '
'print("stdout-text"); sys.exit(1)',
],
check=True,
)
assert exc.value.returncode == 1
assert exc.value.stdout.rstrip() == b"stdout-text"
assert exc.value.stderr.rstrip() == b"stderr-text"
@pytest.mark.skipif(
platform.system() == "Windows",
reason="process.terminate() kills the process instantly on Windows",
)
async def test_terminate(tmp_path: Path) -> None:
script_path = tmp_path / "script.py"
script_path.write_text(
dedent(
"""\
import signal, sys, time
def terminate(signum, frame):
sys.exit(2)
signal.signal(signal.SIGTERM, terminate)
print('ready', flush=True)
time.sleep(5)
"""
)
)
async with await open_process([sys.executable, str(script_path)]) as process:
stdout = process.stdout
assert stdout is not None
buffered_stdout = BufferedByteReceiveStream(stdout)
line = await buffered_stdout.receive_until(b"\n", 100)
assert line.rstrip() == b"ready"
process.terminate()
assert await process.wait() == 2
async def test_process_cwd(tmp_path: Path) -> None:
"""Test that `cwd` is successfully passed to the subprocess implementation"""
cmd = [sys.executable, "-c", "import os; print(os.getcwd())"]
result = await run_process(cmd, cwd=tmp_path)
assert result.stdout.decode().strip() == str(tmp_path)
async def test_process_env() -> None:
"""Test that `env` is successfully passed to the subprocess implementation"""
env = os.environ.copy()
env.update({"foo": "bar"})
cmd = [sys.executable, "-c", "import os; print(os.environ['foo'])"]
result = await run_process(cmd, env=env)
assert result.stdout.decode().strip() == env["foo"]
@pytest.mark.skipif(
platform.system() == "Windows", reason="Windows does not have os.getsid()"
)
async def test_process_new_session_sid() -> None:
"""
Test that start_new_session is successfully passed to the subprocess implementation.
"""
sid = os.getsid(os.getpid())
cmd = [sys.executable, "-c", "import os; print(os.getsid(os.getpid()))"]
result = await run_process(cmd)
assert result.stdout.decode().strip() == str(sid)
result = await run_process(cmd, start_new_session=True)
assert result.stdout.decode().strip() != str(sid)
async def test_run_process_connect_to_file(tmp_path: Path) -> None:
stdinfile = tmp_path / "stdin"
stdinfile.write_text("Hello, process!\n")
stdoutfile = tmp_path / "stdout"
stderrfile = tmp_path / "stderr"
with (
stdinfile.open("rb") as fin,
stdoutfile.open("wb") as fout,
stderrfile.open("wb") as ferr,
):
async with await open_process(
[
sys.executable,
"-c",
"import sys; txt = sys.stdin.read().strip(); "
'print("stdin says", repr(txt), "but stderr says NO!", '
"file=sys.stderr); "
'print("stdin says", repr(txt), "and stdout says YES!")',
],
stdin=fin,
stdout=fout,
stderr=ferr,
) as p:
assert await p.wait() == 0
assert (
stdoutfile.read_text() == "stdin says 'Hello, process!' and stdout says YES!\n"
)
assert (
stderrfile.read_text() == "stdin says 'Hello, process!' but stderr says NO!\n"
)
async def test_run_process_inherit_stdout(capfd: pytest.CaptureFixture[str]) -> None:
await run_process(
[
sys.executable,
"-c",
'import sys; print("stderr-text", file=sys.stderr); '
'print("stdout-text")',
],
check=True,
stdout=None,
stderr=None,
)
out, err = capfd.readouterr()
assert out == "stdout-text" + os.linesep
assert err == "stderr-text" + os.linesep
async def test_process_aexit_cancellation_doesnt_orphan_process() -> None:
"""
Regression test for #669.
Ensures that open_process.__aexit__() doesn't leave behind an orphan process when
cancelled.
"""
with CancelScope() as scope:
async with await open_process(
[sys.executable, "-c", "import time; time.sleep(1)"]
) as process:
scope.cancel()
assert process.returncode is not None
assert process.returncode != 0
async def test_process_aexit_cancellation_closes_standard_streams(
request: FixtureRequest,
anyio_backend_name: str,
) -> None:
"""
Regression test for #669.
Ensures that open_process.__aexit__() closes standard streams when cancelled. Also
ensures that process.std{in.send,{out,err}.receive}() raise ClosedResourceError on a
closed stream.
"""
if anyio_backend_name == "asyncio":
# Avoid pytest.xfail here due to https://github.com/pytest-dev/pytest/issues/9027
request.node.add_marker(
pytest.mark.xfail(reason="#671 needs to be resolved first")
)
with CancelScope() as scope:
async with await open_process(
[sys.executable, "-c", "import time; time.sleep(1)"]
) as process:
scope.cancel()
assert process.stdin is not None
with pytest.raises(ClosedResourceError):
await process.stdin.send(b"foo")
assert process.stdout is not None
with pytest.raises(ClosedResourceError):
await process.stdout.receive(1)
assert process.stderr is not None
with pytest.raises(ClosedResourceError):
await process.stderr.receive(1)
@pytest.mark.parametrize(
"argname, argvalue_factory",
[
pytest.param(
"user",
lambda: os.getuid(),
id="user",
marks=[
pytest.mark.skipif(
platform.system() == "Windows",
reason="os.getuid() is not available on Windows",
)
],
),
pytest.param(
"group",
lambda: os.getgid(),
id="user",
marks=[
pytest.mark.skipif(
platform.system() == "Windows",
reason="os.getgid() is not available on Windows",
)
],
),
pytest.param("extra_groups", list, id="extra_groups"),
pytest.param("umask", lambda: 0, id="umask"),
],
)
async def test_py39_arguments(
argname: str,
argvalue_factory: Callable[[], Any],
anyio_backend_name: str,
anyio_backend_options: dict[str, Any],
) -> None:
try:
await run_process(
[sys.executable, "-c", "print('hello')"],
**{argname: argvalue_factory()},
)
except ValueError as exc:
if (
"unexpected kwargs" in str(exc)
and anyio_backend_name == "asyncio"
and anyio_backend_options["loop_factory"]
and anyio_backend_options["loop_factory"].__module__ == "uvloop"
):
pytest.skip(f"the {argname!r} argument is not supported by uvloop yet")
raise
async def test_close_early() -> None:
"""Regression test for #490."""
code = dedent("""\
import sys
for _ in range(100):
sys.stdout.buffer.write(bytes(range(256)))
""")
async with await open_process([sys.executable, "-c", code]):
pass
async def test_close_while_reading() -> None:
code = dedent("""\
import time
time.sleep(3)
""")
async with (
await open_process([sys.executable, "-c", code]) as process,
create_task_group() as tg,
):
assert process.stdout
tg.start_soon(process.stdout.aclose)
with pytest.raises(ClosedResourceError):
await process.stdout.receive()
process.terminate()
|