blob: 23325f49eebb5a40ec02a819efe1f12da3b6e045 [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
Gregory P. Smithe14e9c22011-03-15 14:55:17 -04006import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00007import os
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00008import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009import tempfile
10import time
Tim Peters3761e8d2004-10-13 04:07:12 +000011import re
Ezio Melotti184bdfb2010-02-18 09:37:05 +000012import sysconfig
Gregory P. Smithd23047b2010-12-04 09:10:44 +000013import warnings
Gregory P. Smith51ee2702010-12-13 07:59:39 +000014import select
Gregory P. Smith81ce6852011-03-15 02:04:11 -040015import shutil
Gregory P. Smith32ec9da2010-03-19 16:53:08 +000016try:
17 import gc
18except ImportError:
19 gc = None
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000020
21mswindows = (sys.platform == "win32")
22
23#
24# Depends on the following external programs: Python
25#
26
27if mswindows:
Tim Peters3b01a702004-10-12 22:19:32 +000028 SETBINARY = ('import msvcrt; msvcrt.setmode(sys.stdout.fileno(), '
29 'os.O_BINARY);')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000030else:
31 SETBINARY = ''
32
Florent Xiclunab1e94e82010-02-27 22:12:37 +000033
34try:
35 mkstemp = tempfile.mkstemp
36except AttributeError:
37 # tempfile.mkstemp is not available
38 def mkstemp():
39 """Replacement for mkstemp, calling mktemp."""
40 fname = tempfile.mktemp()
41 return os.open(fname, os.O_RDWR|os.O_CREAT), fname
42
Tim Peters3761e8d2004-10-13 04:07:12 +000043
Florent Xiclunac049d872010-03-27 22:47:23 +000044class BaseTestCase(unittest.TestCase):
Thomas Wouters0e3f5912006-08-11 14:57:12 +000045 def setUp(self):
46 # Try to minimize the number of children we have so this test
47 # doesn't crash on some buildbots (Alphas in particular).
Florent Xiclunab1e94e82010-02-27 22:12:37 +000048 support.reap_children()
Thomas Wouters0e3f5912006-08-11 14:57:12 +000049
Florent Xiclunaf0cbd822010-03-04 21:50:56 +000050 def tearDown(self):
51 for inst in subprocess._active:
52 inst.wait()
53 subprocess._cleanup()
54 self.assertFalse(subprocess._active, "subprocess._active not empty")
55
Florent Xiclunab1e94e82010-02-27 22:12:37 +000056 def assertStderrEqual(self, stderr, expected, msg=None):
57 # In a debug build, stuff like "[6580 refs]" is printed to stderr at
58 # shutdown time. That frustrates tests trying to check stderr produced
59 # from a spawned Python process.
Antoine Pitrou62f68ed2010-08-04 11:48:56 +000060 actual = support.strip_python_stderr(stderr)
Florent Xiclunab1e94e82010-02-27 22:12:37 +000061 self.assertEqual(actual, expected, msg)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000062
Florent Xiclunac049d872010-03-27 22:47:23 +000063
64class ProcessTestCase(BaseTestCase):
65
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000066 def test_call_seq(self):
Tim Peters7b759da2004-10-12 22:29:54 +000067 # call() function with sequence argument
Tim Peters3b01a702004-10-12 22:19:32 +000068 rc = subprocess.call([sys.executable, "-c",
69 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000070 self.assertEqual(rc, 47)
71
Peter Astrand454f7672005-01-01 09:36:35 +000072 def test_check_call_zero(self):
73 # check_call() function with zero return code
74 rc = subprocess.check_call([sys.executable, "-c",
75 "import sys; sys.exit(0)"])
76 self.assertEqual(rc, 0)
77
78 def test_check_call_nonzero(self):
79 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +000080 with self.assertRaises(subprocess.CalledProcessError) as c:
Peter Astrand454f7672005-01-01 09:36:35 +000081 subprocess.check_call([sys.executable, "-c",
82 "import sys; sys.exit(47)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +000083 self.assertEqual(c.exception.returncode, 47)
Peter Astrand454f7672005-01-01 09:36:35 +000084
Georg Brandlf9734072008-12-07 15:30:06 +000085 def test_check_output(self):
86 # check_output() function with zero return code
87 output = subprocess.check_output(
88 [sys.executable, "-c", "print('BDFL')"])
Benjamin Peterson577473f2010-01-19 00:09:57 +000089 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +000090
91 def test_check_output_nonzero(self):
92 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +000093 with self.assertRaises(subprocess.CalledProcessError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +000094 subprocess.check_output(
95 [sys.executable, "-c", "import sys; sys.exit(5)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +000096 self.assertEqual(c.exception.returncode, 5)
Georg Brandlf9734072008-12-07 15:30:06 +000097
98 def test_check_output_stderr(self):
99 # check_output() function stderr redirected to stdout
100 output = subprocess.check_output(
101 [sys.executable, "-c", "import sys; sys.stderr.write('BDFL')"],
102 stderr=subprocess.STDOUT)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000103 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +0000104
105 def test_check_output_stdout_arg(self):
106 # check_output() function stderr redirected to stdout
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000107 with self.assertRaises(ValueError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +0000108 output = subprocess.check_output(
109 [sys.executable, "-c", "print('will not be run')"],
110 stdout=sys.stdout)
Georg Brandlf9734072008-12-07 15:30:06 +0000111 self.fail("Expected ValueError when stdout arg supplied.")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000112 self.assertIn('stdout', c.exception.args[0])
Georg Brandlf9734072008-12-07 15:30:06 +0000113
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000114 def test_call_kwargs(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000115 # call() function with keyword args
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000116 newenv = os.environ.copy()
117 newenv["FRUIT"] = "banana"
118 rc = subprocess.call([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000119 'import sys, os;'
120 'sys.exit(os.getenv("FRUIT")=="banana")'],
121 env=newenv)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000122 self.assertEqual(rc, 1)
123
Victor Stinner87b9bc32011-06-01 00:57:47 +0200124 def test_invalid_args(self):
125 # Popen() called with invalid arguments should raise TypeError
126 # but Popen.__del__ should not complain (issue #12085)
127 with support.captured_stderr() as s:
128 self.assertRaises(TypeError, subprocess.Popen, invalid_arg_name=1)
129 argcount = subprocess.Popen.__init__.__code__.co_argcount
130 too_many_args = [0] * (argcount + 1)
131 self.assertRaises(TypeError, subprocess.Popen, *too_many_args)
132 self.assertEqual(s.getvalue(), '')
133
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000134 def test_stdin_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000135 # .stdin is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000136 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000137 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000138 self.addCleanup(p.stdout.close)
139 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000140 p.wait()
141 self.assertEqual(p.stdin, None)
142
143 def test_stdout_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000144 # .stdout is None when not redirected
Tim Peters29b6b4f2004-10-13 03:43:40 +0000145 p = subprocess.Popen([sys.executable, "-c",
Georg Brandl88fc6642007-02-09 21:28:07 +0000146 'print(" this bit of output is from a '
Tim Peters4052fe52004-10-13 03:29:54 +0000147 'test of stdout in a different '
Georg Brandl88fc6642007-02-09 21:28:07 +0000148 'process ...")'],
Tim Peters4052fe52004-10-13 03:29:54 +0000149 stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000150 self.addCleanup(p.stdin.close)
151 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000152 p.wait()
153 self.assertEqual(p.stdout, None)
154
155 def test_stderr_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000156 # .stderr is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000157 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000158 stdin=subprocess.PIPE, stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000159 self.addCleanup(p.stdout.close)
160 self.addCleanup(p.stdin.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000161 p.wait()
162 self.assertEqual(p.stderr, None)
163
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000164 def test_executable_with_cwd(self):
Florent Xicluna1d1ab972010-03-11 01:53:10 +0000165 python_dir = os.path.dirname(os.path.realpath(sys.executable))
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000166 p = subprocess.Popen(["somethingyoudonthave", "-c",
167 "import sys; sys.exit(47)"],
168 executable=sys.executable, cwd=python_dir)
169 p.wait()
170 self.assertEqual(p.returncode, 47)
171
172 @unittest.skipIf(sysconfig.is_python_build(),
173 "need an installed Python. See #7774")
174 def test_executable_without_cwd(self):
175 # For a normal installation, it should work without 'cwd'
176 # argument. For test runs in the build directory, see #7774.
177 p = subprocess.Popen(["somethingyoudonthave", "-c",
178 "import sys; sys.exit(47)"],
Tim Peters3b01a702004-10-12 22:19:32 +0000179 executable=sys.executable)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000180 p.wait()
181 self.assertEqual(p.returncode, 47)
182
183 def test_stdin_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000184 # stdin redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000185 p = subprocess.Popen([sys.executable, "-c",
186 'import sys; sys.exit(sys.stdin.read() == "pear")'],
187 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000188 p.stdin.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000189 p.stdin.close()
190 p.wait()
191 self.assertEqual(p.returncode, 1)
192
193 def test_stdin_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000194 # stdin is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000195 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000196 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000197 d = tf.fileno()
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000198 os.write(d, b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000199 os.lseek(d, 0, 0)
200 p = subprocess.Popen([sys.executable, "-c",
201 'import sys; sys.exit(sys.stdin.read() == "pear")'],
202 stdin=d)
203 p.wait()
204 self.assertEqual(p.returncode, 1)
205
206 def test_stdin_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000207 # stdin is set to open file object
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000208 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000209 self.addCleanup(tf.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000210 tf.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000211 tf.seek(0)
212 p = subprocess.Popen([sys.executable, "-c",
213 'import sys; sys.exit(sys.stdin.read() == "pear")'],
214 stdin=tf)
215 p.wait()
216 self.assertEqual(p.returncode, 1)
217
218 def test_stdout_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000219 # stdout redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000220 p = subprocess.Popen([sys.executable, "-c",
221 'import sys; sys.stdout.write("orange")'],
222 stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000223 self.addCleanup(p.stdout.close)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000224 self.assertEqual(p.stdout.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000225
226 def test_stdout_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000227 # stdout is set to open file descriptor
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 d = tf.fileno()
231 p = subprocess.Popen([sys.executable, "-c",
232 'import sys; sys.stdout.write("orange")'],
233 stdout=d)
234 p.wait()
235 os.lseek(d, 0, 0)
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000236 self.assertEqual(os.read(d, 1024), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000237
238 def test_stdout_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000239 # stdout is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000240 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000241 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000242 p = subprocess.Popen([sys.executable, "-c",
243 'import sys; sys.stdout.write("orange")'],
244 stdout=tf)
245 p.wait()
246 tf.seek(0)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000247 self.assertEqual(tf.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000248
249 def test_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000250 # stderr redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000251 p = subprocess.Popen([sys.executable, "-c",
252 'import sys; sys.stderr.write("strawberry")'],
253 stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000254 self.addCleanup(p.stderr.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000255 self.assertStderrEqual(p.stderr.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000256
257 def test_stderr_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000258 # stderr is set to open file descriptor
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 d = tf.fileno()
262 p = subprocess.Popen([sys.executable, "-c",
263 'import sys; sys.stderr.write("strawberry")'],
264 stderr=d)
265 p.wait()
266 os.lseek(d, 0, 0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000267 self.assertStderrEqual(os.read(d, 1024), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000268
269 def test_stderr_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000270 # stderr is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000271 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000272 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000273 p = subprocess.Popen([sys.executable, "-c",
274 'import sys; sys.stderr.write("strawberry")'],
275 stderr=tf)
276 p.wait()
277 tf.seek(0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000278 self.assertStderrEqual(tf.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000279
280 def test_stdout_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000281 # capture stdout and stderr to the same pipe
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000282 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000283 'import sys;'
284 'sys.stdout.write("apple");'
285 'sys.stdout.flush();'
286 'sys.stderr.write("orange")'],
287 stdout=subprocess.PIPE,
288 stderr=subprocess.STDOUT)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000289 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000290 self.assertStderrEqual(p.stdout.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000291
292 def test_stdout_stderr_file(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000293 # capture stdout and stderr to the same open file
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000294 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000295 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000296 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000297 'import sys;'
298 'sys.stdout.write("apple");'
299 'sys.stdout.flush();'
300 'sys.stderr.write("orange")'],
301 stdout=tf,
302 stderr=tf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000303 p.wait()
304 tf.seek(0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000305 self.assertStderrEqual(tf.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000306
Thomas Wouters89f507f2006-12-13 04:49:30 +0000307 def test_stdout_filedes_of_stdout(self):
308 # stdout is set to 1 (#1531862).
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000309 cmd = r"import sys, os; sys.exit(os.write(sys.stdout.fileno(), b'.\n'))"
Thomas Wouters89f507f2006-12-13 04:49:30 +0000310 rc = subprocess.call([sys.executable, "-c", cmd], stdout=1)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000311 self.assertEqual(rc, 2)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000312
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000313 def test_cwd(self):
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000314 tmpdir = tempfile.gettempdir()
Peter Astrand195404f2004-11-12 15:51:48 +0000315 # We cannot use os.path.realpath to canonicalize the path,
316 # since it doesn't expand Tru64 {memb} strings. See bug 1063571.
317 cwd = os.getcwd()
318 os.chdir(tmpdir)
319 tmpdir = os.getcwd()
320 os.chdir(cwd)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000321 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322 'import sys,os;'
323 'sys.stdout.write(os.getcwd())'],
324 stdout=subprocess.PIPE,
325 cwd=tmpdir)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000326 self.addCleanup(p.stdout.close)
Fredrik Lundh59c05592004-10-13 06:55:40 +0000327 normcase = os.path.normcase
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000328 self.assertEqual(normcase(p.stdout.read().decode("utf-8")),
329 normcase(tmpdir))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000330
331 def test_env(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000332 newenv = os.environ.copy()
333 newenv["FRUIT"] = "orange"
Victor Stinnerf1512a22011-06-21 17:18:38 +0200334 with subprocess.Popen([sys.executable, "-c",
335 'import sys,os;'
336 'sys.stdout.write(os.getenv("FRUIT"))'],
337 stdout=subprocess.PIPE,
338 env=newenv) as p:
339 stdout, stderr = p.communicate()
340 self.assertEqual(stdout, b"orange")
341
Victor Stinner237e5cb2011-06-22 21:28:43 +0200342 @unittest.skipIf(sysconfig.get_config_var('Py_ENABLE_SHARED') is not None,
Victor Stinner372309a2011-06-21 21:59:06 +0200343 'the python library cannot be loaded '
344 'with an empty environment')
Victor Stinnerf1512a22011-06-21 17:18:38 +0200345 def test_empty_env(self):
346 with subprocess.Popen([sys.executable, "-c",
347 'import os; '
Victor Stinner372309a2011-06-21 21:59:06 +0200348 'print(list(os.environ.keys()))'],
Victor Stinnerf1512a22011-06-21 17:18:38 +0200349 stdout=subprocess.PIPE,
350 env={}) as p:
351 stdout, stderr = p.communicate()
Victor Stinner237e5cb2011-06-22 21:28:43 +0200352 self.assertIn(stdout.strip(),
353 (b"[]",
354 # Mac OS X adds __CF_USER_TEXT_ENCODING variable to an empty
355 # environment
356 b"['__CF_USER_TEXT_ENCODING']"))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000357
Peter Astrandcbac93c2005-03-03 20:24:28 +0000358 def test_communicate_stdin(self):
359 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000360 'import sys;'
361 'sys.exit(sys.stdin.read() == "pear")'],
Peter Astrandcbac93c2005-03-03 20:24:28 +0000362 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000363 p.communicate(b"pear")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000364 self.assertEqual(p.returncode, 1)
365
366 def test_communicate_stdout(self):
367 p = subprocess.Popen([sys.executable, "-c",
368 'import sys; sys.stdout.write("pineapple")'],
369 stdout=subprocess.PIPE)
370 (stdout, stderr) = p.communicate()
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000371 self.assertEqual(stdout, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000372 self.assertEqual(stderr, None)
373
374 def test_communicate_stderr(self):
375 p = subprocess.Popen([sys.executable, "-c",
376 'import sys; sys.stderr.write("pineapple")'],
377 stderr=subprocess.PIPE)
378 (stdout, stderr) = p.communicate()
379 self.assertEqual(stdout, None)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000380 self.assertStderrEqual(stderr, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000381
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000382 def test_communicate(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000383 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000384 'import sys,os;'
385 'sys.stderr.write("pineapple");'
386 'sys.stdout.write(sys.stdin.read())'],
387 stdin=subprocess.PIPE,
388 stdout=subprocess.PIPE,
389 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000390 self.addCleanup(p.stdout.close)
391 self.addCleanup(p.stderr.close)
392 self.addCleanup(p.stdin.close)
Georg Brandl1abcbf82008-07-01 19:28:43 +0000393 (stdout, stderr) = p.communicate(b"banana")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000394 self.assertEqual(stdout, b"banana")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000395 self.assertStderrEqual(stderr, b"pineapple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000396
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000397 # Test for the fd leak reported in http://bugs.python.org/issue2791.
398 def test_communicate_pipe_fd_leak(self):
Victor Stinner667d4b52010-12-25 22:40:32 +0000399 for stdin_pipe in (False, True):
400 for stdout_pipe in (False, True):
401 for stderr_pipe in (False, True):
402 options = {}
403 if stdin_pipe:
404 options['stdin'] = subprocess.PIPE
405 if stdout_pipe:
406 options['stdout'] = subprocess.PIPE
407 if stderr_pipe:
408 options['stderr'] = subprocess.PIPE
409 if not options:
410 continue
411 p = subprocess.Popen((sys.executable, "-c", "pass"), **options)
412 p.communicate()
413 if p.stdin is not None:
414 self.assertTrue(p.stdin.closed)
415 if p.stdout is not None:
416 self.assertTrue(p.stdout.closed)
417 if p.stderr is not None:
418 self.assertTrue(p.stderr.closed)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000419
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000420 def test_communicate_returns(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000421 # communicate() should return None if no redirection is active
Tim Peters3b01a702004-10-12 22:19:32 +0000422 p = subprocess.Popen([sys.executable, "-c",
423 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000424 (stdout, stderr) = p.communicate()
425 self.assertEqual(stdout, None)
426 self.assertEqual(stderr, None)
427
428 def test_communicate_pipe_buf(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000429 # communicate() with writes larger than pipe_buf
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000430 # This test will probably deadlock rather than fail, if
Tim Peterse718f612004-10-12 21:51:32 +0000431 # communicate() does not work properly.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000432 x, y = os.pipe()
433 if mswindows:
434 pipe_buf = 512
435 else:
436 pipe_buf = os.fpathconf(x, "PC_PIPE_BUF")
437 os.close(x)
438 os.close(y)
439 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000440 'import sys,os;'
441 'sys.stdout.write(sys.stdin.read(47));'
442 'sys.stderr.write("xyz"*%d);'
443 'sys.stdout.write(sys.stdin.read())' % pipe_buf],
444 stdin=subprocess.PIPE,
445 stdout=subprocess.PIPE,
446 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000447 self.addCleanup(p.stdout.close)
448 self.addCleanup(p.stderr.close)
449 self.addCleanup(p.stdin.close)
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000450 string_to_write = b"abc"*pipe_buf
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000451 (stdout, stderr) = p.communicate(string_to_write)
452 self.assertEqual(stdout, string_to_write)
453
454 def test_writes_before_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000455 # stdin.write before communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000456 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000457 'import sys,os;'
458 'sys.stdout.write(sys.stdin.read())'],
459 stdin=subprocess.PIPE,
460 stdout=subprocess.PIPE,
461 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000462 self.addCleanup(p.stdout.close)
463 self.addCleanup(p.stderr.close)
464 self.addCleanup(p.stdin.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000465 p.stdin.write(b"banana")
466 (stdout, stderr) = p.communicate(b"split")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000467 self.assertEqual(stdout, b"bananasplit")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000468 self.assertStderrEqual(stderr, b"")
Tim Peterse718f612004-10-12 21:51:32 +0000469
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000470 def test_universal_newlines(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000471 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000472 'import sys,os;' + SETBINARY +
473 'sys.stdout.write("line1\\n");'
474 'sys.stdout.flush();'
475 'sys.stdout.write("line2\\n");'
476 'sys.stdout.flush();'
477 'sys.stdout.write("line3\\r\\n");'
478 'sys.stdout.flush();'
479 'sys.stdout.write("line4\\r");'
480 'sys.stdout.flush();'
481 'sys.stdout.write("\\nline5");'
482 'sys.stdout.flush();'
483 'sys.stdout.write("\\nline6");'],
484 stdout=subprocess.PIPE,
485 universal_newlines=1)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000486 self.addCleanup(p.stdout.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000487 stdout = p.stdout.read()
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000488 self.assertEqual(stdout, "line1\nline2\nline3\nline4\nline5\nline6")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000489
490 def test_universal_newlines_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000491 # universal newlines through communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000492 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000493 'import sys,os;' + SETBINARY +
494 'sys.stdout.write("line1\\n");'
495 'sys.stdout.flush();'
496 'sys.stdout.write("line2\\n");'
497 'sys.stdout.flush();'
498 'sys.stdout.write("line3\\r\\n");'
499 'sys.stdout.flush();'
500 'sys.stdout.write("line4\\r");'
501 'sys.stdout.flush();'
502 'sys.stdout.write("\\nline5");'
503 'sys.stdout.flush();'
504 'sys.stdout.write("\\nline6");'],
505 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
506 universal_newlines=1)
Brian Curtin19a53792010-11-05 17:09:05 +0000507 self.addCleanup(p.stdout.close)
508 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000509 (stdout, stderr) = p.communicate()
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000510 self.assertEqual(stdout, "line1\nline2\nline3\nline4\nline5\nline6")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000511
512 def test_no_leaking(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000513 # Make sure we leak no resources
Antoine Pitrou8db30272010-09-18 22:38:48 +0000514 if not mswindows:
Peter Astrandf7f1bb72005-03-03 20:47:37 +0000515 max_handles = 1026 # too much for most UNIX systems
516 else:
Antoine Pitrou8db30272010-09-18 22:38:48 +0000517 max_handles = 2050 # too much for (at least some) Windows setups
518 handles = []
Gregory P. Smith81ce6852011-03-15 02:04:11 -0400519 tmpdir = tempfile.mkdtemp()
Antoine Pitrou8db30272010-09-18 22:38:48 +0000520 try:
521 for i in range(max_handles):
522 try:
Gregory P. Smith81ce6852011-03-15 02:04:11 -0400523 tmpfile = os.path.join(tmpdir, support.TESTFN)
524 handles.append(os.open(tmpfile, os.O_WRONLY|os.O_CREAT))
Antoine Pitrou8db30272010-09-18 22:38:48 +0000525 except OSError as e:
526 if e.errno != errno.EMFILE:
527 raise
528 break
529 else:
530 self.skipTest("failed to reach the file descriptor limit "
531 "(tried %d)" % max_handles)
532 # Close a couple of them (should be enough for a subprocess)
533 for i in range(10):
534 os.close(handles.pop())
535 # Loop creating some subprocesses. If one of them leaks some fds,
536 # the next loop iteration will fail by reaching the max fd limit.
537 for i in range(15):
538 p = subprocess.Popen([sys.executable, "-c",
539 "import sys;"
540 "sys.stdout.write(sys.stdin.read())"],
541 stdin=subprocess.PIPE,
542 stdout=subprocess.PIPE,
543 stderr=subprocess.PIPE)
544 data = p.communicate(b"lime")[0]
545 self.assertEqual(data, b"lime")
546 finally:
547 for h in handles:
548 os.close(h)
Gregory P. Smith81ce6852011-03-15 02:04:11 -0400549 shutil.rmtree(tmpdir)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000550
551 def test_list2cmdline(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000552 self.assertEqual(subprocess.list2cmdline(['a b c', 'd', 'e']),
553 '"a b c" d e')
554 self.assertEqual(subprocess.list2cmdline(['ab"c', '\\', 'd']),
555 'ab\\"c \\ d')
Christian Heimesfdab48e2008-01-20 09:06:41 +0000556 self.assertEqual(subprocess.list2cmdline(['ab"c', ' \\', 'd']),
557 'ab\\"c " \\\\" d')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000558 self.assertEqual(subprocess.list2cmdline(['a\\\\\\b', 'de fg', 'h']),
559 'a\\\\\\b "de fg" h')
560 self.assertEqual(subprocess.list2cmdline(['a\\"b', 'c', 'd']),
561 'a\\\\\\"b c d')
562 self.assertEqual(subprocess.list2cmdline(['a\\\\b c', 'd', 'e']),
563 '"a\\\\b c" d e')
564 self.assertEqual(subprocess.list2cmdline(['a\\\\b\\ c', 'd', 'e']),
565 '"a\\\\b\\ c" d e')
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000566 self.assertEqual(subprocess.list2cmdline(['ab', '']),
567 'ab ""')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000568
569
570 def test_poll(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000571 p = subprocess.Popen([sys.executable,
Tim Peters29b6b4f2004-10-13 03:43:40 +0000572 "-c", "import time; time.sleep(1)"])
573 count = 0
574 while p.poll() is None:
575 time.sleep(0.1)
576 count += 1
577 # We expect that the poll loop probably went around about 10 times,
578 # but, based on system scheduling we can't control, it's possible
579 # poll() never returned None. It "should be" very rare that it
580 # didn't go around at least twice.
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000581 self.assertGreaterEqual(count, 2)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000582 # Subsequent invocations should just return the returncode
583 self.assertEqual(p.poll(), 0)
584
585
586 def test_wait(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000587 p = subprocess.Popen([sys.executable,
588 "-c", "import time; time.sleep(2)"])
589 self.assertEqual(p.wait(), 0)
590 # Subsequent invocations should just return the returncode
591 self.assertEqual(p.wait(), 0)
Tim Peterse718f612004-10-12 21:51:32 +0000592
Peter Astrand738131d2004-11-30 21:04:45 +0000593
594 def test_invalid_bufsize(self):
595 # an invalid type of the bufsize argument should raise
596 # TypeError.
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000597 with self.assertRaises(TypeError):
Peter Astrand738131d2004-11-30 21:04:45 +0000598 subprocess.Popen([sys.executable, "-c", "pass"], "orange")
Peter Astrand738131d2004-11-30 21:04:45 +0000599
Guido van Rossum46a05a72007-06-07 21:56:45 +0000600 def test_bufsize_is_none(self):
601 # bufsize=None should be the same as bufsize=0.
602 p = subprocess.Popen([sys.executable, "-c", "pass"], None)
603 self.assertEqual(p.wait(), 0)
604 # Again with keyword arg
605 p = subprocess.Popen([sys.executable, "-c", "pass"], bufsize=None)
606 self.assertEqual(p.wait(), 0)
607
Benjamin Petersond75fcb42009-02-19 04:22:03 +0000608 def test_leaking_fds_on_error(self):
609 # see bug #5179: Popen leaks file descriptors to PIPEs if
610 # the child fails to execute; this will eventually exhaust
611 # the maximum number of open fds. 1024 seems a very common
612 # value for that limit, but Windows has 2048, so we loop
613 # 1024 times (each call leaked two fds).
614 for i in range(1024):
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000615 # Windows raises IOError. Others raise OSError.
616 with self.assertRaises(EnvironmentError) as c:
Benjamin Petersond75fcb42009-02-19 04:22:03 +0000617 subprocess.Popen(['nonexisting_i_hope'],
618 stdout=subprocess.PIPE,
619 stderr=subprocess.PIPE)
R David Murray384069c2011-03-13 22:26:53 -0400620 # ignore errors that indicate the command was not found
R David Murray6924bd72011-03-13 22:48:55 -0400621 if c.exception.errno not in (errno.ENOENT, errno.EACCES):
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000622 raise c.exception
Benjamin Petersond75fcb42009-02-19 04:22:03 +0000623
Victor Stinnerb3693582010-05-21 20:13:12 +0000624 def test_issue8780(self):
625 # Ensure that stdout is inherited from the parent
626 # if stdout=PIPE is not used
627 code = ';'.join((
628 'import subprocess, sys',
629 'retcode = subprocess.call('
630 "[sys.executable, '-c', 'print(\"Hello World!\")'])",
631 'assert retcode == 0'))
632 output = subprocess.check_output([sys.executable, '-c', code])
Ezio Melottib3aedd42010-11-20 19:04:17 +0000633 self.assertTrue(output.startswith(b'Hello World!'), ascii(output))
Victor Stinnerb3693582010-05-21 20:13:12 +0000634
Tim Goldenaf5ac392010-08-06 13:03:56 +0000635 def test_handles_closed_on_exception(self):
636 # If CreateProcess exits with an error, ensure the
637 # duplicate output handles are released
638 ifhandle, ifname = mkstemp()
639 ofhandle, ofname = mkstemp()
640 efhandle, efname = mkstemp()
641 try:
642 subprocess.Popen (["*"], stdin=ifhandle, stdout=ofhandle,
643 stderr=efhandle)
644 except OSError:
645 os.close(ifhandle)
646 os.remove(ifname)
647 os.close(ofhandle)
648 os.remove(ofname)
649 os.close(efhandle)
650 os.remove(efname)
651 self.assertFalse(os.path.exists(ifname))
652 self.assertFalse(os.path.exists(ofname))
653 self.assertFalse(os.path.exists(efname))
654
Ross Lagerwall4f61b022011-04-05 15:34:00 +0200655 def test_communicate_epipe(self):
656 # Issue 10963: communicate() should hide EPIPE
657 p = subprocess.Popen([sys.executable, "-c", 'pass'],
658 stdin=subprocess.PIPE,
659 stdout=subprocess.PIPE,
660 stderr=subprocess.PIPE)
661 self.addCleanup(p.stdout.close)
662 self.addCleanup(p.stderr.close)
663 self.addCleanup(p.stdin.close)
664 p.communicate(b"x" * 2**20)
665
666 def test_communicate_epipe_only_stdin(self):
667 # Issue 10963: communicate() should hide EPIPE
668 p = subprocess.Popen([sys.executable, "-c", 'pass'],
669 stdin=subprocess.PIPE)
670 self.addCleanup(p.stdin.close)
671 time.sleep(2)
672 p.communicate(b"x" * 2**20)
673
Tim Peterse718f612004-10-12 21:51:32 +0000674
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000675# context manager
676class _SuppressCoreFiles(object):
677 """Try to prevent core files from being created."""
678 old_limit = None
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000679
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000680 def __enter__(self):
681 """Try to save previous ulimit, then set it to (0, 0)."""
682 try:
683 import resource
684 self.old_limit = resource.getrlimit(resource.RLIMIT_CORE)
685 resource.setrlimit(resource.RLIMIT_CORE, (0, 0))
686 except (ImportError, ValueError, resource.error):
687 pass
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000688
Ronald Oussoren102d11a2010-07-23 09:50:05 +0000689 if sys.platform == 'darwin':
690 # Check if the 'Crash Reporter' on OSX was configured
691 # in 'Developer' mode and warn that it will get triggered
692 # when it is.
693 #
694 # This assumes that this context manager is used in tests
695 # that might trigger the next manager.
696 value = subprocess.Popen(['/usr/bin/defaults', 'read',
697 'com.apple.CrashReporter', 'DialogType'],
698 stdout=subprocess.PIPE).communicate()[0]
699 if value.strip() == b'developer':
700 print("this tests triggers the Crash Reporter, "
701 "that is intentional", end='')
702 sys.stdout.flush()
703
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000704 def __exit__(self, *args):
705 """Return core file behavior to default."""
706 if self.old_limit is None:
707 return
708 try:
709 import resource
710 resource.setrlimit(resource.RLIMIT_CORE, self.old_limit)
711 except (ImportError, ValueError, resource.error):
712 pass
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000713
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000714
Florent Xiclunaf0cbd822010-03-04 21:50:56 +0000715@unittest.skipIf(mswindows, "POSIX specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +0000716class POSIXProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +0000717
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000718 def test_exceptions(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000719 nonexistent_dir = "/_this/pa.th/does/not/exist"
720 try:
721 os.chdir(nonexistent_dir)
722 except OSError as e:
723 # This avoids hard coding the errno value or the OS perror()
724 # string and instead capture the exception that we want to see
725 # below for comparison.
726 desired_exception = e
Benjamin Peterson5f780402010-11-20 18:07:52 +0000727 desired_exception.strerror += ': ' + repr(sys.executable)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000728 else:
729 self.fail("chdir to nonexistant directory %s succeeded." %
730 nonexistent_dir)
731
732 # Error in the child re-raised in the parent.
733 try:
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000734 p = subprocess.Popen([sys.executable, "-c", ""],
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000735 cwd=nonexistent_dir)
736 except OSError as e:
737 # Test that the child process chdir failure actually makes
738 # it up to the parent process as the correct exception.
739 self.assertEqual(desired_exception.errno, e.errno)
740 self.assertEqual(desired_exception.strerror, e.strerror)
741 else:
742 self.fail("Expected OSError: %s" % desired_exception)
743
744 def test_restore_signals(self):
745 # Code coverage for both values of restore_signals to make sure it
746 # at least does not blow up.
747 # A test for behavior would be complex. Contributions welcome.
748 subprocess.call([sys.executable, "-c", ""], restore_signals=True)
749 subprocess.call([sys.executable, "-c", ""], restore_signals=False)
750
751 def test_start_new_session(self):
752 # For code coverage of calling setsid(). We don't care if we get an
753 # EPERM error from it depending on the test execution environment, that
754 # still indicates that it was called.
755 try:
756 output = subprocess.check_output(
757 [sys.executable, "-c",
758 "import os; print(os.getpgid(os.getpid()))"],
759 start_new_session=True)
760 except OSError as e:
761 if e.errno != errno.EPERM:
762 raise
763 else:
764 parent_pgid = os.getpgid(os.getpid())
765 child_pgid = int(output)
766 self.assertNotEqual(parent_pgid, child_pgid)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000767
768 def test_run_abort(self):
769 # returncode handles signal termination
770 with _SuppressCoreFiles():
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000771 p = subprocess.Popen([sys.executable, "-c",
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000772 'import os; os.abort()'])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000773 p.wait()
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000774 self.assertEqual(-p.returncode, signal.SIGABRT)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000775
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000776 def test_preexec(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000777 # DISCLAIMER: Setting environment variables is *not* a good use
778 # of a preexec_fn. This is merely a test.
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000779 p = subprocess.Popen([sys.executable, "-c",
780 'import sys,os;'
781 'sys.stdout.write(os.getenv("FRUIT"))'],
782 stdout=subprocess.PIPE,
783 preexec_fn=lambda: os.putenv("FRUIT", "apple"))
Brian Curtin3c6a9512010-11-05 03:58:52 +0000784 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000785 self.assertEqual(p.stdout.read(), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000786
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +0000787 def test_preexec_exception(self):
788 def raise_it():
789 raise ValueError("What if two swallows carried a coconut?")
790 try:
791 p = subprocess.Popen([sys.executable, "-c", ""],
792 preexec_fn=raise_it)
793 except RuntimeError as e:
794 self.assertTrue(
795 subprocess._posixsubprocess,
796 "Expected a ValueError from the preexec_fn")
797 except ValueError as e:
798 self.assertIn("coconut", e.args[0])
799 else:
800 self.fail("Exception raised by preexec_fn did not make it "
801 "to the parent process.")
802
Gregory P. Smith32ec9da2010-03-19 16:53:08 +0000803 @unittest.skipUnless(gc, "Requires a gc module.")
804 def test_preexec_gc_module_failure(self):
805 # This tests the code that disables garbage collection if the child
806 # process will execute any Python.
807 def raise_runtime_error():
808 raise RuntimeError("this shouldn't escape")
809 enabled = gc.isenabled()
810 orig_gc_disable = gc.disable
811 orig_gc_isenabled = gc.isenabled
812 try:
813 gc.disable()
814 self.assertFalse(gc.isenabled())
815 subprocess.call([sys.executable, '-c', ''],
816 preexec_fn=lambda: None)
817 self.assertFalse(gc.isenabled(),
818 "Popen enabled gc when it shouldn't.")
819
820 gc.enable()
821 self.assertTrue(gc.isenabled())
822 subprocess.call([sys.executable, '-c', ''],
823 preexec_fn=lambda: None)
824 self.assertTrue(gc.isenabled(), "Popen left gc disabled.")
825
826 gc.disable = raise_runtime_error
827 self.assertRaises(RuntimeError, subprocess.Popen,
828 [sys.executable, '-c', ''],
829 preexec_fn=lambda: None)
830
831 del gc.isenabled # force an AttributeError
832 self.assertRaises(AttributeError, subprocess.Popen,
833 [sys.executable, '-c', ''],
834 preexec_fn=lambda: None)
835 finally:
836 gc.disable = orig_gc_disable
837 gc.isenabled = orig_gc_isenabled
838 if not enabled:
839 gc.disable()
840
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000841 def test_args_string(self):
842 # args is a string
843 fd, fname = mkstemp()
844 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +0000845 with open(fd, "w", errors="surrogateescape") as fobj:
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000846 fobj.write("#!/bin/sh\n")
847 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
848 sys.executable)
849 os.chmod(fname, 0o700)
850 p = subprocess.Popen(fname)
851 p.wait()
852 os.remove(fname)
853 self.assertEqual(p.returncode, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000854
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000855 def test_invalid_args(self):
856 # invalid arguments should raise ValueError
857 self.assertRaises(ValueError, subprocess.call,
858 [sys.executable, "-c",
859 "import sys; sys.exit(47)"],
860 startupinfo=47)
861 self.assertRaises(ValueError, subprocess.call,
862 [sys.executable, "-c",
863 "import sys; sys.exit(47)"],
864 creationflags=47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000865
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000866 def test_shell_sequence(self):
867 # Run command through the shell (sequence)
868 newenv = os.environ.copy()
869 newenv["FRUIT"] = "apple"
870 p = subprocess.Popen(["echo $FRUIT"], shell=1,
871 stdout=subprocess.PIPE,
872 env=newenv)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000873 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000874 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000875
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000876 def test_shell_string(self):
877 # Run command through the shell (string)
878 newenv = os.environ.copy()
879 newenv["FRUIT"] = "apple"
880 p = subprocess.Popen("echo $FRUIT", shell=1,
881 stdout=subprocess.PIPE,
882 env=newenv)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000883 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000884 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Christian Heimesa342c012008-04-20 21:01:16 +0000885
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000886 def test_call_string(self):
887 # call() function with string argument on UNIX
888 fd, fname = mkstemp()
889 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +0000890 with open(fd, "w", errors="surrogateescape") as fobj:
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000891 fobj.write("#!/bin/sh\n")
892 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
893 sys.executable)
894 os.chmod(fname, 0o700)
895 rc = subprocess.call(fname)
896 os.remove(fname)
897 self.assertEqual(rc, 47)
Christian Heimesa342c012008-04-20 21:01:16 +0000898
Stefan Krah9542cc62010-07-19 14:20:53 +0000899 def test_specific_shell(self):
900 # Issue #9265: Incorrect name passed as arg[0].
901 shells = []
902 for prefix in ['/bin', '/usr/bin/', '/usr/local/bin']:
903 for name in ['bash', 'ksh']:
904 sh = os.path.join(prefix, name)
905 if os.path.isfile(sh):
906 shells.append(sh)
907 if not shells: # Will probably work for any shell but csh.
908 self.skipTest("bash or ksh required for this test")
909 sh = '/bin/sh'
910 if os.path.isfile(sh) and not os.path.islink(sh):
911 # Test will fail if /bin/sh is a symlink to csh.
912 shells.append(sh)
913 for sh in shells:
914 p = subprocess.Popen("echo $0", executable=sh, shell=True,
915 stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000916 self.addCleanup(p.stdout.close)
Stefan Krah9542cc62010-07-19 14:20:53 +0000917 self.assertEqual(p.stdout.read().strip(), bytes(sh, 'ascii'))
918
Florent Xicluna4886d242010-03-08 13:27:26 +0000919 def _kill_process(self, method, *args):
Florent Xicluna1d8ee3a2010-03-05 20:26:54 +0000920 # Do not inherit file handles from the parent.
921 # It should fix failures on some platforms.
Antoine Pitrou3d8580f2010-09-20 01:33:21 +0000922 p = subprocess.Popen([sys.executable, "-c", """if 1:
923 import sys, time
924 sys.stdout.write('x\\n')
925 sys.stdout.flush()
926 time.sleep(30)
927 """],
928 close_fds=True,
929 stdin=subprocess.PIPE,
930 stdout=subprocess.PIPE,
931 stderr=subprocess.PIPE)
932 # Wait for the interpreter to be completely initialized before
933 # sending any signal.
934 p.stdout.read(1)
935 getattr(p, method)(*args)
Florent Xicluna4886d242010-03-08 13:27:26 +0000936 return p
937
938 def test_send_signal(self):
939 p = self._kill_process('send_signal', signal.SIGINT)
Florent Xiclunac049d872010-03-27 22:47:23 +0000940 _, stderr = p.communicate()
941 self.assertIn(b'KeyboardInterrupt', stderr)
Florent Xiclunaf0cbd822010-03-04 21:50:56 +0000942 self.assertNotEqual(p.wait(), 0)
Christian Heimesa342c012008-04-20 21:01:16 +0000943
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000944 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +0000945 p = self._kill_process('kill')
Florent Xiclunac049d872010-03-27 22:47:23 +0000946 _, stderr = p.communicate()
947 self.assertStderrEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000948 self.assertEqual(p.wait(), -signal.SIGKILL)
Tim Peterse718f612004-10-12 21:51:32 +0000949
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000950 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +0000951 p = self._kill_process('terminate')
Florent Xiclunac049d872010-03-27 22:47:23 +0000952 _, stderr = p.communicate()
953 self.assertStderrEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000954 self.assertEqual(p.wait(), -signal.SIGTERM)
955
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +0000956 def check_close_std_fds(self, fds):
957 # Issue #9905: test that subprocess pipes still work properly with
958 # some standard fds closed
959 stdin = 0
960 newfds = []
961 for a in fds:
962 b = os.dup(a)
963 newfds.append(b)
964 if a == 0:
965 stdin = b
966 try:
967 for fd in fds:
968 os.close(fd)
969 out, err = subprocess.Popen([sys.executable, "-c",
970 'import sys;'
971 'sys.stdout.write("apple");'
972 'sys.stdout.flush();'
973 'sys.stderr.write("orange")'],
974 stdin=stdin,
975 stdout=subprocess.PIPE,
976 stderr=subprocess.PIPE).communicate()
977 err = support.strip_python_stderr(err)
978 self.assertEqual((out, err), (b'apple', b'orange'))
979 finally:
980 for b, a in zip(newfds, fds):
981 os.dup2(b, a)
982 for b in newfds:
983 os.close(b)
984
985 def test_close_fd_0(self):
986 self.check_close_std_fds([0])
987
988 def test_close_fd_1(self):
989 self.check_close_std_fds([1])
990
991 def test_close_fd_2(self):
992 self.check_close_std_fds([2])
993
994 def test_close_fds_0_1(self):
995 self.check_close_std_fds([0, 1])
996
997 def test_close_fds_0_2(self):
998 self.check_close_std_fds([0, 2])
999
1000 def test_close_fds_1_2(self):
1001 self.check_close_std_fds([1, 2])
1002
1003 def test_close_fds_0_1_2(self):
1004 # Issue #10806: test that subprocess pipes still work properly with
1005 # all standard fds closed.
1006 self.check_close_std_fds([0, 1, 2])
1007
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00001008 def test_remapping_std_fds(self):
1009 # open up some temporary files
1010 temps = [mkstemp() for i in range(3)]
1011 try:
1012 temp_fds = [fd for fd, fname in temps]
1013
1014 # unlink the files -- we won't need to reopen them
1015 for fd, fname in temps:
1016 os.unlink(fname)
1017
1018 # write some data to what will become stdin, and rewind
1019 os.write(temp_fds[1], b"STDIN")
1020 os.lseek(temp_fds[1], 0, 0)
1021
1022 # move the standard file descriptors out of the way
1023 saved_fds = [os.dup(fd) for fd in range(3)]
1024 try:
1025 # duplicate the file objects over the standard fd's
1026 for fd, temp_fd in enumerate(temp_fds):
1027 os.dup2(temp_fd, fd)
1028
1029 # now use those files in the "wrong" order, so that subprocess
1030 # has to rearrange them in the child
1031 p = subprocess.Popen([sys.executable, "-c",
1032 'import sys; got = sys.stdin.read();'
1033 'sys.stdout.write("got %s"%got); sys.stderr.write("err")'],
1034 stdin=temp_fds[1],
1035 stdout=temp_fds[2],
1036 stderr=temp_fds[0])
1037 p.wait()
1038 finally:
1039 # restore the original fd's underneath sys.stdin, etc.
1040 for std, saved in enumerate(saved_fds):
1041 os.dup2(saved, std)
1042 os.close(saved)
1043
1044 for fd in temp_fds:
1045 os.lseek(fd, 0, 0)
1046
1047 out = os.read(temp_fds[2], 1024)
1048 err = support.strip_python_stderr(os.read(temp_fds[0], 1024))
1049 self.assertEqual(out, b"got STDIN")
1050 self.assertEqual(err, b"err")
1051
1052 finally:
1053 for fd in temp_fds:
1054 os.close(fd)
1055
Victor Stinner13bb71c2010-04-23 21:41:56 +00001056 def test_surrogates_error_message(self):
Victor Stinner4d078042010-04-23 19:28:32 +00001057 def prepare():
1058 raise ValueError("surrogate:\uDCff")
1059
1060 try:
1061 subprocess.call(
1062 [sys.executable, "-c", "pass"],
1063 preexec_fn=prepare)
1064 except ValueError as err:
1065 # Pure Python implementations keeps the message
1066 self.assertIsNone(subprocess._posixsubprocess)
1067 self.assertEqual(str(err), "surrogate:\uDCff")
1068 except RuntimeError as err:
1069 # _posixsubprocess uses a default message
1070 self.assertIsNotNone(subprocess._posixsubprocess)
1071 self.assertEqual(str(err), "Exception occurred in preexec_fn.")
1072 else:
1073 self.fail("Expected ValueError or RuntimeError")
1074
Victor Stinner13bb71c2010-04-23 21:41:56 +00001075 def test_undecodable_env(self):
1076 for key, value in (('test', 'abc\uDCFF'), ('test\uDCFF', '42')):
Victor Stinner13bb71c2010-04-23 21:41:56 +00001077 # test str with surrogates
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00001078 script = "import os; print(ascii(os.getenv(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001079 env = os.environ.copy()
1080 env[key] = value
Victor Stinner89f3ad12010-10-14 10:43:31 +00001081 # Use C locale to get ascii for the locale encoding to force
1082 # surrogate-escaping of \xFF in the child process; otherwise it can
1083 # be decoded as-is if the default locale is latin-1.
Victor Stinnerebc78d22010-10-14 10:38:17 +00001084 env['LC_ALL'] = 'C'
Victor Stinner13bb71c2010-04-23 21:41:56 +00001085 stdout = subprocess.check_output(
1086 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001087 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00001088 stdout = stdout.rstrip(b'\n\r')
Ezio Melottib3aedd42010-11-20 19:04:17 +00001089 self.assertEqual(stdout.decode('ascii'), ascii(value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00001090
1091 # test bytes
1092 key = key.encode("ascii", "surrogateescape")
1093 value = value.encode("ascii", "surrogateescape")
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00001094 script = "import os; print(ascii(os.getenvb(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001095 env = os.environ.copy()
1096 env[key] = value
Victor Stinner13bb71c2010-04-23 21:41:56 +00001097 stdout = subprocess.check_output(
1098 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001099 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00001100 stdout = stdout.rstrip(b'\n\r')
Ezio Melottib3aedd42010-11-20 19:04:17 +00001101 self.assertEqual(stdout.decode('ascii'), ascii(value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00001102
Victor Stinnerb745a742010-05-18 17:17:23 +00001103 def test_bytes_program(self):
1104 abs_program = os.fsencode(sys.executable)
1105 path, program = os.path.split(sys.executable)
1106 program = os.fsencode(program)
1107
1108 # absolute bytes path
1109 exitcode = subprocess.call([abs_program, "-c", "pass"])
Ezio Melottib3aedd42010-11-20 19:04:17 +00001110 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001111
1112 # bytes program, unicode PATH
1113 env = os.environ.copy()
1114 env["PATH"] = path
1115 exitcode = subprocess.call([program, "-c", "pass"], env=env)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001116 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001117
1118 # bytes program, bytes PATH
1119 envb = os.environb.copy()
1120 envb[b"PATH"] = os.fsencode(path)
1121 exitcode = subprocess.call([program, "-c", "pass"], env=envb)
Ezio Melottib3aedd42010-11-20 19:04:17 +00001122 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001123
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001124 def test_pipe_cloexec(self):
1125 sleeper = support.findfile("input_reader.py", subdir="subprocessdata")
1126 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
1127
1128 p1 = subprocess.Popen([sys.executable, sleeper],
1129 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1130 stderr=subprocess.PIPE, close_fds=False)
1131
1132 self.addCleanup(p1.communicate, b'')
1133
1134 p2 = subprocess.Popen([sys.executable, fd_status],
1135 stdout=subprocess.PIPE, close_fds=False)
1136
1137 output, error = p2.communicate()
1138 result_fds = set(map(int, output.split(b',')))
1139 unwanted_fds = set([p1.stdin.fileno(), p1.stdout.fileno(),
1140 p1.stderr.fileno()])
1141
1142 self.assertFalse(result_fds & unwanted_fds,
1143 "Expected no fds from %r to be open in child, "
1144 "found %r" %
1145 (unwanted_fds, result_fds & unwanted_fds))
1146
1147 def test_pipe_cloexec_real_tools(self):
1148 qcat = support.findfile("qcat.py", subdir="subprocessdata")
1149 qgrep = support.findfile("qgrep.py", subdir="subprocessdata")
1150
1151 subdata = b'zxcvbn'
1152 data = subdata * 4 + b'\n'
1153
1154 p1 = subprocess.Popen([sys.executable, qcat],
1155 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1156 close_fds=False)
1157
1158 p2 = subprocess.Popen([sys.executable, qgrep, subdata],
1159 stdin=p1.stdout, stdout=subprocess.PIPE,
1160 close_fds=False)
1161
1162 self.addCleanup(p1.wait)
1163 self.addCleanup(p2.wait)
1164 self.addCleanup(p1.terminate)
1165 self.addCleanup(p2.terminate)
1166
1167 p1.stdin.write(data)
1168 p1.stdin.close()
1169
1170 readfiles, ignored1, ignored2 = select.select([p2.stdout], [], [], 10)
1171
1172 self.assertTrue(readfiles, "The child hung")
1173 self.assertEqual(p2.stdout.read(), data)
1174
Victor Stinnerfaa8c132011-01-03 16:36:00 +00001175 p1.stdout.close()
1176 p2.stdout.close()
1177
Gregory P. Smith51ee2702010-12-13 07:59:39 +00001178 def test_close_fds(self):
1179 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
1180
1181 fds = os.pipe()
1182 self.addCleanup(os.close, fds[0])
1183 self.addCleanup(os.close, fds[1])
1184
1185 open_fds = set(fds)
1186
1187 p = subprocess.Popen([sys.executable, fd_status],
1188 stdout=subprocess.PIPE, close_fds=False)
1189 output, ignored = p.communicate()
1190 remaining_fds = set(map(int, output.split(b',')))
1191
1192 self.assertEqual(remaining_fds & open_fds, open_fds,
1193 "Some fds were closed")
1194
1195 p = subprocess.Popen([sys.executable, fd_status],
1196 stdout=subprocess.PIPE, close_fds=True)
1197 output, ignored = p.communicate()
1198 remaining_fds = set(map(int, output.split(b',')))
1199
1200 self.assertFalse(remaining_fds & open_fds,
1201 "Some fds were left open")
1202 self.assertIn(1, remaining_fds, "Subprocess failed")
1203
Victor Stinner88701e22011-06-01 13:13:04 +02001204 # Mac OS X Tiger (10.4) has a kernel bug: sometimes, the file
1205 # descriptor of a pipe closed in the parent process is valid in the
1206 # child process according to fstat(), but the mode of the file
1207 # descriptor is invalid, and read or write raise an error.
1208 @support.requires_mac_ver(10, 5)
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00001209 def test_pass_fds(self):
1210 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
1211
1212 open_fds = set()
1213
1214 for x in range(5):
1215 fds = os.pipe()
1216 self.addCleanup(os.close, fds[0])
1217 self.addCleanup(os.close, fds[1])
1218 open_fds.update(fds)
1219
1220 for fd in open_fds:
1221 p = subprocess.Popen([sys.executable, fd_status],
1222 stdout=subprocess.PIPE, close_fds=True,
1223 pass_fds=(fd, ))
1224 output, ignored = p.communicate()
1225
1226 remaining_fds = set(map(int, output.split(b',')))
1227 to_be_closed = open_fds - {fd}
1228
1229 self.assertIn(fd, remaining_fds, "fd to be passed not passed")
1230 self.assertFalse(remaining_fds & to_be_closed,
1231 "fd to be closed passed")
1232
1233 # pass_fds overrides close_fds with a warning.
1234 with self.assertWarns(RuntimeWarning) as context:
1235 self.assertFalse(subprocess.call(
1236 [sys.executable, "-c", "import sys; sys.exit(0)"],
1237 close_fds=False, pass_fds=(fd, )))
1238 self.assertIn('overriding close_fds', str(context.warning))
1239
Gregory P. Smithe14e9c22011-03-15 14:55:17 -04001240 def test_stdout_stdin_are_single_inout_fd(self):
1241 with io.open(os.devnull, "r+") as inout:
1242 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
1243 stdout=inout, stdin=inout)
1244 p.wait()
1245
1246 def test_stdout_stderr_are_single_inout_fd(self):
1247 with io.open(os.devnull, "r+") as inout:
1248 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
1249 stdout=inout, stderr=inout)
1250 p.wait()
1251
1252 def test_stderr_stdin_are_single_inout_fd(self):
1253 with io.open(os.devnull, "r+") as inout:
1254 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
1255 stderr=inout, stdin=inout)
1256 p.wait()
1257
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001258 def test_wait_when_sigchild_ignored(self):
1259 # NOTE: sigchild_ignore.py may not be an effective test on all OSes.
1260 sigchild_ignore = support.findfile("sigchild_ignore.py",
1261 subdir="subprocessdata")
1262 p = subprocess.Popen([sys.executable, sigchild_ignore],
1263 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1264 stdout, stderr = p.communicate()
1265 self.assertEqual(0, p.returncode, "sigchild_ignore.py exited"
Gregory P. Smitha80f4fb2010-12-14 15:23:02 +00001266 " non-zero with this error:\n%s" %
1267 stderr.decode('utf8'))
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00001268
Antoine Pitrou7b98d022011-03-19 17:04:13 +01001269 def test_select_unbuffered(self):
1270 # Issue #11459: bufsize=0 should really set the pipes as
1271 # unbuffered (and therefore let select() work properly).
1272 select = support.import_module("select")
1273 p = subprocess.Popen([sys.executable, "-c",
1274 'import sys;'
1275 'sys.stdout.write("apple")'],
1276 stdout=subprocess.PIPE,
1277 bufsize=0)
1278 f = p.stdout
Ross Lagerwall17ace7a2011-03-26 21:21:46 +02001279 self.addCleanup(f.close)
Antoine Pitrou7b98d022011-03-19 17:04:13 +01001280 try:
1281 self.assertEqual(f.read(4), b"appl")
1282 self.assertIn(f, select.select([f], [], [], 0.0)[0])
1283 finally:
1284 p.wait()
1285
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001286
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001287@unittest.skipUnless(mswindows, "Windows specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +00001288class Win32ProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001289
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001290 def test_startupinfo(self):
1291 # startupinfo argument
1292 # We uses hardcoded constants, because we do not want to
1293 # depend on win32all.
1294 STARTF_USESHOWWINDOW = 1
1295 SW_MAXIMIZE = 3
1296 startupinfo = subprocess.STARTUPINFO()
1297 startupinfo.dwFlags = STARTF_USESHOWWINDOW
1298 startupinfo.wShowWindow = SW_MAXIMIZE
1299 # Since Python is a console process, it won't be affected
1300 # by wShowWindow, but the argument should be silently
1301 # ignored
1302 subprocess.call([sys.executable, "-c", "import sys; sys.exit(0)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001303 startupinfo=startupinfo)
1304
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001305 def test_creationflags(self):
1306 # creationflags argument
1307 CREATE_NEW_CONSOLE = 16
1308 sys.stderr.write(" a DOS box should flash briefly ...\n")
1309 subprocess.call(sys.executable +
1310 ' -c "import time; time.sleep(0.25)"',
1311 creationflags=CREATE_NEW_CONSOLE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001312
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001313 def test_invalid_args(self):
1314 # invalid arguments should raise ValueError
1315 self.assertRaises(ValueError, subprocess.call,
1316 [sys.executable, "-c",
1317 "import sys; sys.exit(47)"],
1318 preexec_fn=lambda: 1)
1319 self.assertRaises(ValueError, subprocess.call,
1320 [sys.executable, "-c",
1321 "import sys; sys.exit(47)"],
1322 stdout=subprocess.PIPE,
1323 close_fds=True)
1324
1325 def test_close_fds(self):
1326 # close file descriptors
1327 rc = subprocess.call([sys.executable, "-c",
1328 "import sys; sys.exit(47)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001329 close_fds=True)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001330 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001331
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001332 def test_shell_sequence(self):
1333 # Run command through the shell (sequence)
1334 newenv = os.environ.copy()
1335 newenv["FRUIT"] = "physalis"
1336 p = subprocess.Popen(["set"], shell=1,
1337 stdout=subprocess.PIPE,
1338 env=newenv)
Brian Curtin19a53792010-11-05 17:09:05 +00001339 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001340 self.assertIn(b"physalis", p.stdout.read())
Guido van Rossume7ba4952007-06-06 23:52:48 +00001341
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001342 def test_shell_string(self):
1343 # Run command through the shell (string)
1344 newenv = os.environ.copy()
1345 newenv["FRUIT"] = "physalis"
1346 p = subprocess.Popen("set", shell=1,
1347 stdout=subprocess.PIPE,
1348 env=newenv)
Brian Curtin19a53792010-11-05 17:09:05 +00001349 self.addCleanup(p.stdout.close)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001350 self.assertIn(b"physalis", p.stdout.read())
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001351
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001352 def test_call_string(self):
1353 # call() function with string argument on Windows
1354 rc = subprocess.call(sys.executable +
1355 ' -c "import sys; sys.exit(47)"')
1356 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001357
Florent Xicluna4886d242010-03-08 13:27:26 +00001358 def _kill_process(self, method, *args):
1359 # Some win32 buildbot raises EOFError if stdin is inherited
Antoine Pitroua4024e22010-09-24 18:57:01 +00001360 p = subprocess.Popen([sys.executable, "-c", """if 1:
1361 import sys, time
1362 sys.stdout.write('x\\n')
1363 sys.stdout.flush()
1364 time.sleep(30)
1365 """],
1366 stdin=subprocess.PIPE,
1367 stdout=subprocess.PIPE,
1368 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +00001369 self.addCleanup(p.stdout.close)
1370 self.addCleanup(p.stderr.close)
1371 self.addCleanup(p.stdin.close)
Antoine Pitroua4024e22010-09-24 18:57:01 +00001372 # Wait for the interpreter to be completely initialized before
1373 # sending any signal.
1374 p.stdout.read(1)
1375 getattr(p, method)(*args)
Florent Xiclunac049d872010-03-27 22:47:23 +00001376 _, stderr = p.communicate()
1377 self.assertStderrEqual(stderr, b'')
Antoine Pitroua4024e22010-09-24 18:57:01 +00001378 returncode = p.wait()
Florent Xicluna4886d242010-03-08 13:27:26 +00001379 self.assertNotEqual(returncode, 0)
1380
1381 def test_send_signal(self):
1382 self._kill_process('send_signal', signal.SIGTERM)
Christian Heimesa342c012008-04-20 21:01:16 +00001383
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001384 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00001385 self._kill_process('kill')
Christian Heimesa342c012008-04-20 21:01:16 +00001386
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001387 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00001388 self._kill_process('terminate')
Christian Heimesa342c012008-04-20 21:01:16 +00001389
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001390
Brett Cannona23810f2008-05-26 19:04:21 +00001391# The module says:
1392# "NB This only works (and is only relevant) for UNIX."
1393#
1394# Actually, getoutput should work on any platform with an os.popen, but
1395# I'll take the comment as given, and skip this suite.
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001396@unittest.skipUnless(os.name == 'posix', "only relevant for UNIX")
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001397class CommandTests(unittest.TestCase):
1398 def test_getoutput(self):
1399 self.assertEqual(subprocess.getoutput('echo xyzzy'), 'xyzzy')
1400 self.assertEqual(subprocess.getstatusoutput('echo xyzzy'),
1401 (0, 'xyzzy'))
Brett Cannona23810f2008-05-26 19:04:21 +00001402
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001403 # we use mkdtemp in the next line to create an empty directory
1404 # under our exclusive control; from that, we can invent a pathname
1405 # that we _know_ won't exist. This is guaranteed to fail.
1406 dir = None
1407 try:
1408 dir = tempfile.mkdtemp()
1409 name = os.path.join(dir, "foo")
Brett Cannona23810f2008-05-26 19:04:21 +00001410
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001411 status, output = subprocess.getstatusoutput('cat ' + name)
1412 self.assertNotEqual(status, 0)
1413 finally:
1414 if dir is not None:
1415 os.rmdir(dir)
Brett Cannona23810f2008-05-26 19:04:21 +00001416
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001417
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001418@unittest.skipUnless(getattr(subprocess, '_has_poll', False),
1419 "poll system call not supported")
1420class ProcessTestCaseNoPoll(ProcessTestCase):
1421 def setUp(self):
1422 subprocess._has_poll = False
1423 ProcessTestCase.setUp(self)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001424
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001425 def tearDown(self):
1426 subprocess._has_poll = True
1427 ProcessTestCase.tearDown(self)
Gregory P. Smithd06fa472009-07-04 02:46:54 +00001428
1429
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001430@unittest.skipUnless(getattr(subprocess, '_posixsubprocess', False),
1431 "_posixsubprocess extension module not found.")
1432class ProcessTestCasePOSIXPurePython(ProcessTestCase, POSIXProcessTestCase):
Gregory P. Smith7439e7b2011-05-28 09:06:02 -07001433 @classmethod
1434 def setUpClass(cls):
1435 global subprocess
1436 assert subprocess._posixsubprocess
1437 # Reimport subprocess while forcing _posixsubprocess to not exist.
1438 with support.check_warnings(('.*_posixsubprocess .* not being used.*',
1439 RuntimeWarning)):
1440 subprocess = support.import_fresh_module(
1441 'subprocess', blocked=['_posixsubprocess'])
1442 assert not subprocess._posixsubprocess
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001443
Gregory P. Smith7439e7b2011-05-28 09:06:02 -07001444 @classmethod
1445 def tearDownClass(cls):
1446 global subprocess
1447 # Reimport subprocess as it should be, restoring order to the universe.
1448 subprocess = support.import_fresh_module('subprocess')
1449 assert subprocess._posixsubprocess
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001450
1451
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00001452class HelperFunctionTests(unittest.TestCase):
Gregory P. Smithaf6d3b82010-03-01 02:56:44 +00001453 @unittest.skipIf(mswindows, "errno and EINTR make no sense on windows")
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00001454 def test_eintr_retry_call(self):
1455 record_calls = []
1456 def fake_os_func(*args):
1457 record_calls.append(args)
1458 if len(record_calls) == 2:
1459 raise OSError(errno.EINTR, "fake interrupted system call")
1460 return tuple(reversed(args))
1461
1462 self.assertEqual((999, 256),
1463 subprocess._eintr_retry_call(fake_os_func, 256, 999))
1464 self.assertEqual([(256, 999)], record_calls)
1465 # This time there will be an EINTR so it will loop once.
1466 self.assertEqual((666,),
1467 subprocess._eintr_retry_call(fake_os_func, 666))
1468 self.assertEqual([(256, 999), (666,), (666,)], record_calls)
1469
1470
Tim Golden126c2962010-08-11 14:20:40 +00001471@unittest.skipUnless(mswindows, "Windows-specific tests")
1472class CommandsWithSpaces (BaseTestCase):
1473
1474 def setUp(self):
1475 super().setUp()
1476 f, fname = mkstemp(".py", "te st")
1477 self.fname = fname.lower ()
1478 os.write(f, b"import sys;"
1479 b"sys.stdout.write('%d %s' % (len(sys.argv), [a.lower () for a in sys.argv]))"
1480 )
1481 os.close(f)
1482
1483 def tearDown(self):
1484 os.remove(self.fname)
1485 super().tearDown()
1486
1487 def with_spaces(self, *args, **kwargs):
1488 kwargs['stdout'] = subprocess.PIPE
1489 p = subprocess.Popen(*args, **kwargs)
Brian Curtin19a53792010-11-05 17:09:05 +00001490 self.addCleanup(p.stdout.close)
Tim Golden126c2962010-08-11 14:20:40 +00001491 self.assertEqual(
1492 p.stdout.read ().decode("mbcs"),
1493 "2 [%r, 'ab cd']" % self.fname
1494 )
1495
1496 def test_shell_string_with_spaces(self):
1497 # call() function with string argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00001498 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
1499 "ab cd"), shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00001500
1501 def test_shell_sequence_with_spaces(self):
1502 # call() function with sequence argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00001503 self.with_spaces([sys.executable, self.fname, "ab cd"], shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00001504
1505 def test_noshell_string_with_spaces(self):
1506 # call() function with string argument with spaces on Windows
1507 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
1508 "ab cd"))
1509
1510 def test_noshell_sequence_with_spaces(self):
1511 # call() function with sequence argument with spaces on Windows
1512 self.with_spaces([sys.executable, self.fname, "ab cd"])
1513
Brian Curtin79cdb662010-12-03 02:46:02 +00001514
1515class ContextManagerTests(ProcessTestCase):
1516
1517 def test_pipe(self):
1518 with subprocess.Popen([sys.executable, "-c",
1519 "import sys;"
1520 "sys.stdout.write('stdout');"
1521 "sys.stderr.write('stderr');"],
1522 stdout=subprocess.PIPE,
1523 stderr=subprocess.PIPE) as proc:
1524 self.assertEqual(proc.stdout.read(), b"stdout")
1525 self.assertStderrEqual(proc.stderr.read(), b"stderr")
1526
1527 self.assertTrue(proc.stdout.closed)
1528 self.assertTrue(proc.stderr.closed)
1529
1530 def test_returncode(self):
1531 with subprocess.Popen([sys.executable, "-c",
1532 "import sys; sys.exit(100)"]) as proc:
Gregory P. Smithc9557af2011-05-11 22:18:23 -07001533 pass
1534 # __exit__ calls wait(), so the returncode should be set
Brian Curtin79cdb662010-12-03 02:46:02 +00001535 self.assertEqual(proc.returncode, 100)
1536
1537 def test_communicate_stdin(self):
1538 with subprocess.Popen([sys.executable, "-c",
1539 "import sys;"
1540 "sys.exit(sys.stdin.read() == 'context')"],
1541 stdin=subprocess.PIPE) as proc:
1542 proc.communicate(b"context")
1543 self.assertEqual(proc.returncode, 1)
1544
1545 def test_invalid_args(self):
1546 with self.assertRaises(EnvironmentError) as c:
1547 with subprocess.Popen(['nonexisting_i_hope'],
1548 stdout=subprocess.PIPE,
1549 stderr=subprocess.PIPE) as proc:
1550 pass
1551
1552 if c.exception.errno != errno.ENOENT: # ignore "no such file"
1553 raise c.exception
1554
1555
Gregory P. Smith961e0e82011-03-15 15:43:39 -04001556def test_main():
1557 unit_tests = (ProcessTestCase,
1558 POSIXProcessTestCase,
1559 Win32ProcessTestCase,
1560 ProcessTestCasePOSIXPurePython,
1561 CommandTests,
1562 ProcessTestCaseNoPoll,
1563 HelperFunctionTests,
1564 CommandsWithSpaces,
1565 ContextManagerTests)
1566
1567 support.run_unittest(*unit_tests)
1568 support.reap_children()
1569
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001570if __name__ == "__main__":
Gregory P. Smithe14e9c22011-03-15 14:55:17 -04001571 unittest.main()