##// END OF EJS Templates
run-tests: be more paranoid about os.system using bytes
Augie Fackler -
r25056:e5f6c6ec default
parent child Browse files
Show More
@@ -1,2170 +1,2173
1 1 #!/usr/bin/env python
2 2 #
3 3 # run-tests.py - Run a set of tests on Mercurial
4 4 #
5 5 # Copyright 2006 Matt Mackall <mpm@selenic.com>
6 6 #
7 7 # This software may be used and distributed according to the terms of the
8 8 # GNU General Public License version 2 or any later version.
9 9
10 10 # Modifying this script is tricky because it has many modes:
11 11 # - serial (default) vs parallel (-jN, N > 1)
12 12 # - no coverage (default) vs coverage (-c, -C, -s)
13 13 # - temp install (default) vs specific hg script (--with-hg, --local)
14 14 # - tests are a mix of shell scripts and Python scripts
15 15 #
16 16 # If you change this script, it is recommended that you ensure you
17 17 # haven't broken it by running it in various modes with a representative
18 18 # sample of test scripts. For example:
19 19 #
20 20 # 1) serial, no coverage, temp install:
21 21 # ./run-tests.py test-s*
22 22 # 2) serial, no coverage, local hg:
23 23 # ./run-tests.py --local test-s*
24 24 # 3) serial, coverage, temp install:
25 25 # ./run-tests.py -c test-s*
26 26 # 4) serial, coverage, local hg:
27 27 # ./run-tests.py -c --local test-s* # unsupported
28 28 # 5) parallel, no coverage, temp install:
29 29 # ./run-tests.py -j2 test-s*
30 30 # 6) parallel, no coverage, local hg:
31 31 # ./run-tests.py -j2 --local test-s*
32 32 # 7) parallel, coverage, temp install:
33 33 # ./run-tests.py -j2 -c test-s* # currently broken
34 34 # 8) parallel, coverage, local install:
35 35 # ./run-tests.py -j2 -c --local test-s* # unsupported (and broken)
36 36 # 9) parallel, custom tmp dir:
37 37 # ./run-tests.py -j2 --tmpdir /tmp/myhgtests
38 38 #
39 39 # (You could use any subset of the tests: test-s* happens to match
40 40 # enough that it's worth doing parallel runs, few enough that it
41 41 # completes fairly quickly, includes both shell and Python scripts, and
42 42 # includes some scripts that run daemon processes.)
43 43
44 44 from __future__ import print_function
45 45
46 46 from distutils import version
47 47 import difflib
48 48 import errno
49 49 import optparse
50 50 import os
51 51 import shutil
52 52 import subprocess
53 53 import signal
54 54 import socket
55 55 import sys
56 56 import tempfile
57 57 import time
58 58 import random
59 59 import re
60 60 import threading
61 61 import killdaemons as killmod
62 62 try:
63 63 import Queue as queue
64 64 except ImportError:
65 65 import queue
66 66 from xml.dom import minidom
67 67 import unittest
68 68
69 69 osenvironb = getattr(os, 'environb', os.environ)
70 70
71 71 try:
72 72 import json
73 73 except ImportError:
74 74 try:
75 75 import simplejson as json
76 76 except ImportError:
77 77 json = None
78 78
79 79 processlock = threading.Lock()
80 80
81 81 if sys.version_info > (3, 0, 0):
82 82 xrange = range # we use xrange in one place, and we'd rather not use range
83 83
84 84 # subprocess._cleanup can race with any Popen.wait or Popen.poll on py24
85 85 # http://bugs.python.org/issue1731717 for details. We shouldn't be producing
86 86 # zombies but it's pretty harmless even if we do.
87 87 if sys.version_info < (2, 5):
88 88 subprocess._cleanup = lambda: None
89 89
90 90 wifexited = getattr(os, "WIFEXITED", lambda x: False)
91 91
92 92 def checkportisavailable(port):
93 93 """return true if a port seems free to bind on localhost"""
94 94 try:
95 95 s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
96 96 s.bind(('localhost', port))
97 97 s.close()
98 98 return True
99 99 except socket.error as exc:
100 100 if not exc.errno == errno.EADDRINUSE:
101 101 raise
102 102 return False
103 103
104 104 closefds = os.name == 'posix'
105 105 def Popen4(cmd, wd, timeout, env=None):
106 106 processlock.acquire()
107 107 p = subprocess.Popen(cmd, shell=True, bufsize=-1, cwd=wd, env=env,
108 108 close_fds=closefds,
109 109 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
110 110 stderr=subprocess.STDOUT)
111 111 processlock.release()
112 112
113 113 p.fromchild = p.stdout
114 114 p.tochild = p.stdin
115 115 p.childerr = p.stderr
116 116
117 117 p.timeout = False
118 118 if timeout:
119 119 def t():
120 120 start = time.time()
121 121 while time.time() - start < timeout and p.returncode is None:
122 122 time.sleep(.1)
123 123 p.timeout = True
124 124 if p.returncode is None:
125 125 terminate(p)
126 126 threading.Thread(target=t).start()
127 127
128 128 return p
129 129
130 130 PYTHON = sys.executable.replace('\\', '/')
131 131 IMPL_PATH = b'PYTHONPATH'
132 132 if 'java' in sys.platform:
133 133 IMPL_PATH = b'JYTHONPATH'
134 134
135 135 defaults = {
136 136 'jobs': ('HGTEST_JOBS', 1),
137 137 'timeout': ('HGTEST_TIMEOUT', 180),
138 138 'port': ('HGTEST_PORT', 20059),
139 139 'shell': ('HGTEST_SHELL', 'sh'),
140 140 }
141 141
142 142 def parselistfiles(files, listtype, warn=True):
143 143 entries = dict()
144 144 for filename in files:
145 145 try:
146 146 path = os.path.expanduser(os.path.expandvars(filename))
147 147 f = open(path, "rb")
148 148 except IOError as err:
149 149 if err.errno != errno.ENOENT:
150 150 raise
151 151 if warn:
152 152 print("warning: no such %s file: %s" % (listtype, filename))
153 153 continue
154 154
155 155 for line in f.readlines():
156 156 line = line.split(b'#', 1)[0].strip()
157 157 if line:
158 158 entries[line] = filename
159 159
160 160 f.close()
161 161 return entries
162 162
163 163 def getparser():
164 164 """Obtain the OptionParser used by the CLI."""
165 165 parser = optparse.OptionParser("%prog [options] [tests]")
166 166
167 167 # keep these sorted
168 168 parser.add_option("--blacklist", action="append",
169 169 help="skip tests listed in the specified blacklist file")
170 170 parser.add_option("--whitelist", action="append",
171 171 help="always run tests listed in the specified whitelist file")
172 172 parser.add_option("--changed", type="string",
173 173 help="run tests that are changed in parent rev or working directory")
174 174 parser.add_option("-C", "--annotate", action="store_true",
175 175 help="output files annotated with coverage")
176 176 parser.add_option("-c", "--cover", action="store_true",
177 177 help="print a test coverage report")
178 178 parser.add_option("-d", "--debug", action="store_true",
179 179 help="debug mode: write output of test scripts to console"
180 180 " rather than capturing and diffing it (disables timeout)")
181 181 parser.add_option("-f", "--first", action="store_true",
182 182 help="exit on the first test failure")
183 183 parser.add_option("-H", "--htmlcov", action="store_true",
184 184 help="create an HTML report of the coverage of the files")
185 185 parser.add_option("-i", "--interactive", action="store_true",
186 186 help="prompt to accept changed output")
187 187 parser.add_option("-j", "--jobs", type="int",
188 188 help="number of jobs to run in parallel"
189 189 " (default: $%s or %d)" % defaults['jobs'])
190 190 parser.add_option("--keep-tmpdir", action="store_true",
191 191 help="keep temporary directory after running tests")
192 192 parser.add_option("-k", "--keywords",
193 193 help="run tests matching keywords")
194 194 parser.add_option("-l", "--local", action="store_true",
195 195 help="shortcut for --with-hg=<testdir>/../hg")
196 196 parser.add_option("--loop", action="store_true",
197 197 help="loop tests repeatedly")
198 198 parser.add_option("--runs-per-test", type="int", dest="runs_per_test",
199 199 help="run each test N times (default=1)", default=1)
200 200 parser.add_option("-n", "--nodiff", action="store_true",
201 201 help="skip showing test changes")
202 202 parser.add_option("-p", "--port", type="int",
203 203 help="port on which servers should listen"
204 204 " (default: $%s or %d)" % defaults['port'])
205 205 parser.add_option("--compiler", type="string",
206 206 help="compiler to build with")
207 207 parser.add_option("--pure", action="store_true",
208 208 help="use pure Python code instead of C extensions")
209 209 parser.add_option("-R", "--restart", action="store_true",
210 210 help="restart at last error")
211 211 parser.add_option("-r", "--retest", action="store_true",
212 212 help="retest failed tests")
213 213 parser.add_option("-S", "--noskips", action="store_true",
214 214 help="don't report skip tests verbosely")
215 215 parser.add_option("--shell", type="string",
216 216 help="shell to use (default: $%s or %s)" % defaults['shell'])
217 217 parser.add_option("-t", "--timeout", type="int",
218 218 help="kill errant tests after TIMEOUT seconds"
219 219 " (default: $%s or %d)" % defaults['timeout'])
220 220 parser.add_option("--time", action="store_true",
221 221 help="time how long each test takes")
222 222 parser.add_option("--json", action="store_true",
223 223 help="store test result data in 'report.json' file")
224 224 parser.add_option("--tmpdir", type="string",
225 225 help="run tests in the given temporary directory"
226 226 " (implies --keep-tmpdir)")
227 227 parser.add_option("-v", "--verbose", action="store_true",
228 228 help="output verbose messages")
229 229 parser.add_option("--xunit", type="string",
230 230 help="record xunit results at specified path")
231 231 parser.add_option("--view", type="string",
232 232 help="external diff viewer")
233 233 parser.add_option("--with-hg", type="string",
234 234 metavar="HG",
235 235 help="test using specified hg script rather than a "
236 236 "temporary installation")
237 237 parser.add_option("-3", "--py3k-warnings", action="store_true",
238 238 help="enable Py3k warnings on Python 2.6+")
239 239 parser.add_option('--extra-config-opt', action="append",
240 240 help='set the given config opt in the test hgrc')
241 241 parser.add_option('--random', action="store_true",
242 242 help='run tests in random order')
243 243
244 244 for option, (envvar, default) in defaults.items():
245 245 defaults[option] = type(default)(os.environ.get(envvar, default))
246 246 parser.set_defaults(**defaults)
247 247
248 248 return parser
249 249
250 250 def parseargs(args, parser):
251 251 """Parse arguments with our OptionParser and validate results."""
252 252 (options, args) = parser.parse_args(args)
253 253
254 254 # jython is always pure
255 255 if 'java' in sys.platform or '__pypy__' in sys.modules:
256 256 options.pure = True
257 257
258 258 if options.with_hg:
259 259 options.with_hg = os.path.expanduser(options.with_hg)
260 260 if not (os.path.isfile(options.with_hg) and
261 261 os.access(options.with_hg, os.X_OK)):
262 262 parser.error('--with-hg must specify an executable hg script')
263 263 if not os.path.basename(options.with_hg) == 'hg':
264 264 sys.stderr.write('warning: --with-hg should specify an hg script\n')
265 265 if options.local:
266 266 testdir = os.path.dirname(os.path.realpath(sys.argv[0]).encode('utf-8'))
267 267 hgbin = os.path.join(os.path.dirname(testdir), b'hg')
268 268 if os.name != 'nt' and not os.access(hgbin, os.X_OK):
269 269 parser.error('--local specified, but %r not found or not executable'
270 270 % hgbin)
271 271 options.with_hg = hgbin
272 272
273 273 options.anycoverage = options.cover or options.annotate or options.htmlcov
274 274 if options.anycoverage:
275 275 try:
276 276 import coverage
277 277 covver = version.StrictVersion(coverage.__version__).version
278 278 if covver < (3, 3):
279 279 parser.error('coverage options require coverage 3.3 or later')
280 280 except ImportError:
281 281 parser.error('coverage options now require the coverage package')
282 282
283 283 if options.anycoverage and options.local:
284 284 # this needs some path mangling somewhere, I guess
285 285 parser.error("sorry, coverage options do not work when --local "
286 286 "is specified")
287 287
288 288 if options.anycoverage and options.with_hg:
289 289 parser.error("sorry, coverage options do not work when --with-hg "
290 290 "is specified")
291 291
292 292 global verbose
293 293 if options.verbose:
294 294 verbose = ''
295 295
296 296 if options.tmpdir:
297 297 options.tmpdir = os.path.expanduser(options.tmpdir)
298 298
299 299 if options.jobs < 1:
300 300 parser.error('--jobs must be positive')
301 301 if options.interactive and options.debug:
302 302 parser.error("-i/--interactive and -d/--debug are incompatible")
303 303 if options.debug:
304 304 if options.timeout != defaults['timeout']:
305 305 sys.stderr.write(
306 306 'warning: --timeout option ignored with --debug\n')
307 307 options.timeout = 0
308 308 if options.py3k_warnings:
309 309 if sys.version_info[:2] < (2, 6) or sys.version_info[:2] >= (3, 0):
310 310 parser.error('--py3k-warnings can only be used on Python 2.6+')
311 311 if options.blacklist:
312 312 options.blacklist = parselistfiles(options.blacklist, 'blacklist')
313 313 if options.whitelist:
314 314 options.whitelisted = parselistfiles(options.whitelist, 'whitelist')
315 315 else:
316 316 options.whitelisted = {}
317 317
318 318 return (options, args)
319 319
320 320 def rename(src, dst):
321 321 """Like os.rename(), trade atomicity and opened files friendliness
322 322 for existing destination support.
323 323 """
324 324 shutil.copy(src, dst)
325 325 os.remove(src)
326 326
327 327 _unified_diff = difflib.unified_diff
328 328 if sys.version_info[0] > 2:
329 329 import functools
330 330 _unified_diff = functools.partial(difflib.diff_bytes, difflib.unified_diff)
331 331
332 332 def getdiff(expected, output, ref, err):
333 333 servefail = False
334 334 lines = []
335 335 for line in _unified_diff(expected, output, ref, err):
336 336 if line.startswith(b'+++') or line.startswith(b'---'):
337 337 line = line.replace(b'\\', b'/')
338 338 if line.endswith(b' \n'):
339 339 line = line[:-2] + b'\n'
340 340 lines.append(line)
341 341 if not servefail and line.startswith(
342 342 b'+ abort: child process failed to start'):
343 343 servefail = True
344 344
345 345 return servefail, lines
346 346
347 347 verbose = False
348 348 def vlog(*msg):
349 349 """Log only when in verbose mode."""
350 350 if verbose is False:
351 351 return
352 352
353 353 return log(*msg)
354 354
355 355 # Bytes that break XML even in a CDATA block: control characters 0-31
356 356 # sans \t, \n and \r
357 357 CDATA_EVIL = re.compile(br"[\000-\010\013\014\016-\037]")
358 358
359 359 def cdatasafe(data):
360 360 """Make a string safe to include in a CDATA block.
361 361
362 362 Certain control characters are illegal in a CDATA block, and
363 363 there's no way to include a ]]> in a CDATA either. This function
364 364 replaces illegal bytes with ? and adds a space between the ]] so
365 365 that it won't break the CDATA block.
366 366 """
367 367 return CDATA_EVIL.sub(b'?', data).replace(b']]>', b'] ]>')
368 368
369 369 def log(*msg):
370 370 """Log something to stdout.
371 371
372 372 Arguments are strings to print.
373 373 """
374 374 with iolock:
375 375 if verbose:
376 376 print(verbose, end=' ')
377 377 for m in msg:
378 378 print(m, end=' ')
379 379 print()
380 380 sys.stdout.flush()
381 381
382 382 def terminate(proc):
383 383 """Terminate subprocess (with fallback for Python versions < 2.6)"""
384 384 vlog('# Terminating process %d' % proc.pid)
385 385 try:
386 386 getattr(proc, 'terminate', lambda : os.kill(proc.pid, signal.SIGTERM))()
387 387 except OSError:
388 388 pass
389 389
390 390 def killdaemons(pidfile):
391 391 return killmod.killdaemons(pidfile, tryhard=False, remove=True,
392 392 logfn=vlog)
393 393
394 394 class Test(unittest.TestCase):
395 395 """Encapsulates a single, runnable test.
396 396
397 397 While this class conforms to the unittest.TestCase API, it differs in that
398 398 instances need to be instantiated manually. (Typically, unittest.TestCase
399 399 classes are instantiated automatically by scanning modules.)
400 400 """
401 401
402 402 # Status code reserved for skipped tests (used by hghave).
403 403 SKIPPED_STATUS = 80
404 404
405 405 def __init__(self, path, tmpdir, keeptmpdir=False,
406 406 debug=False,
407 407 timeout=defaults['timeout'],
408 408 startport=defaults['port'], extraconfigopts=None,
409 409 py3kwarnings=False, shell=None):
410 410 """Create a test from parameters.
411 411
412 412 path is the full path to the file defining the test.
413 413
414 414 tmpdir is the main temporary directory to use for this test.
415 415
416 416 keeptmpdir determines whether to keep the test's temporary directory
417 417 after execution. It defaults to removal (False).
418 418
419 419 debug mode will make the test execute verbosely, with unfiltered
420 420 output.
421 421
422 422 timeout controls the maximum run time of the test. It is ignored when
423 423 debug is True.
424 424
425 425 startport controls the starting port number to use for this test. Each
426 426 test will reserve 3 port numbers for execution. It is the caller's
427 427 responsibility to allocate a non-overlapping port range to Test
428 428 instances.
429 429
430 430 extraconfigopts is an iterable of extra hgrc config options. Values
431 431 must have the form "key=value" (something understood by hgrc). Values
432 432 of the form "foo.key=value" will result in "[foo] key=value".
433 433
434 434 py3kwarnings enables Py3k warnings.
435 435
436 436 shell is the shell to execute tests in.
437 437 """
438 438 self.path = path
439 439 self.bname = os.path.basename(path)
440 440 self.name = self.bname.decode('utf-8')
441 441 self._testdir = os.path.dirname(path)
442 442 self.errpath = os.path.join(self._testdir, b'%s.err' % self.bname)
443 443
444 444 self._threadtmp = tmpdir
445 445 self._keeptmpdir = keeptmpdir
446 446 self._debug = debug
447 447 self._timeout = timeout
448 448 self._startport = startport
449 449 self._extraconfigopts = extraconfigopts or []
450 450 self._py3kwarnings = py3kwarnings
451 451 self._shell = shell.encode('utf-8')
452 452
453 453 self._aborted = False
454 454 self._daemonpids = []
455 455 self._finished = None
456 456 self._ret = None
457 457 self._out = None
458 458 self._skipped = None
459 459 self._testtmp = None
460 460
461 461 # If we're not in --debug mode and reference output file exists,
462 462 # check test output against it.
463 463 if debug:
464 464 self._refout = None # to match "out is None"
465 465 elif os.path.exists(self.refpath):
466 466 f = open(self.refpath, 'rb')
467 467 self._refout = f.read().splitlines(True)
468 468 f.close()
469 469 else:
470 470 self._refout = []
471 471
472 472 # needed to get base class __repr__ running
473 473 @property
474 474 def _testMethodName(self):
475 475 return self.name
476 476
477 477 def __str__(self):
478 478 return self.name
479 479
480 480 def shortDescription(self):
481 481 return self.name
482 482
483 483 def setUp(self):
484 484 """Tasks to perform before run()."""
485 485 self._finished = False
486 486 self._ret = None
487 487 self._out = None
488 488 self._skipped = None
489 489
490 490 try:
491 491 os.mkdir(self._threadtmp)
492 492 except OSError as e:
493 493 if e.errno != errno.EEXIST:
494 494 raise
495 495
496 496 self._testtmp = os.path.join(self._threadtmp,
497 497 os.path.basename(self.path))
498 498 os.mkdir(self._testtmp)
499 499
500 500 # Remove any previous output files.
501 501 if os.path.exists(self.errpath):
502 502 try:
503 503 os.remove(self.errpath)
504 504 except OSError as e:
505 505 # We might have raced another test to clean up a .err
506 506 # file, so ignore ENOENT when removing a previous .err
507 507 # file.
508 508 if e.errno != errno.ENOENT:
509 509 raise
510 510
511 511 def run(self, result):
512 512 """Run this test and report results against a TestResult instance."""
513 513 # This function is extremely similar to unittest.TestCase.run(). Once
514 514 # we require Python 2.7 (or at least its version of unittest), this
515 515 # function can largely go away.
516 516 self._result = result
517 517 result.startTest(self)
518 518 try:
519 519 try:
520 520 self.setUp()
521 521 except (KeyboardInterrupt, SystemExit):
522 522 self._aborted = True
523 523 raise
524 524 except Exception:
525 525 result.addError(self, sys.exc_info())
526 526 return
527 527
528 528 success = False
529 529 try:
530 530 self.runTest()
531 531 except KeyboardInterrupt:
532 532 self._aborted = True
533 533 raise
534 534 except SkipTest as e:
535 535 result.addSkip(self, str(e))
536 536 # The base class will have already counted this as a
537 537 # test we "ran", but we want to exclude skipped tests
538 538 # from those we count towards those run.
539 539 result.testsRun -= 1
540 540 except IgnoreTest as e:
541 541 result.addIgnore(self, str(e))
542 542 # As with skips, ignores also should be excluded from
543 543 # the number of tests executed.
544 544 result.testsRun -= 1
545 545 except WarnTest as e:
546 546 result.addWarn(self, str(e))
547 547 except self.failureException as e:
548 548 # This differs from unittest in that we don't capture
549 549 # the stack trace. This is for historical reasons and
550 550 # this decision could be revisited in the future,
551 551 # especially for PythonTest instances.
552 552 if result.addFailure(self, str(e)):
553 553 success = True
554 554 except Exception:
555 555 result.addError(self, sys.exc_info())
556 556 else:
557 557 success = True
558 558
559 559 try:
560 560 self.tearDown()
561 561 except (KeyboardInterrupt, SystemExit):
562 562 self._aborted = True
563 563 raise
564 564 except Exception:
565 565 result.addError(self, sys.exc_info())
566 566 success = False
567 567
568 568 if success:
569 569 result.addSuccess(self)
570 570 finally:
571 571 result.stopTest(self, interrupted=self._aborted)
572 572
573 573 def runTest(self):
574 574 """Run this test instance.
575 575
576 576 This will return a tuple describing the result of the test.
577 577 """
578 578 env = self._getenv()
579 579 self._daemonpids.append(env['DAEMON_PIDS'])
580 580 self._createhgrc(env['HGRCPATH'])
581 581
582 582 vlog('# Test', self.name)
583 583
584 584 ret, out = self._run(env)
585 585 self._finished = True
586 586 self._ret = ret
587 587 self._out = out
588 588
589 589 def describe(ret):
590 590 if ret < 0:
591 591 return 'killed by signal: %d' % -ret
592 592 return 'returned error code %d' % ret
593 593
594 594 self._skipped = False
595 595
596 596 if ret == self.SKIPPED_STATUS:
597 597 if out is None: # Debug mode, nothing to parse.
598 598 missing = ['unknown']
599 599 failed = None
600 600 else:
601 601 missing, failed = TTest.parsehghaveoutput(out)
602 602
603 603 if not missing:
604 604 missing = ['skipped']
605 605
606 606 if failed:
607 607 self.fail('hg have failed checking for %s' % failed[-1])
608 608 else:
609 609 self._skipped = True
610 610 raise SkipTest(missing[-1])
611 611 elif ret == 'timeout':
612 612 self.fail('timed out')
613 613 elif ret is False:
614 614 raise WarnTest('no result code from test')
615 615 elif out != self._refout:
616 616 # Diff generation may rely on written .err file.
617 617 if (ret != 0 or out != self._refout) and not self._skipped \
618 618 and not self._debug:
619 619 f = open(self.errpath, 'wb')
620 620 for line in out:
621 621 f.write(line)
622 622 f.close()
623 623
624 624 # The result object handles diff calculation for us.
625 625 if self._result.addOutputMismatch(self, ret, out, self._refout):
626 626 # change was accepted, skip failing
627 627 return
628 628
629 629 if ret:
630 630 msg = 'output changed and ' + describe(ret)
631 631 else:
632 632 msg = 'output changed'
633 633
634 634 self.fail(msg)
635 635 elif ret:
636 636 self.fail(describe(ret))
637 637
638 638 def tearDown(self):
639 639 """Tasks to perform after run()."""
640 640 for entry in self._daemonpids:
641 641 killdaemons(entry)
642 642 self._daemonpids = []
643 643
644 644 if not self._keeptmpdir:
645 645 shutil.rmtree(self._testtmp, True)
646 646 shutil.rmtree(self._threadtmp, True)
647 647
648 648 if (self._ret != 0 or self._out != self._refout) and not self._skipped \
649 649 and not self._debug and self._out:
650 650 f = open(self.errpath, 'wb')
651 651 for line in self._out:
652 652 f.write(line)
653 653 f.close()
654 654
655 655 vlog("# Ret was:", self._ret, '(%s)' % self.name)
656 656
657 657 def _run(self, env):
658 658 # This should be implemented in child classes to run tests.
659 659 raise SkipTest('unknown test type')
660 660
661 661 def abort(self):
662 662 """Terminate execution of this test."""
663 663 self._aborted = True
664 664
665 665 def _getreplacements(self):
666 666 """Obtain a mapping of text replacements to apply to test output.
667 667
668 668 Test output needs to be normalized so it can be compared to expected
669 669 output. This function defines how some of that normalization will
670 670 occur.
671 671 """
672 672 r = [
673 673 (br':%d\b' % self._startport, b':$HGPORT'),
674 674 (br':%d\b' % (self._startport + 1), b':$HGPORT1'),
675 675 (br':%d\b' % (self._startport + 2), b':$HGPORT2'),
676 676 (br'(?m)^(saved backup bundle to .*\.hg)( \(glob\))?$',
677 677 br'\1 (glob)'),
678 678 ]
679 679
680 680 if os.name == 'nt':
681 681 r.append(
682 682 (b''.join(c.isalpha() and b'[%s%s]' % (c.lower(), c.upper()) or
683 683 c in b'/\\' and br'[/\\]' or c.isdigit() and c or b'\\' + c
684 684 for c in self._testtmp), b'$TESTTMP'))
685 685 else:
686 686 r.append((re.escape(self._testtmp), b'$TESTTMP'))
687 687
688 688 return r
689 689
690 690 def _getenv(self):
691 691 """Obtain environment variables to use during test execution."""
692 692 env = os.environ.copy()
693 693 env['TESTTMP'] = self._testtmp
694 694 env['HOME'] = self._testtmp
695 695 env["HGPORT"] = str(self._startport)
696 696 env["HGPORT1"] = str(self._startport + 1)
697 697 env["HGPORT2"] = str(self._startport + 2)
698 698 env["HGRCPATH"] = os.path.join(self._threadtmp, b'.hgrc')
699 699 env["DAEMON_PIDS"] = os.path.join(self._threadtmp, b'daemon.pids')
700 700 env["HGEDITOR"] = ('"' + sys.executable + '"'
701 701 + ' -c "import sys; sys.exit(0)"')
702 702 env["HGMERGE"] = "internal:merge"
703 703 env["HGUSER"] = "test"
704 704 env["HGENCODING"] = "ascii"
705 705 env["HGENCODINGMODE"] = "strict"
706 706
707 707 # Reset some environment variables to well-known values so that
708 708 # the tests produce repeatable output.
709 709 env['LANG'] = env['LC_ALL'] = env['LANGUAGE'] = 'C'
710 710 env['TZ'] = 'GMT'
711 711 env["EMAIL"] = "Foo Bar <foo.bar@example.com>"
712 712 env['COLUMNS'] = '80'
713 713 env['TERM'] = 'xterm'
714 714
715 715 for k in ('HG HGPROF CDPATH GREP_OPTIONS http_proxy no_proxy ' +
716 716 'NO_PROXY').split():
717 717 if k in env:
718 718 del env[k]
719 719
720 720 # unset env related to hooks
721 721 for k in env.keys():
722 722 if k.startswith('HG_'):
723 723 del env[k]
724 724
725 725 return env
726 726
727 727 def _createhgrc(self, path):
728 728 """Create an hgrc file for this test."""
729 729 hgrc = open(path, 'wb')
730 730 hgrc.write(b'[ui]\n')
731 731 hgrc.write(b'slash = True\n')
732 732 hgrc.write(b'interactive = False\n')
733 733 hgrc.write(b'mergemarkers = detailed\n')
734 734 hgrc.write(b'promptecho = True\n')
735 735 hgrc.write(b'[defaults]\n')
736 736 hgrc.write(b'backout = -d "0 0"\n')
737 737 hgrc.write(b'commit = -d "0 0"\n')
738 738 hgrc.write(b'shelve = --date "0 0"\n')
739 739 hgrc.write(b'tag = -d "0 0"\n')
740 740 hgrc.write(b'[devel]\n')
741 741 hgrc.write(b'all = true\n')
742 742 hgrc.write(b'[largefiles]\n')
743 743 hgrc.write(b'usercache = %s\n' %
744 744 (os.path.join(self._testtmp, b'.cache/largefiles')))
745 745
746 746 for opt in self._extraconfigopts:
747 747 section, key = opt.split('.', 1)
748 748 assert '=' in key, ('extra config opt %s must '
749 749 'have an = for assignment' % opt)
750 750 hgrc.write(b'[%s]\n%s\n' % (section, key))
751 751 hgrc.close()
752 752
753 753 def fail(self, msg):
754 754 # unittest differentiates between errored and failed.
755 755 # Failed is denoted by AssertionError (by default at least).
756 756 raise AssertionError(msg)
757 757
758 758 def _runcommand(self, cmd, env, normalizenewlines=False):
759 759 """Run command in a sub-process, capturing the output (stdout and
760 760 stderr).
761 761
762 762 Return a tuple (exitcode, output). output is None in debug mode.
763 763 """
764 764 if self._debug:
765 765 proc = subprocess.Popen(cmd, shell=True, cwd=self._testtmp,
766 766 env=env)
767 767 ret = proc.wait()
768 768 return (ret, None)
769 769
770 770 proc = Popen4(cmd, self._testtmp, self._timeout, env)
771 771 def cleanup():
772 772 terminate(proc)
773 773 ret = proc.wait()
774 774 if ret == 0:
775 775 ret = signal.SIGTERM << 8
776 776 killdaemons(env['DAEMON_PIDS'])
777 777 return ret
778 778
779 779 output = ''
780 780 proc.tochild.close()
781 781
782 782 try:
783 783 output = proc.fromchild.read()
784 784 except KeyboardInterrupt:
785 785 vlog('# Handling keyboard interrupt')
786 786 cleanup()
787 787 raise
788 788
789 789 ret = proc.wait()
790 790 if wifexited(ret):
791 791 ret = os.WEXITSTATUS(ret)
792 792
793 793 if proc.timeout:
794 794 ret = 'timeout'
795 795
796 796 if ret:
797 797 killdaemons(env['DAEMON_PIDS'])
798 798
799 799 for s, r in self._getreplacements():
800 800 output = re.sub(s, r, output)
801 801
802 802 if normalizenewlines:
803 803 output = output.replace('\r\n', '\n')
804 804
805 805 return ret, output.splitlines(True)
806 806
807 807 class PythonTest(Test):
808 808 """A Python-based test."""
809 809
810 810 @property
811 811 def refpath(self):
812 812 return os.path.join(self._testdir, '%s.out' % self.name)
813 813
814 814 def _run(self, env):
815 815 py3kswitch = self._py3kwarnings and ' -3' or ''
816 816 cmd = '%s%s "%s"' % (PYTHON, py3kswitch, self.path)
817 817 vlog("# Running", cmd)
818 818 normalizenewlines = os.name == 'nt'
819 819 result = self._runcommand(cmd, env,
820 820 normalizenewlines=normalizenewlines)
821 821 if self._aborted:
822 822 raise KeyboardInterrupt()
823 823
824 824 return result
825 825
826 826 # This script may want to drop globs from lines matching these patterns on
827 827 # Windows, but check-code.py wants a glob on these lines unconditionally. Don't
828 828 # warn if that is the case for anything matching these lines.
829 829 checkcodeglobpats = [
830 830 re.compile(r'^pushing to \$TESTTMP/.*[^)]$'),
831 831 re.compile(r'^moving \S+/.*[^)]$'),
832 832 re.compile(r'^pulling from \$TESTTMP/.*[^)]$')
833 833 ]
834 834
835 835 bchr = chr
836 836 if sys.version_info[0] == 3:
837 837 bchr = lambda x: bytes([x])
838 838
839 839 class TTest(Test):
840 840 """A "t test" is a test backed by a .t file."""
841 841
842 842 SKIPPED_PREFIX = 'skipped: '
843 843 FAILED_PREFIX = 'hghave check failed: '
844 844 NEEDESCAPE = re.compile(br'[\x00-\x08\x0b-\x1f\x7f-\xff]').search
845 845
846 846 ESCAPESUB = re.compile(br'[\x00-\x08\x0b-\x1f\\\x7f-\xff]').sub
847 847 ESCAPEMAP = dict((bchr(i), br'\x%02x' % i) for i in range(256))
848 848 ESCAPEMAP.update({b'\\': b'\\\\', b'\r': br'\r'})
849 849
850 850 @property
851 851 def refpath(self):
852 852 return os.path.join(self._testdir, self.bname)
853 853
854 854 def _run(self, env):
855 855 f = open(self.path, 'rb')
856 856 lines = f.readlines()
857 857 f.close()
858 858
859 859 salt, script, after, expected = self._parsetest(lines)
860 860
861 861 # Write out the generated script.
862 862 fname = b'%s.sh' % self._testtmp
863 863 f = open(fname, 'wb')
864 864 for l in script:
865 865 f.write(l)
866 866 f.close()
867 867
868 868 cmd = b'%s "%s"' % (self._shell, fname)
869 869 vlog("# Running", cmd)
870 870
871 871 exitcode, output = self._runcommand(cmd, env)
872 872
873 873 if self._aborted:
874 874 raise KeyboardInterrupt()
875 875
876 876 # Do not merge output if skipped. Return hghave message instead.
877 877 # Similarly, with --debug, output is None.
878 878 if exitcode == self.SKIPPED_STATUS or output is None:
879 879 return exitcode, output
880 880
881 881 return self._processoutput(exitcode, output, salt, after, expected)
882 882
883 883 def _hghave(self, reqs):
884 884 # TODO do something smarter when all other uses of hghave are gone.
885 885 tdir = self._testdir.replace(b'\\', b'/')
886 886 proc = Popen4(b'%s -c "%s/hghave %s"' %
887 887 (self._shell, tdir, b' '.join(reqs)),
888 888 self._testtmp, 0, self._getenv())
889 889 stdout, stderr = proc.communicate()
890 890 ret = proc.wait()
891 891 if wifexited(ret):
892 892 ret = os.WEXITSTATUS(ret)
893 893 if ret == 2:
894 894 print(stdout)
895 895 sys.exit(1)
896 896
897 897 return ret == 0
898 898
899 899 def _parsetest(self, lines):
900 900 # We generate a shell script which outputs unique markers to line
901 901 # up script results with our source. These markers include input
902 902 # line number and the last return code.
903 903 salt = b"SALT%d" % time.time()
904 904 def addsalt(line, inpython):
905 905 if inpython:
906 906 script.append(b'%s %d 0\n' % (salt, line))
907 907 else:
908 908 script.append(b'echo %s %d $?\n' % (salt, line))
909 909
910 910 script = []
911 911
912 912 # After we run the shell script, we re-unify the script output
913 913 # with non-active parts of the source, with synchronization by our
914 914 # SALT line number markers. The after table contains the non-active
915 915 # components, ordered by line number.
916 916 after = {}
917 917
918 918 # Expected shell script output.
919 919 expected = {}
920 920
921 921 pos = prepos = -1
922 922
923 923 # True or False when in a true or false conditional section
924 924 skipping = None
925 925
926 926 # We keep track of whether or not we're in a Python block so we
927 927 # can generate the surrounding doctest magic.
928 928 inpython = False
929 929
930 930 if self._debug:
931 931 script.append('set -x\n')
932 932 if os.getenv('MSYSTEM'):
933 933 script.append('alias pwd="pwd -W"\n')
934 934
935 935 for n, l in enumerate(lines):
936 936 if not l.endswith(b'\n'):
937 937 l += b'\n'
938 938 if l.startswith(b'#require'):
939 939 lsplit = l.split()
940 940 if len(lsplit) < 2 or lsplit[0] != b'#require':
941 941 after.setdefault(pos, []).append(' !!! invalid #require\n')
942 942 if not self._hghave(lsplit[1:]):
943 943 script = ["exit 80\n"]
944 944 break
945 945 after.setdefault(pos, []).append(l)
946 946 elif l.startswith(b'#if'):
947 947 lsplit = l.split()
948 948 if len(lsplit) < 2 or lsplit[0] != b'#if':
949 949 after.setdefault(pos, []).append(' !!! invalid #if\n')
950 950 if skipping is not None:
951 951 after.setdefault(pos, []).append(' !!! nested #if\n')
952 952 skipping = not self._hghave(lsplit[1:])
953 953 after.setdefault(pos, []).append(l)
954 954 elif l.startswith(b'#else'):
955 955 if skipping is None:
956 956 after.setdefault(pos, []).append(' !!! missing #if\n')
957 957 skipping = not skipping
958 958 after.setdefault(pos, []).append(l)
959 959 elif l.startswith(b'#endif'):
960 960 if skipping is None:
961 961 after.setdefault(pos, []).append(' !!! missing #if\n')
962 962 skipping = None
963 963 after.setdefault(pos, []).append(l)
964 964 elif skipping:
965 965 after.setdefault(pos, []).append(l)
966 966 elif l.startswith(b' >>> '): # python inlines
967 967 after.setdefault(pos, []).append(l)
968 968 prepos = pos
969 969 pos = n
970 970 if not inpython:
971 971 # We've just entered a Python block. Add the header.
972 972 inpython = True
973 973 addsalt(prepos, False) # Make sure we report the exit code.
974 974 script.append('%s -m heredoctest <<EOF\n' % PYTHON)
975 975 addsalt(n, True)
976 976 script.append(l[2:])
977 977 elif l.startswith(b' ... '): # python inlines
978 978 after.setdefault(prepos, []).append(l)
979 979 script.append(l[2:])
980 980 elif l.startswith(b' $ '): # commands
981 981 if inpython:
982 982 script.append('EOF\n')
983 983 inpython = False
984 984 after.setdefault(pos, []).append(l)
985 985 prepos = pos
986 986 pos = n
987 987 addsalt(n, False)
988 988 cmd = l[4:].split()
989 989 if len(cmd) == 2 and cmd[0] == 'cd':
990 990 l = ' $ cd %s || exit 1\n' % cmd[1]
991 991 script.append(l[4:])
992 992 elif l.startswith(b' > '): # continuations
993 993 after.setdefault(prepos, []).append(l)
994 994 script.append(l[4:])
995 995 elif l.startswith(b' '): # results
996 996 # Queue up a list of expected results.
997 997 expected.setdefault(pos, []).append(l[2:])
998 998 else:
999 999 if inpython:
1000 1000 script.append('EOF\n')
1001 1001 inpython = False
1002 1002 # Non-command/result. Queue up for merged output.
1003 1003 after.setdefault(pos, []).append(l)
1004 1004
1005 1005 if inpython:
1006 1006 script.append('EOF\n')
1007 1007 if skipping is not None:
1008 1008 after.setdefault(pos, []).append(' !!! missing #endif\n')
1009 1009 addsalt(n + 1, False)
1010 1010
1011 1011 return salt, script, after, expected
1012 1012
1013 1013 def _processoutput(self, exitcode, output, salt, after, expected):
1014 1014 # Merge the script output back into a unified test.
1015 1015 warnonly = 1 # 1: not yet; 2: yes; 3: for sure not
1016 1016 if exitcode != 0:
1017 1017 warnonly = 3
1018 1018
1019 1019 pos = -1
1020 1020 postout = []
1021 1021 for l in output:
1022 1022 lout, lcmd = l, None
1023 1023 if salt in l:
1024 1024 lout, lcmd = l.split(salt, 1)
1025 1025
1026 1026 if lout:
1027 1027 if not lout.endswith(b'\n'):
1028 1028 lout += b' (no-eol)\n'
1029 1029
1030 1030 # Find the expected output at the current position.
1031 1031 el = None
1032 1032 if expected.get(pos, None):
1033 1033 el = expected[pos].pop(0)
1034 1034
1035 1035 r = TTest.linematch(el, lout)
1036 1036 if isinstance(r, str):
1037 1037 if r == '+glob':
1038 1038 lout = el[:-1] + ' (glob)\n'
1039 1039 r = '' # Warn only this line.
1040 1040 elif r == '-glob':
1041 1041 lout = ''.join(el.rsplit(' (glob)', 1))
1042 1042 r = '' # Warn only this line.
1043 1043 else:
1044 1044 log('\ninfo, unknown linematch result: %r\n' % r)
1045 1045 r = False
1046 1046 if r:
1047 1047 postout.append(b' ' + el)
1048 1048 else:
1049 1049 if self.NEEDESCAPE(lout):
1050 1050 lout = TTest._stringescape(b'%s (esc)\n' %
1051 1051 lout.rstrip(b'\n'))
1052 1052 postout.append(b' ' + lout) # Let diff deal with it.
1053 1053 if r != '': # If line failed.
1054 1054 warnonly = 3 # for sure not
1055 1055 elif warnonly == 1: # Is "not yet" and line is warn only.
1056 1056 warnonly = 2 # Yes do warn.
1057 1057
1058 1058 if lcmd:
1059 1059 # Add on last return code.
1060 1060 ret = int(lcmd.split()[1])
1061 1061 if ret != 0:
1062 1062 postout.append(b' [%d]\n' % ret)
1063 1063 if pos in after:
1064 1064 # Merge in non-active test bits.
1065 1065 postout += after.pop(pos)
1066 1066 pos = int(lcmd.split()[0])
1067 1067
1068 1068 if pos in after:
1069 1069 postout += after.pop(pos)
1070 1070
1071 1071 if warnonly == 2:
1072 1072 exitcode = False # Set exitcode to warned.
1073 1073
1074 1074 return exitcode, postout
1075 1075
1076 1076 @staticmethod
1077 1077 def rematch(el, l):
1078 1078 try:
1079 1079 # use \Z to ensure that the regex matches to the end of the string
1080 1080 if os.name == 'nt':
1081 1081 return re.match(el + br'\r?\n\Z', l)
1082 1082 return re.match(el + br'\n\Z', l)
1083 1083 except re.error:
1084 1084 # el is an invalid regex
1085 1085 return False
1086 1086
1087 1087 @staticmethod
1088 1088 def globmatch(el, l):
1089 1089 # The only supported special characters are * and ? plus / which also
1090 1090 # matches \ on windows. Escaping of these characters is supported.
1091 1091 if el + b'\n' == l:
1092 1092 if os.altsep:
1093 1093 # matching on "/" is not needed for this line
1094 1094 for pat in checkcodeglobpats:
1095 1095 if pat.match(el):
1096 1096 return True
1097 1097 return b'-glob'
1098 1098 return True
1099 1099 i, n = 0, len(el)
1100 1100 res = b''
1101 1101 while i < n:
1102 1102 c = el[i:i + 1]
1103 1103 i += 1
1104 1104 if c == b'\\' and i < n and el[i:i + 1] in b'*?\\/':
1105 1105 res += el[i - 1:i + 1]
1106 1106 i += 1
1107 1107 elif c == b'*':
1108 1108 res += b'.*'
1109 1109 elif c == b'?':
1110 1110 res += b'.'
1111 1111 elif c == b'/' and os.altsep:
1112 1112 res += b'[/\\\\]'
1113 1113 else:
1114 1114 res += re.escape(c)
1115 1115 return TTest.rematch(res, l)
1116 1116
1117 1117 @staticmethod
1118 1118 def linematch(el, l):
1119 1119 if el == l: # perfect match (fast)
1120 1120 return True
1121 1121 if el:
1122 1122 if el.endswith(b" (esc)\n"):
1123 1123 if sys.version_info[0] == 3:
1124 1124 el = el[:-7].decode('unicode_escape') + '\n'
1125 1125 el = el.encode('utf-8')
1126 1126 else:
1127 1127 el = el[:-7].decode('string-escape') + '\n'
1128 1128 if el == l or os.name == 'nt' and el[:-1] + b'\r\n' == l:
1129 1129 return True
1130 1130 if el.endswith(b" (re)\n"):
1131 1131 return TTest.rematch(el[:-6], l)
1132 1132 if el.endswith(b" (glob)\n"):
1133 1133 # ignore '(glob)' added to l by 'replacements'
1134 1134 if l.endswith(b" (glob)\n"):
1135 1135 l = l[:-8] + b"\n"
1136 1136 return TTest.globmatch(el[:-8], l)
1137 1137 if os.altsep and l.replace(b'\\', b'/') == el:
1138 1138 return b'+glob'
1139 1139 return False
1140 1140
1141 1141 @staticmethod
1142 1142 def parsehghaveoutput(lines):
1143 1143 '''Parse hghave log lines.
1144 1144
1145 1145 Return tuple of lists (missing, failed):
1146 1146 * the missing/unknown features
1147 1147 * the features for which existence check failed'''
1148 1148 missing = []
1149 1149 failed = []
1150 1150 for line in lines:
1151 1151 if line.startswith(TTest.SKIPPED_PREFIX):
1152 1152 line = line.splitlines()[0]
1153 1153 missing.append(line[len(TTest.SKIPPED_PREFIX):])
1154 1154 elif line.startswith(TTest.FAILED_PREFIX):
1155 1155 line = line.splitlines()[0]
1156 1156 failed.append(line[len(TTest.FAILED_PREFIX):])
1157 1157
1158 1158 return missing, failed
1159 1159
1160 1160 @staticmethod
1161 1161 def _escapef(m):
1162 1162 return TTest.ESCAPEMAP[m.group(0)]
1163 1163
1164 1164 @staticmethod
1165 1165 def _stringescape(s):
1166 1166 return TTest.ESCAPESUB(TTest._escapef, s)
1167 1167
1168 1168 iolock = threading.RLock()
1169 1169
1170 1170 class SkipTest(Exception):
1171 1171 """Raised to indicate that a test is to be skipped."""
1172 1172
1173 1173 class IgnoreTest(Exception):
1174 1174 """Raised to indicate that a test is to be ignored."""
1175 1175
1176 1176 class WarnTest(Exception):
1177 1177 """Raised to indicate that a test warned."""
1178 1178
1179 1179 class TestResult(unittest._TextTestResult):
1180 1180 """Holds results when executing via unittest."""
1181 1181 # Don't worry too much about accessing the non-public _TextTestResult.
1182 1182 # It is relatively common in Python testing tools.
1183 1183 def __init__(self, options, *args, **kwargs):
1184 1184 super(TestResult, self).__init__(*args, **kwargs)
1185 1185
1186 1186 self._options = options
1187 1187
1188 1188 # unittest.TestResult didn't have skipped until 2.7. We need to
1189 1189 # polyfill it.
1190 1190 self.skipped = []
1191 1191
1192 1192 # We have a custom "ignored" result that isn't present in any Python
1193 1193 # unittest implementation. It is very similar to skipped. It may make
1194 1194 # sense to map it into skip some day.
1195 1195 self.ignored = []
1196 1196
1197 1197 # We have a custom "warned" result that isn't present in any Python
1198 1198 # unittest implementation. It is very similar to failed. It may make
1199 1199 # sense to map it into fail some day.
1200 1200 self.warned = []
1201 1201
1202 1202 self.times = []
1203 1203 # Data stored for the benefit of generating xunit reports.
1204 1204 self.successes = []
1205 1205 self.faildata = {}
1206 1206
1207 1207 def addFailure(self, test, reason):
1208 1208 self.failures.append((test, reason))
1209 1209
1210 1210 if self._options.first:
1211 1211 self.stop()
1212 1212 else:
1213 1213 with iolock:
1214 1214 if not self._options.nodiff:
1215 1215 self.stream.write('\nERROR: %s output changed\n' % test)
1216 1216
1217 1217 self.stream.write('!')
1218 1218 self.stream.flush()
1219 1219
1220 1220 def addSuccess(self, test):
1221 1221 with iolock:
1222 1222 super(TestResult, self).addSuccess(test)
1223 1223 self.successes.append(test)
1224 1224
1225 1225 def addError(self, test, err):
1226 1226 super(TestResult, self).addError(test, err)
1227 1227 if self._options.first:
1228 1228 self.stop()
1229 1229
1230 1230 # Polyfill.
1231 1231 def addSkip(self, test, reason):
1232 1232 self.skipped.append((test, reason))
1233 1233 with iolock:
1234 1234 if self.showAll:
1235 1235 self.stream.writeln('skipped %s' % reason)
1236 1236 else:
1237 1237 self.stream.write('s')
1238 1238 self.stream.flush()
1239 1239
1240 1240 def addIgnore(self, test, reason):
1241 1241 self.ignored.append((test, reason))
1242 1242 with iolock:
1243 1243 if self.showAll:
1244 1244 self.stream.writeln('ignored %s' % reason)
1245 1245 else:
1246 1246 if reason not in ('not retesting', "doesn't match keyword"):
1247 1247 self.stream.write('i')
1248 1248 else:
1249 1249 self.testsRun += 1
1250 1250 self.stream.flush()
1251 1251
1252 1252 def addWarn(self, test, reason):
1253 1253 self.warned.append((test, reason))
1254 1254
1255 1255 if self._options.first:
1256 1256 self.stop()
1257 1257
1258 1258 with iolock:
1259 1259 if self.showAll:
1260 1260 self.stream.writeln('warned %s' % reason)
1261 1261 else:
1262 1262 self.stream.write('~')
1263 1263 self.stream.flush()
1264 1264
1265 1265 def addOutputMismatch(self, test, ret, got, expected):
1266 1266 """Record a mismatch in test output for a particular test."""
1267 1267 if self.shouldStop:
1268 1268 # don't print, some other test case already failed and
1269 1269 # printed, we're just stale and probably failed due to our
1270 1270 # temp dir getting cleaned up.
1271 1271 return
1272 1272
1273 1273 accepted = False
1274 1274 failed = False
1275 1275 lines = []
1276 1276
1277 1277 with iolock:
1278 1278 if self._options.nodiff:
1279 1279 pass
1280 1280 elif self._options.view:
1281 os.system("%s %s %s" %
1282 (self._options.view, test.refpath, test.errpath))
1281 v = self._options.view
1282 if sys.version_info[0] == 3:
1283 v = v.encode('utf-8')
1284 os.system(b"%s %s %s" %
1285 (v, test.refpath, test.errpath))
1283 1286 else:
1284 1287 servefail, lines = getdiff(expected, got,
1285 1288 test.refpath, test.errpath)
1286 1289 if servefail:
1287 1290 self.addFailure(
1288 1291 test,
1289 1292 'server failed to start (HGPORT=%s)' % test._startport)
1290 1293 else:
1291 1294 self.stream.write('\n')
1292 1295 for line in lines:
1293 1296 if sys.version_info[0] > 2:
1294 1297 self.stream.flush()
1295 1298 self.stream.buffer.write(line)
1296 1299 self.stream.buffer.flush()
1297 1300 else:
1298 1301 self.stream.write(line)
1299 1302 self.stream.flush()
1300 1303
1301 1304 # handle interactive prompt without releasing iolock
1302 1305 if self._options.interactive:
1303 1306 self.stream.write('Accept this change? [n] ')
1304 1307 answer = sys.stdin.readline().strip()
1305 1308 if answer.lower() in ('y', 'yes'):
1306 1309 if test.name.endswith('.t'):
1307 1310 rename(test.errpath, test.path)
1308 1311 else:
1309 1312 rename(test.errpath, '%s.out' % test.path)
1310 1313 accepted = True
1311 1314 if not accepted and not failed:
1312 1315 self.faildata[test.name] = b''.join(lines)
1313 1316
1314 1317 return accepted
1315 1318
1316 1319 def startTest(self, test):
1317 1320 super(TestResult, self).startTest(test)
1318 1321
1319 1322 # os.times module computes the user time and system time spent by
1320 1323 # child's processes along with real elapsed time taken by a process.
1321 1324 # This module has one limitation. It can only work for Linux user
1322 1325 # and not for Windows.
1323 1326 test.started = os.times()
1324 1327
1325 1328 def stopTest(self, test, interrupted=False):
1326 1329 super(TestResult, self).stopTest(test)
1327 1330
1328 1331 test.stopped = os.times()
1329 1332
1330 1333 starttime = test.started
1331 1334 endtime = test.stopped
1332 1335 self.times.append((test.name,
1333 1336 endtime[2] - starttime[2], # user space CPU time
1334 1337 endtime[3] - starttime[3], # sys space CPU time
1335 1338 endtime[4] - starttime[4], # real time
1336 1339 ))
1337 1340
1338 1341 if interrupted:
1339 1342 with iolock:
1340 1343 self.stream.writeln('INTERRUPTED: %s (after %d seconds)' % (
1341 1344 test.name, self.times[-1][3]))
1342 1345
1343 1346 class TestSuite(unittest.TestSuite):
1344 1347 """Custom unittest TestSuite that knows how to execute Mercurial tests."""
1345 1348
1346 1349 def __init__(self, testdir, jobs=1, whitelist=None, blacklist=None,
1347 1350 retest=False, keywords=None, loop=False, runs_per_test=1,
1348 1351 loadtest=None,
1349 1352 *args, **kwargs):
1350 1353 """Create a new instance that can run tests with a configuration.
1351 1354
1352 1355 testdir specifies the directory where tests are executed from. This
1353 1356 is typically the ``tests`` directory from Mercurial's source
1354 1357 repository.
1355 1358
1356 1359 jobs specifies the number of jobs to run concurrently. Each test
1357 1360 executes on its own thread. Tests actually spawn new processes, so
1358 1361 state mutation should not be an issue.
1359 1362
1360 1363 whitelist and blacklist denote tests that have been whitelisted and
1361 1364 blacklisted, respectively. These arguments don't belong in TestSuite.
1362 1365 Instead, whitelist and blacklist should be handled by the thing that
1363 1366 populates the TestSuite with tests. They are present to preserve
1364 1367 backwards compatible behavior which reports skipped tests as part
1365 1368 of the results.
1366 1369
1367 1370 retest denotes whether to retest failed tests. This arguably belongs
1368 1371 outside of TestSuite.
1369 1372
1370 1373 keywords denotes key words that will be used to filter which tests
1371 1374 to execute. This arguably belongs outside of TestSuite.
1372 1375
1373 1376 loop denotes whether to loop over tests forever.
1374 1377 """
1375 1378 super(TestSuite, self).__init__(*args, **kwargs)
1376 1379
1377 1380 self._jobs = jobs
1378 1381 self._whitelist = whitelist
1379 1382 self._blacklist = blacklist
1380 1383 self._retest = retest
1381 1384 self._keywords = keywords
1382 1385 self._loop = loop
1383 1386 self._runs_per_test = runs_per_test
1384 1387 self._loadtest = loadtest
1385 1388
1386 1389 def run(self, result):
1387 1390 # We have a number of filters that need to be applied. We do this
1388 1391 # here instead of inside Test because it makes the running logic for
1389 1392 # Test simpler.
1390 1393 tests = []
1391 1394 num_tests = [0]
1392 1395 for test in self._tests:
1393 1396 def get():
1394 1397 num_tests[0] += 1
1395 1398 if getattr(test, 'should_reload', False):
1396 1399 return self._loadtest(test.bname, num_tests[0])
1397 1400 return test
1398 1401 if not os.path.exists(test.path):
1399 1402 result.addSkip(test, "Doesn't exist")
1400 1403 continue
1401 1404
1402 1405 if not (self._whitelist and test.name in self._whitelist):
1403 1406 if self._blacklist and test.bname in self._blacklist:
1404 1407 result.addSkip(test, 'blacklisted')
1405 1408 continue
1406 1409
1407 1410 if self._retest and not os.path.exists(test.errpath):
1408 1411 result.addIgnore(test, 'not retesting')
1409 1412 continue
1410 1413
1411 1414 if self._keywords:
1412 1415 f = open(test.path, 'rb')
1413 1416 t = f.read().lower() + test.bname.lower()
1414 1417 f.close()
1415 1418 ignored = False
1416 1419 for k in self._keywords.lower().split():
1417 1420 if k not in t:
1418 1421 result.addIgnore(test, "doesn't match keyword")
1419 1422 ignored = True
1420 1423 break
1421 1424
1422 1425 if ignored:
1423 1426 continue
1424 1427 for _ in xrange(self._runs_per_test):
1425 1428 tests.append(get())
1426 1429
1427 1430 runtests = list(tests)
1428 1431 done = queue.Queue()
1429 1432 running = 0
1430 1433
1431 1434 def job(test, result):
1432 1435 try:
1433 1436 test(result)
1434 1437 done.put(None)
1435 1438 except KeyboardInterrupt:
1436 1439 pass
1437 1440 except: # re-raises
1438 1441 done.put(('!', test, 'run-test raised an error, see traceback'))
1439 1442 raise
1440 1443
1441 1444 stoppedearly = False
1442 1445
1443 1446 try:
1444 1447 while tests or running:
1445 1448 if not done.empty() or running == self._jobs or not tests:
1446 1449 try:
1447 1450 done.get(True, 1)
1448 1451 running -= 1
1449 1452 if result and result.shouldStop:
1450 1453 stoppedearly = True
1451 1454 break
1452 1455 except queue.Empty:
1453 1456 continue
1454 1457 if tests and not running == self._jobs:
1455 1458 test = tests.pop(0)
1456 1459 if self._loop:
1457 1460 if getattr(test, 'should_reload', False):
1458 1461 num_tests[0] += 1
1459 1462 tests.append(
1460 1463 self._loadtest(test.name, num_tests[0]))
1461 1464 else:
1462 1465 tests.append(test)
1463 1466 t = threading.Thread(target=job, name=test.name,
1464 1467 args=(test, result))
1465 1468 t.start()
1466 1469 running += 1
1467 1470
1468 1471 # If we stop early we still need to wait on started tests to
1469 1472 # finish. Otherwise, there is a race between the test completing
1470 1473 # and the test's cleanup code running. This could result in the
1471 1474 # test reporting incorrect.
1472 1475 if stoppedearly:
1473 1476 while running:
1474 1477 try:
1475 1478 done.get(True, 1)
1476 1479 running -= 1
1477 1480 except queue.Empty:
1478 1481 continue
1479 1482 except KeyboardInterrupt:
1480 1483 for test in runtests:
1481 1484 test.abort()
1482 1485
1483 1486 return result
1484 1487
1485 1488 class TextTestRunner(unittest.TextTestRunner):
1486 1489 """Custom unittest test runner that uses appropriate settings."""
1487 1490
1488 1491 def __init__(self, runner, *args, **kwargs):
1489 1492 super(TextTestRunner, self).__init__(*args, **kwargs)
1490 1493
1491 1494 self._runner = runner
1492 1495
1493 1496 def run(self, test):
1494 1497 result = TestResult(self._runner.options, self.stream,
1495 1498 self.descriptions, self.verbosity)
1496 1499
1497 1500 test(result)
1498 1501
1499 1502 failed = len(result.failures)
1500 1503 warned = len(result.warned)
1501 1504 skipped = len(result.skipped)
1502 1505 ignored = len(result.ignored)
1503 1506
1504 1507 with iolock:
1505 1508 self.stream.writeln('')
1506 1509
1507 1510 if not self._runner.options.noskips:
1508 1511 for test, msg in result.skipped:
1509 1512 self.stream.writeln('Skipped %s: %s' % (test.name, msg))
1510 1513 for test, msg in result.warned:
1511 1514 self.stream.writeln('Warned %s: %s' % (test.name, msg))
1512 1515 for test, msg in result.failures:
1513 1516 self.stream.writeln('Failed %s: %s' % (test.name, msg))
1514 1517 for test, msg in result.errors:
1515 1518 self.stream.writeln('Errored %s: %s' % (test.name, msg))
1516 1519
1517 1520 if self._runner.options.xunit:
1518 1521 xuf = open(self._runner.options.xunit, 'wb')
1519 1522 try:
1520 1523 timesd = dict((t[0], t[3]) for t in result.times)
1521 1524 doc = minidom.Document()
1522 1525 s = doc.createElement('testsuite')
1523 1526 s.setAttribute('name', 'run-tests')
1524 1527 s.setAttribute('tests', str(result.testsRun))
1525 1528 s.setAttribute('errors', "0") # TODO
1526 1529 s.setAttribute('failures', str(failed))
1527 1530 s.setAttribute('skipped', str(skipped + ignored))
1528 1531 doc.appendChild(s)
1529 1532 for tc in result.successes:
1530 1533 t = doc.createElement('testcase')
1531 1534 t.setAttribute('name', tc.name)
1532 1535 t.setAttribute('time', '%.3f' % timesd[tc.name])
1533 1536 s.appendChild(t)
1534 1537 for tc, err in sorted(result.faildata.items()):
1535 1538 t = doc.createElement('testcase')
1536 1539 t.setAttribute('name', tc)
1537 1540 t.setAttribute('time', '%.3f' % timesd[tc])
1538 1541 # createCDATASection expects a unicode or it will
1539 1542 # convert using default conversion rules, which will
1540 1543 # fail if string isn't ASCII.
1541 1544 err = cdatasafe(err).decode('utf-8', 'replace')
1542 1545 cd = doc.createCDATASection(err)
1543 1546 t.appendChild(cd)
1544 1547 s.appendChild(t)
1545 1548 xuf.write(doc.toprettyxml(indent=' ', encoding='utf-8'))
1546 1549 finally:
1547 1550 xuf.close()
1548 1551
1549 1552 if self._runner.options.json:
1550 1553 if json is None:
1551 1554 raise ImportError("json module not installed")
1552 1555 jsonpath = os.path.join(self._runner._testdir, 'report.json')
1553 1556 fp = open(jsonpath, 'w')
1554 1557 try:
1555 1558 timesd = {}
1556 1559 for tdata in result.times:
1557 1560 test = tdata[0]
1558 1561 timesd[test] = tdata[1:]
1559 1562
1560 1563 outcome = {}
1561 1564 groups = [('success', ((tc, None)
1562 1565 for tc in result.successes)),
1563 1566 ('failure', result.failures),
1564 1567 ('skip', result.skipped)]
1565 1568 for res, testcases in groups:
1566 1569 for tc, __ in testcases:
1567 1570 tres = {'result': res,
1568 1571 'time': ('%0.3f' % timesd[tc.name][2]),
1569 1572 'cuser': ('%0.3f' % timesd[tc.name][0]),
1570 1573 'csys': ('%0.3f' % timesd[tc.name][1])}
1571 1574 outcome[tc.name] = tres
1572 1575
1573 1576 jsonout = json.dumps(outcome, sort_keys=True, indent=4)
1574 1577 fp.writelines(("testreport =", jsonout))
1575 1578 finally:
1576 1579 fp.close()
1577 1580
1578 1581 self._runner._checkhglib('Tested')
1579 1582
1580 1583 self.stream.writeln(
1581 1584 '# Ran %d tests, %d skipped, %d warned, %d failed.'
1582 1585 % (result.testsRun,
1583 1586 skipped + ignored, warned, failed))
1584 1587 if failed:
1585 1588 self.stream.writeln('python hash seed: %s' %
1586 1589 os.environ['PYTHONHASHSEED'])
1587 1590 if self._runner.options.time:
1588 1591 self.printtimes(result.times)
1589 1592
1590 1593 return result
1591 1594
1592 1595 def printtimes(self, times):
1593 1596 # iolock held by run
1594 1597 self.stream.writeln('# Producing time report')
1595 1598 times.sort(key=lambda t: (t[3]))
1596 1599 cols = '%7.3f %7.3f %7.3f %s'
1597 1600 self.stream.writeln('%-7s %-7s %-7s %s' % ('cuser', 'csys', 'real',
1598 1601 'Test'))
1599 1602 for tdata in times:
1600 1603 test = tdata[0]
1601 1604 cuser, csys, real = tdata[1:4]
1602 1605 self.stream.writeln(cols % (cuser, csys, real, test))
1603 1606
1604 1607 class TestRunner(object):
1605 1608 """Holds context for executing tests.
1606 1609
1607 1610 Tests rely on a lot of state. This object holds it for them.
1608 1611 """
1609 1612
1610 1613 # Programs required to run tests.
1611 1614 REQUIREDTOOLS = [
1612 1615 os.path.basename(sys.executable).encode('utf-8'),
1613 1616 b'diff',
1614 1617 b'grep',
1615 1618 b'unzip',
1616 1619 b'gunzip',
1617 1620 b'bunzip2',
1618 1621 b'sed',
1619 1622 ]
1620 1623
1621 1624 # Maps file extensions to test class.
1622 1625 TESTTYPES = [
1623 1626 (b'.py', PythonTest),
1624 1627 (b'.t', TTest),
1625 1628 ]
1626 1629
1627 1630 def __init__(self):
1628 1631 self.options = None
1629 1632 self._hgroot = None
1630 1633 self._testdir = None
1631 1634 self._hgtmp = None
1632 1635 self._installdir = None
1633 1636 self._bindir = None
1634 1637 self._tmpbinddir = None
1635 1638 self._pythondir = None
1636 1639 self._coveragefile = None
1637 1640 self._createdfiles = []
1638 1641 self._hgpath = None
1639 1642 self._portoffset = 0
1640 1643 self._ports = {}
1641 1644
1642 1645 def run(self, args, parser=None):
1643 1646 """Run the test suite."""
1644 1647 oldmask = os.umask(0o22)
1645 1648 try:
1646 1649 parser = parser or getparser()
1647 1650 options, args = parseargs(args, parser)
1648 1651 args = [a.encode('utf-8') for a in args]
1649 1652 self.options = options
1650 1653
1651 1654 self._checktools()
1652 1655 tests = self.findtests(args)
1653 1656 return self._run(tests)
1654 1657 finally:
1655 1658 os.umask(oldmask)
1656 1659
1657 1660 def _run(self, tests):
1658 1661 if self.options.random:
1659 1662 random.shuffle(tests)
1660 1663 else:
1661 1664 # keywords for slow tests
1662 1665 slow = b'svn gendoc check-code-hg'.split()
1663 1666 def sortkey(f):
1664 1667 # run largest tests first, as they tend to take the longest
1665 1668 try:
1666 1669 val = -os.stat(f).st_size
1667 1670 except OSError as e:
1668 1671 if e.errno != errno.ENOENT:
1669 1672 raise
1670 1673 return -1e9 # file does not exist, tell early
1671 1674 for kw in slow:
1672 1675 if kw in f:
1673 1676 val *= 10
1674 1677 return val
1675 1678 tests.sort(key=sortkey)
1676 1679
1677 1680 self._testdir = osenvironb[b'TESTDIR'] = getattr(
1678 1681 os, 'getcwdb', os.getcwd)()
1679 1682
1680 1683 if 'PYTHONHASHSEED' not in os.environ:
1681 1684 # use a random python hash seed all the time
1682 1685 # we do the randomness ourself to know what seed is used
1683 1686 os.environ['PYTHONHASHSEED'] = str(random.getrandbits(32))
1684 1687
1685 1688 if self.options.tmpdir:
1686 1689 self.options.keep_tmpdir = True
1687 1690 tmpdir = self.options.tmpdir.encode('utf-8')
1688 1691 if os.path.exists(tmpdir):
1689 1692 # Meaning of tmpdir has changed since 1.3: we used to create
1690 1693 # HGTMP inside tmpdir; now HGTMP is tmpdir. So fail if
1691 1694 # tmpdir already exists.
1692 1695 print("error: temp dir %r already exists" % tmpdir)
1693 1696 return 1
1694 1697
1695 1698 # Automatically removing tmpdir sounds convenient, but could
1696 1699 # really annoy anyone in the habit of using "--tmpdir=/tmp"
1697 1700 # or "--tmpdir=$HOME".
1698 1701 #vlog("# Removing temp dir", tmpdir)
1699 1702 #shutil.rmtree(tmpdir)
1700 1703 os.makedirs(tmpdir)
1701 1704 else:
1702 1705 d = None
1703 1706 if os.name == 'nt':
1704 1707 # without this, we get the default temp dir location, but
1705 1708 # in all lowercase, which causes troubles with paths (issue3490)
1706 1709 d = osenvironb.get(b'TMP', None)
1707 1710 # FILE BUG: mkdtemp works only on unicode in Python 3
1708 1711 tmpdir = tempfile.mkdtemp('', 'hgtests.',
1709 1712 d and d.decode('utf-8')).encode('utf-8')
1710 1713
1711 1714 self._hgtmp = osenvironb[b'HGTMP'] = (
1712 1715 os.path.realpath(tmpdir))
1713 1716
1714 1717 if self.options.with_hg:
1715 1718 self._installdir = None
1716 1719 whg = self.options.with_hg
1717 1720 # If --with-hg is not specified, we have bytes already,
1718 1721 # but if it was specified in python3 we get a str, so we
1719 1722 # have to encode it back into a bytes.
1720 1723 if sys.version_info[0] == 3:
1721 1724 if not isinstance(whg, bytes):
1722 1725 whg = whg.encode('utf-8')
1723 1726 self._bindir = os.path.dirname(os.path.realpath(whg))
1724 1727 assert isinstance(self._bindir, bytes)
1725 1728 self._tmpbindir = os.path.join(self._hgtmp, b'install', b'bin')
1726 1729 os.makedirs(self._tmpbindir)
1727 1730
1728 1731 # This looks redundant with how Python initializes sys.path from
1729 1732 # the location of the script being executed. Needed because the
1730 1733 # "hg" specified by --with-hg is not the only Python script
1731 1734 # executed in the test suite that needs to import 'mercurial'
1732 1735 # ... which means it's not really redundant at all.
1733 1736 self._pythondir = self._bindir
1734 1737 else:
1735 1738 self._installdir = os.path.join(self._hgtmp, b"install")
1736 1739 self._bindir = osenvironb[b"BINDIR"] = \
1737 1740 os.path.join(self._installdir, b"bin")
1738 1741 self._tmpbindir = self._bindir
1739 1742 self._pythondir = os.path.join(self._installdir, b"lib", b"python")
1740 1743
1741 1744 osenvironb[b"BINDIR"] = self._bindir
1742 1745 os.environ["PYTHON"] = PYTHON
1743 1746
1744 1747 fileb = __file__.encode('utf-8')
1745 1748 runtestdir = os.path.abspath(os.path.dirname(fileb))
1746 1749 if sys.version_info[0] == 3:
1747 1750 sepb = os.pathsep.encode('utf-8')
1748 1751 else:
1749 1752 sepb = os.pathsep
1750 1753 path = [self._bindir, runtestdir] + osenvironb[b"PATH"].split(sepb)
1751 1754 if os.path.islink(__file__):
1752 1755 # test helper will likely be at the end of the symlink
1753 1756 realfile = os.path.realpath(fileb)
1754 1757 realdir = os.path.abspath(os.path.dirname(realfile))
1755 1758 path.insert(2, realdir)
1756 1759 if self._tmpbindir != self._bindir:
1757 1760 path = [self._tmpbindir] + path
1758 1761 osenvironb[b"PATH"] = sepb.join(path)
1759 1762
1760 1763 # Include TESTDIR in PYTHONPATH so that out-of-tree extensions
1761 1764 # can run .../tests/run-tests.py test-foo where test-foo
1762 1765 # adds an extension to HGRC. Also include run-test.py directory to
1763 1766 # import modules like heredoctest.
1764 1767 pypath = [self._pythondir, self._testdir, runtestdir]
1765 1768 # We have to augment PYTHONPATH, rather than simply replacing
1766 1769 # it, in case external libraries are only available via current
1767 1770 # PYTHONPATH. (In particular, the Subversion bindings on OS X
1768 1771 # are in /opt/subversion.)
1769 1772 oldpypath = osenvironb.get(IMPL_PATH)
1770 1773 if oldpypath:
1771 1774 pypath.append(oldpypath)
1772 1775 osenvironb[IMPL_PATH] = sepb.join(pypath)
1773 1776
1774 1777 if self.options.pure:
1775 1778 os.environ["HGTEST_RUN_TESTS_PURE"] = "--pure"
1776 1779
1777 1780 self._coveragefile = os.path.join(self._testdir, b'.coverage')
1778 1781
1779 1782 vlog("# Using TESTDIR", self._testdir)
1780 1783 vlog("# Using HGTMP", self._hgtmp)
1781 1784 vlog("# Using PATH", os.environ["PATH"])
1782 1785 vlog("# Using", IMPL_PATH, osenvironb[IMPL_PATH])
1783 1786
1784 1787 try:
1785 1788 return self._runtests(tests) or 0
1786 1789 finally:
1787 1790 time.sleep(.1)
1788 1791 self._cleanup()
1789 1792
1790 1793 def findtests(self, args):
1791 1794 """Finds possible test files from arguments.
1792 1795
1793 1796 If you wish to inject custom tests into the test harness, this would
1794 1797 be a good function to monkeypatch or override in a derived class.
1795 1798 """
1796 1799 if not args:
1797 1800 if self.options.changed:
1798 1801 proc = Popen4('hg st --rev "%s" -man0 .' %
1799 1802 self.options.changed, None, 0)
1800 1803 stdout, stderr = proc.communicate()
1801 1804 args = stdout.strip(b'\0').split(b'\0')
1802 1805 else:
1803 1806 args = os.listdir(b'.')
1804 1807
1805 1808 return [t for t in args
1806 1809 if os.path.basename(t).startswith(b'test-')
1807 1810 and (t.endswith(b'.py') or t.endswith(b'.t'))]
1808 1811
1809 1812 def _runtests(self, tests):
1810 1813 try:
1811 1814 if self._installdir:
1812 1815 self._installhg()
1813 1816 self._checkhglib("Testing")
1814 1817 else:
1815 1818 self._usecorrectpython()
1816 1819
1817 1820 if self.options.restart:
1818 1821 orig = list(tests)
1819 1822 while tests:
1820 1823 if os.path.exists(tests[0] + ".err"):
1821 1824 break
1822 1825 tests.pop(0)
1823 1826 if not tests:
1824 1827 print("running all tests")
1825 1828 tests = orig
1826 1829
1827 1830 tests = [self._gettest(t, i) for i, t in enumerate(tests)]
1828 1831
1829 1832 failed = False
1830 1833 warned = False
1831 1834 kws = self.options.keywords
1832 1835 if kws is not None and sys.version_info[0] == 3:
1833 1836 kws = kws.encode('utf-8')
1834 1837
1835 1838 suite = TestSuite(self._testdir,
1836 1839 jobs=self.options.jobs,
1837 1840 whitelist=self.options.whitelisted,
1838 1841 blacklist=self.options.blacklist,
1839 1842 retest=self.options.retest,
1840 1843 keywords=kws,
1841 1844 loop=self.options.loop,
1842 1845 runs_per_test=self.options.runs_per_test,
1843 1846 tests=tests, loadtest=self._gettest)
1844 1847 verbosity = 1
1845 1848 if self.options.verbose:
1846 1849 verbosity = 2
1847 1850 runner = TextTestRunner(self, verbosity=verbosity)
1848 1851 result = runner.run(suite)
1849 1852
1850 1853 if result.failures:
1851 1854 failed = True
1852 1855 if result.warned:
1853 1856 warned = True
1854 1857
1855 1858 if self.options.anycoverage:
1856 1859 self._outputcoverage()
1857 1860 except KeyboardInterrupt:
1858 1861 failed = True
1859 1862 print("\ninterrupted!")
1860 1863
1861 1864 if failed:
1862 1865 return 1
1863 1866 if warned:
1864 1867 return 80
1865 1868
1866 1869 def _getport(self, count):
1867 1870 port = self._ports.get(count) # do we have a cached entry?
1868 1871 if port is None:
1869 1872 port = self.options.port + self._portoffset
1870 1873 portneeded = 3
1871 1874 # above 100 tries we just give up and let test reports failure
1872 1875 for tries in xrange(100):
1873 1876 allfree = True
1874 1877 for idx in xrange(portneeded):
1875 1878 if not checkportisavailable(port + idx):
1876 1879 allfree = False
1877 1880 break
1878 1881 self._portoffset += portneeded
1879 1882 if allfree:
1880 1883 break
1881 1884 self._ports[count] = port
1882 1885 return port
1883 1886
1884 1887 def _gettest(self, test, count):
1885 1888 """Obtain a Test by looking at its filename.
1886 1889
1887 1890 Returns a Test instance. The Test may not be runnable if it doesn't
1888 1891 map to a known type.
1889 1892 """
1890 1893 lctest = test.lower()
1891 1894 testcls = Test
1892 1895
1893 1896 for ext, cls in self.TESTTYPES:
1894 1897 if lctest.endswith(ext):
1895 1898 testcls = cls
1896 1899 break
1897 1900
1898 1901 refpath = os.path.join(self._testdir, test)
1899 1902 tmpdir = os.path.join(self._hgtmp, b'child%d' % count)
1900 1903
1901 1904 t = testcls(refpath, tmpdir,
1902 1905 keeptmpdir=self.options.keep_tmpdir,
1903 1906 debug=self.options.debug,
1904 1907 timeout=self.options.timeout,
1905 1908 startport=self._getport(count),
1906 1909 extraconfigopts=self.options.extra_config_opt,
1907 1910 py3kwarnings=self.options.py3k_warnings,
1908 1911 shell=self.options.shell)
1909 1912 t.should_reload = True
1910 1913 return t
1911 1914
1912 1915 def _cleanup(self):
1913 1916 """Clean up state from this test invocation."""
1914 1917
1915 1918 if self.options.keep_tmpdir:
1916 1919 return
1917 1920
1918 1921 vlog("# Cleaning up HGTMP", self._hgtmp)
1919 1922 shutil.rmtree(self._hgtmp, True)
1920 1923 for f in self._createdfiles:
1921 1924 try:
1922 1925 os.remove(f)
1923 1926 except OSError:
1924 1927 pass
1925 1928
1926 1929 def _usecorrectpython(self):
1927 1930 """Configure the environment to use the appropriate Python in tests."""
1928 1931 # Tests must use the same interpreter as us or bad things will happen.
1929 1932 pyexename = sys.platform == 'win32' and b'python.exe' or b'python'
1930 1933 if getattr(os, 'symlink', None):
1931 1934 vlog("# Making python executable in test path a symlink to '%s'" %
1932 1935 sys.executable)
1933 1936 mypython = os.path.join(self._tmpbindir, pyexename)
1934 1937 try:
1935 1938 if os.readlink(mypython) == sys.executable:
1936 1939 return
1937 1940 os.unlink(mypython)
1938 1941 except OSError as err:
1939 1942 if err.errno != errno.ENOENT:
1940 1943 raise
1941 1944 if self._findprogram(pyexename) != sys.executable:
1942 1945 try:
1943 1946 os.symlink(sys.executable, mypython)
1944 1947 self._createdfiles.append(mypython)
1945 1948 except OSError as err:
1946 1949 # child processes may race, which is harmless
1947 1950 if err.errno != errno.EEXIST:
1948 1951 raise
1949 1952 else:
1950 1953 exedir, exename = os.path.split(sys.executable)
1951 1954 vlog("# Modifying search path to find %s as %s in '%s'" %
1952 1955 (exename, pyexename, exedir))
1953 1956 path = os.environ['PATH'].split(os.pathsep)
1954 1957 while exedir in path:
1955 1958 path.remove(exedir)
1956 1959 os.environ['PATH'] = os.pathsep.join([exedir] + path)
1957 1960 if not self._findprogram(pyexename):
1958 1961 print("WARNING: Cannot find %s in search path" % pyexename)
1959 1962
1960 1963 def _installhg(self):
1961 1964 """Install hg into the test environment.
1962 1965
1963 1966 This will also configure hg with the appropriate testing settings.
1964 1967 """
1965 1968 vlog("# Performing temporary installation of HG")
1966 1969 installerrs = os.path.join(b"tests", b"install.err")
1967 1970 compiler = ''
1968 1971 if self.options.compiler:
1969 1972 compiler = '--compiler ' + self.options.compiler
1970 1973 if self.options.pure:
1971 1974 pure = b"--pure"
1972 1975 else:
1973 1976 pure = b""
1974 1977 py3 = ''
1975 1978
1976 1979 # Run installer in hg root
1977 1980 script = os.path.realpath(sys.argv[0])
1978 1981 exe = sys.executable
1979 1982 if sys.version_info[0] == 3:
1980 1983 py3 = b'--c2to3'
1981 1984 compiler = compiler.encode('utf-8')
1982 1985 script = script.encode('utf-8')
1983 1986 exe = exe.encode('utf-8')
1984 1987 hgroot = os.path.dirname(os.path.dirname(script))
1985 1988 self._hgroot = hgroot
1986 1989 os.chdir(hgroot)
1987 1990 nohome = b'--home=""'
1988 1991 if os.name == 'nt':
1989 1992 # The --home="" trick works only on OS where os.sep == '/'
1990 1993 # because of a distutils convert_path() fast-path. Avoid it at
1991 1994 # least on Windows for now, deal with .pydistutils.cfg bugs
1992 1995 # when they happen.
1993 1996 nohome = b''
1994 1997 cmd = (b'%(exe)s setup.py %(py3)s %(pure)s clean --all'
1995 1998 b' build %(compiler)s --build-base="%(base)s"'
1996 1999 b' install --force --prefix="%(prefix)s"'
1997 2000 b' --install-lib="%(libdir)s"'
1998 2001 b' --install-scripts="%(bindir)s" %(nohome)s >%(logfile)s 2>&1'
1999 2002 % {b'exe': exe, b'py3': py3, b'pure': pure,
2000 2003 b'compiler': compiler,
2001 2004 b'base': os.path.join(self._hgtmp, b"build"),
2002 2005 b'prefix': self._installdir, b'libdir': self._pythondir,
2003 2006 b'bindir': self._bindir,
2004 2007 b'nohome': nohome, b'logfile': installerrs})
2005 2008
2006 2009 # setuptools requires install directories to exist.
2007 2010 def makedirs(p):
2008 2011 try:
2009 2012 os.makedirs(p)
2010 2013 except OSError as e:
2011 2014 if e.errno != errno.EEXIST:
2012 2015 raise
2013 2016 makedirs(self._pythondir)
2014 2017 makedirs(self._bindir)
2015 2018
2016 2019 vlog("# Running", cmd)
2017 2020 if os.system(cmd) == 0:
2018 2021 if not self.options.verbose:
2019 2022 os.remove(installerrs)
2020 2023 else:
2021 2024 f = open(installerrs, 'rb')
2022 2025 for line in f:
2023 2026 if sys.version_info[0] > 2:
2024 2027 sys.stdout.buffer.write(line)
2025 2028 else:
2026 2029 sys.stdout.write(line)
2027 2030 f.close()
2028 2031 sys.exit(1)
2029 2032 os.chdir(self._testdir)
2030 2033
2031 2034 self._usecorrectpython()
2032 2035
2033 2036 if self.options.py3k_warnings and not self.options.anycoverage:
2034 2037 vlog("# Updating hg command to enable Py3k Warnings switch")
2035 2038 f = open(os.path.join(self._bindir, 'hg'), 'rb')
2036 2039 lines = [line.rstrip() for line in f]
2037 2040 lines[0] += ' -3'
2038 2041 f.close()
2039 2042 f = open(os.path.join(self._bindir, 'hg'), 'wb')
2040 2043 for line in lines:
2041 2044 f.write(line + '\n')
2042 2045 f.close()
2043 2046
2044 2047 hgbat = os.path.join(self._bindir, b'hg.bat')
2045 2048 if os.path.isfile(hgbat):
2046 2049 # hg.bat expects to be put in bin/scripts while run-tests.py
2047 2050 # installation layout put it in bin/ directly. Fix it
2048 2051 f = open(hgbat, 'rb')
2049 2052 data = f.read()
2050 2053 f.close()
2051 2054 if b'"%~dp0..\python" "%~dp0hg" %*' in data:
2052 2055 data = data.replace(b'"%~dp0..\python" "%~dp0hg" %*',
2053 2056 b'"%~dp0python" "%~dp0hg" %*')
2054 2057 f = open(hgbat, 'wb')
2055 2058 f.write(data)
2056 2059 f.close()
2057 2060 else:
2058 2061 print('WARNING: cannot fix hg.bat reference to python.exe')
2059 2062
2060 2063 if self.options.anycoverage:
2061 2064 custom = os.path.join(self._testdir, 'sitecustomize.py')
2062 2065 target = os.path.join(self._pythondir, 'sitecustomize.py')
2063 2066 vlog('# Installing coverage trigger to %s' % target)
2064 2067 shutil.copyfile(custom, target)
2065 2068 rc = os.path.join(self._testdir, '.coveragerc')
2066 2069 vlog('# Installing coverage rc to %s' % rc)
2067 2070 os.environ['COVERAGE_PROCESS_START'] = rc
2068 2071 covdir = os.path.join(self._installdir, '..', 'coverage')
2069 2072 try:
2070 2073 os.mkdir(covdir)
2071 2074 except OSError as e:
2072 2075 if e.errno != errno.EEXIST:
2073 2076 raise
2074 2077
2075 2078 os.environ['COVERAGE_DIR'] = covdir
2076 2079
2077 2080 def _checkhglib(self, verb):
2078 2081 """Ensure that the 'mercurial' package imported by python is
2079 2082 the one we expect it to be. If not, print a warning to stderr."""
2080 2083 if ((self._bindir == self._pythondir) and
2081 2084 (self._bindir != self._tmpbindir)):
2082 2085 # The pythondir has been inferred from --with-hg flag.
2083 2086 # We cannot expect anything sensible here.
2084 2087 return
2085 2088 expecthg = os.path.join(self._pythondir, b'mercurial')
2086 2089 actualhg = self._gethgpath()
2087 2090 if os.path.abspath(actualhg) != os.path.abspath(expecthg):
2088 2091 sys.stderr.write('warning: %s with unexpected mercurial lib: %s\n'
2089 2092 ' (expected %s)\n'
2090 2093 % (verb, actualhg, expecthg))
2091 2094 def _gethgpath(self):
2092 2095 """Return the path to the mercurial package that is actually found by
2093 2096 the current Python interpreter."""
2094 2097 if self._hgpath is not None:
2095 2098 return self._hgpath
2096 2099
2097 2100 cmd = '%s -c "import mercurial; print (mercurial.__path__[0])"'
2098 2101 pipe = os.popen(cmd % PYTHON)
2099 2102 try:
2100 2103 self._hgpath = pipe.read().strip()
2101 2104 finally:
2102 2105 pipe.close()
2103 2106
2104 2107 return self._hgpath
2105 2108
2106 2109 def _outputcoverage(self):
2107 2110 """Produce code coverage output."""
2108 2111 from coverage import coverage
2109 2112
2110 2113 vlog('# Producing coverage report')
2111 2114 # chdir is the easiest way to get short, relative paths in the
2112 2115 # output.
2113 2116 os.chdir(self._hgroot)
2114 2117 covdir = os.path.join(self._installdir, '..', 'coverage')
2115 2118 cov = coverage(data_file=os.path.join(covdir, 'cov'))
2116 2119
2117 2120 # Map install directory paths back to source directory.
2118 2121 cov.config.paths['srcdir'] = ['.', self._pythondir]
2119 2122
2120 2123 cov.combine()
2121 2124
2122 2125 omit = [os.path.join(x, '*') for x in [self._bindir, self._testdir]]
2123 2126 cov.report(ignore_errors=True, omit=omit)
2124 2127
2125 2128 if self.options.htmlcov:
2126 2129 htmldir = os.path.join(self._testdir, 'htmlcov')
2127 2130 cov.html_report(directory=htmldir, omit=omit)
2128 2131 if self.options.annotate:
2129 2132 adir = os.path.join(self._testdir, 'annotated')
2130 2133 if not os.path.isdir(adir):
2131 2134 os.mkdir(adir)
2132 2135 cov.annotate(directory=adir, omit=omit)
2133 2136
2134 2137 def _findprogram(self, program):
2135 2138 """Search PATH for a executable program"""
2136 2139 if sys.version_info[0] > 2:
2137 2140 dpb = os.defpath.encode('utf-8')
2138 2141 sepb = os.pathsep.encode('utf-8')
2139 2142 else:
2140 2143 dpb = os.defpath
2141 2144 sepb = os.pathsep
2142 2145 for p in osenvironb.get(b'PATH', dpb).split(sepb):
2143 2146 name = os.path.join(p, program)
2144 2147 if os.name == 'nt' or os.access(name, os.X_OK):
2145 2148 return name
2146 2149 return None
2147 2150
2148 2151 def _checktools(self):
2149 2152 """Ensure tools required to run tests are present."""
2150 2153 for p in self.REQUIREDTOOLS:
2151 2154 if os.name == 'nt' and not p.endswith('.exe'):
2152 2155 p += '.exe'
2153 2156 found = self._findprogram(p)
2154 2157 if found:
2155 2158 vlog("# Found prerequisite", p, "at", found)
2156 2159 else:
2157 2160 print("WARNING: Did not find prerequisite tool: %s " % p)
2158 2161
2159 2162 if __name__ == '__main__':
2160 2163 runner = TestRunner()
2161 2164
2162 2165 try:
2163 2166 import msvcrt
2164 2167 msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
2165 2168 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
2166 2169 msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)
2167 2170 except ImportError:
2168 2171 pass
2169 2172
2170 2173 sys.exit(runner.run(sys.argv[1:]))
General Comments 0
You need to be logged in to leave comments. Login now