blob: 1cebf6b24a69e9611e7795767931a05d771f47d1 [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
Alexey Izbyshev0e7144b2018-03-26 22:49:35 +03008import itertools
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00009import os
Gregory P. Smitha59c59f2010-03-01 00:17:40 +000010import errno
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000011import tempfile
12import time
Gregory P. Smith580d2782019-09-11 04:23:05 -050013import traceback
Charles-François Natali3a4586a2013-11-08 19:56:59 +010014import selectors
Ezio Melotti184bdfb2010-02-18 09:37:05 +000015import sysconfig
Gregory P. Smith51ee2702010-12-13 07:59:39 +000016import select
Gregory P. Smith81ce6852011-03-15 02:04:11 -040017import shutil
Antoine Pitroua6a4dc82017-09-07 18:56:24 +020018import threading
Benjamin Petersonb870aa12011-12-10 12:44:25 -050019import gc
Andrew Svetlov47ec25d2012-08-19 16:25:37 +030020import textwrap
Patrick McLean2b2ead72019-09-12 10:15:44 -070021import json
Serhiy Storchakab21d1552018-03-02 11:53:51 +020022from test.support import FakePath
Benjamin Peterson964561b2011-12-10 12:31:42 -050023
24try:
Victor Stinner7b7c6dc2017-08-10 12:37:39 +020025 import _testcapi
26except ImportError:
27 _testcapi = None
28
Patrick McLean2b2ead72019-09-12 10:15:44 -070029try:
30 import pwd
31except ImportError:
32 pwd = None
33try:
34 import grp
35except ImportError:
36 grp = None
Victor Stinner8f4ef3b2019-07-01 18:28:25 +020037
Steve Dower22d06982016-09-06 19:38:15 -070038if support.PGO:
39 raise unittest.SkipTest("test is not helpful for PGO")
40
Victor Stinner937ee9e2018-06-26 02:11:06 +020041mswindows = (sys.platform == "win32")
42
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000043#
44# Depends on the following external programs: Python
45#
46
Victor Stinner937ee9e2018-06-26 02:11:06 +020047if mswindows:
Tim Peters3b01a702004-10-12 22:19:32 +000048 SETBINARY = ('import msvcrt; msvcrt.setmode(sys.stdout.fileno(), '
49 'os.O_BINARY);')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +000050else:
51 SETBINARY = ''
52
Victor Stinner9a83f652017-08-21 23:51:31 +020053NONEXISTING_CMD = ('nonexisting_i_hope',)
Victor Stinnerb31206a2018-01-25 19:06:05 +010054# Ignore errors that indicate the command was not found
55NONEXISTING_ERRORS = (FileNotFoundError, NotADirectoryError, PermissionError)
Victor Stinner9a83f652017-08-21 23:51:31 +020056
Gregory P. Smith67b93f82019-10-12 16:35:53 -070057ZERO_RETURN_CMD = (sys.executable, '-c', 'pass')
58
59
60def setUpModule():
61 shell_true = shutil.which('true')
Pablo Galindo46113e02019-10-13 02:40:24 +010062 if shell_true is None:
63 return
Gregory P. Smith67b93f82019-10-12 16:35:53 -070064 if (os.access(shell_true, os.X_OK) and
65 subprocess.run([shell_true]).returncode == 0):
66 global ZERO_RETURN_CMD
67 ZERO_RETURN_CMD = (shell_true,) # Faster than Python startup.
68
Florent Xiclunab1e94e82010-02-27 22:12:37 +000069
Florent Xiclunac049d872010-03-27 22:47:23 +000070class BaseTestCase(unittest.TestCase):
Thomas Wouters0e3f5912006-08-11 14:57:12 +000071 def setUp(self):
72 # Try to minimize the number of children we have so this test
73 # doesn't crash on some buildbots (Alphas in particular).
Florent Xiclunab1e94e82010-02-27 22:12:37 +000074 support.reap_children()
Thomas Wouters0e3f5912006-08-11 14:57:12 +000075
Florent Xiclunaf0cbd822010-03-04 21:50:56 +000076 def tearDown(self):
Ruslan Kuprieiev042821a2019-06-28 19:12:16 +030077 if not mswindows:
78 # subprocess._active is not used on Windows and is set to None.
79 for inst in subprocess._active:
80 inst.wait()
81 subprocess._cleanup()
82 self.assertFalse(
83 subprocess._active, "subprocess._active not empty"
84 )
Victor Stinnercc42c122017-07-28 18:00:22 +020085 self.doCleanups()
86 support.reap_children()
Florent Xiclunaf0cbd822010-03-04 21:50:56 +000087
Florent Xiclunac049d872010-03-27 22:47:23 +000088
Gregory P. Smith3d8e7762012-11-10 22:32:22 -080089class PopenTestException(Exception):
90 pass
91
92
93class PopenExecuteChildRaises(subprocess.Popen):
94 """Popen subclass for testing cleanup of subprocess.PIPE filehandles when
95 _execute_child fails.
96 """
97 def _execute_child(self, *args, **kwargs):
98 raise PopenTestException("Forced Exception for Test")
99
100
Florent Xiclunac049d872010-03-27 22:47:23 +0000101class ProcessTestCase(BaseTestCase):
102
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700103 def test_io_buffered_by_default(self):
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700104 p = subprocess.Popen(ZERO_RETURN_CMD,
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700105 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
106 stderr=subprocess.PIPE)
107 try:
108 self.assertIsInstance(p.stdin, io.BufferedIOBase)
109 self.assertIsInstance(p.stdout, io.BufferedIOBase)
110 self.assertIsInstance(p.stderr, io.BufferedIOBase)
111 finally:
Gregory P. Smitha1b9ed32013-03-23 11:54:22 -0700112 p.stdin.close()
113 p.stdout.close()
114 p.stderr.close()
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700115 p.wait()
116
117 def test_io_unbuffered_works(self):
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700118 p = subprocess.Popen(ZERO_RETURN_CMD,
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700119 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
120 stderr=subprocess.PIPE, bufsize=0)
121 try:
122 self.assertIsInstance(p.stdin, io.RawIOBase)
123 self.assertIsInstance(p.stdout, io.RawIOBase)
124 self.assertIsInstance(p.stderr, io.RawIOBase)
125 finally:
Gregory P. Smitha1b9ed32013-03-23 11:54:22 -0700126 p.stdin.close()
127 p.stdout.close()
128 p.stderr.close()
Gregory P. Smitha1ed5392013-03-23 11:44:25 -0700129 p.wait()
130
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000131 def test_call_seq(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000132 # call() function with sequence argument
Tim Peters3b01a702004-10-12 22:19:32 +0000133 rc = subprocess.call([sys.executable, "-c",
134 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000135 self.assertEqual(rc, 47)
136
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400137 def test_call_timeout(self):
138 # call() function with timeout argument; we want to test that the child
139 # process gets killed when the timeout expires. If the child isn't
140 # killed, this call will deadlock since subprocess.call waits for the
141 # child.
142 self.assertRaises(subprocess.TimeoutExpired, subprocess.call,
143 [sys.executable, "-c", "while True: pass"],
144 timeout=0.1)
145
Peter Astrand454f7672005-01-01 09:36:35 +0000146 def test_check_call_zero(self):
147 # check_call() function with zero return code
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700148 rc = subprocess.check_call(ZERO_RETURN_CMD)
Peter Astrand454f7672005-01-01 09:36:35 +0000149 self.assertEqual(rc, 0)
150
151 def test_check_call_nonzero(self):
152 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000153 with self.assertRaises(subprocess.CalledProcessError) as c:
Peter Astrand454f7672005-01-01 09:36:35 +0000154 subprocess.check_call([sys.executable, "-c",
155 "import sys; sys.exit(47)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000156 self.assertEqual(c.exception.returncode, 47)
Peter Astrand454f7672005-01-01 09:36:35 +0000157
Georg Brandlf9734072008-12-07 15:30:06 +0000158 def test_check_output(self):
159 # check_output() function with zero return code
160 output = subprocess.check_output(
161 [sys.executable, "-c", "print('BDFL')"])
Benjamin Peterson577473f2010-01-19 00:09:57 +0000162 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +0000163
164 def test_check_output_nonzero(self):
165 # check_call() function with non-zero return code
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000166 with self.assertRaises(subprocess.CalledProcessError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +0000167 subprocess.check_output(
168 [sys.executable, "-c", "import sys; sys.exit(5)"])
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000169 self.assertEqual(c.exception.returncode, 5)
Georg Brandlf9734072008-12-07 15:30:06 +0000170
171 def test_check_output_stderr(self):
172 # check_output() function stderr redirected to stdout
173 output = subprocess.check_output(
174 [sys.executable, "-c", "import sys; sys.stderr.write('BDFL')"],
175 stderr=subprocess.STDOUT)
Benjamin Peterson577473f2010-01-19 00:09:57 +0000176 self.assertIn(b'BDFL', output)
Georg Brandlf9734072008-12-07 15:30:06 +0000177
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300178 def test_check_output_stdin_arg(self):
179 # check_output() can be called with stdin set to a file
180 tf = tempfile.TemporaryFile()
181 self.addCleanup(tf.close)
182 tf.write(b'pear')
183 tf.seek(0)
184 output = subprocess.check_output(
185 [sys.executable, "-c",
186 "import sys; sys.stdout.write(sys.stdin.read().upper())"],
187 stdin=tf)
188 self.assertIn(b'PEAR', output)
189
190 def test_check_output_input_arg(self):
191 # check_output() can be called with input set to a string
192 output = subprocess.check_output(
193 [sys.executable, "-c",
194 "import sys; sys.stdout.write(sys.stdin.read().upper())"],
195 input=b'pear')
196 self.assertIn(b'PEAR', output)
197
Georg Brandlf9734072008-12-07 15:30:06 +0000198 def test_check_output_stdout_arg(self):
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300199 # check_output() refuses to accept 'stdout' argument
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000200 with self.assertRaises(ValueError) as c:
Georg Brandlf9734072008-12-07 15:30:06 +0000201 output = subprocess.check_output(
202 [sys.executable, "-c", "print('will not be run')"],
203 stdout=sys.stdout)
Georg Brandlf9734072008-12-07 15:30:06 +0000204 self.fail("Expected ValueError when stdout arg supplied.")
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000205 self.assertIn('stdout', c.exception.args[0])
Georg Brandlf9734072008-12-07 15:30:06 +0000206
Serhiy Storchakafcd9f222013-04-22 20:20:54 +0300207 def test_check_output_stdin_with_input_arg(self):
208 # check_output() refuses to accept 'stdin' with 'input'
209 tf = tempfile.TemporaryFile()
210 self.addCleanup(tf.close)
211 tf.write(b'pear')
212 tf.seek(0)
213 with self.assertRaises(ValueError) as c:
214 output = subprocess.check_output(
215 [sys.executable, "-c", "print('will not be run')"],
216 stdin=tf, input=b'hare')
217 self.fail("Expected ValueError when stdin and input args supplied.")
218 self.assertIn('stdin', c.exception.args[0])
219 self.assertIn('input', c.exception.args[0])
220
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400221 def test_check_output_timeout(self):
222 # check_output() function with timeout arg
223 with self.assertRaises(subprocess.TimeoutExpired) as c:
224 output = subprocess.check_output(
225 [sys.executable, "-c",
Victor Stinner149b1c72011-06-06 23:43:02 +0200226 "import sys, time\n"
227 "sys.stdout.write('BDFL')\n"
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400228 "sys.stdout.flush()\n"
Victor Stinner149b1c72011-06-06 23:43:02 +0200229 "time.sleep(3600)"],
Reid Klecknerda9ac722011-03-16 17:08:21 -0400230 # Some heavily loaded buildbots (sparc Debian 3.x) require
231 # this much time to start and print.
232 timeout=3)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400233 self.fail("Expected TimeoutExpired.")
234 self.assertEqual(c.exception.output, b'BDFL')
235
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000236 def test_call_kwargs(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000237 # call() function with keyword args
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000238 newenv = os.environ.copy()
239 newenv["FRUIT"] = "banana"
240 rc = subprocess.call([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000241 'import sys, os;'
242 'sys.exit(os.getenv("FRUIT")=="banana")'],
243 env=newenv)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000244 self.assertEqual(rc, 1)
245
Victor Stinner87b9bc32011-06-01 00:57:47 +0200246 def test_invalid_args(self):
247 # Popen() called with invalid arguments should raise TypeError
248 # but Popen.__del__ should not complain (issue #12085)
249 with support.captured_stderr() as s:
250 self.assertRaises(TypeError, subprocess.Popen, invalid_arg_name=1)
251 argcount = subprocess.Popen.__init__.__code__.co_argcount
252 too_many_args = [0] * (argcount + 1)
253 self.assertRaises(TypeError, subprocess.Popen, *too_many_args)
254 self.assertEqual(s.getvalue(), '')
255
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000256 def test_stdin_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000257 # .stdin is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000258 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000259 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000260 self.addCleanup(p.stdout.close)
261 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000262 p.wait()
263 self.assertEqual(p.stdin, None)
264
265 def test_stdout_none(self):
Ezio Melotti42a541b2013-03-11 05:53:34 +0200266 # .stdout is None when not redirected, and the child's stdout will
267 # be inherited from the parent. In order to test this we run a
268 # subprocess in a subprocess:
269 # this_test
270 # \-- subprocess created by this test (parent)
271 # \-- subprocess created by the parent subprocess (child)
272 # The parent doesn't specify stdout, so the child will use the
273 # parent's stdout. This test checks that the message printed by the
274 # child goes to the parent stdout. The parent also checks that the
275 # child's stdout is None. See #11963.
276 code = ('import sys; from subprocess import Popen, PIPE;'
277 'p = Popen([sys.executable, "-c", "print(\'test_stdout_none\')"],'
278 ' stdin=PIPE, stderr=PIPE);'
279 'p.wait(); assert p.stdout is None;')
280 p = subprocess.Popen([sys.executable, "-c", code],
281 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
282 self.addCleanup(p.stdout.close)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000283 self.addCleanup(p.stderr.close)
Ezio Melotti42a541b2013-03-11 05:53:34 +0200284 out, err = p.communicate()
285 self.assertEqual(p.returncode, 0, err)
286 self.assertEqual(out.rstrip(), b'test_stdout_none')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000287
288 def test_stderr_none(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000289 # .stderr is None when not redirected
Georg Brandl88fc6642007-02-09 21:28:07 +0000290 p = subprocess.Popen([sys.executable, "-c", 'print("banana")'],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000291 stdin=subprocess.PIPE, stdout=subprocess.PIPE)
Brian Curtin3c6a9512010-11-05 03:58:52 +0000292 self.addCleanup(p.stdout.close)
293 self.addCleanup(p.stdin.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000294 p.wait()
295 self.assertEqual(p.stderr, None)
296
Chris Jerdonek776cb192012-10-08 15:56:43 -0700297 def _assert_python(self, pre_args, **kwargs):
298 # We include sys.exit() to prevent the test runner from hanging
299 # whenever python is found.
300 args = pre_args + ["import sys; sys.exit(47)"]
301 p = subprocess.Popen(args, **kwargs)
302 p.wait()
303 self.assertEqual(47, p.returncode)
304
305 def test_executable(self):
306 # Check that the executable argument works.
Chris Jerdonek86b0fb22012-10-09 13:17:49 -0700307 #
308 # On Unix (non-Mac and non-Windows), Python looks at args[0] to
309 # determine where its standard library is, so we need the directory
310 # of args[0] to be valid for the Popen() call to Python to succeed.
311 # See also issue #16170 and issue #7774.
312 doesnotexist = os.path.join(os.path.dirname(sys.executable),
313 "doesnotexist")
314 self._assert_python([doesnotexist, "-c"], executable=sys.executable)
Chris Jerdonek776cb192012-10-08 15:56:43 -0700315
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +0300316 def test_bytes_executable(self):
317 doesnotexist = os.path.join(os.path.dirname(sys.executable),
318 "doesnotexist")
319 self._assert_python([doesnotexist, "-c"],
320 executable=os.fsencode(sys.executable))
321
322 def test_pathlike_executable(self):
323 doesnotexist = os.path.join(os.path.dirname(sys.executable),
324 "doesnotexist")
325 self._assert_python([doesnotexist, "-c"],
326 executable=FakePath(sys.executable))
327
Chris Jerdonek776cb192012-10-08 15:56:43 -0700328 def test_executable_takes_precedence(self):
329 # Check that the executable argument takes precedence over args[0].
330 #
331 # Verify first that the call succeeds without the executable arg.
332 pre_args = [sys.executable, "-c"]
333 self._assert_python(pre_args)
Victor Stinnerb31206a2018-01-25 19:06:05 +0100334 self.assertRaises(NONEXISTING_ERRORS,
Xavier de Gaye38c8b7d2016-11-14 17:14:42 +0100335 self._assert_python, pre_args,
Victor Stinnerb31206a2018-01-25 19:06:05 +0100336 executable=NONEXISTING_CMD[0])
Chris Jerdonek776cb192012-10-08 15:56:43 -0700337
Victor Stinner937ee9e2018-06-26 02:11:06 +0200338 @unittest.skipIf(mswindows, "executable argument replaces shell")
Chris Jerdonek776cb192012-10-08 15:56:43 -0700339 def test_executable_replaces_shell(self):
340 # Check that the executable argument replaces the default shell
341 # when shell=True.
342 self._assert_python([], executable=sys.executable, shell=True)
343
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +0300344 @unittest.skipIf(mswindows, "executable argument replaces shell")
345 def test_bytes_executable_replaces_shell(self):
346 self._assert_python([], executable=os.fsencode(sys.executable),
347 shell=True)
348
349 @unittest.skipIf(mswindows, "executable argument replaces shell")
350 def test_pathlike_executable_replaces_shell(self):
351 self._assert_python([], executable=FakePath(sys.executable),
352 shell=True)
353
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700354 # For use in the test_cwd* tests below.
355 def _normalize_cwd(self, cwd):
356 # Normalize an expected cwd (for Tru64 support).
357 # We can't use os.path.realpath since it doesn't expand Tru64 {memb}
358 # strings. See bug #1063571.
Serhiy Storchaka2a23adf2015-09-06 14:13:25 +0300359 with support.change_cwd(cwd):
360 return os.getcwd()
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700361
362 # For use in the test_cwd* tests below.
363 def _split_python_path(self):
364 # Return normalized (python_dir, python_base).
365 python_path = os.path.realpath(sys.executable)
366 return os.path.split(python_path)
367
368 # For use in the test_cwd* tests below.
369 def _assert_cwd(self, expected_cwd, python_arg, **kwargs):
370 # Invoke Python via Popen, and assert that (1) the call succeeds,
371 # and that (2) the current working directory of the child process
372 # matches *expected_cwd*.
373 p = subprocess.Popen([python_arg, "-c",
374 "import os, sys; "
375 "sys.stdout.write(os.getcwd()); "
376 "sys.exit(47)"],
377 stdout=subprocess.PIPE,
378 **kwargs)
379 self.addCleanup(p.stdout.close)
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000380 p.wait()
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700381 self.assertEqual(47, p.returncode)
382 normcase = os.path.normcase
383 self.assertEqual(normcase(expected_cwd),
384 normcase(p.stdout.read().decode("utf-8")))
385
386 def test_cwd(self):
387 # Check that cwd changes the cwd for the child process.
388 temp_dir = tempfile.gettempdir()
389 temp_dir = self._normalize_cwd(temp_dir)
390 self._assert_cwd(temp_dir, sys.executable, cwd=temp_dir)
391
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +0300392 def test_cwd_with_bytes(self):
393 temp_dir = tempfile.gettempdir()
394 temp_dir = self._normalize_cwd(temp_dir)
395 self._assert_cwd(temp_dir, sys.executable, cwd=os.fsencode(temp_dir))
396
Sayan Chowdhuryd5c11f72017-02-26 22:36:10 +0530397 def test_cwd_with_pathlike(self):
398 temp_dir = tempfile.gettempdir()
399 temp_dir = self._normalize_cwd(temp_dir)
Serhiy Storchakab21d1552018-03-02 11:53:51 +0200400 self._assert_cwd(temp_dir, sys.executable, cwd=FakePath(temp_dir))
Sayan Chowdhuryd5c11f72017-02-26 22:36:10 +0530401
Victor Stinner937ee9e2018-06-26 02:11:06 +0200402 @unittest.skipIf(mswindows, "pending resolution of issue #15533")
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700403 def test_cwd_with_relative_arg(self):
404 # Check that Popen looks for args[0] relative to cwd if args[0]
405 # is relative.
406 python_dir, python_base = self._split_python_path()
407 rel_python = os.path.join(os.curdir, python_base)
408 with support.temp_cwd() as wrong_dir:
409 # Before calling with the correct cwd, confirm that the call fails
410 # without cwd and with the wrong cwd.
Chris Jerdonek28714c82012-09-30 02:15:37 -0700411 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700412 [rel_python])
Chris Jerdonek28714c82012-09-30 02:15:37 -0700413 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700414 [rel_python], cwd=wrong_dir)
415 python_dir = self._normalize_cwd(python_dir)
416 self._assert_cwd(python_dir, rel_python, cwd=python_dir)
417
Victor Stinner937ee9e2018-06-26 02:11:06 +0200418 @unittest.skipIf(mswindows, "pending resolution of issue #15533")
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700419 def test_cwd_with_relative_executable(self):
420 # Check that Popen looks for executable relative to cwd if executable
421 # is relative (and that executable takes precedence over args[0]).
422 python_dir, python_base = self._split_python_path()
423 rel_python = os.path.join(os.curdir, python_base)
424 doesntexist = "somethingyoudonthave"
425 with support.temp_cwd() as wrong_dir:
426 # Before calling with the correct cwd, confirm that the call fails
427 # without cwd and with the wrong cwd.
Chris Jerdonek28714c82012-09-30 02:15:37 -0700428 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700429 [doesntexist], executable=rel_python)
Chris Jerdonek28714c82012-09-30 02:15:37 -0700430 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700431 [doesntexist], executable=rel_python,
432 cwd=wrong_dir)
433 python_dir = self._normalize_cwd(python_dir)
434 self._assert_cwd(python_dir, doesntexist, executable=rel_python,
435 cwd=python_dir)
436
437 def test_cwd_with_absolute_arg(self):
438 # Check that Popen can find the executable when the cwd is wrong
439 # if args[0] is an absolute path.
440 python_dir, python_base = self._split_python_path()
441 abs_python = os.path.join(python_dir, python_base)
442 rel_python = os.path.join(os.curdir, python_base)
Berker Peksagce643912015-05-06 06:33:17 +0300443 with support.temp_dir() as wrong_dir:
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700444 # Before calling with an absolute path, confirm that using a
445 # relative path fails.
Chris Jerdonek28714c82012-09-30 02:15:37 -0700446 self.assertRaises(FileNotFoundError, subprocess.Popen,
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700447 [rel_python], cwd=wrong_dir)
448 wrong_dir = self._normalize_cwd(wrong_dir)
449 self._assert_cwd(wrong_dir, abs_python, cwd=wrong_dir)
450
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100451 @unittest.skipIf(sys.base_prefix != sys.prefix,
452 'Test is not venv-compatible')
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000453 def test_executable_with_cwd(self):
Chris Jerdonekec3ea942012-09-30 00:10:28 -0700454 python_dir, python_base = self._split_python_path()
455 python_dir = self._normalize_cwd(python_dir)
456 self._assert_cwd(python_dir, "somethingyoudonthave",
457 executable=sys.executable, cwd=python_dir)
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000458
Vinay Sajip7ded1f02012-05-26 03:45:29 +0100459 @unittest.skipIf(sys.base_prefix != sys.prefix,
460 'Test is not venv-compatible')
Ezio Melotti184bdfb2010-02-18 09:37:05 +0000461 @unittest.skipIf(sysconfig.is_python_build(),
462 "need an installed Python. See #7774")
463 def test_executable_without_cwd(self):
464 # For a normal installation, it should work without 'cwd'
465 # argument. For test runs in the build directory, see #7774.
Ned Deilye92dfbf2013-08-02 18:02:21 -0700466 self._assert_cwd(os.getcwd(), "somethingyoudonthave",
467 executable=sys.executable)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000468
469 def test_stdin_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000470 # stdin redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000471 p = subprocess.Popen([sys.executable, "-c",
472 'import sys; sys.exit(sys.stdin.read() == "pear")'],
473 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000474 p.stdin.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000475 p.stdin.close()
476 p.wait()
477 self.assertEqual(p.returncode, 1)
478
479 def test_stdin_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000480 # stdin is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000481 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000482 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000483 d = tf.fileno()
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000484 os.write(d, b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000485 os.lseek(d, 0, 0)
486 p = subprocess.Popen([sys.executable, "-c",
487 'import sys; sys.exit(sys.stdin.read() == "pear")'],
488 stdin=d)
489 p.wait()
490 self.assertEqual(p.returncode, 1)
491
492 def test_stdin_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000493 # stdin is set to open file object
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000494 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000495 self.addCleanup(tf.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000496 tf.write(b"pear")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000497 tf.seek(0)
498 p = subprocess.Popen([sys.executable, "-c",
499 'import sys; sys.exit(sys.stdin.read() == "pear")'],
500 stdin=tf)
501 p.wait()
502 self.assertEqual(p.returncode, 1)
503
504 def test_stdout_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000505 # stdout redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000506 p = subprocess.Popen([sys.executable, "-c",
507 'import sys; sys.stdout.write("orange")'],
508 stdout=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +0200509 with p:
510 self.assertEqual(p.stdout.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000511
512 def test_stdout_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000513 # stdout is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000514 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000515 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000516 d = tf.fileno()
517 p = subprocess.Popen([sys.executable, "-c",
518 'import sys; sys.stdout.write("orange")'],
519 stdout=d)
520 p.wait()
521 os.lseek(d, 0, 0)
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000522 self.assertEqual(os.read(d, 1024), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000523
524 def test_stdout_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000525 # stdout is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000526 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000527 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000528 p = subprocess.Popen([sys.executable, "-c",
529 'import sys; sys.stdout.write("orange")'],
530 stdout=tf)
531 p.wait()
532 tf.seek(0)
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000533 self.assertEqual(tf.read(), b"orange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000534
535 def test_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000536 # stderr redirection
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000537 p = subprocess.Popen([sys.executable, "-c",
538 'import sys; sys.stderr.write("strawberry")'],
539 stderr=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +0200540 with p:
Victor Stinner6cac1132019-12-08 08:38:16 +0100541 self.assertEqual(p.stderr.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000542
543 def test_stderr_filedes(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000544 # stderr is set to open file descriptor
Tim Peterse718f612004-10-12 21:51:32 +0000545 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000546 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000547 d = tf.fileno()
548 p = subprocess.Popen([sys.executable, "-c",
549 'import sys; sys.stderr.write("strawberry")'],
550 stderr=d)
551 p.wait()
552 os.lseek(d, 0, 0)
Victor Stinner6cac1132019-12-08 08:38:16 +0100553 self.assertEqual(os.read(d, 1024), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000554
555 def test_stderr_fileobj(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000556 # stderr is set to open file object
Tim Peterse718f612004-10-12 21:51:32 +0000557 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000558 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000559 p = subprocess.Popen([sys.executable, "-c",
560 'import sys; sys.stderr.write("strawberry")'],
561 stderr=tf)
562 p.wait()
563 tf.seek(0)
Victor Stinner6cac1132019-12-08 08:38:16 +0100564 self.assertEqual(tf.read(), b"strawberry")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000565
Martin Panterc7635892016-05-13 01:54:44 +0000566 def test_stderr_redirect_with_no_stdout_redirect(self):
567 # test stderr=STDOUT while stdout=None (not set)
568
569 # - grandchild prints to stderr
570 # - child redirects grandchild's stderr to its stdout
571 # - the parent should get grandchild's stderr in child's stdout
572 p = subprocess.Popen([sys.executable, "-c",
573 'import sys, subprocess;'
574 'rc = subprocess.call([sys.executable, "-c",'
575 ' "import sys;"'
576 ' "sys.stderr.write(\'42\')"],'
577 ' stderr=subprocess.STDOUT);'
578 'sys.exit(rc)'],
579 stdout=subprocess.PIPE,
580 stderr=subprocess.PIPE)
581 stdout, stderr = p.communicate()
582 #NOTE: stdout should get stderr from grandchild
Victor Stinner6cac1132019-12-08 08:38:16 +0100583 self.assertEqual(stdout, b'42')
584 self.assertEqual(stderr, b'') # should be empty
Martin Panterc7635892016-05-13 01:54:44 +0000585 self.assertEqual(p.returncode, 0)
586
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000587 def test_stdout_stderr_pipe(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000588 # capture stdout and stderr to the same pipe
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000589 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000590 'import sys;'
591 'sys.stdout.write("apple");'
592 'sys.stdout.flush();'
593 'sys.stderr.write("orange")'],
594 stdout=subprocess.PIPE,
595 stderr=subprocess.STDOUT)
Victor Stinner7438c612016-05-20 12:43:15 +0200596 with p:
Victor Stinner6cac1132019-12-08 08:38:16 +0100597 self.assertEqual(p.stdout.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000598
599 def test_stdout_stderr_file(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000600 # capture stdout and stderr to the same open file
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000601 tf = tempfile.TemporaryFile()
Benjamin Petersoncc221b22010-10-31 02:06:21 +0000602 self.addCleanup(tf.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000603 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000604 'import sys;'
605 'sys.stdout.write("apple");'
606 'sys.stdout.flush();'
607 'sys.stderr.write("orange")'],
608 stdout=tf,
609 stderr=tf)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000610 p.wait()
611 tf.seek(0)
Victor Stinner6cac1132019-12-08 08:38:16 +0100612 self.assertEqual(tf.read(), b"appleorange")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000613
Thomas Wouters89f507f2006-12-13 04:49:30 +0000614 def test_stdout_filedes_of_stdout(self):
615 # stdout is set to 1 (#1531862).
Ezio Melotti42a541b2013-03-11 05:53:34 +0200616 # To avoid printing the text on stdout, we do something similar to
617 # test_stdout_none (see above). The parent subprocess calls the child
618 # subprocess passing stdout=1, and this test uses stdout=PIPE in
619 # order to capture and check the output of the parent. See #11963.
620 code = ('import sys, subprocess; '
621 'rc = subprocess.call([sys.executable, "-c", '
622 ' "import os, sys; sys.exit(os.write(sys.stdout.fileno(), '
623 'b\'test with stdout=1\'))"], stdout=1); '
624 'assert rc == 18')
625 p = subprocess.Popen([sys.executable, "-c", code],
626 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
627 self.addCleanup(p.stdout.close)
628 self.addCleanup(p.stderr.close)
629 out, err = p.communicate()
630 self.assertEqual(p.returncode, 0, err)
631 self.assertEqual(out.rstrip(), b'test with stdout=1')
Thomas Wouters89f507f2006-12-13 04:49:30 +0000632
Ross Lagerwallba102ec2011-03-16 18:40:25 +0200633 def test_stdout_devnull(self):
634 p = subprocess.Popen([sys.executable, "-c",
635 'for i in range(10240):'
636 'print("x" * 1024)'],
637 stdout=subprocess.DEVNULL)
638 p.wait()
639 self.assertEqual(p.stdout, None)
640
641 def test_stderr_devnull(self):
642 p = subprocess.Popen([sys.executable, "-c",
643 'import sys\n'
644 'for i in range(10240):'
645 'sys.stderr.write("x" * 1024)'],
646 stderr=subprocess.DEVNULL)
647 p.wait()
648 self.assertEqual(p.stderr, None)
649
650 def test_stdin_devnull(self):
651 p = subprocess.Popen([sys.executable, "-c",
652 'import sys;'
653 'sys.stdin.read(1)'],
654 stdin=subprocess.DEVNULL)
655 p.wait()
656 self.assertEqual(p.stdin, None)
657
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000658 def test_env(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000659 newenv = os.environ.copy()
660 newenv["FRUIT"] = "orange"
Victor Stinnerf1512a22011-06-21 17:18:38 +0200661 with subprocess.Popen([sys.executable, "-c",
662 'import sys,os;'
663 'sys.stdout.write(os.getenv("FRUIT"))'],
664 stdout=subprocess.PIPE,
665 env=newenv) as p:
666 stdout, stderr = p.communicate()
667 self.assertEqual(stdout, b"orange")
668
Victor Stinner62d51182011-06-23 01:02:25 +0200669 # Windows requires at least the SYSTEMROOT environment variable to start
670 # Python
671 @unittest.skipIf(sys.platform == 'win32',
672 'cannot test an empty env on Windows')
Gregory P. Smithb3512482017-05-30 14:40:37 -0700673 @unittest.skipIf(sysconfig.get_config_var('Py_ENABLE_SHARED') == 1,
674 'The Python shared library cannot be loaded '
675 'with an empty environment.')
Victor Stinnerf1512a22011-06-21 17:18:38 +0200676 def test_empty_env(self):
Gregory P. Smithb3512482017-05-30 14:40:37 -0700677 """Verify that env={} is as empty as possible."""
678
Gregory P. Smith85aba232017-05-30 16:21:47 -0700679 def is_env_var_to_ignore(n):
Gregory P. Smithb3512482017-05-30 14:40:37 -0700680 """Determine if an environment variable is under our control."""
681 # This excludes some __CF_* and VERSIONER_* keys MacOS insists
682 # on adding even when the environment in exec is empty.
683 # Gentoo sandboxes also force LD_PRELOAD and SANDBOX_* to exist.
Gregory P. Smith85aba232017-05-30 16:21:47 -0700684 return ('VERSIONER' in n or '__CF' in n or # MacOS
Ned Deily918edc02017-09-04 00:00:21 -0400685 '__PYVENV_LAUNCHER__' in n or # MacOS framework build
Nick Coghlan6ea41862017-06-11 13:16:15 +1000686 n == 'LD_PRELOAD' or n.startswith('SANDBOX') or # Gentoo
687 n == 'LC_CTYPE') # Locale coercion triggered
Gregory P. Smithb3512482017-05-30 14:40:37 -0700688
Victor Stinnerf1512a22011-06-21 17:18:38 +0200689 with subprocess.Popen([sys.executable, "-c",
Gregory P. Smithb3512482017-05-30 14:40:37 -0700690 'import os; print(list(os.environ.keys()))'],
691 stdout=subprocess.PIPE, env={}) as p:
Victor Stinnerf1512a22011-06-21 17:18:38 +0200692 stdout, stderr = p.communicate()
Gregory P. Smithb3512482017-05-30 14:40:37 -0700693 child_env_names = eval(stdout.strip())
694 self.assertIsInstance(child_env_names, list)
695 child_env_names = [k for k in child_env_names
696 if not is_env_var_to_ignore(k)]
697 self.assertEqual(child_env_names, [])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000698
Serhiy Storchakad174d242017-06-23 19:39:27 +0300699 def test_invalid_cmd(self):
700 # null character in the command name
701 cmd = sys.executable + '\0'
702 with self.assertRaises(ValueError):
703 subprocess.Popen([cmd, "-c", "pass"])
704
705 # null character in the command argument
706 with self.assertRaises(ValueError):
707 subprocess.Popen([sys.executable, "-c", "pass#\0"])
708
709 def test_invalid_env(self):
Ville Skyttä49b27342017-08-03 09:00:59 +0300710 # null character in the environment variable name
Serhiy Storchakad174d242017-06-23 19:39:27 +0300711 newenv = os.environ.copy()
712 newenv["FRUIT\0VEGETABLE"] = "cabbage"
713 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700714 subprocess.Popen(ZERO_RETURN_CMD, env=newenv)
Serhiy Storchakad174d242017-06-23 19:39:27 +0300715
Ville Skyttä49b27342017-08-03 09:00:59 +0300716 # null character in the environment variable value
Serhiy Storchakad174d242017-06-23 19:39:27 +0300717 newenv = os.environ.copy()
718 newenv["FRUIT"] = "orange\0VEGETABLE=cabbage"
719 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700720 subprocess.Popen(ZERO_RETURN_CMD, env=newenv)
Serhiy Storchakad174d242017-06-23 19:39:27 +0300721
Ville Skyttä49b27342017-08-03 09:00:59 +0300722 # equal character in the environment variable name
Serhiy Storchakad174d242017-06-23 19:39:27 +0300723 newenv = os.environ.copy()
724 newenv["FRUIT=ORANGE"] = "lemon"
725 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700726 subprocess.Popen(ZERO_RETURN_CMD, env=newenv)
Serhiy Storchakad174d242017-06-23 19:39:27 +0300727
Ville Skyttä49b27342017-08-03 09:00:59 +0300728 # equal character in the environment variable value
Serhiy Storchakad174d242017-06-23 19:39:27 +0300729 newenv = os.environ.copy()
730 newenv["FRUIT"] = "orange=lemon"
731 with subprocess.Popen([sys.executable, "-c",
732 'import sys, os;'
733 'sys.stdout.write(os.getenv("FRUIT"))'],
734 stdout=subprocess.PIPE,
735 env=newenv) as p:
736 stdout, stderr = p.communicate()
737 self.assertEqual(stdout, b"orange=lemon")
738
Peter Astrandcbac93c2005-03-03 20:24:28 +0000739 def test_communicate_stdin(self):
740 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000741 'import sys;'
742 'sys.exit(sys.stdin.read() == "pear")'],
Peter Astrandcbac93c2005-03-03 20:24:28 +0000743 stdin=subprocess.PIPE)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000744 p.communicate(b"pear")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000745 self.assertEqual(p.returncode, 1)
746
747 def test_communicate_stdout(self):
748 p = subprocess.Popen([sys.executable, "-c",
749 'import sys; sys.stdout.write("pineapple")'],
750 stdout=subprocess.PIPE)
751 (stdout, stderr) = p.communicate()
Guido van Rossumfa0054a2007-05-24 04:05:35 +0000752 self.assertEqual(stdout, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000753 self.assertEqual(stderr, None)
754
755 def test_communicate_stderr(self):
756 p = subprocess.Popen([sys.executable, "-c",
757 'import sys; sys.stderr.write("pineapple")'],
758 stderr=subprocess.PIPE)
759 (stdout, stderr) = p.communicate()
760 self.assertEqual(stdout, None)
Victor Stinner6cac1132019-12-08 08:38:16 +0100761 self.assertEqual(stderr, b"pineapple")
Peter Astrandcbac93c2005-03-03 20:24:28 +0000762
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000763 def test_communicate(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000764 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000765 'import sys,os;'
766 'sys.stderr.write("pineapple");'
767 'sys.stdout.write(sys.stdin.read())'],
768 stdin=subprocess.PIPE,
769 stdout=subprocess.PIPE,
770 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000771 self.addCleanup(p.stdout.close)
772 self.addCleanup(p.stderr.close)
773 self.addCleanup(p.stdin.close)
Georg Brandl1abcbf82008-07-01 19:28:43 +0000774 (stdout, stderr) = p.communicate(b"banana")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000775 self.assertEqual(stdout, b"banana")
Victor Stinner6cac1132019-12-08 08:38:16 +0100776 self.assertEqual(stderr, b"pineapple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000777
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400778 def test_communicate_timeout(self):
779 p = subprocess.Popen([sys.executable, "-c",
780 'import sys,os,time;'
781 'sys.stderr.write("pineapple\\n");'
782 'time.sleep(1);'
783 'sys.stderr.write("pear\\n");'
784 'sys.stdout.write(sys.stdin.read())'],
785 universal_newlines=True,
786 stdin=subprocess.PIPE,
787 stdout=subprocess.PIPE,
788 stderr=subprocess.PIPE)
789 self.assertRaises(subprocess.TimeoutExpired, p.communicate, "banana",
790 timeout=0.3)
791 # Make sure we can keep waiting for it, and that we get the whole output
792 # after it completes.
793 (stdout, stderr) = p.communicate()
794 self.assertEqual(stdout, "banana")
Victor Stinner6cac1132019-12-08 08:38:16 +0100795 self.assertEqual(stderr.encode(), b"pineapple\npear\n")
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400796
Raymond Hettinger15f44ab2016-08-30 10:47:49 -0700797 def test_communicate_timeout_large_output(self):
Ross Lagerwall003c7a32012-02-12 09:02:01 +0200798 # Test an expiring timeout while the child is outputting lots of data.
Reid Kleckner31aa7dd2011-03-14 12:02:10 -0400799 p = subprocess.Popen([sys.executable, "-c",
800 'import sys,os,time;'
801 'sys.stdout.write("a" * (64 * 1024));'
802 'time.sleep(0.2);'
803 'sys.stdout.write("a" * (64 * 1024));'
804 'time.sleep(0.2);'
805 'sys.stdout.write("a" * (64 * 1024));'
806 'time.sleep(0.2);'
807 'sys.stdout.write("a" * (64 * 1024));'],
808 stdout=subprocess.PIPE)
809 self.assertRaises(subprocess.TimeoutExpired, p.communicate, timeout=0.4)
810 (stdout, _) = p.communicate()
811 self.assertEqual(len(stdout), 4 * 64 * 1024)
812
Florent Xiclunab1e94e82010-02-27 22:12:37 +0000813 # Test for the fd leak reported in http://bugs.python.org/issue2791.
814 def test_communicate_pipe_fd_leak(self):
Victor Stinner667d4b52010-12-25 22:40:32 +0000815 for stdin_pipe in (False, True):
816 for stdout_pipe in (False, True):
817 for stderr_pipe in (False, True):
818 options = {}
819 if stdin_pipe:
820 options['stdin'] = subprocess.PIPE
821 if stdout_pipe:
822 options['stdout'] = subprocess.PIPE
823 if stderr_pipe:
824 options['stderr'] = subprocess.PIPE
825 if not options:
826 continue
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700827 p = subprocess.Popen(ZERO_RETURN_CMD, **options)
Victor Stinner667d4b52010-12-25 22:40:32 +0000828 p.communicate()
829 if p.stdin is not None:
830 self.assertTrue(p.stdin.closed)
831 if p.stdout is not None:
832 self.assertTrue(p.stdout.closed)
833 if p.stderr is not None:
834 self.assertTrue(p.stderr.closed)
Georg Brandlf08a9dd2008-06-10 16:57:31 +0000835
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000836 def test_communicate_returns(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000837 # communicate() should return None if no redirection is active
Tim Peters3b01a702004-10-12 22:19:32 +0000838 p = subprocess.Popen([sys.executable, "-c",
839 "import sys; sys.exit(47)"])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000840 (stdout, stderr) = p.communicate()
841 self.assertEqual(stdout, None)
842 self.assertEqual(stderr, None)
843
844 def test_communicate_pipe_buf(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000845 # communicate() with writes larger than pipe_buf
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000846 # This test will probably deadlock rather than fail, if
Tim Peterse718f612004-10-12 21:51:32 +0000847 # communicate() does not work properly.
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000848 x, y = os.pipe()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000849 os.close(x)
850 os.close(y)
851 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000852 'import sys,os;'
853 'sys.stdout.write(sys.stdin.read(47));'
Charles-François Natali2d517212011-05-29 16:36:44 +0200854 'sys.stderr.write("x" * %d);'
855 'sys.stdout.write(sys.stdin.read())' %
856 support.PIPE_MAX_SIZE],
Guido van Rossum98297ee2007-11-06 21:34:58 +0000857 stdin=subprocess.PIPE,
858 stdout=subprocess.PIPE,
859 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000860 self.addCleanup(p.stdout.close)
861 self.addCleanup(p.stderr.close)
862 self.addCleanup(p.stdin.close)
Charles-François Natali2d517212011-05-29 16:36:44 +0200863 string_to_write = b"a" * support.PIPE_MAX_SIZE
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000864 (stdout, stderr) = p.communicate(string_to_write)
865 self.assertEqual(stdout, string_to_write)
866
867 def test_writes_before_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000868 # stdin.write before communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000869 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000870 'import sys,os;'
871 'sys.stdout.write(sys.stdin.read())'],
872 stdin=subprocess.PIPE,
873 stdout=subprocess.PIPE,
874 stderr=subprocess.PIPE)
Brian Curtin19a53792010-11-05 17:09:05 +0000875 self.addCleanup(p.stdout.close)
876 self.addCleanup(p.stderr.close)
877 self.addCleanup(p.stdin.close)
Guido van Rossumbb839ef2007-08-27 23:58:21 +0000878 p.stdin.write(b"banana")
879 (stdout, stderr) = p.communicate(b"split")
Guido van Rossumc9e363c2007-05-15 23:18:55 +0000880 self.assertEqual(stdout, b"bananasplit")
Victor Stinner6cac1132019-12-08 08:38:16 +0100881 self.assertEqual(stderr, b"")
Tim Peterse718f612004-10-12 21:51:32 +0000882
andyclegg7fed7bd2017-10-23 03:01:19 +0100883 def test_universal_newlines_and_text(self):
884 args = [
885 sys.executable, "-c",
886 'import sys,os;' + SETBINARY +
887 'buf = sys.stdout.buffer;'
888 'buf.write(sys.stdin.readline().encode());'
889 'buf.flush();'
890 'buf.write(b"line2\\n");'
891 'buf.flush();'
892 'buf.write(sys.stdin.read().encode());'
893 'buf.flush();'
894 'buf.write(b"line4\\n");'
895 'buf.flush();'
896 'buf.write(b"line5\\r\\n");'
897 'buf.flush();'
898 'buf.write(b"line6\\r");'
899 'buf.flush();'
900 'buf.write(b"\\nline7");'
901 'buf.flush();'
902 'buf.write(b"\\nline8");']
903
904 for extra_kwarg in ('universal_newlines', 'text'):
905 p = subprocess.Popen(args, **{'stdin': subprocess.PIPE,
906 'stdout': subprocess.PIPE,
907 extra_kwarg: True})
908 with p:
909 p.stdin.write("line1\n")
910 p.stdin.flush()
911 self.assertEqual(p.stdout.readline(), "line1\n")
912 p.stdin.write("line3\n")
913 p.stdin.close()
914 self.addCleanup(p.stdout.close)
915 self.assertEqual(p.stdout.readline(),
916 "line2\n")
917 self.assertEqual(p.stdout.read(6),
918 "line3\n")
919 self.assertEqual(p.stdout.read(),
920 "line4\nline5\nline6\nline7\nline8")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000921
922 def test_universal_newlines_communicate(self):
Tim Peters7b759da2004-10-12 22:29:54 +0000923 # universal newlines through communicate()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000924 p = subprocess.Popen([sys.executable, "-c",
Guido van Rossum98297ee2007-11-06 21:34:58 +0000925 'import sys,os;' + SETBINARY +
Antoine Pitrouec2d2692012-08-05 00:23:40 +0200926 'buf = sys.stdout.buffer;'
927 'buf.write(b"line2\\n");'
928 'buf.flush();'
929 'buf.write(b"line4\\n");'
930 'buf.flush();'
931 'buf.write(b"line5\\r\\n");'
932 'buf.flush();'
933 'buf.write(b"line6\\r");'
934 'buf.flush();'
935 'buf.write(b"\\nline7");'
936 'buf.flush();'
937 'buf.write(b"\\nline8");'],
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200938 stderr=subprocess.PIPE,
939 stdout=subprocess.PIPE,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000940 universal_newlines=1)
Brian Curtin19a53792010-11-05 17:09:05 +0000941 self.addCleanup(p.stdout.close)
942 self.addCleanup(p.stderr.close)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000943 (stdout, stderr) = p.communicate()
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200944 self.assertEqual(stdout,
945 "line2\nline4\nline5\nline6\nline7\nline8")
946
947 def test_universal_newlines_communicate_stdin(self):
948 # universal newlines through communicate(), with only stdin
949 p = subprocess.Popen([sys.executable, "-c",
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300950 'import sys,os;' + SETBINARY + textwrap.dedent('''
951 s = sys.stdin.readline()
952 assert s == "line1\\n", repr(s)
953 s = sys.stdin.read()
954 assert s == "line3\\n", repr(s)
955 ''')],
Antoine Pitrouab85ff32011-07-23 22:03:45 +0200956 stdin=subprocess.PIPE,
957 universal_newlines=1)
958 (stdout, stderr) = p.communicate("line1\nline3\n")
959 self.assertEqual(p.returncode, 0)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +0000960
Andrew Svetlovf3765072012-08-14 18:35:17 +0300961 def test_universal_newlines_communicate_input_none(self):
962 # Test communicate(input=None) with universal newlines.
963 #
964 # We set stdout to PIPE because, as of this writing, a different
965 # code path is tested when the number of pipes is zero or one.
Gregory P. Smith67b93f82019-10-12 16:35:53 -0700966 p = subprocess.Popen(ZERO_RETURN_CMD,
Andrew Svetlovf3765072012-08-14 18:35:17 +0300967 stdin=subprocess.PIPE,
968 stdout=subprocess.PIPE,
969 universal_newlines=True)
970 p.communicate()
971 self.assertEqual(p.returncode, 0)
972
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300973 def test_universal_newlines_communicate_stdin_stdout_stderr(self):
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300974 # universal newlines through communicate(), with stdin, stdout, stderr
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300975 p = subprocess.Popen([sys.executable, "-c",
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300976 'import sys,os;' + SETBINARY + textwrap.dedent('''
977 s = sys.stdin.buffer.readline()
978 sys.stdout.buffer.write(s)
979 sys.stdout.buffer.write(b"line2\\r")
980 sys.stderr.buffer.write(b"eline2\\n")
981 s = sys.stdin.buffer.read()
982 sys.stdout.buffer.write(s)
983 sys.stdout.buffer.write(b"line4\\n")
984 sys.stdout.buffer.write(b"line5\\r\\n")
985 sys.stderr.buffer.write(b"eline6\\r")
986 sys.stderr.buffer.write(b"eline7\\r\\nz")
987 ''')],
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300988 stdin=subprocess.PIPE,
989 stderr=subprocess.PIPE,
990 stdout=subprocess.PIPE,
Andrew Svetlov47ec25d2012-08-19 16:25:37 +0300991 universal_newlines=True)
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300992 self.addCleanup(p.stdout.close)
993 self.addCleanup(p.stderr.close)
994 (stdout, stderr) = p.communicate("line1\nline3\n")
995 self.assertEqual(p.returncode, 0)
Andrew Svetlov943c5b32012-08-16 20:17:47 +0300996 self.assertEqual("line1\nline2\nline3\nline4\nline5\n", stdout)
Andrew Svetlov5395d2f2012-08-15 22:46:43 +0300997 # Python debug build push something like "[42442 refs]\n"
998 # to stderr at exit of subprocess.
Andrew Svetlov943c5b32012-08-16 20:17:47 +0300999 self.assertTrue(stderr.startswith("eline2\neline6\neline7\n"))
Andrew Svetlov5395d2f2012-08-15 22:46:43 +03001000
Andrew Svetlov82860712012-08-19 22:13:41 +03001001 def test_universal_newlines_communicate_encodings(self):
1002 # Check that universal newlines mode works for various encodings,
1003 # in particular for encodings in the UTF-16 and UTF-32 families.
1004 # See issue #15595.
1005 #
1006 # UTF-16 and UTF-32-BE are sufficient to check both with BOM and
1007 # without, and UTF-16 and UTF-32.
1008 for encoding in ['utf-16', 'utf-32-be']:
Andrew Svetlov82860712012-08-19 22:13:41 +03001009 code = ("import sys; "
1010 r"sys.stdout.buffer.write('1\r\n2\r3\n4'.encode('%s'))" %
1011 encoding)
1012 args = [sys.executable, '-c', code]
Steve Dower050acae2016-09-06 20:16:17 -07001013 # We set stdin to be non-None because, as of this writing,
1014 # a different code path is used when the number of pipes is
1015 # zero or one.
1016 popen = subprocess.Popen(args,
1017 stdin=subprocess.PIPE,
1018 stdout=subprocess.PIPE,
1019 encoding=encoding)
1020 stdout, stderr = popen.communicate(input='')
Andrew Svetlov82860712012-08-19 22:13:41 +03001021 self.assertEqual(stdout, '1\n2\n3\n4')
1022
Steve Dower050acae2016-09-06 20:16:17 -07001023 def test_communicate_errors(self):
1024 for errors, expected in [
1025 ('ignore', ''),
1026 ('replace', '\ufffd\ufffd'),
1027 ('surrogateescape', '\udc80\udc80'),
1028 ('backslashreplace', '\\x80\\x80'),
1029 ]:
1030 code = ("import sys; "
1031 r"sys.stdout.buffer.write(b'[\x80\x80]')")
1032 args = [sys.executable, '-c', code]
1033 # We set stdin to be non-None because, as of this writing,
1034 # a different code path is used when the number of pipes is
1035 # zero or one.
1036 popen = subprocess.Popen(args,
1037 stdin=subprocess.PIPE,
1038 stdout=subprocess.PIPE,
1039 encoding='utf-8',
1040 errors=errors)
1041 stdout, stderr = popen.communicate(input='')
1042 self.assertEqual(stdout, '[{}]'.format(expected))
1043
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001044 def test_no_leaking(self):
Tim Peters7b759da2004-10-12 22:29:54 +00001045 # Make sure we leak no resources
Victor Stinner937ee9e2018-06-26 02:11:06 +02001046 if not mswindows:
Peter Astrandf7f1bb72005-03-03 20:47:37 +00001047 max_handles = 1026 # too much for most UNIX systems
1048 else:
Antoine Pitrou8db30272010-09-18 22:38:48 +00001049 max_handles = 2050 # too much for (at least some) Windows setups
1050 handles = []
Gregory P. Smith81ce6852011-03-15 02:04:11 -04001051 tmpdir = tempfile.mkdtemp()
Antoine Pitrou8db30272010-09-18 22:38:48 +00001052 try:
1053 for i in range(max_handles):
1054 try:
Gregory P. Smith81ce6852011-03-15 02:04:11 -04001055 tmpfile = os.path.join(tmpdir, support.TESTFN)
1056 handles.append(os.open(tmpfile, os.O_WRONLY|os.O_CREAT))
Antoine Pitrou8db30272010-09-18 22:38:48 +00001057 except OSError as e:
1058 if e.errno != errno.EMFILE:
1059 raise
1060 break
1061 else:
1062 self.skipTest("failed to reach the file descriptor limit "
1063 "(tried %d)" % max_handles)
1064 # Close a couple of them (should be enough for a subprocess)
1065 for i in range(10):
1066 os.close(handles.pop())
1067 # Loop creating some subprocesses. If one of them leaks some fds,
1068 # the next loop iteration will fail by reaching the max fd limit.
1069 for i in range(15):
1070 p = subprocess.Popen([sys.executable, "-c",
1071 "import sys;"
1072 "sys.stdout.write(sys.stdin.read())"],
1073 stdin=subprocess.PIPE,
1074 stdout=subprocess.PIPE,
1075 stderr=subprocess.PIPE)
1076 data = p.communicate(b"lime")[0]
1077 self.assertEqual(data, b"lime")
1078 finally:
1079 for h in handles:
1080 os.close(h)
Gregory P. Smith81ce6852011-03-15 02:04:11 -04001081 shutil.rmtree(tmpdir)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001082
1083 def test_list2cmdline(self):
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001084 self.assertEqual(subprocess.list2cmdline(['a b c', 'd', 'e']),
1085 '"a b c" d e')
1086 self.assertEqual(subprocess.list2cmdline(['ab"c', '\\', 'd']),
1087 'ab\\"c \\ d')
Christian Heimesfdab48e2008-01-20 09:06:41 +00001088 self.assertEqual(subprocess.list2cmdline(['ab"c', ' \\', 'd']),
1089 'ab\\"c " \\\\" d')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001090 self.assertEqual(subprocess.list2cmdline(['a\\\\\\b', 'de fg', 'h']),
1091 'a\\\\\\b "de fg" h')
1092 self.assertEqual(subprocess.list2cmdline(['a\\"b', 'c', 'd']),
1093 'a\\\\\\"b c d')
1094 self.assertEqual(subprocess.list2cmdline(['a\\\\b c', 'd', 'e']),
1095 '"a\\\\b c" d e')
1096 self.assertEqual(subprocess.list2cmdline(['a\\\\b\\ c', 'd', 'e']),
1097 '"a\\\\b\\ c" d e')
Thomas Woutersfc7bb8c2007-01-15 15:49:28 +00001098 self.assertEqual(subprocess.list2cmdline(['ab', '']),
1099 'ab ""')
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001100
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001101 def test_poll(self):
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001102 p = subprocess.Popen([sys.executable, "-c",
Ross Lagerwalle7ad4192012-02-22 06:02:07 +02001103 "import os; os.read(0, 1)"],
1104 stdin=subprocess.PIPE)
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001105 self.addCleanup(p.stdin.close)
1106 self.assertIsNone(p.poll())
1107 os.write(p.stdin.fileno(), b'A')
1108 p.wait()
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001109 # Subsequent invocations should just return the returncode
1110 self.assertEqual(p.poll(), 0)
1111
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001112 def test_wait(self):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001113 p = subprocess.Popen(ZERO_RETURN_CMD)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001114 self.assertEqual(p.wait(), 0)
1115 # Subsequent invocations should just return the returncode
1116 self.assertEqual(p.wait(), 0)
Tim Peterse718f612004-10-12 21:51:32 +00001117
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001118 def test_wait_timeout(self):
1119 p = subprocess.Popen([sys.executable,
Antoine Pitroudc49b2b2013-05-19 15:55:40 +02001120 "-c", "import time; time.sleep(0.3)"])
Reid Kleckner2b228f02011-03-16 16:57:54 -04001121 with self.assertRaises(subprocess.TimeoutExpired) as c:
Antoine Pitroudc49b2b2013-05-19 15:55:40 +02001122 p.wait(timeout=0.0001)
1123 self.assertIn("0.0001", str(c.exception)) # For coverage of __str__.
Victor Stinner0d63bac2019-12-11 11:30:03 +01001124 self.assertEqual(p.wait(timeout=support.SHORT_TIMEOUT), 0)
Reid Kleckner31aa7dd2011-03-14 12:02:10 -04001125
Peter Astrand738131d2004-11-30 21:04:45 +00001126 def test_invalid_bufsize(self):
1127 # an invalid type of the bufsize argument should raise
1128 # TypeError.
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001129 with self.assertRaises(TypeError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001130 subprocess.Popen(ZERO_RETURN_CMD, "orange")
Peter Astrand738131d2004-11-30 21:04:45 +00001131
Guido van Rossum46a05a72007-06-07 21:56:45 +00001132 def test_bufsize_is_none(self):
1133 # bufsize=None should be the same as bufsize=0.
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001134 p = subprocess.Popen(ZERO_RETURN_CMD, None)
Guido van Rossum46a05a72007-06-07 21:56:45 +00001135 self.assertEqual(p.wait(), 0)
1136 # Again with keyword arg
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001137 p = subprocess.Popen(ZERO_RETURN_CMD, bufsize=None)
Guido van Rossum46a05a72007-06-07 21:56:45 +00001138 self.assertEqual(p.wait(), 0)
1139
Antoine Pitrouafe8d062014-09-21 21:10:56 +02001140 def _test_bufsize_equal_one(self, line, expected, universal_newlines):
1141 # subprocess may deadlock with bufsize=1, see issue #21332
1142 with subprocess.Popen([sys.executable, "-c", "import sys;"
1143 "sys.stdout.write(sys.stdin.readline());"
1144 "sys.stdout.flush()"],
1145 stdin=subprocess.PIPE,
1146 stdout=subprocess.PIPE,
1147 stderr=subprocess.DEVNULL,
1148 bufsize=1,
1149 universal_newlines=universal_newlines) as p:
1150 p.stdin.write(line) # expect that it flushes the line in text mode
1151 os.close(p.stdin.fileno()) # close it without flushing the buffer
1152 read_line = p.stdout.readline()
Segev Finer4d385172017-08-18 16:18:13 +03001153 with support.SuppressCrashReport():
1154 try:
1155 p.stdin.close()
1156 except OSError:
1157 pass
Antoine Pitrouafe8d062014-09-21 21:10:56 +02001158 p.stdin = None
1159 self.assertEqual(p.returncode, 0)
1160 self.assertEqual(read_line, expected)
1161
1162 def test_bufsize_equal_one_text_mode(self):
1163 # line is flushed in text mode with bufsize=1.
1164 # we should get the full line in return
1165 line = "line\n"
1166 self._test_bufsize_equal_one(line, line, universal_newlines=True)
1167
1168 def test_bufsize_equal_one_binary_mode(self):
1169 # line is not flushed in binary mode with bufsize=1.
1170 # we should get empty response
1171 line = b'line' + os.linesep.encode() # assume ascii-based locale
Alexey Izbysheva2670562018-10-20 03:22:31 +03001172 with self.assertWarnsRegex(RuntimeWarning, 'line buffering'):
1173 self._test_bufsize_equal_one(line, b'', universal_newlines=False)
Antoine Pitrouafe8d062014-09-21 21:10:56 +02001174
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001175 def test_leaking_fds_on_error(self):
1176 # see bug #5179: Popen leaks file descriptors to PIPEs if
1177 # the child fails to execute; this will eventually exhaust
1178 # the maximum number of open fds. 1024 seems a very common
1179 # value for that limit, but Windows has 2048, so we loop
1180 # 1024 times (each call leaked two fds).
1181 for i in range(1024):
Victor Stinnerb31206a2018-01-25 19:06:05 +01001182 with self.assertRaises(NONEXISTING_ERRORS):
Victor Stinner9a83f652017-08-21 23:51:31 +02001183 subprocess.Popen(NONEXISTING_CMD,
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001184 stdout=subprocess.PIPE,
1185 stderr=subprocess.PIPE)
Benjamin Petersond75fcb42009-02-19 04:22:03 +00001186
Victor Stinner9a83f652017-08-21 23:51:31 +02001187 def test_nonexisting_with_pipes(self):
1188 # bpo-30121: Popen with pipes must close properly pipes on error.
1189 # Previously, os.close() was called with a Windows handle which is not
1190 # a valid file descriptor.
1191 #
1192 # Run the test in a subprocess to control how the CRT reports errors
1193 # and to get stderr content.
1194 try:
1195 import msvcrt
1196 msvcrt.CrtSetReportMode
1197 except (AttributeError, ImportError):
1198 self.skipTest("need msvcrt.CrtSetReportMode")
1199
1200 code = textwrap.dedent(f"""
1201 import msvcrt
1202 import subprocess
1203
1204 cmd = {NONEXISTING_CMD!r}
1205
1206 for report_type in [msvcrt.CRT_WARN,
1207 msvcrt.CRT_ERROR,
1208 msvcrt.CRT_ASSERT]:
1209 msvcrt.CrtSetReportMode(report_type, msvcrt.CRTDBG_MODE_FILE)
1210 msvcrt.CrtSetReportFile(report_type, msvcrt.CRTDBG_FILE_STDERR)
1211
1212 try:
Zachary Ware55376462018-02-19 14:02:38 -06001213 subprocess.Popen(cmd,
Victor Stinner9a83f652017-08-21 23:51:31 +02001214 stdout=subprocess.PIPE,
1215 stderr=subprocess.PIPE)
1216 except OSError:
1217 pass
1218 """)
1219 cmd = [sys.executable, "-c", code]
1220 proc = subprocess.Popen(cmd,
1221 stderr=subprocess.PIPE,
1222 universal_newlines=True)
1223 with proc:
1224 stderr = proc.communicate()[1]
1225 self.assertEqual(stderr, "")
1226 self.assertEqual(proc.returncode, 0)
1227
Antoine Pitroua8392712013-08-30 23:38:13 +02001228 def test_double_close_on_error(self):
1229 # Issue #18851
1230 fds = []
1231 def open_fds():
1232 for i in range(20):
1233 fds.extend(os.pipe())
1234 time.sleep(0.001)
1235 t = threading.Thread(target=open_fds)
1236 t.start()
1237 try:
1238 with self.assertRaises(EnvironmentError):
Victor Stinner9a83f652017-08-21 23:51:31 +02001239 subprocess.Popen(NONEXISTING_CMD,
Antoine Pitroua8392712013-08-30 23:38:13 +02001240 stdin=subprocess.PIPE,
1241 stdout=subprocess.PIPE,
1242 stderr=subprocess.PIPE)
1243 finally:
1244 t.join()
1245 exc = None
1246 for fd in fds:
1247 # If a double close occurred, some of those fds will
1248 # already have been closed by mistake, and os.close()
1249 # here will raise.
1250 try:
1251 os.close(fd)
1252 except OSError as e:
1253 exc = e
1254 if exc is not None:
1255 raise exc
1256
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001257 def test_threadsafe_wait(self):
1258 """Issue21291: Popen.wait() needs to be threadsafe for returncode."""
1259 proc = subprocess.Popen([sys.executable, '-c',
1260 'import time; time.sleep(12)'])
1261 self.assertEqual(proc.returncode, None)
1262 results = []
1263
1264 def kill_proc_timer_thread():
1265 results.append(('thread-start-poll-result', proc.poll()))
1266 # terminate it from the thread and wait for the result.
1267 proc.kill()
1268 proc.wait()
1269 results.append(('thread-after-kill-and-wait', proc.returncode))
1270 # this wait should be a no-op given the above.
1271 proc.wait()
1272 results.append(('thread-after-second-wait', proc.returncode))
1273
1274 # This is a timing sensitive test, the failure mode is
1275 # triggered when both the main thread and this thread are in
1276 # the wait() call at once. The delay here is to allow the
1277 # main thread to most likely be blocked in its wait() call.
1278 t = threading.Timer(0.2, kill_proc_timer_thread)
1279 t.start()
1280
Victor Stinner937ee9e2018-06-26 02:11:06 +02001281 if mswindows:
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001282 expected_errorcode = 1
1283 else:
1284 # Should be -9 because of the proc.kill() from the thread.
1285 expected_errorcode = -9
1286
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001287 # Wait for the process to finish; the thread should kill it
1288 # long before it finishes on its own. Supplying a timeout
1289 # triggers a different code path for better coverage.
Victor Stinner0d63bac2019-12-11 11:30:03 +01001290 proc.wait(timeout=support.SHORT_TIMEOUT)
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001291 self.assertEqual(proc.returncode, expected_errorcode,
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001292 msg="unexpected result in wait from main thread")
1293
1294 # This should be a no-op with no change in returncode.
1295 proc.wait()
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001296 self.assertEqual(proc.returncode, expected_errorcode,
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001297 msg="unexpected result in second main wait.")
1298
1299 t.join()
1300 # Ensure that all of the thread results are as expected.
1301 # When a race condition occurs in wait(), the returncode could
1302 # be set by the wrong thread that doesn't actually have it
1303 # leading to an incorrect value.
1304 self.assertEqual([('thread-start-poll-result', None),
Gregory P. Smithab2719f2014-04-23 08:38:36 -07001305 ('thread-after-kill-and-wait', expected_errorcode),
1306 ('thread-after-second-wait', expected_errorcode)],
Gregory P. Smithd65ba512014-04-23 00:27:17 -07001307 results)
1308
Victor Stinnerb3693582010-05-21 20:13:12 +00001309 def test_issue8780(self):
1310 # Ensure that stdout is inherited from the parent
1311 # if stdout=PIPE is not used
1312 code = ';'.join((
1313 'import subprocess, sys',
1314 'retcode = subprocess.call('
1315 "[sys.executable, '-c', 'print(\"Hello World!\")'])",
1316 'assert retcode == 0'))
1317 output = subprocess.check_output([sys.executable, '-c', code])
Ezio Melottib3aedd42010-11-20 19:04:17 +00001318 self.assertTrue(output.startswith(b'Hello World!'), ascii(output))
Victor Stinnerb3693582010-05-21 20:13:12 +00001319
Tim Goldenaf5ac392010-08-06 13:03:56 +00001320 def test_handles_closed_on_exception(self):
1321 # If CreateProcess exits with an error, ensure the
1322 # duplicate output handles are released
Berker Peksag16a1f282015-09-28 13:33:14 +03001323 ifhandle, ifname = tempfile.mkstemp()
1324 ofhandle, ofname = tempfile.mkstemp()
1325 efhandle, efname = tempfile.mkstemp()
Tim Goldenaf5ac392010-08-06 13:03:56 +00001326 try:
1327 subprocess.Popen (["*"], stdin=ifhandle, stdout=ofhandle,
1328 stderr=efhandle)
1329 except OSError:
1330 os.close(ifhandle)
1331 os.remove(ifname)
1332 os.close(ofhandle)
1333 os.remove(ofname)
1334 os.close(efhandle)
1335 os.remove(efname)
1336 self.assertFalse(os.path.exists(ifname))
1337 self.assertFalse(os.path.exists(ofname))
1338 self.assertFalse(os.path.exists(efname))
1339
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001340 def test_communicate_epipe(self):
1341 # Issue 10963: communicate() should hide EPIPE
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001342 p = subprocess.Popen(ZERO_RETURN_CMD,
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001343 stdin=subprocess.PIPE,
1344 stdout=subprocess.PIPE,
1345 stderr=subprocess.PIPE)
1346 self.addCleanup(p.stdout.close)
1347 self.addCleanup(p.stderr.close)
1348 self.addCleanup(p.stdin.close)
1349 p.communicate(b"x" * 2**20)
1350
Andrey Doroschenko645005e2019-11-17 17:08:31 +03001351 def test_repr(self):
1352 # Run a command that waits for user input, to check the repr() of
1353 # a Proc object while and after the sub-process runs.
1354 code = 'import sys; input(); sys.exit(57)'
1355 cmd = [sys.executable, '-c', code]
1356 result = "<Popen: returncode: {}"
1357
1358 with subprocess.Popen(
1359 cmd, stdin=subprocess.PIPE, universal_newlines=True) as proc:
1360 self.assertIsNone(proc.returncode)
1361 self.assertTrue(
1362 repr(proc).startswith(result.format(proc.returncode)) and
1363 repr(proc).endswith('>')
1364 )
1365
1366 proc.communicate(input='exit...\n')
1367 proc.wait()
1368
1369 self.assertIsNotNone(proc.returncode)
1370 self.assertTrue(
1371 repr(proc).startswith(result.format(proc.returncode)) and
1372 repr(proc).endswith('>')
1373 )
1374
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001375 def test_communicate_epipe_only_stdin(self):
1376 # Issue 10963: communicate() should hide EPIPE
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001377 p = subprocess.Popen(ZERO_RETURN_CMD,
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001378 stdin=subprocess.PIPE)
1379 self.addCleanup(p.stdin.close)
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001380 p.wait()
Ross Lagerwall4f61b022011-04-05 15:34:00 +02001381 p.communicate(b"x" * 2**20)
1382
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001383 @unittest.skipUnless(hasattr(signal, 'SIGUSR1'),
1384 "Requires signal.SIGUSR1")
1385 @unittest.skipUnless(hasattr(os, 'kill'),
1386 "Requires os.kill")
1387 @unittest.skipUnless(hasattr(os, 'getppid'),
1388 "Requires os.getppid")
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001389 def test_communicate_eintr(self):
1390 # Issue #12493: communicate() should handle EINTR
1391 def handler(signum, frame):
1392 pass
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001393 old_handler = signal.signal(signal.SIGUSR1, handler)
1394 self.addCleanup(signal.signal, signal.SIGUSR1, old_handler)
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001395
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001396 args = [sys.executable, "-c",
1397 'import os, signal;'
1398 'os.kill(os.getppid(), signal.SIGUSR1)']
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001399 for stream in ('stdout', 'stderr'):
1400 kw = {stream: subprocess.PIPE}
1401 with subprocess.Popen(args, **kw) as process:
Ross Lagerwallab66d2a2012-02-12 09:01:30 +02001402 # communicate() will be interrupted by SIGUSR1
Victor Stinner2cfb6f32011-07-05 14:00:56 +02001403 process.communicate()
1404
Tim Peterse718f612004-10-12 21:51:32 +00001405
Gregory P. Smith3d8e7762012-11-10 22:32:22 -08001406 # This test is Linux-ish specific for simplicity to at least have
1407 # some coverage. It is not a platform specific bug.
1408 @unittest.skipUnless(os.path.isdir('/proc/%d/fd' % os.getpid()),
1409 "Linux specific")
1410 def test_failed_child_execute_fd_leak(self):
1411 """Test for the fork() failure fd leak reported in issue16327."""
1412 fd_directory = '/proc/%d/fd' % os.getpid()
1413 fds_before_popen = os.listdir(fd_directory)
1414 with self.assertRaises(PopenTestException):
1415 PopenExecuteChildRaises(
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001416 ZERO_RETURN_CMD, stdin=subprocess.PIPE,
Gregory P. Smith3d8e7762012-11-10 22:32:22 -08001417 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1418
1419 # NOTE: This test doesn't verify that the real _execute_child
1420 # does not close the file descriptors itself on the way out
1421 # during an exception. Code inspection has confirmed that.
1422
1423 fds_after_exception = os.listdir(fd_directory)
1424 self.assertEqual(fds_before_popen, fds_after_exception)
1425
Victor Stinner937ee9e2018-06-26 02:11:06 +02001426 @unittest.skipIf(mswindows, "behavior currently not supported on Windows")
Gregory P. Smith8621bb52017-08-24 14:58:25 -07001427 def test_file_not_found_includes_filename(self):
1428 with self.assertRaises(FileNotFoundError) as c:
1429 subprocess.call(['/opt/nonexistent_binary', 'with', 'some', 'args'])
1430 self.assertEqual(c.exception.filename, '/opt/nonexistent_binary')
1431
Victor Stinner937ee9e2018-06-26 02:11:06 +02001432 @unittest.skipIf(mswindows, "behavior currently not supported on Windows")
Gregory P. Smith8621bb52017-08-24 14:58:25 -07001433 def test_file_not_found_with_bad_cwd(self):
1434 with self.assertRaises(FileNotFoundError) as c:
1435 subprocess.Popen(['exit', '0'], cwd='/some/nonexistent/directory')
1436 self.assertEqual(c.exception.filename, '/some/nonexistent/directory')
1437
Batuhan Taşkaya4dc5a9d2019-12-30 19:02:04 +03001438 def test_class_getitems(self):
1439 self.assertIs(subprocess.Popen[bytes], subprocess.Popen)
1440 self.assertIs(subprocess.CompletedProcess[str], subprocess.CompletedProcess)
Gregory P. Smith6e730002015-04-14 16:14:25 -07001441
1442class RunFuncTestCase(BaseTestCase):
1443 def run_python(self, code, **kwargs):
1444 """Run Python code in a subprocess using subprocess.run"""
1445 argv = [sys.executable, "-c", code]
1446 return subprocess.run(argv, **kwargs)
1447
1448 def test_returncode(self):
1449 # call() function with sequence argument
1450 cp = self.run_python("import sys; sys.exit(47)")
1451 self.assertEqual(cp.returncode, 47)
1452 with self.assertRaises(subprocess.CalledProcessError):
1453 cp.check_returncode()
1454
1455 def test_check(self):
1456 with self.assertRaises(subprocess.CalledProcessError) as c:
1457 self.run_python("import sys; sys.exit(47)", check=True)
1458 self.assertEqual(c.exception.returncode, 47)
1459
1460 def test_check_zero(self):
1461 # check_returncode shouldn't raise when returncode is zero
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001462 cp = subprocess.run(ZERO_RETURN_CMD, check=True)
Gregory P. Smith6e730002015-04-14 16:14:25 -07001463 self.assertEqual(cp.returncode, 0)
1464
1465 def test_timeout(self):
1466 # run() function with timeout argument; we want to test that the child
1467 # process gets killed when the timeout expires. If the child isn't
1468 # killed, this call will deadlock since subprocess.run waits for the
1469 # child.
1470 with self.assertRaises(subprocess.TimeoutExpired):
1471 self.run_python("while True: pass", timeout=0.0001)
1472
1473 def test_capture_stdout(self):
1474 # capture stdout with zero return code
1475 cp = self.run_python("print('BDFL')", stdout=subprocess.PIPE)
1476 self.assertIn(b'BDFL', cp.stdout)
1477
1478 def test_capture_stderr(self):
1479 cp = self.run_python("import sys; sys.stderr.write('BDFL')",
1480 stderr=subprocess.PIPE)
1481 self.assertIn(b'BDFL', cp.stderr)
1482
1483 def test_check_output_stdin_arg(self):
1484 # run() can be called with stdin set to a file
1485 tf = tempfile.TemporaryFile()
1486 self.addCleanup(tf.close)
1487 tf.write(b'pear')
1488 tf.seek(0)
1489 cp = self.run_python(
1490 "import sys; sys.stdout.write(sys.stdin.read().upper())",
1491 stdin=tf, stdout=subprocess.PIPE)
1492 self.assertIn(b'PEAR', cp.stdout)
1493
1494 def test_check_output_input_arg(self):
1495 # check_output() can be called with input set to a string
1496 cp = self.run_python(
1497 "import sys; sys.stdout.write(sys.stdin.read().upper())",
1498 input=b'pear', stdout=subprocess.PIPE)
1499 self.assertIn(b'PEAR', cp.stdout)
1500
1501 def test_check_output_stdin_with_input_arg(self):
1502 # run() refuses to accept 'stdin' with 'input'
1503 tf = tempfile.TemporaryFile()
1504 self.addCleanup(tf.close)
1505 tf.write(b'pear')
1506 tf.seek(0)
1507 with self.assertRaises(ValueError,
1508 msg="Expected ValueError when stdin and input args supplied.") as c:
1509 output = self.run_python("print('will not be run')",
1510 stdin=tf, input=b'hare')
1511 self.assertIn('stdin', c.exception.args[0])
1512 self.assertIn('input', c.exception.args[0])
1513
1514 def test_check_output_timeout(self):
1515 with self.assertRaises(subprocess.TimeoutExpired) as c:
1516 cp = self.run_python((
1517 "import sys, time\n"
1518 "sys.stdout.write('BDFL')\n"
1519 "sys.stdout.flush()\n"
1520 "time.sleep(3600)"),
1521 # Some heavily loaded buildbots (sparc Debian 3.x) require
1522 # this much time to start and print.
1523 timeout=3, stdout=subprocess.PIPE)
1524 self.assertEqual(c.exception.output, b'BDFL')
1525 # output is aliased to stdout
1526 self.assertEqual(c.exception.stdout, b'BDFL')
1527
1528 def test_run_kwargs(self):
1529 newenv = os.environ.copy()
1530 newenv["FRUIT"] = "banana"
1531 cp = self.run_python(('import sys, os;'
1532 'sys.exit(33 if os.getenv("FRUIT")=="banana" else 31)'),
1533 env=newenv)
1534 self.assertEqual(cp.returncode, 33)
1535
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +03001536 def test_run_with_pathlike_path(self):
1537 # bpo-31961: test run(pathlike_object)
1538 # the name of a command that can be run without
Min ho Kimc4cacc82019-07-31 08:16:13 +10001539 # any arguments that exit fast
Serhiy Storchaka9e3c4522019-05-28 22:49:35 +03001540 prog = 'tree.com' if mswindows else 'ls'
1541 path = shutil.which(prog)
1542 if path is None:
1543 self.skipTest(f'{prog} required for this test')
1544 path = FakePath(path)
1545 res = subprocess.run(path, stdout=subprocess.DEVNULL)
1546 self.assertEqual(res.returncode, 0)
1547 with self.assertRaises(TypeError):
1548 subprocess.run(path, stdout=subprocess.DEVNULL, shell=True)
1549
1550 def test_run_with_bytes_path_and_arguments(self):
1551 # bpo-31961: test run([bytes_object, b'additional arguments'])
1552 path = os.fsencode(sys.executable)
1553 args = [path, '-c', b'import sys; sys.exit(57)']
1554 res = subprocess.run(args)
1555 self.assertEqual(res.returncode, 57)
1556
1557 def test_run_with_pathlike_path_and_arguments(self):
1558 # bpo-31961: test run([pathlike_object, 'additional arguments'])
1559 path = FakePath(sys.executable)
1560 args = [path, '-c', 'import sys; sys.exit(57)']
1561 res = subprocess.run(args)
1562 self.assertEqual(res.returncode, 57)
1563
Bo Baylesce0f33d2018-01-30 00:40:39 -06001564 def test_capture_output(self):
1565 cp = self.run_python(("import sys;"
1566 "sys.stdout.write('BDFL'); "
1567 "sys.stderr.write('FLUFL')"),
1568 capture_output=True)
1569 self.assertIn(b'BDFL', cp.stdout)
1570 self.assertIn(b'FLUFL', cp.stderr)
1571
1572 def test_stdout_with_capture_output_arg(self):
1573 # run() refuses to accept 'stdout' with 'capture_output'
1574 tf = tempfile.TemporaryFile()
1575 self.addCleanup(tf.close)
1576 with self.assertRaises(ValueError,
1577 msg=("Expected ValueError when stdout and capture_output "
1578 "args supplied.")) as c:
1579 output = self.run_python("print('will not be run')",
1580 capture_output=True, stdout=tf)
1581 self.assertIn('stdout', c.exception.args[0])
1582 self.assertIn('capture_output', c.exception.args[0])
1583
1584 def test_stderr_with_capture_output_arg(self):
1585 # run() refuses to accept 'stderr' with 'capture_output'
1586 tf = tempfile.TemporaryFile()
1587 self.addCleanup(tf.close)
1588 with self.assertRaises(ValueError,
1589 msg=("Expected ValueError when stderr and capture_output "
1590 "args supplied.")) as c:
1591 output = self.run_python("print('will not be run')",
1592 capture_output=True, stderr=tf)
1593 self.assertIn('stderr', c.exception.args[0])
1594 self.assertIn('capture_output', c.exception.args[0])
1595
Gregory P. Smith580d2782019-09-11 04:23:05 -05001596 # This test _might_ wind up a bit fragile on loaded build+test machines
1597 # as it depends on the timing with wide enough margins for normal situations
1598 # but does assert that it happened "soon enough" to believe the right thing
1599 # happened.
1600 @unittest.skipIf(mswindows, "requires posix like 'sleep' shell command")
1601 def test_run_with_shell_timeout_and_capture_output(self):
1602 """Output capturing after a timeout mustn't hang forever on open filehandles."""
1603 before_secs = time.monotonic()
1604 try:
1605 subprocess.run('sleep 3', shell=True, timeout=0.1,
1606 capture_output=True) # New session unspecified.
1607 except subprocess.TimeoutExpired as exc:
1608 after_secs = time.monotonic()
1609 stacks = traceback.format_exc() # assertRaises doesn't give this.
1610 else:
1611 self.fail("TimeoutExpired not raised.")
1612 self.assertLess(after_secs - before_secs, 1.5,
1613 msg="TimeoutExpired was delayed! Bad traceback:\n```\n"
1614 f"{stacks}```")
1615
Gregory P. Smith6e730002015-04-14 16:14:25 -07001616
Gregory P. Smith693aa802019-09-13 14:43:35 +01001617def _get_test_grp_name():
Victor Stinnerfaca8552019-09-25 15:52:49 +02001618 for name_group in ('staff', 'nogroup', 'grp', 'nobody', 'nfsnobody'):
Gregory P. Smith693aa802019-09-13 14:43:35 +01001619 if grp:
1620 try:
1621 grp.getgrnam(name_group)
1622 except KeyError:
1623 continue
1624 return name_group
1625 else:
1626 raise unittest.SkipTest('No identified group name to use for this test on this platform.')
1627
1628
Victor Stinner937ee9e2018-06-26 02:11:06 +02001629@unittest.skipIf(mswindows, "POSIX specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +00001630class POSIXProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00001631
Gregory P. Smith5591b022012-10-10 03:34:47 -07001632 def setUp(self):
1633 super().setUp()
1634 self._nonexistent_dir = "/_this/pa.th/does/not/exist"
1635
1636 def _get_chdir_exception(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001637 try:
Gregory P. Smith5591b022012-10-10 03:34:47 -07001638 os.chdir(self._nonexistent_dir)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001639 except OSError as e:
1640 # This avoids hard coding the errno value or the OS perror()
1641 # string and instead capture the exception that we want to see
1642 # below for comparison.
1643 desired_exception = e
1644 else:
Martin Pantereb995702016-07-28 01:11:04 +00001645 self.fail("chdir to nonexistent directory %s succeeded." %
Gregory P. Smith5591b022012-10-10 03:34:47 -07001646 self._nonexistent_dir)
1647 return desired_exception
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001648
Gregory P. Smith5591b022012-10-10 03:34:47 -07001649 def test_exception_cwd(self):
1650 """Test error in the child raised in the parent for a bad cwd."""
1651 desired_exception = self._get_chdir_exception()
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001652 try:
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001653 p = subprocess.Popen([sys.executable, "-c", ""],
Gregory P. Smith5591b022012-10-10 03:34:47 -07001654 cwd=self._nonexistent_dir)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001655 except OSError as e:
1656 # Test that the child process chdir failure actually makes
1657 # it up to the parent process as the correct exception.
1658 self.assertEqual(desired_exception.errno, e.errno)
1659 self.assertEqual(desired_exception.strerror, e.strerror)
Zackery Spytz73870bf2018-09-11 09:54:07 -06001660 self.assertEqual(desired_exception.filename, e.filename)
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001661 else:
1662 self.fail("Expected OSError: %s" % desired_exception)
1663
Gregory P. Smith5591b022012-10-10 03:34:47 -07001664 def test_exception_bad_executable(self):
1665 """Test error in the child raised in the parent for a bad executable."""
1666 desired_exception = self._get_chdir_exception()
1667 try:
1668 p = subprocess.Popen([sys.executable, "-c", ""],
1669 executable=self._nonexistent_dir)
1670 except OSError as e:
1671 # Test that the child process exec failure actually makes
1672 # it up to the parent process as the correct exception.
1673 self.assertEqual(desired_exception.errno, e.errno)
1674 self.assertEqual(desired_exception.strerror, e.strerror)
Zackery Spytz73870bf2018-09-11 09:54:07 -06001675 self.assertEqual(desired_exception.filename, e.filename)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001676 else:
1677 self.fail("Expected OSError: %s" % desired_exception)
1678
1679 def test_exception_bad_args_0(self):
1680 """Test error in the child raised in the parent for a bad args[0]."""
1681 desired_exception = self._get_chdir_exception()
1682 try:
1683 p = subprocess.Popen([self._nonexistent_dir, "-c", ""])
1684 except OSError as e:
1685 # Test that the child process exec failure actually makes
1686 # it up to the parent process as the correct exception.
1687 self.assertEqual(desired_exception.errno, e.errno)
1688 self.assertEqual(desired_exception.strerror, e.strerror)
Zackery Spytz73870bf2018-09-11 09:54:07 -06001689 self.assertEqual(desired_exception.filename, e.filename)
Gregory P. Smith5591b022012-10-10 03:34:47 -07001690 else:
1691 self.fail("Expected OSError: %s" % desired_exception)
1692
Ammar Askar3fc499b2017-09-06 02:41:30 -04001693 # We mock the __del__ method for Popen in the next two tests
1694 # because it does cleanup based on the pid returned by fork_exec
1695 # along with issuing a resource warning if it still exists. Since
1696 # we don't actually spawn a process in these tests we can forego
1697 # the destructor. An alternative would be to set _child_created to
1698 # False before the destructor is called but there is no easy way
1699 # to do that
1700 class PopenNoDestructor(subprocess.Popen):
1701 def __del__(self):
1702 pass
1703
1704 @mock.patch("subprocess._posixsubprocess.fork_exec")
1705 def test_exception_errpipe_normal(self, fork_exec):
1706 """Test error passing done through errpipe_write in the good case"""
1707 def proper_error(*args):
1708 errpipe_write = args[13]
1709 # Write the hex for the error code EISDIR: 'is a directory'
1710 err_code = '{:x}'.format(errno.EISDIR).encode()
1711 os.write(errpipe_write, b"OSError:" + err_code + b":")
1712 return 0
1713
1714 fork_exec.side_effect = proper_error
1715
Victor Stinner11045c92017-10-05 06:32:53 -07001716 with mock.patch("subprocess.os.waitpid",
1717 side_effect=ChildProcessError):
1718 with self.assertRaises(IsADirectoryError):
1719 self.PopenNoDestructor(["non_existent_command"])
Ammar Askar3fc499b2017-09-06 02:41:30 -04001720
1721 @mock.patch("subprocess._posixsubprocess.fork_exec")
1722 def test_exception_errpipe_bad_data(self, fork_exec):
1723 """Test error passing done through errpipe_write where its not
1724 in the expected format"""
1725 error_data = b"\xFF\x00\xDE\xAD"
1726 def bad_error(*args):
1727 errpipe_write = args[13]
1728 # Anything can be in the pipe, no assumptions should
1729 # be made about its encoding, so we'll write some
1730 # arbitrary hex bytes to test it out
1731 os.write(errpipe_write, error_data)
1732 return 0
1733
1734 fork_exec.side_effect = bad_error
1735
Victor Stinner11045c92017-10-05 06:32:53 -07001736 with mock.patch("subprocess.os.waitpid",
1737 side_effect=ChildProcessError):
1738 with self.assertRaises(subprocess.SubprocessError) as e:
1739 self.PopenNoDestructor(["non_existent_command"])
Ammar Askar3fc499b2017-09-06 02:41:30 -04001740
1741 self.assertIn(repr(error_data), str(e.exception))
1742
Gregory P. Smith5f3d04f2018-06-05 12:00:57 -07001743 @unittest.skipIf(not os.path.exists('/proc/self/status'),
1744 "need /proc/self/status")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001745 def test_restore_signals(self):
Gregory P. Smith5f3d04f2018-06-05 12:00:57 -07001746 # Blindly assume that cat exists on systems with /proc/self/status...
1747 default_proc_status = subprocess.check_output(
1748 ['cat', '/proc/self/status'],
1749 restore_signals=False)
1750 for line in default_proc_status.splitlines():
1751 if line.startswith(b'SigIgn'):
1752 default_sig_ign_mask = line
1753 break
1754 else:
1755 self.skipTest("SigIgn not found in /proc/self/status.")
1756 restored_proc_status = subprocess.check_output(
1757 ['cat', '/proc/self/status'],
1758 restore_signals=True)
1759 for line in restored_proc_status.splitlines():
1760 if line.startswith(b'SigIgn'):
1761 restored_sig_ign_mask = line
1762 break
1763 self.assertNotEqual(default_sig_ign_mask, restored_sig_ign_mask,
1764 msg="restore_signals=True should've unblocked "
1765 "SIGPIPE and friends.")
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001766
1767 def test_start_new_session(self):
1768 # For code coverage of calling setsid(). We don't care if we get an
1769 # EPERM error from it depending on the test execution environment, that
1770 # still indicates that it was called.
1771 try:
1772 output = subprocess.check_output(
Victor Stinner58840432019-06-14 19:31:43 +02001773 [sys.executable, "-c", "import os; print(os.getsid(0))"],
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001774 start_new_session=True)
1775 except OSError as e:
1776 if e.errno != errno.EPERM:
1777 raise
1778 else:
Victor Stinner58840432019-06-14 19:31:43 +02001779 parent_sid = os.getsid(0)
1780 child_sid = int(output)
1781 self.assertNotEqual(parent_sid, child_sid)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001782
Patrick McLean2b2ead72019-09-12 10:15:44 -07001783 @unittest.skipUnless(hasattr(os, 'setreuid'), 'no setreuid on platform')
1784 def test_user(self):
1785 # For code coverage of the user parameter. We don't care if we get an
1786 # EPERM error from it depending on the test execution environment, that
1787 # still indicates that it was called.
1788
1789 uid = os.geteuid()
1790 test_users = [65534 if uid != 65534 else 65533, uid]
1791 name_uid = "nobody" if sys.platform != 'darwin' else "unknown"
1792
1793 if pwd is not None:
Victor Stinnerf7b5d412020-03-05 14:28:40 +01001794 try:
1795 pwd.getpwnam(name_uid)
1796 test_users.append(name_uid)
1797 except KeyError:
1798 # unknown user name
1799 name_uid = None
Patrick McLean2b2ead72019-09-12 10:15:44 -07001800
1801 for user in test_users:
Victor Stinnerfaca8552019-09-25 15:52:49 +02001802 # posix_spawn() may be used with close_fds=False
1803 for close_fds in (False, True):
1804 with self.subTest(user=user, close_fds=close_fds):
1805 try:
1806 output = subprocess.check_output(
1807 [sys.executable, "-c",
1808 "import os; print(os.getuid())"],
1809 user=user,
1810 close_fds=close_fds)
1811 except PermissionError: # (EACCES, EPERM)
1812 pass
1813 except OSError as e:
1814 if e.errno not in (errno.EACCES, errno.EPERM):
1815 raise
Patrick McLean2b2ead72019-09-12 10:15:44 -07001816 else:
Victor Stinnerfaca8552019-09-25 15:52:49 +02001817 if isinstance(user, str):
1818 user_uid = pwd.getpwnam(user).pw_uid
1819 else:
1820 user_uid = user
1821 child_user = int(output)
1822 self.assertEqual(child_user, user_uid)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001823
1824 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001825 subprocess.check_call(ZERO_RETURN_CMD, user=-1)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001826
Victor Stinnerf7b5d412020-03-05 14:28:40 +01001827 if pwd is None and name_uid is not None:
Patrick McLean2b2ead72019-09-12 10:15:44 -07001828 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001829 subprocess.check_call(ZERO_RETURN_CMD, user=name_uid)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001830
1831 @unittest.skipIf(hasattr(os, 'setreuid'), 'setreuid() available on platform')
1832 def test_user_error(self):
1833 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001834 subprocess.check_call(ZERO_RETURN_CMD, user=65535)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001835
1836 @unittest.skipUnless(hasattr(os, 'setregid'), 'no setregid() on platform')
1837 def test_group(self):
1838 gid = os.getegid()
1839 group_list = [65534 if gid != 65534 else 65533]
Gregory P. Smith693aa802019-09-13 14:43:35 +01001840 name_group = _get_test_grp_name()
Patrick McLean2b2ead72019-09-12 10:15:44 -07001841
1842 if grp is not None:
1843 group_list.append(name_group)
1844
1845 for group in group_list + [gid]:
Victor Stinnerfaca8552019-09-25 15:52:49 +02001846 # posix_spawn() may be used with close_fds=False
1847 for close_fds in (False, True):
1848 with self.subTest(group=group, close_fds=close_fds):
1849 try:
1850 output = subprocess.check_output(
1851 [sys.executable, "-c",
1852 "import os; print(os.getgid())"],
1853 group=group,
1854 close_fds=close_fds)
1855 except PermissionError: # (EACCES, EPERM)
1856 pass
Patrick McLean2b2ead72019-09-12 10:15:44 -07001857 else:
Victor Stinnerfaca8552019-09-25 15:52:49 +02001858 if isinstance(group, str):
1859 group_gid = grp.getgrnam(group).gr_gid
1860 else:
1861 group_gid = group
Patrick McLean2b2ead72019-09-12 10:15:44 -07001862
Victor Stinnerfaca8552019-09-25 15:52:49 +02001863 child_group = int(output)
1864 self.assertEqual(child_group, group_gid)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001865
1866 # make sure we bomb on negative values
1867 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001868 subprocess.check_call(ZERO_RETURN_CMD, group=-1)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001869
1870 if grp is None:
1871 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001872 subprocess.check_call(ZERO_RETURN_CMD, group=name_group)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001873
1874 @unittest.skipIf(hasattr(os, 'setregid'), 'setregid() available on platform')
1875 def test_group_error(self):
1876 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001877 subprocess.check_call(ZERO_RETURN_CMD, group=65535)
Patrick McLean2b2ead72019-09-12 10:15:44 -07001878
1879 @unittest.skipUnless(hasattr(os, 'setgroups'), 'no setgroups() on platform')
1880 def test_extra_groups(self):
1881 gid = os.getegid()
1882 group_list = [65534 if gid != 65534 else 65533]
Gregory P. Smith693aa802019-09-13 14:43:35 +01001883 name_group = _get_test_grp_name()
Patrick McLean2b2ead72019-09-12 10:15:44 -07001884 perm_error = False
1885
1886 if grp is not None:
1887 group_list.append(name_group)
1888
1889 try:
1890 output = subprocess.check_output(
1891 [sys.executable, "-c",
1892 "import os, sys, json; json.dump(os.getgroups(), sys.stdout)"],
1893 extra_groups=group_list)
1894 except OSError as ex:
1895 if ex.errno != errno.EPERM:
1896 raise
1897 perm_error = True
1898
1899 else:
1900 parent_groups = os.getgroups()
1901 child_groups = json.loads(output)
1902
1903 if grp is not None:
1904 desired_gids = [grp.getgrnam(g).gr_gid if isinstance(g, str) else g
1905 for g in group_list]
1906 else:
1907 desired_gids = group_list
1908
1909 if perm_error:
1910 self.assertEqual(set(child_groups), set(parent_groups))
1911 else:
1912 self.assertEqual(set(desired_gids), set(child_groups))
1913
1914 # make sure we bomb on negative values
1915 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001916 subprocess.check_call(ZERO_RETURN_CMD, extra_groups=[-1])
Patrick McLean2b2ead72019-09-12 10:15:44 -07001917
1918 if grp is None:
1919 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001920 subprocess.check_call(ZERO_RETURN_CMD,
Patrick McLean2b2ead72019-09-12 10:15:44 -07001921 extra_groups=[name_group])
1922
1923 @unittest.skipIf(hasattr(os, 'setgroups'), 'setgroups() available on platform')
1924 def test_extra_groups_error(self):
1925 with self.assertRaises(ValueError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001926 subprocess.check_call(ZERO_RETURN_CMD, extra_groups=[])
Patrick McLean2b2ead72019-09-12 10:15:44 -07001927
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07001928 @unittest.skipIf(mswindows or not hasattr(os, 'umask'),
1929 'POSIX umask() is not available.')
1930 def test_umask(self):
1931 tmpdir = None
1932 try:
1933 tmpdir = tempfile.mkdtemp()
1934 name = os.path.join(tmpdir, "beans")
1935 # We set an unusual umask in the child so as a unique mode
1936 # for us to test the child's touched file for.
1937 subprocess.check_call(
Gregory P. Smith67b93f82019-10-12 16:35:53 -07001938 [sys.executable, "-c", f"open({name!r}, 'w').close()"],
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07001939 umask=0o053)
1940 # Ignore execute permissions entirely in our test,
1941 # filesystems could be mounted to ignore or force that.
1942 st_mode = os.stat(name).st_mode & 0o666
1943 expected_mode = 0o624
1944 self.assertEqual(expected_mode, st_mode,
1945 msg=f'{oct(expected_mode)} != {oct(st_mode)}')
1946 finally:
1947 if tmpdir is not None:
1948 shutil.rmtree(tmpdir)
1949
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001950 def test_run_abort(self):
1951 # returncode handles signal termination
Antoine Pitrou77e904e2013-10-08 23:04:32 +02001952 with support.SuppressCrashReport():
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001953 p = subprocess.Popen([sys.executable, "-c",
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001954 'import os; os.abort()'])
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001955 p.wait()
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001956 self.assertEqual(-p.returncode, signal.SIGABRT)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001957
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)d6da7602016-06-03 06:14:06 +00001958 def test_CalledProcessError_str_signal(self):
1959 err = subprocess.CalledProcessError(-int(signal.SIGABRT), "fake cmd")
1960 error_string = str(err)
1961 # We're relying on the repr() of the signal.Signals intenum to provide
1962 # the word signal, the signal name and the numeric value.
1963 self.assertIn("signal", error_string.lower())
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)b4149062016-06-03 06:19:35 +00001964 # We're not being specific about the signal name as some signals have
1965 # multiple names and which name is revealed can vary.
1966 self.assertIn("SIG", error_string)
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)d6da7602016-06-03 06:14:06 +00001967 self.assertIn(str(signal.SIGABRT), error_string)
1968
1969 def test_CalledProcessError_str_unknown_signal(self):
1970 err = subprocess.CalledProcessError(-9876543, "fake cmd")
1971 error_string = str(err)
1972 self.assertIn("unknown signal 9876543.", error_string)
1973
1974 def test_CalledProcessError_str_non_zero(self):
1975 err = subprocess.CalledProcessError(2, "fake cmd")
1976 error_string = str(err)
1977 self.assertIn("non-zero exit status 2.", error_string)
1978
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001979 def test_preexec(self):
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001980 # DISCLAIMER: Setting environment variables is *not* a good use
1981 # of a preexec_fn. This is merely a test.
Florent Xiclunab1e94e82010-02-27 22:12:37 +00001982 p = subprocess.Popen([sys.executable, "-c",
1983 'import sys,os;'
1984 'sys.stdout.write(os.getenv("FRUIT"))'],
1985 stdout=subprocess.PIPE,
1986 preexec_fn=lambda: os.putenv("FRUIT", "apple"))
Victor Stinner7438c612016-05-20 12:43:15 +02001987 with p:
1988 self.assertEqual(p.stdout.read(), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00001989
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001990 def test_preexec_exception(self):
1991 def raise_it():
1992 raise ValueError("What if two swallows carried a coconut?")
1993 try:
1994 p = subprocess.Popen([sys.executable, "-c", ""],
1995 preexec_fn=raise_it)
Gregory P. Smith8d07c262012-11-10 23:53:47 -08001996 except subprocess.SubprocessError as e:
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00001997 self.assertTrue(
1998 subprocess._posixsubprocess,
1999 "Expected a ValueError from the preexec_fn")
2000 except ValueError as e:
2001 self.assertIn("coconut", e.args[0])
2002 else:
2003 self.fail("Exception raised by preexec_fn did not make it "
2004 "to the parent process.")
2005
Gregory P. Smithe27faac2012-11-11 09:59:27 -08002006 class _TestExecuteChildPopen(subprocess.Popen):
2007 """Used to test behavior at the end of _execute_child."""
2008 def __init__(self, testcase, *args, **kwargs):
2009 self._testcase = testcase
2010 subprocess.Popen.__init__(self, *args, **kwargs)
Gregory P. Smith12489d92012-11-11 01:37:02 -08002011
Gregory P. Smithe27faac2012-11-11 09:59:27 -08002012 def _execute_child(self, *args, **kwargs):
Gregory P. Smith12489d92012-11-11 01:37:02 -08002013 try:
Gregory P. Smithe27faac2012-11-11 09:59:27 -08002014 subprocess.Popen._execute_child(self, *args, **kwargs)
Gregory P. Smith12489d92012-11-11 01:37:02 -08002015 finally:
2016 # Open a bunch of file descriptors and verify that
2017 # none of them are the same as the ones the Popen
2018 # instance is using for stdin/stdout/stderr.
2019 devzero_fds = [os.open("/dev/zero", os.O_RDONLY)
2020 for _ in range(8)]
2021 try:
2022 for fd in devzero_fds:
Gregory P. Smithe27faac2012-11-11 09:59:27 -08002023 self._testcase.assertNotIn(
2024 fd, (self.stdin.fileno(), self.stdout.fileno(),
2025 self.stderr.fileno()),
Gregory P. Smith12489d92012-11-11 01:37:02 -08002026 msg="At least one fd was closed early.")
2027 finally:
Richard Oudkerk0e547b62013-06-10 16:29:19 +01002028 for fd in devzero_fds:
2029 os.close(fd)
Gregory P. Smith12489d92012-11-11 01:37:02 -08002030
Gregory P. Smithe27faac2012-11-11 09:59:27 -08002031 @unittest.skipIf(not os.path.exists("/dev/zero"), "/dev/zero required.")
2032 def test_preexec_errpipe_does_not_double_close_pipes(self):
2033 """Issue16140: Don't double close pipes on preexec error."""
2034
2035 def raise_it():
Gregory P. Smith65ee6ec2012-11-11 10:12:40 -08002036 raise subprocess.SubprocessError(
2037 "force the _execute_child() errpipe_data path.")
Gregory P. Smith12489d92012-11-11 01:37:02 -08002038
Gregory P. Smithc2c4cb62012-11-11 01:41:49 -08002039 with self.assertRaises(subprocess.SubprocessError):
Gregory P. Smithe27faac2012-11-11 09:59:27 -08002040 self._TestExecuteChildPopen(
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002041 self, ZERO_RETURN_CMD,
Gregory P. Smith12489d92012-11-11 01:37:02 -08002042 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
2043 stderr=subprocess.PIPE, preexec_fn=raise_it)
2044
Gregory P. Smith32ec9da2010-03-19 16:53:08 +00002045 def test_preexec_gc_module_failure(self):
2046 # This tests the code that disables garbage collection if the child
2047 # process will execute any Python.
2048 def raise_runtime_error():
2049 raise RuntimeError("this shouldn't escape")
2050 enabled = gc.isenabled()
2051 orig_gc_disable = gc.disable
2052 orig_gc_isenabled = gc.isenabled
2053 try:
2054 gc.disable()
2055 self.assertFalse(gc.isenabled())
2056 subprocess.call([sys.executable, '-c', ''],
2057 preexec_fn=lambda: None)
2058 self.assertFalse(gc.isenabled(),
2059 "Popen enabled gc when it shouldn't.")
2060
2061 gc.enable()
2062 self.assertTrue(gc.isenabled())
2063 subprocess.call([sys.executable, '-c', ''],
2064 preexec_fn=lambda: None)
2065 self.assertTrue(gc.isenabled(), "Popen left gc disabled.")
2066
2067 gc.disable = raise_runtime_error
2068 self.assertRaises(RuntimeError, subprocess.Popen,
2069 [sys.executable, '-c', ''],
2070 preexec_fn=lambda: None)
2071
2072 del gc.isenabled # force an AttributeError
2073 self.assertRaises(AttributeError, subprocess.Popen,
2074 [sys.executable, '-c', ''],
2075 preexec_fn=lambda: None)
2076 finally:
2077 gc.disable = orig_gc_disable
2078 gc.isenabled = orig_gc_isenabled
2079 if not enabled:
2080 gc.disable()
2081
Martin Panterf7fdbda2015-12-05 09:51:52 +00002082 @unittest.skipIf(
2083 sys.platform == 'darwin', 'setrlimit() seems to fail on OS X')
Martin Panterafdd5132015-11-30 02:21:41 +00002084 def test_preexec_fork_failure(self):
2085 # The internal code did not preserve the previous exception when
2086 # re-enabling garbage collection
2087 try:
2088 from resource import getrlimit, setrlimit, RLIMIT_NPROC
2089 except ImportError as err:
2090 self.skipTest(err) # RLIMIT_NPROC is specific to Linux and BSD
2091 limits = getrlimit(RLIMIT_NPROC)
2092 [_, hard] = limits
2093 setrlimit(RLIMIT_NPROC, (0, hard))
2094 self.addCleanup(setrlimit, RLIMIT_NPROC, limits)
Martin Panter5cf791b2015-12-11 05:40:14 +00002095 try:
Martin Panterafdd5132015-11-30 02:21:41 +00002096 subprocess.call([sys.executable, '-c', ''],
2097 preexec_fn=lambda: None)
Martin Panter5cf791b2015-12-11 05:40:14 +00002098 except BlockingIOError:
2099 # Forking should raise EAGAIN, translated to BlockingIOError
2100 pass
2101 else:
2102 self.skipTest('RLIMIT_NPROC had no effect; probably superuser')
Martin Panterafdd5132015-11-30 02:21:41 +00002103
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002104 def test_args_string(self):
2105 # args is a string
Berker Peksag16a1f282015-09-28 13:33:14 +03002106 fd, fname = tempfile.mkstemp()
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002107 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +00002108 with open(fd, "w", errors="surrogateescape") as fobj:
Xavier de Gayed1415312016-07-22 12:15:29 +02002109 fobj.write("#!%s\n" % support.unix_shell)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002110 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
2111 sys.executable)
2112 os.chmod(fname, 0o700)
2113 p = subprocess.Popen(fname)
2114 p.wait()
2115 os.remove(fname)
2116 self.assertEqual(p.returncode, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002117
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002118 def test_invalid_args(self):
2119 # invalid arguments should raise ValueError
2120 self.assertRaises(ValueError, subprocess.call,
2121 [sys.executable, "-c",
2122 "import sys; sys.exit(47)"],
2123 startupinfo=47)
2124 self.assertRaises(ValueError, subprocess.call,
2125 [sys.executable, "-c",
2126 "import sys; sys.exit(47)"],
2127 creationflags=47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002128
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002129 def test_shell_sequence(self):
2130 # Run command through the shell (sequence)
2131 newenv = os.environ.copy()
2132 newenv["FRUIT"] = "apple"
2133 p = subprocess.Popen(["echo $FRUIT"], shell=1,
2134 stdout=subprocess.PIPE,
2135 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02002136 with p:
2137 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00002138
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002139 def test_shell_string(self):
2140 # Run command through the shell (string)
2141 newenv = os.environ.copy()
2142 newenv["FRUIT"] = "apple"
2143 p = subprocess.Popen("echo $FRUIT", shell=1,
2144 stdout=subprocess.PIPE,
2145 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02002146 with p:
2147 self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple")
Christian Heimesa342c012008-04-20 21:01:16 +00002148
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002149 def test_call_string(self):
2150 # call() function with string argument on UNIX
Berker Peksag16a1f282015-09-28 13:33:14 +03002151 fd, fname = tempfile.mkstemp()
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002152 # reopen in text mode
Victor Stinnerf6782ac2010-10-16 23:46:43 +00002153 with open(fd, "w", errors="surrogateescape") as fobj:
Xavier de Gayed1415312016-07-22 12:15:29 +02002154 fobj.write("#!%s\n" % support.unix_shell)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002155 fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" %
2156 sys.executable)
2157 os.chmod(fname, 0o700)
2158 rc = subprocess.call(fname)
2159 os.remove(fname)
2160 self.assertEqual(rc, 47)
Christian Heimesa342c012008-04-20 21:01:16 +00002161
Stefan Krah9542cc62010-07-19 14:20:53 +00002162 def test_specific_shell(self):
2163 # Issue #9265: Incorrect name passed as arg[0].
2164 shells = []
2165 for prefix in ['/bin', '/usr/bin/', '/usr/local/bin']:
2166 for name in ['bash', 'ksh']:
2167 sh = os.path.join(prefix, name)
2168 if os.path.isfile(sh):
2169 shells.append(sh)
2170 if not shells: # Will probably work for any shell but csh.
2171 self.skipTest("bash or ksh required for this test")
2172 sh = '/bin/sh'
2173 if os.path.isfile(sh) and not os.path.islink(sh):
2174 # Test will fail if /bin/sh is a symlink to csh.
2175 shells.append(sh)
2176 for sh in shells:
2177 p = subprocess.Popen("echo $0", executable=sh, shell=True,
2178 stdout=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +02002179 with p:
2180 self.assertEqual(p.stdout.read().strip(), bytes(sh, 'ascii'))
Stefan Krah9542cc62010-07-19 14:20:53 +00002181
Florent Xicluna4886d242010-03-08 13:27:26 +00002182 def _kill_process(self, method, *args):
Florent Xicluna1d8ee3a2010-03-05 20:26:54 +00002183 # Do not inherit file handles from the parent.
2184 # It should fix failures on some platforms.
Gregory P. Smithdee04342013-08-29 13:35:27 -07002185 # Also set the SIGINT handler to the default to make sure it's not
2186 # being ignored (some tests rely on that.)
2187 old_handler = signal.signal(signal.SIGINT, signal.default_int_handler)
2188 try:
2189 p = subprocess.Popen([sys.executable, "-c", """if 1:
2190 import sys, time
2191 sys.stdout.write('x\\n')
2192 sys.stdout.flush()
2193 time.sleep(30)
2194 """],
2195 close_fds=True,
2196 stdin=subprocess.PIPE,
2197 stdout=subprocess.PIPE,
2198 stderr=subprocess.PIPE)
2199 finally:
2200 signal.signal(signal.SIGINT, old_handler)
Antoine Pitrou3d8580f2010-09-20 01:33:21 +00002201 # Wait for the interpreter to be completely initialized before
2202 # sending any signal.
2203 p.stdout.read(1)
2204 getattr(p, method)(*args)
Florent Xicluna4886d242010-03-08 13:27:26 +00002205 return p
2206
Charles-François Natali53221e32013-01-12 16:52:20 +01002207 @unittest.skipIf(sys.platform.startswith(('netbsd', 'openbsd')),
2208 "Due to known OS bug (issue #16762)")
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01002209 def _kill_dead_process(self, method, *args):
2210 # Do not inherit file handles from the parent.
2211 # It should fix failures on some platforms.
2212 p = subprocess.Popen([sys.executable, "-c", """if 1:
2213 import sys, time
2214 sys.stdout.write('x\\n')
2215 sys.stdout.flush()
2216 """],
2217 close_fds=True,
2218 stdin=subprocess.PIPE,
2219 stdout=subprocess.PIPE,
2220 stderr=subprocess.PIPE)
2221 # Wait for the interpreter to be completely initialized before
2222 # sending any signal.
2223 p.stdout.read(1)
2224 # The process should end after this
2225 time.sleep(1)
2226 # This shouldn't raise even though the child is now dead
2227 getattr(p, method)(*args)
2228 p.communicate()
2229
Florent Xicluna4886d242010-03-08 13:27:26 +00002230 def test_send_signal(self):
2231 p = self._kill_process('send_signal', signal.SIGINT)
Florent Xiclunac049d872010-03-27 22:47:23 +00002232 _, stderr = p.communicate()
2233 self.assertIn(b'KeyboardInterrupt', stderr)
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00002234 self.assertNotEqual(p.wait(), 0)
Christian Heimesa342c012008-04-20 21:01:16 +00002235
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002236 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00002237 p = self._kill_process('kill')
Florent Xiclunac049d872010-03-27 22:47:23 +00002238 _, stderr = p.communicate()
Victor Stinner6cac1132019-12-08 08:38:16 +01002239 self.assertEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002240 self.assertEqual(p.wait(), -signal.SIGKILL)
Tim Peterse718f612004-10-12 21:51:32 +00002241
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002242 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00002243 p = self._kill_process('terminate')
Florent Xiclunac049d872010-03-27 22:47:23 +00002244 _, stderr = p.communicate()
Victor Stinner6cac1132019-12-08 08:38:16 +01002245 self.assertEqual(stderr, b'')
Florent Xiclunab1e94e82010-02-27 22:12:37 +00002246 self.assertEqual(p.wait(), -signal.SIGTERM)
2247
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01002248 def test_send_signal_dead(self):
2249 # Sending a signal to a dead process
2250 self._kill_dead_process('send_signal', signal.SIGINT)
2251
2252 def test_kill_dead(self):
2253 # Killing a dead process
2254 self._kill_dead_process('kill')
2255
2256 def test_terminate_dead(self):
2257 # Terminating a dead process
2258 self._kill_dead_process('terminate')
2259
Victor Stinnerdaf45552013-08-28 00:53:59 +02002260 def _save_fds(self, save_fds):
2261 fds = []
2262 for fd in save_fds:
2263 inheritable = os.get_inheritable(fd)
2264 saved = os.dup(fd)
2265 fds.append((fd, saved, inheritable))
2266 return fds
2267
2268 def _restore_fds(self, fds):
2269 for fd, saved, inheritable in fds:
2270 os.dup2(saved, fd, inheritable=inheritable)
2271 os.close(saved)
2272
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00002273 def check_close_std_fds(self, fds):
2274 # Issue #9905: test that subprocess pipes still work properly with
2275 # some standard fds closed
2276 stdin = 0
Victor Stinnerdaf45552013-08-28 00:53:59 +02002277 saved_fds = self._save_fds(fds)
2278 for fd, saved, inheritable in saved_fds:
2279 if fd == 0:
2280 stdin = saved
2281 break
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00002282 try:
2283 for fd in fds:
2284 os.close(fd)
2285 out, err = subprocess.Popen([sys.executable, "-c",
2286 'import sys;'
2287 'sys.stdout.write("apple");'
2288 'sys.stdout.flush();'
2289 'sys.stderr.write("orange")'],
2290 stdin=stdin,
2291 stdout=subprocess.PIPE,
2292 stderr=subprocess.PIPE).communicate()
Victor Stinner6cac1132019-12-08 08:38:16 +01002293 self.assertEqual(out, b'apple')
2294 self.assertEqual(err, b'orange')
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00002295 finally:
Victor Stinnerdaf45552013-08-28 00:53:59 +02002296 self._restore_fds(saved_fds)
Antoine Pitrouc9c83ba2011-01-03 18:23:55 +00002297
2298 def test_close_fd_0(self):
2299 self.check_close_std_fds([0])
2300
2301 def test_close_fd_1(self):
2302 self.check_close_std_fds([1])
2303
2304 def test_close_fd_2(self):
2305 self.check_close_std_fds([2])
2306
2307 def test_close_fds_0_1(self):
2308 self.check_close_std_fds([0, 1])
2309
2310 def test_close_fds_0_2(self):
2311 self.check_close_std_fds([0, 2])
2312
2313 def test_close_fds_1_2(self):
2314 self.check_close_std_fds([1, 2])
2315
2316 def test_close_fds_0_1_2(self):
2317 # Issue #10806: test that subprocess pipes still work properly with
2318 # all standard fds closed.
2319 self.check_close_std_fds([0, 1, 2])
2320
Gregory P. Smith53dd8162013-12-01 16:03:24 -08002321 def test_small_errpipe_write_fd(self):
2322 """Issue #15798: Popen should work when stdio fds are available."""
2323 new_stdin = os.dup(0)
2324 new_stdout = os.dup(1)
2325 try:
2326 os.close(0)
2327 os.close(1)
2328
2329 # Side test: if errpipe_write fails to have its CLOEXEC
2330 # flag set this should cause the parent to think the exec
2331 # failed. Extremely unlikely: everyone supports CLOEXEC.
2332 subprocess.Popen([
2333 sys.executable, "-c",
2334 "print('AssertionError:0:CLOEXEC failure.')"]).wait()
2335 finally:
2336 # Restore original stdin and stdout
2337 os.dup2(new_stdin, 0)
2338 os.dup2(new_stdout, 1)
2339 os.close(new_stdin)
2340 os.close(new_stdout)
2341
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00002342 def test_remapping_std_fds(self):
2343 # open up some temporary files
Berker Peksag16a1f282015-09-28 13:33:14 +03002344 temps = [tempfile.mkstemp() for i in range(3)]
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00002345 try:
2346 temp_fds = [fd for fd, fname in temps]
2347
2348 # unlink the files -- we won't need to reopen them
2349 for fd, fname in temps:
2350 os.unlink(fname)
2351
2352 # write some data to what will become stdin, and rewind
2353 os.write(temp_fds[1], b"STDIN")
2354 os.lseek(temp_fds[1], 0, 0)
2355
2356 # move the standard file descriptors out of the way
Victor Stinnerdaf45552013-08-28 00:53:59 +02002357 saved_fds = self._save_fds(range(3))
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00002358 try:
2359 # duplicate the file objects over the standard fd's
2360 for fd, temp_fd in enumerate(temp_fds):
2361 os.dup2(temp_fd, fd)
2362
2363 # now use those files in the "wrong" order, so that subprocess
2364 # has to rearrange them in the child
2365 p = subprocess.Popen([sys.executable, "-c",
2366 'import sys; got = sys.stdin.read();'
2367 'sys.stdout.write("got %s"%got); sys.stderr.write("err")'],
2368 stdin=temp_fds[1],
2369 stdout=temp_fds[2],
2370 stderr=temp_fds[0])
2371 p.wait()
2372 finally:
Victor Stinnerdaf45552013-08-28 00:53:59 +02002373 self._restore_fds(saved_fds)
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00002374
2375 for fd in temp_fds:
2376 os.lseek(fd, 0, 0)
2377
2378 out = os.read(temp_fds[2], 1024)
Victor Stinner6cac1132019-12-08 08:38:16 +01002379 err = os.read(temp_fds[0], 1024).strip()
Antoine Pitrou95aaeee2011-01-03 21:15:48 +00002380 self.assertEqual(out, b"got STDIN")
2381 self.assertEqual(err, b"err")
2382
2383 finally:
2384 for fd in temp_fds:
2385 os.close(fd)
2386
Ross Lagerwalld98646e2011-07-27 07:16:31 +02002387 def check_swap_fds(self, stdin_no, stdout_no, stderr_no):
2388 # open up some temporary files
Berker Peksag16a1f282015-09-28 13:33:14 +03002389 temps = [tempfile.mkstemp() for i in range(3)]
Ross Lagerwalld98646e2011-07-27 07:16:31 +02002390 temp_fds = [fd for fd, fname in temps]
2391 try:
2392 # unlink the files -- we won't need to reopen them
2393 for fd, fname in temps:
2394 os.unlink(fname)
2395
2396 # save a copy of the standard file descriptors
Victor Stinnerdaf45552013-08-28 00:53:59 +02002397 saved_fds = self._save_fds(range(3))
Ross Lagerwalld98646e2011-07-27 07:16:31 +02002398 try:
2399 # duplicate the temp files over the standard fd's 0, 1, 2
2400 for fd, temp_fd in enumerate(temp_fds):
2401 os.dup2(temp_fd, fd)
2402
2403 # write some data to what will become stdin, and rewind
2404 os.write(stdin_no, b"STDIN")
2405 os.lseek(stdin_no, 0, 0)
2406
2407 # now use those files in the given order, so that subprocess
2408 # has to rearrange them in the child
2409 p = subprocess.Popen([sys.executable, "-c",
2410 'import sys; got = sys.stdin.read();'
2411 'sys.stdout.write("got %s"%got); sys.stderr.write("err")'],
2412 stdin=stdin_no,
2413 stdout=stdout_no,
2414 stderr=stderr_no)
2415 p.wait()
2416
2417 for fd in temp_fds:
2418 os.lseek(fd, 0, 0)
2419
2420 out = os.read(stdout_no, 1024)
Victor Stinner6cac1132019-12-08 08:38:16 +01002421 err = os.read(stderr_no, 1024).strip()
Ross Lagerwalld98646e2011-07-27 07:16:31 +02002422 finally:
Victor Stinnerdaf45552013-08-28 00:53:59 +02002423 self._restore_fds(saved_fds)
Ross Lagerwalld98646e2011-07-27 07:16:31 +02002424
2425 self.assertEqual(out, b"got STDIN")
2426 self.assertEqual(err, b"err")
2427
2428 finally:
2429 for fd in temp_fds:
2430 os.close(fd)
2431
2432 # When duping fds, if there arises a situation where one of the fds is
2433 # either 0, 1 or 2, it is possible that it is overwritten (#12607).
2434 # This tests all combinations of this.
2435 def test_swap_fds(self):
2436 self.check_swap_fds(0, 1, 2)
2437 self.check_swap_fds(0, 2, 1)
2438 self.check_swap_fds(1, 0, 2)
2439 self.check_swap_fds(1, 2, 0)
2440 self.check_swap_fds(2, 0, 1)
2441 self.check_swap_fds(2, 1, 0)
2442
Alexey Izbyshev0e7144b2018-03-26 22:49:35 +03002443 def _check_swap_std_fds_with_one_closed(self, from_fds, to_fds):
2444 saved_fds = self._save_fds(range(3))
2445 try:
2446 for from_fd in from_fds:
2447 with tempfile.TemporaryFile() as f:
2448 os.dup2(f.fileno(), from_fd)
2449
2450 fd_to_close = (set(range(3)) - set(from_fds)).pop()
2451 os.close(fd_to_close)
2452
2453 arg_names = ['stdin', 'stdout', 'stderr']
2454 kwargs = {}
2455 for from_fd, to_fd in zip(from_fds, to_fds):
2456 kwargs[arg_names[to_fd]] = from_fd
2457
2458 code = textwrap.dedent(r'''
2459 import os, sys
2460 skipped_fd = int(sys.argv[1])
2461 for fd in range(3):
2462 if fd != skipped_fd:
2463 os.write(fd, str(fd).encode('ascii'))
2464 ''')
2465
2466 skipped_fd = (set(range(3)) - set(to_fds)).pop()
2467
2468 rc = subprocess.call([sys.executable, '-c', code, str(skipped_fd)],
2469 **kwargs)
2470 self.assertEqual(rc, 0)
2471
2472 for from_fd, to_fd in zip(from_fds, to_fds):
2473 os.lseek(from_fd, 0, os.SEEK_SET)
2474 read_bytes = os.read(from_fd, 1024)
2475 read_fds = list(map(int, read_bytes.decode('ascii')))
2476 msg = textwrap.dedent(f"""
2477 When testing {from_fds} to {to_fds} redirection,
2478 parent descriptor {from_fd} got redirected
2479 to descriptor(s) {read_fds} instead of descriptor {to_fd}.
2480 """)
2481 self.assertEqual([to_fd], read_fds, msg)
2482 finally:
2483 self._restore_fds(saved_fds)
2484
2485 # Check that subprocess can remap std fds correctly even
2486 # if one of them is closed (#32844).
2487 def test_swap_std_fds_with_one_closed(self):
2488 for from_fds in itertools.combinations(range(3), 2):
2489 for to_fds in itertools.permutations(range(3), 2):
2490 self._check_swap_std_fds_with_one_closed(from_fds, to_fds)
2491
Victor Stinner13bb71c2010-04-23 21:41:56 +00002492 def test_surrogates_error_message(self):
Victor Stinner4d078042010-04-23 19:28:32 +00002493 def prepare():
2494 raise ValueError("surrogate:\uDCff")
2495
2496 try:
2497 subprocess.call(
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002498 ZERO_RETURN_CMD,
Victor Stinner4d078042010-04-23 19:28:32 +00002499 preexec_fn=prepare)
2500 except ValueError as err:
2501 # Pure Python implementations keeps the message
2502 self.assertIsNone(subprocess._posixsubprocess)
2503 self.assertEqual(str(err), "surrogate:\uDCff")
Gregory P. Smith8d07c262012-11-10 23:53:47 -08002504 except subprocess.SubprocessError as err:
Victor Stinner4d078042010-04-23 19:28:32 +00002505 # _posixsubprocess uses a default message
2506 self.assertIsNotNone(subprocess._posixsubprocess)
2507 self.assertEqual(str(err), "Exception occurred in preexec_fn.")
2508 else:
Gregory P. Smith8d07c262012-11-10 23:53:47 -08002509 self.fail("Expected ValueError or subprocess.SubprocessError")
Victor Stinner4d078042010-04-23 19:28:32 +00002510
Victor Stinner13bb71c2010-04-23 21:41:56 +00002511 def test_undecodable_env(self):
2512 for key, value in (('test', 'abc\uDCFF'), ('test\uDCFF', '42')):
Victor Stinner5323fb02013-11-19 23:46:06 +01002513 encoded_value = value.encode("ascii", "surrogateescape")
2514
Victor Stinner13bb71c2010-04-23 21:41:56 +00002515 # test str with surrogates
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00002516 script = "import os; print(ascii(os.getenv(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00002517 env = os.environ.copy()
2518 env[key] = value
Victor Stinner5323fb02013-11-19 23:46:06 +01002519 # Use C locale to get ASCII for the locale encoding to force
Michael Felt89d79b12018-08-26 19:29:36 +02002520 # surrogate-escaping of \xFF in the child process
Victor Stinnerebc78d22010-10-14 10:38:17 +00002521 env['LC_ALL'] = 'C'
Michael Felt89d79b12018-08-26 19:29:36 +02002522 decoded_value = value
Victor Stinner13bb71c2010-04-23 21:41:56 +00002523 stdout = subprocess.check_output(
2524 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00002525 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00002526 stdout = stdout.rstrip(b'\n\r')
Victor Stinner5323fb02013-11-19 23:46:06 +01002527 self.assertEqual(stdout.decode('ascii'), ascii(decoded_value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00002528
2529 # test bytes
2530 key = key.encode("ascii", "surrogateescape")
Antoine Pitroufb8db8f2010-09-19 22:46:05 +00002531 script = "import os; print(ascii(os.getenvb(%s)))" % repr(key)
Victor Stinnerce2d24d2010-04-23 22:55:39 +00002532 env = os.environ.copy()
Victor Stinner5323fb02013-11-19 23:46:06 +01002533 env[key] = encoded_value
Victor Stinner13bb71c2010-04-23 21:41:56 +00002534 stdout = subprocess.check_output(
2535 [sys.executable, "-c", script],
Victor Stinnerce2d24d2010-04-23 22:55:39 +00002536 env=env)
Victor Stinner13bb71c2010-04-23 21:41:56 +00002537 stdout = stdout.rstrip(b'\n\r')
Victor Stinner5323fb02013-11-19 23:46:06 +01002538 self.assertEqual(stdout.decode('ascii'), ascii(encoded_value))
Victor Stinner13bb71c2010-04-23 21:41:56 +00002539
Victor Stinnerb745a742010-05-18 17:17:23 +00002540 def test_bytes_program(self):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002541 abs_program = os.fsencode(ZERO_RETURN_CMD[0])
2542 args = list(ZERO_RETURN_CMD[1:])
2543 path, program = os.path.split(ZERO_RETURN_CMD[0])
Victor Stinnerb745a742010-05-18 17:17:23 +00002544 program = os.fsencode(program)
2545
2546 # absolute bytes path
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002547 exitcode = subprocess.call([abs_program]+args)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002548 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00002549
Victor Stinner7b3b20a2011-03-03 12:54:05 +00002550 # absolute bytes path as a string
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002551 cmd = b"'%s' %s" % (abs_program, " ".join(args).encode("utf-8"))
Victor Stinner7b3b20a2011-03-03 12:54:05 +00002552 exitcode = subprocess.call(cmd, shell=True)
2553 self.assertEqual(exitcode, 0)
2554
Victor Stinnerb745a742010-05-18 17:17:23 +00002555 # bytes program, unicode PATH
2556 env = os.environ.copy()
2557 env["PATH"] = path
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002558 exitcode = subprocess.call([program]+args, env=env)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002559 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00002560
2561 # bytes program, bytes PATH
2562 envb = os.environb.copy()
2563 envb[b"PATH"] = os.fsencode(path)
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002564 exitcode = subprocess.call([program]+args, env=envb)
Ezio Melottib3aedd42010-11-20 19:04:17 +00002565 self.assertEqual(exitcode, 0)
Victor Stinnerb745a742010-05-18 17:17:23 +00002566
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002567 def test_pipe_cloexec(self):
2568 sleeper = support.findfile("input_reader.py", subdir="subprocessdata")
2569 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2570
2571 p1 = subprocess.Popen([sys.executable, sleeper],
2572 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
2573 stderr=subprocess.PIPE, close_fds=False)
2574
2575 self.addCleanup(p1.communicate, b'')
2576
2577 p2 = subprocess.Popen([sys.executable, fd_status],
2578 stdout=subprocess.PIPE, close_fds=False)
2579
2580 output, error = p2.communicate()
2581 result_fds = set(map(int, output.split(b',')))
2582 unwanted_fds = set([p1.stdin.fileno(), p1.stdout.fileno(),
2583 p1.stderr.fileno()])
2584
2585 self.assertFalse(result_fds & unwanted_fds,
2586 "Expected no fds from %r to be open in child, "
2587 "found %r" %
2588 (unwanted_fds, result_fds & unwanted_fds))
2589
2590 def test_pipe_cloexec_real_tools(self):
2591 qcat = support.findfile("qcat.py", subdir="subprocessdata")
2592 qgrep = support.findfile("qgrep.py", subdir="subprocessdata")
2593
2594 subdata = b'zxcvbn'
2595 data = subdata * 4 + b'\n'
2596
2597 p1 = subprocess.Popen([sys.executable, qcat],
2598 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
2599 close_fds=False)
2600
2601 p2 = subprocess.Popen([sys.executable, qgrep, subdata],
2602 stdin=p1.stdout, stdout=subprocess.PIPE,
2603 close_fds=False)
2604
2605 self.addCleanup(p1.wait)
2606 self.addCleanup(p2.wait)
Gregory P. Smith886455c2012-01-21 22:05:10 -08002607 def kill_p1():
2608 try:
2609 p1.terminate()
2610 except ProcessLookupError:
2611 pass
2612 def kill_p2():
2613 try:
2614 p2.terminate()
2615 except ProcessLookupError:
2616 pass
2617 self.addCleanup(kill_p1)
2618 self.addCleanup(kill_p2)
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002619
2620 p1.stdin.write(data)
2621 p1.stdin.close()
2622
2623 readfiles, ignored1, ignored2 = select.select([p2.stdout], [], [], 10)
2624
2625 self.assertTrue(readfiles, "The child hung")
2626 self.assertEqual(p2.stdout.read(), data)
2627
Victor Stinnerfaa8c132011-01-03 16:36:00 +00002628 p1.stdout.close()
2629 p2.stdout.close()
2630
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002631 def test_close_fds(self):
2632 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2633
2634 fds = os.pipe()
2635 self.addCleanup(os.close, fds[0])
2636 self.addCleanup(os.close, fds[1])
2637
2638 open_fds = set(fds)
Gregory P. Smith8facece2012-01-21 14:01:08 -08002639 # add a bunch more fds
2640 for _ in range(9):
Serhiy Storchaka85c30332015-02-15 13:58:23 +02002641 fd = os.open(os.devnull, os.O_RDONLY)
Gregory P. Smith8facece2012-01-21 14:01:08 -08002642 self.addCleanup(os.close, fd)
2643 open_fds.add(fd)
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002644
Victor Stinnerdaf45552013-08-28 00:53:59 +02002645 for fd in open_fds:
2646 os.set_inheritable(fd, True)
2647
Gregory P. Smith51ee2702010-12-13 07:59:39 +00002648 p = subprocess.Popen([sys.executable, fd_status],
2649 stdout=subprocess.PIPE, close_fds=False)
2650 output, ignored = p.communicate()
2651 remaining_fds = set(map(int, output.split(b',')))
2652
2653 self.assertEqual(remaining_fds & open_fds, open_fds,
2654 "Some fds were closed")
2655
2656 p = subprocess.Popen([sys.executable, fd_status],
2657 stdout=subprocess.PIPE, close_fds=True)
2658 output, ignored = p.communicate()
2659 remaining_fds = set(map(int, output.split(b',')))
2660
2661 self.assertFalse(remaining_fds & open_fds,
2662 "Some fds were left open")
2663 self.assertIn(1, remaining_fds, "Subprocess failed")
2664
Gregory P. Smith8facece2012-01-21 14:01:08 -08002665 # Keep some of the fd's we opened open in the subprocess.
2666 # This tests _posixsubprocess.c's proper handling of fds_to_keep.
2667 fds_to_keep = set(open_fds.pop() for _ in range(8))
2668 p = subprocess.Popen([sys.executable, fd_status],
2669 stdout=subprocess.PIPE, close_fds=True,
izbyshev2d8f0632017-12-19 03:26:49 +07002670 pass_fds=fds_to_keep)
Gregory P. Smith8facece2012-01-21 14:01:08 -08002671 output, ignored = p.communicate()
2672 remaining_fds = set(map(int, output.split(b',')))
2673
izbyshev2d8f0632017-12-19 03:26:49 +07002674 self.assertFalse((remaining_fds - fds_to_keep) & open_fds,
Gregory P. Smith8facece2012-01-21 14:01:08 -08002675 "Some fds not in pass_fds were left open")
2676 self.assertIn(1, remaining_fds, "Subprocess failed")
2677
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002678
Gregory P. Smithd04f6992014-06-01 15:27:28 -07002679 @unittest.skipIf(sys.platform.startswith("freebsd") and
2680 os.stat("/dev").st_dev == os.stat("/dev/fd").st_dev,
2681 "Requires fdescfs mounted on /dev/fd on FreeBSD.")
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002682 def test_close_fds_when_max_fd_is_lowered(self):
2683 """Confirm that issue21618 is fixed (may fail under valgrind)."""
2684 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2685
Gregory P. Smith634aa682014-06-15 17:51:04 -07002686 # This launches the meat of the test in a child process to
2687 # avoid messing with the larger unittest processes maximum
2688 # number of file descriptors.
2689 # This process launches:
2690 # +--> Process that lowers its RLIMIT_NOFILE aftr setting up
2691 # a bunch of high open fds above the new lower rlimit.
2692 # Those are reported via stdout before launching a new
2693 # process with close_fds=False to run the actual test:
2694 # +--> The TEST: This one launches a fd_status.py
2695 # subprocess with close_fds=True so we can find out if
2696 # any of the fds above the lowered rlimit are still open.
2697 p = subprocess.Popen([sys.executable, '-c', textwrap.dedent(
2698 '''
2699 import os, resource, subprocess, sys, textwrap
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002700 open_fds = set()
2701 # Add a bunch more fds to pass down.
Gregory P. Smith8fed4de2014-06-01 15:15:44 -07002702 for _ in range(40):
Serhiy Storchaka85c30332015-02-15 13:58:23 +02002703 fd = os.open(os.devnull, os.O_RDONLY)
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002704 open_fds.add(fd)
2705
2706 # Leave a two pairs of low ones available for use by the
2707 # internal child error pipe and the stdout pipe.
Gregory P. Smith8fed4de2014-06-01 15:15:44 -07002708 # We also leave 10 more open as some Python buildbots run into
2709 # "too many open files" errors during the test if we do not.
2710 for fd in sorted(open_fds)[:14]:
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002711 os.close(fd)
2712 open_fds.remove(fd)
2713
2714 for fd in open_fds:
Gregory P. Smith634aa682014-06-15 17:51:04 -07002715 #self.addCleanup(os.close, fd)
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002716 os.set_inheritable(fd, True)
2717
2718 max_fd_open = max(open_fds)
2719
Gregory P. Smith634aa682014-06-15 17:51:04 -07002720 # Communicate the open_fds to the parent unittest.TestCase process.
2721 print(','.join(map(str, sorted(open_fds))))
2722 sys.stdout.flush()
2723
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002724 rlim_cur, rlim_max = resource.getrlimit(resource.RLIMIT_NOFILE)
2725 try:
Gregory P. Smith8fed4de2014-06-01 15:15:44 -07002726 # 29 is lower than the highest fds we are leaving open.
2727 resource.setrlimit(resource.RLIMIT_NOFILE, (29, rlim_max))
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002728 # Launch a new Python interpreter with our low fd rlim_cur that
2729 # inherits open fds above that limit. It then uses subprocess
2730 # with close_fds=True to get a report of open fds in the child.
2731 # An explicit list of fds to check is passed to fd_status.py as
2732 # letting fd_status rely on its default logic would miss the
2733 # fds above rlim_cur as it normally only checks up to that limit.
Gregory P. Smith634aa682014-06-15 17:51:04 -07002734 subprocess.Popen(
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002735 [sys.executable, '-c',
2736 textwrap.dedent("""
2737 import subprocess, sys
Gregory P. Smith634aa682014-06-15 17:51:04 -07002738 subprocess.Popen([sys.executable, %r] +
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002739 [str(x) for x in range({max_fd})],
Gregory P. Smithffd529c2014-06-01 13:46:54 -07002740 close_fds=True).wait()
Gregory P. Smith634aa682014-06-15 17:51:04 -07002741 """.format(max_fd=max_fd_open+1))],
2742 close_fds=False).wait()
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002743 finally:
2744 resource.setrlimit(resource.RLIMIT_NOFILE, (rlim_cur, rlim_max))
Gregory P. Smith634aa682014-06-15 17:51:04 -07002745 ''' % fd_status)], stdout=subprocess.PIPE)
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002746
2747 output, unused_stderr = p.communicate()
Gregory P. Smith634aa682014-06-15 17:51:04 -07002748 output_lines = output.splitlines()
2749 self.assertEqual(len(output_lines), 2,
Gregory P. Smith9204e092014-06-15 20:16:01 -07002750 msg="expected exactly two lines of output:\n%r" % output)
Gregory P. Smith634aa682014-06-15 17:51:04 -07002751 opened_fds = set(map(int, output_lines[0].strip().split(b',')))
2752 remaining_fds = set(map(int, output_lines[1].strip().split(b',')))
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002753
Gregory P. Smith634aa682014-06-15 17:51:04 -07002754 self.assertFalse(remaining_fds & opened_fds,
Gregory P. Smithd4dcb702014-06-01 13:18:28 -07002755 msg="Some fds were left open.")
2756
2757
Victor Stinner88701e22011-06-01 13:13:04 +02002758 # Mac OS X Tiger (10.4) has a kernel bug: sometimes, the file
2759 # descriptor of a pipe closed in the parent process is valid in the
2760 # child process according to fstat(), but the mode of the file
2761 # descriptor is invalid, and read or write raise an error.
2762 @support.requires_mac_ver(10, 5)
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00002763 def test_pass_fds(self):
2764 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2765
2766 open_fds = set()
2767
2768 for x in range(5):
2769 fds = os.pipe()
2770 self.addCleanup(os.close, fds[0])
2771 self.addCleanup(os.close, fds[1])
Victor Stinnerdaf45552013-08-28 00:53:59 +02002772 os.set_inheritable(fds[0], True)
2773 os.set_inheritable(fds[1], True)
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00002774 open_fds.update(fds)
2775
2776 for fd in open_fds:
2777 p = subprocess.Popen([sys.executable, fd_status],
2778 stdout=subprocess.PIPE, close_fds=True,
2779 pass_fds=(fd, ))
2780 output, ignored = p.communicate()
2781
2782 remaining_fds = set(map(int, output.split(b',')))
2783 to_be_closed = open_fds - {fd}
2784
2785 self.assertIn(fd, remaining_fds, "fd to be passed not passed")
2786 self.assertFalse(remaining_fds & to_be_closed,
2787 "fd to be closed passed")
2788
2789 # pass_fds overrides close_fds with a warning.
2790 with self.assertWarns(RuntimeWarning) as context:
2791 self.assertFalse(subprocess.call(
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002792 ZERO_RETURN_CMD,
Gregory P. Smith8edd99d2010-12-14 13:43:30 +00002793 close_fds=False, pass_fds=(fd, )))
2794 self.assertIn('overriding close_fds', str(context.warning))
2795
Victor Stinnerdaf45552013-08-28 00:53:59 +02002796 def test_pass_fds_inheritable(self):
Victor Stinnerf6fa22e2013-09-01 10:22:41 +02002797 script = support.findfile("fd_status.py", subdir="subprocessdata")
Victor Stinnerdaf45552013-08-28 00:53:59 +02002798
2799 inheritable, non_inheritable = os.pipe()
2800 self.addCleanup(os.close, inheritable)
2801 self.addCleanup(os.close, non_inheritable)
2802 os.set_inheritable(inheritable, True)
2803 os.set_inheritable(non_inheritable, False)
2804 pass_fds = (inheritable, non_inheritable)
2805 args = [sys.executable, script]
2806 args += list(map(str, pass_fds))
2807
2808 p = subprocess.Popen(args,
2809 stdout=subprocess.PIPE, close_fds=True,
2810 pass_fds=pass_fds)
2811 output, ignored = p.communicate()
2812 fds = set(map(int, output.split(b',')))
2813
2814 # the inheritable file descriptor must be inherited, so its inheritable
2815 # flag must be set in the child process after fork() and before exec()
Victor Stinnerf6fa22e2013-09-01 10:22:41 +02002816 self.assertEqual(fds, set(pass_fds), "output=%a" % output)
Victor Stinnerdaf45552013-08-28 00:53:59 +02002817
2818 # inheritable flag must not be changed in the parent process
2819 self.assertEqual(os.get_inheritable(inheritable), True)
2820 self.assertEqual(os.get_inheritable(non_inheritable), False)
2821
Gregory P. Smithce344102018-09-10 17:46:22 -07002822
2823 # bpo-32270: Ensure that descriptors specified in pass_fds
2824 # are inherited even if they are used in redirections.
2825 # Contributed by @izbyshev.
2826 def test_pass_fds_redirected(self):
2827 """Regression test for https://bugs.python.org/issue32270."""
2828 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2829 pass_fds = []
2830 for _ in range(2):
2831 fd = os.open(os.devnull, os.O_RDWR)
2832 self.addCleanup(os.close, fd)
2833 pass_fds.append(fd)
2834
2835 stdout_r, stdout_w = os.pipe()
2836 self.addCleanup(os.close, stdout_r)
2837 self.addCleanup(os.close, stdout_w)
2838 pass_fds.insert(1, stdout_w)
2839
2840 with subprocess.Popen([sys.executable, fd_status],
2841 stdin=pass_fds[0],
2842 stdout=pass_fds[1],
2843 stderr=pass_fds[2],
2844 close_fds=True,
2845 pass_fds=pass_fds):
2846 output = os.read(stdout_r, 1024)
2847 fds = {int(num) for num in output.split(b',')}
2848
2849 self.assertEqual(fds, {0, 1, 2} | frozenset(pass_fds), f"output={output!a}")
2850
2851
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04002852 def test_stdout_stdin_are_single_inout_fd(self):
2853 with io.open(os.devnull, "r+") as inout:
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002854 p = subprocess.Popen(ZERO_RETURN_CMD,
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04002855 stdout=inout, stdin=inout)
2856 p.wait()
2857
2858 def test_stdout_stderr_are_single_inout_fd(self):
2859 with io.open(os.devnull, "r+") as inout:
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002860 p = subprocess.Popen(ZERO_RETURN_CMD,
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04002861 stdout=inout, stderr=inout)
2862 p.wait()
2863
2864 def test_stderr_stdin_are_single_inout_fd(self):
2865 with io.open(os.devnull, "r+") as inout:
Gregory P. Smith67b93f82019-10-12 16:35:53 -07002866 p = subprocess.Popen(ZERO_RETURN_CMD,
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04002867 stderr=inout, stdin=inout)
2868 p.wait()
2869
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00002870 def test_wait_when_sigchild_ignored(self):
2871 # NOTE: sigchild_ignore.py may not be an effective test on all OSes.
2872 sigchild_ignore = support.findfile("sigchild_ignore.py",
2873 subdir="subprocessdata")
2874 p = subprocess.Popen([sys.executable, sigchild_ignore],
2875 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
2876 stdout, stderr = p.communicate()
2877 self.assertEqual(0, p.returncode, "sigchild_ignore.py exited"
Gregory P. Smitha80f4fb2010-12-14 15:23:02 +00002878 " non-zero with this error:\n%s" %
Marc-André Lemburg8f36af72011-02-25 15:42:01 +00002879 stderr.decode('utf-8'))
Gregory P. Smithe85db2b2010-12-14 14:38:00 +00002880
Antoine Pitrou7b98d022011-03-19 17:04:13 +01002881 def test_select_unbuffered(self):
2882 # Issue #11459: bufsize=0 should really set the pipes as
2883 # unbuffered (and therefore let select() work properly).
2884 select = support.import_module("select")
2885 p = subprocess.Popen([sys.executable, "-c",
2886 'import sys;'
2887 'sys.stdout.write("apple")'],
2888 stdout=subprocess.PIPE,
2889 bufsize=0)
2890 f = p.stdout
Ross Lagerwall17ace7a2011-03-26 21:21:46 +02002891 self.addCleanup(f.close)
Antoine Pitrou7b98d022011-03-19 17:04:13 +01002892 try:
2893 self.assertEqual(f.read(4), b"appl")
2894 self.assertIn(f, select.select([f], [], [], 0.0)[0])
2895 finally:
2896 p.wait()
2897
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002898 def test_zombie_fast_process_del(self):
2899 # Issue #12650: on Unix, if Popen.__del__() was called before the
2900 # process exited, it wouldn't be added to subprocess._active, and would
2901 # remain a zombie.
2902 # spawn a Popen, and delete its reference before it exits
2903 p = subprocess.Popen([sys.executable, "-c",
2904 'import sys, time;'
2905 'time.sleep(0.2)'],
2906 stdout=subprocess.PIPE,
2907 stderr=subprocess.PIPE)
Nadeem Vawda0d7cda32011-08-19 05:12:01 +02002908 self.addCleanup(p.stdout.close)
2909 self.addCleanup(p.stderr.close)
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002910 ident = id(p)
2911 pid = p.pid
Victor Stinner5a48e212016-05-20 12:11:15 +02002912 with support.check_warnings(('', ResourceWarning)):
2913 p = None
2914
Ruslan Kuprieiev042821a2019-06-28 19:12:16 +03002915 if mswindows:
2916 # subprocess._active is not used on Windows and is set to None.
2917 self.assertIsNone(subprocess._active)
2918 else:
2919 # check that p is in the active processes list
2920 self.assertIn(ident, [id(o) for o in subprocess._active])
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002921
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002922 def test_leak_fast_process_del_killed(self):
2923 # Issue #12650: on Unix, if Popen.__del__() was called before the
2924 # process exited, and the process got killed by a signal, it would never
2925 # be removed from subprocess._active, which triggered a FD and memory
2926 # leak.
2927 # spawn a Popen, delete its reference and kill it
2928 p = subprocess.Popen([sys.executable, "-c",
2929 'import time;'
2930 'time.sleep(3)'],
2931 stdout=subprocess.PIPE,
2932 stderr=subprocess.PIPE)
Nadeem Vawda0d7cda32011-08-19 05:12:01 +02002933 self.addCleanup(p.stdout.close)
2934 self.addCleanup(p.stderr.close)
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002935 ident = id(p)
2936 pid = p.pid
Victor Stinner5a48e212016-05-20 12:11:15 +02002937 with support.check_warnings(('', ResourceWarning)):
2938 p = None
2939
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002940 os.kill(pid, signal.SIGKILL)
Ruslan Kuprieiev042821a2019-06-28 19:12:16 +03002941 if mswindows:
2942 # subprocess._active is not used on Windows and is set to None.
2943 self.assertIsNone(subprocess._active)
2944 else:
2945 # check that p is in the active processes list
2946 self.assertIn(ident, [id(o) for o in subprocess._active])
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002947
2948 # let some time for the process to exit, and create a new Popen: this
2949 # should trigger the wait() of p
2950 time.sleep(0.2)
Victor Stinnerb31206a2018-01-25 19:06:05 +01002951 with self.assertRaises(OSError):
Victor Stinner9a83f652017-08-21 23:51:31 +02002952 with subprocess.Popen(NONEXISTING_CMD,
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002953 stdout=subprocess.PIPE,
2954 stderr=subprocess.PIPE) as proc:
2955 pass
2956 # p should have been wait()ed on, and removed from the _active list
2957 self.assertRaises(OSError, os.waitpid, pid, 0)
Ruslan Kuprieiev042821a2019-06-28 19:12:16 +03002958 if mswindows:
2959 # subprocess._active is not used on Windows and is set to None.
2960 self.assertIsNone(subprocess._active)
2961 else:
2962 self.assertNotIn(ident, [id(o) for o in subprocess._active])
Charles-François Natali134a8ba2011-08-18 18:49:39 +02002963
Charles-François Natali249cdc32013-08-25 18:24:45 +02002964 def test_close_fds_after_preexec(self):
2965 fd_status = support.findfile("fd_status.py", subdir="subprocessdata")
2966
2967 # this FD is used as dup2() target by preexec_fn, and should be closed
2968 # in the child process
2969 fd = os.dup(1)
2970 self.addCleanup(os.close, fd)
2971
2972 p = subprocess.Popen([sys.executable, fd_status],
2973 stdout=subprocess.PIPE, close_fds=True,
2974 preexec_fn=lambda: os.dup2(1, fd))
2975 output, ignored = p.communicate()
2976
2977 remaining_fds = set(map(int, output.split(b',')))
2978
2979 self.assertNotIn(fd, remaining_fds)
2980
Victor Stinner8f437aa2014-10-05 17:25:19 +02002981 @support.cpython_only
2982 def test_fork_exec(self):
2983 # Issue #22290: fork_exec() must not crash on memory allocation failure
2984 # or other errors
2985 import _posixsubprocess
2986 gc_enabled = gc.isenabled()
2987 try:
2988 # Use a preexec function and enable the garbage collector
2989 # to force fork_exec() to re-enable the garbage collector
2990 # on error.
2991 func = lambda: None
2992 gc.enable()
2993
Victor Stinner8f437aa2014-10-05 17:25:19 +02002994 for args, exe_list, cwd, env_list in (
2995 (123, [b"exe"], None, [b"env"]),
2996 ([b"arg"], 123, None, [b"env"]),
2997 ([b"arg"], [b"exe"], 123, [b"env"]),
2998 ([b"arg"], [b"exe"], None, 123),
2999 ):
Patrick McLean2b2ead72019-09-12 10:15:44 -07003000 with self.assertRaises(TypeError) as err:
Victor Stinner8f437aa2014-10-05 17:25:19 +02003001 _posixsubprocess.fork_exec(
3002 args, exe_list,
Serhiy Storchaka66bffd12017-04-19 21:12:46 +03003003 True, (), cwd, env_list,
Victor Stinner8f437aa2014-10-05 17:25:19 +02003004 -1, -1, -1, -1,
3005 1, 2, 3, 4,
Patrick McLean2b2ead72019-09-12 10:15:44 -07003006 True, True,
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07003007 False, [], 0, -1,
Patrick McLean2b2ead72019-09-12 10:15:44 -07003008 func)
3009 # Attempt to prevent
3010 # "TypeError: fork_exec() takes exactly N arguments (M given)"
3011 # from passing the test. More refactoring to have us start
3012 # with a valid *args list, confirm a good call with that works
3013 # before mutating it in various ways to ensure that bad calls
3014 # with individual arg type errors raise a typeerror would be
3015 # ideal. Saving that for a future PR...
3016 self.assertNotIn('takes exactly', str(err.exception))
Victor Stinner8f437aa2014-10-05 17:25:19 +02003017 finally:
3018 if not gc_enabled:
3019 gc.disable()
3020
Gregory P. Smithd0a5b1c2015-11-15 21:15:26 -08003021 @support.cpython_only
3022 def test_fork_exec_sorted_fd_sanity_check(self):
3023 # Issue #23564: sanity check the fork_exec() fds_to_keep sanity check.
3024 import _posixsubprocess
Serhiy Storchaka66bffd12017-04-19 21:12:46 +03003025 class BadInt:
3026 first = True
3027 def __init__(self, value):
3028 self.value = value
3029 def __int__(self):
3030 if self.first:
3031 self.first = False
3032 return self.value
3033 raise ValueError
3034
Gregory P. Smithd0a5b1c2015-11-15 21:15:26 -08003035 gc_enabled = gc.isenabled()
3036 try:
3037 gc.enable()
3038
3039 for fds_to_keep in (
3040 (-1, 2, 3, 4, 5), # Negative number.
3041 ('str', 4), # Not an int.
3042 (18, 23, 42, 2**63), # Out of range.
3043 (5, 4), # Not sorted.
3044 (6, 7, 7, 8), # Duplicate.
Serhiy Storchaka66bffd12017-04-19 21:12:46 +03003045 (BadInt(1), BadInt(2)),
Gregory P. Smithd0a5b1c2015-11-15 21:15:26 -08003046 ):
3047 with self.assertRaises(
3048 ValueError,
3049 msg='fds_to_keep={}'.format(fds_to_keep)) as c:
3050 _posixsubprocess.fork_exec(
3051 [b"false"], [b"false"],
3052 True, fds_to_keep, None, [b"env"],
3053 -1, -1, -1, -1,
3054 1, 2, 3, 4,
Patrick McLean2b2ead72019-09-12 10:15:44 -07003055 True, True,
Gregory P. Smithf3751ef2019-10-12 13:24:56 -07003056 None, None, None, -1,
Patrick McLean2b2ead72019-09-12 10:15:44 -07003057 None)
Gregory P. Smithd0a5b1c2015-11-15 21:15:26 -08003058 self.assertIn('fds_to_keep', str(c.exception))
3059 finally:
3060 if not gc_enabled:
3061 gc.disable()
Victor Stinner8f437aa2014-10-05 17:25:19 +02003062
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)2daf8e72016-06-05 02:57:47 +00003063 def test_communicate_BrokenPipeError_stdin_close(self):
3064 # By not setting stdout or stderr or a timeout we force the fast path
3065 # that just calls _stdin_write() internally due to our mock.
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003066 proc = subprocess.Popen(ZERO_RETURN_CMD)
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)2daf8e72016-06-05 02:57:47 +00003067 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin:
3068 mock_proc_stdin.close.side_effect = BrokenPipeError
3069 proc.communicate() # Should swallow BrokenPipeError from close.
3070 mock_proc_stdin.close.assert_called_with()
3071
3072 def test_communicate_BrokenPipeError_stdin_write(self):
3073 # By not setting stdout or stderr or a timeout we force the fast path
3074 # that just calls _stdin_write() internally due to our mock.
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003075 proc = subprocess.Popen(ZERO_RETURN_CMD)
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)2daf8e72016-06-05 02:57:47 +00003076 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin:
3077 mock_proc_stdin.write.side_effect = BrokenPipeError
3078 proc.communicate(b'stuff') # Should swallow the BrokenPipeError.
3079 mock_proc_stdin.write.assert_called_once_with(b'stuff')
3080 mock_proc_stdin.close.assert_called_once_with()
3081
3082 def test_communicate_BrokenPipeError_stdin_flush(self):
3083 # Setting stdin and stdout forces the ._communicate() code path.
3084 # python -h exits faster than python -c pass (but spams stdout).
3085 proc = subprocess.Popen([sys.executable, '-h'],
3086 stdin=subprocess.PIPE,
3087 stdout=subprocess.PIPE)
3088 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin, \
3089 open(os.devnull, 'wb') as dev_null:
3090 mock_proc_stdin.flush.side_effect = BrokenPipeError
3091 # because _communicate registers a selector using proc.stdin...
3092 mock_proc_stdin.fileno.return_value = dev_null.fileno()
3093 # _communicate() should swallow BrokenPipeError from flush.
3094 proc.communicate(b'stuff')
3095 mock_proc_stdin.flush.assert_called_once_with()
3096
3097 def test_communicate_BrokenPipeError_stdin_close_with_timeout(self):
3098 # Setting stdin and stdout forces the ._communicate() code path.
3099 # python -h exits faster than python -c pass (but spams stdout).
3100 proc = subprocess.Popen([sys.executable, '-h'],
3101 stdin=subprocess.PIPE,
3102 stdout=subprocess.PIPE)
3103 with proc, mock.patch.object(proc, 'stdin') as mock_proc_stdin:
3104 mock_proc_stdin.close.side_effect = BrokenPipeError
3105 # _communicate() should swallow BrokenPipeError from close.
3106 proc.communicate(timeout=999)
3107 mock_proc_stdin.close.assert_called_once_with()
3108
Victor Stinner7b7c6dc2017-08-10 12:37:39 +02003109 @unittest.skipUnless(_testcapi is not None
3110 and hasattr(_testcapi, 'W_STOPCODE'),
3111 'need _testcapi.W_STOPCODE')
3112 def test_stopped(self):
Gregory P. Smith50e16e32017-01-22 17:28:38 -08003113 """Test wait() behavior when waitpid returns WIFSTOPPED; issue29335."""
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003114 args = ZERO_RETURN_CMD
Victor Stinner7b7c6dc2017-08-10 12:37:39 +02003115 proc = subprocess.Popen(args)
Victor Stinnercdee3f12017-06-26 17:23:03 +02003116
Victor Stinner7b7c6dc2017-08-10 12:37:39 +02003117 # Wait until the real process completes to avoid zombie process
3118 pid = proc.pid
3119 pid, status = os.waitpid(pid, 0)
3120 self.assertEqual(status, 0)
Victor Stinnercdee3f12017-06-26 17:23:03 +02003121
Victor Stinner7b7c6dc2017-08-10 12:37:39 +02003122 status = _testcapi.W_STOPCODE(3)
3123 with mock.patch('subprocess.os.waitpid', return_value=(pid, status)):
3124 returncode = proc.wait()
Victor Stinnercdee3f12017-06-26 17:23:03 +02003125
Victor Stinner7b7c6dc2017-08-10 12:37:39 +02003126 self.assertEqual(returncode, -3)
Gregory P. Smith50e16e32017-01-22 17:28:38 -08003127
Victor Stinnere85a3052020-01-15 17:38:55 +01003128 def test_send_signal_race(self):
3129 # bpo-38630: send_signal() must poll the process exit status to reduce
3130 # the risk of sending the signal to the wrong process.
3131 proc = subprocess.Popen(ZERO_RETURN_CMD)
3132
3133 # wait until the process completes without using the Popen APIs.
3134 pid, status = os.waitpid(proc.pid, 0)
3135 self.assertEqual(pid, proc.pid)
3136 self.assertTrue(os.WIFEXITED(status), status)
3137 self.assertEqual(os.WEXITSTATUS(status), 0)
3138
3139 # returncode is still None but the process completed.
3140 self.assertIsNone(proc.returncode)
3141
3142 with mock.patch("os.kill") as mock_kill:
3143 proc.send_signal(signal.SIGTERM)
3144
3145 # send_signal() didn't call os.kill() since the process already
3146 # completed.
3147 mock_kill.assert_not_called()
3148
3149 # Don't check the returncode value: the test reads the exit status,
3150 # so Popen failed to read it and uses a default returncode instead.
3151 self.assertIsNotNone(proc.returncode)
3152
Alex Rebertd3ae95e2020-01-22 18:28:31 -05003153 def test_communicate_repeated_call_after_stdout_close(self):
3154 proc = subprocess.Popen([sys.executable, '-c',
3155 'import os, time; os.close(1), time.sleep(2)'],
3156 stdout=subprocess.PIPE)
3157 while True:
3158 try:
3159 proc.communicate(timeout=0.1)
3160 return
3161 except subprocess.TimeoutExpired:
3162 pass
3163
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003164
Victor Stinner937ee9e2018-06-26 02:11:06 +02003165@unittest.skipUnless(mswindows, "Windows specific tests")
Florent Xiclunac049d872010-03-27 22:47:23 +00003166class Win32ProcessTestCase(BaseTestCase):
Florent Xiclunaf0cbd822010-03-04 21:50:56 +00003167
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003168 def test_startupinfo(self):
3169 # startupinfo argument
3170 # We uses hardcoded constants, because we do not want to
3171 # depend on win32all.
3172 STARTF_USESHOWWINDOW = 1
3173 SW_MAXIMIZE = 3
3174 startupinfo = subprocess.STARTUPINFO()
3175 startupinfo.dwFlags = STARTF_USESHOWWINDOW
3176 startupinfo.wShowWindow = SW_MAXIMIZE
3177 # Since Python is a console process, it won't be affected
3178 # by wShowWindow, but the argument should be silently
3179 # ignored
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003180 subprocess.call(ZERO_RETURN_CMD,
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003181 startupinfo=startupinfo)
3182
Subhendu Ghoshae160bb2017-02-25 20:29:05 +05303183 def test_startupinfo_keywords(self):
3184 # startupinfo argument
3185 # We use hardcoded constants, because we do not want to
3186 # depend on win32all.
3187 STARTF_USERSHOWWINDOW = 1
3188 SW_MAXIMIZE = 3
3189 startupinfo = subprocess.STARTUPINFO(
3190 dwFlags=STARTF_USERSHOWWINDOW,
3191 wShowWindow=SW_MAXIMIZE
3192 )
3193 # Since Python is a console process, it won't be affected
3194 # by wShowWindow, but the argument should be silently
3195 # ignored
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003196 subprocess.call(ZERO_RETURN_CMD,
Subhendu Ghoshae160bb2017-02-25 20:29:05 +05303197 startupinfo=startupinfo)
3198
Victor Stinner483422f2018-07-05 22:54:17 +02003199 def test_startupinfo_copy(self):
3200 # bpo-34044: Popen must not modify input STARTUPINFO structure
3201 startupinfo = subprocess.STARTUPINFO()
3202 startupinfo.dwFlags = subprocess.STARTF_USESHOWWINDOW
3203 startupinfo.wShowWindow = subprocess.SW_HIDE
3204
3205 # Call Popen() twice with the same startupinfo object to make sure
3206 # that it's not modified
3207 for _ in range(2):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003208 cmd = ZERO_RETURN_CMD
Victor Stinner483422f2018-07-05 22:54:17 +02003209 with open(os.devnull, 'w') as null:
3210 proc = subprocess.Popen(cmd,
3211 stdout=null,
3212 stderr=subprocess.STDOUT,
3213 startupinfo=startupinfo)
3214 with proc:
3215 proc.communicate()
3216 self.assertEqual(proc.returncode, 0)
3217
3218 self.assertEqual(startupinfo.dwFlags,
3219 subprocess.STARTF_USESHOWWINDOW)
3220 self.assertIsNone(startupinfo.hStdInput)
3221 self.assertIsNone(startupinfo.hStdOutput)
3222 self.assertIsNone(startupinfo.hStdError)
3223 self.assertEqual(startupinfo.wShowWindow, subprocess.SW_HIDE)
3224 self.assertEqual(startupinfo.lpAttributeList, {"handle_list": []})
3225
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003226 def test_creationflags(self):
3227 # creationflags argument
3228 CREATE_NEW_CONSOLE = 16
3229 sys.stderr.write(" a DOS box should flash briefly ...\n")
3230 subprocess.call(sys.executable +
3231 ' -c "import time; time.sleep(0.25)"',
3232 creationflags=CREATE_NEW_CONSOLE)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003233
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003234 def test_invalid_args(self):
3235 # invalid arguments should raise ValueError
3236 self.assertRaises(ValueError, subprocess.call,
3237 [sys.executable, "-c",
3238 "import sys; sys.exit(47)"],
3239 preexec_fn=lambda: 1)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003240
Oren Milman0b3a87e2017-09-14 22:30:28 +03003241 @support.cpython_only
3242 def test_issue31471(self):
3243 # There shouldn't be an assertion failure in Popen() in case the env
3244 # argument has a bad keys() method.
3245 class BadEnv(dict):
3246 keys = None
3247 with self.assertRaises(TypeError):
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003248 subprocess.Popen(ZERO_RETURN_CMD, env=BadEnv())
Oren Milman0b3a87e2017-09-14 22:30:28 +03003249
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003250 def test_close_fds(self):
3251 # close file descriptors
3252 rc = subprocess.call([sys.executable, "-c",
3253 "import sys; sys.exit(47)"],
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003254 close_fds=True)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003255 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003256
Segev Finerb2a60832017-12-18 11:28:19 +02003257 def test_close_fds_with_stdio(self):
3258 import msvcrt
3259
3260 fds = os.pipe()
3261 self.addCleanup(os.close, fds[0])
3262 self.addCleanup(os.close, fds[1])
3263
3264 handles = []
3265 for fd in fds:
3266 os.set_inheritable(fd, True)
3267 handles.append(msvcrt.get_osfhandle(fd))
3268
3269 p = subprocess.Popen([sys.executable, "-c",
3270 "import msvcrt; print(msvcrt.open_osfhandle({}, 0))".format(handles[0])],
3271 stdout=subprocess.PIPE, close_fds=False)
3272 stdout, stderr = p.communicate()
3273 self.assertEqual(p.returncode, 0)
3274 int(stdout.strip()) # Check that stdout is an integer
3275
3276 p = subprocess.Popen([sys.executable, "-c",
3277 "import msvcrt; print(msvcrt.open_osfhandle({}, 0))".format(handles[0])],
3278 stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True)
3279 stdout, stderr = p.communicate()
3280 self.assertEqual(p.returncode, 1)
3281 self.assertIn(b"OSError", stderr)
3282
3283 # The same as the previous call, but with an empty handle_list
3284 handle_list = []
3285 startupinfo = subprocess.STARTUPINFO()
3286 startupinfo.lpAttributeList = {"handle_list": handle_list}
3287 p = subprocess.Popen([sys.executable, "-c",
3288 "import msvcrt; print(msvcrt.open_osfhandle({}, 0))".format(handles[0])],
3289 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
3290 startupinfo=startupinfo, close_fds=True)
3291 stdout, stderr = p.communicate()
3292 self.assertEqual(p.returncode, 1)
3293 self.assertIn(b"OSError", stderr)
3294
3295 # Check for a warning due to using handle_list and close_fds=False
3296 with support.check_warnings((".*overriding close_fds", RuntimeWarning)):
3297 startupinfo = subprocess.STARTUPINFO()
3298 startupinfo.lpAttributeList = {"handle_list": handles[:]}
3299 p = subprocess.Popen([sys.executable, "-c",
3300 "import msvcrt; print(msvcrt.open_osfhandle({}, 0))".format(handles[0])],
3301 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
3302 startupinfo=startupinfo, close_fds=False)
3303 stdout, stderr = p.communicate()
3304 self.assertEqual(p.returncode, 0)
3305
3306 def test_empty_attribute_list(self):
3307 startupinfo = subprocess.STARTUPINFO()
3308 startupinfo.lpAttributeList = {}
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003309 subprocess.call(ZERO_RETURN_CMD,
Segev Finerb2a60832017-12-18 11:28:19 +02003310 startupinfo=startupinfo)
3311
3312 def test_empty_handle_list(self):
3313 startupinfo = subprocess.STARTUPINFO()
3314 startupinfo.lpAttributeList = {"handle_list": []}
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003315 subprocess.call(ZERO_RETURN_CMD,
Segev Finerb2a60832017-12-18 11:28:19 +02003316 startupinfo=startupinfo)
3317
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003318 def test_shell_sequence(self):
3319 # Run command through the shell (sequence)
3320 newenv = os.environ.copy()
3321 newenv["FRUIT"] = "physalis"
3322 p = subprocess.Popen(["set"], shell=1,
3323 stdout=subprocess.PIPE,
3324 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02003325 with p:
3326 self.assertIn(b"physalis", p.stdout.read())
Guido van Rossume7ba4952007-06-06 23:52:48 +00003327
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003328 def test_shell_string(self):
3329 # Run command through the shell (string)
3330 newenv = os.environ.copy()
3331 newenv["FRUIT"] = "physalis"
3332 p = subprocess.Popen("set", shell=1,
3333 stdout=subprocess.PIPE,
3334 env=newenv)
Victor Stinner7438c612016-05-20 12:43:15 +02003335 with p:
3336 self.assertIn(b"physalis", p.stdout.read())
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003337
Steve Dower050acae2016-09-06 20:16:17 -07003338 def test_shell_encodings(self):
3339 # Run command through the shell (string)
3340 for enc in ['ansi', 'oem']:
3341 newenv = os.environ.copy()
3342 newenv["FRUIT"] = "physalis"
3343 p = subprocess.Popen("set", shell=1,
3344 stdout=subprocess.PIPE,
3345 env=newenv,
3346 encoding=enc)
3347 with p:
3348 self.assertIn("physalis", p.stdout.read(), enc)
3349
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003350 def test_call_string(self):
3351 # call() function with string argument on Windows
3352 rc = subprocess.call(sys.executable +
3353 ' -c "import sys; sys.exit(47)"')
3354 self.assertEqual(rc, 47)
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003355
Florent Xicluna4886d242010-03-08 13:27:26 +00003356 def _kill_process(self, method, *args):
3357 # Some win32 buildbot raises EOFError if stdin is inherited
Antoine Pitroua4024e22010-09-24 18:57:01 +00003358 p = subprocess.Popen([sys.executable, "-c", """if 1:
3359 import sys, time
3360 sys.stdout.write('x\\n')
3361 sys.stdout.flush()
3362 time.sleep(30)
3363 """],
3364 stdin=subprocess.PIPE,
3365 stdout=subprocess.PIPE,
3366 stderr=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +02003367 with p:
3368 # Wait for the interpreter to be completely initialized before
3369 # sending any signal.
3370 p.stdout.read(1)
3371 getattr(p, method)(*args)
3372 _, stderr = p.communicate()
Victor Stinner6cac1132019-12-08 08:38:16 +01003373 self.assertEqual(stderr, b'')
Victor Stinner7438c612016-05-20 12:43:15 +02003374 returncode = p.wait()
Florent Xicluna4886d242010-03-08 13:27:26 +00003375 self.assertNotEqual(returncode, 0)
3376
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01003377 def _kill_dead_process(self, method, *args):
3378 p = subprocess.Popen([sys.executable, "-c", """if 1:
3379 import sys, time
3380 sys.stdout.write('x\\n')
3381 sys.stdout.flush()
3382 sys.exit(42)
3383 """],
3384 stdin=subprocess.PIPE,
3385 stdout=subprocess.PIPE,
3386 stderr=subprocess.PIPE)
Victor Stinner7438c612016-05-20 12:43:15 +02003387 with p:
3388 # Wait for the interpreter to be completely initialized before
3389 # sending any signal.
3390 p.stdout.read(1)
3391 # The process should end after this
3392 time.sleep(1)
3393 # This shouldn't raise even though the child is now dead
3394 getattr(p, method)(*args)
3395 _, stderr = p.communicate()
Victor Stinner6cac1132019-12-08 08:38:16 +01003396 self.assertEqual(stderr, b'')
Victor Stinner7438c612016-05-20 12:43:15 +02003397 rc = p.wait()
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01003398 self.assertEqual(rc, 42)
3399
Florent Xicluna4886d242010-03-08 13:27:26 +00003400 def test_send_signal(self):
3401 self._kill_process('send_signal', signal.SIGTERM)
Christian Heimesa342c012008-04-20 21:01:16 +00003402
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003403 def test_kill(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00003404 self._kill_process('kill')
Christian Heimesa342c012008-04-20 21:01:16 +00003405
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003406 def test_terminate(self):
Florent Xicluna4886d242010-03-08 13:27:26 +00003407 self._kill_process('terminate')
Christian Heimesa342c012008-04-20 21:01:16 +00003408
Antoine Pitrou1f9a8352012-03-11 19:29:12 +01003409 def test_send_signal_dead(self):
3410 self._kill_dead_process('send_signal', signal.SIGTERM)
3411
3412 def test_kill_dead(self):
3413 self._kill_dead_process('kill')
3414
3415 def test_terminate_dead(self):
3416 self._kill_dead_process('terminate')
3417
Martin Panter23172bd2016-04-16 11:28:10 +00003418class MiscTests(unittest.TestCase):
Gregory P. Smithf4d644f2018-01-29 21:27:39 -08003419
3420 class RecordingPopen(subprocess.Popen):
3421 """A Popen that saves a reference to each instance for testing."""
3422 instances_created = []
3423
3424 def __init__(self, *args, **kwargs):
3425 super().__init__(*args, **kwargs)
3426 self.instances_created.append(self)
3427
3428 @mock.patch.object(subprocess.Popen, "_communicate")
3429 def _test_keyboardinterrupt_no_kill(self, popener, mock__communicate,
3430 **kwargs):
3431 """Fake a SIGINT happening during Popen._communicate() and ._wait().
3432
3433 This avoids the need to actually try and get test environments to send
3434 and receive signals reliably across platforms. The net effect of a ^C
3435 happening during a blocking subprocess execution which we want to clean
3436 up from is a KeyboardInterrupt coming out of communicate() or wait().
3437 """
3438
3439 mock__communicate.side_effect = KeyboardInterrupt
3440 try:
3441 with mock.patch.object(subprocess.Popen, "_wait") as mock__wait:
3442 # We patch out _wait() as no signal was involved so the
3443 # child process isn't actually going to exit rapidly.
3444 mock__wait.side_effect = KeyboardInterrupt
3445 with mock.patch.object(subprocess, "Popen",
3446 self.RecordingPopen):
3447 with self.assertRaises(KeyboardInterrupt):
3448 popener([sys.executable, "-c",
3449 "import time\ntime.sleep(9)\nimport sys\n"
3450 "sys.stderr.write('\\n!runaway child!\\n')"],
3451 stdout=subprocess.DEVNULL, **kwargs)
3452 for call in mock__wait.call_args_list[1:]:
3453 self.assertNotEqual(
3454 call, mock.call(timeout=None),
3455 "no open-ended wait() after the first allowed: "
3456 f"{mock__wait.call_args_list}")
3457 sigint_calls = []
3458 for call in mock__wait.call_args_list:
3459 if call == mock.call(timeout=0.25): # from Popen.__init__
3460 sigint_calls.append(call)
3461 self.assertLessEqual(mock__wait.call_count, 2,
3462 msg=mock__wait.call_args_list)
3463 self.assertEqual(len(sigint_calls), 1,
3464 msg=mock__wait.call_args_list)
3465 finally:
3466 # cleanup the forgotten (due to our mocks) child process
3467 process = self.RecordingPopen.instances_created.pop()
3468 process.kill()
3469 process.wait()
3470 self.assertEqual([], self.RecordingPopen.instances_created)
3471
3472 def test_call_keyboardinterrupt_no_kill(self):
3473 self._test_keyboardinterrupt_no_kill(subprocess.call, timeout=6.282)
3474
3475 def test_run_keyboardinterrupt_no_kill(self):
3476 self._test_keyboardinterrupt_no_kill(subprocess.run, timeout=6.282)
3477
3478 def test_context_manager_keyboardinterrupt_no_kill(self):
3479 def popen_via_context_manager(*args, **kwargs):
3480 with subprocess.Popen(*args, **kwargs) as unused_process:
3481 raise KeyboardInterrupt # Test how __exit__ handles ^C.
3482 self._test_keyboardinterrupt_no_kill(popen_via_context_manager)
3483
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003484 def test_getoutput(self):
3485 self.assertEqual(subprocess.getoutput('echo xyzzy'), 'xyzzy')
3486 self.assertEqual(subprocess.getstatusoutput('echo xyzzy'),
3487 (0, 'xyzzy'))
Brett Cannona23810f2008-05-26 19:04:21 +00003488
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003489 # we use mkdtemp in the next line to create an empty directory
3490 # under our exclusive control; from that, we can invent a pathname
3491 # that we _know_ won't exist. This is guaranteed to fail.
3492 dir = None
3493 try:
3494 dir = tempfile.mkdtemp()
3495 name = os.path.join(dir, "foo")
Tim Goldene0041752013-11-03 12:53:17 +00003496 status, output = subprocess.getstatusoutput(
Victor Stinner937ee9e2018-06-26 02:11:06 +02003497 ("type " if mswindows else "cat ") + name)
Florent Xiclunab1e94e82010-02-27 22:12:37 +00003498 self.assertNotEqual(status, 0)
3499 finally:
3500 if dir is not None:
3501 os.rmdir(dir)
Brett Cannona23810f2008-05-26 19:04:21 +00003502
Gregory P. Smithace55862015-04-07 15:57:54 -07003503 def test__all__(self):
3504 """Ensure that __all__ is populated properly."""
Patrick McLean2b2ead72019-09-12 10:15:44 -07003505 intentionally_excluded = {"list2cmdline", "Handle", "pwd", "grp"}
Gregory P. Smithace55862015-04-07 15:57:54 -07003506 exported = set(subprocess.__all__)
3507 possible_exports = set()
3508 import types
3509 for name, value in subprocess.__dict__.items():
3510 if name.startswith('_'):
3511 continue
3512 if isinstance(value, (types.ModuleType,)):
3513 continue
3514 possible_exports.add(name)
3515 self.assertEqual(exported, possible_exports - intentionally_excluded)
3516
3517
Martin Panter23172bd2016-04-16 11:28:10 +00003518@unittest.skipUnless(hasattr(selectors, 'PollSelector'),
3519 "Test needs selectors.PollSelector")
3520class ProcessTestCaseNoPoll(ProcessTestCase):
3521 def setUp(self):
3522 self.orig_selector = subprocess._PopenSelector
3523 subprocess._PopenSelector = selectors.SelectSelector
3524 ProcessTestCase.setUp(self)
3525
3526 def tearDown(self):
3527 subprocess._PopenSelector = self.orig_selector
3528 ProcessTestCase.tearDown(self)
3529
Gregory P. Smithd06fa472009-07-04 02:46:54 +00003530
Victor Stinner937ee9e2018-06-26 02:11:06 +02003531@unittest.skipUnless(mswindows, "Windows-specific tests")
Tim Golden126c2962010-08-11 14:20:40 +00003532class CommandsWithSpaces (BaseTestCase):
3533
3534 def setUp(self):
3535 super().setUp()
Berker Peksag16a1f282015-09-28 13:33:14 +03003536 f, fname = tempfile.mkstemp(".py", "te st")
Tim Golden126c2962010-08-11 14:20:40 +00003537 self.fname = fname.lower ()
3538 os.write(f, b"import sys;"
3539 b"sys.stdout.write('%d %s' % (len(sys.argv), [a.lower () for a in sys.argv]))"
3540 )
3541 os.close(f)
3542
3543 def tearDown(self):
3544 os.remove(self.fname)
3545 super().tearDown()
3546
3547 def with_spaces(self, *args, **kwargs):
3548 kwargs['stdout'] = subprocess.PIPE
3549 p = subprocess.Popen(*args, **kwargs)
Victor Stinner7438c612016-05-20 12:43:15 +02003550 with p:
3551 self.assertEqual(
3552 p.stdout.read ().decode("mbcs"),
3553 "2 [%r, 'ab cd']" % self.fname
3554 )
Tim Golden126c2962010-08-11 14:20:40 +00003555
3556 def test_shell_string_with_spaces(self):
3557 # call() function with string argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00003558 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
3559 "ab cd"), shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00003560
3561 def test_shell_sequence_with_spaces(self):
3562 # call() function with sequence argument with spaces on Windows
Brian Curtind835cf12010-08-13 20:42:57 +00003563 self.with_spaces([sys.executable, self.fname, "ab cd"], shell=1)
Tim Golden126c2962010-08-11 14:20:40 +00003564
3565 def test_noshell_string_with_spaces(self):
3566 # call() function with string argument with spaces on Windows
3567 self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname,
3568 "ab cd"))
3569
3570 def test_noshell_sequence_with_spaces(self):
3571 # call() function with sequence argument with spaces on Windows
3572 self.with_spaces([sys.executable, self.fname, "ab cd"])
3573
Brian Curtin79cdb662010-12-03 02:46:02 +00003574
Georg Brandla86b2622012-02-20 21:34:57 +01003575class ContextManagerTests(BaseTestCase):
Brian Curtin79cdb662010-12-03 02:46:02 +00003576
3577 def test_pipe(self):
3578 with subprocess.Popen([sys.executable, "-c",
3579 "import sys;"
3580 "sys.stdout.write('stdout');"
3581 "sys.stderr.write('stderr');"],
3582 stdout=subprocess.PIPE,
3583 stderr=subprocess.PIPE) as proc:
3584 self.assertEqual(proc.stdout.read(), b"stdout")
Victor Stinner6cac1132019-12-08 08:38:16 +01003585 self.assertEqual(proc.stderr.read(), b"stderr")
Brian Curtin79cdb662010-12-03 02:46:02 +00003586
3587 self.assertTrue(proc.stdout.closed)
3588 self.assertTrue(proc.stderr.closed)
3589
3590 def test_returncode(self):
3591 with subprocess.Popen([sys.executable, "-c",
3592 "import sys; sys.exit(100)"]) as proc:
Gregory P. Smith6b657452011-05-11 21:42:08 -07003593 pass
3594 # __exit__ calls wait(), so the returncode should be set
Brian Curtin79cdb662010-12-03 02:46:02 +00003595 self.assertEqual(proc.returncode, 100)
3596
3597 def test_communicate_stdin(self):
3598 with subprocess.Popen([sys.executable, "-c",
3599 "import sys;"
3600 "sys.exit(sys.stdin.read() == 'context')"],
3601 stdin=subprocess.PIPE) as proc:
3602 proc.communicate(b"context")
3603 self.assertEqual(proc.returncode, 1)
3604
3605 def test_invalid_args(self):
Victor Stinnerb31206a2018-01-25 19:06:05 +01003606 with self.assertRaises(NONEXISTING_ERRORS):
Victor Stinner9a83f652017-08-21 23:51:31 +02003607 with subprocess.Popen(NONEXISTING_CMD,
Brian Curtin79cdb662010-12-03 02:46:02 +00003608 stdout=subprocess.PIPE,
3609 stderr=subprocess.PIPE) as proc:
3610 pass
3611
Serhiy Storchakaab900c22015-02-28 12:43:08 +02003612 def test_broken_pipe_cleanup(self):
3613 """Broken pipe error should not prevent wait() (Issue 21619)"""
Gregory P. Smith67b93f82019-10-12 16:35:53 -07003614 proc = subprocess.Popen(ZERO_RETURN_CMD,
Victor Stinner20f4bd42015-03-05 02:38:41 +01003615 stdin=subprocess.PIPE,
Victor Stinner20f4bd42015-03-05 02:38:41 +01003616 bufsize=support.PIPE_MAX_SIZE*2)
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02003617 proc = proc.__enter__()
3618 # Prepare to send enough data to overflow any OS pipe buffering and
3619 # guarantee a broken pipe error. Data is held in BufferedWriter
3620 # buffer until closed.
3621 proc.stdin.write(b'x' * support.PIPE_MAX_SIZE)
Serhiy Storchakaab900c22015-02-28 12:43:08 +02003622 self.assertIsNone(proc.returncode)
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02003623 # EPIPE expected under POSIX; EINVAL under Windows
Serhiy Storchakacf265fd2015-02-28 13:27:54 +02003624 self.assertRaises(OSError, proc.__exit__, None, None, None)
Serhiy Storchakaf87afb02015-03-08 09:16:40 +02003625 self.assertEqual(proc.returncode, 0)
Serhiy Storchakaab900c22015-02-28 12:43:08 +02003626 self.assertTrue(proc.stdin.closed)
Serhiy Storchakaab900c22015-02-28 12:43:08 +02003627
Brian Curtin79cdb662010-12-03 02:46:02 +00003628
Fredrik Lundh5b3687d2004-10-12 15:26:28 +00003629if __name__ == "__main__":
Gregory P. Smith112bb3a2011-03-15 14:55:17 -04003630 unittest.main()