Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1 | import unittest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 2 | from test import support |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 3 | import subprocess |
| 4 | import sys |
| 5 | import signal |
| 6 | import os |
Gregory P. Smith | a59c59f | 2010-03-01 00:17:40 +0000 | [diff] [blame] | 7 | import errno |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 8 | import tempfile |
| 9 | import time |
Tim Peters | 3761e8d | 2004-10-13 04:07:12 +0000 | [diff] [blame] | 10 | import re |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 11 | import sysconfig |
Gregory P. Smith | d23047b | 2010-12-04 09:10:44 +0000 | [diff] [blame] | 12 | import warnings |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 13 | import select |
Gregory P. Smith | 32ec9da | 2010-03-19 16:53:08 +0000 | [diff] [blame] | 14 | try: |
| 15 | import gc |
| 16 | except ImportError: |
| 17 | gc = None |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 18 | |
| 19 | mswindows = (sys.platform == "win32") |
| 20 | |
| 21 | # |
| 22 | # Depends on the following external programs: Python |
| 23 | # |
| 24 | |
| 25 | if mswindows: |
Tim Peters | 3b01a70 | 2004-10-12 22:19:32 +0000 | [diff] [blame] | 26 | SETBINARY = ('import msvcrt; msvcrt.setmode(sys.stdout.fileno(), ' |
| 27 | 'os.O_BINARY);') |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 28 | else: |
| 29 | SETBINARY = '' |
| 30 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 31 | |
| 32 | try: |
| 33 | mkstemp = tempfile.mkstemp |
| 34 | except AttributeError: |
| 35 | # tempfile.mkstemp is not available |
| 36 | def mkstemp(): |
| 37 | """Replacement for mkstemp, calling mktemp.""" |
| 38 | fname = tempfile.mktemp() |
| 39 | return os.open(fname, os.O_RDWR|os.O_CREAT), fname |
| 40 | |
Tim Peters | 3761e8d | 2004-10-13 04:07:12 +0000 | [diff] [blame] | 41 | |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 42 | class BaseTestCase(unittest.TestCase): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 43 | def setUp(self): |
| 44 | # Try to minimize the number of children we have so this test |
| 45 | # doesn't crash on some buildbots (Alphas in particular). |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 46 | support.reap_children() |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 47 | |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 48 | def tearDown(self): |
| 49 | for inst in subprocess._active: |
| 50 | inst.wait() |
| 51 | subprocess._cleanup() |
| 52 | self.assertFalse(subprocess._active, "subprocess._active not empty") |
| 53 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 54 | def assertStderrEqual(self, stderr, expected, msg=None): |
| 55 | # In a debug build, stuff like "[6580 refs]" is printed to stderr at |
| 56 | # shutdown time. That frustrates tests trying to check stderr produced |
| 57 | # from a spawned Python process. |
Antoine Pitrou | 62f68ed | 2010-08-04 11:48:56 +0000 | [diff] [blame] | 58 | actual = support.strip_python_stderr(stderr) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 59 | self.assertEqual(actual, expected, msg) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 60 | |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 61 | |
| 62 | class ProcessTestCase(BaseTestCase): |
| 63 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 64 | def test_call_seq(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 65 | # call() function with sequence argument |
Tim Peters | 3b01a70 | 2004-10-12 22:19:32 +0000 | [diff] [blame] | 66 | rc = subprocess.call([sys.executable, "-c", |
| 67 | "import sys; sys.exit(47)"]) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 68 | self.assertEqual(rc, 47) |
| 69 | |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 70 | def test_check_call_zero(self): |
| 71 | # check_call() function with zero return code |
| 72 | rc = subprocess.check_call([sys.executable, "-c", |
| 73 | "import sys; sys.exit(0)"]) |
| 74 | self.assertEqual(rc, 0) |
| 75 | |
| 76 | def test_check_call_nonzero(self): |
| 77 | # check_call() function with non-zero return code |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 78 | with self.assertRaises(subprocess.CalledProcessError) as c: |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 79 | subprocess.check_call([sys.executable, "-c", |
| 80 | "import sys; sys.exit(47)"]) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 81 | self.assertEqual(c.exception.returncode, 47) |
Peter Astrand | 454f767 | 2005-01-01 09:36:35 +0000 | [diff] [blame] | 82 | |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 83 | def test_check_output(self): |
| 84 | # check_output() function with zero return code |
| 85 | output = subprocess.check_output( |
| 86 | [sys.executable, "-c", "print('BDFL')"]) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 87 | self.assertIn(b'BDFL', output) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 88 | |
| 89 | def test_check_output_nonzero(self): |
| 90 | # check_call() function with non-zero return code |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 91 | with self.assertRaises(subprocess.CalledProcessError) as c: |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 92 | subprocess.check_output( |
| 93 | [sys.executable, "-c", "import sys; sys.exit(5)"]) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 94 | self.assertEqual(c.exception.returncode, 5) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 95 | |
| 96 | def test_check_output_stderr(self): |
| 97 | # check_output() function stderr redirected to stdout |
| 98 | output = subprocess.check_output( |
| 99 | [sys.executable, "-c", "import sys; sys.stderr.write('BDFL')"], |
| 100 | stderr=subprocess.STDOUT) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 101 | self.assertIn(b'BDFL', output) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 102 | |
| 103 | def test_check_output_stdout_arg(self): |
| 104 | # check_output() function stderr redirected to stdout |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 105 | with self.assertRaises(ValueError) as c: |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 106 | output = subprocess.check_output( |
| 107 | [sys.executable, "-c", "print('will not be run')"], |
| 108 | stdout=sys.stdout) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 109 | self.fail("Expected ValueError when stdout arg supplied.") |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 110 | self.assertIn('stdout', c.exception.args[0]) |
Georg Brandl | f973407 | 2008-12-07 15:30:06 +0000 | [diff] [blame] | 111 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 112 | def test_call_kwargs(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 113 | # call() function with keyword args |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 114 | newenv = os.environ.copy() |
| 115 | newenv["FRUIT"] = "banana" |
| 116 | rc = subprocess.call([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 117 | 'import sys, os;' |
| 118 | 'sys.exit(os.getenv("FRUIT")=="banana")'], |
| 119 | env=newenv) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 120 | self.assertEqual(rc, 1) |
| 121 | |
| 122 | def test_stdin_none(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 123 | # .stdin is None when not redirected |
Georg Brandl | 88fc664 | 2007-02-09 21:28:07 +0000 | [diff] [blame] | 124 | p = subprocess.Popen([sys.executable, "-c", 'print("banana")'], |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 125 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 126 | self.addCleanup(p.stdout.close) |
| 127 | self.addCleanup(p.stderr.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 128 | p.wait() |
| 129 | self.assertEqual(p.stdin, None) |
| 130 | |
| 131 | def test_stdout_none(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 132 | # .stdout is None when not redirected |
Tim Peters | 29b6b4f | 2004-10-13 03:43:40 +0000 | [diff] [blame] | 133 | p = subprocess.Popen([sys.executable, "-c", |
Georg Brandl | 88fc664 | 2007-02-09 21:28:07 +0000 | [diff] [blame] | 134 | 'print(" this bit of output is from a ' |
Tim Peters | 4052fe5 | 2004-10-13 03:29:54 +0000 | [diff] [blame] | 135 | 'test of stdout in a different ' |
Georg Brandl | 88fc664 | 2007-02-09 21:28:07 +0000 | [diff] [blame] | 136 | 'process ...")'], |
Tim Peters | 4052fe5 | 2004-10-13 03:29:54 +0000 | [diff] [blame] | 137 | stdin=subprocess.PIPE, stderr=subprocess.PIPE) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 138 | self.addCleanup(p.stdin.close) |
| 139 | self.addCleanup(p.stderr.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 140 | p.wait() |
| 141 | self.assertEqual(p.stdout, None) |
| 142 | |
| 143 | def test_stderr_none(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 144 | # .stderr is None when not redirected |
Georg Brandl | 88fc664 | 2007-02-09 21:28:07 +0000 | [diff] [blame] | 145 | p = subprocess.Popen([sys.executable, "-c", 'print("banana")'], |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 146 | stdin=subprocess.PIPE, stdout=subprocess.PIPE) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 147 | self.addCleanup(p.stdout.close) |
| 148 | self.addCleanup(p.stdin.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 149 | p.wait() |
| 150 | self.assertEqual(p.stderr, None) |
| 151 | |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 152 | def test_executable_with_cwd(self): |
Florent Xicluna | 1d1ab97 | 2010-03-11 01:53:10 +0000 | [diff] [blame] | 153 | python_dir = os.path.dirname(os.path.realpath(sys.executable)) |
Ezio Melotti | 184bdfb | 2010-02-18 09:37:05 +0000 | [diff] [blame] | 154 | p = subprocess.Popen(["somethingyoudonthave", "-c", |
| 155 | "import sys; sys.exit(47)"], |
| 156 | executable=sys.executable, cwd=python_dir) |
| 157 | p.wait() |
| 158 | self.assertEqual(p.returncode, 47) |
| 159 | |
| 160 | @unittest.skipIf(sysconfig.is_python_build(), |
| 161 | "need an installed Python. See #7774") |
| 162 | def test_executable_without_cwd(self): |
| 163 | # For a normal installation, it should work without 'cwd' |
| 164 | # argument. For test runs in the build directory, see #7774. |
| 165 | p = subprocess.Popen(["somethingyoudonthave", "-c", |
| 166 | "import sys; sys.exit(47)"], |
Tim Peters | 3b01a70 | 2004-10-12 22:19:32 +0000 | [diff] [blame] | 167 | executable=sys.executable) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 168 | p.wait() |
| 169 | self.assertEqual(p.returncode, 47) |
| 170 | |
| 171 | def test_stdin_pipe(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 172 | # stdin redirection |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 173 | p = subprocess.Popen([sys.executable, "-c", |
| 174 | 'import sys; sys.exit(sys.stdin.read() == "pear")'], |
| 175 | stdin=subprocess.PIPE) |
Guido van Rossum | bb839ef | 2007-08-27 23:58:21 +0000 | [diff] [blame] | 176 | p.stdin.write(b"pear") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 177 | p.stdin.close() |
| 178 | p.wait() |
| 179 | self.assertEqual(p.returncode, 1) |
| 180 | |
| 181 | def test_stdin_filedes(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 182 | # stdin is set to open file descriptor |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 183 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 184 | self.addCleanup(tf.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 185 | d = tf.fileno() |
Antoine Pitrou | 9cadb1b | 2008-09-15 23:02:56 +0000 | [diff] [blame] | 186 | os.write(d, b"pear") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 187 | os.lseek(d, 0, 0) |
| 188 | p = subprocess.Popen([sys.executable, "-c", |
| 189 | 'import sys; sys.exit(sys.stdin.read() == "pear")'], |
| 190 | stdin=d) |
| 191 | p.wait() |
| 192 | self.assertEqual(p.returncode, 1) |
| 193 | |
| 194 | def test_stdin_fileobj(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 195 | # stdin is set to open file object |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 196 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 197 | self.addCleanup(tf.close) |
Guido van Rossum | bb839ef | 2007-08-27 23:58:21 +0000 | [diff] [blame] | 198 | tf.write(b"pear") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 199 | tf.seek(0) |
| 200 | p = subprocess.Popen([sys.executable, "-c", |
| 201 | 'import sys; sys.exit(sys.stdin.read() == "pear")'], |
| 202 | stdin=tf) |
| 203 | p.wait() |
| 204 | self.assertEqual(p.returncode, 1) |
| 205 | |
| 206 | def test_stdout_pipe(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 207 | # stdout redirection |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 208 | p = subprocess.Popen([sys.executable, "-c", |
| 209 | 'import sys; sys.stdout.write("orange")'], |
| 210 | stdout=subprocess.PIPE) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 211 | self.addCleanup(p.stdout.close) |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 212 | self.assertEqual(p.stdout.read(), b"orange") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 213 | |
| 214 | def test_stdout_filedes(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 215 | # stdout is set to open file descriptor |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 216 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 217 | self.addCleanup(tf.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 218 | d = tf.fileno() |
| 219 | p = subprocess.Popen([sys.executable, "-c", |
| 220 | 'import sys; sys.stdout.write("orange")'], |
| 221 | stdout=d) |
| 222 | p.wait() |
| 223 | os.lseek(d, 0, 0) |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 224 | self.assertEqual(os.read(d, 1024), b"orange") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 225 | |
| 226 | def test_stdout_fileobj(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 227 | # stdout is set to open file object |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 228 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 229 | self.addCleanup(tf.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 230 | p = subprocess.Popen([sys.executable, "-c", |
| 231 | 'import sys; sys.stdout.write("orange")'], |
| 232 | stdout=tf) |
| 233 | p.wait() |
| 234 | tf.seek(0) |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 235 | self.assertEqual(tf.read(), b"orange") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 236 | |
| 237 | def test_stderr_pipe(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 238 | # stderr redirection |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 239 | p = subprocess.Popen([sys.executable, "-c", |
| 240 | 'import sys; sys.stderr.write("strawberry")'], |
| 241 | stderr=subprocess.PIPE) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 242 | self.addCleanup(p.stderr.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 243 | self.assertStderrEqual(p.stderr.read(), b"strawberry") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 244 | |
| 245 | def test_stderr_filedes(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 246 | # stderr is set to open file descriptor |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 247 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 248 | self.addCleanup(tf.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 249 | d = tf.fileno() |
| 250 | p = subprocess.Popen([sys.executable, "-c", |
| 251 | 'import sys; sys.stderr.write("strawberry")'], |
| 252 | stderr=d) |
| 253 | p.wait() |
| 254 | os.lseek(d, 0, 0) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 255 | self.assertStderrEqual(os.read(d, 1024), b"strawberry") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 256 | |
| 257 | def test_stderr_fileobj(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 258 | # stderr is set to open file object |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 259 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 260 | self.addCleanup(tf.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 261 | p = subprocess.Popen([sys.executable, "-c", |
| 262 | 'import sys; sys.stderr.write("strawberry")'], |
| 263 | stderr=tf) |
| 264 | p.wait() |
| 265 | tf.seek(0) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 266 | self.assertStderrEqual(tf.read(), b"strawberry") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 267 | |
| 268 | def test_stdout_stderr_pipe(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 269 | # capture stdout and stderr to the same pipe |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 270 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 271 | 'import sys;' |
| 272 | 'sys.stdout.write("apple");' |
| 273 | 'sys.stdout.flush();' |
| 274 | 'sys.stderr.write("orange")'], |
| 275 | stdout=subprocess.PIPE, |
| 276 | stderr=subprocess.STDOUT) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 277 | self.addCleanup(p.stdout.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 278 | self.assertStderrEqual(p.stdout.read(), b"appleorange") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 279 | |
| 280 | def test_stdout_stderr_file(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 281 | # capture stdout and stderr to the same open file |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 282 | tf = tempfile.TemporaryFile() |
Benjamin Peterson | cc221b2 | 2010-10-31 02:06:21 +0000 | [diff] [blame] | 283 | self.addCleanup(tf.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 284 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 285 | 'import sys;' |
| 286 | 'sys.stdout.write("apple");' |
| 287 | 'sys.stdout.flush();' |
| 288 | 'sys.stderr.write("orange")'], |
| 289 | stdout=tf, |
| 290 | stderr=tf) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 291 | p.wait() |
| 292 | tf.seek(0) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 293 | self.assertStderrEqual(tf.read(), b"appleorange") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 294 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 295 | def test_stdout_filedes_of_stdout(self): |
| 296 | # stdout is set to 1 (#1531862). |
Antoine Pitrou | 9cadb1b | 2008-09-15 23:02:56 +0000 | [diff] [blame] | 297 | cmd = r"import sys, os; sys.exit(os.write(sys.stdout.fileno(), b'.\n'))" |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 298 | rc = subprocess.call([sys.executable, "-c", cmd], stdout=1) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 299 | self.assertEqual(rc, 2) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 300 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 301 | def test_cwd(self): |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 302 | tmpdir = tempfile.gettempdir() |
Peter Astrand | 195404f | 2004-11-12 15:51:48 +0000 | [diff] [blame] | 303 | # We cannot use os.path.realpath to canonicalize the path, |
| 304 | # since it doesn't expand Tru64 {memb} strings. See bug 1063571. |
| 305 | cwd = os.getcwd() |
| 306 | os.chdir(tmpdir) |
| 307 | tmpdir = os.getcwd() |
| 308 | os.chdir(cwd) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 309 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 310 | 'import sys,os;' |
| 311 | 'sys.stdout.write(os.getcwd())'], |
| 312 | stdout=subprocess.PIPE, |
| 313 | cwd=tmpdir) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 314 | self.addCleanup(p.stdout.close) |
Fredrik Lundh | 59c0559 | 2004-10-13 06:55:40 +0000 | [diff] [blame] | 315 | normcase = os.path.normcase |
Guido van Rossum | bb839ef | 2007-08-27 23:58:21 +0000 | [diff] [blame] | 316 | self.assertEqual(normcase(p.stdout.read().decode("utf-8")), |
| 317 | normcase(tmpdir)) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 318 | |
| 319 | def test_env(self): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 320 | newenv = os.environ.copy() |
| 321 | newenv["FRUIT"] = "orange" |
| 322 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 323 | 'import sys,os;' |
| 324 | 'sys.stdout.write(os.getenv("FRUIT"))'], |
| 325 | stdout=subprocess.PIPE, |
| 326 | env=newenv) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 327 | self.addCleanup(p.stdout.close) |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 328 | self.assertEqual(p.stdout.read(), b"orange") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 329 | |
Peter Astrand | cbac93c | 2005-03-03 20:24:28 +0000 | [diff] [blame] | 330 | def test_communicate_stdin(self): |
| 331 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 332 | 'import sys;' |
| 333 | 'sys.exit(sys.stdin.read() == "pear")'], |
Peter Astrand | cbac93c | 2005-03-03 20:24:28 +0000 | [diff] [blame] | 334 | stdin=subprocess.PIPE) |
Guido van Rossum | bb839ef | 2007-08-27 23:58:21 +0000 | [diff] [blame] | 335 | p.communicate(b"pear") |
Peter Astrand | cbac93c | 2005-03-03 20:24:28 +0000 | [diff] [blame] | 336 | self.assertEqual(p.returncode, 1) |
| 337 | |
| 338 | def test_communicate_stdout(self): |
| 339 | p = subprocess.Popen([sys.executable, "-c", |
| 340 | 'import sys; sys.stdout.write("pineapple")'], |
| 341 | stdout=subprocess.PIPE) |
| 342 | (stdout, stderr) = p.communicate() |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 343 | self.assertEqual(stdout, b"pineapple") |
Peter Astrand | cbac93c | 2005-03-03 20:24:28 +0000 | [diff] [blame] | 344 | self.assertEqual(stderr, None) |
| 345 | |
| 346 | def test_communicate_stderr(self): |
| 347 | p = subprocess.Popen([sys.executable, "-c", |
| 348 | 'import sys; sys.stderr.write("pineapple")'], |
| 349 | stderr=subprocess.PIPE) |
| 350 | (stdout, stderr) = p.communicate() |
| 351 | self.assertEqual(stdout, None) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 352 | self.assertStderrEqual(stderr, b"pineapple") |
Peter Astrand | cbac93c | 2005-03-03 20:24:28 +0000 | [diff] [blame] | 353 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 354 | def test_communicate(self): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 355 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 356 | 'import sys,os;' |
| 357 | 'sys.stderr.write("pineapple");' |
| 358 | 'sys.stdout.write(sys.stdin.read())'], |
| 359 | stdin=subprocess.PIPE, |
| 360 | stdout=subprocess.PIPE, |
| 361 | stderr=subprocess.PIPE) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 362 | self.addCleanup(p.stdout.close) |
| 363 | self.addCleanup(p.stderr.close) |
| 364 | self.addCleanup(p.stdin.close) |
Georg Brandl | 1abcbf8 | 2008-07-01 19:28:43 +0000 | [diff] [blame] | 365 | (stdout, stderr) = p.communicate(b"banana") |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 366 | self.assertEqual(stdout, b"banana") |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 367 | self.assertStderrEqual(stderr, b"pineapple") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 368 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 369 | # Test for the fd leak reported in http://bugs.python.org/issue2791. |
| 370 | def test_communicate_pipe_fd_leak(self): |
Victor Stinner | 667d4b5 | 2010-12-25 22:40:32 +0000 | [diff] [blame] | 371 | for stdin_pipe in (False, True): |
| 372 | for stdout_pipe in (False, True): |
| 373 | for stderr_pipe in (False, True): |
| 374 | options = {} |
| 375 | if stdin_pipe: |
| 376 | options['stdin'] = subprocess.PIPE |
| 377 | if stdout_pipe: |
| 378 | options['stdout'] = subprocess.PIPE |
| 379 | if stderr_pipe: |
| 380 | options['stderr'] = subprocess.PIPE |
| 381 | if not options: |
| 382 | continue |
| 383 | p = subprocess.Popen((sys.executable, "-c", "pass"), **options) |
| 384 | p.communicate() |
| 385 | if p.stdin is not None: |
| 386 | self.assertTrue(p.stdin.closed) |
| 387 | if p.stdout is not None: |
| 388 | self.assertTrue(p.stdout.closed) |
| 389 | if p.stderr is not None: |
| 390 | self.assertTrue(p.stderr.closed) |
Georg Brandl | f08a9dd | 2008-06-10 16:57:31 +0000 | [diff] [blame] | 391 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 392 | def test_communicate_returns(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 393 | # communicate() should return None if no redirection is active |
Tim Peters | 3b01a70 | 2004-10-12 22:19:32 +0000 | [diff] [blame] | 394 | p = subprocess.Popen([sys.executable, "-c", |
| 395 | "import sys; sys.exit(47)"]) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 396 | (stdout, stderr) = p.communicate() |
| 397 | self.assertEqual(stdout, None) |
| 398 | self.assertEqual(stderr, None) |
| 399 | |
| 400 | def test_communicate_pipe_buf(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 401 | # communicate() with writes larger than pipe_buf |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 402 | # This test will probably deadlock rather than fail, if |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 403 | # communicate() does not work properly. |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 404 | x, y = os.pipe() |
| 405 | if mswindows: |
| 406 | pipe_buf = 512 |
| 407 | else: |
| 408 | pipe_buf = os.fpathconf(x, "PC_PIPE_BUF") |
| 409 | os.close(x) |
| 410 | os.close(y) |
| 411 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 412 | 'import sys,os;' |
| 413 | 'sys.stdout.write(sys.stdin.read(47));' |
| 414 | 'sys.stderr.write("xyz"*%d);' |
| 415 | 'sys.stdout.write(sys.stdin.read())' % pipe_buf], |
| 416 | stdin=subprocess.PIPE, |
| 417 | stdout=subprocess.PIPE, |
| 418 | stderr=subprocess.PIPE) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 419 | self.addCleanup(p.stdout.close) |
| 420 | self.addCleanup(p.stderr.close) |
| 421 | self.addCleanup(p.stdin.close) |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 422 | string_to_write = b"abc"*pipe_buf |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 423 | (stdout, stderr) = p.communicate(string_to_write) |
| 424 | self.assertEqual(stdout, string_to_write) |
| 425 | |
| 426 | def test_writes_before_communicate(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 427 | # stdin.write before communicate() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 428 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 429 | 'import sys,os;' |
| 430 | 'sys.stdout.write(sys.stdin.read())'], |
| 431 | stdin=subprocess.PIPE, |
| 432 | stdout=subprocess.PIPE, |
| 433 | stderr=subprocess.PIPE) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 434 | self.addCleanup(p.stdout.close) |
| 435 | self.addCleanup(p.stderr.close) |
| 436 | self.addCleanup(p.stdin.close) |
Guido van Rossum | bb839ef | 2007-08-27 23:58:21 +0000 | [diff] [blame] | 437 | p.stdin.write(b"banana") |
| 438 | (stdout, stderr) = p.communicate(b"split") |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 439 | self.assertEqual(stdout, b"bananasplit") |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 440 | self.assertStderrEqual(stderr, b"") |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 441 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 442 | def test_universal_newlines(self): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 443 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 444 | 'import sys,os;' + SETBINARY + |
| 445 | 'sys.stdout.write("line1\\n");' |
| 446 | 'sys.stdout.flush();' |
| 447 | 'sys.stdout.write("line2\\n");' |
| 448 | 'sys.stdout.flush();' |
| 449 | 'sys.stdout.write("line3\\r\\n");' |
| 450 | 'sys.stdout.flush();' |
| 451 | 'sys.stdout.write("line4\\r");' |
| 452 | 'sys.stdout.flush();' |
| 453 | 'sys.stdout.write("\\nline5");' |
| 454 | 'sys.stdout.flush();' |
| 455 | 'sys.stdout.write("\\nline6");'], |
| 456 | stdout=subprocess.PIPE, |
| 457 | universal_newlines=1) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 458 | self.addCleanup(p.stdout.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 459 | stdout = p.stdout.read() |
Guido van Rossum | c9e363c | 2007-05-15 23:18:55 +0000 | [diff] [blame] | 460 | self.assertEqual(stdout, "line1\nline2\nline3\nline4\nline5\nline6") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 461 | |
| 462 | def test_universal_newlines_communicate(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 463 | # universal newlines through communicate() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 464 | p = subprocess.Popen([sys.executable, "-c", |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 465 | 'import sys,os;' + SETBINARY + |
| 466 | 'sys.stdout.write("line1\\n");' |
| 467 | 'sys.stdout.flush();' |
| 468 | 'sys.stdout.write("line2\\n");' |
| 469 | 'sys.stdout.flush();' |
| 470 | 'sys.stdout.write("line3\\r\\n");' |
| 471 | 'sys.stdout.flush();' |
| 472 | 'sys.stdout.write("line4\\r");' |
| 473 | 'sys.stdout.flush();' |
| 474 | 'sys.stdout.write("\\nline5");' |
| 475 | 'sys.stdout.flush();' |
| 476 | 'sys.stdout.write("\\nline6");'], |
| 477 | stdout=subprocess.PIPE, stderr=subprocess.PIPE, |
| 478 | universal_newlines=1) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 479 | self.addCleanup(p.stdout.close) |
| 480 | self.addCleanup(p.stderr.close) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 481 | (stdout, stderr) = p.communicate() |
Guido van Rossum | fa0054a | 2007-05-24 04:05:35 +0000 | [diff] [blame] | 482 | self.assertEqual(stdout, "line1\nline2\nline3\nline4\nline5\nline6") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 483 | |
| 484 | def test_no_leaking(self): |
Tim Peters | 7b759da | 2004-10-12 22:29:54 +0000 | [diff] [blame] | 485 | # Make sure we leak no resources |
Antoine Pitrou | 8db3027 | 2010-09-18 22:38:48 +0000 | [diff] [blame] | 486 | if not mswindows: |
Peter Astrand | f7f1bb7 | 2005-03-03 20:47:37 +0000 | [diff] [blame] | 487 | max_handles = 1026 # too much for most UNIX systems |
| 488 | else: |
Antoine Pitrou | 8db3027 | 2010-09-18 22:38:48 +0000 | [diff] [blame] | 489 | max_handles = 2050 # too much for (at least some) Windows setups |
| 490 | handles = [] |
| 491 | try: |
| 492 | for i in range(max_handles): |
| 493 | try: |
| 494 | handles.append(os.open(support.TESTFN, |
| 495 | os.O_WRONLY | os.O_CREAT)) |
| 496 | except OSError as e: |
| 497 | if e.errno != errno.EMFILE: |
| 498 | raise |
| 499 | break |
| 500 | else: |
| 501 | self.skipTest("failed to reach the file descriptor limit " |
| 502 | "(tried %d)" % max_handles) |
| 503 | # Close a couple of them (should be enough for a subprocess) |
| 504 | for i in range(10): |
| 505 | os.close(handles.pop()) |
| 506 | # Loop creating some subprocesses. If one of them leaks some fds, |
| 507 | # the next loop iteration will fail by reaching the max fd limit. |
| 508 | for i in range(15): |
| 509 | p = subprocess.Popen([sys.executable, "-c", |
| 510 | "import sys;" |
| 511 | "sys.stdout.write(sys.stdin.read())"], |
| 512 | stdin=subprocess.PIPE, |
| 513 | stdout=subprocess.PIPE, |
| 514 | stderr=subprocess.PIPE) |
| 515 | data = p.communicate(b"lime")[0] |
| 516 | self.assertEqual(data, b"lime") |
| 517 | finally: |
| 518 | for h in handles: |
| 519 | os.close(h) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 520 | |
| 521 | def test_list2cmdline(self): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 522 | self.assertEqual(subprocess.list2cmdline(['a b c', 'd', 'e']), |
| 523 | '"a b c" d e') |
| 524 | self.assertEqual(subprocess.list2cmdline(['ab"c', '\\', 'd']), |
| 525 | 'ab\\"c \\ d') |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 526 | self.assertEqual(subprocess.list2cmdline(['ab"c', ' \\', 'd']), |
| 527 | 'ab\\"c " \\\\" d') |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 528 | self.assertEqual(subprocess.list2cmdline(['a\\\\\\b', 'de fg', 'h']), |
| 529 | 'a\\\\\\b "de fg" h') |
| 530 | self.assertEqual(subprocess.list2cmdline(['a\\"b', 'c', 'd']), |
| 531 | 'a\\\\\\"b c d') |
| 532 | self.assertEqual(subprocess.list2cmdline(['a\\\\b c', 'd', 'e']), |
| 533 | '"a\\\\b c" d e') |
| 534 | self.assertEqual(subprocess.list2cmdline(['a\\\\b\\ c', 'd', 'e']), |
| 535 | '"a\\\\b\\ c" d e') |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 536 | self.assertEqual(subprocess.list2cmdline(['ab', '']), |
| 537 | 'ab ""') |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 538 | |
| 539 | |
| 540 | def test_poll(self): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 541 | p = subprocess.Popen([sys.executable, |
Tim Peters | 29b6b4f | 2004-10-13 03:43:40 +0000 | [diff] [blame] | 542 | "-c", "import time; time.sleep(1)"]) |
| 543 | count = 0 |
| 544 | while p.poll() is None: |
| 545 | time.sleep(0.1) |
| 546 | count += 1 |
| 547 | # We expect that the poll loop probably went around about 10 times, |
| 548 | # but, based on system scheduling we can't control, it's possible |
| 549 | # poll() never returned None. It "should be" very rare that it |
| 550 | # didn't go around at least twice. |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 551 | self.assertGreaterEqual(count, 2) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 552 | # Subsequent invocations should just return the returncode |
| 553 | self.assertEqual(p.poll(), 0) |
| 554 | |
| 555 | |
| 556 | def test_wait(self): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 557 | p = subprocess.Popen([sys.executable, |
| 558 | "-c", "import time; time.sleep(2)"]) |
| 559 | self.assertEqual(p.wait(), 0) |
| 560 | # Subsequent invocations should just return the returncode |
| 561 | self.assertEqual(p.wait(), 0) |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 562 | |
Peter Astrand | 738131d | 2004-11-30 21:04:45 +0000 | [diff] [blame] | 563 | |
| 564 | def test_invalid_bufsize(self): |
| 565 | # an invalid type of the bufsize argument should raise |
| 566 | # TypeError. |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 567 | with self.assertRaises(TypeError): |
Peter Astrand | 738131d | 2004-11-30 21:04:45 +0000 | [diff] [blame] | 568 | subprocess.Popen([sys.executable, "-c", "pass"], "orange") |
Peter Astrand | 738131d | 2004-11-30 21:04:45 +0000 | [diff] [blame] | 569 | |
Guido van Rossum | 46a05a7 | 2007-06-07 21:56:45 +0000 | [diff] [blame] | 570 | def test_bufsize_is_none(self): |
| 571 | # bufsize=None should be the same as bufsize=0. |
| 572 | p = subprocess.Popen([sys.executable, "-c", "pass"], None) |
| 573 | self.assertEqual(p.wait(), 0) |
| 574 | # Again with keyword arg |
| 575 | p = subprocess.Popen([sys.executable, "-c", "pass"], bufsize=None) |
| 576 | self.assertEqual(p.wait(), 0) |
| 577 | |
Benjamin Peterson | d75fcb4 | 2009-02-19 04:22:03 +0000 | [diff] [blame] | 578 | def test_leaking_fds_on_error(self): |
| 579 | # see bug #5179: Popen leaks file descriptors to PIPEs if |
| 580 | # the child fails to execute; this will eventually exhaust |
| 581 | # the maximum number of open fds. 1024 seems a very common |
| 582 | # value for that limit, but Windows has 2048, so we loop |
| 583 | # 1024 times (each call leaked two fds). |
| 584 | for i in range(1024): |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 585 | # Windows raises IOError. Others raise OSError. |
| 586 | with self.assertRaises(EnvironmentError) as c: |
Benjamin Peterson | d75fcb4 | 2009-02-19 04:22:03 +0000 | [diff] [blame] | 587 | subprocess.Popen(['nonexisting_i_hope'], |
| 588 | stdout=subprocess.PIPE, |
| 589 | stderr=subprocess.PIPE) |
Antoine Pitrou | 679e0f2 | 2010-09-18 17:56:02 +0000 | [diff] [blame] | 590 | if c.exception.errno != errno.ENOENT: # ignore "no such file" |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 591 | raise c.exception |
Benjamin Peterson | d75fcb4 | 2009-02-19 04:22:03 +0000 | [diff] [blame] | 592 | |
Victor Stinner | b369358 | 2010-05-21 20:13:12 +0000 | [diff] [blame] | 593 | def test_issue8780(self): |
| 594 | # Ensure that stdout is inherited from the parent |
| 595 | # if stdout=PIPE is not used |
| 596 | code = ';'.join(( |
| 597 | 'import subprocess, sys', |
| 598 | 'retcode = subprocess.call(' |
| 599 | "[sys.executable, '-c', 'print(\"Hello World!\")'])", |
| 600 | 'assert retcode == 0')) |
| 601 | output = subprocess.check_output([sys.executable, '-c', code]) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 602 | self.assertTrue(output.startswith(b'Hello World!'), ascii(output)) |
Victor Stinner | b369358 | 2010-05-21 20:13:12 +0000 | [diff] [blame] | 603 | |
Tim Golden | af5ac39 | 2010-08-06 13:03:56 +0000 | [diff] [blame] | 604 | def test_handles_closed_on_exception(self): |
| 605 | # If CreateProcess exits with an error, ensure the |
| 606 | # duplicate output handles are released |
| 607 | ifhandle, ifname = mkstemp() |
| 608 | ofhandle, ofname = mkstemp() |
| 609 | efhandle, efname = mkstemp() |
| 610 | try: |
| 611 | subprocess.Popen (["*"], stdin=ifhandle, stdout=ofhandle, |
| 612 | stderr=efhandle) |
| 613 | except OSError: |
| 614 | os.close(ifhandle) |
| 615 | os.remove(ifname) |
| 616 | os.close(ofhandle) |
| 617 | os.remove(ofname) |
| 618 | os.close(efhandle) |
| 619 | os.remove(efname) |
| 620 | self.assertFalse(os.path.exists(ifname)) |
| 621 | self.assertFalse(os.path.exists(ofname)) |
| 622 | self.assertFalse(os.path.exists(efname)) |
| 623 | |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 624 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 625 | # context manager |
| 626 | class _SuppressCoreFiles(object): |
| 627 | """Try to prevent core files from being created.""" |
| 628 | old_limit = None |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 629 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 630 | def __enter__(self): |
| 631 | """Try to save previous ulimit, then set it to (0, 0).""" |
| 632 | try: |
| 633 | import resource |
| 634 | self.old_limit = resource.getrlimit(resource.RLIMIT_CORE) |
| 635 | resource.setrlimit(resource.RLIMIT_CORE, (0, 0)) |
| 636 | except (ImportError, ValueError, resource.error): |
| 637 | pass |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 638 | |
Ronald Oussoren | 102d11a | 2010-07-23 09:50:05 +0000 | [diff] [blame] | 639 | if sys.platform == 'darwin': |
| 640 | # Check if the 'Crash Reporter' on OSX was configured |
| 641 | # in 'Developer' mode and warn that it will get triggered |
| 642 | # when it is. |
| 643 | # |
| 644 | # This assumes that this context manager is used in tests |
| 645 | # that might trigger the next manager. |
| 646 | value = subprocess.Popen(['/usr/bin/defaults', 'read', |
| 647 | 'com.apple.CrashReporter', 'DialogType'], |
| 648 | stdout=subprocess.PIPE).communicate()[0] |
| 649 | if value.strip() == b'developer': |
| 650 | print("this tests triggers the Crash Reporter, " |
| 651 | "that is intentional", end='') |
| 652 | sys.stdout.flush() |
| 653 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 654 | def __exit__(self, *args): |
| 655 | """Return core file behavior to default.""" |
| 656 | if self.old_limit is None: |
| 657 | return |
| 658 | try: |
| 659 | import resource |
| 660 | resource.setrlimit(resource.RLIMIT_CORE, self.old_limit) |
| 661 | except (ImportError, ValueError, resource.error): |
| 662 | pass |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 663 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 664 | |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 665 | @unittest.skipIf(mswindows, "POSIX specific tests") |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 666 | class POSIXProcessTestCase(BaseTestCase): |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 667 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 668 | def test_exceptions(self): |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 669 | nonexistent_dir = "/_this/pa.th/does/not/exist" |
| 670 | try: |
| 671 | os.chdir(nonexistent_dir) |
| 672 | except OSError as e: |
| 673 | # This avoids hard coding the errno value or the OS perror() |
| 674 | # string and instead capture the exception that we want to see |
| 675 | # below for comparison. |
| 676 | desired_exception = e |
Benjamin Peterson | 5f78040 | 2010-11-20 18:07:52 +0000 | [diff] [blame] | 677 | desired_exception.strerror += ': ' + repr(sys.executable) |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 678 | else: |
| 679 | self.fail("chdir to nonexistant directory %s succeeded." % |
| 680 | nonexistent_dir) |
| 681 | |
| 682 | # Error in the child re-raised in the parent. |
| 683 | try: |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 684 | p = subprocess.Popen([sys.executable, "-c", ""], |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 685 | cwd=nonexistent_dir) |
| 686 | except OSError as e: |
| 687 | # Test that the child process chdir failure actually makes |
| 688 | # it up to the parent process as the correct exception. |
| 689 | self.assertEqual(desired_exception.errno, e.errno) |
| 690 | self.assertEqual(desired_exception.strerror, e.strerror) |
| 691 | else: |
| 692 | self.fail("Expected OSError: %s" % desired_exception) |
| 693 | |
| 694 | def test_restore_signals(self): |
| 695 | # Code coverage for both values of restore_signals to make sure it |
| 696 | # at least does not blow up. |
| 697 | # A test for behavior would be complex. Contributions welcome. |
| 698 | subprocess.call([sys.executable, "-c", ""], restore_signals=True) |
| 699 | subprocess.call([sys.executable, "-c", ""], restore_signals=False) |
| 700 | |
| 701 | def test_start_new_session(self): |
| 702 | # For code coverage of calling setsid(). We don't care if we get an |
| 703 | # EPERM error from it depending on the test execution environment, that |
| 704 | # still indicates that it was called. |
| 705 | try: |
| 706 | output = subprocess.check_output( |
| 707 | [sys.executable, "-c", |
| 708 | "import os; print(os.getpgid(os.getpid()))"], |
| 709 | start_new_session=True) |
| 710 | except OSError as e: |
| 711 | if e.errno != errno.EPERM: |
| 712 | raise |
| 713 | else: |
| 714 | parent_pgid = os.getpgid(os.getpid()) |
| 715 | child_pgid = int(output) |
| 716 | self.assertNotEqual(parent_pgid, child_pgid) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 717 | |
| 718 | def test_run_abort(self): |
| 719 | # returncode handles signal termination |
| 720 | with _SuppressCoreFiles(): |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 721 | p = subprocess.Popen([sys.executable, "-c", |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 722 | 'import os; os.abort()']) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 723 | p.wait() |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 724 | self.assertEqual(-p.returncode, signal.SIGABRT) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 725 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 726 | def test_preexec(self): |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 727 | # DISCLAIMER: Setting environment variables is *not* a good use |
| 728 | # of a preexec_fn. This is merely a test. |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 729 | p = subprocess.Popen([sys.executable, "-c", |
| 730 | 'import sys,os;' |
| 731 | 'sys.stdout.write(os.getenv("FRUIT"))'], |
| 732 | stdout=subprocess.PIPE, |
| 733 | preexec_fn=lambda: os.putenv("FRUIT", "apple")) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 734 | self.addCleanup(p.stdout.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 735 | self.assertEqual(p.stdout.read(), b"apple") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 736 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 737 | def test_preexec_exception(self): |
| 738 | def raise_it(): |
| 739 | raise ValueError("What if two swallows carried a coconut?") |
| 740 | try: |
| 741 | p = subprocess.Popen([sys.executable, "-c", ""], |
| 742 | preexec_fn=raise_it) |
| 743 | except RuntimeError as e: |
| 744 | self.assertTrue( |
| 745 | subprocess._posixsubprocess, |
| 746 | "Expected a ValueError from the preexec_fn") |
| 747 | except ValueError as e: |
| 748 | self.assertIn("coconut", e.args[0]) |
| 749 | else: |
| 750 | self.fail("Exception raised by preexec_fn did not make it " |
| 751 | "to the parent process.") |
| 752 | |
Gregory P. Smith | 32ec9da | 2010-03-19 16:53:08 +0000 | [diff] [blame] | 753 | @unittest.skipUnless(gc, "Requires a gc module.") |
| 754 | def test_preexec_gc_module_failure(self): |
| 755 | # This tests the code that disables garbage collection if the child |
| 756 | # process will execute any Python. |
| 757 | def raise_runtime_error(): |
| 758 | raise RuntimeError("this shouldn't escape") |
| 759 | enabled = gc.isenabled() |
| 760 | orig_gc_disable = gc.disable |
| 761 | orig_gc_isenabled = gc.isenabled |
| 762 | try: |
| 763 | gc.disable() |
| 764 | self.assertFalse(gc.isenabled()) |
| 765 | subprocess.call([sys.executable, '-c', ''], |
| 766 | preexec_fn=lambda: None) |
| 767 | self.assertFalse(gc.isenabled(), |
| 768 | "Popen enabled gc when it shouldn't.") |
| 769 | |
| 770 | gc.enable() |
| 771 | self.assertTrue(gc.isenabled()) |
| 772 | subprocess.call([sys.executable, '-c', ''], |
| 773 | preexec_fn=lambda: None) |
| 774 | self.assertTrue(gc.isenabled(), "Popen left gc disabled.") |
| 775 | |
| 776 | gc.disable = raise_runtime_error |
| 777 | self.assertRaises(RuntimeError, subprocess.Popen, |
| 778 | [sys.executable, '-c', ''], |
| 779 | preexec_fn=lambda: None) |
| 780 | |
| 781 | del gc.isenabled # force an AttributeError |
| 782 | self.assertRaises(AttributeError, subprocess.Popen, |
| 783 | [sys.executable, '-c', ''], |
| 784 | preexec_fn=lambda: None) |
| 785 | finally: |
| 786 | gc.disable = orig_gc_disable |
| 787 | gc.isenabled = orig_gc_isenabled |
| 788 | if not enabled: |
| 789 | gc.disable() |
| 790 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 791 | def test_args_string(self): |
| 792 | # args is a string |
| 793 | fd, fname = mkstemp() |
| 794 | # reopen in text mode |
Victor Stinner | f6782ac | 2010-10-16 23:46:43 +0000 | [diff] [blame] | 795 | with open(fd, "w", errors="surrogateescape") as fobj: |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 796 | fobj.write("#!/bin/sh\n") |
| 797 | fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" % |
| 798 | sys.executable) |
| 799 | os.chmod(fname, 0o700) |
| 800 | p = subprocess.Popen(fname) |
| 801 | p.wait() |
| 802 | os.remove(fname) |
| 803 | self.assertEqual(p.returncode, 47) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 804 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 805 | def test_invalid_args(self): |
| 806 | # invalid arguments should raise ValueError |
| 807 | self.assertRaises(ValueError, subprocess.call, |
| 808 | [sys.executable, "-c", |
| 809 | "import sys; sys.exit(47)"], |
| 810 | startupinfo=47) |
| 811 | self.assertRaises(ValueError, subprocess.call, |
| 812 | [sys.executable, "-c", |
| 813 | "import sys; sys.exit(47)"], |
| 814 | creationflags=47) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 815 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 816 | def test_shell_sequence(self): |
| 817 | # Run command through the shell (sequence) |
| 818 | newenv = os.environ.copy() |
| 819 | newenv["FRUIT"] = "apple" |
| 820 | p = subprocess.Popen(["echo $FRUIT"], shell=1, |
| 821 | stdout=subprocess.PIPE, |
| 822 | env=newenv) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 823 | self.addCleanup(p.stdout.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 824 | self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple") |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 825 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 826 | def test_shell_string(self): |
| 827 | # Run command through the shell (string) |
| 828 | newenv = os.environ.copy() |
| 829 | newenv["FRUIT"] = "apple" |
| 830 | p = subprocess.Popen("echo $FRUIT", shell=1, |
| 831 | stdout=subprocess.PIPE, |
| 832 | env=newenv) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 833 | self.addCleanup(p.stdout.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 834 | self.assertEqual(p.stdout.read().strip(b" \t\r\n\f"), b"apple") |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 835 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 836 | def test_call_string(self): |
| 837 | # call() function with string argument on UNIX |
| 838 | fd, fname = mkstemp() |
| 839 | # reopen in text mode |
Victor Stinner | f6782ac | 2010-10-16 23:46:43 +0000 | [diff] [blame] | 840 | with open(fd, "w", errors="surrogateescape") as fobj: |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 841 | fobj.write("#!/bin/sh\n") |
| 842 | fobj.write("exec '%s' -c 'import sys; sys.exit(47)'\n" % |
| 843 | sys.executable) |
| 844 | os.chmod(fname, 0o700) |
| 845 | rc = subprocess.call(fname) |
| 846 | os.remove(fname) |
| 847 | self.assertEqual(rc, 47) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 848 | |
Stefan Krah | 9542cc6 | 2010-07-19 14:20:53 +0000 | [diff] [blame] | 849 | def test_specific_shell(self): |
| 850 | # Issue #9265: Incorrect name passed as arg[0]. |
| 851 | shells = [] |
| 852 | for prefix in ['/bin', '/usr/bin/', '/usr/local/bin']: |
| 853 | for name in ['bash', 'ksh']: |
| 854 | sh = os.path.join(prefix, name) |
| 855 | if os.path.isfile(sh): |
| 856 | shells.append(sh) |
| 857 | if not shells: # Will probably work for any shell but csh. |
| 858 | self.skipTest("bash or ksh required for this test") |
| 859 | sh = '/bin/sh' |
| 860 | if os.path.isfile(sh) and not os.path.islink(sh): |
| 861 | # Test will fail if /bin/sh is a symlink to csh. |
| 862 | shells.append(sh) |
| 863 | for sh in shells: |
| 864 | p = subprocess.Popen("echo $0", executable=sh, shell=True, |
| 865 | stdout=subprocess.PIPE) |
Brian Curtin | 3c6a951 | 2010-11-05 03:58:52 +0000 | [diff] [blame] | 866 | self.addCleanup(p.stdout.close) |
Stefan Krah | 9542cc6 | 2010-07-19 14:20:53 +0000 | [diff] [blame] | 867 | self.assertEqual(p.stdout.read().strip(), bytes(sh, 'ascii')) |
| 868 | |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 869 | def _kill_process(self, method, *args): |
Florent Xicluna | 1d8ee3a | 2010-03-05 20:26:54 +0000 | [diff] [blame] | 870 | # Do not inherit file handles from the parent. |
| 871 | # It should fix failures on some platforms. |
Antoine Pitrou | 3d8580f | 2010-09-20 01:33:21 +0000 | [diff] [blame] | 872 | p = subprocess.Popen([sys.executable, "-c", """if 1: |
| 873 | import sys, time |
| 874 | sys.stdout.write('x\\n') |
| 875 | sys.stdout.flush() |
| 876 | time.sleep(30) |
| 877 | """], |
| 878 | close_fds=True, |
| 879 | stdin=subprocess.PIPE, |
| 880 | stdout=subprocess.PIPE, |
| 881 | stderr=subprocess.PIPE) |
| 882 | # Wait for the interpreter to be completely initialized before |
| 883 | # sending any signal. |
| 884 | p.stdout.read(1) |
| 885 | getattr(p, method)(*args) |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 886 | return p |
| 887 | |
| 888 | def test_send_signal(self): |
| 889 | p = self._kill_process('send_signal', signal.SIGINT) |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 890 | _, stderr = p.communicate() |
| 891 | self.assertIn(b'KeyboardInterrupt', stderr) |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 892 | self.assertNotEqual(p.wait(), 0) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 893 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 894 | def test_kill(self): |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 895 | p = self._kill_process('kill') |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 896 | _, stderr = p.communicate() |
| 897 | self.assertStderrEqual(stderr, b'') |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 898 | self.assertEqual(p.wait(), -signal.SIGKILL) |
Tim Peters | e718f61 | 2004-10-12 21:51:32 +0000 | [diff] [blame] | 899 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 900 | def test_terminate(self): |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 901 | p = self._kill_process('terminate') |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 902 | _, stderr = p.communicate() |
| 903 | self.assertStderrEqual(stderr, b'') |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 904 | self.assertEqual(p.wait(), -signal.SIGTERM) |
| 905 | |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 906 | def test_surrogates_error_message(self): |
Victor Stinner | 4d07804 | 2010-04-23 19:28:32 +0000 | [diff] [blame] | 907 | def prepare(): |
| 908 | raise ValueError("surrogate:\uDCff") |
| 909 | |
| 910 | try: |
| 911 | subprocess.call( |
| 912 | [sys.executable, "-c", "pass"], |
| 913 | preexec_fn=prepare) |
| 914 | except ValueError as err: |
| 915 | # Pure Python implementations keeps the message |
| 916 | self.assertIsNone(subprocess._posixsubprocess) |
| 917 | self.assertEqual(str(err), "surrogate:\uDCff") |
| 918 | except RuntimeError as err: |
| 919 | # _posixsubprocess uses a default message |
| 920 | self.assertIsNotNone(subprocess._posixsubprocess) |
| 921 | self.assertEqual(str(err), "Exception occurred in preexec_fn.") |
| 922 | else: |
| 923 | self.fail("Expected ValueError or RuntimeError") |
| 924 | |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 925 | def test_undecodable_env(self): |
| 926 | for key, value in (('test', 'abc\uDCFF'), ('test\uDCFF', '42')): |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 927 | # test str with surrogates |
Antoine Pitrou | fb8db8f | 2010-09-19 22:46:05 +0000 | [diff] [blame] | 928 | script = "import os; print(ascii(os.getenv(%s)))" % repr(key) |
Victor Stinner | ce2d24d | 2010-04-23 22:55:39 +0000 | [diff] [blame] | 929 | env = os.environ.copy() |
| 930 | env[key] = value |
Victor Stinner | 89f3ad1 | 2010-10-14 10:43:31 +0000 | [diff] [blame] | 931 | # Use C locale to get ascii for the locale encoding to force |
| 932 | # surrogate-escaping of \xFF in the child process; otherwise it can |
| 933 | # be decoded as-is if the default locale is latin-1. |
Victor Stinner | ebc78d2 | 2010-10-14 10:38:17 +0000 | [diff] [blame] | 934 | env['LC_ALL'] = 'C' |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 935 | stdout = subprocess.check_output( |
| 936 | [sys.executable, "-c", script], |
Victor Stinner | ce2d24d | 2010-04-23 22:55:39 +0000 | [diff] [blame] | 937 | env=env) |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 938 | stdout = stdout.rstrip(b'\n\r') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 939 | self.assertEqual(stdout.decode('ascii'), ascii(value)) |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 940 | |
| 941 | # test bytes |
| 942 | key = key.encode("ascii", "surrogateescape") |
| 943 | value = value.encode("ascii", "surrogateescape") |
Antoine Pitrou | fb8db8f | 2010-09-19 22:46:05 +0000 | [diff] [blame] | 944 | script = "import os; print(ascii(os.getenvb(%s)))" % repr(key) |
Victor Stinner | ce2d24d | 2010-04-23 22:55:39 +0000 | [diff] [blame] | 945 | env = os.environ.copy() |
| 946 | env[key] = value |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 947 | stdout = subprocess.check_output( |
| 948 | [sys.executable, "-c", script], |
Victor Stinner | ce2d24d | 2010-04-23 22:55:39 +0000 | [diff] [blame] | 949 | env=env) |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 950 | stdout = stdout.rstrip(b'\n\r') |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 951 | self.assertEqual(stdout.decode('ascii'), ascii(value)) |
Victor Stinner | 13bb71c | 2010-04-23 21:41:56 +0000 | [diff] [blame] | 952 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 953 | def test_bytes_program(self): |
| 954 | abs_program = os.fsencode(sys.executable) |
| 955 | path, program = os.path.split(sys.executable) |
| 956 | program = os.fsencode(program) |
| 957 | |
| 958 | # absolute bytes path |
| 959 | exitcode = subprocess.call([abs_program, "-c", "pass"]) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 960 | self.assertEqual(exitcode, 0) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 961 | |
| 962 | # bytes program, unicode PATH |
| 963 | env = os.environ.copy() |
| 964 | env["PATH"] = path |
| 965 | exitcode = subprocess.call([program, "-c", "pass"], env=env) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 966 | self.assertEqual(exitcode, 0) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 967 | |
| 968 | # bytes program, bytes PATH |
| 969 | envb = os.environb.copy() |
| 970 | envb[b"PATH"] = os.fsencode(path) |
| 971 | exitcode = subprocess.call([program, "-c", "pass"], env=envb) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 972 | self.assertEqual(exitcode, 0) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 973 | |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 974 | def test_pipe_cloexec(self): |
| 975 | sleeper = support.findfile("input_reader.py", subdir="subprocessdata") |
| 976 | fd_status = support.findfile("fd_status.py", subdir="subprocessdata") |
| 977 | |
| 978 | p1 = subprocess.Popen([sys.executable, sleeper], |
| 979 | stdin=subprocess.PIPE, stdout=subprocess.PIPE, |
| 980 | stderr=subprocess.PIPE, close_fds=False) |
| 981 | |
| 982 | self.addCleanup(p1.communicate, b'') |
| 983 | |
| 984 | p2 = subprocess.Popen([sys.executable, fd_status], |
| 985 | stdout=subprocess.PIPE, close_fds=False) |
| 986 | |
| 987 | output, error = p2.communicate() |
| 988 | result_fds = set(map(int, output.split(b','))) |
| 989 | unwanted_fds = set([p1.stdin.fileno(), p1.stdout.fileno(), |
| 990 | p1.stderr.fileno()]) |
| 991 | |
| 992 | self.assertFalse(result_fds & unwanted_fds, |
| 993 | "Expected no fds from %r to be open in child, " |
| 994 | "found %r" % |
| 995 | (unwanted_fds, result_fds & unwanted_fds)) |
| 996 | |
| 997 | def test_pipe_cloexec_real_tools(self): |
| 998 | qcat = support.findfile("qcat.py", subdir="subprocessdata") |
| 999 | qgrep = support.findfile("qgrep.py", subdir="subprocessdata") |
| 1000 | |
| 1001 | subdata = b'zxcvbn' |
| 1002 | data = subdata * 4 + b'\n' |
| 1003 | |
| 1004 | p1 = subprocess.Popen([sys.executable, qcat], |
| 1005 | stdin=subprocess.PIPE, stdout=subprocess.PIPE, |
| 1006 | close_fds=False) |
| 1007 | |
| 1008 | p2 = subprocess.Popen([sys.executable, qgrep, subdata], |
| 1009 | stdin=p1.stdout, stdout=subprocess.PIPE, |
| 1010 | close_fds=False) |
| 1011 | |
| 1012 | self.addCleanup(p1.wait) |
| 1013 | self.addCleanup(p2.wait) |
| 1014 | self.addCleanup(p1.terminate) |
| 1015 | self.addCleanup(p2.terminate) |
| 1016 | |
| 1017 | p1.stdin.write(data) |
| 1018 | p1.stdin.close() |
| 1019 | |
| 1020 | readfiles, ignored1, ignored2 = select.select([p2.stdout], [], [], 10) |
| 1021 | |
| 1022 | self.assertTrue(readfiles, "The child hung") |
| 1023 | self.assertEqual(p2.stdout.read(), data) |
| 1024 | |
Victor Stinner | faa8c13 | 2011-01-03 16:36:00 +0000 | [diff] [blame] | 1025 | p1.stdout.close() |
| 1026 | p2.stdout.close() |
| 1027 | |
Gregory P. Smith | 51ee270 | 2010-12-13 07:59:39 +0000 | [diff] [blame] | 1028 | def test_close_fds(self): |
| 1029 | fd_status = support.findfile("fd_status.py", subdir="subprocessdata") |
| 1030 | |
| 1031 | fds = os.pipe() |
| 1032 | self.addCleanup(os.close, fds[0]) |
| 1033 | self.addCleanup(os.close, fds[1]) |
| 1034 | |
| 1035 | open_fds = set(fds) |
| 1036 | |
| 1037 | p = subprocess.Popen([sys.executable, fd_status], |
| 1038 | stdout=subprocess.PIPE, close_fds=False) |
| 1039 | output, ignored = p.communicate() |
| 1040 | remaining_fds = set(map(int, output.split(b','))) |
| 1041 | |
| 1042 | self.assertEqual(remaining_fds & open_fds, open_fds, |
| 1043 | "Some fds were closed") |
| 1044 | |
| 1045 | p = subprocess.Popen([sys.executable, fd_status], |
| 1046 | stdout=subprocess.PIPE, close_fds=True) |
| 1047 | output, ignored = p.communicate() |
| 1048 | remaining_fds = set(map(int, output.split(b','))) |
| 1049 | |
| 1050 | self.assertFalse(remaining_fds & open_fds, |
| 1051 | "Some fds were left open") |
| 1052 | self.assertIn(1, remaining_fds, "Subprocess failed") |
| 1053 | |
Gregory P. Smith | 8edd99d | 2010-12-14 13:43:30 +0000 | [diff] [blame] | 1054 | def test_pass_fds(self): |
| 1055 | fd_status = support.findfile("fd_status.py", subdir="subprocessdata") |
| 1056 | |
| 1057 | open_fds = set() |
| 1058 | |
| 1059 | for x in range(5): |
| 1060 | fds = os.pipe() |
| 1061 | self.addCleanup(os.close, fds[0]) |
| 1062 | self.addCleanup(os.close, fds[1]) |
| 1063 | open_fds.update(fds) |
| 1064 | |
| 1065 | for fd in open_fds: |
| 1066 | p = subprocess.Popen([sys.executable, fd_status], |
| 1067 | stdout=subprocess.PIPE, close_fds=True, |
| 1068 | pass_fds=(fd, )) |
| 1069 | output, ignored = p.communicate() |
| 1070 | |
| 1071 | remaining_fds = set(map(int, output.split(b','))) |
| 1072 | to_be_closed = open_fds - {fd} |
| 1073 | |
| 1074 | self.assertIn(fd, remaining_fds, "fd to be passed not passed") |
| 1075 | self.assertFalse(remaining_fds & to_be_closed, |
| 1076 | "fd to be closed passed") |
| 1077 | |
| 1078 | # pass_fds overrides close_fds with a warning. |
| 1079 | with self.assertWarns(RuntimeWarning) as context: |
| 1080 | self.assertFalse(subprocess.call( |
| 1081 | [sys.executable, "-c", "import sys; sys.exit(0)"], |
| 1082 | close_fds=False, pass_fds=(fd, ))) |
| 1083 | self.assertIn('overriding close_fds', str(context.warning)) |
| 1084 | |
Gregory P. Smith | e85db2b | 2010-12-14 14:38:00 +0000 | [diff] [blame] | 1085 | def test_wait_when_sigchild_ignored(self): |
| 1086 | # NOTE: sigchild_ignore.py may not be an effective test on all OSes. |
| 1087 | sigchild_ignore = support.findfile("sigchild_ignore.py", |
| 1088 | subdir="subprocessdata") |
| 1089 | p = subprocess.Popen([sys.executable, sigchild_ignore], |
| 1090 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
| 1091 | stdout, stderr = p.communicate() |
| 1092 | self.assertEqual(0, p.returncode, "sigchild_ignore.py exited" |
Gregory P. Smith | a80f4fb | 2010-12-14 15:23:02 +0000 | [diff] [blame] | 1093 | " non-zero with this error:\n%s" % |
| 1094 | stderr.decode('utf8')) |
Gregory P. Smith | e85db2b | 2010-12-14 14:38:00 +0000 | [diff] [blame] | 1095 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1096 | |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 1097 | @unittest.skipUnless(mswindows, "Windows specific tests") |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 1098 | class Win32ProcessTestCase(BaseTestCase): |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 1099 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1100 | def test_startupinfo(self): |
| 1101 | # startupinfo argument |
| 1102 | # We uses hardcoded constants, because we do not want to |
| 1103 | # depend on win32all. |
| 1104 | STARTF_USESHOWWINDOW = 1 |
| 1105 | SW_MAXIMIZE = 3 |
| 1106 | startupinfo = subprocess.STARTUPINFO() |
| 1107 | startupinfo.dwFlags = STARTF_USESHOWWINDOW |
| 1108 | startupinfo.wShowWindow = SW_MAXIMIZE |
| 1109 | # Since Python is a console process, it won't be affected |
| 1110 | # by wShowWindow, but the argument should be silently |
| 1111 | # ignored |
| 1112 | subprocess.call([sys.executable, "-c", "import sys; sys.exit(0)"], |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1113 | startupinfo=startupinfo) |
| 1114 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1115 | def test_creationflags(self): |
| 1116 | # creationflags argument |
| 1117 | CREATE_NEW_CONSOLE = 16 |
| 1118 | sys.stderr.write(" a DOS box should flash briefly ...\n") |
| 1119 | subprocess.call(sys.executable + |
| 1120 | ' -c "import time; time.sleep(0.25)"', |
| 1121 | creationflags=CREATE_NEW_CONSOLE) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1122 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1123 | def test_invalid_args(self): |
| 1124 | # invalid arguments should raise ValueError |
| 1125 | self.assertRaises(ValueError, subprocess.call, |
| 1126 | [sys.executable, "-c", |
| 1127 | "import sys; sys.exit(47)"], |
| 1128 | preexec_fn=lambda: 1) |
| 1129 | self.assertRaises(ValueError, subprocess.call, |
| 1130 | [sys.executable, "-c", |
| 1131 | "import sys; sys.exit(47)"], |
| 1132 | stdout=subprocess.PIPE, |
| 1133 | close_fds=True) |
| 1134 | |
| 1135 | def test_close_fds(self): |
| 1136 | # close file descriptors |
| 1137 | rc = subprocess.call([sys.executable, "-c", |
| 1138 | "import sys; sys.exit(47)"], |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1139 | close_fds=True) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1140 | self.assertEqual(rc, 47) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1141 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1142 | def test_shell_sequence(self): |
| 1143 | # Run command through the shell (sequence) |
| 1144 | newenv = os.environ.copy() |
| 1145 | newenv["FRUIT"] = "physalis" |
| 1146 | p = subprocess.Popen(["set"], shell=1, |
| 1147 | stdout=subprocess.PIPE, |
| 1148 | env=newenv) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 1149 | self.addCleanup(p.stdout.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1150 | self.assertIn(b"physalis", p.stdout.read()) |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 1151 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1152 | def test_shell_string(self): |
| 1153 | # Run command through the shell (string) |
| 1154 | newenv = os.environ.copy() |
| 1155 | newenv["FRUIT"] = "physalis" |
| 1156 | p = subprocess.Popen("set", shell=1, |
| 1157 | stdout=subprocess.PIPE, |
| 1158 | env=newenv) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 1159 | self.addCleanup(p.stdout.close) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1160 | self.assertIn(b"physalis", p.stdout.read()) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1161 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1162 | def test_call_string(self): |
| 1163 | # call() function with string argument on Windows |
| 1164 | rc = subprocess.call(sys.executable + |
| 1165 | ' -c "import sys; sys.exit(47)"') |
| 1166 | self.assertEqual(rc, 47) |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1167 | |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 1168 | def _kill_process(self, method, *args): |
| 1169 | # Some win32 buildbot raises EOFError if stdin is inherited |
Antoine Pitrou | a4024e2 | 2010-09-24 18:57:01 +0000 | [diff] [blame] | 1170 | p = subprocess.Popen([sys.executable, "-c", """if 1: |
| 1171 | import sys, time |
| 1172 | sys.stdout.write('x\\n') |
| 1173 | sys.stdout.flush() |
| 1174 | time.sleep(30) |
| 1175 | """], |
| 1176 | stdin=subprocess.PIPE, |
| 1177 | stdout=subprocess.PIPE, |
| 1178 | stderr=subprocess.PIPE) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 1179 | self.addCleanup(p.stdout.close) |
| 1180 | self.addCleanup(p.stderr.close) |
| 1181 | self.addCleanup(p.stdin.close) |
Antoine Pitrou | a4024e2 | 2010-09-24 18:57:01 +0000 | [diff] [blame] | 1182 | # Wait for the interpreter to be completely initialized before |
| 1183 | # sending any signal. |
| 1184 | p.stdout.read(1) |
| 1185 | getattr(p, method)(*args) |
Florent Xicluna | c049d87 | 2010-03-27 22:47:23 +0000 | [diff] [blame] | 1186 | _, stderr = p.communicate() |
| 1187 | self.assertStderrEqual(stderr, b'') |
Antoine Pitrou | a4024e2 | 2010-09-24 18:57:01 +0000 | [diff] [blame] | 1188 | returncode = p.wait() |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 1189 | self.assertNotEqual(returncode, 0) |
| 1190 | |
| 1191 | def test_send_signal(self): |
| 1192 | self._kill_process('send_signal', signal.SIGTERM) |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1193 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1194 | def test_kill(self): |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 1195 | self._kill_process('kill') |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1196 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1197 | def test_terminate(self): |
Florent Xicluna | 4886d24 | 2010-03-08 13:27:26 +0000 | [diff] [blame] | 1198 | self._kill_process('terminate') |
Christian Heimes | a342c01 | 2008-04-20 21:01:16 +0000 | [diff] [blame] | 1199 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1200 | |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 1201 | # The module says: |
| 1202 | # "NB This only works (and is only relevant) for UNIX." |
| 1203 | # |
| 1204 | # Actually, getoutput should work on any platform with an os.popen, but |
| 1205 | # I'll take the comment as given, and skip this suite. |
Florent Xicluna | f0cbd82 | 2010-03-04 21:50:56 +0000 | [diff] [blame] | 1206 | @unittest.skipUnless(os.name == 'posix', "only relevant for UNIX") |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1207 | class CommandTests(unittest.TestCase): |
| 1208 | def test_getoutput(self): |
| 1209 | self.assertEqual(subprocess.getoutput('echo xyzzy'), 'xyzzy') |
| 1210 | self.assertEqual(subprocess.getstatusoutput('echo xyzzy'), |
| 1211 | (0, 'xyzzy')) |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 1212 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1213 | # we use mkdtemp in the next line to create an empty directory |
| 1214 | # under our exclusive control; from that, we can invent a pathname |
| 1215 | # that we _know_ won't exist. This is guaranteed to fail. |
| 1216 | dir = None |
| 1217 | try: |
| 1218 | dir = tempfile.mkdtemp() |
| 1219 | name = os.path.join(dir, "foo") |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 1220 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1221 | status, output = subprocess.getstatusoutput('cat ' + name) |
| 1222 | self.assertNotEqual(status, 0) |
| 1223 | finally: |
| 1224 | if dir is not None: |
| 1225 | os.rmdir(dir) |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 1226 | |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1227 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1228 | @unittest.skipUnless(getattr(subprocess, '_has_poll', False), |
| 1229 | "poll system call not supported") |
| 1230 | class ProcessTestCaseNoPoll(ProcessTestCase): |
| 1231 | def setUp(self): |
| 1232 | subprocess._has_poll = False |
| 1233 | ProcessTestCase.setUp(self) |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1234 | |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1235 | def tearDown(self): |
| 1236 | subprocess._has_poll = True |
| 1237 | ProcessTestCase.tearDown(self) |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1238 | |
| 1239 | |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1240 | @unittest.skipUnless(getattr(subprocess, '_posixsubprocess', False), |
| 1241 | "_posixsubprocess extension module not found.") |
| 1242 | class ProcessTestCasePOSIXPurePython(ProcessTestCase, POSIXProcessTestCase): |
| 1243 | def setUp(self): |
| 1244 | subprocess._posixsubprocess = None |
| 1245 | ProcessTestCase.setUp(self) |
| 1246 | POSIXProcessTestCase.setUp(self) |
| 1247 | |
| 1248 | def tearDown(self): |
| 1249 | subprocess._posixsubprocess = sys.modules['_posixsubprocess'] |
| 1250 | POSIXProcessTestCase.tearDown(self) |
| 1251 | ProcessTestCase.tearDown(self) |
| 1252 | |
| 1253 | |
Gregory P. Smith | a59c59f | 2010-03-01 00:17:40 +0000 | [diff] [blame] | 1254 | class HelperFunctionTests(unittest.TestCase): |
Gregory P. Smith | af6d3b8 | 2010-03-01 02:56:44 +0000 | [diff] [blame] | 1255 | @unittest.skipIf(mswindows, "errno and EINTR make no sense on windows") |
Gregory P. Smith | a59c59f | 2010-03-01 00:17:40 +0000 | [diff] [blame] | 1256 | def test_eintr_retry_call(self): |
| 1257 | record_calls = [] |
| 1258 | def fake_os_func(*args): |
| 1259 | record_calls.append(args) |
| 1260 | if len(record_calls) == 2: |
| 1261 | raise OSError(errno.EINTR, "fake interrupted system call") |
| 1262 | return tuple(reversed(args)) |
| 1263 | |
| 1264 | self.assertEqual((999, 256), |
| 1265 | subprocess._eintr_retry_call(fake_os_func, 256, 999)) |
| 1266 | self.assertEqual([(256, 999)], record_calls) |
| 1267 | # This time there will be an EINTR so it will loop once. |
| 1268 | self.assertEqual((666,), |
| 1269 | subprocess._eintr_retry_call(fake_os_func, 666)) |
| 1270 | self.assertEqual([(256, 999), (666,), (666,)], record_calls) |
| 1271 | |
| 1272 | |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 1273 | @unittest.skipUnless(mswindows, "Windows-specific tests") |
| 1274 | class CommandsWithSpaces (BaseTestCase): |
| 1275 | |
| 1276 | def setUp(self): |
| 1277 | super().setUp() |
| 1278 | f, fname = mkstemp(".py", "te st") |
| 1279 | self.fname = fname.lower () |
| 1280 | os.write(f, b"import sys;" |
| 1281 | b"sys.stdout.write('%d %s' % (len(sys.argv), [a.lower () for a in sys.argv]))" |
| 1282 | ) |
| 1283 | os.close(f) |
| 1284 | |
| 1285 | def tearDown(self): |
| 1286 | os.remove(self.fname) |
| 1287 | super().tearDown() |
| 1288 | |
| 1289 | def with_spaces(self, *args, **kwargs): |
| 1290 | kwargs['stdout'] = subprocess.PIPE |
| 1291 | p = subprocess.Popen(*args, **kwargs) |
Brian Curtin | 19a5379 | 2010-11-05 17:09:05 +0000 | [diff] [blame] | 1292 | self.addCleanup(p.stdout.close) |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 1293 | self.assertEqual( |
| 1294 | p.stdout.read ().decode("mbcs"), |
| 1295 | "2 [%r, 'ab cd']" % self.fname |
| 1296 | ) |
| 1297 | |
| 1298 | def test_shell_string_with_spaces(self): |
| 1299 | # call() function with string argument with spaces on Windows |
Brian Curtin | d835cf1 | 2010-08-13 20:42:57 +0000 | [diff] [blame] | 1300 | self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname, |
| 1301 | "ab cd"), shell=1) |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 1302 | |
| 1303 | def test_shell_sequence_with_spaces(self): |
| 1304 | # call() function with sequence argument with spaces on Windows |
Brian Curtin | d835cf1 | 2010-08-13 20:42:57 +0000 | [diff] [blame] | 1305 | self.with_spaces([sys.executable, self.fname, "ab cd"], shell=1) |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 1306 | |
| 1307 | def test_noshell_string_with_spaces(self): |
| 1308 | # call() function with string argument with spaces on Windows |
| 1309 | self.with_spaces('"%s" "%s" "%s"' % (sys.executable, self.fname, |
| 1310 | "ab cd")) |
| 1311 | |
| 1312 | def test_noshell_sequence_with_spaces(self): |
| 1313 | # call() function with sequence argument with spaces on Windows |
| 1314 | self.with_spaces([sys.executable, self.fname, "ab cd"]) |
| 1315 | |
Brian Curtin | 79cdb66 | 2010-12-03 02:46:02 +0000 | [diff] [blame] | 1316 | |
| 1317 | class ContextManagerTests(ProcessTestCase): |
| 1318 | |
| 1319 | def test_pipe(self): |
| 1320 | with subprocess.Popen([sys.executable, "-c", |
| 1321 | "import sys;" |
| 1322 | "sys.stdout.write('stdout');" |
| 1323 | "sys.stderr.write('stderr');"], |
| 1324 | stdout=subprocess.PIPE, |
| 1325 | stderr=subprocess.PIPE) as proc: |
| 1326 | self.assertEqual(proc.stdout.read(), b"stdout") |
| 1327 | self.assertStderrEqual(proc.stderr.read(), b"stderr") |
| 1328 | |
| 1329 | self.assertTrue(proc.stdout.closed) |
| 1330 | self.assertTrue(proc.stderr.closed) |
| 1331 | |
| 1332 | def test_returncode(self): |
| 1333 | with subprocess.Popen([sys.executable, "-c", |
| 1334 | "import sys; sys.exit(100)"]) as proc: |
| 1335 | proc.wait() |
| 1336 | self.assertEqual(proc.returncode, 100) |
| 1337 | |
| 1338 | def test_communicate_stdin(self): |
| 1339 | with subprocess.Popen([sys.executable, "-c", |
| 1340 | "import sys;" |
| 1341 | "sys.exit(sys.stdin.read() == 'context')"], |
| 1342 | stdin=subprocess.PIPE) as proc: |
| 1343 | proc.communicate(b"context") |
| 1344 | self.assertEqual(proc.returncode, 1) |
| 1345 | |
| 1346 | def test_invalid_args(self): |
| 1347 | with self.assertRaises(EnvironmentError) as c: |
| 1348 | with subprocess.Popen(['nonexisting_i_hope'], |
| 1349 | stdout=subprocess.PIPE, |
| 1350 | stderr=subprocess.PIPE) as proc: |
| 1351 | pass |
| 1352 | |
| 1353 | if c.exception.errno != errno.ENOENT: # ignore "no such file" |
| 1354 | raise c.exception |
| 1355 | |
| 1356 | |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1357 | def test_main(): |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1358 | unit_tests = (ProcessTestCase, |
| 1359 | POSIXProcessTestCase, |
| 1360 | Win32ProcessTestCase, |
Gregory P. Smith | fb94c5f | 2010-03-14 06:49:55 +0000 | [diff] [blame] | 1361 | ProcessTestCasePOSIXPurePython, |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1362 | CommandTests, |
Gregory P. Smith | a59c59f | 2010-03-01 00:17:40 +0000 | [diff] [blame] | 1363 | ProcessTestCaseNoPoll, |
Tim Golden | 126c296 | 2010-08-11 14:20:40 +0000 | [diff] [blame] | 1364 | HelperFunctionTests, |
Brian Curtin | 79cdb66 | 2010-12-03 02:46:02 +0000 | [diff] [blame] | 1365 | CommandsWithSpaces, |
Gregory P. Smith | f560485 | 2010-12-13 06:45:02 +0000 | [diff] [blame] | 1366 | ContextManagerTests) |
Florent Xicluna | b1e94e8 | 2010-02-27 22:12:37 +0000 | [diff] [blame] | 1367 | |
Gregory P. Smith | d06fa47 | 2009-07-04 02:46:54 +0000 | [diff] [blame] | 1368 | support.run_unittest(*unit_tests) |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 1369 | support.reap_children() |
Fredrik Lundh | 5b3687d | 2004-10-12 15:26:28 +0000 | [diff] [blame] | 1370 | |
| 1371 | if __name__ == "__main__": |
Brett Cannon | a23810f | 2008-05-26 19:04:21 +0000 | [diff] [blame] | 1372 | test_main() |