blob: 2d9239c75905efa1f58bdfe8f60419261993ad21 [file] [log] [blame]
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001import unittest
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)1ef8c7e2016-06-04 00:22:17 +00002from unittest import mock
Benjamin Petersonee8712c2008-05-20 21:35:26 +00003from test import support
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00004import subprocess
5import sys
6import signal
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04007import io
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00008import os
Gregory P. Smitha59c59f2010-03-01 00:17:40 +00009import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000010import tempfile
11import time
Charles-François Natali3a4586a2013-11-08 19:56:59 +010012import selectors
Ezio Melotti184bdfb2010-02-18 09:37:05 +000013import sysconfig
Gregory P. Smith51ee2702010-12-13 07:59:39 +000014import select
Gregory P. Smith81ce6852011-03-15 02:04:11 -040015import shutil
Benjamin Petersonb870aa12011-12-10 12:44:25 -050016import gc
Andrew Svetlov47ec25d2012-08-19 16:25:37 +030017import textwrap
Benjamin Peterson964561b2011-12-10 12:31:42 -050018
19try:
Antoine Pitroua8392712013-08-30 23:38:13 +020020 import threading
21except ImportError:
22 threading = None
Benjamin Peterson964561b2011-12-10 12:31:42 -050023
Steve Dower22d06982016-09-06 19:38:15 -070024if support.PGO:
25 raise unittest.SkipTest("test is not helpful for PGO")
26
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000027mswindows = (sys.platform == "win32")
28
29#
30# Depends on the following external programs: Python
31#
32
33if mswindows:
Tim Peters3b01a702004-10-12 22:19:32 +000034 SETBINARY = ('import msvcrt; msvcrt.setmode(sys.stdout.fileno(), '
35 'os.O_BINARY);')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000036else:
37 SETBINARY = ''
38
Florent Xiclunab1e94e82010-02-27 22:12:37 +000039
Florent Xiclunac049d872010-03-27 22:47:23 +000040class BaseTestCase(unittest.TestCase):
Thomas Wouters0e3f5912006-08-11 14:57:12 +000041 def setUp(self):
42 # Try to minimize the number of children we have so this test
43 # doesn't crash on some buildbots (Alphas in particular).
Florent Xiclunab1e94e82010-02-27 22:12:37 +000044 support.reap_children()
Thomas Wouters0e3f5912006-08-11 14:57:12 +000045
Florent Xiclunaf0cbd822010-03-04 21:50:56 +000046 def tearDown(self):
47 for inst in subprocess._active:
48 inst.wait()
49 subprocess._cleanup()
50 self.assertFalse(subprocess._active, "subprocess._active not empty")
51
Florent Xiclunab1e94e82010-02-27 22:12:37 +000052 def assertStderrEqual(self, stderr, expected, msg=None):
53 # In a debug build, stuff like "[6580 refs]" is printed to stderr at
54 # shutdown time. That frustrates tests trying to check stderr produced
55 # from a spawned Python process.
Antoine Pitrou62f68ed2010-08-04 11:48:56 +000056 actual = support.strip_python_stderr(stderr)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -040057 # strip_python_stderr also strips whitespace, so we do too.
58 expected = expected.strip()
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
Gregory P. Smith3d8e7762012-11-10 22:32:22 -080062class PopenTestException(Exception):
63 pass
64
65
66class PopenExecuteChildRaises(subprocess.Popen):
67 """Popen subclass for testing cleanup of subprocess.PIPE filehandles when
68 _execute_child fails.
69 """
70 def _execute_child(self, *args, **kwargs):
71 raise PopenTestException("Forced Exception for Test")
72
73
Florent Xiclunac049d872010-03-27 22:47:23 +000074class ProcessTestCase(BaseTestCase):
75
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070076 def test_io_buffered_by_default(self):
77 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
78 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
79 stderr=subprocess.PIPE)
80 try:
81 self.assertIsInstance(p.stdin, io.BufferedIOBase)
82 self.assertIsInstance(p.stdout, io.BufferedIOBase)
83 self.assertIsInstance(p.stderr, io.BufferedIOBase)
84 finally:
Gregory P. Smitha1b9ed32013-03-23 11:54:22 -070085 p.stdin.close()
86 p.stdout.close()
87 p.stderr.close()
Gregory P. Smitha1ed5392013-03-23 11:44:25 -070088 p.wait()
89
90 def test_io_unbuffered_works(self):
91 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
92 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
93 stderr=subprocess.PIPE, bufsize=0)
94 try:
95 self.assertIsInstance(p.stdin, io.RawIOBase)
96 self.assertIsInstance(p.stdout, io.RawIOBase)
97 self.assertIsInstance(p.stderr, io.RawIOBase)
98 finally:
Gregory P. Smitha1b9ed32013-03-23 11:54:22 -070099 p.stdin.close()
100 p.stdout.close()
101 p.stderr.close()
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700102 p.wait()
103
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000104 def test_call_seq(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000105 # call() function with sequence argument
Tim Peters3b01a702004-10-12 22:19:32 +0000106 rc = subprocess.call([sys.executable, "-c",
107 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000108 self.assertEqual(rc, 47)
109
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400110 def test_call_timeout(self):
111 # call() function with timeout argument; we want to test that the child
112 # process gets killed when the timeout expires. If the child isn't
113 # killed, this call will deadlock since subprocess.call waits for the
114 # child.
115 self.assertRaises(subprocess.TimeoutExpired, subprocess.call,
116 [sys.executable, "-c", "while True: pass"],
117 timeout=0.1)
118
Peter Astrand454f7672005-01-01 09:36:35 +0000119 def test_check_call_zero(self):
120 # check_call() function with zero return code
121 rc = subprocess.check_call([sys.executable, "-c",
122 "import sys; sys.exit(0)"])
123 self.assertEqual(rc, 0)
124
125 def test_check_call_nonzero(self):
126 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000127 with self.assertRaises(subprocess.CalledProcessError) as c:
Peter Astrand454f7672005-01-01 09:36:35 +0000128 subprocess.check_call([sys.executable, "-c",
129 "import sys; sys.exit(47)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000130 self.assertEqual(c.exception.returncode, 47)
Peter Astrand454f7672005-01-01 09:36:35 +0000131
Georg Brandlf9734072008-12-07 15:30:06 +0000132 def test_check_output(self):
133 # check_output() function with zero return code
134 output = subprocess.check_output(
135 [sys.executable, "-c", "print('BDFL')"])
Benjamin Peterson577473f2010-01-19 00:09:57 +0000136 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +0000137
138 def test_check_output_nonzero(self):
139 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000140 with self.assertRaises(subprocess.CalledProcessError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +0000141 subprocess.check_output(
142 [sys.executable, "-c", "import sys; sys.exit(5)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000143 self.assertEqual(c.exception.returncode, 5)
Georg Brandlf9734072008-12-07 15:30:06 +0000144
145 def test_check_output_stderr(self):
146 # check_output() function stderr redirected to stdout
147 output = subprocess.check_output(
148 [sys.executable, "-c", "import sys; sys.stderr.write('BDFL')"],
149 stderr=subprocess.STDOUT)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000150 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +0000151
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300152 def test_check_output_stdin_arg(self):
153 # check_output() can be called with stdin set to a file
154 tf = tempfile.TemporaryFile()
155 self.addCleanup(tf.close)
156 tf.write(b'pear')
157 tf.seek(0)
158 output = subprocess.check_output(
159 [sys.executable, "-c",
160 "import sys; sys.stdout.write(sys.stdin.read().upper())"],
161 stdin=tf)
162 self.assertIn(b'PEAR', output)
163
164 def test_check_output_input_arg(self):
165 # check_output() can be called with input set to a string
166 output = subprocess.check_output(
167 [sys.executable, "-c",
168 "import sys; sys.stdout.write(sys.stdin.read().upper())"],
169 input=b'pear')
170 self.assertIn(b'PEAR', output)
171
Georg Brandlf9734072008-12-07 15:30:06 +0000172 def test_check_output_stdout_arg(self):
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300173 # check_output() refuses to accept 'stdout' argument
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000174 with self.assertRaises(ValueError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +0000175 output = subprocess.check_output(
176 [sys.executable, "-c", "print('will not be run')"],
177 stdout=sys.stdout)
Georg Brandlf9734072008-12-07 15:30:06 +0000178 self.fail("Expected ValueError when stdout arg supplied.")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000179 self.assertIn('stdout', c.exception.args[0])
Georg Brandlf9734072008-12-07 15:30:06 +0000180
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300181 def test_check_output_stdin_with_input_arg(self):
182 # check_output() refuses to accept 'stdin' with 'input'
183 tf = tempfile.TemporaryFile()
184 self.addCleanup(tf.close)
185 tf.write(b'pear')
186 tf.seek(0)
187 with self.assertRaises(ValueError) as c:
188 output = subprocess.check_output(
189 [sys.executable, "-c", "print('will not be run')"],
190 stdin=tf, input=b'hare')
191 self.fail("Expected ValueError when stdin and input args supplied.")
192 self.assertIn('stdin', c.exception.args[0])
193 self.assertIn('input', c.exception.args[0])
194
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400195 def test_check_output_timeout(self):
196 # check_output() function with timeout arg
197 with self.assertRaises(subprocess.TimeoutExpired) as c:
198 output = subprocess.check_output(
199 [sys.executable, "-c",
Victor Stinner149b1c72011-06-06 23:43:02 +0200200 "import sys, time\n"
201 "sys.stdout.write('BDFL')\n"
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400202 "sys.stdout.flush()\n"
Victor Stinner149b1c72011-06-06 23:43:02 +0200203 "time.sleep(3600)"],
Reid Klecknerda9ac722011-03-16 17:08:21 -0400204 # Some heavily loaded buildbots (sparc Debian 3.x) require
205 # this much time to start and print.
206 timeout=3)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400207 self.fail("Expected TimeoutExpired.")
208 self.assertEqual(c.exception.output, b'BDFL')
209
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000210 def test_call_kwargs(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000211 # call() function with keyword args
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000212 newenv = os.environ.copy()
213 newenv["FRUIT"] = "banana"
214 rc = subprocess.call([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000215 'import sys, os;'
216 'sys.exit(os.getenv("FRUIT")=="banana")'],
217 env=newenv)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000218 self.assertEqual(rc, 1)
219
Victor Stinner87b9bc32011-06-01 00:57:47 +0200220 def test_invalid_args(self):
221 # Popen() called with invalid arguments should raise TypeError
222 # but Popen.__del__ should not complain (issue #12085)
223 with support.captured_stderr() as s:
224 self.assertRaises(TypeError, subprocess.Popen, invalid_arg_name=1)
225 argcount = subprocess.Popen.__init__.__code__.co_argcount
226 too_many_args = [0] * (argcount + 1)
227 self.assertRaises(TypeError, subprocess.Popen, *too_many_args)
228 self.assertEqual(s.getvalue(), '')
229
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000230 def test_stdin_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000231 # .stdin is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000232 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000233 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000234 self.addCleanup(p.stdout.close)
235 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000236 p.wait()
237 self.assertEqual(p.stdin, None)
238
239 def test_stdout_none(self):
Ezio Melotti42a541b2013-03-11 05:53:34 +0200240 # .stdout is None when not redirected, and the child's stdout will
241 # be inherited from the parent. In order to test this we run a
242 # subprocess in a subprocess:
243 # this_test
244 # \-- subprocess created by this test (parent)
245 # \-- subprocess created by the parent subprocess (child)
246 # The parent doesn't specify stdout, so the child will use the
247 # parent's stdout. This test checks that the message printed by the
248 # child goes to the parent stdout. The parent also checks that the
249 # child's stdout is None. See #11963.
250 code = ('import sys; from subprocess import Popen, PIPE;'
251 'p = Popen([sys.executable, "-c", "print(\'test_stdout_none\')"],'
252 ' stdin=PIPE, stderr=PIPE);'
253 'p.wait(); assert p.stdout is None;')
254 p = subprocess.Popen([sys.executable, "-c", code],
255 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
256 self.addCleanup(p.stdout.close)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000257 self.addCleanup(p.stderr.close)
Ezio Melotti42a541b2013-03-11 05:53:34 +0200258 out, err = p.communicate()
259 self.assertEqual(p.returncode, 0, err)
260 self.assertEqual(out.rstrip(), b'test_stdout_none')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000261
262 def test_stderr_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000263 # .stderr is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000264 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000265 stdin=subprocess.PIPE, stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000266 self.addCleanup(p.stdout.close)
267 self.addCleanup(p.stdin.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000268 p.wait()
269 self.assertEqual(p.stderr, None)
270
Chris Jerdonek776cb192012-10-08 15:56:43 -0700271 def _assert_python(self, pre_args, **kwargs):
272 # We include sys.exit() to prevent the test runner from hanging
273 # whenever python is found.
274 args = pre_args + ["import sys; sys.exit(47)"]
275 p = subprocess.Popen(args, **kwargs)
276 p.wait()
277 self.assertEqual(47, p.returncode)
278
279 def test_executable(self):
280 # Check that the executable argument works.
Chris Jerdonek86b0fb22012-10-09 13:17:49 -0700281 #
282 # On Unix (non-Mac and non-Windows), Python looks at args[0] to
283 # determine where its standard library is, so we need the directory
284 # of args[0] to be valid for the Popen() call to Python to succeed.
285 # See also issue #16170 and issue #7774.
286 doesnotexist = os.path.join(os.path.dirname(sys.executable),
287 "doesnotexist")
288 self._assert_python([doesnotexist, "-c"], executable=sys.executable)
Chris Jerdonek776cb192012-10-08 15:56:43 -0700289
290 def test_executable_takes_precedence(self):
291 # Check that the executable argument takes precedence over args[0].
292 #
293 # Verify first that the call succeeds without the executable arg.
294 pre_args = [sys.executable, "-c"]
295 self._assert_python(pre_args)
296 self.assertRaises(FileNotFoundError, self._assert_python, pre_args,
297 executable="doesnotexist")
298
299 @unittest.skipIf(mswindows, "executable argument replaces shell")
300 def test_executable_replaces_shell(self):
301 # Check that the executable argument replaces the default shell
302 # when shell=True.
303 self._assert_python([], executable=sys.executable, shell=True)
304
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700305 # For use in the test_cwd* tests below.
306 def _normalize_cwd(self, cwd):
307 # Normalize an expected cwd (for Tru64 support).
308 # We can't use os.path.realpath since it doesn't expand Tru64 {memb}
309 # strings. See bug #1063571.
Serhiy Storchaka2a23adf2015-09-06 14:13:25 +0300310 with support.change_cwd(cwd):
311 return os.getcwd()
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700312
313 # For use in the test_cwd* tests below.
314 def _split_python_path(self):
315 # Return normalized (python_dir, python_base).
316 python_path = os.path.realpath(sys.executable)
317 return os.path.split(python_path)
318
319 # For use in the test_cwd* tests below.
320 def _assert_cwd(self, expected_cwd, python_arg, **kwargs):
321 # Invoke Python via Popen, and assert that (1) the call succeeds,
322 # and that (2) the current working directory of the child process
323 # matches *expected_cwd*.
324 p = subprocess.Popen([python_arg, "-c",
325 "import os, sys; "
326 "sys.stdout.write(os.getcwd()); "
327 "sys.exit(47)"],
328 stdout=subprocess.PIPE,
329 **kwargs)
330 self.addCleanup(p.stdout.close)
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000331 p.wait()
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700332 self.assertEqual(47, p.returncode)
333 normcase = os.path.normcase
334 self.assertEqual(normcase(expected_cwd),
335 normcase(p.stdout.read().decode("utf-8")))
336
337 def test_cwd(self):
338 # Check that cwd changes the cwd for the child process.
339 temp_dir = tempfile.gettempdir()
340 temp_dir = self._normalize_cwd(temp_dir)
341 self._assert_cwd(temp_dir, sys.executable, cwd=temp_dir)
342
Chris Jerdonekc2cd6262012-09-30 09:45:00 -0700343 @unittest.skipIf(mswindows, "pending resolution of issue #15533")
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700344 def test_cwd_with_relative_arg(self):
345 # Check that Popen looks for args[0] relative to cwd if args[0]
346 # is relative.
347 python_dir, python_base = self._split_python_path()
348 rel_python = os.path.join(os.curdir, python_base)
349 with support.temp_cwd() as wrong_dir:
350 # Before calling with the correct cwd, confirm that the call fails
351 # without cwd and with the wrong cwd.
Chris Jerdonek28714c82012-09-30 02:15:37 -0700352 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700353 [rel_python])
Chris Jerdonek28714c82012-09-30 02:15:37 -0700354 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700355 [rel_python], cwd=wrong_dir)
356 python_dir = self._normalize_cwd(python_dir)
357 self._assert_cwd(python_dir, rel_python, cwd=python_dir)
358
Chris Jerdonekc2cd6262012-09-30 09:45:00 -0700359 @unittest.skipIf(mswindows, "pending resolution of issue #15533")
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700360 def test_cwd_with_relative_executable(self):
361 # Check that Popen looks for executable relative to cwd if executable
362 # is relative (and that executable takes precedence over args[0]).
363 python_dir, python_base = self._split_python_path()
364 rel_python = os.path.join(os.curdir, python_base)
365 doesntexist = "somethingyoudonthave"
366 with support.temp_cwd() as wrong_dir:
367 # Before calling with the correct cwd, confirm that the call fails
368 # without cwd and with the wrong cwd.
Chris Jerdonek28714c82012-09-30 02:15:37 -0700369 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700370 [doesntexist], executable=rel_python)
Chris Jerdonek28714c82012-09-30 02:15:37 -0700371 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700372 [doesntexist], executable=rel_python,
373 cwd=wrong_dir)
374 python_dir = self._normalize_cwd(python_dir)
375 self._assert_cwd(python_dir, doesntexist, executable=rel_python,
376 cwd=python_dir)
377
378 def test_cwd_with_absolute_arg(self):
379 # Check that Popen can find the executable when the cwd is wrong
380 # if args[0] is an absolute path.
381 python_dir, python_base = self._split_python_path()
382 abs_python = os.path.join(python_dir, python_base)
383 rel_python = os.path.join(os.curdir, python_base)
Berker Peksagce643912015-05-06 06:33:17 +0300384 with support.temp_dir() as wrong_dir:
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700385 # Before calling with an absolute path, confirm that using a
386 # relative path fails.
Chris Jerdonek28714c82012-09-30 02:15:37 -0700387 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700388 [rel_python], cwd=wrong_dir)
389 wrong_dir = self._normalize_cwd(wrong_dir)
390 self._assert_cwd(wrong_dir, abs_python, cwd=wrong_dir)
391
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100392 @unittest.skipIf(sys.base_prefix != sys.prefix,
393 'Test is not venv-compatible')
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000394 def test_executable_with_cwd(self):
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700395 python_dir, python_base = self._split_python_path()
396 python_dir = self._normalize_cwd(python_dir)
397 self._assert_cwd(python_dir, "somethingyoudonthave",
398 executable=sys.executable, cwd=python_dir)
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000399
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100400 @unittest.skipIf(sys.base_prefix != sys.prefix,
401 'Test is not venv-compatible')
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000402 @unittest.skipIf(sysconfig.is_python_build(),
403 "need an installed Python. See #7774")
404 def test_executable_without_cwd(self):
405 # For a normal installation, it should work without 'cwd'
406 # argument. For test runs in the build directory, see #7774.
Ned Deilye92dfbf2013-08-02 18:02:21 -0700407 self._assert_cwd(os.getcwd(), "somethingyoudonthave",
408 executable=sys.executable)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000409
410 def test_stdin_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000411 # stdin redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000412 p = subprocess.Popen([sys.executable, "-c",
413 'import sys; sys.exit(sys.stdin.read() == "pear")'],
414 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000415 p.stdin.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000416 p.stdin.close()
417 p.wait()
418 self.assertEqual(p.returncode, 1)
419
420 def test_stdin_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000421 # stdin is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000422 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000423 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000424 d = tf.fileno()
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000425 os.write(d, b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000426 os.lseek(d, 0, 0)
427 p = subprocess.Popen([sys.executable, "-c",
428 'import sys; sys.exit(sys.stdin.read() == "pear")'],
429 stdin=d)
430 p.wait()
431 self.assertEqual(p.returncode, 1)
432
433 def test_stdin_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000434 # stdin is set to open file object
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000435 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000436 self.addCleanup(tf.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000437 tf.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000438 tf.seek(0)
439 p = subprocess.Popen([sys.executable, "-c",
440 'import sys; sys.exit(sys.stdin.read() == "pear")'],
441 stdin=tf)
442 p.wait()
443 self.assertEqual(p.returncode, 1)
444
445 def test_stdout_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000446 # stdout redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000447 p = subprocess.Popen([sys.executable, "-c",
448 'import sys; sys.stdout.write("orange")'],
449 stdout=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +0200450 with p:
451 self.assertEqual(p.stdout.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000452
453 def test_stdout_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000454 # stdout is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000455 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000456 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000457 d = tf.fileno()
458 p = subprocess.Popen([sys.executable, "-c",
459 'import sys; sys.stdout.write("orange")'],
460 stdout=d)
461 p.wait()
462 os.lseek(d, 0, 0)
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000463 self.assertEqual(os.read(d, 1024), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000464
465 def test_stdout_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000466 # stdout is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000467 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000468 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000469 p = subprocess.Popen([sys.executable, "-c",
470 'import sys; sys.stdout.write("orange")'],
471 stdout=tf)
472 p.wait()
473 tf.seek(0)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000474 self.assertEqual(tf.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000475
476 def test_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000477 # stderr redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000478 p = subprocess.Popen([sys.executable, "-c",
479 'import sys; sys.stderr.write("strawberry")'],
480 stderr=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +0200481 with p:
482 self.assertStderrEqual(p.stderr.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000483
484 def test_stderr_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000485 # stderr is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000486 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000487 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000488 d = tf.fileno()
489 p = subprocess.Popen([sys.executable, "-c",
490 'import sys; sys.stderr.write("strawberry")'],
491 stderr=d)
492 p.wait()
493 os.lseek(d, 0, 0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000494 self.assertStderrEqual(os.read(d, 1024), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000495
496 def test_stderr_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000497 # stderr is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000498 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000499 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000500 p = subprocess.Popen([sys.executable, "-c",
501 'import sys; sys.stderr.write("strawberry")'],
502 stderr=tf)
503 p.wait()
504 tf.seek(0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000505 self.assertStderrEqual(tf.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000506
Martin Panterc7635892016-05-13 01:54:44 +0000507 def test_stderr_redirect_with_no_stdout_redirect(self):
508 # test stderr=STDOUT while stdout=None (not set)
509
510 # - grandchild prints to stderr
511 # - child redirects grandchild's stderr to its stdout
512 # - the parent should get grandchild's stderr in child's stdout
513 p = subprocess.Popen([sys.executable, "-c",
514 'import sys, subprocess;'
515 'rc = subprocess.call([sys.executable, "-c",'
516 ' "import sys;"'
517 ' "sys.stderr.write(\'42\')"],'
518 ' stderr=subprocess.STDOUT);'
519 'sys.exit(rc)'],
520 stdout=subprocess.PIPE,
521 stderr=subprocess.PIPE)
522 stdout, stderr = p.communicate()
523 #NOTE: stdout should get stderr from grandchild
524 self.assertStderrEqual(stdout, b'42')
525 self.assertStderrEqual(stderr, b'') # should be empty
526 self.assertEqual(p.returncode, 0)
527
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000528 def test_stdout_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000529 # capture stdout and stderr to the same pipe
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000530 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000531 'import sys;'
532 'sys.stdout.write("apple");'
533 'sys.stdout.flush();'
534 'sys.stderr.write("orange")'],
535 stdout=subprocess.PIPE,
536 stderr=subprocess.STDOUT)
Victor Stinner7438c612016-05-20 12:43:15 +0200537 with p:
538 self.assertStderrEqual(p.stdout.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000539
540 def test_stdout_stderr_file(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000541 # capture stdout and stderr to the same open file
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000542 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000543 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000544 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000545 'import sys;'
546 'sys.stdout.write("apple");'
547 'sys.stdout.flush();'
548 'sys.stderr.write("orange")'],
549 stdout=tf,
550 stderr=tf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000551 p.wait()
552 tf.seek(0)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000553 self.assertStderrEqual(tf.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000554
Thomas Wouters89f507f2006-12-13 04:49:30 +0000555 def test_stdout_filedes_of_stdout(self):
556 # stdout is set to 1 (#1531862).
Ezio Melotti42a541b2013-03-11 05:53:34 +0200557 # To avoid printing the text on stdout, we do something similar to
558 # test_stdout_none (see above). The parent subprocess calls the child
559 # subprocess passing stdout=1, and this test uses stdout=PIPE in
560 # order to capture and check the output of the parent. See #11963.
561 code = ('import sys, subprocess; '
562 'rc = subprocess.call([sys.executable, "-c", '
563 ' "import os, sys; sys.exit(os.write(sys.stdout.fileno(), '
564 'b\'test with stdout=1\'))"], stdout=1); '
565 'assert rc == 18')
566 p = subprocess.Popen([sys.executable, "-c", code],
567 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
568 self.addCleanup(p.stdout.close)
569 self.addCleanup(p.stderr.close)
570 out, err = p.communicate()
571 self.assertEqual(p.returncode, 0, err)
572 self.assertEqual(out.rstrip(), b'test with stdout=1')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000573
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200574 def test_stdout_devnull(self):
575 p = subprocess.Popen([sys.executable, "-c",
576 'for i in range(10240):'
577 'print("x" * 1024)'],
578 stdout=subprocess.DEVNULL)
579 p.wait()
580 self.assertEqual(p.stdout, None)
581
582 def test_stderr_devnull(self):
583 p = subprocess.Popen([sys.executable, "-c",
584 'import sys\n'
585 'for i in range(10240):'
586 'sys.stderr.write("x" * 1024)'],
587 stderr=subprocess.DEVNULL)
588 p.wait()
589 self.assertEqual(p.stderr, None)
590
591 def test_stdin_devnull(self):
592 p = subprocess.Popen([sys.executable, "-c",
593 'import sys;'
594 'sys.stdin.read(1)'],
595 stdin=subprocess.DEVNULL)
596 p.wait()
597 self.assertEqual(p.stdin, None)
598
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000599 def test_env(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000600 newenv = os.environ.copy()
601 newenv["FRUIT"] = "orange"
Victor Stinnerf1512a22011-06-21 17:18:38 +0200602 with subprocess.Popen([sys.executable, "-c",
603 'import sys,os;'
604 'sys.stdout.write(os.getenv("FRUIT"))'],
605 stdout=subprocess.PIPE,
606 env=newenv) as p:
607 stdout, stderr = p.communicate()
608 self.assertEqual(stdout, b"orange")
609
Victor Stinner62d51182011-06-23 01:02:25 +0200610 # Windows requires at least the SYSTEMROOT environment variable to start
611 # Python
612 @unittest.skipIf(sys.platform == 'win32',
613 'cannot test an empty env on Windows')
Victor Stinner237e5cb2011-06-22 21:28:43 +0200614 @unittest.skipIf(sysconfig.get_config_var('Py_ENABLE_SHARED') is not None,
Victor Stinner372309a2011-06-21 21:59:06 +0200615 'the python library cannot be loaded '
616 'with an empty environment')
Victor Stinnerf1512a22011-06-21 17:18:38 +0200617 def test_empty_env(self):
618 with subprocess.Popen([sys.executable, "-c",
619 'import os; '
Victor Stinner372309a2011-06-21 21:59:06 +0200620 'print(list(os.environ.keys()))'],
Victor Stinnerf1512a22011-06-21 17:18:38 +0200621 stdout=subprocess.PIPE,
622 env={}) as p:
623 stdout, stderr = p.communicate()
Victor Stinner237e5cb2011-06-22 21:28:43 +0200624 self.assertIn(stdout.strip(),
625 (b"[]",
626 # Mac OS X adds __CF_USER_TEXT_ENCODING variable to an empty
627 # environment
628 b"['__CF_USER_TEXT_ENCODING']"))
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000629
Peter Astrandcbac93c2005-03-03 20:24:28 +0000630 def test_communicate_stdin(self):
631 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000632 'import sys;'
633 'sys.exit(sys.stdin.read() == "pear")'],
Peter Astrandcbac93c2005-03-03 20:24:28 +0000634 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000635 p.communicate(b"pear")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000636 self.assertEqual(p.returncode, 1)
637
638 def test_communicate_stdout(self):
639 p = subprocess.Popen([sys.executable, "-c",
640 'import sys; sys.stdout.write("pineapple")'],
641 stdout=subprocess.PIPE)
642 (stdout, stderr) = p.communicate()
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000643 self.assertEqual(stdout, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000644 self.assertEqual(stderr, None)
645
646 def test_communicate_stderr(self):
647 p = subprocess.Popen([sys.executable, "-c",
648 'import sys; sys.stderr.write("pineapple")'],
649 stderr=subprocess.PIPE)
650 (stdout, stderr) = p.communicate()
651 self.assertEqual(stdout, None)
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000652 self.assertStderrEqual(stderr, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000653
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000654 def test_communicate(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000655 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000656 'import sys,os;'
657 'sys.stderr.write("pineapple");'
658 'sys.stdout.write(sys.stdin.read())'],
659 stdin=subprocess.PIPE,
660 stdout=subprocess.PIPE,
661 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000662 self.addCleanup(p.stdout.close)
663 self.addCleanup(p.stderr.close)
664 self.addCleanup(p.stdin.close)
Georg Brandl1abcbf82008-07-01 19:28:43 +0000665 (stdout, stderr) = p.communicate(b"banana")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000666 self.assertEqual(stdout, b"banana")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000667 self.assertStderrEqual(stderr, b"pineapple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000668
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400669 def test_communicate_timeout(self):
670 p = subprocess.Popen([sys.executable, "-c",
671 'import sys,os,time;'
672 'sys.stderr.write("pineapple\\n");'
673 'time.sleep(1);'
674 'sys.stderr.write("pear\\n");'
675 'sys.stdout.write(sys.stdin.read())'],
676 universal_newlines=True,
677 stdin=subprocess.PIPE,
678 stdout=subprocess.PIPE,
679 stderr=subprocess.PIPE)
680 self.assertRaises(subprocess.TimeoutExpired, p.communicate, "banana",
681 timeout=0.3)
682 # Make sure we can keep waiting for it, and that we get the whole output
683 # after it completes.
684 (stdout, stderr) = p.communicate()
685 self.assertEqual(stdout, "banana")
686 self.assertStderrEqual(stderr.encode(), b"pineapple\npear\n")
687
Raymond Hettinger15f44ab2016-08-30 10:47:49 -0700688 def test_communicate_timeout_large_output(self):
Ross Lagerwall003c7a32012-02-12 09:02:01 +0200689 # Test an expiring timeout while the child is outputting lots of data.
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400690 p = subprocess.Popen([sys.executable, "-c",
691 'import sys,os,time;'
692 'sys.stdout.write("a" * (64 * 1024));'
693 'time.sleep(0.2);'
694 'sys.stdout.write("a" * (64 * 1024));'
695 'time.sleep(0.2);'
696 'sys.stdout.write("a" * (64 * 1024));'
697 'time.sleep(0.2);'
698 'sys.stdout.write("a" * (64 * 1024));'],
699 stdout=subprocess.PIPE)
700 self.assertRaises(subprocess.TimeoutExpired, p.communicate, timeout=0.4)
701 (stdout, _) = p.communicate()
702 self.assertEqual(len(stdout), 4 * 64 * 1024)
703
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000704 # Test for the fd leak reported in http://bugs.python.org/issue2791.
705 def test_communicate_pipe_fd_leak(self):
Victor Stinner667d4b52010-12-25 22:40:32 +0000706 for stdin_pipe in (False, True):
707 for stdout_pipe in (False, True):
708 for stderr_pipe in (False, True):
709 options = {}
710 if stdin_pipe:
711 options['stdin'] = subprocess.PIPE
712 if stdout_pipe:
713 options['stdout'] = subprocess.PIPE
714 if stderr_pipe:
715 options['stderr'] = subprocess.PIPE
716 if not options:
717 continue
718 p = subprocess.Popen((sys.executable, "-c", "pass"), **options)
719 p.communicate()
720 if p.stdin is not None:
721 self.assertTrue(p.stdin.closed)
722 if p.stdout is not None:
723 self.assertTrue(p.stdout.closed)
724 if p.stderr is not None:
725 self.assertTrue(p.stderr.closed)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000726
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000727 def test_communicate_returns(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000728 # communicate() should return None if no redirection is active
Tim Peters3b01a702004-10-12 22:19:32 +0000729 p = subprocess.Popen([sys.executable, "-c",
730 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000731 (stdout, stderr) = p.communicate()
732 self.assertEqual(stdout, None)
733 self.assertEqual(stderr, None)
734
735 def test_communicate_pipe_buf(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000736 # communicate() with writes larger than pipe_buf
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000737 # This test will probably deadlock rather than fail, if
Tim Peterse718f612004-10-12 21:51:32 +0000738 # communicate() does not work properly.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000739 x, y = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000740 os.close(x)
741 os.close(y)
742 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000743 'import sys,os;'
744 'sys.stdout.write(sys.stdin.read(47));'
Charles-François Natali2d517212011-05-29 16:36:44 +0200745 'sys.stderr.write("x" * %d);'
746 'sys.stdout.write(sys.stdin.read())' %
747 support.PIPE_MAX_SIZE],
Guido van Rossum98297ee2007-11-06 21:34:58 +0000748 stdin=subprocess.PIPE,
749 stdout=subprocess.PIPE,
750 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000751 self.addCleanup(p.stdout.close)
752 self.addCleanup(p.stderr.close)
753 self.addCleanup(p.stdin.close)
Charles-François Natali2d517212011-05-29 16:36:44 +0200754 string_to_write = b"a" * support.PIPE_MAX_SIZE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000755 (stdout, stderr) = p.communicate(string_to_write)
756 self.assertEqual(stdout, string_to_write)
757
758 def test_writes_before_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000759 # stdin.write before communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000760 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000761 'import sys,os;'
762 'sys.stdout.write(sys.stdin.read())'],
763 stdin=subprocess.PIPE,
764 stdout=subprocess.PIPE,
765 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000766 self.addCleanup(p.stdout.close)
767 self.addCleanup(p.stderr.close)
768 self.addCleanup(p.stdin.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000769 p.stdin.write(b"banana")
770 (stdout, stderr) = p.communicate(b"split")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000771 self.assertEqual(stdout, b"bananasplit")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000772 self.assertStderrEqual(stderr, b"")
Tim Peterse718f612004-10-12 21:51:32 +0000773
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000774 def test_universal_newlines(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000775 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000776 'import sys,os;' + SETBINARY +
Antoine Pitrouec2d2692012-08-05 00:23:40 +0200777 'buf = sys.stdout.buffer;'
778 'buf.write(sys.stdin.readline().encode());'
779 'buf.flush();'
780 'buf.write(b"line2\\n");'
781 'buf.flush();'
782 'buf.write(sys.stdin.read().encode());'
783 'buf.flush();'
784 'buf.write(b"line4\\n");'
785 'buf.flush();'
786 'buf.write(b"line5\\r\\n");'
787 'buf.flush();'
788 'buf.write(b"line6\\r");'
789 'buf.flush();'
790 'buf.write(b"\\nline7");'
791 'buf.flush();'
792 'buf.write(b"\\nline8");'],
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200793 stdin=subprocess.PIPE,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000794 stdout=subprocess.PIPE,
795 universal_newlines=1)
Victor Stinner7438c612016-05-20 12:43:15 +0200796 with p:
797 p.stdin.write("line1\n")
798 p.stdin.flush()
799 self.assertEqual(p.stdout.readline(), "line1\n")
800 p.stdin.write("line3\n")
801 p.stdin.close()
802 self.addCleanup(p.stdout.close)
803 self.assertEqual(p.stdout.readline(),
804 "line2\n")
805 self.assertEqual(p.stdout.read(6),
806 "line3\n")
807 self.assertEqual(p.stdout.read(),
808 "line4\nline5\nline6\nline7\nline8")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000809
810 def test_universal_newlines_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000811 # universal newlines through communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000812 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000813 'import sys,os;' + SETBINARY +
Antoine Pitrouec2d2692012-08-05 00:23:40 +0200814 'buf = sys.stdout.buffer;'
815 'buf.write(b"line2\\n");'
816 'buf.flush();'
817 'buf.write(b"line4\\n");'
818 'buf.flush();'
819 'buf.write(b"line5\\r\\n");'
820 'buf.flush();'
821 'buf.write(b"line6\\r");'
822 'buf.flush();'
823 'buf.write(b"\\nline7");'
824 'buf.flush();'
825 'buf.write(b"\\nline8");'],
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200826 stderr=subprocess.PIPE,
827 stdout=subprocess.PIPE,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000828 universal_newlines=1)
Brian Curtin19a53792010-11-05 17:09:05 +0000829 self.addCleanup(p.stdout.close)
830 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000831 (stdout, stderr) = p.communicate()
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200832 self.assertEqual(stdout,
833 "line2\nline4\nline5\nline6\nline7\nline8")
834
835 def test_universal_newlines_communicate_stdin(self):
836 # universal newlines through communicate(), with only stdin
837 p = subprocess.Popen([sys.executable, "-c",
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300838 'import sys,os;' + SETBINARY + textwrap.dedent('''
839 s = sys.stdin.readline()
840 assert s == "line1\\n", repr(s)
841 s = sys.stdin.read()
842 assert s == "line3\\n", repr(s)
843 ''')],
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200844 stdin=subprocess.PIPE,
845 universal_newlines=1)
846 (stdout, stderr) = p.communicate("line1\nline3\n")
847 self.assertEqual(p.returncode, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000848
Andrew Svetlovf3765072012-08-14 18:35:17 +0300849 def test_universal_newlines_communicate_input_none(self):
850 # Test communicate(input=None) with universal newlines.
851 #
852 # We set stdout to PIPE because, as of this writing, a different
853 # code path is tested when the number of pipes is zero or one.
854 p = subprocess.Popen([sys.executable, "-c", "pass"],
855 stdin=subprocess.PIPE,
856 stdout=subprocess.PIPE,
857 universal_newlines=True)
858 p.communicate()
859 self.assertEqual(p.returncode, 0)
860
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300861 def test_universal_newlines_communicate_stdin_stdout_stderr(self):
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300862 # universal newlines through communicate(), with stdin, stdout, stderr
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300863 p = subprocess.Popen([sys.executable, "-c",
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300864 'import sys,os;' + SETBINARY + textwrap.dedent('''
865 s = sys.stdin.buffer.readline()
866 sys.stdout.buffer.write(s)
867 sys.stdout.buffer.write(b"line2\\r")
868 sys.stderr.buffer.write(b"eline2\\n")
869 s = sys.stdin.buffer.read()
870 sys.stdout.buffer.write(s)
871 sys.stdout.buffer.write(b"line4\\n")
872 sys.stdout.buffer.write(b"line5\\r\\n")
873 sys.stderr.buffer.write(b"eline6\\r")
874 sys.stderr.buffer.write(b"eline7\\r\\nz")
875 ''')],
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300876 stdin=subprocess.PIPE,
877 stderr=subprocess.PIPE,
878 stdout=subprocess.PIPE,
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300879 universal_newlines=True)
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300880 self.addCleanup(p.stdout.close)
881 self.addCleanup(p.stderr.close)
882 (stdout, stderr) = p.communicate("line1\nline3\n")
883 self.assertEqual(p.returncode, 0)
Andrew Svetlov943c5b32012-08-16 20:17:47 +0300884 self.assertEqual("line1\nline2\nline3\nline4\nline5\n", stdout)
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300885 # Python debug build push something like "[42442 refs]\n"
886 # to stderr at exit of subprocess.
Andrew Svetlov943c5b32012-08-16 20:17:47 +0300887 # Don't use assertStderrEqual because it strips CR and LF from output.
888 self.assertTrue(stderr.startswith("eline2\neline6\neline7\n"))
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300889
Andrew Svetlov82860712012-08-19 22:13:41 +0300890 def test_universal_newlines_communicate_encodings(self):
891 # Check that universal newlines mode works for various encodings,
892 # in particular for encodings in the UTF-16 and UTF-32 families.
893 # See issue #15595.
894 #
895 # UTF-16 and UTF-32-BE are sufficient to check both with BOM and
896 # without, and UTF-16 and UTF-32.
897 for encoding in ['utf-16', 'utf-32-be']:
Andrew Svetlov82860712012-08-19 22:13:41 +0300898 code = ("import sys; "
899 r"sys.stdout.buffer.write('1\r\n2\r3\n4'.encode('%s'))" %
900 encoding)
901 args = [sys.executable, '-c', code]
Steve Dower050acae2016-09-06 20:16:17 -0700902 # We set stdin to be non-None because, as of this writing,
903 # a different code path is used when the number of pipes is
904 # zero or one.
905 popen = subprocess.Popen(args,
906 stdin=subprocess.PIPE,
907 stdout=subprocess.PIPE,
908 encoding=encoding)
909 stdout, stderr = popen.communicate(input='')
Andrew Svetlov82860712012-08-19 22:13:41 +0300910 self.assertEqual(stdout, '1\n2\n3\n4')
911
Steve Dower050acae2016-09-06 20:16:17 -0700912 def test_communicate_errors(self):
913 for errors, expected in [
914 ('ignore', ''),
915 ('replace', '\ufffd\ufffd'),
916 ('surrogateescape', '\udc80\udc80'),
917 ('backslashreplace', '\\x80\\x80'),
918 ]:
919 code = ("import sys; "
920 r"sys.stdout.buffer.write(b'[\x80\x80]')")
921 args = [sys.executable, '-c', code]
922 # We set stdin to be non-None because, as of this writing,
923 # a different code path is used when the number of pipes is
924 # zero or one.
925 popen = subprocess.Popen(args,
926 stdin=subprocess.PIPE,
927 stdout=subprocess.PIPE,
928 encoding='utf-8',
929 errors=errors)
930 stdout, stderr = popen.communicate(input='')
931 self.assertEqual(stdout, '[{}]'.format(expected))
932
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000933 def test_no_leaking(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000934 # Make sure we leak no resources
Antoine Pitrou8db30272010-09-18 22:38:48 +0000935 if not mswindows:
Peter Astrandf7f1bb72005-03-03 20:47:37 +0000936 max_handles = 1026 # too much for most UNIX systems
937 else:
Antoine Pitrou8db30272010-09-18 22:38:48 +0000938 max_handles = 2050 # too much for (at least some) Windows setups
939 handles = []
Gregory P. Smith81ce6852011-03-15 02:04:11 -0400940 tmpdir = tempfile.mkdtemp()
Antoine Pitrou8db30272010-09-18 22:38:48 +0000941 try:
942 for i in range(max_handles):
943 try:
Gregory P. Smith81ce6852011-03-15 02:04:11 -0400944 tmpfile = os.path.join(tmpdir, support.TESTFN)
945 handles.append(os.open(tmpfile, os.O_WRONLY|os.O_CREAT))
Antoine Pitrou8db30272010-09-18 22:38:48 +0000946 except OSError as e:
947 if e.errno != errno.EMFILE:
948 raise
949 break
950 else:
951 self.skipTest("failed to reach the file descriptor limit "
952 "(tried %d)" % max_handles)
953 # Close a couple of them (should be enough for a subprocess)
954 for i in range(10):
955 os.close(handles.pop())
956 # Loop creating some subprocesses. If one of them leaks some fds,
957 # the next loop iteration will fail by reaching the max fd limit.
958 for i in range(15):
959 p = subprocess.Popen([sys.executable, "-c",
960 "import sys;"
961 "sys.stdout.write(sys.stdin.read())"],
962 stdin=subprocess.PIPE,
963 stdout=subprocess.PIPE,
964 stderr=subprocess.PIPE)
965 data = p.communicate(b"lime")[0]
966 self.assertEqual(data, b"lime")
967 finally:
968 for h in handles:
969 os.close(h)
Gregory P. Smith81ce6852011-03-15 02:04:11 -0400970 shutil.rmtree(tmpdir)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000971
972 def test_list2cmdline(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000973 self.assertEqual(subprocess.list2cmdline(['a b c', 'd', 'e']),
974 '"a b c" d e')
975 self.assertEqual(subprocess.list2cmdline(['ab"c', '\\', 'd']),
976 'ab\\"c \\ d')
Christian Heimesfdab48e2008-01-20 09:06:41 +0000977 self.assertEqual(subprocess.list2cmdline(['ab"c', ' \\', 'd']),
978 'ab\\"c " \\\\" d')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000979 self.assertEqual(subprocess.list2cmdline(['a\\\\\\b', 'de fg', 'h']),
980 'a\\\\\\b "de fg" h')
981 self.assertEqual(subprocess.list2cmdline(['a\\"b', 'c', 'd']),
982 'a\\\\\\"b c d')
983 self.assertEqual(subprocess.list2cmdline(['a\\\\b c', 'd', 'e']),
984 '"a\\\\b c" d e')
985 self.assertEqual(subprocess.list2cmdline(['a\\\\b\\ c', 'd', 'e']),
986 '"a\\\\b\\ c" d e')
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +0000987 self.assertEqual(subprocess.list2cmdline(['ab', '']),
988 'ab ""')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000989
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000990 def test_poll(self):
Ross Lagerwallab66d2a2012-02-12 09:01:30 +0200991 p = subprocess.Popen([sys.executable, "-c",
Ross Lagerwalle7ad4192012-02-22 06:02:07 +0200992 "import os; os.read(0, 1)"],
993 stdin=subprocess.PIPE)
Ross Lagerwallab66d2a2012-02-12 09:01:30 +0200994 self.addCleanup(p.stdin.close)
995 self.assertIsNone(p.poll())
996 os.write(p.stdin.fileno(), b'A')
997 p.wait()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000998 # Subsequent invocations should just return the returncode
999 self.assertEqual(p.poll(), 0)
1000
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001001 def test_wait(self):
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001002 p = subprocess.Popen([sys.executable, "-c", "pass"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001003 self.assertEqual(p.wait(), 0)
1004 # Subsequent invocations should just return the returncode
1005 self.assertEqual(p.wait(), 0)
Tim Peterse718f612004-10-12 21:51:32 +00001006
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001007 def test_wait_timeout(self):
1008 p = subprocess.Popen([sys.executable,
Antoine Pitroudc49b2b2013-05-19 15:55:40 +02001009 "-c", "import time; time.sleep(0.3)"])
Reid Kleckner2b228f02011-03-16 16:57:54 -04001010 with self.assertRaises(subprocess.TimeoutExpired) as c:
Antoine Pitroudc49b2b2013-05-19 15:55:40 +02001011 p.wait(timeout=0.0001)
1012 self.assertIn("0.0001", str(c.exception)) # For coverage of __str__.
Reid Klecknerda9ac722011-03-16 17:08:21 -04001013 # Some heavily loaded buildbots (sparc Debian 3.x) require this much
1014 # time to start.
1015 self.assertEqual(p.wait(timeout=3), 0)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001016
Peter Astrand738131d2004-11-30 21:04:45 +00001017 def test_invalid_bufsize(self):
1018 # an invalid type of the bufsize argument should raise
1019 # TypeError.
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001020 with self.assertRaises(TypeError):
Peter Astrand738131d2004-11-30 21:04:45 +00001021 subprocess.Popen([sys.executable, "-c", "pass"], "orange")
Peter Astrand738131d2004-11-30 21:04:45 +00001022
Guido van Rossum46a05a72007-06-07 21:56:45 +00001023 def test_bufsize_is_none(self):
1024 # bufsize=None should be the same as bufsize=0.
1025 p = subprocess.Popen([sys.executable, "-c", "pass"], None)
1026 self.assertEqual(p.wait(), 0)
1027 # Again with keyword arg
1028 p = subprocess.Popen([sys.executable, "-c", "pass"], bufsize=None)
1029 self.assertEqual(p.wait(), 0)
1030
Antoine Pitrouafe8d062014-09-21 21:10:56 +02001031 def _test_bufsize_equal_one(self, line, expected, universal_newlines):
1032 # subprocess may deadlock with bufsize=1, see issue #21332
1033 with subprocess.Popen([sys.executable, "-c", "import sys;"
1034 "sys.stdout.write(sys.stdin.readline());"
1035 "sys.stdout.flush()"],
1036 stdin=subprocess.PIPE,
1037 stdout=subprocess.PIPE,
1038 stderr=subprocess.DEVNULL,
1039 bufsize=1,
1040 universal_newlines=universal_newlines) as p:
1041 p.stdin.write(line) # expect that it flushes the line in text mode
1042 os.close(p.stdin.fileno()) # close it without flushing the buffer
1043 read_line = p.stdout.readline()
1044 try:
1045 p.stdin.close()
1046 except OSError:
1047 pass
1048 p.stdin = None
1049 self.assertEqual(p.returncode, 0)
1050 self.assertEqual(read_line, expected)
1051
1052 def test_bufsize_equal_one_text_mode(self):
1053 # line is flushed in text mode with bufsize=1.
1054 # we should get the full line in return
1055 line = "line\n"
1056 self._test_bufsize_equal_one(line, line, universal_newlines=True)
1057
1058 def test_bufsize_equal_one_binary_mode(self):
1059 # line is not flushed in binary mode with bufsize=1.
1060 # we should get empty response
1061 line = b'line' + os.linesep.encode() # assume ascii-based locale
1062 self._test_bufsize_equal_one(line, b'', universal_newlines=False)
1063
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001064 def test_leaking_fds_on_error(self):
1065 # see bug #5179: Popen leaks file descriptors to PIPEs if
1066 # the child fails to execute; this will eventually exhaust
1067 # the maximum number of open fds. 1024 seems a very common
1068 # value for that limit, but Windows has 2048, so we loop
1069 # 1024 times (each call leaked two fds).
1070 for i in range(1024):
Andrew Svetlov3438fa42012-12-17 23:35:18 +02001071 with self.assertRaises(OSError) as c:
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001072 subprocess.Popen(['nonexisting_i_hope'],
1073 stdout=subprocess.PIPE,
1074 stderr=subprocess.PIPE)
R David Murray384069c2011-03-13 22:26:53 -04001075 # ignore errors that indicate the command was not found
R David Murray6924bd72011-03-13 22:48:55 -04001076 if c.exception.errno not in (errno.ENOENT, errno.EACCES):
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001077 raise c.exception
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001078
Antoine Pitroua8392712013-08-30 23:38:13 +02001079 @unittest.skipIf(threading is None, "threading required")
1080 def test_double_close_on_error(self):
1081 # Issue #18851
1082 fds = []
1083 def open_fds():
1084 for i in range(20):
1085 fds.extend(os.pipe())
1086 time.sleep(0.001)
1087 t = threading.Thread(target=open_fds)
1088 t.start()
1089 try:
1090 with self.assertRaises(EnvironmentError):
1091 subprocess.Popen(['nonexisting_i_hope'],
1092 stdin=subprocess.PIPE,
1093 stdout=subprocess.PIPE,
1094 stderr=subprocess.PIPE)
1095 finally:
1096 t.join()
1097 exc = None
1098 for fd in fds:
1099 # If a double close occurred, some of those fds will
1100 # already have been closed by mistake, and os.close()
1101 # here will raise.
1102 try:
1103 os.close(fd)
1104 except OSError as e:
1105 exc = e
1106 if exc is not None:
1107 raise exc
1108
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001109 @unittest.skipIf(threading is None, "threading required")
1110 def test_threadsafe_wait(self):
1111 """Issue21291: Popen.wait() needs to be threadsafe for returncode."""
1112 proc = subprocess.Popen([sys.executable, '-c',
1113 'import time; time.sleep(12)'])
1114 self.assertEqual(proc.returncode, None)
1115 results = []
1116
1117 def kill_proc_timer_thread():
1118 results.append(('thread-start-poll-result', proc.poll()))
1119 # terminate it from the thread and wait for the result.
1120 proc.kill()
1121 proc.wait()
1122 results.append(('thread-after-kill-and-wait', proc.returncode))
1123 # this wait should be a no-op given the above.
1124 proc.wait()
1125 results.append(('thread-after-second-wait', proc.returncode))
1126
1127 # This is a timing sensitive test, the failure mode is
1128 # triggered when both the main thread and this thread are in
1129 # the wait() call at once. The delay here is to allow the
1130 # main thread to most likely be blocked in its wait() call.
1131 t = threading.Timer(0.2, kill_proc_timer_thread)
1132 t.start()
1133
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001134 if mswindows:
1135 expected_errorcode = 1
1136 else:
1137 # Should be -9 because of the proc.kill() from the thread.
1138 expected_errorcode = -9
1139
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001140 # Wait for the process to finish; the thread should kill it
1141 # long before it finishes on its own. Supplying a timeout
1142 # triggers a different code path for better coverage.
1143 proc.wait(timeout=20)
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001144 self.assertEqual(proc.returncode, expected_errorcode,
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001145 msg="unexpected result in wait from main thread")
1146
1147 # This should be a no-op with no change in returncode.
1148 proc.wait()
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001149 self.assertEqual(proc.returncode, expected_errorcode,
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001150 msg="unexpected result in second main wait.")
1151
1152 t.join()
1153 # Ensure that all of the thread results are as expected.
1154 # When a race condition occurs in wait(), the returncode could
1155 # be set by the wrong thread that doesn't actually have it
1156 # leading to an incorrect value.
1157 self.assertEqual([('thread-start-poll-result', None),
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001158 ('thread-after-kill-and-wait', expected_errorcode),
1159 ('thread-after-second-wait', expected_errorcode)],
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001160 results)
1161
Victor Stinnerb3693582010-05-21 20:13:12 +00001162 def test_issue8780(self):
1163 # Ensure that stdout is inherited from the parent
1164 # if stdout=PIPE is not used
1165 code = ';'.join((
1166 'import subprocess, sys',
1167 'retcode = subprocess.call('
1168 "[sys.executable, '-c', 'print(\"Hello World!\")'])",
1169 'assert retcode == 0'))
1170 output = subprocess.check_output([sys.executable, '-c', code])
Ezio Melottib3aedd42010-11-20 19:04:17 +00001171 self.assertTrue(output.startswith(b'Hello World!'), ascii(output))
Victor Stinnerb3693582010-05-21 20:13:12 +00001172
Tim Goldenaf5ac392010-08-06 13:03:56 +00001173 def test_handles_closed_on_exception(self):
1174 # If CreateProcess exits with an error, ensure the
1175 # duplicate output handles are released
Berker Peksag16a1f282015-09-28 13:33:14 +03001176 ifhandle, ifname = tempfile.mkstemp()
1177 ofhandle, ofname = tempfile.mkstemp()
1178 efhandle, efname = tempfile.mkstemp()
Tim Goldenaf5ac392010-08-06 13:03:56 +00001179 try:
1180 subprocess.Popen (["*"], stdin=ifhandle, stdout=ofhandle,
1181 stderr=efhandle)
1182 except OSError:
1183 os.close(ifhandle)
1184 os.remove(ifname)
1185 os.close(ofhandle)
1186 os.remove(ofname)
1187 os.close(efhandle)
1188 os.remove(efname)
1189 self.assertFalse(os.path.exists(ifname))
1190 self.assertFalse(os.path.exists(ofname))
1191 self.assertFalse(os.path.exists(efname))
1192
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001193 def test_communicate_epipe(self):
1194 # Issue 10963: communicate() should hide EPIPE
1195 p = subprocess.Popen([sys.executable, "-c", 'pass'],
1196 stdin=subprocess.PIPE,
1197 stdout=subprocess.PIPE,
1198 stderr=subprocess.PIPE)
1199 self.addCleanup(p.stdout.close)
1200 self.addCleanup(p.stderr.close)
1201 self.addCleanup(p.stdin.close)
1202 p.communicate(b"x" * 2**20)
1203
1204 def test_communicate_epipe_only_stdin(self):
1205 # Issue 10963: communicate() should hide EPIPE
1206 p = subprocess.Popen([sys.executable, "-c", 'pass'],
1207 stdin=subprocess.PIPE)
1208 self.addCleanup(p.stdin.close)
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001209 p.wait()
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001210 p.communicate(b"x" * 2**20)
1211
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001212 @unittest.skipUnless(hasattr(signal, 'SIGUSR1'),
1213 "Requires signal.SIGUSR1")
1214 @unittest.skipUnless(hasattr(os, 'kill'),
1215 "Requires os.kill")
1216 @unittest.skipUnless(hasattr(os, 'getppid'),
1217 "Requires os.getppid")
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001218 def test_communicate_eintr(self):
1219 # Issue #12493: communicate() should handle EINTR
1220 def handler(signum, frame):
1221 pass
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001222 old_handler = signal.signal(signal.SIGUSR1, handler)
1223 self.addCleanup(signal.signal, signal.SIGUSR1, old_handler)
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001224
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001225 args = [sys.executable, "-c",
1226 'import os, signal;'
1227 'os.kill(os.getppid(), signal.SIGUSR1)']
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001228 for stream in ('stdout', 'stderr'):
1229 kw = {stream: subprocess.PIPE}
1230 with subprocess.Popen(args, **kw) as process:
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001231 # communicate() will be interrupted by SIGUSR1
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001232 process.communicate()
1233
Tim Peterse718f612004-10-12 21:51:32 +00001234
Gregory P. Smith3d8e7762012-11-10 22:32:22 -08001235 # This test is Linux-ish specific for simplicity to at least have
1236 # some coverage. It is not a platform specific bug.
1237 @unittest.skipUnless(os.path.isdir('/proc/%d/fd' % os.getpid()),
1238 "Linux specific")
1239 def test_failed_child_execute_fd_leak(self):
1240 """Test for the fork() failure fd leak reported in issue16327."""
1241 fd_directory = '/proc/%d/fd' % os.getpid()
1242 fds_before_popen = os.listdir(fd_directory)
1243 with self.assertRaises(PopenTestException):
1244 PopenExecuteChildRaises(
1245 [sys.executable, '-c', 'pass'], stdin=subprocess.PIPE,
1246 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1247
1248 # NOTE: This test doesn't verify that the real _execute_child
1249 # does not close the file descriptors itself on the way out
1250 # during an exception. Code inspection has confirmed that.
1251
1252 fds_after_exception = os.listdir(fd_directory)
1253 self.assertEqual(fds_before_popen, fds_after_exception)
1254
Gregory P. Smith6e730002015-04-14 16:14:25 -07001255
1256class RunFuncTestCase(BaseTestCase):
1257 def run_python(self, code, **kwargs):
1258 """Run Python code in a subprocess using subprocess.run"""
1259 argv = [sys.executable, "-c", code]
1260 return subprocess.run(argv, **kwargs)
1261
1262 def test_returncode(self):
1263 # call() function with sequence argument
1264 cp = self.run_python("import sys; sys.exit(47)")
1265 self.assertEqual(cp.returncode, 47)
1266 with self.assertRaises(subprocess.CalledProcessError):
1267 cp.check_returncode()
1268
1269 def test_check(self):
1270 with self.assertRaises(subprocess.CalledProcessError) as c:
1271 self.run_python("import sys; sys.exit(47)", check=True)
1272 self.assertEqual(c.exception.returncode, 47)
1273
1274 def test_check_zero(self):
1275 # check_returncode shouldn't raise when returncode is zero
1276 cp = self.run_python("import sys; sys.exit(0)", check=True)
1277 self.assertEqual(cp.returncode, 0)
1278
1279 def test_timeout(self):
1280 # run() function with timeout argument; we want to test that the child
1281 # process gets killed when the timeout expires. If the child isn't
1282 # killed, this call will deadlock since subprocess.run waits for the
1283 # child.
1284 with self.assertRaises(subprocess.TimeoutExpired):
1285 self.run_python("while True: pass", timeout=0.0001)
1286
1287 def test_capture_stdout(self):
1288 # capture stdout with zero return code
1289 cp = self.run_python("print('BDFL')", stdout=subprocess.PIPE)
1290 self.assertIn(b'BDFL', cp.stdout)
1291
1292 def test_capture_stderr(self):
1293 cp = self.run_python("import sys; sys.stderr.write('BDFL')",
1294 stderr=subprocess.PIPE)
1295 self.assertIn(b'BDFL', cp.stderr)
1296
1297 def test_check_output_stdin_arg(self):
1298 # run() can be called with stdin set to a file
1299 tf = tempfile.TemporaryFile()
1300 self.addCleanup(tf.close)
1301 tf.write(b'pear')
1302 tf.seek(0)
1303 cp = self.run_python(
1304 "import sys; sys.stdout.write(sys.stdin.read().upper())",
1305 stdin=tf, stdout=subprocess.PIPE)
1306 self.assertIn(b'PEAR', cp.stdout)
1307
1308 def test_check_output_input_arg(self):
1309 # check_output() can be called with input set to a string
1310 cp = self.run_python(
1311 "import sys; sys.stdout.write(sys.stdin.read().upper())",
1312 input=b'pear', stdout=subprocess.PIPE)
1313 self.assertIn(b'PEAR', cp.stdout)
1314
1315 def test_check_output_stdin_with_input_arg(self):
1316 # run() refuses to accept 'stdin' with 'input'
1317 tf = tempfile.TemporaryFile()
1318 self.addCleanup(tf.close)
1319 tf.write(b'pear')
1320 tf.seek(0)
1321 with self.assertRaises(ValueError,
1322 msg="Expected ValueError when stdin and input args supplied.") as c:
1323 output = self.run_python("print('will not be run')",
1324 stdin=tf, input=b'hare')
1325 self.assertIn('stdin', c.exception.args[0])
1326 self.assertIn('input', c.exception.args[0])
1327
1328 def test_check_output_timeout(self):
1329 with self.assertRaises(subprocess.TimeoutExpired) as c:
1330 cp = self.run_python((
1331 "import sys, time\n"
1332 "sys.stdout.write('BDFL')\n"
1333 "sys.stdout.flush()\n"
1334 "time.sleep(3600)"),
1335 # Some heavily loaded buildbots (sparc Debian 3.x) require
1336 # this much time to start and print.
1337 timeout=3, stdout=subprocess.PIPE)
1338 self.assertEqual(c.exception.output, b'BDFL')
1339 # output is aliased to stdout
1340 self.assertEqual(c.exception.stdout, b'BDFL')
1341
1342 def test_run_kwargs(self):
1343 newenv = os.environ.copy()
1344 newenv["FRUIT"] = "banana"
1345 cp = self.run_python(('import sys, os;'
1346 'sys.exit(33 if os.getenv("FRUIT")=="banana" else 31)'),
1347 env=newenv)
1348 self.assertEqual(cp.returncode, 33)
1349
1350
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001351@unittest.skipIf(mswindows, "POSIX specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +00001352class POSIXProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001353
Gregory P. Smith5591b022012-10-10 03:34:47 -07001354 def setUp(self):
1355 super().setUp()
1356 self._nonexistent_dir = "/_this/pa.th/does/not/exist"
1357
1358 def _get_chdir_exception(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001359 try:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001360 os.chdir(self._nonexistent_dir)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001361 except OSError as e:
1362 # This avoids hard coding the errno value or the OS perror()
1363 # string and instead capture the exception that we want to see
1364 # below for comparison.
1365 desired_exception = e
Gregory P. Smith5591b022012-10-10 03:34:47 -07001366 desired_exception.strerror += ': ' + repr(self._nonexistent_dir)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001367 else:
Martin Pantereb995702016-07-28 01:11:04 +00001368 self.fail("chdir to nonexistent directory %s succeeded." %
Gregory P. Smith5591b022012-10-10 03:34:47 -07001369 self._nonexistent_dir)
1370 return desired_exception
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001371
Gregory P. Smith5591b022012-10-10 03:34:47 -07001372 def test_exception_cwd(self):
1373 """Test error in the child raised in the parent for a bad cwd."""
1374 desired_exception = self._get_chdir_exception()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001375 try:
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001376 p = subprocess.Popen([sys.executable, "-c", ""],
Gregory P. Smith5591b022012-10-10 03:34:47 -07001377 cwd=self._nonexistent_dir)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001378 except OSError as e:
1379 # Test that the child process chdir failure actually makes
1380 # it up to the parent process as the correct exception.
1381 self.assertEqual(desired_exception.errno, e.errno)
1382 self.assertEqual(desired_exception.strerror, e.strerror)
1383 else:
1384 self.fail("Expected OSError: %s" % desired_exception)
1385
Gregory P. Smith5591b022012-10-10 03:34:47 -07001386 def test_exception_bad_executable(self):
1387 """Test error in the child raised in the parent for a bad executable."""
1388 desired_exception = self._get_chdir_exception()
1389 try:
1390 p = subprocess.Popen([sys.executable, "-c", ""],
1391 executable=self._nonexistent_dir)
1392 except OSError as e:
1393 # Test that the child process exec failure actually makes
1394 # it up to the parent process as the correct exception.
1395 self.assertEqual(desired_exception.errno, e.errno)
1396 self.assertEqual(desired_exception.strerror, e.strerror)
1397 else:
1398 self.fail("Expected OSError: %s" % desired_exception)
1399
1400 def test_exception_bad_args_0(self):
1401 """Test error in the child raised in the parent for a bad args[0]."""
1402 desired_exception = self._get_chdir_exception()
1403 try:
1404 p = subprocess.Popen([self._nonexistent_dir, "-c", ""])
1405 except OSError as e:
1406 # Test that the child process exec failure actually makes
1407 # it up to the parent process as the correct exception.
1408 self.assertEqual(desired_exception.errno, e.errno)
1409 self.assertEqual(desired_exception.strerror, e.strerror)
1410 else:
1411 self.fail("Expected OSError: %s" % desired_exception)
1412
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001413 def test_restore_signals(self):
1414 # Code coverage for both values of restore_signals to make sure it
1415 # at least does not blow up.
1416 # A test for behavior would be complex. Contributions welcome.
1417 subprocess.call([sys.executable, "-c", ""], restore_signals=True)
1418 subprocess.call([sys.executable, "-c", ""], restore_signals=False)
1419
1420 def test_start_new_session(self):
1421 # For code coverage of calling setsid(). We don't care if we get an
1422 # EPERM error from it depending on the test execution environment, that
1423 # still indicates that it was called.
1424 try:
1425 output = subprocess.check_output(
1426 [sys.executable, "-c",
1427 "import os; print(os.getpgid(os.getpid()))"],
1428 start_new_session=True)
1429 except OSError as e:
1430 if e.errno != errno.EPERM:
1431 raise
1432 else:
1433 parent_pgid = os.getpgid(os.getpid())
1434 child_pgid = int(output)
1435 self.assertNotEqual(parent_pgid, child_pgid)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001436
1437 def test_run_abort(self):
1438 # returncode handles signal termination
Antoine Pitrou77e904e2013-10-08 23:04:32 +02001439 with support.SuppressCrashReport():
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001440 p = subprocess.Popen([sys.executable, "-c",
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001441 'import os; os.abort()'])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001442 p.wait()
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001443 self.assertEqual(-p.returncode, signal.SIGABRT)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001444
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)d6da7602016-06-03 06:14:06 +00001445 def test_CalledProcessError_str_signal(self):
1446 err = subprocess.CalledProcessError(-int(signal.SIGABRT), "fake cmd")
1447 error_string = str(err)
1448 # We're relying on the repr() of the signal.Signals intenum to provide
1449 # the word signal, the signal name and the numeric value.
1450 self.assertIn("signal", error_string.lower())
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)b4149062016-06-03 06:19:35 +00001451 # We're not being specific about the signal name as some signals have
1452 # multiple names and which name is revealed can vary.
1453 self.assertIn("SIG", error_string)
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)d6da7602016-06-03 06:14:06 +00001454 self.assertIn(str(signal.SIGABRT), error_string)
1455
1456 def test_CalledProcessError_str_unknown_signal(self):
1457 err = subprocess.CalledProcessError(-9876543, "fake cmd")
1458 error_string = str(err)
1459 self.assertIn("unknown signal 9876543.", error_string)
1460
1461 def test_CalledProcessError_str_non_zero(self):
1462 err = subprocess.CalledProcessError(2, "fake cmd")
1463 error_string = str(err)
1464 self.assertIn("non-zero exit status 2.", error_string)
1465
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001466 def test_preexec(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001467 # DISCLAIMER: Setting environment variables is *not* a good use
1468 # of a preexec_fn. This is merely a test.
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001469 p = subprocess.Popen([sys.executable, "-c",
1470 'import sys,os;'
1471 'sys.stdout.write(os.getenv("FRUIT"))'],
1472 stdout=subprocess.PIPE,
1473 preexec_fn=lambda: os.putenv("FRUIT", "apple"))
Victor Stinner7438c612016-05-20 12:43:15 +02001474 with p:
1475 self.assertEqual(p.stdout.read(), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001476
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001477 def test_preexec_exception(self):
1478 def raise_it():
1479 raise ValueError("What if two swallows carried a coconut?")
1480 try:
1481 p = subprocess.Popen([sys.executable, "-c", ""],
1482 preexec_fn=raise_it)
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001483 except subprocess.SubprocessError as e:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001484 self.assertTrue(
1485 subprocess._posixsubprocess,
1486 "Expected a ValueError from the preexec_fn")
1487 except ValueError as e:
1488 self.assertIn("coconut", e.args[0])
1489 else:
1490 self.fail("Exception raised by preexec_fn did not make it "
1491 "to the parent process.")
1492
Gregory P. Smithe27faac2012-11-11 09:59:27 -08001493 class _TestExecuteChildPopen(subprocess.Popen):
1494 """Used to test behavior at the end of _execute_child."""
1495 def __init__(self, testcase, *args, **kwargs):
1496 self._testcase = testcase
1497 subprocess.Popen.__init__(self, *args, **kwargs)
Gregory P. Smith12489d92012-11-11 01:37:02 -08001498
Gregory P. Smithe27faac2012-11-11 09:59:27 -08001499 def _execute_child(self, *args, **kwargs):
Gregory P. Smith12489d92012-11-11 01:37:02 -08001500 try:
Gregory P. Smithe27faac2012-11-11 09:59:27 -08001501 subprocess.Popen._execute_child(self, *args, **kwargs)
Gregory P. Smith12489d92012-11-11 01:37:02 -08001502 finally:
1503 # Open a bunch of file descriptors and verify that
1504 # none of them are the same as the ones the Popen
1505 # instance is using for stdin/stdout/stderr.
1506 devzero_fds = [os.open("/dev/zero", os.O_RDONLY)
1507 for _ in range(8)]
1508 try:
1509 for fd in devzero_fds:
Gregory P. Smithe27faac2012-11-11 09:59:27 -08001510 self._testcase.assertNotIn(
1511 fd, (self.stdin.fileno(), self.stdout.fileno(),
1512 self.stderr.fileno()),
Gregory P. Smith12489d92012-11-11 01:37:02 -08001513 msg="At least one fd was closed early.")
1514 finally:
Richard Oudkerk0e547b62013-06-10 16:29:19 +01001515 for fd in devzero_fds:
1516 os.close(fd)
Gregory P. Smith12489d92012-11-11 01:37:02 -08001517
Gregory P. Smithe27faac2012-11-11 09:59:27 -08001518 @unittest.skipIf(not os.path.exists("/dev/zero"), "/dev/zero required.")
1519 def test_preexec_errpipe_does_not_double_close_pipes(self):
1520 """Issue16140: Don't double close pipes on preexec error."""
1521
1522 def raise_it():
Gregory P. Smith65ee6ec2012-11-11 10:12:40 -08001523 raise subprocess.SubprocessError(
1524 "force the _execute_child() errpipe_data path.")
Gregory P. Smith12489d92012-11-11 01:37:02 -08001525
Gregory P. Smithc2c4cb62012-11-11 01:41:49 -08001526 with self.assertRaises(subprocess.SubprocessError):
Gregory P. Smithe27faac2012-11-11 09:59:27 -08001527 self._TestExecuteChildPopen(
1528 self, [sys.executable, "-c", "pass"],
Gregory P. Smith12489d92012-11-11 01:37:02 -08001529 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1530 stderr=subprocess.PIPE, preexec_fn=raise_it)
1531
Gregory P. Smith32ec9da2010-03-19 16:53:08 +00001532 def test_preexec_gc_module_failure(self):
1533 # This tests the code that disables garbage collection if the child
1534 # process will execute any Python.
1535 def raise_runtime_error():
1536 raise RuntimeError("this shouldn't escape")
1537 enabled = gc.isenabled()
1538 orig_gc_disable = gc.disable
1539 orig_gc_isenabled = gc.isenabled
1540 try:
1541 gc.disable()
1542 self.assertFalse(gc.isenabled())
1543 subprocess.call([sys.executable, '-c', ''],
1544 preexec_fn=lambda: None)
1545 self.assertFalse(gc.isenabled(),
1546 "Popen enabled gc when it shouldn't.")
1547
1548 gc.enable()
1549 self.assertTrue(gc.isenabled())
1550 subprocess.call([sys.executable, '-c', ''],
1551 preexec_fn=lambda: None)
1552 self.assertTrue(gc.isenabled(), "Popen left gc disabled.")
1553
1554 gc.disable = raise_runtime_error
1555 self.assertRaises(RuntimeError, subprocess.Popen,
1556 [sys.executable, '-c', ''],
1557 preexec_fn=lambda: None)
1558
1559 del gc.isenabled # force an AttributeError
1560 self.assertRaises(AttributeError, subprocess.Popen,
1561 [sys.executable, '-c', ''],
1562 preexec_fn=lambda: None)
1563 finally:
1564 gc.disable = orig_gc_disable
1565 gc.isenabled = orig_gc_isenabled
1566 if not enabled:
1567 gc.disable()
1568
Martin Panterf7fdbda2015-12-05 09:51:52 +00001569 @unittest.skipIf(
1570 sys.platform == 'darwin', 'setrlimit() seems to fail on OS X')
Martin Panterafdd5132015-11-30 02:21:41 +00001571 def test_preexec_fork_failure(self):
1572 # The internal code did not preserve the previous exception when
1573 # re-enabling garbage collection
1574 try:
1575 from resource import getrlimit, setrlimit, RLIMIT_NPROC
1576 except ImportError as err:
1577 self.skipTest(err) # RLIMIT_NPROC is specific to Linux and BSD
1578 limits = getrlimit(RLIMIT_NPROC)
1579 [_, hard] = limits
1580 setrlimit(RLIMIT_NPROC, (0, hard))
1581 self.addCleanup(setrlimit, RLIMIT_NPROC, limits)
Martin Panter5cf791b2015-12-11 05:40:14 +00001582 try:
Martin Panterafdd5132015-11-30 02:21:41 +00001583 subprocess.call([sys.executable, '-c', ''],
1584 preexec_fn=lambda: None)
Martin Panter5cf791b2015-12-11 05:40:14 +00001585 except BlockingIOError:
1586 # Forking should raise EAGAIN, translated to BlockingIOError
1587 pass
1588 else:
1589 self.skipTest('RLIMIT_NPROC had no effect; probably superuser')
Martin Panterafdd5132015-11-30 02:21:41 +00001590
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001591 def test_args_string(self):
1592 # args is a string
Berker Peksag16a1f282015-09-28 13:33:14 +03001593 fd, fname = tempfile.mkstemp()
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001594 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +00001595 with open(fd, "w", errors="surrogateescape") as fobj:
Xavier de Gayed1415312016-07-22 12:15:29 +02001596 fobj.write("#!%s\n" % support.unix_shell)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001597 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
1598 sys.executable)
1599 os.chmod(fname, 0o700)
1600 p = subprocess.Popen(fname)
1601 p.wait()
1602 os.remove(fname)
1603 self.assertEqual(p.returncode, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001604
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001605 def test_invalid_args(self):
1606 # invalid arguments should raise ValueError
1607 self.assertRaises(ValueError, subprocess.call,
1608 [sys.executable, "-c",
1609 "import sys; sys.exit(47)"],
1610 startupinfo=47)
1611 self.assertRaises(ValueError, subprocess.call,
1612 [sys.executable, "-c",
1613 "import sys; sys.exit(47)"],
1614 creationflags=47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001615
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001616 def test_shell_sequence(self):
1617 # Run command through the shell (sequence)
1618 newenv = os.environ.copy()
1619 newenv["FRUIT"] = "apple"
1620 p = subprocess.Popen(["echo $FRUIT"], shell=1,
1621 stdout=subprocess.PIPE,
1622 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02001623 with p:
1624 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001625
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001626 def test_shell_string(self):
1627 # Run command through the shell (string)
1628 newenv = os.environ.copy()
1629 newenv["FRUIT"] = "apple"
1630 p = subprocess.Popen("echo $FRUIT", shell=1,
1631 stdout=subprocess.PIPE,
1632 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02001633 with p:
1634 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Christian Heimesa342c012008-04-20 21:01:16 +00001635
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001636 def test_call_string(self):
1637 # call() function with string argument on UNIX
Berker Peksag16a1f282015-09-28 13:33:14 +03001638 fd, fname = tempfile.mkstemp()
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001639 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +00001640 with open(fd, "w", errors="surrogateescape") as fobj:
Xavier de Gayed1415312016-07-22 12:15:29 +02001641 fobj.write("#!%s\n" % support.unix_shell)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001642 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
1643 sys.executable)
1644 os.chmod(fname, 0o700)
1645 rc = subprocess.call(fname)
1646 os.remove(fname)
1647 self.assertEqual(rc, 47)
Christian Heimesa342c012008-04-20 21:01:16 +00001648
Stefan Krah9542cc62010-07-19 14:20:53 +00001649 def test_specific_shell(self):
1650 # Issue #9265: Incorrect name passed as arg[0].
1651 shells = []
1652 for prefix in ['/bin', '/usr/bin/', '/usr/local/bin']:
1653 for name in ['bash', 'ksh']:
1654 sh = os.path.join(prefix, name)
1655 if os.path.isfile(sh):
1656 shells.append(sh)
1657 if not shells: # Will probably work for any shell but csh.
1658 self.skipTest("bash or ksh required for this test")
1659 sh = '/bin/sh'
1660 if os.path.isfile(sh) and not os.path.islink(sh):
1661 # Test will fail if /bin/sh is a symlink to csh.
1662 shells.append(sh)
1663 for sh in shells:
1664 p = subprocess.Popen("echo $0", executable=sh, shell=True,
1665 stdout=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +02001666 with p:
1667 self.assertEqual(p.stdout.read().strip(), bytes(sh, 'ascii'))
Stefan Krah9542cc62010-07-19 14:20:53 +00001668
Florent Xicluna4886d242010-03-08 13:27:26 +00001669 def _kill_process(self, method, *args):
Florent Xicluna1d8ee3a2010-03-05 20:26:54 +00001670 # Do not inherit file handles from the parent.
1671 # It should fix failures on some platforms.
Gregory P. Smithdee04342013-08-29 13:35:27 -07001672 # Also set the SIGINT handler to the default to make sure it's not
1673 # being ignored (some tests rely on that.)
1674 old_handler = signal.signal(signal.SIGINT, signal.default_int_handler)
1675 try:
1676 p = subprocess.Popen([sys.executable, "-c", """if 1:
1677 import sys, time
1678 sys.stdout.write('x\\n')
1679 sys.stdout.flush()
1680 time.sleep(30)
1681 """],
1682 close_fds=True,
1683 stdin=subprocess.PIPE,
1684 stdout=subprocess.PIPE,
1685 stderr=subprocess.PIPE)
1686 finally:
1687 signal.signal(signal.SIGINT, old_handler)
Antoine Pitrou3d8580f2010-09-20 01:33:21 +00001688 # Wait for the interpreter to be completely initialized before
1689 # sending any signal.
1690 p.stdout.read(1)
1691 getattr(p, method)(*args)
Florent Xicluna4886d242010-03-08 13:27:26 +00001692 return p
1693
Charles-François Natali53221e32013-01-12 16:52:20 +01001694 @unittest.skipIf(sys.platform.startswith(('netbsd', 'openbsd')),
1695 "Due to known OS bug (issue #16762)")
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001696 def _kill_dead_process(self, method, *args):
1697 # Do not inherit file handles from the parent.
1698 # It should fix failures on some platforms.
1699 p = subprocess.Popen([sys.executable, "-c", """if 1:
1700 import sys, time
1701 sys.stdout.write('x\\n')
1702 sys.stdout.flush()
1703 """],
1704 close_fds=True,
1705 stdin=subprocess.PIPE,
1706 stdout=subprocess.PIPE,
1707 stderr=subprocess.PIPE)
1708 # Wait for the interpreter to be completely initialized before
1709 # sending any signal.
1710 p.stdout.read(1)
1711 # The process should end after this
1712 time.sleep(1)
1713 # This shouldn't raise even though the child is now dead
1714 getattr(p, method)(*args)
1715 p.communicate()
1716
Florent Xicluna4886d242010-03-08 13:27:26 +00001717 def test_send_signal(self):
1718 p = self._kill_process('send_signal', signal.SIGINT)
Florent Xiclunac049d872010-03-27 22:47:23 +00001719 _, stderr = p.communicate()
1720 self.assertIn(b'KeyboardInterrupt', stderr)
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001721 self.assertNotEqual(p.wait(), 0)
Christian Heimesa342c012008-04-20 21:01:16 +00001722
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001723 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00001724 p = self._kill_process('kill')
Florent Xiclunac049d872010-03-27 22:47:23 +00001725 _, stderr = p.communicate()
1726 self.assertStderrEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001727 self.assertEqual(p.wait(), -signal.SIGKILL)
Tim Peterse718f612004-10-12 21:51:32 +00001728
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001729 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00001730 p = self._kill_process('terminate')
Florent Xiclunac049d872010-03-27 22:47:23 +00001731 _, stderr = p.communicate()
1732 self.assertStderrEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001733 self.assertEqual(p.wait(), -signal.SIGTERM)
1734
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01001735 def test_send_signal_dead(self):
1736 # Sending a signal to a dead process
1737 self._kill_dead_process('send_signal', signal.SIGINT)
1738
1739 def test_kill_dead(self):
1740 # Killing a dead process
1741 self._kill_dead_process('kill')
1742
1743 def test_terminate_dead(self):
1744 # Terminating a dead process
1745 self._kill_dead_process('terminate')
1746
Victor Stinnerdaf45552013-08-28 00:53:59 +02001747 def _save_fds(self, save_fds):
1748 fds = []
1749 for fd in save_fds:
1750 inheritable = os.get_inheritable(fd)
1751 saved = os.dup(fd)
1752 fds.append((fd, saved, inheritable))
1753 return fds
1754
1755 def _restore_fds(self, fds):
1756 for fd, saved, inheritable in fds:
1757 os.dup2(saved, fd, inheritable=inheritable)
1758 os.close(saved)
1759
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001760 def check_close_std_fds(self, fds):
1761 # Issue #9905: test that subprocess pipes still work properly with
1762 # some standard fds closed
1763 stdin = 0
Victor Stinnerdaf45552013-08-28 00:53:59 +02001764 saved_fds = self._save_fds(fds)
1765 for fd, saved, inheritable in saved_fds:
1766 if fd == 0:
1767 stdin = saved
1768 break
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001769 try:
1770 for fd in fds:
1771 os.close(fd)
1772 out, err = subprocess.Popen([sys.executable, "-c",
1773 'import sys;'
1774 'sys.stdout.write("apple");'
1775 'sys.stdout.flush();'
1776 'sys.stderr.write("orange")'],
1777 stdin=stdin,
1778 stdout=subprocess.PIPE,
1779 stderr=subprocess.PIPE).communicate()
1780 err = support.strip_python_stderr(err)
1781 self.assertEqual((out, err), (b'apple', b'orange'))
1782 finally:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001783 self._restore_fds(saved_fds)
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00001784
1785 def test_close_fd_0(self):
1786 self.check_close_std_fds([0])
1787
1788 def test_close_fd_1(self):
1789 self.check_close_std_fds([1])
1790
1791 def test_close_fd_2(self):
1792 self.check_close_std_fds([2])
1793
1794 def test_close_fds_0_1(self):
1795 self.check_close_std_fds([0, 1])
1796
1797 def test_close_fds_0_2(self):
1798 self.check_close_std_fds([0, 2])
1799
1800 def test_close_fds_1_2(self):
1801 self.check_close_std_fds([1, 2])
1802
1803 def test_close_fds_0_1_2(self):
1804 # Issue #10806: test that subprocess pipes still work properly with
1805 # all standard fds closed.
1806 self.check_close_std_fds([0, 1, 2])
1807
Gregory P. Smith53dd8162013-12-01 16:03:24 -08001808 def test_small_errpipe_write_fd(self):
1809 """Issue #15798: Popen should work when stdio fds are available."""
1810 new_stdin = os.dup(0)
1811 new_stdout = os.dup(1)
1812 try:
1813 os.close(0)
1814 os.close(1)
1815
1816 # Side test: if errpipe_write fails to have its CLOEXEC
1817 # flag set this should cause the parent to think the exec
1818 # failed. Extremely unlikely: everyone supports CLOEXEC.
1819 subprocess.Popen([
1820 sys.executable, "-c",
1821 "print('AssertionError:0:CLOEXEC failure.')"]).wait()
1822 finally:
1823 # Restore original stdin and stdout
1824 os.dup2(new_stdin, 0)
1825 os.dup2(new_stdout, 1)
1826 os.close(new_stdin)
1827 os.close(new_stdout)
1828
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00001829 def test_remapping_std_fds(self):
1830 # open up some temporary files
Berker Peksag16a1f282015-09-28 13:33:14 +03001831 temps = [tempfile.mkstemp() for i in range(3)]
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00001832 try:
1833 temp_fds = [fd for fd, fname in temps]
1834
1835 # unlink the files -- we won't need to reopen them
1836 for fd, fname in temps:
1837 os.unlink(fname)
1838
1839 # write some data to what will become stdin, and rewind
1840 os.write(temp_fds[1], b"STDIN")
1841 os.lseek(temp_fds[1], 0, 0)
1842
1843 # move the standard file descriptors out of the way
Victor Stinnerdaf45552013-08-28 00:53:59 +02001844 saved_fds = self._save_fds(range(3))
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00001845 try:
1846 # duplicate the file objects over the standard fd's
1847 for fd, temp_fd in enumerate(temp_fds):
1848 os.dup2(temp_fd, fd)
1849
1850 # now use those files in the "wrong" order, so that subprocess
1851 # has to rearrange them in the child
1852 p = subprocess.Popen([sys.executable, "-c",
1853 'import sys; got = sys.stdin.read();'
1854 'sys.stdout.write("got %s"%got); sys.stderr.write("err")'],
1855 stdin=temp_fds[1],
1856 stdout=temp_fds[2],
1857 stderr=temp_fds[0])
1858 p.wait()
1859 finally:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001860 self._restore_fds(saved_fds)
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00001861
1862 for fd in temp_fds:
1863 os.lseek(fd, 0, 0)
1864
1865 out = os.read(temp_fds[2], 1024)
1866 err = support.strip_python_stderr(os.read(temp_fds[0], 1024))
1867 self.assertEqual(out, b"got STDIN")
1868 self.assertEqual(err, b"err")
1869
1870 finally:
1871 for fd in temp_fds:
1872 os.close(fd)
1873
Ross Lagerwalld98646e2011-07-27 07:16:31 +02001874 def check_swap_fds(self, stdin_no, stdout_no, stderr_no):
1875 # open up some temporary files
Berker Peksag16a1f282015-09-28 13:33:14 +03001876 temps = [tempfile.mkstemp() for i in range(3)]
Ross Lagerwalld98646e2011-07-27 07:16:31 +02001877 temp_fds = [fd for fd, fname in temps]
1878 try:
1879 # unlink the files -- we won't need to reopen them
1880 for fd, fname in temps:
1881 os.unlink(fname)
1882
1883 # save a copy of the standard file descriptors
Victor Stinnerdaf45552013-08-28 00:53:59 +02001884 saved_fds = self._save_fds(range(3))
Ross Lagerwalld98646e2011-07-27 07:16:31 +02001885 try:
1886 # duplicate the temp files over the standard fd's 0, 1, 2
1887 for fd, temp_fd in enumerate(temp_fds):
1888 os.dup2(temp_fd, fd)
1889
1890 # write some data to what will become stdin, and rewind
1891 os.write(stdin_no, b"STDIN")
1892 os.lseek(stdin_no, 0, 0)
1893
1894 # now use those files in the given order, so that subprocess
1895 # has to rearrange them in the child
1896 p = subprocess.Popen([sys.executable, "-c",
1897 'import sys; got = sys.stdin.read();'
1898 'sys.stdout.write("got %s"%got); sys.stderr.write("err")'],
1899 stdin=stdin_no,
1900 stdout=stdout_no,
1901 stderr=stderr_no)
1902 p.wait()
1903
1904 for fd in temp_fds:
1905 os.lseek(fd, 0, 0)
1906
1907 out = os.read(stdout_no, 1024)
1908 err = support.strip_python_stderr(os.read(stderr_no, 1024))
1909 finally:
Victor Stinnerdaf45552013-08-28 00:53:59 +02001910 self._restore_fds(saved_fds)
Ross Lagerwalld98646e2011-07-27 07:16:31 +02001911
1912 self.assertEqual(out, b"got STDIN")
1913 self.assertEqual(err, b"err")
1914
1915 finally:
1916 for fd in temp_fds:
1917 os.close(fd)
1918
1919 # When duping fds, if there arises a situation where one of the fds is
1920 # either 0, 1 or 2, it is possible that it is overwritten (#12607).
1921 # This tests all combinations of this.
1922 def test_swap_fds(self):
1923 self.check_swap_fds(0, 1, 2)
1924 self.check_swap_fds(0, 2, 1)
1925 self.check_swap_fds(1, 0, 2)
1926 self.check_swap_fds(1, 2, 0)
1927 self.check_swap_fds(2, 0, 1)
1928 self.check_swap_fds(2, 1, 0)
1929
Victor Stinner13bb71c2010-04-23 21:41:56 +00001930 def test_surrogates_error_message(self):
Victor Stinner4d078042010-04-23 19:28:32 +00001931 def prepare():
1932 raise ValueError("surrogate:\uDCff")
1933
1934 try:
1935 subprocess.call(
1936 [sys.executable, "-c", "pass"],
1937 preexec_fn=prepare)
1938 except ValueError as err:
1939 # Pure Python implementations keeps the message
1940 self.assertIsNone(subprocess._posixsubprocess)
1941 self.assertEqual(str(err), "surrogate:\uDCff")
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001942 except subprocess.SubprocessError as err:
Victor Stinner4d078042010-04-23 19:28:32 +00001943 # _posixsubprocess uses a default message
1944 self.assertIsNotNone(subprocess._posixsubprocess)
1945 self.assertEqual(str(err), "Exception occurred in preexec_fn.")
1946 else:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001947 self.fail("Expected ValueError or subprocess.SubprocessError")
Victor Stinner4d078042010-04-23 19:28:32 +00001948
Victor Stinner13bb71c2010-04-23 21:41:56 +00001949 def test_undecodable_env(self):
1950 for key, value in (('test', 'abc\uDCFF'), ('test\uDCFF', '42')):
Victor Stinner5323fb02013-11-19 23:46:06 +01001951 encoded_value = value.encode("ascii", "surrogateescape")
1952
Victor Stinner13bb71c2010-04-23 21:41:56 +00001953 # test str with surrogates
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00001954 script = "import os; print(ascii(os.getenv(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001955 env = os.environ.copy()
1956 env[key] = value
Victor Stinner5323fb02013-11-19 23:46:06 +01001957 # Use C locale to get ASCII for the locale encoding to force
Victor Stinner89f3ad12010-10-14 10:43:31 +00001958 # surrogate-escaping of \xFF in the child process; otherwise it can
1959 # be decoded as-is if the default locale is latin-1.
Victor Stinnerebc78d22010-10-14 10:38:17 +00001960 env['LC_ALL'] = 'C'
Victor Stinner5323fb02013-11-19 23:46:06 +01001961 if sys.platform.startswith("aix"):
1962 # On AIX, the C locale uses the Latin1 encoding
1963 decoded_value = encoded_value.decode("latin1", "surrogateescape")
1964 else:
1965 # On other UNIXes, the C locale uses the ASCII encoding
1966 decoded_value = value
Victor Stinner13bb71c2010-04-23 21:41:56 +00001967 stdout = subprocess.check_output(
1968 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001969 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00001970 stdout = stdout.rstrip(b'\n\r')
Victor Stinner5323fb02013-11-19 23:46:06 +01001971 self.assertEqual(stdout.decode('ascii'), ascii(decoded_value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00001972
1973 # test bytes
1974 key = key.encode("ascii", "surrogateescape")
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00001975 script = "import os; print(ascii(os.getenvb(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001976 env = os.environ.copy()
Victor Stinner5323fb02013-11-19 23:46:06 +01001977 env[key] = encoded_value
Victor Stinner13bb71c2010-04-23 21:41:56 +00001978 stdout = subprocess.check_output(
1979 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00001980 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00001981 stdout = stdout.rstrip(b'\n\r')
Victor Stinner5323fb02013-11-19 23:46:06 +01001982 self.assertEqual(stdout.decode('ascii'), ascii(encoded_value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00001983
Victor Stinnerb745a742010-05-18 17:17:23 +00001984 def test_bytes_program(self):
1985 abs_program = os.fsencode(sys.executable)
1986 path, program = os.path.split(sys.executable)
1987 program = os.fsencode(program)
1988
1989 # absolute bytes path
1990 exitcode = subprocess.call([abs_program, "-c", "pass"])
Ezio Melottib3aedd42010-11-20 19:04:17 +00001991 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00001992
Victor Stinner7b3b20a2011-03-03 12:54:05 +00001993 # absolute bytes path as a string
1994 cmd = b"'" + abs_program + b"' -c pass"
1995 exitcode = subprocess.call(cmd, shell=True)
1996 self.assertEqual(exitcode, 0)
1997
Victor Stinnerb745a742010-05-18 17:17:23 +00001998 # bytes program, unicode PATH
1999 env = os.environ.copy()
2000 env["PATH"] = path
2001 exitcode = subprocess.call([program, "-c", "pass"], env=env)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002002 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00002003
2004 # bytes program, bytes PATH
2005 envb = os.environb.copy()
2006 envb[b"PATH"] = os.fsencode(path)
2007 exitcode = subprocess.call([program, "-c", "pass"], env=envb)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002008 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00002009
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002010 def test_pipe_cloexec(self):
2011 sleeper = support.findfile("input_reader.py", subdir="subprocessdata")
2012 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2013
2014 p1 = subprocess.Popen([sys.executable, sleeper],
2015 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
2016 stderr=subprocess.PIPE, close_fds=False)
2017
2018 self.addCleanup(p1.communicate, b'')
2019
2020 p2 = subprocess.Popen([sys.executable, fd_status],
2021 stdout=subprocess.PIPE, close_fds=False)
2022
2023 output, error = p2.communicate()
2024 result_fds = set(map(int, output.split(b',')))
2025 unwanted_fds = set([p1.stdin.fileno(), p1.stdout.fileno(),
2026 p1.stderr.fileno()])
2027
2028 self.assertFalse(result_fds & unwanted_fds,
2029 "Expected no fds from %r to be open in child, "
2030 "found %r" %
2031 (unwanted_fds, result_fds & unwanted_fds))
2032
2033 def test_pipe_cloexec_real_tools(self):
2034 qcat = support.findfile("qcat.py", subdir="subprocessdata")
2035 qgrep = support.findfile("qgrep.py", subdir="subprocessdata")
2036
2037 subdata = b'zxcvbn'
2038 data = subdata * 4 + b'\n'
2039
2040 p1 = subprocess.Popen([sys.executable, qcat],
2041 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
2042 close_fds=False)
2043
2044 p2 = subprocess.Popen([sys.executable, qgrep, subdata],
2045 stdin=p1.stdout, stdout=subprocess.PIPE,
2046 close_fds=False)
2047
2048 self.addCleanup(p1.wait)
2049 self.addCleanup(p2.wait)
Gregory P. Smith886455c2012-01-21 22:05:10 -08002050 def kill_p1():
2051 try:
2052 p1.terminate()
2053 except ProcessLookupError:
2054 pass
2055 def kill_p2():
2056 try:
2057 p2.terminate()
2058 except ProcessLookupError:
2059 pass
2060 self.addCleanup(kill_p1)
2061 self.addCleanup(kill_p2)
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002062
2063 p1.stdin.write(data)
2064 p1.stdin.close()
2065
2066 readfiles, ignored1, ignored2 = select.select([p2.stdout], [], [], 10)
2067
2068 self.assertTrue(readfiles, "The child hung")
2069 self.assertEqual(p2.stdout.read(), data)
2070
Victor Stinnerfaa8c132011-01-03 16:36:00 +00002071 p1.stdout.close()
2072 p2.stdout.close()
2073
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002074 def test_close_fds(self):
2075 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2076
2077 fds = os.pipe()
2078 self.addCleanup(os.close, fds[0])
2079 self.addCleanup(os.close, fds[1])
2080
2081 open_fds = set(fds)
Gregory P. Smith8facece2012-01-21 14:01:08 -08002082 # add a bunch more fds
2083 for _ in range(9):
Serhiy Storchaka85c30332015-02-15 13:58:23 +02002084 fd = os.open(os.devnull, os.O_RDONLY)
Gregory P. Smith8facece2012-01-21 14:01:08 -08002085 self.addCleanup(os.close, fd)
2086 open_fds.add(fd)
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002087
Victor Stinnerdaf45552013-08-28 00:53:59 +02002088 for fd in open_fds:
2089 os.set_inheritable(fd, True)
2090
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002091 p = subprocess.Popen([sys.executable, fd_status],
2092 stdout=subprocess.PIPE, close_fds=False)
2093 output, ignored = p.communicate()
2094 remaining_fds = set(map(int, output.split(b',')))
2095
2096 self.assertEqual(remaining_fds & open_fds, open_fds,
2097 "Some fds were closed")
2098
2099 p = subprocess.Popen([sys.executable, fd_status],
2100 stdout=subprocess.PIPE, close_fds=True)
2101 output, ignored = p.communicate()
2102 remaining_fds = set(map(int, output.split(b',')))
2103
2104 self.assertFalse(remaining_fds & open_fds,
2105 "Some fds were left open")
2106 self.assertIn(1, remaining_fds, "Subprocess failed")
2107
Gregory P. Smith8facece2012-01-21 14:01:08 -08002108 # Keep some of the fd's we opened open in the subprocess.
2109 # This tests _posixsubprocess.c's proper handling of fds_to_keep.
2110 fds_to_keep = set(open_fds.pop() for _ in range(8))
2111 p = subprocess.Popen([sys.executable, fd_status],
2112 stdout=subprocess.PIPE, close_fds=True,
2113 pass_fds=())
2114 output, ignored = p.communicate()
2115 remaining_fds = set(map(int, output.split(b',')))
2116
2117 self.assertFalse(remaining_fds & fds_to_keep & open_fds,
2118 "Some fds not in pass_fds were left open")
2119 self.assertIn(1, remaining_fds, "Subprocess failed")
2120
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002121
Gregory P. Smithd04f6992014-06-01 15:27:28 -07002122 @unittest.skipIf(sys.platform.startswith("freebsd") and
2123 os.stat("/dev").st_dev == os.stat("/dev/fd").st_dev,
2124 "Requires fdescfs mounted on /dev/fd on FreeBSD.")
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002125 def test_close_fds_when_max_fd_is_lowered(self):
2126 """Confirm that issue21618 is fixed (may fail under valgrind)."""
2127 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2128
Gregory P. Smith634aa682014-06-15 17:51:04 -07002129 # This launches the meat of the test in a child process to
2130 # avoid messing with the larger unittest processes maximum
2131 # number of file descriptors.
2132 # This process launches:
2133 # +--> Process that lowers its RLIMIT_NOFILE aftr setting up
2134 # a bunch of high open fds above the new lower rlimit.
2135 # Those are reported via stdout before launching a new
2136 # process with close_fds=False to run the actual test:
2137 # +--> The TEST: This one launches a fd_status.py
2138 # subprocess with close_fds=True so we can find out if
2139 # any of the fds above the lowered rlimit are still open.
2140 p = subprocess.Popen([sys.executable, '-c', textwrap.dedent(
2141 '''
2142 import os, resource, subprocess, sys, textwrap
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002143 open_fds = set()
2144 # Add a bunch more fds to pass down.
Gregory P. Smith8fed4de2014-06-01 15:15:44 -07002145 for _ in range(40):
Serhiy Storchaka85c30332015-02-15 13:58:23 +02002146 fd = os.open(os.devnull, os.O_RDONLY)
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002147 open_fds.add(fd)
2148
2149 # Leave a two pairs of low ones available for use by the
2150 # internal child error pipe and the stdout pipe.
Gregory P. Smith8fed4de2014-06-01 15:15:44 -07002151 # We also leave 10 more open as some Python buildbots run into
2152 # "too many open files" errors during the test if we do not.
2153 for fd in sorted(open_fds)[:14]:
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002154 os.close(fd)
2155 open_fds.remove(fd)
2156
2157 for fd in open_fds:
Gregory P. Smith634aa682014-06-15 17:51:04 -07002158 #self.addCleanup(os.close, fd)
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002159 os.set_inheritable(fd, True)
2160
2161 max_fd_open = max(open_fds)
2162
Gregory P. Smith634aa682014-06-15 17:51:04 -07002163 # Communicate the open_fds to the parent unittest.TestCase process.
2164 print(','.join(map(str, sorted(open_fds))))
2165 sys.stdout.flush()
2166
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002167 rlim_cur, rlim_max = resource.getrlimit(resource.RLIMIT_NOFILE)
2168 try:
Gregory P. Smith8fed4de2014-06-01 15:15:44 -07002169 # 29 is lower than the highest fds we are leaving open.
2170 resource.setrlimit(resource.RLIMIT_NOFILE, (29, rlim_max))
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002171 # Launch a new Python interpreter with our low fd rlim_cur that
2172 # inherits open fds above that limit. It then uses subprocess
2173 # with close_fds=True to get a report of open fds in the child.
2174 # An explicit list of fds to check is passed to fd_status.py as
2175 # letting fd_status rely on its default logic would miss the
2176 # fds above rlim_cur as it normally only checks up to that limit.
Gregory P. Smith634aa682014-06-15 17:51:04 -07002177 subprocess.Popen(
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002178 [sys.executable, '-c',
2179 textwrap.dedent("""
2180 import subprocess, sys
Gregory P. Smith634aa682014-06-15 17:51:04 -07002181 subprocess.Popen([sys.executable, %r] +
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002182 [str(x) for x in range({max_fd})],
Gregory P. Smithffd529c2014-06-01 13:46:54 -07002183 close_fds=True).wait()
Gregory P. Smith634aa682014-06-15 17:51:04 -07002184 """.format(max_fd=max_fd_open+1))],
2185 close_fds=False).wait()
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002186 finally:
2187 resource.setrlimit(resource.RLIMIT_NOFILE, (rlim_cur, rlim_max))
Gregory P. Smith634aa682014-06-15 17:51:04 -07002188 ''' % fd_status)], stdout=subprocess.PIPE)
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002189
2190 output, unused_stderr = p.communicate()
Gregory P. Smith634aa682014-06-15 17:51:04 -07002191 output_lines = output.splitlines()
2192 self.assertEqual(len(output_lines), 2,
Gregory P. Smith9204e092014-06-15 20:16:01 -07002193 msg="expected exactly two lines of output:\n%r" % output)
Gregory P. Smith634aa682014-06-15 17:51:04 -07002194 opened_fds = set(map(int, output_lines[0].strip().split(b',')))
2195 remaining_fds = set(map(int, output_lines[1].strip().split(b',')))
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002196
Gregory P. Smith634aa682014-06-15 17:51:04 -07002197 self.assertFalse(remaining_fds & opened_fds,
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002198 msg="Some fds were left open.")
2199
2200
Victor Stinner88701e22011-06-01 13:13:04 +02002201 # Mac OS X Tiger (10.4) has a kernel bug: sometimes, the file
2202 # descriptor of a pipe closed in the parent process is valid in the
2203 # child process according to fstat(), but the mode of the file
2204 # descriptor is invalid, and read or write raise an error.
2205 @support.requires_mac_ver(10, 5)
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00002206 def test_pass_fds(self):
2207 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2208
2209 open_fds = set()
2210
2211 for x in range(5):
2212 fds = os.pipe()
2213 self.addCleanup(os.close, fds[0])
2214 self.addCleanup(os.close, fds[1])
Victor Stinnerdaf45552013-08-28 00:53:59 +02002215 os.set_inheritable(fds[0], True)
2216 os.set_inheritable(fds[1], True)
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00002217 open_fds.update(fds)
2218
2219 for fd in open_fds:
2220 p = subprocess.Popen([sys.executable, fd_status],
2221 stdout=subprocess.PIPE, close_fds=True,
2222 pass_fds=(fd, ))
2223 output, ignored = p.communicate()
2224
2225 remaining_fds = set(map(int, output.split(b',')))
2226 to_be_closed = open_fds - {fd}
2227
2228 self.assertIn(fd, remaining_fds, "fd to be passed not passed")
2229 self.assertFalse(remaining_fds & to_be_closed,
2230 "fd to be closed passed")
2231
2232 # pass_fds overrides close_fds with a warning.
2233 with self.assertWarns(RuntimeWarning) as context:
2234 self.assertFalse(subprocess.call(
2235 [sys.executable, "-c", "import sys; sys.exit(0)"],
2236 close_fds=False, pass_fds=(fd, )))
2237 self.assertIn('overriding close_fds', str(context.warning))
2238
Victor Stinnerdaf45552013-08-28 00:53:59 +02002239 def test_pass_fds_inheritable(self):
Victor Stinnerf6fa22e2013-09-01 10:22:41 +02002240 script = support.findfile("fd_status.py", subdir="subprocessdata")
Victor Stinnerdaf45552013-08-28 00:53:59 +02002241
2242 inheritable, non_inheritable = os.pipe()
2243 self.addCleanup(os.close, inheritable)
2244 self.addCleanup(os.close, non_inheritable)
2245 os.set_inheritable(inheritable, True)
2246 os.set_inheritable(non_inheritable, False)
2247 pass_fds = (inheritable, non_inheritable)
2248 args = [sys.executable, script]
2249 args += list(map(str, pass_fds))
2250
2251 p = subprocess.Popen(args,
2252 stdout=subprocess.PIPE, close_fds=True,
2253 pass_fds=pass_fds)
2254 output, ignored = p.communicate()
2255 fds = set(map(int, output.split(b',')))
2256
2257 # the inheritable file descriptor must be inherited, so its inheritable
2258 # flag must be set in the child process after fork() and before exec()
Victor Stinnerf6fa22e2013-09-01 10:22:41 +02002259 self.assertEqual(fds, set(pass_fds), "output=%a" % output)
Victor Stinnerdaf45552013-08-28 00:53:59 +02002260
2261 # inheritable flag must not be changed in the parent process
2262 self.assertEqual(os.get_inheritable(inheritable), True)
2263 self.assertEqual(os.get_inheritable(non_inheritable), False)
2264
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04002265 def test_stdout_stdin_are_single_inout_fd(self):
2266 with io.open(os.devnull, "r+") as inout:
2267 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
2268 stdout=inout, stdin=inout)
2269 p.wait()
2270
2271 def test_stdout_stderr_are_single_inout_fd(self):
2272 with io.open(os.devnull, "r+") as inout:
2273 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
2274 stdout=inout, stderr=inout)
2275 p.wait()
2276
2277 def test_stderr_stdin_are_single_inout_fd(self):
2278 with io.open(os.devnull, "r+") as inout:
2279 p = subprocess.Popen([sys.executable, "-c", "import sys; sys.exit(0)"],
2280 stderr=inout, stdin=inout)
2281 p.wait()
2282
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00002283 def test_wait_when_sigchild_ignored(self):
2284 # NOTE: sigchild_ignore.py may not be an effective test on all OSes.
2285 sigchild_ignore = support.findfile("sigchild_ignore.py",
2286 subdir="subprocessdata")
2287 p = subprocess.Popen([sys.executable, sigchild_ignore],
2288 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
2289 stdout, stderr = p.communicate()
2290 self.assertEqual(0, p.returncode, "sigchild_ignore.py exited"
Gregory P. Smitha80f4fb2010-12-14 15:23:02 +00002291 " non-zero with this error:\n%s" %
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00002292 stderr.decode('utf-8'))
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00002293
Antoine Pitrou7b98d022011-03-19 17:04:13 +01002294 def test_select_unbuffered(self):
2295 # Issue #11459: bufsize=0 should really set the pipes as
2296 # unbuffered (and therefore let select() work properly).
2297 select = support.import_module("select")
2298 p = subprocess.Popen([sys.executable, "-c",
2299 'import sys;'
2300 'sys.stdout.write("apple")'],
2301 stdout=subprocess.PIPE,
2302 bufsize=0)
2303 f = p.stdout
Ross Lagerwall17ace7a2011-03-26 21:21:46 +02002304 self.addCleanup(f.close)
Antoine Pitrou7b98d022011-03-19 17:04:13 +01002305 try:
2306 self.assertEqual(f.read(4), b"appl")
2307 self.assertIn(f, select.select([f], [], [], 0.0)[0])
2308 finally:
2309 p.wait()
2310
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002311 def test_zombie_fast_process_del(self):
2312 # Issue #12650: on Unix, if Popen.__del__() was called before the
2313 # process exited, it wouldn't be added to subprocess._active, and would
2314 # remain a zombie.
2315 # spawn a Popen, and delete its reference before it exits
2316 p = subprocess.Popen([sys.executable, "-c",
2317 'import sys, time;'
2318 'time.sleep(0.2)'],
2319 stdout=subprocess.PIPE,
2320 stderr=subprocess.PIPE)
Nadeem Vawda0d7cda32011-08-19 05:12:01 +02002321 self.addCleanup(p.stdout.close)
2322 self.addCleanup(p.stderr.close)
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002323 ident = id(p)
2324 pid = p.pid
Victor Stinner5a48e212016-05-20 12:11:15 +02002325 with support.check_warnings(('', ResourceWarning)):
2326 p = None
2327
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002328 # check that p is in the active processes list
2329 self.assertIn(ident, [id(o) for o in subprocess._active])
2330
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002331 def test_leak_fast_process_del_killed(self):
2332 # Issue #12650: on Unix, if Popen.__del__() was called before the
2333 # process exited, and the process got killed by a signal, it would never
2334 # be removed from subprocess._active, which triggered a FD and memory
2335 # leak.
2336 # spawn a Popen, delete its reference and kill it
2337 p = subprocess.Popen([sys.executable, "-c",
2338 'import time;'
2339 'time.sleep(3)'],
2340 stdout=subprocess.PIPE,
2341 stderr=subprocess.PIPE)
Nadeem Vawda0d7cda32011-08-19 05:12:01 +02002342 self.addCleanup(p.stdout.close)
2343 self.addCleanup(p.stderr.close)
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002344 ident = id(p)
2345 pid = p.pid
Victor Stinner5a48e212016-05-20 12:11:15 +02002346 with support.check_warnings(('', ResourceWarning)):
2347 p = None
2348
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002349 os.kill(pid, signal.SIGKILL)
2350 # check that p is in the active processes list
2351 self.assertIn(ident, [id(o) for o in subprocess._active])
2352
2353 # let some time for the process to exit, and create a new Popen: this
2354 # should trigger the wait() of p
2355 time.sleep(0.2)
Andrew Svetlov3438fa42012-12-17 23:35:18 +02002356 with self.assertRaises(OSError) as c:
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002357 with subprocess.Popen(['nonexisting_i_hope'],
2358 stdout=subprocess.PIPE,
2359 stderr=subprocess.PIPE) as proc:
2360 pass
2361 # p should have been wait()ed on, and removed from the _active list
2362 self.assertRaises(OSError, os.waitpid, pid, 0)
2363 self.assertNotIn(ident, [id(o) for o in subprocess._active])
2364
Charles-François Natali249cdc32013-08-25 18:24:45 +02002365 def test_close_fds_after_preexec(self):
2366 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2367
2368 # this FD is used as dup2() target by preexec_fn, and should be closed
2369 # in the child process
2370 fd = os.dup(1)
2371 self.addCleanup(os.close, fd)
2372
2373 p = subprocess.Popen([sys.executable, fd_status],
2374 stdout=subprocess.PIPE, close_fds=True,
2375 preexec_fn=lambda: os.dup2(1, fd))
2376 output, ignored = p.communicate()
2377
2378 remaining_fds = set(map(int, output.split(b',')))
2379
2380 self.assertNotIn(fd, remaining_fds)
2381
Victor Stinner8f437aa2014-10-05 17:25:19 +02002382 @support.cpython_only
2383 def test_fork_exec(self):
2384 # Issue #22290: fork_exec() must not crash on memory allocation failure
2385 # or other errors
2386 import _posixsubprocess
2387 gc_enabled = gc.isenabled()
2388 try:
2389 # Use a preexec function and enable the garbage collector
2390 # to force fork_exec() to re-enable the garbage collector
2391 # on error.
2392 func = lambda: None
2393 gc.enable()
2394
Victor Stinner8f437aa2014-10-05 17:25:19 +02002395 for args, exe_list, cwd, env_list in (
2396 (123, [b"exe"], None, [b"env"]),
2397 ([b"arg"], 123, None, [b"env"]),
2398 ([b"arg"], [b"exe"], 123, [b"env"]),
2399 ([b"arg"], [b"exe"], None, 123),
2400 ):
2401 with self.assertRaises(TypeError):
2402 _posixsubprocess.fork_exec(
2403 args, exe_list,
2404 True, [], cwd, env_list,
2405 -1, -1, -1, -1,
2406 1, 2, 3, 4,
2407 True, True, func)
2408 finally:
2409 if not gc_enabled:
2410 gc.disable()
2411
Gregory P. Smithd0a5b1c2015-11-15 21:15:26 -08002412 @support.cpython_only
2413 def test_fork_exec_sorted_fd_sanity_check(self):
2414 # Issue #23564: sanity check the fork_exec() fds_to_keep sanity check.
2415 import _posixsubprocess
2416 gc_enabled = gc.isenabled()
2417 try:
2418 gc.enable()
2419
2420 for fds_to_keep in (
2421 (-1, 2, 3, 4, 5), # Negative number.
2422 ('str', 4), # Not an int.
2423 (18, 23, 42, 2**63), # Out of range.
2424 (5, 4), # Not sorted.
2425 (6, 7, 7, 8), # Duplicate.
2426 ):
2427 with self.assertRaises(
2428 ValueError,
2429 msg='fds_to_keep={}'.format(fds_to_keep)) as c:
2430 _posixsubprocess.fork_exec(
2431 [b"false"], [b"false"],
2432 True, fds_to_keep, None, [b"env"],
2433 -1, -1, -1, -1,
2434 1, 2, 3, 4,
2435 True, True, None)
2436 self.assertIn('fds_to_keep', str(c.exception))
2437 finally:
2438 if not gc_enabled:
2439 gc.disable()
Victor Stinner8f437aa2014-10-05 17:25:19 +02002440
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)2daf8e72016-06-05 02:57:47 +00002441 def test_communicate_BrokenPipeError_stdin_close(self):
2442 # By not setting stdout or stderr or a timeout we force the fast path
2443 # that just calls _stdin_write() internally due to our mock.
2444 proc = subprocess.Popen([sys.executable, '-c', 'pass'])
2445 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin:
2446 mock_proc_stdin.close.side_effect = BrokenPipeError
2447 proc.communicate() # Should swallow BrokenPipeError from close.
2448 mock_proc_stdin.close.assert_called_with()
2449
2450 def test_communicate_BrokenPipeError_stdin_write(self):
2451 # By not setting stdout or stderr or a timeout we force the fast path
2452 # that just calls _stdin_write() internally due to our mock.
2453 proc = subprocess.Popen([sys.executable, '-c', 'pass'])
2454 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin:
2455 mock_proc_stdin.write.side_effect = BrokenPipeError
2456 proc.communicate(b'stuff') # Should swallow the BrokenPipeError.
2457 mock_proc_stdin.write.assert_called_once_with(b'stuff')
2458 mock_proc_stdin.close.assert_called_once_with()
2459
2460 def test_communicate_BrokenPipeError_stdin_flush(self):
2461 # Setting stdin and stdout forces the ._communicate() code path.
2462 # python -h exits faster than python -c pass (but spams stdout).
2463 proc = subprocess.Popen([sys.executable, '-h'],
2464 stdin=subprocess.PIPE,
2465 stdout=subprocess.PIPE)
2466 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin, \
2467 open(os.devnull, 'wb') as dev_null:
2468 mock_proc_stdin.flush.side_effect = BrokenPipeError
2469 # because _communicate registers a selector using proc.stdin...
2470 mock_proc_stdin.fileno.return_value = dev_null.fileno()
2471 # _communicate() should swallow BrokenPipeError from flush.
2472 proc.communicate(b'stuff')
2473 mock_proc_stdin.flush.assert_called_once_with()
2474
2475 def test_communicate_BrokenPipeError_stdin_close_with_timeout(self):
2476 # Setting stdin and stdout forces the ._communicate() code path.
2477 # python -h exits faster than python -c pass (but spams stdout).
2478 proc = subprocess.Popen([sys.executable, '-h'],
2479 stdin=subprocess.PIPE,
2480 stdout=subprocess.PIPE)
2481 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin:
2482 mock_proc_stdin.close.side_effect = BrokenPipeError
2483 # _communicate() should swallow BrokenPipeError from close.
2484 proc.communicate(timeout=999)
2485 mock_proc_stdin.close.assert_called_once_with()
2486
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002487
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00002488@unittest.skipUnless(mswindows, "Windows specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +00002489class Win32ProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00002490
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002491 def test_startupinfo(self):
2492 # startupinfo argument
2493 # We uses hardcoded constants, because we do not want to
2494 # depend on win32all.
2495 STARTF_USESHOWWINDOW = 1
2496 SW_MAXIMIZE = 3
2497 startupinfo = subprocess.STARTUPINFO()
2498 startupinfo.dwFlags = STARTF_USESHOWWINDOW
2499 startupinfo.wShowWindow = SW_MAXIMIZE
2500 # Since Python is a console process, it won't be affected
2501 # by wShowWindow, but the argument should be silently
2502 # ignored
2503 subprocess.call([sys.executable, "-c", "import sys; sys.exit(0)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002504 startupinfo=startupinfo)
2505
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002506 def test_creationflags(self):
2507 # creationflags argument
2508 CREATE_NEW_CONSOLE = 16
2509 sys.stderr.write(" a DOS box should flash briefly ...\n")
2510 subprocess.call(sys.executable +
2511 ' -c "import time; time.sleep(0.25)"',
2512 creationflags=CREATE_NEW_CONSOLE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002513
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002514 def test_invalid_args(self):
2515 # invalid arguments should raise ValueError
2516 self.assertRaises(ValueError, subprocess.call,
2517 [sys.executable, "-c",
2518 "import sys; sys.exit(47)"],
2519 preexec_fn=lambda: 1)
2520 self.assertRaises(ValueError, subprocess.call,
2521 [sys.executable, "-c",
2522 "import sys; sys.exit(47)"],
2523 stdout=subprocess.PIPE,
2524 close_fds=True)
2525
2526 def test_close_fds(self):
2527 # close file descriptors
2528 rc = subprocess.call([sys.executable, "-c",
2529 "import sys; sys.exit(47)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002530 close_fds=True)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002531 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002532
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002533 def test_shell_sequence(self):
2534 # Run command through the shell (sequence)
2535 newenv = os.environ.copy()
2536 newenv["FRUIT"] = "physalis"
2537 p = subprocess.Popen(["set"], shell=1,
2538 stdout=subprocess.PIPE,
2539 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02002540 with p:
2541 self.assertIn(b"physalis", p.stdout.read())
Guido van Rossume7ba4952007-06-06 23:52:48 +00002542
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002543 def test_shell_string(self):
2544 # Run command through the shell (string)
2545 newenv = os.environ.copy()
2546 newenv["FRUIT"] = "physalis"
2547 p = subprocess.Popen("set", shell=1,
2548 stdout=subprocess.PIPE,
2549 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02002550 with p:
2551 self.assertIn(b"physalis", p.stdout.read())
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002552
Steve Dower050acae2016-09-06 20:16:17 -07002553 def test_shell_encodings(self):
2554 # Run command through the shell (string)
2555 for enc in ['ansi', 'oem']:
2556 newenv = os.environ.copy()
2557 newenv["FRUIT"] = "physalis"
2558 p = subprocess.Popen("set", shell=1,
2559 stdout=subprocess.PIPE,
2560 env=newenv,
2561 encoding=enc)
2562 with p:
2563 self.assertIn("physalis", p.stdout.read(), enc)
2564
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002565 def test_call_string(self):
2566 # call() function with string argument on Windows
2567 rc = subprocess.call(sys.executable +
2568 ' -c "import sys; sys.exit(47)"')
2569 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002570
Florent Xicluna4886d242010-03-08 13:27:26 +00002571 def _kill_process(self, method, *args):
2572 # Some win32 buildbot raises EOFError if stdin is inherited
Antoine Pitroua4024e22010-09-24 18:57:01 +00002573 p = subprocess.Popen([sys.executable, "-c", """if 1:
2574 import sys, time
2575 sys.stdout.write('x\\n')
2576 sys.stdout.flush()
2577 time.sleep(30)
2578 """],
2579 stdin=subprocess.PIPE,
2580 stdout=subprocess.PIPE,
2581 stderr=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +02002582 with p:
2583 # Wait for the interpreter to be completely initialized before
2584 # sending any signal.
2585 p.stdout.read(1)
2586 getattr(p, method)(*args)
2587 _, stderr = p.communicate()
2588 self.assertStderrEqual(stderr, b'')
2589 returncode = p.wait()
Florent Xicluna4886d242010-03-08 13:27:26 +00002590 self.assertNotEqual(returncode, 0)
2591
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01002592 def _kill_dead_process(self, method, *args):
2593 p = subprocess.Popen([sys.executable, "-c", """if 1:
2594 import sys, time
2595 sys.stdout.write('x\\n')
2596 sys.stdout.flush()
2597 sys.exit(42)
2598 """],
2599 stdin=subprocess.PIPE,
2600 stdout=subprocess.PIPE,
2601 stderr=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +02002602 with p:
2603 # Wait for the interpreter to be completely initialized before
2604 # sending any signal.
2605 p.stdout.read(1)
2606 # The process should end after this
2607 time.sleep(1)
2608 # This shouldn't raise even though the child is now dead
2609 getattr(p, method)(*args)
2610 _, stderr = p.communicate()
2611 self.assertStderrEqual(stderr, b'')
2612 rc = p.wait()
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01002613 self.assertEqual(rc, 42)
2614
Florent Xicluna4886d242010-03-08 13:27:26 +00002615 def test_send_signal(self):
2616 self._kill_process('send_signal', signal.SIGTERM)
Christian Heimesa342c012008-04-20 21:01:16 +00002617
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002618 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00002619 self._kill_process('kill')
Christian Heimesa342c012008-04-20 21:01:16 +00002620
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002621 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00002622 self._kill_process('terminate')
Christian Heimesa342c012008-04-20 21:01:16 +00002623
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01002624 def test_send_signal_dead(self):
2625 self._kill_dead_process('send_signal', signal.SIGTERM)
2626
2627 def test_kill_dead(self):
2628 self._kill_dead_process('kill')
2629
2630 def test_terminate_dead(self):
2631 self._kill_dead_process('terminate')
2632
Martin Panter23172bd2016-04-16 11:28:10 +00002633class MiscTests(unittest.TestCase):
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002634 def test_getoutput(self):
2635 self.assertEqual(subprocess.getoutput('echo xyzzy'), 'xyzzy')
2636 self.assertEqual(subprocess.getstatusoutput('echo xyzzy'),
2637 (0, 'xyzzy'))
Brett Cannona23810f2008-05-26 19:04:21 +00002638
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002639 # we use mkdtemp in the next line to create an empty directory
2640 # under our exclusive control; from that, we can invent a pathname
2641 # that we _know_ won't exist. This is guaranteed to fail.
2642 dir = None
2643 try:
2644 dir = tempfile.mkdtemp()
2645 name = os.path.join(dir, "foo")
Tim Goldene0041752013-11-03 12:53:17 +00002646 status, output = subprocess.getstatusoutput(
2647 ("type " if mswindows else "cat ") + name)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002648 self.assertNotEqual(status, 0)
2649 finally:
2650 if dir is not None:
2651 os.rmdir(dir)
Brett Cannona23810f2008-05-26 19:04:21 +00002652
Gregory P. Smithace55862015-04-07 15:57:54 -07002653 def test__all__(self):
2654 """Ensure that __all__ is populated properly."""
Martin Panter528619b2016-04-16 23:42:37 +00002655 intentionally_excluded = {"list2cmdline", "Handle"}
Gregory P. Smithace55862015-04-07 15:57:54 -07002656 exported = set(subprocess.__all__)
2657 possible_exports = set()
2658 import types
2659 for name, value in subprocess.__dict__.items():
2660 if name.startswith('_'):
2661 continue
2662 if isinstance(value, (types.ModuleType,)):
2663 continue
2664 possible_exports.add(name)
2665 self.assertEqual(exported, possible_exports - intentionally_excluded)
2666
2667
Martin Panter23172bd2016-04-16 11:28:10 +00002668@unittest.skipUnless(hasattr(selectors, 'PollSelector'),
2669 "Test needs selectors.PollSelector")
2670class ProcessTestCaseNoPoll(ProcessTestCase):
2671 def setUp(self):
2672 self.orig_selector = subprocess._PopenSelector
2673 subprocess._PopenSelector = selectors.SelectSelector
2674 ProcessTestCase.setUp(self)
2675
2676 def tearDown(self):
2677 subprocess._PopenSelector = self.orig_selector
2678 ProcessTestCase.tearDown(self)
2679
Gregory P. Smithd06fa472009-07-04 02:46:54 +00002680
Tim Golden126c2962010-08-11 14:20:40 +00002681@unittest.skipUnless(mswindows, "Windows-specific tests")
2682class CommandsWithSpaces (BaseTestCase):
2683
2684 def setUp(self):
2685 super().setUp()
Berker Peksag16a1f282015-09-28 13:33:14 +03002686 f, fname = tempfile.mkstemp(".py", "te st")
Tim Golden126c2962010-08-11 14:20:40 +00002687 self.fname = fname.lower ()
2688 os.write(f, b"import sys;"
2689 b"sys.stdout.write('%d %s' % (len(sys.argv), [a.lower () for a in sys.argv]))"
2690 )
2691 os.close(f)
2692
2693 def tearDown(self):
2694 os.remove(self.fname)
2695 super().tearDown()
2696
2697 def with_spaces(self, *args, **kwargs):
2698 kwargs['stdout'] = subprocess.PIPE
2699 p = subprocess.Popen(*args, **kwargs)
Victor Stinner7438c612016-05-20 12:43:15 +02002700 with p:
2701 self.assertEqual(
2702 p.stdout.read ().decode("mbcs"),
2703 "2 [%r, 'ab cd']" % self.fname
2704 )
Tim Golden126c2962010-08-11 14:20:40 +00002705
2706 def test_shell_string_with_spaces(self):
2707 # call() function with string argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00002708 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
2709 "ab cd"), shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00002710
2711 def test_shell_sequence_with_spaces(self):
2712 # call() function with sequence argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00002713 self.with_spaces([sys.executable, self.fname, "ab cd"], shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00002714
2715 def test_noshell_string_with_spaces(self):
2716 # call() function with string argument with spaces on Windows
2717 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
2718 "ab cd"))
2719
2720 def test_noshell_sequence_with_spaces(self):
2721 # call() function with sequence argument with spaces on Windows
2722 self.with_spaces([sys.executable, self.fname, "ab cd"])
2723
Brian Curtin79cdb662010-12-03 02:46:02 +00002724
Georg Brandla86b2622012-02-20 21:34:57 +01002725class ContextManagerTests(BaseTestCase):
Brian Curtin79cdb662010-12-03 02:46:02 +00002726
2727 def test_pipe(self):
2728 with subprocess.Popen([sys.executable, "-c",
2729 "import sys;"
2730 "sys.stdout.write('stdout');"
2731 "sys.stderr.write('stderr');"],
2732 stdout=subprocess.PIPE,
2733 stderr=subprocess.PIPE) as proc:
2734 self.assertEqual(proc.stdout.read(), b"stdout")
2735 self.assertStderrEqual(proc.stderr.read(), b"stderr")
2736
2737 self.assertTrue(proc.stdout.closed)
2738 self.assertTrue(proc.stderr.closed)
2739
2740 def test_returncode(self):
2741 with subprocess.Popen([sys.executable, "-c",
2742 "import sys; sys.exit(100)"]) as proc:
Gregory P. Smith6b657452011-05-11 21:42:08 -07002743 pass
2744 # __exit__ calls wait(), so the returncode should be set
Brian Curtin79cdb662010-12-03 02:46:02 +00002745 self.assertEqual(proc.returncode, 100)
2746
2747 def test_communicate_stdin(self):
2748 with subprocess.Popen([sys.executable, "-c",
2749 "import sys;"
2750 "sys.exit(sys.stdin.read() == 'context')"],
2751 stdin=subprocess.PIPE) as proc:
2752 proc.communicate(b"context")
2753 self.assertEqual(proc.returncode, 1)
2754
2755 def test_invalid_args(self):
Andrew Svetlovb1726972012-12-26 23:34:54 +02002756 with self.assertRaises(FileNotFoundError) as c:
Brian Curtin79cdb662010-12-03 02:46:02 +00002757 with subprocess.Popen(['nonexisting_i_hope'],
2758 stdout=subprocess.PIPE,
2759 stderr=subprocess.PIPE) as proc:
2760 pass
2761
Serhiy Storchakaab900c22015-02-28 12:43:08 +02002762 def test_broken_pipe_cleanup(self):
2763 """Broken pipe error should not prevent wait() (Issue 21619)"""
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02002764 proc = subprocess.Popen([sys.executable, '-c', 'pass'],
Victor Stinner20f4bd42015-03-05 02:38:41 +01002765 stdin=subprocess.PIPE,
Victor Stinner20f4bd42015-03-05 02:38:41 +01002766 bufsize=support.PIPE_MAX_SIZE*2)
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02002767 proc = proc.__enter__()
2768 # Prepare to send enough data to overflow any OS pipe buffering and
2769 # guarantee a broken pipe error. Data is held in BufferedWriter
2770 # buffer until closed.
2771 proc.stdin.write(b'x' * support.PIPE_MAX_SIZE)
Serhiy Storchakaab900c22015-02-28 12:43:08 +02002772 self.assertIsNone(proc.returncode)
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02002773 # EPIPE expected under POSIX; EINVAL under Windows
Serhiy Storchakacf265fd2015-02-28 13:27:54 +02002774 self.assertRaises(OSError, proc.__exit__, None, None, None)
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02002775 self.assertEqual(proc.returncode, 0)
Serhiy Storchakaab900c22015-02-28 12:43:08 +02002776 self.assertTrue(proc.stdin.closed)
Serhiy Storchakaab900c22015-02-28 12:43:08 +02002777
Brian Curtin79cdb662010-12-03 02:46:02 +00002778
Gregory P. Smith3b4652e2011-03-15 15:43:39 -04002779def test_main():
2780 unit_tests = (ProcessTestCase,
2781 POSIXProcessTestCase,
2782 Win32ProcessTestCase,
Martin Panter23172bd2016-04-16 11:28:10 +00002783 MiscTests,
Gregory P. Smith3b4652e2011-03-15 15:43:39 -04002784 ProcessTestCaseNoPoll,
Gregory P. Smith3b4652e2011-03-15 15:43:39 -04002785 CommandsWithSpaces,
Antoine Pitrouab85ff32011-07-23 22:03:45 +02002786 ContextManagerTests,
Gregory P. Smith6e730002015-04-14 16:14:25 -07002787 RunFuncTestCase,
Antoine Pitrouab85ff32011-07-23 22:03:45 +02002788 )
Gregory P. Smith3b4652e2011-03-15 15:43:39 -04002789
2790 support.run_unittest(*unit_tests)
2791 support.reap_children()
2792
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002793if __name__ == "__main__":
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04002794 unittest.main()