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
|
# Copyright 2022-2024 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
#
import os
import pathlib
import sys
import tempfile
from typing import Any
from typing import cast
import pytest
from pytestshellutils.customtypes import EnvironDict
from pytestshellutils.exceptions import FactoryTimeout
from pytestshellutils.shell import Subprocess
from tests.conftest import Tempfiles
@pytest.mark.parametrize("exitcode", [0, 1, 3, 9, 40, 120])
def test_exitcode(exitcode: int, tempfiles: Tempfiles) -> None:
shell = Subprocess()
script = tempfiles.makepyfile(
"""
# coding=utf-8
import time
time.sleep(0.125)
exit({})
""".format(
exitcode
)
)
result = shell.run(sys.executable, script)
assert result.returncode == exitcode
def test_timeout_defined_on_class_instantiation(tempfiles: Tempfiles) -> None:
shell = Subprocess(timeout=0.5)
script = tempfiles.makepyfile(
"""
# coding=utf-8
import time
time.sleep(1)
exit(0)
"""
)
with pytest.raises(FactoryTimeout):
shell.run(sys.executable, script)
def test_timeout_defined_run(tempfiles: Tempfiles) -> None:
shell = Subprocess()
script = tempfiles.makepyfile(
"""
# coding=utf-8
import time
time.sleep(0.5)
exit(0)
"""
)
result = shell.run(sys.executable, script)
assert result.returncode == 0
script = tempfiles.makepyfile(
"""
# coding=utf-8
import time
time.sleep(0.5)
exit(0)
"""
)
with pytest.raises(FactoryTimeout):
shell.run(sys.executable, script, _timeout=0.1)
@pytest.mark.parametrize(
"input_str,expected_object",
[
# Good JSON
('{"a": "a", "1": 1}', {"a": "a", "1": 1}),
# Bad JSON
("{'a': 'a', '1': 1}", None),
],
)
def test_json_output(input_str: str, expected_object: Any, tempfiles: Tempfiles) -> None:
shell = Subprocess()
script = tempfiles.makepyfile(
"""
# coding=utf-8
import sys
sys.stdout.write('''{}''')
exit(0)
""".format(
input_str
)
)
result = shell.run(sys.executable, script)
assert result.returncode == 0
if expected_object:
assert result.data == expected_object
assert result.stdout == input_str
def test_stderr_output(tempfiles: Tempfiles) -> None:
input_str = "Thou shalt not exit cleanly"
shell = Subprocess()
script = tempfiles.makepyfile(
"""
# coding=utf-8
exit("{}")
""".format(
input_str
)
)
result = shell.run(sys.executable, script)
assert result.returncode == 1
assert result.stderr == input_str + "\n"
def test_unicode_output(tempfiles: Tempfiles) -> None:
shell = Subprocess()
script = tempfiles.makepyfile(
r"""
# coding=utf-8
from __future__ import print_function
import sys
sys.stdout.write(u'STDOUT F\xe1tima')
sys.stdout.flush()
sys.stderr.write(u'STDERR F\xe1tima')
sys.stderr.flush()
exit(0)
"""
)
result = shell.run(sys.executable, script)
assert result.returncode == 0, str(result)
assert result.stdout == "STDOUT Fátima"
assert result.stderr == "STDERR Fátima"
def test_process_failed_to_start(tempfiles: Tempfiles) -> None:
shell = Subprocess()
script = tempfiles.makepyfile(
"""
# coding=utf-8
1/0
"""
)
result = shell.run(sys.executable, script)
assert result.returncode == 1
assert "ZeroDivisionError: division by zero" in result.stderr
def test_environ(tempfiles: Tempfiles) -> None:
environ = cast(EnvironDict, os.environ.copy())
environ["FOO"] = "foo"
shell = Subprocess(environ=environ)
script = tempfiles.makepyfile(
"""
# coding=utf-8
import os
import json
print(json.dumps(dict(**os.environ)), flush=True)
exit(0)
"""
)
result = shell.run(sys.executable, script)
assert result.returncode == 0
assert result.data
assert "FOO" in result.data
assert result.data["FOO"] == "foo"
def test_env_in_run_call(tempfiles: Tempfiles) -> None:
env = cast(EnvironDict, {"FOO": "bar"})
environ = cast(EnvironDict, os.environ.copy())
environ["FOO"] = "foo"
shell = Subprocess(environ=environ)
script = tempfiles.makepyfile(
"""
# coding=utf-8
import os
import json
print(json.dumps(dict(**os.environ)), flush=True)
exit(0)
"""
)
result = shell.run(sys.executable, script, env=env)
assert result.returncode == 0
assert result.data
assert "FOO" in result.data
assert result.data["FOO"] == env["FOO"]
def test_not_started() -> None:
shell = Subprocess()
assert shell.is_running() is False
assert not shell.pid
assert shell.terminate() is None
def test_display_name(tempfiles: Tempfiles) -> None:
shell = Subprocess()
assert shell.get_display_name() == "Subprocess()"
script = tempfiles.makepyfile(
"""
# coding=utf-8
import time
time.sleep(0.125)
exit(0)
"""
)
result = shell.run(sys.executable, script)
assert result.returncode == 0
assert shell.get_display_name() == "Subprocess([{!r}, {!r}])".format(sys.executable, script)
def test_run_cwd(tmp_path: str, tempfiles: Tempfiles, shell: Subprocess) -> None:
shell = Subprocess(cwd=tmp_path)
system_tempdir = str(pathlib.Path(tempfile.gettempdir()).resolve())
assert str(shell.cwd.resolve()) != system_tempdir
script = tempfiles.makepyfile(
"""
# coding=utf-8
import pathlib
print(str(pathlib.Path.cwd().resolve()), flush=True)
exit(0)
"""
)
result = shell.run(sys.executable, script, cwd=system_tempdir)
assert result.returncode == 0
assert result.stdout.strip() == system_tempdir
def test_run_shell() -> None:
shell = Subprocess()
with pytest.raises(FileNotFoundError):
shell.run("exit", "0")
with pytest.raises(FileNotFoundError):
shell.run("exit", "0", shell=False)
result = shell.run("exit", "0", shell=True)
assert result.returncode == 0
|
