blob: cf6684d816bcd51b8ec792a9d2af16732a98b26e [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003import subprocess
4import sys
5import signal
6import os
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00007import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00008import tempfile
9import time
Tim Peters3761e8d2004-10-13 04:07:12 +000010import re
Ezio Melotti184bdfb2010-02-18 09:37:05 +000011import sysconfig
Gregory P. Smithd23047b2010-12-04 09:10:44 +000012import warnings
Gregory P. Smith51ee2702010-12-13 07:59:39 +000013import select
Gregory P. Smith32ec9da2010-03-19 16:53:08 +000014try:
15 import gc
16except ImportError:
17 gc = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000018
19mswindows = (sys.platform == "win32")
20
21#
22# Depends on the following external programs: Python
23#
24
25if mswindows:
Tim Peters3b01a702004-10-12 22:19:32 +000026 SETBINARY = ('import msvcrt; msvcrt.setmode(sys.stdout.fileno(), '
27 'os.O_BINARY);')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000028else:
29 SETBINARY = ''
30
Florent Xiclunab1e94e82010-02-27 22:12:37 +000031
32try:
33 mkstemp = tempfile.mkstemp
34except AttributeError:
35 # tempfile.mkstemp is not available
36 def mkstemp():
37 """Replacement for mkstemp, calling mktemp."""
38 fname = tempfile.mktemp()
39 return os.open(fname, os.O_RDWR|os.O_CREAT), fname
40
Tim Peters3761e8d2004-10-13 04:07:12 +000041
Florent Xiclunac049d872010-03-27 22:47:23 +000042class BaseTestCase(unittest.TestCase):
Thomas Wouters0e3f5912006-08-11 14:57:12 +000043 def setUp(self):
44 # Try to minimize the number of children we have so this test
45 # doesn't crash on some buildbots (Alphas in particular).
Florent Xiclunab1e94e82010-02-27 22:12:37 +000046 support.reap_children()
Thomas Wouters0e3f5912006-08-11 14:57:12 +000047
Florent Xiclunaf0cbd822010-03-04 21:50:56 +000048 def tearDown(self):
49 for inst in subprocess._active:
50 inst.wait()
51 subprocess._cleanup()
52 self.assertFalse(subprocess._active, "subprocess._active not empty")
53
Florent Xiclunab1e94e82010-02-27 22:12:37 +000054 def assertStderrEqual(self, stderr, expected, msg=None):
55 # In a debug build, stuff like "[6580 refs]" is printed to stderr at
56 # shutdown time. That frustrates tests trying to check stderr produced
57 # from a spawned Python process.
Antoine Pitrou62f68ed2010-08-04 11:48:56 +000058 actual = support.strip_python_stderr(stderr)
Florent Xiclunab1e94e82010-02-27 22:12:37 +000059 self.assertEqual(actual, expected, msg)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000060
Florent Xiclunac049d872010-03-27 22:47:23 +000061
62class ProcessTestCase(BaseTestCase):
63
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000064 def test_call_seq(self):
Tim Peters7b759da2004-10-12 22:29:54 +000065 # call() function with sequence argument
Tim Peters3b01a702004-10-12 22:19:32 +000066 rc = subprocess.call([sys.executable, "-c",
67 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000068 self.assertEqual(rc, 47)
69
Peter Astrand454f7672005-01-01 09:36:35 +000070 def test_check_call_zero(self):
71 # check_call() function with zero return code
72 rc = subprocess.check_call([sys.executable, "-c",
73 "import sys; sys.exit(0)"])
74 self.assertEqual(rc, 0)
75
76 def test_check_call_nonzero(self):
77 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +000078 with self.assertRaises(subprocess.CalledProcessError) as c:
Peter Astrand454f7672005-01-01 09:36:35 +000079 subprocess.check_call([sys.executable, "-c",
80 "import sys; sys.exit(47)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +000081 self.assertEqual(c.exception.returncode, 47)
Peter Astrand454f7672005-01-01 09:36:35 +000082
Georg Brandlf9734072008-12-07 15:30:06 +000083 def test_check_output(self):
84 # check_output() function with zero return code
85 output = subprocess.check_output(
86 [sys.executable, "-c", "print('BDFL')"])
Benjamin Peterson577473f2010-01-19 00:09:57 +000087 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +000088
89 def test_check_output_nonzero(self):
90 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +000091 with self.assertRaises(subprocess.CalledProcessError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +000092 subprocess.check_output(
93 [sys.executable, "-c", "import sys; sys.exit(5)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +000094 self.assertEqual(c.exception.returncode, 5)
Georg Brandlf9734072008-12-07 15:30:06 +000095
96 def test_check_output_stderr(self):
97 # check_output() function stderr redirected to stdout
98 output = subprocess.check_output(
99 [sys.executable, "-c", "import sys; sys.stderr.write('BDFL')"],
100 stderr=subprocess.STDOUT)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000101 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +0000102
103 def test_check_output_stdout_arg(self):
104 # check_output() function stderr redirected to stdout
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000105 with self.assertRaises(ValueError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +0000106 output = subprocess.check_output(
107 [sys.executable, "-c", "print('will not be run')"],
108 stdout=sys.stdout)
Georg Brandlf9734072008-12-07 15:30:06 +0000109 self.fail("Expected ValueError when stdout arg supplied.")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000110 self.assertIn('stdout', c.exception.args[0])
Georg Brandlf9734072008-12-07 15:30:06 +0000111
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000112 def test_call_kwargs(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000113 # call() function with keyword args
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000114 newenv = os.environ.copy()
115 newenv["FRUIT"] = "banana"
116 rc = subprocess.call([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000117 'import sys, os;'
118 'sys.exit(os.getenv("FRUIT")=="banana")'],
119 env=newenv)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000120 self.assertEqual(rc, 1)
121
122 def test_stdin_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000123 # .stdin is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000124 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000125 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000126 self.addCleanup(p.stdout.close)
127 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000128 p.wait()
129 self.assertEqual(p.stdin, None)
130
131 def test_stdout_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000132 # .stdout is None when not redirected
Tim Peters29b6b4f2004-10-13 03:43:40 +0000133 p = subprocess.Popen([sys.executable, "-c",
Georg Brandl88fc6642007-02-09 21:28:07 +0000134 'print(" this bit of output is from a '
Tim Peters4052fe52004-10-13 03:29:54 +0000135 'test of stdout in a different '
Georg Brandl88fc6642007-02-09 21:28:07 +0000136 'process ...")'],
Tim Peters4052fe52004-10-13 03:29:54 +0000137 stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000138 self.addCleanup(p.stdin.close)
139 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000140 p.wait()
141 self.assertEqual(p.stdout, None)
142
143 def test_stderr_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000144 # .stderr is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000145 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000146 stdin=subprocess.PIPE, stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000147 self.addCleanup(p.stdout.close)
148 self.addCleanup(p.stdin.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000149 p.wait()
150 self.assertEqual(p.stderr, None)
151
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000152 def test_executable_with_cwd(self):
Florent Xicluna1d1ab972010-03-11 01:53:10 +0000153 python_dir = os.path.dirname(os.path.realpath(sys.executable))
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000154 p = subprocess.Popen(["somethingyoudonthave", "-c",
155 "import sys; sys.exit(47)"],
156 executable=sys.executable, cwd=python_dir)
157 p.wait()
158 self.assertEqual(p.returncode, 47)
159
160 @unittest.skipIf(sysconfig.is_python_build(),
161 "need an installed Python. See #7774")
162 def test_executable_without_cwd(self):
163 # For a normal installation, it should work without 'cwd'
164 # argument. For test runs in the build directory, see #7774.
165 p = subprocess.Popen(["somethingyoudonthave", "-c",
166 "import sys; sys.exit(47)"],
Tim Peters3b01a702004-10-12 22:19:32 +0000167 executable=sys.executable)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000168 p.wait()
169 self.assertEqual(p.returncode, 47)
170
171 def test_stdin_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000172 # stdin redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000173 p = subprocess.Popen([sys.executable, "-c",
174 'import sys; sys.exit(sys.stdin.read() == "pear")'],
175 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000176 p.stdin.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000177 p.stdin.close()
178 p.wait()
179 self.assertEqual(p.returncode, 1)
180
181 def test_stdin_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000182 # stdin is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000183 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000184 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000185 d = tf.fileno()
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000186 os.write(d, b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000187 os.lseek(d, 0, 0)
188 p = subprocess.Popen([sys.executable, "-c",
189 'import sys; sys.exit(sys.stdin.read() == "pear")'],
190 stdin=d)
191 p.wait()
192 self.assertEqual(p.returncode, 1)
193
194 def test_stdin_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000195 # stdin is set to open file object
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000196 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000197 self.addCleanup(tf.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000198 tf.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000199 tf.seek(0)
200 p = subprocess.Popen([sys.executable, "-c",
201 'import sys; sys.exit(sys.stdin.read() == "pear")'],
202 stdin=tf)
203 p.wait()
204 self.assertEqual(p.returncode, 1)
205
206 def test_stdout_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000207 # stdout redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000208 p = subprocess.Popen([sys.executable, "-c",
209 'import sys; sys.stdout.write("orange")'],
210 stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000211 self.addCleanup(p.stdout.close)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000212 self.assertEqual(p.stdout.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000213
214 def test_stdout_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000215 # stdout is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000216 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000217 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000218 d = tf.fileno()
219 p = subprocess.Popen([sys.executable, "-c",
220 'import sys; sys.stdout.write("orange")'],
221 stdout=d)
222 p.wait()
223 os.lseek(d, 0, 0)
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000224 self.assertEqual(os.read(d, 1024), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225
226 def test_stdout_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000227 # stdout is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000228 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000229 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000230 p = subprocess.Popen([sys.executable, "-c",
231 'import sys; sys.stdout.write("orange")'],
232 stdout=tf)
233 p.wait()
234 tf.seek(0)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000235 self.assertEqual(tf.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000236
237 def test_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000238 # stderr redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000239 p = subprocess.Popen([sys.executable, "-c",
240 'import sys; sys.stderr.write("strawberry")'],
241 stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000242 self.addCleanup(p.stderr.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000243 self.assertStderrEqual(p.stderr.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000244
245 def test_stderr_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000246 # stderr is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000247 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000248 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000249 d = tf.fileno()
250 p = subprocess.Popen([sys.executable, "-c",
251 'import sys; sys.stderr.write("strawberry")'],
252 stderr=d)
253 p.wait()
254 os.lseek(d, 0, 0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000255 self.assertStderrEqual(os.read(d, 1024), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000256
257 def test_stderr_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000258 # stderr is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000259 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000260 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000261 p = subprocess.Popen([sys.executable, "-c",
262 'import sys; sys.stderr.write("strawberry")'],
263 stderr=tf)
264 p.wait()
265 tf.seek(0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000266 self.assertStderrEqual(tf.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000267
268 def test_stdout_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000269 # capture stdout and stderr to the same pipe
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000270 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000271 'import sys;'
272 'sys.stdout.write("apple");'
273 'sys.stdout.flush();'
274 'sys.stderr.write("orange")'],
275 stdout=subprocess.PIPE,
276 stderr=subprocess.STDOUT)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000277 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000278 self.assertStderrEqual(p.stdout.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000279
280 def test_stdout_stderr_file(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000281 # capture stdout and stderr to the same open file
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000282 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000283 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000284 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000285 'import sys;'
286 'sys.stdout.write("apple");'
287 'sys.stdout.flush();'
288 'sys.stderr.write("orange")'],
289 stdout=tf,
290 stderr=tf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000291 p.wait()
292 tf.seek(0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000293 self.assertStderrEqual(tf.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000294
Thomas Wouters89f507f2006-12-13 04:49:30 +0000295 def test_stdout_filedes_of_stdout(self):
296 # stdout is set to 1 (#1531862).
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000297 cmd = r"import sys, os; sys.exit(os.write(sys.stdout.fileno(), b'.\n'))"
Thomas Wouters89f507f2006-12-13 04:49:30 +0000298 rc = subprocess.call([sys.executable, "-c", cmd], stdout=1)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000299 self.assertEqual(rc, 2)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000300
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000301 def test_cwd(self):
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000302 tmpdir = tempfile.gettempdir()
Peter Astrand195404f2004-11-12 15:51:48 +0000303 # We cannot use os.path.realpath to canonicalize the path,
304 # since it doesn't expand Tru64 {memb} strings. See bug 1063571.
305 cwd = os.getcwd()
306 os.chdir(tmpdir)
307 tmpdir = os.getcwd()
308 os.chdir(cwd)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000309 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000310 'import sys,os;'
311 'sys.stdout.write(os.getcwd())'],
312 stdout=subprocess.PIPE,
313 cwd=tmpdir)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000314 self.addCleanup(p.stdout.close)
Fredrik Lundh59c05592004-10-13 06:55:40 +0000315 normcase = os.path.normcase
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000316 self.assertEqual(normcase(p.stdout.read().decode("utf-8")),
317 normcase(tmpdir))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000318
319 def test_env(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000320 newenv = os.environ.copy()
321 newenv["FRUIT"] = "orange"
322 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000323 'import sys,os;'
324 'sys.stdout.write(os.getenv("FRUIT"))'],
325 stdout=subprocess.PIPE,
326 env=newenv)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000327 self.addCleanup(p.stdout.close)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000328 self.assertEqual(p.stdout.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000329
Peter Astrandcbac93c2005-03-03 20:24:28 +0000330 def test_communicate_stdin(self):
331 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000332 'import sys;'
333 'sys.exit(sys.stdin.read() == "pear")'],
Peter Astrandcbac93c2005-03-03 20:24:28 +0000334 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000335 p.communicate(b"pear")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000336 self.assertEqual(p.returncode, 1)
337
338 def test_communicate_stdout(self):
339 p = subprocess.Popen([sys.executable, "-c",
340 'import sys; sys.stdout.write("pineapple")'],
341 stdout=subprocess.PIPE)
342 (stdout, stderr) = p.communicate()
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000343 self.assertEqual(stdout, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000344 self.assertEqual(stderr, None)
345
346 def test_communicate_stderr(self):
347 p = subprocess.Popen([sys.executable, "-c",
348 'import sys; sys.stderr.write("pineapple")'],
349 stderr=subprocess.PIPE)
350 (stdout, stderr) = p.communicate()
351 self.assertEqual(stdout, None)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000352 self.assertStderrEqual(stderr, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000353
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000354 def test_communicate(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000355 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000356 'import sys,os;'
357 'sys.stderr.write("pineapple");'
358 'sys.stdout.write(sys.stdin.read())'],
359 stdin=subprocess.PIPE,
360 stdout=subprocess.PIPE,
361 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000362 self.addCleanup(p.stdout.close)
363 self.addCleanup(p.stderr.close)
364 self.addCleanup(p.stdin.close)
Georg Brandl1abcbf82008-07-01 19:28:43 +0000365 (stdout, stderr) = p.communicate(b"banana")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000366 self.assertEqual(stdout, b"banana")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000367 self.assertStderrEqual(stderr, b"pineapple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000368
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000369 # Test for the fd leak reported in http://bugs.python.org/issue2791.
370 def test_communicate_pipe_fd_leak(self):
Victor Stinner667d4b52010-12-25 22:40:32 +0000371 for stdin_pipe in (False, True):
372 for stdout_pipe in (False, True):
373 for stderr_pipe in (False, True):
374 options = {}
375 if stdin_pipe:
376 options['stdin'] = subprocess.PIPE
377 if stdout_pipe:
378 options['stdout'] = subprocess.PIPE
379 if stderr_pipe:
380 options['stderr'] = subprocess.PIPE
381 if not options:
382 continue
383 p = subprocess.Popen((sys.executable, "-c", "pass"), **options)
384 p.communicate()
385 if p.stdin is not None:
386 self.assertTrue(p.stdin.closed)
387 if p.stdout is not None:
388 self.assertTrue(p.stdout.closed)
389 if p.stderr is not None:
390 self.assertTrue(p.stderr.closed)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000391
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000392 def test_communicate_returns(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000393 # communicate() should return None if no redirection is active
Tim Peters3b01a702004-10-12 22:19:32 +0000394 p = subprocess.Popen([sys.executable, "-c",
395 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000396 (stdout, stderr) = p.communicate()
397 self.assertEqual(stdout, None)
398 self.assertEqual(stderr, None)
399
400 def test_communicate_pipe_buf(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000401 # communicate() with writes larger than pipe_buf
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000402 # This test will probably deadlock rather than fail, if
Tim Peterse718f612004-10-12 21:51:32 +0000403 # communicate() does not work properly.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000404 x, y = os.pipe()
405 if mswindows:
406 pipe_buf = 512
407 else:
408 pipe_buf = os.fpathconf(x, "PC_PIPE_BUF")
409 os.close(x)
410 os.close(y)
411 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000412 'import sys,os;'
413 'sys.stdout.write(sys.stdin.read(47));'
414 'sys.stderr.write("xyz"*%d);'
415 'sys.stdout.write(sys.stdin.read())' % pipe_buf],
416 stdin=subprocess.PIPE,
417 stdout=subprocess.PIPE,
418 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000419 self.addCleanup(p.stdout.close)
420 self.addCleanup(p.stderr.close)
421 self.addCleanup(p.stdin.close)
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000422 string_to_write = b"abc"*pipe_buf
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000423 (stdout, stderr) = p.communicate(string_to_write)
424 self.assertEqual(stdout, string_to_write)
425
426 def test_writes_before_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000427 # stdin.write before communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000428 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000429 'import sys,os;'
430 'sys.stdout.write(sys.stdin.read())'],
431 stdin=subprocess.PIPE,
432 stdout=subprocess.PIPE,
433 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000434 self.addCleanup(p.stdout.close)
435 self.addCleanup(p.stderr.close)
436 self.addCleanup(p.stdin.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000437 p.stdin.write(b"banana")
438 (stdout, stderr) = p.communicate(b"split")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000439 self.assertEqual(stdout, b"bananasplit")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000440 self.assertStderrEqual(stderr, b"")
Tim Peterse718f612004-10-12 21:51:32 +0000441
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000442 def test_universal_newlines(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000443 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000444 'import sys,os;' + SETBINARY +
445 'sys.stdout.write("line1\\n");'
446 'sys.stdout.flush();'
447 'sys.stdout.write("line2\\n");'
448 'sys.stdout.flush();'
449 'sys.stdout.write("line3\\r\\n");'
450 'sys.stdout.flush();'
451 'sys.stdout.write("line4\\r");'
452 'sys.stdout.flush();'
453 'sys.stdout.write("\\nline5");'
454 'sys.stdout.flush();'
455 'sys.stdout.write("\\nline6");'],
456 stdout=subprocess.PIPE,
457 universal_newlines=1)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000458 self.addCleanup(p.stdout.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000459 stdout = p.stdout.read()
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000460 self.assertEqual(stdout, "line1\nline2\nline3\nline4\nline5\nline6")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000461
462 def test_universal_newlines_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000463 # universal newlines through communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000464 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000465 'import sys,os;' + SETBINARY +
466 'sys.stdout.write("line1\\n");'
467 'sys.stdout.flush();'
468 'sys.stdout.write("line2\\n");'
469 'sys.stdout.flush();'
470 'sys.stdout.write("line3\\r\\n");'
471 'sys.stdout.flush();'
472 'sys.stdout.write("line4\\r");'
473 'sys.stdout.flush();'
474 'sys.stdout.write("\\nline5");'
475 'sys.stdout.flush();'
476 'sys.stdout.write("\\nline6");'],
477 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
478 universal_newlines=1)
Brian Curtin19a53792010-11-05 17:09:05 +0000479 self.addCleanup(p.stdout.close)
480 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000481 (stdout, stderr) = p.communicate()
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000482 self.assertEqual(stdout, "line1\nline2\nline3\nline4\nline5\nline6")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000483
484 def test_no_leaking(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000485 # Make sure we leak no resources
Antoine Pitrou8db30272010-09-18 22:38:48 +0000486 if not mswindows:
Peter Astrandf7f1bb72005-03-03 20:47:37 +0000487 max_handles = 1026 # too much for most UNIX systems
488 else:
Antoine Pitrou8db30272010-09-18 22:38:48 +0000489 max_handles = 2050 # too much for (at least some) Windows setups
490 handles = []
491 try:
492 for i in range(max_handles):
493 try:
494 handles.append(os.open(support.TESTFN,
495 os.O_WRONLY | os.O_CREAT))
496 except OSError as e:
497 if e.errno != errno.EMFILE:
498 raise
499 break
500 else:
501 self.skipTest("failed to reach the file descriptor limit "
502 "(tried %d)" % max_handles)
503 # Close a couple of them (should be enough for a subprocess)
504 for i in range(10):
505 os.close(handles.pop())
506 # Loop creating some subprocesses. If one of them leaks some fds,
507 # the next loop iteration will fail by reaching the max fd limit.
508 for i in range(15):
509 p = subprocess.Popen([sys.executable, "-c",
510 "import sys;"
511 "sys.stdout.write(sys.stdin.read())"],
512 stdin=subprocess.PIPE,
513 stdout=subprocess.PIPE,
514 stderr=subprocess.PIPE)
515 data = p.communicate(b"lime")[0]
516 self.assertEqual(data, b"lime")
517 finally:
518 for h in handles:
519 os.close(h)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000520
521 def test_list2cmdline(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000522 self.assertEqual(subprocess.list2cmdline(['a b c', 'd', 'e']),
523 '"a b c" d e')
524 self.assertEqual(subprocess.list2cmdline(['ab"c', '\\', 'd']),
525 'ab\\"c \\ d')
Christian Heimesfdab48e2008-01-20 09:06:41 +0000526 self.assertEqual(subprocess.list2cmdline(['ab"c', ' \\', 'd']),
527 'ab\\"c " \\\\" d')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000528 self.assertEqual(subprocess.list2cmdline(['a\\\\\\b', 'de fg', 'h']),
529 'a\\\\\\b "de fg" h')
530 self.assertEqual(subprocess.list2cmdline(['a\\"b', 'c', 'd']),
531 'a\\\\\\"b c d')
532 self.assertEqual(subprocess.list2cmdline(['a\\\\b c', 'd', 'e']),
533 '"a\\\\b c" d e')
534 self.assertEqual(subprocess.list2cmdline(['a\\\\b\\ c', 'd', 'e']),
535 '"a\\\\b\\ c" d e')
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000536 self.assertEqual(subprocess.list2cmdline(['ab', '']),
537 'ab ""')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000538
539
540 def test_poll(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000541 p = subprocess.Popen([sys.executable,
Tim Peters29b6b4f2004-10-13 03:43:40 +0000542 "-c", "import time; time.sleep(1)"])
543 count = 0
544 while p.poll() is None:
545 time.sleep(0.1)
546 count += 1
547 # We expect that the poll loop probably went around about 10 times,
548 # but, based on system scheduling we can't control, it's possible
549 # poll() never returned None. It "should be" very rare that it
550 # didn't go around at least twice.
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000551 self.assertGreaterEqual(count, 2)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000552 # Subsequent invocations should just return the returncode
553 self.assertEqual(p.poll(), 0)
554
555
556 def test_wait(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000557 p = subprocess.Popen([sys.executable,
558 "-c", "import time; time.sleep(2)"])
559 self.assertEqual(p.wait(), 0)
560 # Subsequent invocations should just return the returncode
561 self.assertEqual(p.wait(), 0)
Tim Peterse718f612004-10-12 21:51:32 +0000562
Peter Astrand738131d2004-11-30 21:04:45 +0000563
564 def test_invalid_bufsize(self):
565 # an invalid type of the bufsize argument should raise
566 # TypeError.
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000567 with self.assertRaises(TypeError):
Peter Astrand738131d2004-11-30 21:04:45 +0000568 subprocess.Popen([sys.executable, "-c", "pass"], "orange")
Peter Astrand738131d2004-11-30 21:04:45 +0000569
Guido van Rossum46a05a72007-06-07 21:56:45 +0000570 def test_bufsize_is_none(self):
571 # bufsize=None should be the same as bufsize=0.
572 p = subprocess.Popen([sys.executable, "-c", "pass"], None)
573 self.assertEqual(p.wait(), 0)
574 # Again with keyword arg
575 p = subprocess.Popen([sys.executable, "-c", "pass"], bufsize=None)
576 self.assertEqual(p.wait(), 0)
577
Benjamin Petersond75fcb42009-02-19 04:22:03 +0000578 def test_leaking_fds_on_error(self):
579 # see bug #5179: Popen leaks file descriptors to PIPEs if
580 # the child fails to execute; this will eventually exhaust
581 # the maximum number of open fds. 1024 seems a very common
582 # value for that limit, but Windows has 2048, so we loop
583 # 1024 times (each call leaked two fds).
584 for i in range(1024):
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000585 # Windows raises IOError. Others raise OSError.
586 with self.assertRaises(EnvironmentError) as c:
Benjamin Petersond75fcb42009-02-19 04:22:03 +0000587 subprocess.Popen(['nonexisting_i_hope'],
588 stdout=subprocess.PIPE,
589 stderr=subprocess.PIPE)
Antoine Pitrou679e0f22010-09-18 17:56:02 +0000590 if c.exception.errno != errno.ENOENT: # ignore "no such file"
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000591 raise c.exception
Benjamin Petersond75fcb42009-02-19 04:22:03 +0000592
Victor Stinnerb3693582010-05-21 20:13:12 +0000593 def test_issue8780(self):
594 # Ensure that stdout is inherited from the parent
595 # if stdout=PIPE is not used
596 code = ';'.join((
597 'import subprocess, sys',
598 'retcode = subprocess.call('
599 "[sys.executable, '-c', 'print(\"Hello World!\")'])",
600 'assert retcode == 0'))
601 output = subprocess.check_output([sys.executable, '-c', code])
Ezio Melottib3aedd42010-11-20 19:04:17 +0000602 self.assertTrue(output.startswith(b'Hello World!'), ascii(output))
Victor Stinnerb3693582010-05-21 20:13:12 +0000603
Tim Goldenaf5ac392010-08-06 13:03:56 +0000604 def test_handles_closed_on_exception(self):
605 # If CreateProcess exits with an error, ensure the
606 # duplicate output handles are released
607 ifhandle, ifname = mkstemp()
608 ofhandle, ofname = mkstemp()
609 efhandle, efname = mkstemp()
610 try:
611 subprocess.Popen (["*"], stdin=ifhandle, stdout=ofhandle,
612 stderr=efhandle)
613 except OSError:
614 os.close(ifhandle)
615 os.remove(ifname)
616 os.close(ofhandle)
617 os.remove(ofname)
618 os.close(efhandle)
619 os.remove(efname)
620 self.assertFalse(os.path.exists(ifname))
621 self.assertFalse(os.path.exists(ofname))
622 self.assertFalse(os.path.exists(efname))
623
Tim Peterse718f612004-10-12 21:51:32 +0000624
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000625# context manager
626class _SuppressCoreFiles(object):
627 """Try to prevent core files from being created."""
628 old_limit = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000629
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000630 def __enter__(self):
631 """Try to save previous ulimit, then set it to (0, 0)."""
632 try:
633 import resource
634 self.old_limit = resource.getrlimit(resource.RLIMIT_CORE)
635 resource.setrlimit(resource.RLIMIT_CORE, (0, 0))
636 except (ImportError, ValueError, resource.error):
637 pass
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000638
Ronald Oussoren102d11a2010-07-23 09:50:05 +0000639 if sys.platform == 'darwin':
640 # Check if the 'Crash Reporter' on OSX was configured
641 # in 'Developer' mode and warn that it will get triggered
642 # when it is.
643 #
644 # This assumes that this context manager is used in tests
645 # that might trigger the next manager.
646 value = subprocess.Popen(['/usr/bin/defaults', 'read',
647 'com.apple.CrashReporter', 'DialogType'],
648 stdout=subprocess.PIPE).communicate()[0]
649 if value.strip() == b'developer':
650 print("this tests triggers the Crash Reporter, "
651 "that is intentional", end='')
652 sys.stdout.flush()
653
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000654 def __exit__(self, *args):
655 """Return core file behavior to default."""
656 if self.old_limit is None:
657 return
658 try:
659 import resource
660 resource.setrlimit(resource.RLIMIT_CORE, self.old_limit)
661 except (ImportError, ValueError, resource.error):
662 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000663
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000664
Florent Xiclunaf0cbd822010-03-04 21:50:56 +0000665@unittest.skipIf(mswindows, "POSIX specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +0000666class POSIXProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +0000667
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000668 def test_exceptions(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000669 nonexistent_dir = "/_this/pa.th/does/not/exist"
670 try:
671 os.chdir(nonexistent_dir)
672 except OSError as e:
673 # This avoids hard coding the errno value or the OS perror()
674 # string and instead capture the exception that we want to see
675 # below for comparison.
676 desired_exception = e
Benjamin Peterson5f780402010-11-20 18:07:52 +0000677 desired_exception.strerror += ': ' + repr(sys.executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000678 else:
679 self.fail("chdir to nonexistant directory %s succeeded." %
680 nonexistent_dir)
681
682 # Error in the child re-raised in the parent.
683 try:
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000684 p = subprocess.Popen([sys.executable, "-c", ""],
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000685 cwd=nonexistent_dir)
686 except OSError as e:
687 # Test that the child process chdir failure actually makes
688 # it up to the parent process as the correct exception.
689 self.assertEqual(desired_exception.errno, e.errno)
690 self.assertEqual(desired_exception.strerror, e.strerror)
691 else:
692 self.fail("Expected OSError: %s" % desired_exception)
693
694 def test_restore_signals(self):
695 # Code coverage for both values of restore_signals to make sure it
696 # at least does not blow up.
697 # A test for behavior would be complex. Contributions welcome.
698 subprocess.call([sys.executable, "-c", ""], restore_signals=True)
699 subprocess.call([sys.executable, "-c", ""], restore_signals=False)
700
701 def test_start_new_session(self):
702 # For code coverage of calling setsid(). We don't care if we get an
703 # EPERM error from it depending on the test execution environment, that
704 # still indicates that it was called.
705 try:
706 output = subprocess.check_output(
707 [sys.executable, "-c",
708 "import os; print(os.getpgid(os.getpid()))"],
709 start_new_session=True)
710 except OSError as e:
711 if e.errno != errno.EPERM:
712 raise
713 else:
714 parent_pgid = os.getpgid(os.getpid())
715 child_pgid = int(output)
716 self.assertNotEqual(parent_pgid, child_pgid)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000717
718 def test_run_abort(self):
719 # returncode handles signal termination
720 with _SuppressCoreFiles():
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000721 p = subprocess.Popen([sys.executable, "-c",
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000722 'import os; os.abort()'])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000723 p.wait()
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000724 self.assertEqual(-p.returncode, signal.SIGABRT)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000725
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000726 def test_preexec(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000727 # DISCLAIMER: Setting environment variables is *not* a good use
728 # of a preexec_fn. This is merely a test.
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000729 p = subprocess.Popen([sys.executable, "-c",
730 'import sys,os;'
731 'sys.stdout.write(os.getenv("FRUIT"))'],
732 stdout=subprocess.PIPE,
733 preexec_fn=lambda: os.putenv("FRUIT", "apple"))
Brian Curtin3c6a9512010-11-05 03:58:52 +0000734 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000735 self.assertEqual(p.stdout.read(), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000736
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000737 def test_preexec_exception(self):
738 def raise_it():
739 raise ValueError("What if two swallows carried a coconut?")
740 try:
741 p = subprocess.Popen([sys.executable, "-c", ""],
742 preexec_fn=raise_it)
743 except RuntimeError as e:
744 self.assertTrue(
745 subprocess._posixsubprocess,
746 "Expected a ValueError from the preexec_fn")
747 except ValueError as e:
748 self.assertIn("coconut", e.args[0])
749 else:
750 self.fail("Exception raised by preexec_fn did not make it "
751 "to the parent process.")
752
Gregory P. Smith32ec9da2010-03-19 16:53:08 +0000753 @unittest.skipUnless(gc, "Requires a gc module.")
754 def test_preexec_gc_module_failure(self):
755 # This tests the code that disables garbage collection if the child
756 # process will execute any Python.
757 def raise_runtime_error():
758 raise RuntimeError("this shouldn't escape")
759 enabled = gc.isenabled()
760 orig_gc_disable = gc.disable
761 orig_gc_isenabled = gc.isenabled
762 try:
763 gc.disable()
764 self.assertFalse(gc.isenabled())
765 subprocess.call([sys.executable, '-c', ''],
766 preexec_fn=lambda: None)
767 self.assertFalse(gc.isenabled(),
768 "Popen enabled gc when it shouldn't.")
769
770 gc.enable()
771 self.assertTrue(gc.isenabled())
772 subprocess.call([sys.executable, '-c', ''],
773 preexec_fn=lambda: None)
774 self.assertTrue(gc.isenabled(), "Popen left gc disabled.")
775
776 gc.disable = raise_runtime_error
777 self.assertRaises(RuntimeError, subprocess.Popen,
778 [sys.executable, '-c', ''],
779 preexec_fn=lambda: None)
780
781 del gc.isenabled # force an AttributeError
782 self.assertRaises(AttributeError, subprocess.Popen,
783 [sys.executable, '-c', ''],
784 preexec_fn=lambda: None)
785 finally:
786 gc.disable = orig_gc_disable
787 gc.isenabled = orig_gc_isenabled
788 if not enabled:
789 gc.disable()
790
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000791 def test_args_string(self):
792 # args is a string
793 fd, fname = mkstemp()
794 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +0000795 with open(fd, "w", errors="surrogateescape") as fobj:
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000796 fobj.write("#!/bin/sh\n")
797 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
798 sys.executable)
799 os.chmod(fname, 0o700)
800 p = subprocess.Popen(fname)
801 p.wait()
802 os.remove(fname)
803 self.assertEqual(p.returncode, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000804
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000805 def test_invalid_args(self):
806 # invalid arguments should raise ValueError
807 self.assertRaises(ValueError, subprocess.call,
808 [sys.executable, "-c",
809 "import sys; sys.exit(47)"],
810 startupinfo=47)
811 self.assertRaises(ValueError, subprocess.call,
812 [sys.executable, "-c",
813 "import sys; sys.exit(47)"],
814 creationflags=47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000815
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000816 def test_shell_sequence(self):
817 # Run command through the shell (sequence)
818 newenv = os.environ.copy()
819 newenv["FRUIT"] = "apple"
820 p = subprocess.Popen(["echo $FRUIT"], shell=1,
821 stdout=subprocess.PIPE,
822 env=newenv)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000823 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000824 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000825
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000826 def test_shell_string(self):
827 # Run command through the shell (string)
828 newenv = os.environ.copy()
829 newenv["FRUIT"] = "apple"
830 p = subprocess.Popen("echo $FRUIT", shell=1,
831 stdout=subprocess.PIPE,
832 env=newenv)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000833 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000834 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Christian Heimesa342c012008-04-20 21:01:16 +0000835
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000836 def test_call_string(self):
837 # call() function with string argument on UNIX
838 fd, fname = mkstemp()
839 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +0000840 with open(fd, "w", errors="surrogateescape") as fobj:
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000841 fobj.write("#!/bin/sh\n")
842 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
843 sys.executable)
844 os.chmod(fname, 0o700)
845 rc = subprocess.call(fname)
846 os.remove(fname)
847 self.assertEqual(rc, 47)
Christian Heimesa342c012008-04-20 21:01:16 +0000848
Stefan Krah9542cc62010-07-19 14:20:53 +0000849 def test_specific_shell(self):
850 # Issue #9265: Incorrect name passed as arg[0].
851 shells = []
852 for prefix in ['/bin', '/usr/bin/', '/usr/local/bin']:
853 for name in ['bash', 'ksh']:
854 sh = os.path.join(prefix, name)
855 if os.path.isfile(sh):
856 shells.append(sh)
857 if not shells: # Will probably work for any shell but csh.
858 self.skipTest("bash or ksh required for this test")
859 sh = '/bin/sh'
860 if os.path.isfile(sh) and not os.path.islink(sh):
861 # Test will fail if /bin/sh is a symlink to csh.
862 shells.append(sh)
863 for sh in shells:
864 p = subprocess.Popen("echo $0", executable=sh, shell=True,
865 stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000866 self.addCleanup(p.stdout.close)
Stefan Krah9542cc62010-07-19 14:20:53 +0000867 self.assertEqual(p.stdout.read().strip(), bytes(sh, 'ascii'))
868
Florent Xicluna4886d242010-03-08 13:27:26 +0000869 def _kill_process(self, method, *args):
Florent Xicluna1d8ee3a2010-03-05 20:26:54 +0000870 # Do not inherit file handles from the parent.
871 # It should fix failures on some platforms.
Antoine Pitrou3d8580f2010-09-20 01:33:21 +0000872 p = subprocess.Popen([sys.executable, "-c", """if 1:
873 import sys, time
874 sys.stdout.write('x\\n')
875 sys.stdout.flush()
876 time.sleep(30)
877 """],
878 close_fds=True,
879 stdin=subprocess.PIPE,
880 stdout=subprocess.PIPE,
881 stderr=subprocess.PIPE)
882 # Wait for the interpreter to be completely initialized before
883 # sending any signal.
884 p.stdout.read(1)
885 getattr(p, method)(*args)
Florent Xicluna4886d242010-03-08 13:27:26 +0000886 return p
887
888 def test_send_signal(self):
889 p = self._kill_process('send_signal', signal.SIGINT)
Florent Xiclunac049d872010-03-27 22:47:23 +0000890 _, stderr = p.communicate()
891 self.assertIn(b'KeyboardInterrupt', stderr)
Florent Xiclunaf0cbd822010-03-04 21:50:56 +0000892 self.assertNotEqual(p.wait(), 0)
Christian Heimesa342c012008-04-20 21:01:16 +0000893
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000894 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +0000895 p = self._kill_process('kill')
Florent Xiclunac049d872010-03-27 22:47:23 +0000896 _, stderr = p.communicate()
897 self.assertStderrEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000898 self.assertEqual(p.wait(), -signal.SIGKILL)
Tim Peterse718f612004-10-12 21:51:32 +0000899
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000900 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +0000901 p = self._kill_process('terminate')
Florent Xiclunac049d872010-03-27 22:47:23 +0000902 _, stderr = p.communicate()
903 self.assertStderrEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000904 self.assertEqual(p.wait(), -signal.SIGTERM)
905
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000906 def check_close_std_fds(self, fds):
907 # Issue #9905: test that subprocess pipes still work properly with
908 # some standard fds closed
909 stdin = 0
910 newfds = []
911 for a in fds:
912 b = os.dup(a)
913 newfds.append(b)
914 if a == 0:
915 stdin = b
916 try:
917 for fd in fds:
918 os.close(fd)
919 out, err = subprocess.Popen([sys.executable, "-c",
920 'import sys;'
921 'sys.stdout.write("apple");'
922 'sys.stdout.flush();'
923 'sys.stderr.write("orange")'],
924 stdin=stdin,
925 stdout=subprocess.PIPE,
926 stderr=subprocess.PIPE).communicate()
927 err = support.strip_python_stderr(err)
928 self.assertEqual((out, err), (b'apple', b'orange'))
929 finally:
930 for b, a in zip(newfds, fds):
931 os.dup2(b, a)
932 for b in newfds:
933 os.close(b)
934
935 def test_close_fd_0(self):
936 self.check_close_std_fds([0])
937
938 def test_close_fd_1(self):
939 self.check_close_std_fds([1])
940
941 def test_close_fd_2(self):
942 self.check_close_std_fds([2])
943
944 def test_close_fds_0_1(self):
945 self.check_close_std_fds([0, 1])
946
947 def test_close_fds_0_2(self):
948 self.check_close_std_fds([0, 2])
949
950 def test_close_fds_1_2(self):
951 self.check_close_std_fds([1, 2])
952
953 def test_close_fds_0_1_2(self):
954 # Issue #10806: test that subprocess pipes still work properly with
955 # all standard fds closed.
956 self.check_close_std_fds([0, 1, 2])
957
Antoine Pitrou95aaeee2011-01-03 21:15:48 +0000958 def test_remapping_std_fds(self):
959 # open up some temporary files
960 temps = [mkstemp() for i in range(3)]
961 try:
962 temp_fds = [fd for fd, fname in temps]
963
964 # unlink the files -- we won't need to reopen them
965 for fd, fname in temps:
966 os.unlink(fname)
967
968 # write some data to what will become stdin, and rewind
969 os.write(temp_fds[1], b"STDIN")
970 os.lseek(temp_fds[1], 0, 0)
971
972 # move the standard file descriptors out of the way
973 saved_fds = [os.dup(fd) for fd in range(3)]
974 try:
975 # duplicate the file objects over the standard fd's
976 for fd, temp_fd in enumerate(temp_fds):
977 os.dup2(temp_fd, fd)
978
979 # now use those files in the "wrong" order, so that subprocess
980 # has to rearrange them in the child
981 p = subprocess.Popen([sys.executable, "-c",
982 'import sys; got = sys.stdin.read();'
983 'sys.stdout.write("got %s"%got); sys.stderr.write("err")'],
984 stdin=temp_fds[1],
985 stdout=temp_fds[2],
986 stderr=temp_fds[0])
987 p.wait()
988 finally:
989 # restore the original fd's underneath sys.stdin, etc.
990 for std, saved in enumerate(saved_fds):
991 os.dup2(saved, std)
992 os.close(saved)
993
994 for fd in temp_fds:
995 os.lseek(fd, 0, 0)
996
997 out = os.read(temp_fds[2], 1024)
998 err = support.strip_python_stderr(os.read(temp_fds[0], 1024))
999 self.assertEqual(out, b"got STDIN")
1000 self.assertEqual(err, b"err")
1001
1002 finally:
1003 for fd in temp_fds:
1004 os.close(fd)
1005
Victor Stinner13bb71c2010-04-23 21:41:56 +00001006 def test_surrogates_error_message(self):
Victor Stinner4d078042010-04-23 19:28:32 +00001007 def prepare():
1008 raise ValueError("surrogate:\uDCff")
1009
1010 try:
1011 subprocess.call(
1012 [sys.executable, "-c", "pass"],
1013 preexec_fn=prepare)
1014 except ValueError as err:
1015 # Pure Python implementations keeps the message
1016 self.assertIsNone(subprocess._posixsubprocess)
1017 self.assertEqual(str(err), "surrogate:\uDCff")
1018 except RuntimeError as err:
1019 # _posixsubprocess uses a default message
1020 self.assertIsNotNone(subprocess._posixsubprocess)
1021 self.assertEqual(str(err), "Exception occurred in preexec_fn.")
1022 else:
1023 self.fail("Expected ValueError or RuntimeError")
1024
Victor Stinner13bb71c2010-04-23 21:41:56 +00001025 def test_undecodable_env(self):
1026 for key, value in (('test', 'abc\uDCFF'), ('test\uDCFF', '42')):
Victor Stinner13bb71c2010-04-23 21:41:56 +00001027 # test str with surrogates
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00001028 script = "import os; print(ascii(os.getenv(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001029 env = os.environ.copy()
1030 env[key] = value
Victor Stinner89f3ad12010-10-14 10:43:31 +00001031 # Use C locale to get ascii for the locale encoding to force
1032 # surrogate-escaping of \xFF in the child process; otherwise it can
1033 # be decoded as-is if the default locale is latin-1.
Victor Stinnerebc78d22010-10-14 10:38:17 +00001034 env['LC_ALL'] = 'C'
Victor Stinner13bb71c2010-04-23 21:41:56 +00001035 stdout = subprocess.check_output(
1036 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001037 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00001038 stdout = stdout.rstrip(b'\n\r')
Ezio Melottib3aedd42010-11-20 19:04:17 +00001039 self.assertEqual(stdout.decode('ascii'), ascii(value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00001040
1041 # test bytes
1042 key = key.encode("ascii", "surrogateescape")
1043 value = value.encode("ascii", "surrogateescape")
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00001044 script = "import os; print(ascii(os.getenvb(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001045 env = os.environ.copy()
1046 env[key] = value
Victor Stinner13bb71c2010-04-23 21:41:56 +00001047 stdout = subprocess.check_output(
1048 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001049 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00001050 stdout = stdout.rstrip(b'\n\r')
Ezio Melottib3aedd42010-11-20 19:04:17 +00001051 self.assertEqual(stdout.decode('ascii'), ascii(value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00001052
Victor Stinnerb745a742010-05-18 17:17:23 +00001053 def test_bytes_program(self):
1054 abs_program = os.fsencode(sys.executable)
1055 path, program = os.path.split(sys.executable)
1056 program = os.fsencode(program)
1057
1058 # absolute bytes path
1059 exitcode = subprocess.call([abs_program, "-c", "pass"])
Ezio Melottib3aedd42010-11-20 19:04:17 +00001060 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001061
1062 # bytes program, unicode PATH
1063 env = os.environ.copy()
1064 env["PATH"] = path
1065 exitcode = subprocess.call([program, "-c", "pass"], env=env)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001066 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001067
1068 # bytes program, bytes PATH
1069 envb = os.environb.copy()
1070 envb[b"PATH"] = os.fsencode(path)
1071 exitcode = subprocess.call([program, "-c", "pass"], env=envb)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001072 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001073
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001074 def test_pipe_cloexec(self):
1075 sleeper = support.findfile("input_reader.py", subdir="subprocessdata")
1076 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
1077
1078 p1 = subprocess.Popen([sys.executable, sleeper],
1079 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1080 stderr=subprocess.PIPE, close_fds=False)
1081
1082 self.addCleanup(p1.communicate, b'')
1083
1084 p2 = subprocess.Popen([sys.executable, fd_status],
1085 stdout=subprocess.PIPE, close_fds=False)
1086
1087 output, error = p2.communicate()
1088 result_fds = set(map(int, output.split(b',')))
1089 unwanted_fds = set([p1.stdin.fileno(), p1.stdout.fileno(),
1090 p1.stderr.fileno()])
1091
1092 self.assertFalse(result_fds & unwanted_fds,
1093 "Expected no fds from %r to be open in child, "
1094 "found %r" %
1095 (unwanted_fds, result_fds & unwanted_fds))
1096
1097 def test_pipe_cloexec_real_tools(self):
1098 qcat = support.findfile("qcat.py", subdir="subprocessdata")
1099 qgrep = support.findfile("qgrep.py", subdir="subprocessdata")
1100
1101 subdata = b'zxcvbn'
1102 data = subdata * 4 + b'\n'
1103
1104 p1 = subprocess.Popen([sys.executable, qcat],
1105 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1106 close_fds=False)
1107
1108 p2 = subprocess.Popen([sys.executable, qgrep, subdata],
1109 stdin=p1.stdout, stdout=subprocess.PIPE,
1110 close_fds=False)
1111
1112 self.addCleanup(p1.wait)
1113 self.addCleanup(p2.wait)
1114 self.addCleanup(p1.terminate)
1115 self.addCleanup(p2.terminate)
1116
1117 p1.stdin.write(data)
1118 p1.stdin.close()
1119
1120 readfiles, ignored1, ignored2 = select.select([p2.stdout], [], [], 10)
1121
1122 self.assertTrue(readfiles, "The child hung")
1123 self.assertEqual(p2.stdout.read(), data)
1124
Victor Stinnerfaa8c132011-01-03 16:36:00 +00001125 p1.stdout.close()
1126 p2.stdout.close()
1127
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001128 def test_close_fds(self):
1129 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
1130
1131 fds = os.pipe()
1132 self.addCleanup(os.close, fds[0])
1133 self.addCleanup(os.close, fds[1])
1134
1135 open_fds = set(fds)
1136
1137 p = subprocess.Popen([sys.executable, fd_status],
1138 stdout=subprocess.PIPE, close_fds=False)
1139 output, ignored = p.communicate()
1140 remaining_fds = set(map(int, output.split(b',')))
1141
1142 self.assertEqual(remaining_fds & open_fds, open_fds,
1143 "Some fds were closed")
1144
1145 p = subprocess.Popen([sys.executable, fd_status],
1146 stdout=subprocess.PIPE, close_fds=True)
1147 output, ignored = p.communicate()
1148 remaining_fds = set(map(int, output.split(b',')))
1149
1150 self.assertFalse(remaining_fds & open_fds,
1151 "Some fds were left open")
1152 self.assertIn(1, remaining_fds, "Subprocess failed")
1153
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001154 def test_pass_fds(self):
1155 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
1156
1157 open_fds = set()
1158
Antoine Pitroudcdc3b42011-01-03 22:24:52 +00001159 if support.verbose:
1160 print(" -- maxfd =", subprocess.MAXFD)
1161
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001162 for x in range(5):
1163 fds = os.pipe()
1164 self.addCleanup(os.close, fds[0])
1165 self.addCleanup(os.close, fds[1])
1166 open_fds.update(fds)
1167
1168 for fd in open_fds:
1169 p = subprocess.Popen([sys.executable, fd_status],
1170 stdout=subprocess.PIPE, close_fds=True,
1171 pass_fds=(fd, ))
1172 output, ignored = p.communicate()
1173
1174 remaining_fds = set(map(int, output.split(b',')))
1175 to_be_closed = open_fds - {fd}
Antoine Pitrouc43ec082011-01-03 22:12:43 +00001176 # Temporary debug output for intermittent failures
1177 if support.verbose:
1178 print(" -- fds that should have been closed:", to_be_closed)
1179 print(" -- fds that remained open:", remaining_fds)
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001180
1181 self.assertIn(fd, remaining_fds, "fd to be passed not passed")
1182 self.assertFalse(remaining_fds & to_be_closed,
1183 "fd to be closed passed")
1184
1185 # pass_fds overrides close_fds with a warning.
1186 with self.assertWarns(RuntimeWarning) as context:
1187 self.assertFalse(subprocess.call(
1188 [sys.executable, "-c", "import sys; sys.exit(0)"],
1189 close_fds=False, pass_fds=(fd, )))
1190 self.assertIn('overriding close_fds', str(context.warning))
1191
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001192 def test_wait_when_sigchild_ignored(self):
1193 # NOTE: sigchild_ignore.py may not be an effective test on all OSes.
1194 sigchild_ignore = support.findfile("sigchild_ignore.py",
1195 subdir="subprocessdata")
1196 p = subprocess.Popen([sys.executable, sigchild_ignore],
1197 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1198 stdout, stderr = p.communicate()
1199 self.assertEqual(0, p.returncode, "sigchild_ignore.py exited"
Gregory P. Smitha80f4fb2010-12-14 15:23:02 +00001200 " non-zero with this error:\n%s" %
1201 stderr.decode('utf8'))
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001202
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001203
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001204@unittest.skipUnless(mswindows, "Windows specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +00001205class Win32ProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001206
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001207 def test_startupinfo(self):
1208 # startupinfo argument
1209 # We uses hardcoded constants, because we do not want to
1210 # depend on win32all.
1211 STARTF_USESHOWWINDOW = 1
1212 SW_MAXIMIZE = 3
1213 startupinfo = subprocess.STARTUPINFO()
1214 startupinfo.dwFlags = STARTF_USESHOWWINDOW
1215 startupinfo.wShowWindow = SW_MAXIMIZE
1216 # Since Python is a console process, it won't be affected
1217 # by wShowWindow, but the argument should be silently
1218 # ignored
1219 subprocess.call([sys.executable, "-c", "import sys; sys.exit(0)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001220 startupinfo=startupinfo)
1221
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001222 def test_creationflags(self):
1223 # creationflags argument
1224 CREATE_NEW_CONSOLE = 16
1225 sys.stderr.write(" a DOS box should flash briefly ...\n")
1226 subprocess.call(sys.executable +
1227 ' -c "import time; time.sleep(0.25)"',
1228 creationflags=CREATE_NEW_CONSOLE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001229
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001230 def test_invalid_args(self):
1231 # invalid arguments should raise ValueError
1232 self.assertRaises(ValueError, subprocess.call,
1233 [sys.executable, "-c",
1234 "import sys; sys.exit(47)"],
1235 preexec_fn=lambda: 1)
1236 self.assertRaises(ValueError, subprocess.call,
1237 [sys.executable, "-c",
1238 "import sys; sys.exit(47)"],
1239 stdout=subprocess.PIPE,
1240 close_fds=True)
1241
1242 def test_close_fds(self):
1243 # close file descriptors
1244 rc = subprocess.call([sys.executable, "-c",
1245 "import sys; sys.exit(47)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001246 close_fds=True)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001247 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001248
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001249 def test_shell_sequence(self):
1250 # Run command through the shell (sequence)
1251 newenv = os.environ.copy()
1252 newenv["FRUIT"] = "physalis"
1253 p = subprocess.Popen(["set"], shell=1,
1254 stdout=subprocess.PIPE,
1255 env=newenv)
Brian Curtin19a53792010-11-05 17:09:05 +00001256 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001257 self.assertIn(b"physalis", p.stdout.read())
Guido van Rossume7ba4952007-06-06 23:52:48 +00001258
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001259 def test_shell_string(self):
1260 # Run command through the shell (string)
1261 newenv = os.environ.copy()
1262 newenv["FRUIT"] = "physalis"
1263 p = subprocess.Popen("set", shell=1,
1264 stdout=subprocess.PIPE,
1265 env=newenv)
Brian Curtin19a53792010-11-05 17:09:05 +00001266 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001267 self.assertIn(b"physalis", p.stdout.read())
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001268
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001269 def test_call_string(self):
1270 # call() function with string argument on Windows
1271 rc = subprocess.call(sys.executable +
1272 ' -c "import sys; sys.exit(47)"')
1273 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001274
Florent Xicluna4886d242010-03-08 13:27:26 +00001275 def _kill_process(self, method, *args):
1276 # Some win32 buildbot raises EOFError if stdin is inherited
Antoine Pitroua4024e22010-09-24 18:57:01 +00001277 p = subprocess.Popen([sys.executable, "-c", """if 1:
1278 import sys, time
1279 sys.stdout.write('x\\n')
1280 sys.stdout.flush()
1281 time.sleep(30)
1282 """],
1283 stdin=subprocess.PIPE,
1284 stdout=subprocess.PIPE,
1285 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +00001286 self.addCleanup(p.stdout.close)
1287 self.addCleanup(p.stderr.close)
1288 self.addCleanup(p.stdin.close)
Antoine Pitroua4024e22010-09-24 18:57:01 +00001289 # Wait for the interpreter to be completely initialized before
1290 # sending any signal.
1291 p.stdout.read(1)
1292 getattr(p, method)(*args)
Florent Xiclunac049d872010-03-27 22:47:23 +00001293 _, stderr = p.communicate()
1294 self.assertStderrEqual(stderr, b'')
Antoine Pitroua4024e22010-09-24 18:57:01 +00001295 returncode = p.wait()
Florent Xicluna4886d242010-03-08 13:27:26 +00001296 self.assertNotEqual(returncode, 0)
1297
1298 def test_send_signal(self):
1299 self._kill_process('send_signal', signal.SIGTERM)
Christian Heimesa342c012008-04-20 21:01:16 +00001300
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001301 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00001302 self._kill_process('kill')
Christian Heimesa342c012008-04-20 21:01:16 +00001303
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001304 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00001305 self._kill_process('terminate')
Christian Heimesa342c012008-04-20 21:01:16 +00001306
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001307
Brett Cannona23810f2008-05-26 19:04:21 +00001308# The module says:
1309# "NB This only works (and is only relevant) for UNIX."
1310#
1311# Actually, getoutput should work on any platform with an os.popen, but
1312# I'll take the comment as given, and skip this suite.
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001313@unittest.skipUnless(os.name == 'posix', "only relevant for UNIX")
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001314class CommandTests(unittest.TestCase):
1315 def test_getoutput(self):
1316 self.assertEqual(subprocess.getoutput('echo xyzzy'), 'xyzzy')
1317 self.assertEqual(subprocess.getstatusoutput('echo xyzzy'),
1318 (0, 'xyzzy'))
Brett Cannona23810f2008-05-26 19:04:21 +00001319
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001320 # we use mkdtemp in the next line to create an empty directory
1321 # under our exclusive control; from that, we can invent a pathname
1322 # that we _know_ won't exist. This is guaranteed to fail.
1323 dir = None
1324 try:
1325 dir = tempfile.mkdtemp()
1326 name = os.path.join(dir, "foo")
Brett Cannona23810f2008-05-26 19:04:21 +00001327
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001328 status, output = subprocess.getstatusoutput('cat ' + name)
1329 self.assertNotEqual(status, 0)
1330 finally:
1331 if dir is not None:
1332 os.rmdir(dir)
Brett Cannona23810f2008-05-26 19:04:21 +00001333
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001334
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001335@unittest.skipUnless(getattr(subprocess, '_has_poll', False),
1336 "poll system call not supported")
1337class ProcessTestCaseNoPoll(ProcessTestCase):
1338 def setUp(self):
1339 subprocess._has_poll = False
1340 ProcessTestCase.setUp(self)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001341
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001342 def tearDown(self):
1343 subprocess._has_poll = True
1344 ProcessTestCase.tearDown(self)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001345
1346
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001347@unittest.skipUnless(getattr(subprocess, '_posixsubprocess', False),
1348 "_posixsubprocess extension module not found.")
1349class ProcessTestCasePOSIXPurePython(ProcessTestCase, POSIXProcessTestCase):
1350 def setUp(self):
1351 subprocess._posixsubprocess = None
1352 ProcessTestCase.setUp(self)
1353 POSIXProcessTestCase.setUp(self)
1354
1355 def tearDown(self):
1356 subprocess._posixsubprocess = sys.modules['_posixsubprocess']
1357 POSIXProcessTestCase.tearDown(self)
1358 ProcessTestCase.tearDown(self)
1359
1360
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00001361class HelperFunctionTests(unittest.TestCase):
Gregory P. Smithaf6d3b82010-03-01 02:56:44 +00001362 @unittest.skipIf(mswindows, "errno and EINTR make no sense on windows")
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00001363 def test_eintr_retry_call(self):
1364 record_calls = []
1365 def fake_os_func(*args):
1366 record_calls.append(args)
1367 if len(record_calls) == 2:
1368 raise OSError(errno.EINTR, "fake interrupted system call")
1369 return tuple(reversed(args))
1370
1371 self.assertEqual((999, 256),
1372 subprocess._eintr_retry_call(fake_os_func, 256, 999))
1373 self.assertEqual([(256, 999)], record_calls)
1374 # This time there will be an EINTR so it will loop once.
1375 self.assertEqual((666,),
1376 subprocess._eintr_retry_call(fake_os_func, 666))
1377 self.assertEqual([(256, 999), (666,), (666,)], record_calls)
1378
1379
Tim Golden126c2962010-08-11 14:20:40 +00001380@unittest.skipUnless(mswindows, "Windows-specific tests")
1381class CommandsWithSpaces (BaseTestCase):
1382
1383 def setUp(self):
1384 super().setUp()
1385 f, fname = mkstemp(".py", "te st")
1386 self.fname = fname.lower ()
1387 os.write(f, b"import sys;"
1388 b"sys.stdout.write('%d %s' % (len(sys.argv), [a.lower () for a in sys.argv]))"
1389 )
1390 os.close(f)
1391
1392 def tearDown(self):
1393 os.remove(self.fname)
1394 super().tearDown()
1395
1396 def with_spaces(self, *args, **kwargs):
1397 kwargs['stdout'] = subprocess.PIPE
1398 p = subprocess.Popen(*args, **kwargs)
Brian Curtin19a53792010-11-05 17:09:05 +00001399 self.addCleanup(p.stdout.close)
Tim Golden126c2962010-08-11 14:20:40 +00001400 self.assertEqual(
1401 p.stdout.read ().decode("mbcs"),
1402 "2 [%r, 'ab cd']" % self.fname
1403 )
1404
1405 def test_shell_string_with_spaces(self):
1406 # call() function with string argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00001407 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
1408 "ab cd"), shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00001409
1410 def test_shell_sequence_with_spaces(self):
1411 # call() function with sequence argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00001412 self.with_spaces([sys.executable, self.fname, "ab cd"], shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00001413
1414 def test_noshell_string_with_spaces(self):
1415 # call() function with string argument with spaces on Windows
1416 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
1417 "ab cd"))
1418
1419 def test_noshell_sequence_with_spaces(self):
1420 # call() function with sequence argument with spaces on Windows
1421 self.with_spaces([sys.executable, self.fname, "ab cd"])
1422
Brian Curtin79cdb662010-12-03 02:46:02 +00001423
1424class ContextManagerTests(ProcessTestCase):
1425
1426 def test_pipe(self):
1427 with subprocess.Popen([sys.executable, "-c",
1428 "import sys;"
1429 "sys.stdout.write('stdout');"
1430 "sys.stderr.write('stderr');"],
1431 stdout=subprocess.PIPE,
1432 stderr=subprocess.PIPE) as proc:
1433 self.assertEqual(proc.stdout.read(), b"stdout")
1434 self.assertStderrEqual(proc.stderr.read(), b"stderr")
1435
1436 self.assertTrue(proc.stdout.closed)
1437 self.assertTrue(proc.stderr.closed)
1438
1439 def test_returncode(self):
1440 with subprocess.Popen([sys.executable, "-c",
1441 "import sys; sys.exit(100)"]) as proc:
1442 proc.wait()
1443 self.assertEqual(proc.returncode, 100)
1444
1445 def test_communicate_stdin(self):
1446 with subprocess.Popen([sys.executable, "-c",
1447 "import sys;"
1448 "sys.exit(sys.stdin.read() == 'context')"],
1449 stdin=subprocess.PIPE) as proc:
1450 proc.communicate(b"context")
1451 self.assertEqual(proc.returncode, 1)
1452
1453 def test_invalid_args(self):
1454 with self.assertRaises(EnvironmentError) as c:
1455 with subprocess.Popen(['nonexisting_i_hope'],
1456 stdout=subprocess.PIPE,
1457 stderr=subprocess.PIPE) as proc:
1458 pass
1459
1460 if c.exception.errno != errno.ENOENT: # ignore "no such file"
1461 raise c.exception
1462
1463
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001464def test_main():
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001465 unit_tests = (ProcessTestCase,
1466 POSIXProcessTestCase,
1467 Win32ProcessTestCase,
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001468 ProcessTestCasePOSIXPurePython,
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001469 CommandTests,
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00001470 ProcessTestCaseNoPoll,
Tim Golden126c2962010-08-11 14:20:40 +00001471 HelperFunctionTests,
Brian Curtin79cdb662010-12-03 02:46:02 +00001472 CommandsWithSpaces,
Gregory P. Smithf5604852010-12-13 06:45:02 +00001473 ContextManagerTests)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001474
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001475 support.run_unittest(*unit_tests)
Brett Cannona23810f2008-05-26 19:04:21 +00001476 support.reap_children()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001477
1478if __name__ == "__main__":
Brett Cannona23810f2008-05-26 19:04:21 +00001479 test_main()