blob: ab7741f3bf2a648c7f0d76a9d9d435642eff6961 [file] [log] [blame]
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -08001"""
2Tests of regrtest.py.
Victor Stinner6b415102015-09-28 23:16:17 +02003
4Note: test_regrtest cannot be run twice in parallel.
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -08005"""
6
7import argparse
Victor Stinner14b46622015-10-11 10:04:26 +02008import contextlib
Charles-François Natali833bf1f2013-09-08 12:27:33 +02009import faulthandler
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080010import getopt
Victor Stinner49671462015-10-11 10:03:28 +020011import io
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030012import os.path
Victor Stinner6b415102015-09-28 23:16:17 +020013import platform
14import re
15import subprocess
16import sys
17import textwrap
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080018import unittest
Victor Stinner3844fe52015-09-26 10:38:01 +020019from test import libregrtest
20from test import support
Victor Stinner6b415102015-09-28 23:16:17 +020021
22
23Py_DEBUG = hasattr(sys, 'getobjects')
24ROOT_DIR = os.path.join(os.path.dirname(__file__), '..', '..')
25ROOT_DIR = os.path.abspath(os.path.normpath(ROOT_DIR))
26
Victor Stinner3909e582015-10-11 10:37:25 +020027TEST_INTERRUPTED = textwrap.dedent("""
28 from signal import SIGINT
29 try:
30 from _testcapi import raise_signal
31 raise_signal(SIGINT)
32 except ImportError:
33 import os
34 os.kill(os.getpid(), SIGINT)
35 """)
36
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080037
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080038class ParseArgsTestCase(unittest.TestCase):
Victor Stinner6b415102015-09-28 23:16:17 +020039 """
40 Test regrtest's argument parsing, function _parse_args().
41 """
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080042
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030043 def checkError(self, args, msg):
44 with support.captured_stderr() as err, self.assertRaises(SystemExit):
Victor Stinner3844fe52015-09-26 10:38:01 +020045 libregrtest._parse_args(args)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030046 self.assertIn(msg, err.getvalue())
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080047
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030048 def test_help(self):
49 for opt in '-h', '--help':
50 with self.subTest(opt=opt):
51 with support.captured_stdout() as out, \
52 self.assertRaises(SystemExit):
Victor Stinner3844fe52015-09-26 10:38:01 +020053 libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030054 self.assertIn('Run Python regression tests.', out.getvalue())
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080055
Charles-François Natali833bf1f2013-09-08 12:27:33 +020056 @unittest.skipUnless(hasattr(faulthandler, 'dump_traceback_later'),
57 "faulthandler.dump_traceback_later() required")
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030058 def test_timeout(self):
Victor Stinner3844fe52015-09-26 10:38:01 +020059 ns = libregrtest._parse_args(['--timeout', '4.2'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030060 self.assertEqual(ns.timeout, 4.2)
61 self.checkError(['--timeout'], 'expected one argument')
62 self.checkError(['--timeout', 'foo'], 'invalid float value')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080063
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030064 def test_wait(self):
Victor Stinner3844fe52015-09-26 10:38:01 +020065 ns = libregrtest._parse_args(['--wait'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030066 self.assertTrue(ns.wait)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080067
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030068 def test_slaveargs(self):
Victor Stinner3844fe52015-09-26 10:38:01 +020069 ns = libregrtest._parse_args(['--slaveargs', '[[], {}]'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030070 self.assertEqual(ns.slaveargs, '[[], {}]')
71 self.checkError(['--slaveargs'], 'expected one argument')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080072
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030073 def test_start(self):
74 for opt in '-S', '--start':
75 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +020076 ns = libregrtest._parse_args([opt, 'foo'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030077 self.assertEqual(ns.start, 'foo')
78 self.checkError([opt], 'expected one argument')
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080079
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030080 def test_verbose(self):
Victor Stinner3844fe52015-09-26 10:38:01 +020081 ns = libregrtest._parse_args(['-v'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030082 self.assertEqual(ns.verbose, 1)
Victor Stinner3844fe52015-09-26 10:38:01 +020083 ns = libregrtest._parse_args(['-vvv'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030084 self.assertEqual(ns.verbose, 3)
Victor Stinner3844fe52015-09-26 10:38:01 +020085 ns = libregrtest._parse_args(['--verbose'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030086 self.assertEqual(ns.verbose, 1)
Victor Stinner3844fe52015-09-26 10:38:01 +020087 ns = libregrtest._parse_args(['--verbose'] * 3)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030088 self.assertEqual(ns.verbose, 3)
Victor Stinner3844fe52015-09-26 10:38:01 +020089 ns = libregrtest._parse_args([])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030090 self.assertEqual(ns.verbose, 0)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080091
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030092 def test_verbose2(self):
93 for opt in '-w', '--verbose2':
94 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +020095 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030096 self.assertTrue(ns.verbose2)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -080097
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +030098 def test_verbose3(self):
99 for opt in '-W', '--verbose3':
100 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200101 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300102 self.assertTrue(ns.verbose3)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800103
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300104 def test_quiet(self):
105 for opt in '-q', '--quiet':
106 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200107 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300108 self.assertTrue(ns.quiet)
109 self.assertEqual(ns.verbose, 0)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800110
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300111 def test_slow(self):
112 for opt in '-o', '--slow':
113 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200114 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300115 self.assertTrue(ns.print_slow)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800116
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300117 def test_header(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200118 ns = libregrtest._parse_args(['--header'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300119 self.assertTrue(ns.header)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800120
121 def test_randomize(self):
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300122 for opt in '-r', '--randomize':
123 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200124 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300125 self.assertTrue(ns.randomize)
126
127 def test_randseed(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200128 ns = libregrtest._parse_args(['--randseed', '12345'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300129 self.assertEqual(ns.random_seed, 12345)
130 self.assertTrue(ns.randomize)
131 self.checkError(['--randseed'], 'expected one argument')
132 self.checkError(['--randseed', 'foo'], 'invalid int value')
133
134 def test_fromfile(self):
135 for opt in '-f', '--fromfile':
136 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200137 ns = libregrtest._parse_args([opt, 'foo'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300138 self.assertEqual(ns.fromfile, 'foo')
139 self.checkError([opt], 'expected one argument')
140 self.checkError([opt, 'foo', '-s'], "don't go together")
141
142 def test_exclude(self):
143 for opt in '-x', '--exclude':
144 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200145 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300146 self.assertTrue(ns.exclude)
147
148 def test_single(self):
149 for opt in '-s', '--single':
150 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200151 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300152 self.assertTrue(ns.single)
153 self.checkError([opt, '-f', 'foo'], "don't go together")
154
155 def test_match(self):
156 for opt in '-m', '--match':
157 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200158 ns = libregrtest._parse_args([opt, 'pattern'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300159 self.assertEqual(ns.match_tests, 'pattern')
160 self.checkError([opt], 'expected one argument')
161
162 def test_failfast(self):
163 for opt in '-G', '--failfast':
164 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200165 ns = libregrtest._parse_args([opt, '-v'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300166 self.assertTrue(ns.failfast)
Victor Stinner3844fe52015-09-26 10:38:01 +0200167 ns = libregrtest._parse_args([opt, '-W'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300168 self.assertTrue(ns.failfast)
169 self.checkError([opt], '-G/--failfast needs either -v or -W')
170
171 def test_use(self):
172 for opt in '-u', '--use':
173 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200174 ns = libregrtest._parse_args([opt, 'gui,network'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300175 self.assertEqual(ns.use_resources, ['gui', 'network'])
Victor Stinner3844fe52015-09-26 10:38:01 +0200176 ns = libregrtest._parse_args([opt, 'gui,none,network'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300177 self.assertEqual(ns.use_resources, ['network'])
Victor Stinner98de5342015-09-26 09:43:45 +0200178 expected = list(libregrtest.RESOURCE_NAMES)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300179 expected.remove('gui')
Victor Stinner3844fe52015-09-26 10:38:01 +0200180 ns = libregrtest._parse_args([opt, 'all,-gui'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300181 self.assertEqual(ns.use_resources, expected)
182 self.checkError([opt], 'expected one argument')
183 self.checkError([opt, 'foo'], 'invalid resource')
184
185 def test_memlimit(self):
186 for opt in '-M', '--memlimit':
187 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200188 ns = libregrtest._parse_args([opt, '4G'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300189 self.assertEqual(ns.memlimit, '4G')
190 self.checkError([opt], 'expected one argument')
191
192 def test_testdir(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200193 ns = libregrtest._parse_args(['--testdir', 'foo'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300194 self.assertEqual(ns.testdir, os.path.join(support.SAVEDCWD, 'foo'))
195 self.checkError(['--testdir'], 'expected one argument')
196
Benjamin Peterson95536b82013-09-29 15:18:43 -0400197 def test_runleaks(self):
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300198 for opt in '-L', '--runleaks':
199 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200200 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300201 self.assertTrue(ns.runleaks)
202
Benjamin Peterson95536b82013-09-29 15:18:43 -0400203 def test_huntrleaks(self):
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300204 for opt in '-R', '--huntrleaks':
205 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200206 ns = libregrtest._parse_args([opt, ':'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300207 self.assertEqual(ns.huntrleaks, (5, 4, 'reflog.txt'))
Victor Stinner3844fe52015-09-26 10:38:01 +0200208 ns = libregrtest._parse_args([opt, '6:'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300209 self.assertEqual(ns.huntrleaks, (6, 4, 'reflog.txt'))
Victor Stinner3844fe52015-09-26 10:38:01 +0200210 ns = libregrtest._parse_args([opt, ':3'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300211 self.assertEqual(ns.huntrleaks, (5, 3, 'reflog.txt'))
Victor Stinner3844fe52015-09-26 10:38:01 +0200212 ns = libregrtest._parse_args([opt, '6:3:leaks.log'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300213 self.assertEqual(ns.huntrleaks, (6, 3, 'leaks.log'))
214 self.checkError([opt], 'expected one argument')
215 self.checkError([opt, '6'],
216 'needs 2 or 3 colon-separated arguments')
217 self.checkError([opt, 'foo:'], 'invalid huntrleaks value')
218 self.checkError([opt, '6:foo'], 'invalid huntrleaks value')
219
220 def test_multiprocess(self):
221 for opt in '-j', '--multiprocess':
222 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200223 ns = libregrtest._parse_args([opt, '2'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300224 self.assertEqual(ns.use_mp, 2)
225 self.checkError([opt], 'expected one argument')
226 self.checkError([opt, 'foo'], 'invalid int value')
227 self.checkError([opt, '2', '-T'], "don't go together")
228 self.checkError([opt, '2', '-l'], "don't go together")
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300229
Benjamin Peterson95536b82013-09-29 15:18:43 -0400230 def test_coverage(self):
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300231 for opt in '-T', '--coverage':
232 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200233 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300234 self.assertTrue(ns.trace)
235
236 def test_coverdir(self):
237 for opt in '-D', '--coverdir':
238 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200239 ns = libregrtest._parse_args([opt, 'foo'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300240 self.assertEqual(ns.coverdir,
241 os.path.join(support.SAVEDCWD, 'foo'))
242 self.checkError([opt], 'expected one argument')
243
244 def test_nocoverdir(self):
245 for opt in '-N', '--nocoverdir':
246 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200247 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300248 self.assertIsNone(ns.coverdir)
249
250 def test_threshold(self):
251 for opt in '-t', '--threshold':
252 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200253 ns = libregrtest._parse_args([opt, '1000'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300254 self.assertEqual(ns.threshold, 1000)
255 self.checkError([opt], 'expected one argument')
256 self.checkError([opt, 'foo'], 'invalid int value')
257
258 def test_nowindows(self):
259 for opt in '-n', '--nowindows':
260 with self.subTest(opt=opt):
Victor Stinner14b46622015-10-11 10:04:26 +0200261 with contextlib.redirect_stderr(io.StringIO()) as stderr:
262 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300263 self.assertTrue(ns.nowindows)
Victor Stinner14b46622015-10-11 10:04:26 +0200264 err = stderr.getvalue()
265 self.assertIn('the --nowindows (-n) option is deprecated', err)
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300266
267 def test_forever(self):
268 for opt in '-F', '--forever':
269 with self.subTest(opt=opt):
Victor Stinner3844fe52015-09-26 10:38:01 +0200270 ns = libregrtest._parse_args([opt])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300271 self.assertTrue(ns.forever)
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800272
273
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300274 def test_unrecognized_argument(self):
275 self.checkError(['--xxx'], 'usage:')
276
277 def test_long_option__partial(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200278 ns = libregrtest._parse_args(['--qui'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300279 self.assertTrue(ns.quiet)
280 self.assertEqual(ns.verbose, 0)
281
282 def test_two_options(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200283 ns = libregrtest._parse_args(['--quiet', '--exclude'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300284 self.assertTrue(ns.quiet)
285 self.assertEqual(ns.verbose, 0)
286 self.assertTrue(ns.exclude)
287
288 def test_option_with_empty_string_value(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200289 ns = libregrtest._parse_args(['--start', ''])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300290 self.assertEqual(ns.start, '')
291
292 def test_arg(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200293 ns = libregrtest._parse_args(['foo'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300294 self.assertEqual(ns.args, ['foo'])
295
296 def test_option_and_arg(self):
Victor Stinner3844fe52015-09-26 10:38:01 +0200297 ns = libregrtest._parse_args(['--quiet', 'foo'])
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300298 self.assertTrue(ns.quiet)
299 self.assertEqual(ns.verbose, 0)
300 self.assertEqual(ns.args, ['foo'])
301
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800302
Victor Stinner6b415102015-09-28 23:16:17 +0200303class BaseTestCase(unittest.TestCase):
304 TEST_UNIQUE_ID = 1
305 TESTNAME_PREFIX = 'test_regrtest_'
306 TESTNAME_REGEX = r'test_[a-z0-9_]+'
307
308 def setUp(self):
309 self.testdir = os.path.join(ROOT_DIR, 'Lib', 'test')
310
311 # When test_regrtest is interrupted by CTRL+c, it can leave
312 # temporary test files
313 remove = [entry.path
314 for entry in os.scandir(self.testdir)
315 if (entry.name.startswith(self.TESTNAME_PREFIX)
316 and entry.name.endswith(".py"))]
317 for path in remove:
318 print("WARNING: test_regrtest: remove %s" % path)
319 support.unlink(path)
320
321 def create_test(self, name=None, code=''):
322 if not name:
323 name = 'noop%s' % BaseTestCase.TEST_UNIQUE_ID
324 BaseTestCase.TEST_UNIQUE_ID += 1
325
326 # test_regrtest cannot be run twice in parallel because
327 # of setUp() and create_test()
328 name = self.TESTNAME_PREFIX + "%s_%s" % (os.getpid(), name)
329 path = os.path.join(self.testdir, name + '.py')
330
331 self.addCleanup(support.unlink, path)
332 # Use 'x' mode to ensure that we do not override existing tests
333 with open(path, 'x', encoding='utf-8') as fp:
334 fp.write(code)
335 return name
336
337 def regex_search(self, regex, output):
338 match = re.search(regex, output, re.MULTILINE)
339 if not match:
340 self.fail("%r not found in %r" % (regex, output))
341 return match
342
343 def check_line(self, output, regex):
344 regex = re.compile(r'^' + regex, re.MULTILINE)
345 self.assertRegex(output, regex)
346
347 def parse_executed_tests(self, output):
Victor Stinner9a142142015-09-30 13:51:17 +0200348 regex = r'^\[ *[0-9]+(?:/ *[0-9]+)?\] (%s)$' % self.TESTNAME_REGEX
349 parser = re.finditer(regex, output, re.MULTILINE)
350 return list(match.group(1) for match in parser)
Victor Stinner6b415102015-09-28 23:16:17 +0200351
Victor Stinner9a142142015-09-30 13:51:17 +0200352 def check_executed_tests(self, output, tests, skipped=(), failed=(),
Victor Stinner3909e582015-10-11 10:37:25 +0200353 omitted=(), randomize=False):
Victor Stinner6b415102015-09-28 23:16:17 +0200354 if isinstance(tests, str):
355 tests = [tests]
Victor Stinner9a142142015-09-30 13:51:17 +0200356 if isinstance(skipped, str):
357 skipped = [skipped]
358 if isinstance(failed, str):
359 failed = [failed]
Victor Stinner3909e582015-10-11 10:37:25 +0200360 if isinstance(omitted, str):
361 omitted = [omitted]
Victor Stinner6b415102015-09-28 23:16:17 +0200362 ntest = len(tests)
Victor Stinner9a142142015-09-30 13:51:17 +0200363 nskipped = len(skipped)
364 nfailed = len(failed)
Victor Stinner3909e582015-10-11 10:37:25 +0200365 nomitted = len(omitted)
Victor Stinner6b415102015-09-28 23:16:17 +0200366
Victor Stinner9a142142015-09-30 13:51:17 +0200367 executed = self.parse_executed_tests(output)
368 if randomize:
369 self.assertEqual(set(executed), set(tests), output)
Victor Stinner6b415102015-09-28 23:16:17 +0200370 else:
Victor Stinner9a142142015-09-30 13:51:17 +0200371 self.assertEqual(executed, tests, output)
372
373 def plural(count):
374 return 's' if count != 1 else ''
375
376 def list_regex(line_format, tests):
377 count = len(tests)
378 names = ' '.join(sorted(tests))
379 regex = line_format % (count, plural(count))
380 regex = r'%s:\n %s$' % (regex, names)
381 return regex
382
383 if skipped:
384 regex = list_regex('%s test%s skipped', skipped)
385 self.check_line(output, regex)
386
387 if failed:
388 regex = list_regex('%s test%s failed', failed)
389 self.check_line(output, regex)
390
Victor Stinner3909e582015-10-11 10:37:25 +0200391 if omitted:
392 regex = list_regex('%s test%s omitted', omitted)
393 self.check_line(output, regex)
394
395 good = ntest - nskipped - nfailed - nomitted
Victor Stinner9a142142015-09-30 13:51:17 +0200396 if good:
397 regex = r'%s test%s OK\.$' % (good, plural(good))
398 if not skipped and not failed and good > 1:
399 regex = 'All %s' % regex
400 self.check_line(output, regex)
Victor Stinner6b415102015-09-28 23:16:17 +0200401
402 def parse_random_seed(self, output):
403 match = self.regex_search(r'Using random seed ([0-9]+)', output)
404 randseed = int(match.group(1))
405 self.assertTrue(0 <= randseed <= 10000000, randseed)
406 return randseed
407
Victor Stinner076fc872015-10-03 00:20:56 +0200408 def run_command(self, args, input=None, exitcode=0, **kw):
Victor Stinner42771342015-09-29 14:17:09 +0200409 if not input:
410 input = ''
Victor Stinner076fc872015-10-03 00:20:56 +0200411 if 'stderr' not in kw:
412 kw['stderr'] = subprocess.PIPE
Victor Stinner9a142142015-09-30 13:51:17 +0200413 proc = subprocess.run(args,
414 universal_newlines=True,
415 input=input,
416 stdout=subprocess.PIPE,
Victor Stinner076fc872015-10-03 00:20:56 +0200417 **kw)
Victor Stinner9a142142015-09-30 13:51:17 +0200418 if proc.returncode != exitcode:
Victor Stinner076fc872015-10-03 00:20:56 +0200419 msg = ("Command %s failed with exit code %s\n"
420 "\n"
421 "stdout:\n"
422 "---\n"
423 "%s\n"
424 "---\n"
425 % (str(args), proc.returncode, proc.stdout))
426 if proc.stderr:
427 msg += ("\n"
428 "stderr:\n"
429 "---\n"
430 "%s"
431 "---\n"
432 % proc.stderr)
433 self.fail(msg)
Victor Stinner9a142142015-09-30 13:51:17 +0200434 return proc
Victor Stinner42771342015-09-29 14:17:09 +0200435
436
437 def run_python(self, args, **kw):
438 args = [sys.executable, '-X', 'faulthandler', '-I', *args]
439 proc = self.run_command(args, **kw)
440 return proc.stdout
441
Victor Stinner6b415102015-09-28 23:16:17 +0200442
443class ProgramsTestCase(BaseTestCase):
444 """
445 Test various ways to run the Python test suite. Use options close
446 to options used on the buildbot.
447 """
448
449 NTEST = 4
450
451 def setUp(self):
452 super().setUp()
453
454 # Create NTEST tests doing nothing
455 self.tests = [self.create_test() for index in range(self.NTEST)]
456
457 self.python_args = ['-Wd', '-E', '-bb']
Victor Stinner49671462015-10-11 10:03:28 +0200458 self.regrtest_args = ['-uall', '-rwW']
459 if hasattr(faulthandler, 'dump_traceback_later'):
460 self.regrtest_args.extend(('--timeout', '3600', '-j4'))
Victor Stinner6b415102015-09-28 23:16:17 +0200461 if sys.platform == 'win32':
462 self.regrtest_args.append('-n')
463
464 def check_output(self, output):
465 self.parse_random_seed(output)
Victor Stinner9a142142015-09-30 13:51:17 +0200466 self.check_executed_tests(output, self.tests, randomize=True)
Victor Stinner6b415102015-09-28 23:16:17 +0200467
468 def run_tests(self, args):
Victor Stinner9a142142015-09-30 13:51:17 +0200469 output = self.run_python(args)
470 self.check_output(output)
Victor Stinner6b415102015-09-28 23:16:17 +0200471
472 def test_script_regrtest(self):
473 # Lib/test/regrtest.py
474 script = os.path.join(ROOT_DIR, 'Lib', 'test', 'regrtest.py')
475
476 args = [*self.python_args, script, *self.regrtest_args, *self.tests]
477 self.run_tests(args)
478
479 def test_module_test(self):
480 # -m test
481 args = [*self.python_args, '-m', 'test',
482 *self.regrtest_args, *self.tests]
483 self.run_tests(args)
484
485 def test_module_regrtest(self):
486 # -m test.regrtest
487 args = [*self.python_args, '-m', 'test.regrtest',
488 *self.regrtest_args, *self.tests]
489 self.run_tests(args)
490
491 def test_module_autotest(self):
492 # -m test.autotest
493 args = [*self.python_args, '-m', 'test.autotest',
494 *self.regrtest_args, *self.tests]
495 self.run_tests(args)
496
497 def test_module_from_test_autotest(self):
498 # from test import autotest
499 code = 'from test import autotest'
500 args = [*self.python_args, '-c', code,
501 *self.regrtest_args, *self.tests]
502 self.run_tests(args)
503
504 def test_script_autotest(self):
505 # Lib/test/autotest.py
506 script = os.path.join(ROOT_DIR, 'Lib', 'test', 'autotest.py')
507 args = [*self.python_args, script, *self.regrtest_args, *self.tests]
508 self.run_tests(args)
509
510 def test_tools_script_run_tests(self):
511 # Tools/scripts/run_tests.py
512 script = os.path.join(ROOT_DIR, 'Tools', 'scripts', 'run_tests.py')
513 self.run_tests([script, *self.tests])
514
Victor Stinnere143c1f2015-09-29 01:02:37 +0200515 def run_batch(self, *args):
Victor Stinner42771342015-09-29 14:17:09 +0200516 proc = self.run_command(args)
Victor Stinner6b415102015-09-28 23:16:17 +0200517 self.check_output(proc.stdout)
518
519 @unittest.skipUnless(sys.platform == 'win32', 'Windows only')
520 def test_tools_buildbot_test(self):
521 # Tools\buildbot\test.bat
522 script = os.path.join(ROOT_DIR, 'Tools', 'buildbot', 'test.bat')
Victor Stinnere143c1f2015-09-29 01:02:37 +0200523 test_args = []
524 if platform.architecture()[0] == '64bit':
525 test_args.append('-x64') # 64-bit build
526 if not Py_DEBUG:
527 test_args.append('+d') # Release build, use python.exe
528 self.run_batch(script, *test_args, *self.tests)
Victor Stinner6b415102015-09-28 23:16:17 +0200529
530 @unittest.skipUnless(sys.platform == 'win32', 'Windows only')
531 def test_pcbuild_rt(self):
532 # PCbuild\rt.bat
533 script = os.path.join(ROOT_DIR, r'PCbuild\rt.bat')
Victor Stinnere143c1f2015-09-29 01:02:37 +0200534 rt_args = ["-q"] # Quick, don't run tests twice
535 if platform.architecture()[0] == '64bit':
536 rt_args.append('-x64') # 64-bit build
537 if Py_DEBUG:
538 rt_args.append('-d') # Debug build, use python_d.exe
539 self.run_batch(script, *rt_args, *self.regrtest_args, *self.tests)
Victor Stinner6b415102015-09-28 23:16:17 +0200540
541
542class ArgsTestCase(BaseTestCase):
543 """
544 Test arguments of the Python test suite.
545 """
546
Victor Stinner9a142142015-09-30 13:51:17 +0200547 def run_tests(self, *args, **kw):
548 return self.run_python(['-m', 'test', *args], **kw)
549
550 def test_failing_test(self):
551 # test a failing test
552 code = textwrap.dedent("""
553 import unittest
554
555 class FailingTest(unittest.TestCase):
556 def test_failing(self):
557 self.fail("bug")
558 """)
559 test_ok = self.create_test()
560 test_failing = self.create_test(code=code)
561 tests = [test_ok, test_failing]
562
563 output = self.run_tests(*tests, exitcode=1)
564 self.check_executed_tests(output, tests, failed=test_failing)
Victor Stinner6b415102015-09-28 23:16:17 +0200565
566 def test_resources(self):
567 # test -u command line option
568 tests = {}
569 for resource in ('audio', 'network'):
570 code = 'from test import support\nsupport.requires(%r)' % resource
571 tests[resource] = self.create_test(resource, code)
572 test_names = sorted(tests.values())
573
574 # -u all: 2 resources enabled
575 output = self.run_tests('-u', 'all', *test_names)
576 self.check_executed_tests(output, test_names)
577
578 # -u audio: 1 resource enabled
579 output = self.run_tests('-uaudio', *test_names)
580 self.check_executed_tests(output, test_names,
581 skipped=tests['network'])
582
583 # no option: 0 resources enabled
584 output = self.run_tests(*test_names)
585 self.check_executed_tests(output, test_names,
586 skipped=test_names)
587
588 def test_random(self):
589 # test -r and --randseed command line option
590 code = textwrap.dedent("""
591 import random
592 print("TESTRANDOM: %s" % random.randint(1, 1000))
593 """)
594 test = self.create_test('random', code)
595
596 # first run to get the output with the random seed
597 output = self.run_tests('-r', test)
598 randseed = self.parse_random_seed(output)
599 match = self.regex_search(r'TESTRANDOM: ([0-9]+)', output)
600 test_random = int(match.group(1))
601
602 # try to reproduce with the random seed
603 output = self.run_tests('-r', '--randseed=%s' % randseed, test)
604 randseed2 = self.parse_random_seed(output)
605 self.assertEqual(randseed2, randseed)
606
607 match = self.regex_search(r'TESTRANDOM: ([0-9]+)', output)
608 test_random2 = int(match.group(1))
609 self.assertEqual(test_random2, test_random)
610
611 def test_fromfile(self):
612 # test --fromfile
613 tests = [self.create_test() for index in range(5)]
614
615 # Write the list of files using a format similar to regrtest output:
616 # [1/2] test_1
617 # [2/2] test_2
618 filename = support.TESTFN
619 self.addCleanup(support.unlink, filename)
620 with open(filename, "w") as fp:
621 for index, name in enumerate(tests, 1):
622 print("[%s/%s] %s" % (index, len(tests), name), file=fp)
623
624 output = self.run_tests('--fromfile', filename)
625 self.check_executed_tests(output, tests)
626
Victor Stinner3909e582015-10-11 10:37:25 +0200627 def test_interrupted(self):
628 code = TEST_INTERRUPTED
629 test = self.create_test("sigint", code=code)
630 output = self.run_tests(test, exitcode=1)
631 self.check_executed_tests(output, test, omitted=test)
632
Victor Stinner6b415102015-09-28 23:16:17 +0200633 def test_slow(self):
634 # test --slow
635 tests = [self.create_test() for index in range(3)]
636 output = self.run_tests("--slow", *tests)
637 self.check_executed_tests(output, tests)
638 regex = ('10 slowest tests:\n'
639 '(?:%s: [0-9]+\.[0-9]+s\n){%s}'
640 % (self.TESTNAME_REGEX, len(tests)))
641 self.check_line(output, regex)
642
Victor Stinner3909e582015-10-11 10:37:25 +0200643 def test_slow_interrupted(self):
644 # Issue #25373: test --slow with an interrupted test
645 code = TEST_INTERRUPTED
646 test = self.create_test("sigint", code=code)
647
648 for multiprocessing in (False, True):
649 if multiprocessing:
650 args = ("--slow", "-j2", test)
651 else:
652 args = ("--slow", test)
653 output = self.run_tests(*args, exitcode=1)
654 self.check_executed_tests(output, test, omitted=test)
655 regex = ('10 slowest tests:\n')
656 self.check_line(output, regex)
657 self.check_line(output, 'Test suite interrupted by signal SIGINT.')
658
Victor Stinner6b415102015-09-28 23:16:17 +0200659 def test_coverage(self):
660 # test --coverage
661 test = self.create_test()
662 output = self.run_tests("--coverage", test)
Victor Stinner9a142142015-09-30 13:51:17 +0200663 self.check_executed_tests(output, [test])
Victor Stinner6b415102015-09-28 23:16:17 +0200664 regex = ('lines +cov% +module +\(path\)\n'
665 '(?: *[0-9]+ *[0-9]{1,2}% *[^ ]+ +\([^)]+\)+)+')
666 self.check_line(output, regex)
667
Victor Stinner42771342015-09-29 14:17:09 +0200668 def test_wait(self):
669 # test --wait
670 test = self.create_test()
671 output = self.run_tests("--wait", test, input='key')
672 self.check_line(output, 'Press any key to continue')
673
Victor Stinner9a142142015-09-30 13:51:17 +0200674 def test_forever(self):
675 # test --forever
676 code = textwrap.dedent("""
677 import unittest
678
679 class ForeverTester(unittest.TestCase):
680 RUN = 1
681
682 def test_run(self):
683 ForeverTester.RUN += 1
684 if ForeverTester.RUN > 3:
685 self.fail("fail at the 3rd runs")
686 """)
687 test = self.create_test(code=code)
688 output = self.run_tests('--forever', test, exitcode=1)
689 self.check_executed_tests(output, [test]*3, failed=test)
690
Victor Stinner46d75352015-10-03 02:21:35 +0200691 @unittest.skipUnless(Py_DEBUG, 'need a debug build')
Victor Stinner076fc872015-10-03 00:20:56 +0200692 def test_huntrleaks_fd_leak(self):
693 # test --huntrleaks for file descriptor leak
694 code = textwrap.dedent("""
695 import os
696 import unittest
697
Victor Stinner20d21182015-10-03 21:40:21 +0200698 # Issue #25306: Disable popups and logs to stderr on assertion
699 # failures in MSCRT
700 try:
701 import msvcrt
702 msvcrt.CrtSetReportMode
703 except (ImportError, AttributeError):
704 # no Windows, o release build
705 pass
706 else:
707 for m in [msvcrt.CRT_WARN, msvcrt.CRT_ERROR, msvcrt.CRT_ASSERT]:
708 msvcrt.CrtSetReportMode(m, 0)
709
Victor Stinner076fc872015-10-03 00:20:56 +0200710 class FDLeakTest(unittest.TestCase):
711 def test_leak(self):
712 fd = os.open(__file__, os.O_RDONLY)
713 # bug: never cloes the file descriptor
714 """)
715 test = self.create_test(code=code)
716
717 filename = 'reflog.txt'
718 self.addCleanup(support.unlink, filename)
719 output = self.run_tests('--huntrleaks', '3:3:', test,
720 exitcode=1,
721 stderr=subprocess.STDOUT)
722 self.check_executed_tests(output, [test], failed=test)
723
724 line = 'beginning 6 repetitions\n123456\n......\n'
725 self.check_line(output, re.escape(line))
726
727 line2 = '%s leaked [1, 1, 1] file descriptors, sum=3\n' % test
728 self.check_line(output, re.escape(line2))
729
730 with open(filename) as fp:
731 reflog = fp.read()
732 self.assertEqual(reflog, line2)
733
Victor Stinner5f9d3ac2015-10-03 00:21:12 +0200734 def test_list_tests(self):
735 # test --list-tests
736 tests = [self.create_test() for i in range(5)]
737 output = self.run_tests('--list-tests', *tests)
738 self.assertEqual(output.rstrip().splitlines(),
739 tests)
740
Victor Stinner6b415102015-09-28 23:16:17 +0200741
Chris Jerdonekd6c18dc2012-12-27 18:53:12 -0800742if __name__ == '__main__':
Serhiy Storchaka64f7c4e2013-08-29 12:26:23 +0300743 unittest.main()