##// END OF EJS Templates
run-tests: allow spaces in the --view tool...
Matt Harbison -
r41726:7855a949 default
parent child Browse files
Show More
@@ -1,3308 +1,3309 b''
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 # 10) parallel, pure, tests that call run-tests:
39 39 # ./run-tests.py --pure `grep -l run-tests.py *.t`
40 40 #
41 41 # (You could use any subset of the tests: test-s* happens to match
42 42 # enough that it's worth doing parallel runs, few enough that it
43 43 # completes fairly quickly, includes both shell and Python scripts, and
44 44 # includes some scripts that run daemon processes.)
45 45
46 46 from __future__ import absolute_import, print_function
47 47
48 48 import argparse
49 49 import collections
50 50 import difflib
51 51 import distutils.version as version
52 52 import errno
53 53 import json
54 54 import multiprocessing
55 55 import os
56 56 import random
57 57 import re
58 58 import shutil
59 59 import signal
60 60 import socket
61 61 import subprocess
62 62 import sys
63 63 import sysconfig
64 64 import tempfile
65 65 import threading
66 66 import time
67 67 import unittest
68 68 import uuid
69 69 import xml.dom.minidom as minidom
70 70
71 71 try:
72 72 import Queue as queue
73 73 except ImportError:
74 74 import queue
75 75
76 76 try:
77 77 import shlex
78 78 shellquote = shlex.quote
79 79 except (ImportError, AttributeError):
80 80 import pipes
81 81 shellquote = pipes.quote
82 82
83 83 if os.environ.get('RTUNICODEPEDANTRY', False):
84 84 try:
85 85 reload(sys)
86 86 sys.setdefaultencoding("undefined")
87 87 except NameError:
88 88 pass
89 89
90 90 processlock = threading.Lock()
91 91
92 92 pygmentspresent = False
93 93 # ANSI color is unsupported prior to Windows 10
94 94 if os.name != 'nt':
95 95 try: # is pygments installed
96 96 import pygments
97 97 import pygments.lexers as lexers
98 98 import pygments.lexer as lexer
99 99 import pygments.formatters as formatters
100 100 import pygments.token as token
101 101 import pygments.style as style
102 102 pygmentspresent = True
103 103 difflexer = lexers.DiffLexer()
104 104 terminal256formatter = formatters.Terminal256Formatter()
105 105 except ImportError:
106 106 pass
107 107
108 108 if pygmentspresent:
109 109 class TestRunnerStyle(style.Style):
110 110 default_style = ""
111 111 skipped = token.string_to_tokentype("Token.Generic.Skipped")
112 112 failed = token.string_to_tokentype("Token.Generic.Failed")
113 113 skippedname = token.string_to_tokentype("Token.Generic.SName")
114 114 failedname = token.string_to_tokentype("Token.Generic.FName")
115 115 styles = {
116 116 skipped: '#e5e5e5',
117 117 skippedname: '#00ffff',
118 118 failed: '#7f0000',
119 119 failedname: '#ff0000',
120 120 }
121 121
122 122 class TestRunnerLexer(lexer.RegexLexer):
123 123 testpattern = r'[\w-]+\.(t|py)(#[a-zA-Z0-9_\-\.]+)?'
124 124 tokens = {
125 125 'root': [
126 126 (r'^Skipped', token.Generic.Skipped, 'skipped'),
127 127 (r'^Failed ', token.Generic.Failed, 'failed'),
128 128 (r'^ERROR: ', token.Generic.Failed, 'failed'),
129 129 ],
130 130 'skipped': [
131 131 (testpattern, token.Generic.SName),
132 132 (r':.*', token.Generic.Skipped),
133 133 ],
134 134 'failed': [
135 135 (testpattern, token.Generic.FName),
136 136 (r'(:| ).*', token.Generic.Failed),
137 137 ]
138 138 }
139 139
140 140 runnerformatter = formatters.Terminal256Formatter(style=TestRunnerStyle)
141 141 runnerlexer = TestRunnerLexer()
142 142
143 143 origenviron = os.environ.copy()
144 144
145 145 if sys.version_info > (3, 5, 0):
146 146 PYTHON3 = True
147 147 xrange = range # we use xrange in one place, and we'd rather not use range
148 148 def _bytespath(p):
149 149 if p is None:
150 150 return p
151 151 return p.encode('utf-8')
152 152
153 153 def _strpath(p):
154 154 if p is None:
155 155 return p
156 156 return p.decode('utf-8')
157 157
158 158 osenvironb = getattr(os, 'environb', None)
159 159 if osenvironb is None:
160 160 # Windows lacks os.environb, for instance. A proxy over the real thing
161 161 # instead of a copy allows the environment to be updated via bytes on
162 162 # all platforms.
163 163 class environbytes(object):
164 164 def __init__(self, strenv):
165 165 self.__len__ = strenv.__len__
166 166 self.clear = strenv.clear
167 167 self._strenv = strenv
168 168 def __getitem__(self, k):
169 169 v = self._strenv.__getitem__(_strpath(k))
170 170 return _bytespath(v)
171 171 def __setitem__(self, k, v):
172 172 self._strenv.__setitem__(_strpath(k), _strpath(v))
173 173 def __delitem__(self, k):
174 174 self._strenv.__delitem__(_strpath(k))
175 175 def __contains__(self, k):
176 176 return self._strenv.__contains__(_strpath(k))
177 177 def __iter__(self):
178 178 return iter([_bytespath(k) for k in iter(self._strenv)])
179 179 def get(self, k, default=None):
180 180 v = self._strenv.get(_strpath(k), _strpath(default))
181 181 return _bytespath(v)
182 182 def pop(self, k, default=None):
183 183 v = self._strenv.pop(_strpath(k), _strpath(default))
184 184 return _bytespath(v)
185 185
186 186 osenvironb = environbytes(os.environ)
187 187
188 188 getcwdb = getattr(os, 'getcwdb')
189 189 if not getcwdb or os.name == 'nt':
190 190 getcwdb = lambda: _bytespath(os.getcwd())
191 191
192 192 elif sys.version_info >= (3, 0, 0):
193 193 print('%s is only supported on Python 3.5+ and 2.7, not %s' %
194 194 (sys.argv[0], '.'.join(str(v) for v in sys.version_info[:3])))
195 195 sys.exit(70) # EX_SOFTWARE from `man 3 sysexit`
196 196 else:
197 197 PYTHON3 = False
198 198
199 199 # In python 2.x, path operations are generally done using
200 200 # bytestrings by default, so we don't have to do any extra
201 201 # fiddling there. We define the wrapper functions anyway just to
202 202 # help keep code consistent between platforms.
203 203 def _bytespath(p):
204 204 return p
205 205
206 206 _strpath = _bytespath
207 207 osenvironb = os.environ
208 208 getcwdb = os.getcwd
209 209
210 210 # For Windows support
211 211 wifexited = getattr(os, "WIFEXITED", lambda x: False)
212 212
213 213 # Whether to use IPv6
214 214 def checksocketfamily(name, port=20058):
215 215 """return true if we can listen on localhost using family=name
216 216
217 217 name should be either 'AF_INET', or 'AF_INET6'.
218 218 port being used is okay - EADDRINUSE is considered as successful.
219 219 """
220 220 family = getattr(socket, name, None)
221 221 if family is None:
222 222 return False
223 223 try:
224 224 s = socket.socket(family, socket.SOCK_STREAM)
225 225 s.bind(('localhost', port))
226 226 s.close()
227 227 return True
228 228 except socket.error as exc:
229 229 if exc.errno == errno.EADDRINUSE:
230 230 return True
231 231 elif exc.errno in (errno.EADDRNOTAVAIL, errno.EPROTONOSUPPORT):
232 232 return False
233 233 else:
234 234 raise
235 235 else:
236 236 return False
237 237
238 238 # useipv6 will be set by parseargs
239 239 useipv6 = None
240 240
241 241 def checkportisavailable(port):
242 242 """return true if a port seems free to bind on localhost"""
243 243 if useipv6:
244 244 family = socket.AF_INET6
245 245 else:
246 246 family = socket.AF_INET
247 247 try:
248 248 s = socket.socket(family, socket.SOCK_STREAM)
249 249 s.bind(('localhost', port))
250 250 s.close()
251 251 return True
252 252 except socket.error as exc:
253 253 if exc.errno not in (errno.EADDRINUSE, errno.EADDRNOTAVAIL,
254 254 errno.EPROTONOSUPPORT):
255 255 raise
256 256 return False
257 257
258 258 closefds = os.name == 'posix'
259 259 def Popen4(cmd, wd, timeout, env=None):
260 260 processlock.acquire()
261 261 p = subprocess.Popen(_strpath(cmd), shell=True, bufsize=-1,
262 262 cwd=_strpath(wd), env=env,
263 263 close_fds=closefds,
264 264 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
265 265 stderr=subprocess.STDOUT)
266 266 processlock.release()
267 267
268 268 p.fromchild = p.stdout
269 269 p.tochild = p.stdin
270 270 p.childerr = p.stderr
271 271
272 272 p.timeout = False
273 273 if timeout:
274 274 def t():
275 275 start = time.time()
276 276 while time.time() - start < timeout and p.returncode is None:
277 277 time.sleep(.1)
278 278 p.timeout = True
279 279 if p.returncode is None:
280 280 terminate(p)
281 281 threading.Thread(target=t).start()
282 282
283 283 return p
284 284
285 285 PYTHON = _bytespath(sys.executable.replace('\\', '/'))
286 286 IMPL_PATH = b'PYTHONPATH'
287 287 if 'java' in sys.platform:
288 288 IMPL_PATH = b'JYTHONPATH'
289 289
290 290 defaults = {
291 291 'jobs': ('HGTEST_JOBS', multiprocessing.cpu_count()),
292 292 'timeout': ('HGTEST_TIMEOUT', 180),
293 293 'slowtimeout': ('HGTEST_SLOWTIMEOUT', 500),
294 294 'port': ('HGTEST_PORT', 20059),
295 295 'shell': ('HGTEST_SHELL', 'sh'),
296 296 }
297 297
298 298 def canonpath(path):
299 299 return os.path.realpath(os.path.expanduser(path))
300 300
301 301 def parselistfiles(files, listtype, warn=True):
302 302 entries = dict()
303 303 for filename in files:
304 304 try:
305 305 path = os.path.expanduser(os.path.expandvars(filename))
306 306 f = open(path, "rb")
307 307 except IOError as err:
308 308 if err.errno != errno.ENOENT:
309 309 raise
310 310 if warn:
311 311 print("warning: no such %s file: %s" % (listtype, filename))
312 312 continue
313 313
314 314 for line in f.readlines():
315 315 line = line.split(b'#', 1)[0].strip()
316 316 if line:
317 317 entries[line] = filename
318 318
319 319 f.close()
320 320 return entries
321 321
322 322 def parsettestcases(path):
323 323 """read a .t test file, return a set of test case names
324 324
325 325 If path does not exist, return an empty set.
326 326 """
327 327 cases = []
328 328 try:
329 329 with open(path, 'rb') as f:
330 330 for l in f:
331 331 if l.startswith(b'#testcases '):
332 332 cases.append(sorted(l[11:].split()))
333 333 except IOError as ex:
334 334 if ex.errno != errno.ENOENT:
335 335 raise
336 336 return cases
337 337
338 338 def getparser():
339 339 """Obtain the OptionParser used by the CLI."""
340 340 parser = argparse.ArgumentParser(usage='%(prog)s [options] [tests]')
341 341
342 342 selection = parser.add_argument_group('Test Selection')
343 343 selection.add_argument('--allow-slow-tests', action='store_true',
344 344 help='allow extremely slow tests')
345 345 selection.add_argument("--blacklist", action="append",
346 346 help="skip tests listed in the specified blacklist file")
347 347 selection.add_argument("--changed",
348 348 help="run tests that are changed in parent rev or working directory")
349 349 selection.add_argument("-k", "--keywords",
350 350 help="run tests matching keywords")
351 351 selection.add_argument("-r", "--retest", action="store_true",
352 352 help = "retest failed tests")
353 353 selection.add_argument("--test-list", action="append",
354 354 help="read tests to run from the specified file")
355 355 selection.add_argument("--whitelist", action="append",
356 356 help="always run tests listed in the specified whitelist file")
357 357 selection.add_argument('tests', metavar='TESTS', nargs='*',
358 358 help='Tests to run')
359 359
360 360 harness = parser.add_argument_group('Test Harness Behavior')
361 361 harness.add_argument('--bisect-repo',
362 362 metavar='bisect_repo',
363 363 help=("Path of a repo to bisect. Use together with "
364 364 "--known-good-rev"))
365 365 harness.add_argument("-d", "--debug", action="store_true",
366 366 help="debug mode: write output of test scripts to console"
367 367 " rather than capturing and diffing it (disables timeout)")
368 368 harness.add_argument("-f", "--first", action="store_true",
369 369 help="exit on the first test failure")
370 370 harness.add_argument("-i", "--interactive", action="store_true",
371 371 help="prompt to accept changed output")
372 372 harness.add_argument("-j", "--jobs", type=int,
373 373 help="number of jobs to run in parallel"
374 374 " (default: $%s or %d)" % defaults['jobs'])
375 375 harness.add_argument("--keep-tmpdir", action="store_true",
376 376 help="keep temporary directory after running tests")
377 377 harness.add_argument('--known-good-rev',
378 378 metavar="known_good_rev",
379 379 help=("Automatically bisect any failures using this "
380 380 "revision as a known-good revision."))
381 381 harness.add_argument("--list-tests", action="store_true",
382 382 help="list tests instead of running them")
383 383 harness.add_argument("--loop", action="store_true",
384 384 help="loop tests repeatedly")
385 385 harness.add_argument('--random', action="store_true",
386 386 help='run tests in random order')
387 387 harness.add_argument('--order-by-runtime', action="store_true",
388 388 help='run slowest tests first, according to .testtimes')
389 389 harness.add_argument("-p", "--port", type=int,
390 390 help="port on which servers should listen"
391 391 " (default: $%s or %d)" % defaults['port'])
392 392 harness.add_argument('--profile-runner', action='store_true',
393 393 help='run statprof on run-tests')
394 394 harness.add_argument("-R", "--restart", action="store_true",
395 395 help="restart at last error")
396 396 harness.add_argument("--runs-per-test", type=int, dest="runs_per_test",
397 397 help="run each test N times (default=1)", default=1)
398 398 harness.add_argument("--shell",
399 399 help="shell to use (default: $%s or %s)" % defaults['shell'])
400 400 harness.add_argument('--showchannels', action='store_true',
401 401 help='show scheduling channels')
402 402 harness.add_argument("--slowtimeout", type=int,
403 403 help="kill errant slow tests after SLOWTIMEOUT seconds"
404 404 " (default: $%s or %d)" % defaults['slowtimeout'])
405 405 harness.add_argument("-t", "--timeout", type=int,
406 406 help="kill errant tests after TIMEOUT seconds"
407 407 " (default: $%s or %d)" % defaults['timeout'])
408 408 harness.add_argument("--tmpdir",
409 409 help="run tests in the given temporary directory"
410 410 " (implies --keep-tmpdir)")
411 411 harness.add_argument("-v", "--verbose", action="store_true",
412 412 help="output verbose messages")
413 413
414 414 hgconf = parser.add_argument_group('Mercurial Configuration')
415 415 hgconf.add_argument("--chg", action="store_true",
416 416 help="install and use chg wrapper in place of hg")
417 417 hgconf.add_argument("--compiler",
418 418 help="compiler to build with")
419 419 hgconf.add_argument('--extra-config-opt', action="append", default=[],
420 420 help='set the given config opt in the test hgrc')
421 421 hgconf.add_argument("-l", "--local", action="store_true",
422 422 help="shortcut for --with-hg=<testdir>/../hg, "
423 423 "and --with-chg=<testdir>/../contrib/chg/chg if --chg is set")
424 424 hgconf.add_argument("--ipv6", action="store_true",
425 425 help="prefer IPv6 to IPv4 for network related tests")
426 426 hgconf.add_argument("--pure", action="store_true",
427 427 help="use pure Python code instead of C extensions")
428 428 hgconf.add_argument("-3", "--py3-warnings", action="store_true",
429 429 help="enable Py3k warnings on Python 2.7+")
430 430 hgconf.add_argument("--with-chg", metavar="CHG",
431 431 help="use specified chg wrapper in place of hg")
432 432 hgconf.add_argument("--with-hg",
433 433 metavar="HG",
434 434 help="test using specified hg script rather than a "
435 435 "temporary installation")
436 436
437 437 reporting = parser.add_argument_group('Results Reporting')
438 438 reporting.add_argument("-C", "--annotate", action="store_true",
439 439 help="output files annotated with coverage")
440 440 reporting.add_argument("--color", choices=["always", "auto", "never"],
441 441 default=os.environ.get('HGRUNTESTSCOLOR', 'auto'),
442 442 help="colorisation: always|auto|never (default: auto)")
443 443 reporting.add_argument("-c", "--cover", action="store_true",
444 444 help="print a test coverage report")
445 445 reporting.add_argument('--exceptions', action='store_true',
446 446 help='log all exceptions and generate an exception report')
447 447 reporting.add_argument("-H", "--htmlcov", action="store_true",
448 448 help="create an HTML report of the coverage of the files")
449 449 reporting.add_argument("--json", action="store_true",
450 450 help="store test result data in 'report.json' file")
451 451 reporting.add_argument("--outputdir",
452 452 help="directory to write error logs to (default=test directory)")
453 453 reporting.add_argument("-n", "--nodiff", action="store_true",
454 454 help="skip showing test changes")
455 455 reporting.add_argument("-S", "--noskips", action="store_true",
456 456 help="don't report skip tests verbosely")
457 457 reporting.add_argument("--time", action="store_true",
458 458 help="time how long each test takes")
459 459 reporting.add_argument("--view",
460 460 help="external diff viewer")
461 461 reporting.add_argument("--xunit",
462 462 help="record xunit results at specified path")
463 463
464 464 for option, (envvar, default) in defaults.items():
465 465 defaults[option] = type(default)(os.environ.get(envvar, default))
466 466 parser.set_defaults(**defaults)
467 467
468 468 return parser
469 469
470 470 def parseargs(args, parser):
471 471 """Parse arguments with our OptionParser and validate results."""
472 472 options = parser.parse_args(args)
473 473
474 474 # jython is always pure
475 475 if 'java' in sys.platform or '__pypy__' in sys.modules:
476 476 options.pure = True
477 477
478 478 if options.with_hg:
479 479 options.with_hg = canonpath(_bytespath(options.with_hg))
480 480 if not (os.path.isfile(options.with_hg) and
481 481 os.access(options.with_hg, os.X_OK)):
482 482 parser.error('--with-hg must specify an executable hg script')
483 483 if os.path.basename(options.with_hg) not in [b'hg', b'hg.exe']:
484 484 sys.stderr.write('warning: --with-hg should specify an hg script\n')
485 485 sys.stderr.flush()
486 486 if options.local:
487 487 testdir = os.path.dirname(_bytespath(canonpath(sys.argv[0])))
488 488 reporootdir = os.path.dirname(testdir)
489 489 pathandattrs = [(b'hg', 'with_hg')]
490 490 if options.chg:
491 491 pathandattrs.append((b'contrib/chg/chg', 'with_chg'))
492 492 for relpath, attr in pathandattrs:
493 493 binpath = os.path.join(reporootdir, relpath)
494 494 if os.name != 'nt' and not os.access(binpath, os.X_OK):
495 495 parser.error('--local specified, but %r not found or '
496 496 'not executable' % binpath)
497 497 setattr(options, attr, binpath)
498 498
499 499 if (options.chg or options.with_chg) and os.name == 'nt':
500 500 parser.error('chg does not work on %s' % os.name)
501 501 if options.with_chg:
502 502 options.chg = False # no installation to temporary location
503 503 options.with_chg = canonpath(_bytespath(options.with_chg))
504 504 if not (os.path.isfile(options.with_chg) and
505 505 os.access(options.with_chg, os.X_OK)):
506 506 parser.error('--with-chg must specify a chg executable')
507 507 if options.chg and options.with_hg:
508 508 # chg shares installation location with hg
509 509 parser.error('--chg does not work when --with-hg is specified '
510 510 '(use --with-chg instead)')
511 511
512 512 if options.color == 'always' and not pygmentspresent:
513 513 sys.stderr.write('warning: --color=always ignored because '
514 514 'pygments is not installed\n')
515 515
516 516 if options.bisect_repo and not options.known_good_rev:
517 517 parser.error("--bisect-repo cannot be used without --known-good-rev")
518 518
519 519 global useipv6
520 520 if options.ipv6:
521 521 useipv6 = checksocketfamily('AF_INET6')
522 522 else:
523 523 # only use IPv6 if IPv4 is unavailable and IPv6 is available
524 524 useipv6 = ((not checksocketfamily('AF_INET'))
525 525 and checksocketfamily('AF_INET6'))
526 526
527 527 options.anycoverage = options.cover or options.annotate or options.htmlcov
528 528 if options.anycoverage:
529 529 try:
530 530 import coverage
531 531 covver = version.StrictVersion(coverage.__version__).version
532 532 if covver < (3, 3):
533 533 parser.error('coverage options require coverage 3.3 or later')
534 534 except ImportError:
535 535 parser.error('coverage options now require the coverage package')
536 536
537 537 if options.anycoverage and options.local:
538 538 # this needs some path mangling somewhere, I guess
539 539 parser.error("sorry, coverage options do not work when --local "
540 540 "is specified")
541 541
542 542 if options.anycoverage and options.with_hg:
543 543 parser.error("sorry, coverage options do not work when --with-hg "
544 544 "is specified")
545 545
546 546 global verbose
547 547 if options.verbose:
548 548 verbose = ''
549 549
550 550 if options.tmpdir:
551 551 options.tmpdir = canonpath(options.tmpdir)
552 552
553 553 if options.jobs < 1:
554 554 parser.error('--jobs must be positive')
555 555 if options.interactive and options.debug:
556 556 parser.error("-i/--interactive and -d/--debug are incompatible")
557 557 if options.debug:
558 558 if options.timeout != defaults['timeout']:
559 559 sys.stderr.write(
560 560 'warning: --timeout option ignored with --debug\n')
561 561 if options.slowtimeout != defaults['slowtimeout']:
562 562 sys.stderr.write(
563 563 'warning: --slowtimeout option ignored with --debug\n')
564 564 options.timeout = 0
565 565 options.slowtimeout = 0
566 566 if options.py3_warnings:
567 567 if PYTHON3:
568 568 parser.error(
569 569 '--py3-warnings can only be used on Python 2.7')
570 570
571 571 if options.blacklist:
572 572 options.blacklist = parselistfiles(options.blacklist, 'blacklist')
573 573 if options.whitelist:
574 574 options.whitelisted = parselistfiles(options.whitelist, 'whitelist')
575 575 else:
576 576 options.whitelisted = {}
577 577
578 578 if options.showchannels:
579 579 options.nodiff = True
580 580
581 581 return options
582 582
583 583 def rename(src, dst):
584 584 """Like os.rename(), trade atomicity and opened files friendliness
585 585 for existing destination support.
586 586 """
587 587 shutil.copy(src, dst)
588 588 os.remove(src)
589 589
590 590 def makecleanable(path):
591 591 """Try to fix directory permission recursively so that the entire tree
592 592 can be deleted"""
593 593 for dirpath, dirnames, _filenames in os.walk(path, topdown=True):
594 594 for d in dirnames:
595 595 p = os.path.join(dirpath, d)
596 596 try:
597 597 os.chmod(p, os.stat(p).st_mode & 0o777 | 0o700) # chmod u+rwx
598 598 except OSError:
599 599 pass
600 600
601 601 _unified_diff = difflib.unified_diff
602 602 if PYTHON3:
603 603 import functools
604 604 _unified_diff = functools.partial(difflib.diff_bytes, difflib.unified_diff)
605 605
606 606 def getdiff(expected, output, ref, err):
607 607 servefail = False
608 608 lines = []
609 609 for line in _unified_diff(expected, output, ref, err):
610 610 if line.startswith(b'+++') or line.startswith(b'---'):
611 611 line = line.replace(b'\\', b'/')
612 612 if line.endswith(b' \n'):
613 613 line = line[:-2] + b'\n'
614 614 lines.append(line)
615 615 if not servefail and line.startswith(
616 616 b'+ abort: child process failed to start'):
617 617 servefail = True
618 618
619 619 return servefail, lines
620 620
621 621 verbose = False
622 622 def vlog(*msg):
623 623 """Log only when in verbose mode."""
624 624 if verbose is False:
625 625 return
626 626
627 627 return log(*msg)
628 628
629 629 # Bytes that break XML even in a CDATA block: control characters 0-31
630 630 # sans \t, \n and \r
631 631 CDATA_EVIL = re.compile(br"[\000-\010\013\014\016-\037]")
632 632
633 633 # Match feature conditionalized output lines in the form, capturing the feature
634 634 # list in group 2, and the preceeding line output in group 1:
635 635 #
636 636 # output..output (feature !)\n
637 637 optline = re.compile(br'(.*) \((.+?) !\)\n$')
638 638
639 639 def cdatasafe(data):
640 640 """Make a string safe to include in a CDATA block.
641 641
642 642 Certain control characters are illegal in a CDATA block, and
643 643 there's no way to include a ]]> in a CDATA either. This function
644 644 replaces illegal bytes with ? and adds a space between the ]] so
645 645 that it won't break the CDATA block.
646 646 """
647 647 return CDATA_EVIL.sub(b'?', data).replace(b']]>', b'] ]>')
648 648
649 649 def log(*msg):
650 650 """Log something to stdout.
651 651
652 652 Arguments are strings to print.
653 653 """
654 654 with iolock:
655 655 if verbose:
656 656 print(verbose, end=' ')
657 657 for m in msg:
658 658 print(m, end=' ')
659 659 print()
660 660 sys.stdout.flush()
661 661
662 662 def highlightdiff(line, color):
663 663 if not color:
664 664 return line
665 665 assert pygmentspresent
666 666 return pygments.highlight(line.decode('latin1'), difflexer,
667 667 terminal256formatter).encode('latin1')
668 668
669 669 def highlightmsg(msg, color):
670 670 if not color:
671 671 return msg
672 672 assert pygmentspresent
673 673 return pygments.highlight(msg, runnerlexer, runnerformatter)
674 674
675 675 def terminate(proc):
676 676 """Terminate subprocess"""
677 677 vlog('# Terminating process %d' % proc.pid)
678 678 try:
679 679 proc.terminate()
680 680 except OSError:
681 681 pass
682 682
683 683 def killdaemons(pidfile):
684 684 import killdaemons as killmod
685 685 return killmod.killdaemons(pidfile, tryhard=False, remove=True,
686 686 logfn=vlog)
687 687
688 688 class Test(unittest.TestCase):
689 689 """Encapsulates a single, runnable test.
690 690
691 691 While this class conforms to the unittest.TestCase API, it differs in that
692 692 instances need to be instantiated manually. (Typically, unittest.TestCase
693 693 classes are instantiated automatically by scanning modules.)
694 694 """
695 695
696 696 # Status code reserved for skipped tests (used by hghave).
697 697 SKIPPED_STATUS = 80
698 698
699 699 def __init__(self, path, outputdir, tmpdir, keeptmpdir=False,
700 700 debug=False,
701 701 first=False,
702 702 timeout=None,
703 703 startport=None, extraconfigopts=None,
704 704 py3warnings=False, shell=None, hgcommand=None,
705 705 slowtimeout=None, usechg=False,
706 706 useipv6=False):
707 707 """Create a test from parameters.
708 708
709 709 path is the full path to the file defining the test.
710 710
711 711 tmpdir is the main temporary directory to use for this test.
712 712
713 713 keeptmpdir determines whether to keep the test's temporary directory
714 714 after execution. It defaults to removal (False).
715 715
716 716 debug mode will make the test execute verbosely, with unfiltered
717 717 output.
718 718
719 719 timeout controls the maximum run time of the test. It is ignored when
720 720 debug is True. See slowtimeout for tests with #require slow.
721 721
722 722 slowtimeout overrides timeout if the test has #require slow.
723 723
724 724 startport controls the starting port number to use for this test. Each
725 725 test will reserve 3 port numbers for execution. It is the caller's
726 726 responsibility to allocate a non-overlapping port range to Test
727 727 instances.
728 728
729 729 extraconfigopts is an iterable of extra hgrc config options. Values
730 730 must have the form "key=value" (something understood by hgrc). Values
731 731 of the form "foo.key=value" will result in "[foo] key=value".
732 732
733 733 py3warnings enables Py3k warnings.
734 734
735 735 shell is the shell to execute tests in.
736 736 """
737 737 if timeout is None:
738 738 timeout = defaults['timeout']
739 739 if startport is None:
740 740 startport = defaults['port']
741 741 if slowtimeout is None:
742 742 slowtimeout = defaults['slowtimeout']
743 743 self.path = path
744 744 self.bname = os.path.basename(path)
745 745 self.name = _strpath(self.bname)
746 746 self._testdir = os.path.dirname(path)
747 747 self._outputdir = outputdir
748 748 self._tmpname = os.path.basename(path)
749 749 self.errpath = os.path.join(self._outputdir, b'%s.err' % self.bname)
750 750
751 751 self._threadtmp = tmpdir
752 752 self._keeptmpdir = keeptmpdir
753 753 self._debug = debug
754 754 self._first = first
755 755 self._timeout = timeout
756 756 self._slowtimeout = slowtimeout
757 757 self._startport = startport
758 758 self._extraconfigopts = extraconfigopts or []
759 759 self._py3warnings = py3warnings
760 760 self._shell = _bytespath(shell)
761 761 self._hgcommand = hgcommand or b'hg'
762 762 self._usechg = usechg
763 763 self._useipv6 = useipv6
764 764
765 765 self._aborted = False
766 766 self._daemonpids = []
767 767 self._finished = None
768 768 self._ret = None
769 769 self._out = None
770 770 self._skipped = None
771 771 self._testtmp = None
772 772 self._chgsockdir = None
773 773
774 774 self._refout = self.readrefout()
775 775
776 776 def readrefout(self):
777 777 """read reference output"""
778 778 # If we're not in --debug mode and reference output file exists,
779 779 # check test output against it.
780 780 if self._debug:
781 781 return None # to match "out is None"
782 782 elif os.path.exists(self.refpath):
783 783 with open(self.refpath, 'rb') as f:
784 784 return f.read().splitlines(True)
785 785 else:
786 786 return []
787 787
788 788 # needed to get base class __repr__ running
789 789 @property
790 790 def _testMethodName(self):
791 791 return self.name
792 792
793 793 def __str__(self):
794 794 return self.name
795 795
796 796 def shortDescription(self):
797 797 return self.name
798 798
799 799 def setUp(self):
800 800 """Tasks to perform before run()."""
801 801 self._finished = False
802 802 self._ret = None
803 803 self._out = None
804 804 self._skipped = None
805 805
806 806 try:
807 807 os.mkdir(self._threadtmp)
808 808 except OSError as e:
809 809 if e.errno != errno.EEXIST:
810 810 raise
811 811
812 812 name = self._tmpname
813 813 self._testtmp = os.path.join(self._threadtmp, name)
814 814 os.mkdir(self._testtmp)
815 815
816 816 # Remove any previous output files.
817 817 if os.path.exists(self.errpath):
818 818 try:
819 819 os.remove(self.errpath)
820 820 except OSError as e:
821 821 # We might have raced another test to clean up a .err
822 822 # file, so ignore ENOENT when removing a previous .err
823 823 # file.
824 824 if e.errno != errno.ENOENT:
825 825 raise
826 826
827 827 if self._usechg:
828 828 self._chgsockdir = os.path.join(self._threadtmp,
829 829 b'%s.chgsock' % name)
830 830 os.mkdir(self._chgsockdir)
831 831
832 832 def run(self, result):
833 833 """Run this test and report results against a TestResult instance."""
834 834 # This function is extremely similar to unittest.TestCase.run(). Once
835 835 # we require Python 2.7 (or at least its version of unittest), this
836 836 # function can largely go away.
837 837 self._result = result
838 838 result.startTest(self)
839 839 try:
840 840 try:
841 841 self.setUp()
842 842 except (KeyboardInterrupt, SystemExit):
843 843 self._aborted = True
844 844 raise
845 845 except Exception:
846 846 result.addError(self, sys.exc_info())
847 847 return
848 848
849 849 success = False
850 850 try:
851 851 self.runTest()
852 852 except KeyboardInterrupt:
853 853 self._aborted = True
854 854 raise
855 855 except unittest.SkipTest as e:
856 856 result.addSkip(self, str(e))
857 857 # The base class will have already counted this as a
858 858 # test we "ran", but we want to exclude skipped tests
859 859 # from those we count towards those run.
860 860 result.testsRun -= 1
861 861 except self.failureException as e:
862 862 # This differs from unittest in that we don't capture
863 863 # the stack trace. This is for historical reasons and
864 864 # this decision could be revisited in the future,
865 865 # especially for PythonTest instances.
866 866 if result.addFailure(self, str(e)):
867 867 success = True
868 868 except Exception:
869 869 result.addError(self, sys.exc_info())
870 870 else:
871 871 success = True
872 872
873 873 try:
874 874 self.tearDown()
875 875 except (KeyboardInterrupt, SystemExit):
876 876 self._aborted = True
877 877 raise
878 878 except Exception:
879 879 result.addError(self, sys.exc_info())
880 880 success = False
881 881
882 882 if success:
883 883 result.addSuccess(self)
884 884 finally:
885 885 result.stopTest(self, interrupted=self._aborted)
886 886
887 887 def runTest(self):
888 888 """Run this test instance.
889 889
890 890 This will return a tuple describing the result of the test.
891 891 """
892 892 env = self._getenv()
893 893 self._genrestoreenv(env)
894 894 self._daemonpids.append(env['DAEMON_PIDS'])
895 895 self._createhgrc(env['HGRCPATH'])
896 896
897 897 vlog('# Test', self.name)
898 898
899 899 ret, out = self._run(env)
900 900 self._finished = True
901 901 self._ret = ret
902 902 self._out = out
903 903
904 904 def describe(ret):
905 905 if ret < 0:
906 906 return 'killed by signal: %d' % -ret
907 907 return 'returned error code %d' % ret
908 908
909 909 self._skipped = False
910 910
911 911 if ret == self.SKIPPED_STATUS:
912 912 if out is None: # Debug mode, nothing to parse.
913 913 missing = ['unknown']
914 914 failed = None
915 915 else:
916 916 missing, failed = TTest.parsehghaveoutput(out)
917 917
918 918 if not missing:
919 919 missing = ['skipped']
920 920
921 921 if failed:
922 922 self.fail('hg have failed checking for %s' % failed[-1])
923 923 else:
924 924 self._skipped = True
925 925 raise unittest.SkipTest(missing[-1])
926 926 elif ret == 'timeout':
927 927 self.fail('timed out')
928 928 elif ret is False:
929 929 self.fail('no result code from test')
930 930 elif out != self._refout:
931 931 # Diff generation may rely on written .err file.
932 932 if (ret != 0 or out != self._refout) and not self._skipped \
933 933 and not self._debug:
934 934 with open(self.errpath, 'wb') as f:
935 935 for line in out:
936 936 f.write(line)
937 937
938 938 # The result object handles diff calculation for us.
939 939 with firstlock:
940 940 if self._result.addOutputMismatch(self, ret, out, self._refout):
941 941 # change was accepted, skip failing
942 942 return
943 943 if self._first:
944 944 global firsterror
945 945 firsterror = True
946 946
947 947 if ret:
948 948 msg = 'output changed and ' + describe(ret)
949 949 else:
950 950 msg = 'output changed'
951 951
952 952 self.fail(msg)
953 953 elif ret:
954 954 self.fail(describe(ret))
955 955
956 956 def tearDown(self):
957 957 """Tasks to perform after run()."""
958 958 for entry in self._daemonpids:
959 959 killdaemons(entry)
960 960 self._daemonpids = []
961 961
962 962 if self._keeptmpdir:
963 963 log('\nKeeping testtmp dir: %s\nKeeping threadtmp dir: %s' %
964 964 (self._testtmp.decode('utf-8'),
965 965 self._threadtmp.decode('utf-8')))
966 966 else:
967 967 try:
968 968 shutil.rmtree(self._testtmp)
969 969 except OSError:
970 970 # unreadable directory may be left in $TESTTMP; fix permission
971 971 # and try again
972 972 makecleanable(self._testtmp)
973 973 shutil.rmtree(self._testtmp, True)
974 974 shutil.rmtree(self._threadtmp, True)
975 975
976 976 if self._usechg:
977 977 # chgservers will stop automatically after they find the socket
978 978 # files are deleted
979 979 shutil.rmtree(self._chgsockdir, True)
980 980
981 981 if (self._ret != 0 or self._out != self._refout) and not self._skipped \
982 982 and not self._debug and self._out:
983 983 with open(self.errpath, 'wb') as f:
984 984 for line in self._out:
985 985 f.write(line)
986 986
987 987 vlog("# Ret was:", self._ret, '(%s)' % self.name)
988 988
989 989 def _run(self, env):
990 990 # This should be implemented in child classes to run tests.
991 991 raise unittest.SkipTest('unknown test type')
992 992
993 993 def abort(self):
994 994 """Terminate execution of this test."""
995 995 self._aborted = True
996 996
997 997 def _portmap(self, i):
998 998 offset = b'' if i == 0 else b'%d' % i
999 999 return (br':%d\b' % (self._startport + i), b':$HGPORT%s' % offset)
1000 1000
1001 1001 def _getreplacements(self):
1002 1002 """Obtain a mapping of text replacements to apply to test output.
1003 1003
1004 1004 Test output needs to be normalized so it can be compared to expected
1005 1005 output. This function defines how some of that normalization will
1006 1006 occur.
1007 1007 """
1008 1008 r = [
1009 1009 # This list should be parallel to defineport in _getenv
1010 1010 self._portmap(0),
1011 1011 self._portmap(1),
1012 1012 self._portmap(2),
1013 1013 (br'([^0-9])%s' % re.escape(self._localip()), br'\1$LOCALIP'),
1014 1014 (br'\bHG_TXNID=TXN:[a-f0-9]{40}\b', br'HG_TXNID=TXN:$ID$'),
1015 1015 ]
1016 1016 r.append((self._escapepath(self._testtmp), b'$TESTTMP'))
1017 1017
1018 1018 replacementfile = os.path.join(self._testdir, b'common-pattern.py')
1019 1019
1020 1020 if os.path.exists(replacementfile):
1021 1021 data = {}
1022 1022 with open(replacementfile, mode='rb') as source:
1023 1023 # the intermediate 'compile' step help with debugging
1024 1024 code = compile(source.read(), replacementfile, 'exec')
1025 1025 exec(code, data)
1026 1026 for value in data.get('substitutions', ()):
1027 1027 if len(value) != 2:
1028 1028 msg = 'malformatted substitution in %s: %r'
1029 1029 msg %= (replacementfile, value)
1030 1030 raise ValueError(msg)
1031 1031 r.append(value)
1032 1032 return r
1033 1033
1034 1034 def _escapepath(self, p):
1035 1035 if os.name == 'nt':
1036 1036 return (
1037 1037 (b''.join(c.isalpha() and b'[%s%s]' % (c.lower(), c.upper()) or
1038 1038 c in b'/\\' and br'[/\\]' or c.isdigit() and c or b'\\' + c
1039 1039 for c in [p[i:i + 1] for i in range(len(p))]))
1040 1040 )
1041 1041 else:
1042 1042 return re.escape(p)
1043 1043
1044 1044 def _localip(self):
1045 1045 if self._useipv6:
1046 1046 return b'::1'
1047 1047 else:
1048 1048 return b'127.0.0.1'
1049 1049
1050 1050 def _genrestoreenv(self, testenv):
1051 1051 """Generate a script that can be used by tests to restore the original
1052 1052 environment."""
1053 1053 # Put the restoreenv script inside self._threadtmp
1054 1054 scriptpath = os.path.join(self._threadtmp, b'restoreenv.sh')
1055 1055 testenv['HGTEST_RESTOREENV'] = _strpath(scriptpath)
1056 1056
1057 1057 # Only restore environment variable names that the shell allows
1058 1058 # us to export.
1059 1059 name_regex = re.compile('^[a-zA-Z][a-zA-Z0-9_]*$')
1060 1060
1061 1061 # Do not restore these variables; otherwise tests would fail.
1062 1062 reqnames = {'PYTHON', 'TESTDIR', 'TESTTMP'}
1063 1063
1064 1064 with open(scriptpath, 'w') as envf:
1065 1065 for name, value in origenviron.items():
1066 1066 if not name_regex.match(name):
1067 1067 # Skip environment variables with unusual names not
1068 1068 # allowed by most shells.
1069 1069 continue
1070 1070 if name in reqnames:
1071 1071 continue
1072 1072 envf.write('%s=%s\n' % (name, shellquote(value)))
1073 1073
1074 1074 for name in testenv:
1075 1075 if name in origenviron or name in reqnames:
1076 1076 continue
1077 1077 envf.write('unset %s\n' % (name,))
1078 1078
1079 1079 def _getenv(self):
1080 1080 """Obtain environment variables to use during test execution."""
1081 1081 def defineport(i):
1082 1082 offset = '' if i == 0 else '%s' % i
1083 1083 env["HGPORT%s" % offset] = '%s' % (self._startport + i)
1084 1084 env = os.environ.copy()
1085 1085 env['PYTHONUSERBASE'] = sysconfig.get_config_var('userbase') or ''
1086 1086 env['HGEMITWARNINGS'] = '1'
1087 1087 env['TESTTMP'] = _strpath(self._testtmp)
1088 1088 env['TESTNAME'] = self.name
1089 1089 env['HOME'] = _strpath(self._testtmp)
1090 1090 # This number should match portneeded in _getport
1091 1091 for port in xrange(3):
1092 1092 # This list should be parallel to _portmap in _getreplacements
1093 1093 defineport(port)
1094 1094 env["HGRCPATH"] = _strpath(os.path.join(self._threadtmp, b'.hgrc'))
1095 1095 env["DAEMON_PIDS"] = _strpath(os.path.join(self._threadtmp,
1096 1096 b'daemon.pids'))
1097 1097 env["HGEDITOR"] = ('"' + sys.executable + '"'
1098 1098 + ' -c "import sys; sys.exit(0)"')
1099 1099 env["HGUSER"] = "test"
1100 1100 env["HGENCODING"] = "ascii"
1101 1101 env["HGENCODINGMODE"] = "strict"
1102 1102 env["HGHOSTNAME"] = "test-hostname"
1103 1103 env['HGIPV6'] = str(int(self._useipv6))
1104 1104 # See contrib/catapipe.py for how to use this functionality.
1105 1105 if 'HGTESTCATAPULTSERVERPIPE' not in env:
1106 1106 # If we don't have HGTESTCATAPULTSERVERPIPE explicitly set, pull the
1107 1107 # non-test one in as a default, otherwise set to devnull
1108 1108 env['HGTESTCATAPULTSERVERPIPE'] = \
1109 1109 env.get('HGCATAPULTSERVERPIPE', os.devnull)
1110 1110
1111 1111 extraextensions = []
1112 1112 for opt in self._extraconfigopts:
1113 1113 section, key = opt.encode('utf-8').split(b'.', 1)
1114 1114 if section != 'extensions':
1115 1115 continue
1116 1116 name = key.split(b'=', 1)[0]
1117 1117 extraextensions.append(name)
1118 1118
1119 1119 if extraextensions:
1120 1120 env['HGTESTEXTRAEXTENSIONS'] = b' '.join(extraextensions)
1121 1121
1122 1122 # LOCALIP could be ::1 or 127.0.0.1. Useful for tests that require raw
1123 1123 # IP addresses.
1124 1124 env['LOCALIP'] = _strpath(self._localip())
1125 1125
1126 1126 # This has the same effect as Py_LegacyWindowsStdioFlag in exewrapper.c,
1127 1127 # but this is needed for testing python instances like dummyssh,
1128 1128 # dummysmtpd.py, and dumbhttp.py.
1129 1129 if PYTHON3 and os.name == 'nt':
1130 1130 env['PYTHONLEGACYWINDOWSSTDIO'] = '1'
1131 1131
1132 1132 # Reset some environment variables to well-known values so that
1133 1133 # the tests produce repeatable output.
1134 1134 env['LANG'] = env['LC_ALL'] = env['LANGUAGE'] = 'C'
1135 1135 env['TZ'] = 'GMT'
1136 1136 env["EMAIL"] = "Foo Bar <foo.bar@example.com>"
1137 1137 env['COLUMNS'] = '80'
1138 1138 env['TERM'] = 'xterm'
1139 1139
1140 1140 dropped = [
1141 1141 'CDPATH',
1142 1142 'CHGDEBUG',
1143 1143 'EDITOR',
1144 1144 'GREP_OPTIONS',
1145 1145 'HG',
1146 1146 'HGMERGE',
1147 1147 'HGPLAIN',
1148 1148 'HGPLAINEXCEPT',
1149 1149 'HGPROF',
1150 1150 'http_proxy',
1151 1151 'no_proxy',
1152 1152 'NO_PROXY',
1153 1153 'PAGER',
1154 1154 'VISUAL',
1155 1155 ]
1156 1156
1157 1157 for k in dropped:
1158 1158 if k in env:
1159 1159 del env[k]
1160 1160
1161 1161 # unset env related to hooks
1162 1162 for k in list(env):
1163 1163 if k.startswith('HG_'):
1164 1164 del env[k]
1165 1165
1166 1166 if self._usechg:
1167 1167 env['CHGSOCKNAME'] = os.path.join(self._chgsockdir, b'server')
1168 1168
1169 1169 return env
1170 1170
1171 1171 def _createhgrc(self, path):
1172 1172 """Create an hgrc file for this test."""
1173 1173 with open(path, 'wb') as hgrc:
1174 1174 hgrc.write(b'[ui]\n')
1175 1175 hgrc.write(b'slash = True\n')
1176 1176 hgrc.write(b'interactive = False\n')
1177 1177 hgrc.write(b'merge = internal:merge\n')
1178 1178 hgrc.write(b'mergemarkers = detailed\n')
1179 1179 hgrc.write(b'promptecho = True\n')
1180 1180 hgrc.write(b'[defaults]\n')
1181 1181 hgrc.write(b'[devel]\n')
1182 1182 hgrc.write(b'all-warnings = true\n')
1183 1183 hgrc.write(b'default-date = 0 0\n')
1184 1184 hgrc.write(b'[largefiles]\n')
1185 1185 hgrc.write(b'usercache = %s\n' %
1186 1186 (os.path.join(self._testtmp, b'.cache/largefiles')))
1187 1187 hgrc.write(b'[lfs]\n')
1188 1188 hgrc.write(b'usercache = %s\n' %
1189 1189 (os.path.join(self._testtmp, b'.cache/lfs')))
1190 1190 hgrc.write(b'[web]\n')
1191 1191 hgrc.write(b'address = localhost\n')
1192 1192 hgrc.write(b'ipv6 = %s\n' % str(self._useipv6).encode('ascii'))
1193 1193 hgrc.write(b'server-header = testing stub value\n')
1194 1194
1195 1195 for opt in self._extraconfigopts:
1196 1196 section, key = opt.encode('utf-8').split(b'.', 1)
1197 1197 assert b'=' in key, ('extra config opt %s must '
1198 1198 'have an = for assignment' % opt)
1199 1199 hgrc.write(b'[%s]\n%s\n' % (section, key))
1200 1200
1201 1201 def fail(self, msg):
1202 1202 # unittest differentiates between errored and failed.
1203 1203 # Failed is denoted by AssertionError (by default at least).
1204 1204 raise AssertionError(msg)
1205 1205
1206 1206 def _runcommand(self, cmd, env, normalizenewlines=False):
1207 1207 """Run command in a sub-process, capturing the output (stdout and
1208 1208 stderr).
1209 1209
1210 1210 Return a tuple (exitcode, output). output is None in debug mode.
1211 1211 """
1212 1212 if self._debug:
1213 1213 proc = subprocess.Popen(_strpath(cmd), shell=True,
1214 1214 cwd=_strpath(self._testtmp),
1215 1215 env=env)
1216 1216 ret = proc.wait()
1217 1217 return (ret, None)
1218 1218
1219 1219 proc = Popen4(cmd, self._testtmp, self._timeout, env)
1220 1220 def cleanup():
1221 1221 terminate(proc)
1222 1222 ret = proc.wait()
1223 1223 if ret == 0:
1224 1224 ret = signal.SIGTERM << 8
1225 1225 killdaemons(env['DAEMON_PIDS'])
1226 1226 return ret
1227 1227
1228 1228 proc.tochild.close()
1229 1229
1230 1230 try:
1231 1231 output = proc.fromchild.read()
1232 1232 except KeyboardInterrupt:
1233 1233 vlog('# Handling keyboard interrupt')
1234 1234 cleanup()
1235 1235 raise
1236 1236
1237 1237 ret = proc.wait()
1238 1238 if wifexited(ret):
1239 1239 ret = os.WEXITSTATUS(ret)
1240 1240
1241 1241 if proc.timeout:
1242 1242 ret = 'timeout'
1243 1243
1244 1244 if ret:
1245 1245 killdaemons(env['DAEMON_PIDS'])
1246 1246
1247 1247 for s, r in self._getreplacements():
1248 1248 output = re.sub(s, r, output)
1249 1249
1250 1250 if normalizenewlines:
1251 1251 output = output.replace(b'\r\n', b'\n')
1252 1252
1253 1253 return ret, output.splitlines(True)
1254 1254
1255 1255 class PythonTest(Test):
1256 1256 """A Python-based test."""
1257 1257
1258 1258 @property
1259 1259 def refpath(self):
1260 1260 return os.path.join(self._testdir, b'%s.out' % self.bname)
1261 1261
1262 1262 def _run(self, env):
1263 1263 py3switch = self._py3warnings and b' -3' or b''
1264 1264 # Quote the python(3) executable for Windows
1265 1265 cmd = b'"%s"%s "%s"' % (PYTHON, py3switch, self.path)
1266 1266 vlog("# Running", cmd)
1267 1267 normalizenewlines = os.name == 'nt'
1268 1268 result = self._runcommand(cmd, env,
1269 1269 normalizenewlines=normalizenewlines)
1270 1270 if self._aborted:
1271 1271 raise KeyboardInterrupt()
1272 1272
1273 1273 return result
1274 1274
1275 1275 # Some glob patterns apply only in some circumstances, so the script
1276 1276 # might want to remove (glob) annotations that otherwise should be
1277 1277 # retained.
1278 1278 checkcodeglobpats = [
1279 1279 # On Windows it looks like \ doesn't require a (glob), but we know
1280 1280 # better.
1281 1281 re.compile(br'^pushing to \$TESTTMP/.*[^)]$'),
1282 1282 re.compile(br'^moving \S+/.*[^)]$'),
1283 1283 re.compile(br'^pulling from \$TESTTMP/.*[^)]$'),
1284 1284 # Not all platforms have 127.0.0.1 as loopback (though most do),
1285 1285 # so we always glob that too.
1286 1286 re.compile(br'.*\$LOCALIP.*$'),
1287 1287 ]
1288 1288
1289 1289 bchr = chr
1290 1290 if PYTHON3:
1291 1291 bchr = lambda x: bytes([x])
1292 1292
1293 1293 class TTest(Test):
1294 1294 """A "t test" is a test backed by a .t file."""
1295 1295
1296 1296 SKIPPED_PREFIX = b'skipped: '
1297 1297 FAILED_PREFIX = b'hghave check failed: '
1298 1298 NEEDESCAPE = re.compile(br'[\x00-\x08\x0b-\x1f\x7f-\xff]').search
1299 1299
1300 1300 ESCAPESUB = re.compile(br'[\x00-\x08\x0b-\x1f\\\x7f-\xff]').sub
1301 1301 ESCAPEMAP = dict((bchr(i), br'\x%02x' % i) for i in range(256))
1302 1302 ESCAPEMAP.update({b'\\': b'\\\\', b'\r': br'\r'})
1303 1303
1304 1304 def __init__(self, path, *args, **kwds):
1305 1305 # accept an extra "case" parameter
1306 1306 case = kwds.pop('case', [])
1307 1307 self._case = case
1308 1308 self._allcases = {x for y in parsettestcases(path) for x in y}
1309 1309 super(TTest, self).__init__(path, *args, **kwds)
1310 1310 if case:
1311 1311 casepath = b'#'.join(case)
1312 1312 self.name = '%s#%s' % (self.name, _strpath(casepath))
1313 1313 self.errpath = b'%s#%s.err' % (self.errpath[:-4], casepath)
1314 1314 self._tmpname += b'-%s' % casepath
1315 1315 self._have = {}
1316 1316
1317 1317 @property
1318 1318 def refpath(self):
1319 1319 return os.path.join(self._testdir, self.bname)
1320 1320
1321 1321 def _run(self, env):
1322 1322 with open(self.path, 'rb') as f:
1323 1323 lines = f.readlines()
1324 1324
1325 1325 # .t file is both reference output and the test input, keep reference
1326 1326 # output updated with the the test input. This avoids some race
1327 1327 # conditions where the reference output does not match the actual test.
1328 1328 if self._refout is not None:
1329 1329 self._refout = lines
1330 1330
1331 1331 salt, script, after, expected = self._parsetest(lines)
1332 1332
1333 1333 # Write out the generated script.
1334 1334 fname = b'%s.sh' % self._testtmp
1335 1335 with open(fname, 'wb') as f:
1336 1336 for l in script:
1337 1337 f.write(l)
1338 1338
1339 1339 cmd = b'%s "%s"' % (self._shell, fname)
1340 1340 vlog("# Running", cmd)
1341 1341
1342 1342 exitcode, output = self._runcommand(cmd, env)
1343 1343
1344 1344 if self._aborted:
1345 1345 raise KeyboardInterrupt()
1346 1346
1347 1347 # Do not merge output if skipped. Return hghave message instead.
1348 1348 # Similarly, with --debug, output is None.
1349 1349 if exitcode == self.SKIPPED_STATUS or output is None:
1350 1350 return exitcode, output
1351 1351
1352 1352 return self._processoutput(exitcode, output, salt, after, expected)
1353 1353
1354 1354 def _hghave(self, reqs):
1355 1355 allreqs = b' '.join(reqs)
1356 1356 if allreqs in self._have:
1357 1357 return self._have.get(allreqs)
1358 1358
1359 1359 # TODO do something smarter when all other uses of hghave are gone.
1360 1360 runtestdir = os.path.abspath(os.path.dirname(_bytespath(__file__)))
1361 1361 tdir = runtestdir.replace(b'\\', b'/')
1362 1362 proc = Popen4(b'%s -c "%s/hghave %s"' %
1363 1363 (self._shell, tdir, allreqs),
1364 1364 self._testtmp, 0, self._getenv())
1365 1365 stdout, stderr = proc.communicate()
1366 1366 ret = proc.wait()
1367 1367 if wifexited(ret):
1368 1368 ret = os.WEXITSTATUS(ret)
1369 1369 if ret == 2:
1370 1370 print(stdout.decode('utf-8'))
1371 1371 sys.exit(1)
1372 1372
1373 1373 if ret != 0:
1374 1374 self._have[allreqs] = (False, stdout)
1375 1375 return False, stdout
1376 1376
1377 1377 if b'slow' in reqs:
1378 1378 self._timeout = self._slowtimeout
1379 1379
1380 1380 self._have[allreqs] = (True, None)
1381 1381 return True, None
1382 1382
1383 1383 def _iftest(self, args):
1384 1384 # implements "#if"
1385 1385 reqs = []
1386 1386 for arg in args:
1387 1387 if arg.startswith(b'no-') and arg[3:] in self._allcases:
1388 1388 if arg[3:] in self._case:
1389 1389 return False
1390 1390 elif arg in self._allcases:
1391 1391 if arg not in self._case:
1392 1392 return False
1393 1393 else:
1394 1394 reqs.append(arg)
1395 1395 return self._hghave(reqs)[0]
1396 1396
1397 1397 def _parsetest(self, lines):
1398 1398 # We generate a shell script which outputs unique markers to line
1399 1399 # up script results with our source. These markers include input
1400 1400 # line number and the last return code.
1401 1401 salt = b"SALT%d" % time.time()
1402 1402 def addsalt(line, inpython):
1403 1403 if inpython:
1404 1404 script.append(b'%s %d 0\n' % (salt, line))
1405 1405 else:
1406 1406 script.append(b'echo %s %d $?\n' % (salt, line))
1407 1407 activetrace = []
1408 1408 session = str(uuid.uuid4())
1409 1409 if PYTHON3:
1410 1410 session = session.encode('ascii')
1411 1411 hgcatapult = os.getenv('HGTESTCATAPULTSERVERPIPE') or \
1412 1412 os.getenv('HGCATAPULTSERVERPIPE')
1413 1413 def toggletrace(cmd=None):
1414 1414 if not hgcatapult or hgcatapult == os.devnull:
1415 1415 return
1416 1416
1417 1417 if activetrace:
1418 1418 script.append(
1419 1419 b'echo END %s %s >> "$HGTESTCATAPULTSERVERPIPE"\n' % (
1420 1420 session, activetrace[0]))
1421 1421 if cmd is None:
1422 1422 return
1423 1423
1424 1424 if isinstance(cmd, str):
1425 1425 quoted = shellquote(cmd.strip())
1426 1426 else:
1427 1427 quoted = shellquote(cmd.strip().decode('utf8')).encode('utf8')
1428 1428 quoted = quoted.replace(b'\\', b'\\\\')
1429 1429 script.append(
1430 1430 b'echo START %s %s >> "$HGTESTCATAPULTSERVERPIPE"\n' % (
1431 1431 session, quoted))
1432 1432 activetrace[0:] = [quoted]
1433 1433
1434 1434 script = []
1435 1435
1436 1436 # After we run the shell script, we re-unify the script output
1437 1437 # with non-active parts of the source, with synchronization by our
1438 1438 # SALT line number markers. The after table contains the non-active
1439 1439 # components, ordered by line number.
1440 1440 after = {}
1441 1441
1442 1442 # Expected shell script output.
1443 1443 expected = {}
1444 1444
1445 1445 pos = prepos = -1
1446 1446
1447 1447 # True or False when in a true or false conditional section
1448 1448 skipping = None
1449 1449
1450 1450 # We keep track of whether or not we're in a Python block so we
1451 1451 # can generate the surrounding doctest magic.
1452 1452 inpython = False
1453 1453
1454 1454 if self._debug:
1455 1455 script.append(b'set -x\n')
1456 1456 if self._hgcommand != b'hg':
1457 1457 script.append(b'alias hg="%s"\n' % self._hgcommand)
1458 1458 if os.getenv('MSYSTEM'):
1459 1459 script.append(b'alias pwd="pwd -W"\n')
1460 1460
1461 1461 if hgcatapult and hgcatapult != os.devnull:
1462 1462 # Kludge: use a while loop to keep the pipe from getting
1463 1463 # closed by our echo commands. The still-running file gets
1464 1464 # reaped at the end of the script, which causes the while
1465 1465 # loop to exit and closes the pipe. Sigh.
1466 1466 script.append(
1467 1467 b'rtendtracing() {\n'
1468 1468 b' echo END %(session)s %(name)s >> %(catapult)s\n'
1469 1469 b' rm -f "$TESTTMP/.still-running"\n'
1470 1470 b'}\n'
1471 1471 b'trap "rtendtracing" 0\n'
1472 1472 b'touch "$TESTTMP/.still-running"\n'
1473 1473 b'while [ -f "$TESTTMP/.still-running" ]; do sleep 1; done '
1474 1474 b'> %(catapult)s &\n'
1475 1475 b'HGCATAPULTSESSION=%(session)s ; export HGCATAPULTSESSION\n'
1476 1476 b'echo START %(session)s %(name)s >> %(catapult)s\n'
1477 1477 % {
1478 1478 'name': self.name,
1479 1479 'session': session,
1480 1480 'catapult': hgcatapult,
1481 1481 }
1482 1482 )
1483 1483
1484 1484 if self._case:
1485 1485 casestr = b'#'.join(self._case)
1486 1486 if isinstance(self._case, str):
1487 1487 quoted = shellquote(casestr)
1488 1488 else:
1489 1489 quoted = shellquote(casestr.decode('utf8')).encode('utf8')
1490 1490 script.append(b'TESTCASE=%s\n' % quoted)
1491 1491 script.append(b'export TESTCASE\n')
1492 1492
1493 1493 n = 0
1494 1494 for n, l in enumerate(lines):
1495 1495 if not l.endswith(b'\n'):
1496 1496 l += b'\n'
1497 1497 if l.startswith(b'#require'):
1498 1498 lsplit = l.split()
1499 1499 if len(lsplit) < 2 or lsplit[0] != b'#require':
1500 1500 after.setdefault(pos, []).append(' !!! invalid #require\n')
1501 1501 if not skipping:
1502 1502 haveresult, message = self._hghave(lsplit[1:])
1503 1503 if not haveresult:
1504 1504 script = [b'echo "%s"\nexit 80\n' % message]
1505 1505 break
1506 1506 after.setdefault(pos, []).append(l)
1507 1507 elif l.startswith(b'#if'):
1508 1508 lsplit = l.split()
1509 1509 if len(lsplit) < 2 or lsplit[0] != b'#if':
1510 1510 after.setdefault(pos, []).append(' !!! invalid #if\n')
1511 1511 if skipping is not None:
1512 1512 after.setdefault(pos, []).append(' !!! nested #if\n')
1513 1513 skipping = not self._iftest(lsplit[1:])
1514 1514 after.setdefault(pos, []).append(l)
1515 1515 elif l.startswith(b'#else'):
1516 1516 if skipping is None:
1517 1517 after.setdefault(pos, []).append(' !!! missing #if\n')
1518 1518 skipping = not skipping
1519 1519 after.setdefault(pos, []).append(l)
1520 1520 elif l.startswith(b'#endif'):
1521 1521 if skipping is None:
1522 1522 after.setdefault(pos, []).append(' !!! missing #if\n')
1523 1523 skipping = None
1524 1524 after.setdefault(pos, []).append(l)
1525 1525 elif skipping:
1526 1526 after.setdefault(pos, []).append(l)
1527 1527 elif l.startswith(b' >>> '): # python inlines
1528 1528 after.setdefault(pos, []).append(l)
1529 1529 prepos = pos
1530 1530 pos = n
1531 1531 if not inpython:
1532 1532 # We've just entered a Python block. Add the header.
1533 1533 inpython = True
1534 1534 addsalt(prepos, False) # Make sure we report the exit code.
1535 1535 script.append(b'"%s" -m heredoctest <<EOF\n' % PYTHON)
1536 1536 addsalt(n, True)
1537 1537 script.append(l[2:])
1538 1538 elif l.startswith(b' ... '): # python inlines
1539 1539 after.setdefault(prepos, []).append(l)
1540 1540 script.append(l[2:])
1541 1541 elif l.startswith(b' $ '): # commands
1542 1542 if inpython:
1543 1543 script.append(b'EOF\n')
1544 1544 inpython = False
1545 1545 after.setdefault(pos, []).append(l)
1546 1546 prepos = pos
1547 1547 pos = n
1548 1548 addsalt(n, False)
1549 1549 rawcmd = l[4:]
1550 1550 cmd = rawcmd.split()
1551 1551 toggletrace(rawcmd)
1552 1552 if len(cmd) == 2 and cmd[0] == b'cd':
1553 1553 l = b' $ cd %s || exit 1\n' % cmd[1]
1554 1554 script.append(rawcmd)
1555 1555 elif l.startswith(b' > '): # continuations
1556 1556 after.setdefault(prepos, []).append(l)
1557 1557 script.append(l[4:])
1558 1558 elif l.startswith(b' '): # results
1559 1559 # Queue up a list of expected results.
1560 1560 expected.setdefault(pos, []).append(l[2:])
1561 1561 else:
1562 1562 if inpython:
1563 1563 script.append(b'EOF\n')
1564 1564 inpython = False
1565 1565 # Non-command/result. Queue up for merged output.
1566 1566 after.setdefault(pos, []).append(l)
1567 1567
1568 1568 if inpython:
1569 1569 script.append(b'EOF\n')
1570 1570 if skipping is not None:
1571 1571 after.setdefault(pos, []).append(' !!! missing #endif\n')
1572 1572 addsalt(n + 1, False)
1573 1573 # Need to end any current per-command trace
1574 1574 if activetrace:
1575 1575 toggletrace()
1576 1576 return salt, script, after, expected
1577 1577
1578 1578 def _processoutput(self, exitcode, output, salt, after, expected):
1579 1579 # Merge the script output back into a unified test.
1580 1580 warnonly = 1 # 1: not yet; 2: yes; 3: for sure not
1581 1581 if exitcode != 0:
1582 1582 warnonly = 3
1583 1583
1584 1584 pos = -1
1585 1585 postout = []
1586 1586 for l in output:
1587 1587 lout, lcmd = l, None
1588 1588 if salt in l:
1589 1589 lout, lcmd = l.split(salt, 1)
1590 1590
1591 1591 while lout:
1592 1592 if not lout.endswith(b'\n'):
1593 1593 lout += b' (no-eol)\n'
1594 1594
1595 1595 # Find the expected output at the current position.
1596 1596 els = [None]
1597 1597 if expected.get(pos, None):
1598 1598 els = expected[pos]
1599 1599
1600 1600 optional = []
1601 1601 for i, el in enumerate(els):
1602 1602 r = False
1603 1603 if el:
1604 1604 r, exact = self.linematch(el, lout)
1605 1605 if isinstance(r, str):
1606 1606 if r == '-glob':
1607 1607 lout = ''.join(el.rsplit(' (glob)', 1))
1608 1608 r = '' # Warn only this line.
1609 1609 elif r == "retry":
1610 1610 postout.append(b' ' + el)
1611 1611 else:
1612 1612 log('\ninfo, unknown linematch result: %r\n' % r)
1613 1613 r = False
1614 1614 if r:
1615 1615 els.pop(i)
1616 1616 break
1617 1617 if el:
1618 1618 if el.endswith(b" (?)\n"):
1619 1619 optional.append(i)
1620 1620 else:
1621 1621 m = optline.match(el)
1622 1622 if m:
1623 1623 conditions = [
1624 1624 c for c in m.group(2).split(b' ')]
1625 1625
1626 1626 if not self._iftest(conditions):
1627 1627 optional.append(i)
1628 1628 if exact:
1629 1629 # Don't allow line to be matches against a later
1630 1630 # line in the output
1631 1631 els.pop(i)
1632 1632 break
1633 1633
1634 1634 if r:
1635 1635 if r == "retry":
1636 1636 continue
1637 1637 # clean up any optional leftovers
1638 1638 for i in optional:
1639 1639 postout.append(b' ' + els[i])
1640 1640 for i in reversed(optional):
1641 1641 del els[i]
1642 1642 postout.append(b' ' + el)
1643 1643 else:
1644 1644 if self.NEEDESCAPE(lout):
1645 1645 lout = TTest._stringescape(b'%s (esc)\n' %
1646 1646 lout.rstrip(b'\n'))
1647 1647 postout.append(b' ' + lout) # Let diff deal with it.
1648 1648 if r != '': # If line failed.
1649 1649 warnonly = 3 # for sure not
1650 1650 elif warnonly == 1: # Is "not yet" and line is warn only.
1651 1651 warnonly = 2 # Yes do warn.
1652 1652 break
1653 1653 else:
1654 1654 # clean up any optional leftovers
1655 1655 while expected.get(pos, None):
1656 1656 el = expected[pos].pop(0)
1657 1657 if el:
1658 1658 if not el.endswith(b" (?)\n"):
1659 1659 m = optline.match(el)
1660 1660 if m:
1661 1661 conditions = [c for c in m.group(2).split(b' ')]
1662 1662
1663 1663 if self._iftest(conditions):
1664 1664 # Don't append as optional line
1665 1665 continue
1666 1666 else:
1667 1667 continue
1668 1668 postout.append(b' ' + el)
1669 1669
1670 1670 if lcmd:
1671 1671 # Add on last return code.
1672 1672 ret = int(lcmd.split()[1])
1673 1673 if ret != 0:
1674 1674 postout.append(b' [%d]\n' % ret)
1675 1675 if pos in after:
1676 1676 # Merge in non-active test bits.
1677 1677 postout += after.pop(pos)
1678 1678 pos = int(lcmd.split()[0])
1679 1679
1680 1680 if pos in after:
1681 1681 postout += after.pop(pos)
1682 1682
1683 1683 if warnonly == 2:
1684 1684 exitcode = False # Set exitcode to warned.
1685 1685
1686 1686 return exitcode, postout
1687 1687
1688 1688 @staticmethod
1689 1689 def rematch(el, l):
1690 1690 try:
1691 1691 el = b'(?:' + el + b')'
1692 1692 # use \Z to ensure that the regex matches to the end of the string
1693 1693 if os.name == 'nt':
1694 1694 return re.match(el + br'\r?\n\Z', l)
1695 1695 return re.match(el + br'\n\Z', l)
1696 1696 except re.error:
1697 1697 # el is an invalid regex
1698 1698 return False
1699 1699
1700 1700 @staticmethod
1701 1701 def globmatch(el, l):
1702 1702 # The only supported special characters are * and ? plus / which also
1703 1703 # matches \ on windows. Escaping of these characters is supported.
1704 1704 if el + b'\n' == l:
1705 1705 if os.altsep:
1706 1706 # matching on "/" is not needed for this line
1707 1707 for pat in checkcodeglobpats:
1708 1708 if pat.match(el):
1709 1709 return True
1710 1710 return b'-glob'
1711 1711 return True
1712 1712 el = el.replace(b'$LOCALIP', b'*')
1713 1713 i, n = 0, len(el)
1714 1714 res = b''
1715 1715 while i < n:
1716 1716 c = el[i:i + 1]
1717 1717 i += 1
1718 1718 if c == b'\\' and i < n and el[i:i + 1] in b'*?\\/':
1719 1719 res += el[i - 1:i + 1]
1720 1720 i += 1
1721 1721 elif c == b'*':
1722 1722 res += b'.*'
1723 1723 elif c == b'?':
1724 1724 res += b'.'
1725 1725 elif c == b'/' and os.altsep:
1726 1726 res += b'[/\\\\]'
1727 1727 else:
1728 1728 res += re.escape(c)
1729 1729 return TTest.rematch(res, l)
1730 1730
1731 1731 def linematch(self, el, l):
1732 1732 if el == l: # perfect match (fast)
1733 1733 return True, True
1734 1734 retry = False
1735 1735 if el.endswith(b" (?)\n"):
1736 1736 retry = "retry"
1737 1737 el = el[:-5] + b"\n"
1738 1738 else:
1739 1739 m = optline.match(el)
1740 1740 if m:
1741 1741 conditions = [c for c in m.group(2).split(b' ')]
1742 1742
1743 1743 el = m.group(1) + b"\n"
1744 1744 if not self._iftest(conditions):
1745 1745 retry = "retry" # Not required by listed features
1746 1746
1747 1747 if el.endswith(b" (esc)\n"):
1748 1748 if PYTHON3:
1749 1749 el = el[:-7].decode('unicode_escape') + '\n'
1750 1750 el = el.encode('utf-8')
1751 1751 else:
1752 1752 el = el[:-7].decode('string-escape') + '\n'
1753 1753 if el == l or os.name == 'nt' and el[:-1] + b'\r\n' == l:
1754 1754 return True, True
1755 1755 if el.endswith(b" (re)\n"):
1756 1756 return (TTest.rematch(el[:-6], l) or retry), False
1757 1757 if el.endswith(b" (glob)\n"):
1758 1758 # ignore '(glob)' added to l by 'replacements'
1759 1759 if l.endswith(b" (glob)\n"):
1760 1760 l = l[:-8] + b"\n"
1761 1761 return (TTest.globmatch(el[:-8], l) or retry), False
1762 1762 if os.altsep:
1763 1763 _l = l.replace(b'\\', b'/')
1764 1764 if el == _l or os.name == 'nt' and el[:-1] + b'\r\n' == _l:
1765 1765 return True, True
1766 1766 return retry, True
1767 1767
1768 1768 @staticmethod
1769 1769 def parsehghaveoutput(lines):
1770 1770 '''Parse hghave log lines.
1771 1771
1772 1772 Return tuple of lists (missing, failed):
1773 1773 * the missing/unknown features
1774 1774 * the features for which existence check failed'''
1775 1775 missing = []
1776 1776 failed = []
1777 1777 for line in lines:
1778 1778 if line.startswith(TTest.SKIPPED_PREFIX):
1779 1779 line = line.splitlines()[0]
1780 1780 missing.append(line[len(TTest.SKIPPED_PREFIX):].decode('utf-8'))
1781 1781 elif line.startswith(TTest.FAILED_PREFIX):
1782 1782 line = line.splitlines()[0]
1783 1783 failed.append(line[len(TTest.FAILED_PREFIX):].decode('utf-8'))
1784 1784
1785 1785 return missing, failed
1786 1786
1787 1787 @staticmethod
1788 1788 def _escapef(m):
1789 1789 return TTest.ESCAPEMAP[m.group(0)]
1790 1790
1791 1791 @staticmethod
1792 1792 def _stringescape(s):
1793 1793 return TTest.ESCAPESUB(TTest._escapef, s)
1794 1794
1795 1795 iolock = threading.RLock()
1796 1796 firstlock = threading.RLock()
1797 1797 firsterror = False
1798 1798
1799 1799 class TestResult(unittest._TextTestResult):
1800 1800 """Holds results when executing via unittest."""
1801 1801 # Don't worry too much about accessing the non-public _TextTestResult.
1802 1802 # It is relatively common in Python testing tools.
1803 1803 def __init__(self, options, *args, **kwargs):
1804 1804 super(TestResult, self).__init__(*args, **kwargs)
1805 1805
1806 1806 self._options = options
1807 1807
1808 1808 # unittest.TestResult didn't have skipped until 2.7. We need to
1809 1809 # polyfill it.
1810 1810 self.skipped = []
1811 1811
1812 1812 # We have a custom "ignored" result that isn't present in any Python
1813 1813 # unittest implementation. It is very similar to skipped. It may make
1814 1814 # sense to map it into skip some day.
1815 1815 self.ignored = []
1816 1816
1817 1817 self.times = []
1818 1818 self._firststarttime = None
1819 1819 # Data stored for the benefit of generating xunit reports.
1820 1820 self.successes = []
1821 1821 self.faildata = {}
1822 1822
1823 1823 if options.color == 'auto':
1824 1824 self.color = pygmentspresent and self.stream.isatty()
1825 1825 elif options.color == 'never':
1826 1826 self.color = False
1827 1827 else: # 'always', for testing purposes
1828 1828 self.color = pygmentspresent
1829 1829
1830 1830 def onStart(self, test):
1831 1831 """ Can be overriden by custom TestResult
1832 1832 """
1833 1833
1834 1834 def onEnd(self):
1835 1835 """ Can be overriden by custom TestResult
1836 1836 """
1837 1837
1838 1838 def addFailure(self, test, reason):
1839 1839 self.failures.append((test, reason))
1840 1840
1841 1841 if self._options.first:
1842 1842 self.stop()
1843 1843 else:
1844 1844 with iolock:
1845 1845 if reason == "timed out":
1846 1846 self.stream.write('t')
1847 1847 else:
1848 1848 if not self._options.nodiff:
1849 1849 self.stream.write('\n')
1850 1850 # Exclude the '\n' from highlighting to lex correctly
1851 1851 formatted = 'ERROR: %s output changed\n' % test
1852 1852 self.stream.write(highlightmsg(formatted, self.color))
1853 1853 self.stream.write('!')
1854 1854
1855 1855 self.stream.flush()
1856 1856
1857 1857 def addSuccess(self, test):
1858 1858 with iolock:
1859 1859 super(TestResult, self).addSuccess(test)
1860 1860 self.successes.append(test)
1861 1861
1862 1862 def addError(self, test, err):
1863 1863 super(TestResult, self).addError(test, err)
1864 1864 if self._options.first:
1865 1865 self.stop()
1866 1866
1867 1867 # Polyfill.
1868 1868 def addSkip(self, test, reason):
1869 1869 self.skipped.append((test, reason))
1870 1870 with iolock:
1871 1871 if self.showAll:
1872 1872 self.stream.writeln('skipped %s' % reason)
1873 1873 else:
1874 1874 self.stream.write('s')
1875 1875 self.stream.flush()
1876 1876
1877 1877 def addIgnore(self, test, reason):
1878 1878 self.ignored.append((test, reason))
1879 1879 with iolock:
1880 1880 if self.showAll:
1881 1881 self.stream.writeln('ignored %s' % reason)
1882 1882 else:
1883 1883 if reason not in ('not retesting', "doesn't match keyword"):
1884 1884 self.stream.write('i')
1885 1885 else:
1886 1886 self.testsRun += 1
1887 1887 self.stream.flush()
1888 1888
1889 1889 def addOutputMismatch(self, test, ret, got, expected):
1890 1890 """Record a mismatch in test output for a particular test."""
1891 1891 if self.shouldStop or firsterror:
1892 1892 # don't print, some other test case already failed and
1893 1893 # printed, we're just stale and probably failed due to our
1894 1894 # temp dir getting cleaned up.
1895 1895 return
1896 1896
1897 1897 accepted = False
1898 1898 lines = []
1899 1899
1900 1900 with iolock:
1901 1901 if self._options.nodiff:
1902 1902 pass
1903 1903 elif self._options.view:
1904 1904 v = self._options.view
1905 os.system(r"%s %s %s" %
1906 (v, _strpath(test.refpath), _strpath(test.errpath)))
1905 subprocess.call(r'"%s" "%s" "%s"' %
1906 (v, _strpath(test.refpath),
1907 _strpath(test.errpath)), shell=True)
1907 1908 else:
1908 1909 servefail, lines = getdiff(expected, got,
1909 1910 test.refpath, test.errpath)
1910 1911 self.stream.write('\n')
1911 1912 for line in lines:
1912 1913 line = highlightdiff(line, self.color)
1913 1914 if PYTHON3:
1914 1915 self.stream.flush()
1915 1916 self.stream.buffer.write(line)
1916 1917 self.stream.buffer.flush()
1917 1918 else:
1918 1919 self.stream.write(line)
1919 1920 self.stream.flush()
1920 1921
1921 1922 if servefail:
1922 1923 raise test.failureException(
1923 1924 'server failed to start (HGPORT=%s)' % test._startport)
1924 1925
1925 1926 # handle interactive prompt without releasing iolock
1926 1927 if self._options.interactive:
1927 1928 if test.readrefout() != expected:
1928 1929 self.stream.write(
1929 1930 'Reference output has changed (run again to prompt '
1930 1931 'changes)')
1931 1932 else:
1932 1933 self.stream.write('Accept this change? [n] ')
1933 1934 self.stream.flush()
1934 1935 answer = sys.stdin.readline().strip()
1935 1936 if answer.lower() in ('y', 'yes'):
1936 1937 if test.path.endswith(b'.t'):
1937 1938 rename(test.errpath, test.path)
1938 1939 else:
1939 1940 rename(test.errpath, '%s.out' % test.path)
1940 1941 accepted = True
1941 1942 if not accepted:
1942 1943 self.faildata[test.name] = b''.join(lines)
1943 1944
1944 1945 return accepted
1945 1946
1946 1947 def startTest(self, test):
1947 1948 super(TestResult, self).startTest(test)
1948 1949
1949 1950 # os.times module computes the user time and system time spent by
1950 1951 # child's processes along with real elapsed time taken by a process.
1951 1952 # This module has one limitation. It can only work for Linux user
1952 1953 # and not for Windows.
1953 1954 test.started = os.times()
1954 1955 if self._firststarttime is None: # thread racy but irrelevant
1955 1956 self._firststarttime = test.started[4]
1956 1957
1957 1958 def stopTest(self, test, interrupted=False):
1958 1959 super(TestResult, self).stopTest(test)
1959 1960
1960 1961 test.stopped = os.times()
1961 1962
1962 1963 starttime = test.started
1963 1964 endtime = test.stopped
1964 1965 origin = self._firststarttime
1965 1966 self.times.append((test.name,
1966 1967 endtime[2] - starttime[2], # user space CPU time
1967 1968 endtime[3] - starttime[3], # sys space CPU time
1968 1969 endtime[4] - starttime[4], # real time
1969 1970 starttime[4] - origin, # start date in run context
1970 1971 endtime[4] - origin, # end date in run context
1971 1972 ))
1972 1973
1973 1974 if interrupted:
1974 1975 with iolock:
1975 1976 self.stream.writeln('INTERRUPTED: %s (after %d seconds)' % (
1976 1977 test.name, self.times[-1][3]))
1977 1978
1978 1979 def getTestResult():
1979 1980 """
1980 1981 Returns the relevant test result
1981 1982 """
1982 1983 if "CUSTOM_TEST_RESULT" in os.environ:
1983 1984 testresultmodule = __import__(os.environ["CUSTOM_TEST_RESULT"])
1984 1985 return testresultmodule.TestResult
1985 1986 else:
1986 1987 return TestResult
1987 1988
1988 1989 class TestSuite(unittest.TestSuite):
1989 1990 """Custom unittest TestSuite that knows how to execute Mercurial tests."""
1990 1991
1991 1992 def __init__(self, testdir, jobs=1, whitelist=None, blacklist=None,
1992 1993 retest=False, keywords=None, loop=False, runs_per_test=1,
1993 1994 loadtest=None, showchannels=False,
1994 1995 *args, **kwargs):
1995 1996 """Create a new instance that can run tests with a configuration.
1996 1997
1997 1998 testdir specifies the directory where tests are executed from. This
1998 1999 is typically the ``tests`` directory from Mercurial's source
1999 2000 repository.
2000 2001
2001 2002 jobs specifies the number of jobs to run concurrently. Each test
2002 2003 executes on its own thread. Tests actually spawn new processes, so
2003 2004 state mutation should not be an issue.
2004 2005
2005 2006 If there is only one job, it will use the main thread.
2006 2007
2007 2008 whitelist and blacklist denote tests that have been whitelisted and
2008 2009 blacklisted, respectively. These arguments don't belong in TestSuite.
2009 2010 Instead, whitelist and blacklist should be handled by the thing that
2010 2011 populates the TestSuite with tests. They are present to preserve
2011 2012 backwards compatible behavior which reports skipped tests as part
2012 2013 of the results.
2013 2014
2014 2015 retest denotes whether to retest failed tests. This arguably belongs
2015 2016 outside of TestSuite.
2016 2017
2017 2018 keywords denotes key words that will be used to filter which tests
2018 2019 to execute. This arguably belongs outside of TestSuite.
2019 2020
2020 2021 loop denotes whether to loop over tests forever.
2021 2022 """
2022 2023 super(TestSuite, self).__init__(*args, **kwargs)
2023 2024
2024 2025 self._jobs = jobs
2025 2026 self._whitelist = whitelist
2026 2027 self._blacklist = blacklist
2027 2028 self._retest = retest
2028 2029 self._keywords = keywords
2029 2030 self._loop = loop
2030 2031 self._runs_per_test = runs_per_test
2031 2032 self._loadtest = loadtest
2032 2033 self._showchannels = showchannels
2033 2034
2034 2035 def run(self, result):
2035 2036 # We have a number of filters that need to be applied. We do this
2036 2037 # here instead of inside Test because it makes the running logic for
2037 2038 # Test simpler.
2038 2039 tests = []
2039 2040 num_tests = [0]
2040 2041 for test in self._tests:
2041 2042 def get():
2042 2043 num_tests[0] += 1
2043 2044 if getattr(test, 'should_reload', False):
2044 2045 return self._loadtest(test, num_tests[0])
2045 2046 return test
2046 2047 if not os.path.exists(test.path):
2047 2048 result.addSkip(test, "Doesn't exist")
2048 2049 continue
2049 2050
2050 2051 if not (self._whitelist and test.bname in self._whitelist):
2051 2052 if self._blacklist and test.bname in self._blacklist:
2052 2053 result.addSkip(test, 'blacklisted')
2053 2054 continue
2054 2055
2055 2056 if self._retest and not os.path.exists(test.errpath):
2056 2057 result.addIgnore(test, 'not retesting')
2057 2058 continue
2058 2059
2059 2060 if self._keywords:
2060 2061 with open(test.path, 'rb') as f:
2061 2062 t = f.read().lower() + test.bname.lower()
2062 2063 ignored = False
2063 2064 for k in self._keywords.lower().split():
2064 2065 if k not in t:
2065 2066 result.addIgnore(test, "doesn't match keyword")
2066 2067 ignored = True
2067 2068 break
2068 2069
2069 2070 if ignored:
2070 2071 continue
2071 2072 for _ in xrange(self._runs_per_test):
2072 2073 tests.append(get())
2073 2074
2074 2075 runtests = list(tests)
2075 2076 done = queue.Queue()
2076 2077 running = 0
2077 2078
2078 2079 channels = [""] * self._jobs
2079 2080
2080 2081 def job(test, result):
2081 2082 for n, v in enumerate(channels):
2082 2083 if not v:
2083 2084 channel = n
2084 2085 break
2085 2086 else:
2086 2087 raise ValueError('Could not find output channel')
2087 2088 channels[channel] = "=" + test.name[5:].split(".")[0]
2088 2089 try:
2089 2090 test(result)
2090 2091 done.put(None)
2091 2092 except KeyboardInterrupt:
2092 2093 pass
2093 2094 except: # re-raises
2094 2095 done.put(('!', test, 'run-test raised an error, see traceback'))
2095 2096 raise
2096 2097 finally:
2097 2098 try:
2098 2099 channels[channel] = ''
2099 2100 except IndexError:
2100 2101 pass
2101 2102
2102 2103 def stat():
2103 2104 count = 0
2104 2105 while channels:
2105 2106 d = '\n%03s ' % count
2106 2107 for n, v in enumerate(channels):
2107 2108 if v:
2108 2109 d += v[0]
2109 2110 channels[n] = v[1:] or '.'
2110 2111 else:
2111 2112 d += ' '
2112 2113 d += ' '
2113 2114 with iolock:
2114 2115 sys.stdout.write(d + ' ')
2115 2116 sys.stdout.flush()
2116 2117 for x in xrange(10):
2117 2118 if channels:
2118 2119 time.sleep(.1)
2119 2120 count += 1
2120 2121
2121 2122 stoppedearly = False
2122 2123
2123 2124 if self._showchannels:
2124 2125 statthread = threading.Thread(target=stat, name="stat")
2125 2126 statthread.start()
2126 2127
2127 2128 try:
2128 2129 while tests or running:
2129 2130 if not done.empty() or running == self._jobs or not tests:
2130 2131 try:
2131 2132 done.get(True, 1)
2132 2133 running -= 1
2133 2134 if result and result.shouldStop:
2134 2135 stoppedearly = True
2135 2136 break
2136 2137 except queue.Empty:
2137 2138 continue
2138 2139 if tests and not running == self._jobs:
2139 2140 test = tests.pop(0)
2140 2141 if self._loop:
2141 2142 if getattr(test, 'should_reload', False):
2142 2143 num_tests[0] += 1
2143 2144 tests.append(
2144 2145 self._loadtest(test, num_tests[0]))
2145 2146 else:
2146 2147 tests.append(test)
2147 2148 if self._jobs == 1:
2148 2149 job(test, result)
2149 2150 else:
2150 2151 t = threading.Thread(target=job, name=test.name,
2151 2152 args=(test, result))
2152 2153 t.start()
2153 2154 running += 1
2154 2155
2155 2156 # If we stop early we still need to wait on started tests to
2156 2157 # finish. Otherwise, there is a race between the test completing
2157 2158 # and the test's cleanup code running. This could result in the
2158 2159 # test reporting incorrect.
2159 2160 if stoppedearly:
2160 2161 while running:
2161 2162 try:
2162 2163 done.get(True, 1)
2163 2164 running -= 1
2164 2165 except queue.Empty:
2165 2166 continue
2166 2167 except KeyboardInterrupt:
2167 2168 for test in runtests:
2168 2169 test.abort()
2169 2170
2170 2171 channels = []
2171 2172
2172 2173 return result
2173 2174
2174 2175 # Save the most recent 5 wall-clock runtimes of each test to a
2175 2176 # human-readable text file named .testtimes. Tests are sorted
2176 2177 # alphabetically, while times for each test are listed from oldest to
2177 2178 # newest.
2178 2179
2179 2180 def loadtimes(outputdir):
2180 2181 times = []
2181 2182 try:
2182 2183 with open(os.path.join(outputdir, b'.testtimes')) as fp:
2183 2184 for line in fp:
2184 2185 m = re.match('(.*?) ([0-9. ]+)', line)
2185 2186 times.append((m.group(1),
2186 2187 [float(t) for t in m.group(2).split()]))
2187 2188 except IOError as err:
2188 2189 if err.errno != errno.ENOENT:
2189 2190 raise
2190 2191 return times
2191 2192
2192 2193 def savetimes(outputdir, result):
2193 2194 saved = dict(loadtimes(outputdir))
2194 2195 maxruns = 5
2195 2196 skipped = set([str(t[0]) for t in result.skipped])
2196 2197 for tdata in result.times:
2197 2198 test, real = tdata[0], tdata[3]
2198 2199 if test not in skipped:
2199 2200 ts = saved.setdefault(test, [])
2200 2201 ts.append(real)
2201 2202 ts[:] = ts[-maxruns:]
2202 2203
2203 2204 fd, tmpname = tempfile.mkstemp(prefix=b'.testtimes',
2204 2205 dir=outputdir, text=True)
2205 2206 with os.fdopen(fd, 'w') as fp:
2206 2207 for name, ts in sorted(saved.items()):
2207 2208 fp.write('%s %s\n' % (name, ' '.join(['%.3f' % (t,) for t in ts])))
2208 2209 timepath = os.path.join(outputdir, b'.testtimes')
2209 2210 try:
2210 2211 os.unlink(timepath)
2211 2212 except OSError:
2212 2213 pass
2213 2214 try:
2214 2215 os.rename(tmpname, timepath)
2215 2216 except OSError:
2216 2217 pass
2217 2218
2218 2219 class TextTestRunner(unittest.TextTestRunner):
2219 2220 """Custom unittest test runner that uses appropriate settings."""
2220 2221
2221 2222 def __init__(self, runner, *args, **kwargs):
2222 2223 super(TextTestRunner, self).__init__(*args, **kwargs)
2223 2224
2224 2225 self._runner = runner
2225 2226
2226 2227 self._result = getTestResult()(self._runner.options, self.stream,
2227 2228 self.descriptions, self.verbosity)
2228 2229
2229 2230 def listtests(self, test):
2230 2231 test = sorted(test, key=lambda t: t.name)
2231 2232
2232 2233 self._result.onStart(test)
2233 2234
2234 2235 for t in test:
2235 2236 print(t.name)
2236 2237 self._result.addSuccess(t)
2237 2238
2238 2239 if self._runner.options.xunit:
2239 2240 with open(self._runner.options.xunit, "wb") as xuf:
2240 2241 self._writexunit(self._result, xuf)
2241 2242
2242 2243 if self._runner.options.json:
2243 2244 jsonpath = os.path.join(self._runner._outputdir, b'report.json')
2244 2245 with open(jsonpath, 'w') as fp:
2245 2246 self._writejson(self._result, fp)
2246 2247
2247 2248 return self._result
2248 2249
2249 2250 def run(self, test):
2250 2251 self._result.onStart(test)
2251 2252 test(self._result)
2252 2253
2253 2254 failed = len(self._result.failures)
2254 2255 skipped = len(self._result.skipped)
2255 2256 ignored = len(self._result.ignored)
2256 2257
2257 2258 with iolock:
2258 2259 self.stream.writeln('')
2259 2260
2260 2261 if not self._runner.options.noskips:
2261 2262 for test, msg in sorted(self._result.skipped,
2262 2263 key=lambda s: s[0].name):
2263 2264 formatted = 'Skipped %s: %s\n' % (test.name, msg)
2264 2265 msg = highlightmsg(formatted, self._result.color)
2265 2266 self.stream.write(msg)
2266 2267 for test, msg in sorted(self._result.failures,
2267 2268 key=lambda f: f[0].name):
2268 2269 formatted = 'Failed %s: %s\n' % (test.name, msg)
2269 2270 self.stream.write(highlightmsg(formatted, self._result.color))
2270 2271 for test, msg in sorted(self._result.errors,
2271 2272 key=lambda e: e[0].name):
2272 2273 self.stream.writeln('Errored %s: %s' % (test.name, msg))
2273 2274
2274 2275 if self._runner.options.xunit:
2275 2276 with open(self._runner.options.xunit, "wb") as xuf:
2276 2277 self._writexunit(self._result, xuf)
2277 2278
2278 2279 if self._runner.options.json:
2279 2280 jsonpath = os.path.join(self._runner._outputdir, b'report.json')
2280 2281 with open(jsonpath, 'w') as fp:
2281 2282 self._writejson(self._result, fp)
2282 2283
2283 2284 self._runner._checkhglib('Tested')
2284 2285
2285 2286 savetimes(self._runner._outputdir, self._result)
2286 2287
2287 2288 if failed and self._runner.options.known_good_rev:
2288 2289 self._bisecttests(t for t, m in self._result.failures)
2289 2290 self.stream.writeln(
2290 2291 '# Ran %d tests, %d skipped, %d failed.'
2291 2292 % (self._result.testsRun, skipped + ignored, failed))
2292 2293 if failed:
2293 2294 self.stream.writeln('python hash seed: %s' %
2294 2295 os.environ['PYTHONHASHSEED'])
2295 2296 if self._runner.options.time:
2296 2297 self.printtimes(self._result.times)
2297 2298
2298 2299 if self._runner.options.exceptions:
2299 2300 exceptions = aggregateexceptions(
2300 2301 os.path.join(self._runner._outputdir, b'exceptions'))
2301 2302
2302 2303 self.stream.writeln('Exceptions Report:')
2303 2304 self.stream.writeln('%d total from %d frames' %
2304 2305 (exceptions['total'],
2305 2306 len(exceptions['exceptioncounts'])))
2306 2307 combined = exceptions['combined']
2307 2308 for key in sorted(combined, key=combined.get, reverse=True):
2308 2309 frame, line, exc = key
2309 2310 totalcount, testcount, leastcount, leasttest = combined[key]
2310 2311
2311 2312 self.stream.writeln('%d (%d tests)\t%s: %s (%s - %d total)'
2312 2313 % (totalcount,
2313 2314 testcount,
2314 2315 frame, exc,
2315 2316 leasttest, leastcount))
2316 2317
2317 2318 self.stream.flush()
2318 2319
2319 2320 return self._result
2320 2321
2321 2322 def _bisecttests(self, tests):
2322 2323 bisectcmd = ['hg', 'bisect']
2323 2324 bisectrepo = self._runner.options.bisect_repo
2324 2325 if bisectrepo:
2325 2326 bisectcmd.extend(['-R', os.path.abspath(bisectrepo)])
2326 2327 def pread(args):
2327 2328 env = os.environ.copy()
2328 2329 env['HGPLAIN'] = '1'
2329 2330 p = subprocess.Popen(args, stderr=subprocess.STDOUT,
2330 2331 stdout=subprocess.PIPE, env=env)
2331 2332 data = p.stdout.read()
2332 2333 p.wait()
2333 2334 return data
2334 2335 for test in tests:
2335 2336 pread(bisectcmd + ['--reset']),
2336 2337 pread(bisectcmd + ['--bad', '.'])
2337 2338 pread(bisectcmd + ['--good', self._runner.options.known_good_rev])
2338 2339 # TODO: we probably need to forward more options
2339 2340 # that alter hg's behavior inside the tests.
2340 2341 opts = ''
2341 2342 withhg = self._runner.options.with_hg
2342 2343 if withhg:
2343 2344 opts += ' --with-hg=%s ' % shellquote(_strpath(withhg))
2344 2345 rtc = '%s %s %s %s' % (sys.executable, sys.argv[0], opts,
2345 2346 test)
2346 2347 data = pread(bisectcmd + ['--command', rtc])
2347 2348 m = re.search(
2348 2349 (br'\nThe first (?P<goodbad>bad|good) revision '
2349 2350 br'is:\nchangeset: +\d+:(?P<node>[a-f0-9]+)\n.*\n'
2350 2351 br'summary: +(?P<summary>[^\n]+)\n'),
2351 2352 data, (re.MULTILINE | re.DOTALL))
2352 2353 if m is None:
2353 2354 self.stream.writeln(
2354 2355 'Failed to identify failure point for %s' % test)
2355 2356 continue
2356 2357 dat = m.groupdict()
2357 2358 verb = 'broken' if dat['goodbad'] == b'bad' else 'fixed'
2358 2359 self.stream.writeln(
2359 2360 '%s %s by %s (%s)' % (
2360 2361 test, verb, dat['node'].decode('ascii'),
2361 2362 dat['summary'].decode('utf8', 'ignore')))
2362 2363
2363 2364 def printtimes(self, times):
2364 2365 # iolock held by run
2365 2366 self.stream.writeln('# Producing time report')
2366 2367 times.sort(key=lambda t: (t[3]))
2367 2368 cols = '%7.3f %7.3f %7.3f %7.3f %7.3f %s'
2368 2369 self.stream.writeln('%-7s %-7s %-7s %-7s %-7s %s' %
2369 2370 ('start', 'end', 'cuser', 'csys', 'real', 'Test'))
2370 2371 for tdata in times:
2371 2372 test = tdata[0]
2372 2373 cuser, csys, real, start, end = tdata[1:6]
2373 2374 self.stream.writeln(cols % (start, end, cuser, csys, real, test))
2374 2375
2375 2376 @staticmethod
2376 2377 def _writexunit(result, outf):
2377 2378 # See http://llg.cubic.org/docs/junit/ for a reference.
2378 2379 timesd = dict((t[0], t[3]) for t in result.times)
2379 2380 doc = minidom.Document()
2380 2381 s = doc.createElement('testsuite')
2381 2382 s.setAttribute('errors', "0") # TODO
2382 2383 s.setAttribute('failures', str(len(result.failures)))
2383 2384 s.setAttribute('name', 'run-tests')
2384 2385 s.setAttribute('skipped', str(len(result.skipped) +
2385 2386 len(result.ignored)))
2386 2387 s.setAttribute('tests', str(result.testsRun))
2387 2388 doc.appendChild(s)
2388 2389 for tc in result.successes:
2389 2390 t = doc.createElement('testcase')
2390 2391 t.setAttribute('name', tc.name)
2391 2392 tctime = timesd.get(tc.name)
2392 2393 if tctime is not None:
2393 2394 t.setAttribute('time', '%.3f' % tctime)
2394 2395 s.appendChild(t)
2395 2396 for tc, err in sorted(result.faildata.items()):
2396 2397 t = doc.createElement('testcase')
2397 2398 t.setAttribute('name', tc)
2398 2399 tctime = timesd.get(tc)
2399 2400 if tctime is not None:
2400 2401 t.setAttribute('time', '%.3f' % tctime)
2401 2402 # createCDATASection expects a unicode or it will
2402 2403 # convert using default conversion rules, which will
2403 2404 # fail if string isn't ASCII.
2404 2405 err = cdatasafe(err).decode('utf-8', 'replace')
2405 2406 cd = doc.createCDATASection(err)
2406 2407 # Use 'failure' here instead of 'error' to match errors = 0,
2407 2408 # failures = len(result.failures) in the testsuite element.
2408 2409 failelem = doc.createElement('failure')
2409 2410 failelem.setAttribute('message', 'output changed')
2410 2411 failelem.setAttribute('type', 'output-mismatch')
2411 2412 failelem.appendChild(cd)
2412 2413 t.appendChild(failelem)
2413 2414 s.appendChild(t)
2414 2415 for tc, message in result.skipped:
2415 2416 # According to the schema, 'skipped' has no attributes. So store
2416 2417 # the skip message as a text node instead.
2417 2418 t = doc.createElement('testcase')
2418 2419 t.setAttribute('name', tc.name)
2419 2420 binmessage = message.encode('utf-8')
2420 2421 message = cdatasafe(binmessage).decode('utf-8', 'replace')
2421 2422 cd = doc.createCDATASection(message)
2422 2423 skipelem = doc.createElement('skipped')
2423 2424 skipelem.appendChild(cd)
2424 2425 t.appendChild(skipelem)
2425 2426 s.appendChild(t)
2426 2427 outf.write(doc.toprettyxml(indent=' ', encoding='utf-8'))
2427 2428
2428 2429 @staticmethod
2429 2430 def _writejson(result, outf):
2430 2431 timesd = {}
2431 2432 for tdata in result.times:
2432 2433 test = tdata[0]
2433 2434 timesd[test] = tdata[1:]
2434 2435
2435 2436 outcome = {}
2436 2437 groups = [('success', ((tc, None)
2437 2438 for tc in result.successes)),
2438 2439 ('failure', result.failures),
2439 2440 ('skip', result.skipped)]
2440 2441 for res, testcases in groups:
2441 2442 for tc, __ in testcases:
2442 2443 if tc.name in timesd:
2443 2444 diff = result.faildata.get(tc.name, b'')
2444 2445 try:
2445 2446 diff = diff.decode('unicode_escape')
2446 2447 except UnicodeDecodeError as e:
2447 2448 diff = '%r decoding diff, sorry' % e
2448 2449 tres = {'result': res,
2449 2450 'time': ('%0.3f' % timesd[tc.name][2]),
2450 2451 'cuser': ('%0.3f' % timesd[tc.name][0]),
2451 2452 'csys': ('%0.3f' % timesd[tc.name][1]),
2452 2453 'start': ('%0.3f' % timesd[tc.name][3]),
2453 2454 'end': ('%0.3f' % timesd[tc.name][4]),
2454 2455 'diff': diff,
2455 2456 }
2456 2457 else:
2457 2458 # blacklisted test
2458 2459 tres = {'result': res}
2459 2460
2460 2461 outcome[tc.name] = tres
2461 2462 jsonout = json.dumps(outcome, sort_keys=True, indent=4,
2462 2463 separators=(',', ': '))
2463 2464 outf.writelines(("testreport =", jsonout))
2464 2465
2465 2466 def sorttests(testdescs, previoustimes, shuffle=False):
2466 2467 """Do an in-place sort of tests."""
2467 2468 if shuffle:
2468 2469 random.shuffle(testdescs)
2469 2470 return
2470 2471
2471 2472 if previoustimes:
2472 2473 def sortkey(f):
2473 2474 f = f['path']
2474 2475 if f in previoustimes:
2475 2476 # Use most recent time as estimate
2476 2477 return -previoustimes[f][-1]
2477 2478 else:
2478 2479 # Default to a rather arbitrary value of 1 second for new tests
2479 2480 return -1.0
2480 2481 else:
2481 2482 # keywords for slow tests
2482 2483 slow = {b'svn': 10,
2483 2484 b'cvs': 10,
2484 2485 b'hghave': 10,
2485 2486 b'largefiles-update': 10,
2486 2487 b'run-tests': 10,
2487 2488 b'corruption': 10,
2488 2489 b'race': 10,
2489 2490 b'i18n': 10,
2490 2491 b'check': 100,
2491 2492 b'gendoc': 100,
2492 2493 b'contrib-perf': 200,
2493 2494 }
2494 2495 perf = {}
2495 2496
2496 2497 def sortkey(f):
2497 2498 # run largest tests first, as they tend to take the longest
2498 2499 f = f['path']
2499 2500 try:
2500 2501 return perf[f]
2501 2502 except KeyError:
2502 2503 try:
2503 2504 val = -os.stat(f).st_size
2504 2505 except OSError as e:
2505 2506 if e.errno != errno.ENOENT:
2506 2507 raise
2507 2508 perf[f] = -1e9 # file does not exist, tell early
2508 2509 return -1e9
2509 2510 for kw, mul in slow.items():
2510 2511 if kw in f:
2511 2512 val *= mul
2512 2513 if f.endswith(b'.py'):
2513 2514 val /= 10.0
2514 2515 perf[f] = val / 1000.0
2515 2516 return perf[f]
2516 2517
2517 2518 testdescs.sort(key=sortkey)
2518 2519
2519 2520 class TestRunner(object):
2520 2521 """Holds context for executing tests.
2521 2522
2522 2523 Tests rely on a lot of state. This object holds it for them.
2523 2524 """
2524 2525
2525 2526 # Programs required to run tests.
2526 2527 REQUIREDTOOLS = [
2527 2528 b'diff',
2528 2529 b'grep',
2529 2530 b'unzip',
2530 2531 b'gunzip',
2531 2532 b'bunzip2',
2532 2533 b'sed',
2533 2534 ]
2534 2535
2535 2536 # Maps file extensions to test class.
2536 2537 TESTTYPES = [
2537 2538 (b'.py', PythonTest),
2538 2539 (b'.t', TTest),
2539 2540 ]
2540 2541
2541 2542 def __init__(self):
2542 2543 self.options = None
2543 2544 self._hgroot = None
2544 2545 self._testdir = None
2545 2546 self._outputdir = None
2546 2547 self._hgtmp = None
2547 2548 self._installdir = None
2548 2549 self._bindir = None
2549 2550 self._tmpbinddir = None
2550 2551 self._pythondir = None
2551 2552 self._coveragefile = None
2552 2553 self._createdfiles = []
2553 2554 self._hgcommand = None
2554 2555 self._hgpath = None
2555 2556 self._portoffset = 0
2556 2557 self._ports = {}
2557 2558
2558 2559 def run(self, args, parser=None):
2559 2560 """Run the test suite."""
2560 2561 oldmask = os.umask(0o22)
2561 2562 try:
2562 2563 parser = parser or getparser()
2563 2564 options = parseargs(args, parser)
2564 2565 tests = [_bytespath(a) for a in options.tests]
2565 2566 if options.test_list is not None:
2566 2567 for listfile in options.test_list:
2567 2568 with open(listfile, 'rb') as f:
2568 2569 tests.extend(t for t in f.read().splitlines() if t)
2569 2570 self.options = options
2570 2571
2571 2572 self._checktools()
2572 2573 testdescs = self.findtests(tests)
2573 2574 if options.profile_runner:
2574 2575 import statprof
2575 2576 statprof.start()
2576 2577 result = self._run(testdescs)
2577 2578 if options.profile_runner:
2578 2579 statprof.stop()
2579 2580 statprof.display()
2580 2581 return result
2581 2582
2582 2583 finally:
2583 2584 os.umask(oldmask)
2584 2585
2585 2586 def _run(self, testdescs):
2586 2587 testdir = getcwdb()
2587 2588 self._testdir = osenvironb[b'TESTDIR'] = getcwdb()
2588 2589 # assume all tests in same folder for now
2589 2590 if testdescs:
2590 2591 pathname = os.path.dirname(testdescs[0]['path'])
2591 2592 if pathname:
2592 2593 testdir = os.path.join(testdir, pathname)
2593 2594 self._testdir = osenvironb[b'TESTDIR'] = testdir
2594 2595 if self.options.outputdir:
2595 2596 self._outputdir = canonpath(_bytespath(self.options.outputdir))
2596 2597 else:
2597 2598 self._outputdir = getcwdb()
2598 2599 if testdescs and pathname:
2599 2600 self._outputdir = os.path.join(self._outputdir, pathname)
2600 2601 previoustimes = {}
2601 2602 if self.options.order_by_runtime:
2602 2603 previoustimes = dict(loadtimes(self._outputdir))
2603 2604 sorttests(testdescs, previoustimes, shuffle=self.options.random)
2604 2605
2605 2606 if 'PYTHONHASHSEED' not in os.environ:
2606 2607 # use a random python hash seed all the time
2607 2608 # we do the randomness ourself to know what seed is used
2608 2609 os.environ['PYTHONHASHSEED'] = str(random.getrandbits(32))
2609 2610
2610 2611 if self.options.tmpdir:
2611 2612 self.options.keep_tmpdir = True
2612 2613 tmpdir = _bytespath(self.options.tmpdir)
2613 2614 if os.path.exists(tmpdir):
2614 2615 # Meaning of tmpdir has changed since 1.3: we used to create
2615 2616 # HGTMP inside tmpdir; now HGTMP is tmpdir. So fail if
2616 2617 # tmpdir already exists.
2617 2618 print("error: temp dir %r already exists" % tmpdir)
2618 2619 return 1
2619 2620
2620 2621 os.makedirs(tmpdir)
2621 2622 else:
2622 2623 d = None
2623 2624 if os.name == 'nt':
2624 2625 # without this, we get the default temp dir location, but
2625 2626 # in all lowercase, which causes troubles with paths (issue3490)
2626 2627 d = osenvironb.get(b'TMP', None)
2627 2628 tmpdir = tempfile.mkdtemp(b'', b'hgtests.', d)
2628 2629
2629 2630 self._hgtmp = osenvironb[b'HGTMP'] = (
2630 2631 os.path.realpath(tmpdir))
2631 2632
2632 2633 if self.options.with_hg:
2633 2634 self._installdir = None
2634 2635 whg = self.options.with_hg
2635 2636 self._bindir = os.path.dirname(os.path.realpath(whg))
2636 2637 assert isinstance(self._bindir, bytes)
2637 2638 self._hgcommand = os.path.basename(whg)
2638 2639 self._tmpbindir = os.path.join(self._hgtmp, b'install', b'bin')
2639 2640 os.makedirs(self._tmpbindir)
2640 2641
2641 2642 normbin = os.path.normpath(os.path.abspath(whg))
2642 2643 normbin = normbin.replace(os.sep.encode('ascii'), b'/')
2643 2644
2644 2645 # Other Python scripts in the test harness need to
2645 2646 # `import mercurial`. If `hg` is a Python script, we assume
2646 2647 # the Mercurial modules are relative to its path and tell the tests
2647 2648 # to load Python modules from its directory.
2648 2649 with open(whg, 'rb') as fh:
2649 2650 initial = fh.read(1024)
2650 2651
2651 2652 if re.match(b'#!.*python', initial):
2652 2653 self._pythondir = self._bindir
2653 2654 # If it looks like our in-repo Rust binary, use the source root.
2654 2655 # This is a bit hacky. But rhg is still not supported outside the
2655 2656 # source directory. So until it is, do the simple thing.
2656 2657 elif re.search(b'/rust/target/[^/]+/hg', normbin):
2657 2658 self._pythondir = os.path.dirname(self._testdir)
2658 2659 # Fall back to the legacy behavior.
2659 2660 else:
2660 2661 self._pythondir = self._bindir
2661 2662
2662 2663 else:
2663 2664 self._installdir = os.path.join(self._hgtmp, b"install")
2664 2665 self._bindir = os.path.join(self._installdir, b"bin")
2665 2666 self._hgcommand = b'hg'
2666 2667 self._tmpbindir = self._bindir
2667 2668 self._pythondir = os.path.join(self._installdir, b"lib", b"python")
2668 2669
2669 2670 # Force the use of hg.exe instead of relying on MSYS to recognize hg is
2670 2671 # a python script and feed it to python.exe. Legacy stdio is force
2671 2672 # enabled by hg.exe, and this is a more realistic way to launch hg
2672 2673 # anyway.
2673 2674 if os.name == 'nt' and not self._hgcommand.endswith(b'.exe'):
2674 2675 self._hgcommand += b'.exe'
2675 2676
2676 2677 # set CHGHG, then replace "hg" command by "chg"
2677 2678 chgbindir = self._bindir
2678 2679 if self.options.chg or self.options.with_chg:
2679 2680 osenvironb[b'CHGHG'] = os.path.join(self._bindir, self._hgcommand)
2680 2681 else:
2681 2682 osenvironb.pop(b'CHGHG', None) # drop flag for hghave
2682 2683 if self.options.chg:
2683 2684 self._hgcommand = b'chg'
2684 2685 elif self.options.with_chg:
2685 2686 chgbindir = os.path.dirname(os.path.realpath(self.options.with_chg))
2686 2687 self._hgcommand = os.path.basename(self.options.with_chg)
2687 2688
2688 2689 osenvironb[b"BINDIR"] = self._bindir
2689 2690 osenvironb[b"PYTHON"] = PYTHON
2690 2691
2691 2692 fileb = _bytespath(__file__)
2692 2693 runtestdir = os.path.abspath(os.path.dirname(fileb))
2693 2694 osenvironb[b'RUNTESTDIR'] = runtestdir
2694 2695 if PYTHON3:
2695 2696 sepb = _bytespath(os.pathsep)
2696 2697 else:
2697 2698 sepb = os.pathsep
2698 2699 path = [self._bindir, runtestdir] + osenvironb[b"PATH"].split(sepb)
2699 2700 if os.path.islink(__file__):
2700 2701 # test helper will likely be at the end of the symlink
2701 2702 realfile = os.path.realpath(fileb)
2702 2703 realdir = os.path.abspath(os.path.dirname(realfile))
2703 2704 path.insert(2, realdir)
2704 2705 if chgbindir != self._bindir:
2705 2706 path.insert(1, chgbindir)
2706 2707 if self._testdir != runtestdir:
2707 2708 path = [self._testdir] + path
2708 2709 if self._tmpbindir != self._bindir:
2709 2710 path = [self._tmpbindir] + path
2710 2711 osenvironb[b"PATH"] = sepb.join(path)
2711 2712
2712 2713 # Include TESTDIR in PYTHONPATH so that out-of-tree extensions
2713 2714 # can run .../tests/run-tests.py test-foo where test-foo
2714 2715 # adds an extension to HGRC. Also include run-test.py directory to
2715 2716 # import modules like heredoctest.
2716 2717 pypath = [self._pythondir, self._testdir, runtestdir]
2717 2718 # We have to augment PYTHONPATH, rather than simply replacing
2718 2719 # it, in case external libraries are only available via current
2719 2720 # PYTHONPATH. (In particular, the Subversion bindings on OS X
2720 2721 # are in /opt/subversion.)
2721 2722 oldpypath = osenvironb.get(IMPL_PATH)
2722 2723 if oldpypath:
2723 2724 pypath.append(oldpypath)
2724 2725 osenvironb[IMPL_PATH] = sepb.join(pypath)
2725 2726
2726 2727 if self.options.pure:
2727 2728 os.environ["HGTEST_RUN_TESTS_PURE"] = "--pure"
2728 2729 os.environ["HGMODULEPOLICY"] = "py"
2729 2730
2730 2731 if self.options.allow_slow_tests:
2731 2732 os.environ["HGTEST_SLOW"] = "slow"
2732 2733 elif 'HGTEST_SLOW' in os.environ:
2733 2734 del os.environ['HGTEST_SLOW']
2734 2735
2735 2736 self._coveragefile = os.path.join(self._testdir, b'.coverage')
2736 2737
2737 2738 if self.options.exceptions:
2738 2739 exceptionsdir = os.path.join(self._outputdir, b'exceptions')
2739 2740 try:
2740 2741 os.makedirs(exceptionsdir)
2741 2742 except OSError as e:
2742 2743 if e.errno != errno.EEXIST:
2743 2744 raise
2744 2745
2745 2746 # Remove all existing exception reports.
2746 2747 for f in os.listdir(exceptionsdir):
2747 2748 os.unlink(os.path.join(exceptionsdir, f))
2748 2749
2749 2750 osenvironb[b'HGEXCEPTIONSDIR'] = exceptionsdir
2750 2751 logexceptions = os.path.join(self._testdir, b'logexceptions.py')
2751 2752 self.options.extra_config_opt.append(
2752 2753 'extensions.logexceptions=%s' % logexceptions.decode('utf-8'))
2753 2754
2754 2755 vlog("# Using TESTDIR", self._testdir)
2755 2756 vlog("# Using RUNTESTDIR", osenvironb[b'RUNTESTDIR'])
2756 2757 vlog("# Using HGTMP", self._hgtmp)
2757 2758 vlog("# Using PATH", os.environ["PATH"])
2758 2759 vlog("# Using", IMPL_PATH, osenvironb[IMPL_PATH])
2759 2760 vlog("# Writing to directory", self._outputdir)
2760 2761
2761 2762 try:
2762 2763 return self._runtests(testdescs) or 0
2763 2764 finally:
2764 2765 time.sleep(.1)
2765 2766 self._cleanup()
2766 2767
2767 2768 def findtests(self, args):
2768 2769 """Finds possible test files from arguments.
2769 2770
2770 2771 If you wish to inject custom tests into the test harness, this would
2771 2772 be a good function to monkeypatch or override in a derived class.
2772 2773 """
2773 2774 if not args:
2774 2775 if self.options.changed:
2775 2776 proc = Popen4(b'hg st --rev "%s" -man0 .' %
2776 2777 _bytespath(self.options.changed), None, 0)
2777 2778 stdout, stderr = proc.communicate()
2778 2779 args = stdout.strip(b'\0').split(b'\0')
2779 2780 else:
2780 2781 args = os.listdir(b'.')
2781 2782
2782 2783 expanded_args = []
2783 2784 for arg in args:
2784 2785 if os.path.isdir(arg):
2785 2786 if not arg.endswith(b'/'):
2786 2787 arg += b'/'
2787 2788 expanded_args.extend([arg + a for a in os.listdir(arg)])
2788 2789 else:
2789 2790 expanded_args.append(arg)
2790 2791 args = expanded_args
2791 2792
2792 2793 testcasepattern = re.compile(
2793 2794 br'([\w-]+\.t|py)(?:#([a-zA-Z0-9_\-\.#]+))')
2794 2795 tests = []
2795 2796 for t in args:
2796 2797 case = []
2797 2798
2798 2799 if not (os.path.basename(t).startswith(b'test-')
2799 2800 and (t.endswith(b'.py') or t.endswith(b'.t'))):
2800 2801
2801 2802 m = testcasepattern.match(os.path.basename(t))
2802 2803 if m is not None:
2803 2804 t_basename, casestr = m.groups()
2804 2805 t = os.path.join(os.path.dirname(t), t_basename)
2805 2806 if casestr:
2806 2807 case = casestr.split(b'#')
2807 2808 else:
2808 2809 continue
2809 2810
2810 2811 if t.endswith(b'.t'):
2811 2812 # .t file may contain multiple test cases
2812 2813 casedimensions = parsettestcases(t)
2813 2814 if casedimensions:
2814 2815 cases = []
2815 2816 def addcases(case, casedimensions):
2816 2817 if not casedimensions:
2817 2818 cases.append(case)
2818 2819 else:
2819 2820 for c in casedimensions[0]:
2820 2821 addcases(case + [c], casedimensions[1:])
2821 2822 addcases([], casedimensions)
2822 2823 if case and case in cases:
2823 2824 cases = [case]
2824 2825 elif case:
2825 2826 # Ignore invalid cases
2826 2827 cases = []
2827 2828 else:
2828 2829 pass
2829 2830 tests += [{'path': t, 'case': c} for c in sorted(cases)]
2830 2831 else:
2831 2832 tests.append({'path': t})
2832 2833 else:
2833 2834 tests.append({'path': t})
2834 2835 return tests
2835 2836
2836 2837 def _runtests(self, testdescs):
2837 2838 def _reloadtest(test, i):
2838 2839 # convert a test back to its description dict
2839 2840 desc = {'path': test.path}
2840 2841 case = getattr(test, '_case', [])
2841 2842 if case:
2842 2843 desc['case'] = case
2843 2844 return self._gettest(desc, i)
2844 2845
2845 2846 try:
2846 2847 if self.options.restart:
2847 2848 orig = list(testdescs)
2848 2849 while testdescs:
2849 2850 desc = testdescs[0]
2850 2851 # desc['path'] is a relative path
2851 2852 if 'case' in desc:
2852 2853 casestr = b'#'.join(desc['case'])
2853 2854 errpath = b'%s#%s.err' % (desc['path'], casestr)
2854 2855 else:
2855 2856 errpath = b'%s.err' % desc['path']
2856 2857 errpath = os.path.join(self._outputdir, errpath)
2857 2858 if os.path.exists(errpath):
2858 2859 break
2859 2860 testdescs.pop(0)
2860 2861 if not testdescs:
2861 2862 print("running all tests")
2862 2863 testdescs = orig
2863 2864
2864 2865 tests = [self._gettest(d, i) for i, d in enumerate(testdescs)]
2865 2866 num_tests = len(tests) * self.options.runs_per_test
2866 2867
2867 2868 jobs = min(num_tests, self.options.jobs)
2868 2869
2869 2870 failed = False
2870 2871 kws = self.options.keywords
2871 2872 if kws is not None and PYTHON3:
2872 2873 kws = kws.encode('utf-8')
2873 2874
2874 2875 suite = TestSuite(self._testdir,
2875 2876 jobs=jobs,
2876 2877 whitelist=self.options.whitelisted,
2877 2878 blacklist=self.options.blacklist,
2878 2879 retest=self.options.retest,
2879 2880 keywords=kws,
2880 2881 loop=self.options.loop,
2881 2882 runs_per_test=self.options.runs_per_test,
2882 2883 showchannels=self.options.showchannels,
2883 2884 tests=tests, loadtest=_reloadtest)
2884 2885 verbosity = 1
2885 2886 if self.options.list_tests:
2886 2887 verbosity = 0
2887 2888 elif self.options.verbose:
2888 2889 verbosity = 2
2889 2890 runner = TextTestRunner(self, verbosity=verbosity)
2890 2891
2891 2892 if self.options.list_tests:
2892 2893 result = runner.listtests(suite)
2893 2894 else:
2894 2895 if self._installdir:
2895 2896 self._installhg()
2896 2897 self._checkhglib("Testing")
2897 2898 else:
2898 2899 self._usecorrectpython()
2899 2900 if self.options.chg:
2900 2901 assert self._installdir
2901 2902 self._installchg()
2902 2903
2903 2904 log('running %d tests using %d parallel processes' % (
2904 2905 num_tests, jobs))
2905 2906
2906 2907 result = runner.run(suite)
2907 2908
2908 2909 if result.failures:
2909 2910 failed = True
2910 2911
2911 2912 result.onEnd()
2912 2913
2913 2914 if self.options.anycoverage:
2914 2915 self._outputcoverage()
2915 2916 except KeyboardInterrupt:
2916 2917 failed = True
2917 2918 print("\ninterrupted!")
2918 2919
2919 2920 if failed:
2920 2921 return 1
2921 2922
2922 2923 def _getport(self, count):
2923 2924 port = self._ports.get(count) # do we have a cached entry?
2924 2925 if port is None:
2925 2926 portneeded = 3
2926 2927 # above 100 tries we just give up and let test reports failure
2927 2928 for tries in xrange(100):
2928 2929 allfree = True
2929 2930 port = self.options.port + self._portoffset
2930 2931 for idx in xrange(portneeded):
2931 2932 if not checkportisavailable(port + idx):
2932 2933 allfree = False
2933 2934 break
2934 2935 self._portoffset += portneeded
2935 2936 if allfree:
2936 2937 break
2937 2938 self._ports[count] = port
2938 2939 return port
2939 2940
2940 2941 def _gettest(self, testdesc, count):
2941 2942 """Obtain a Test by looking at its filename.
2942 2943
2943 2944 Returns a Test instance. The Test may not be runnable if it doesn't
2944 2945 map to a known type.
2945 2946 """
2946 2947 path = testdesc['path']
2947 2948 lctest = path.lower()
2948 2949 testcls = Test
2949 2950
2950 2951 for ext, cls in self.TESTTYPES:
2951 2952 if lctest.endswith(ext):
2952 2953 testcls = cls
2953 2954 break
2954 2955
2955 2956 refpath = os.path.join(getcwdb(), path)
2956 2957 tmpdir = os.path.join(self._hgtmp, b'child%d' % count)
2957 2958
2958 2959 # extra keyword parameters. 'case' is used by .t tests
2959 2960 kwds = dict((k, testdesc[k]) for k in ['case'] if k in testdesc)
2960 2961
2961 2962 t = testcls(refpath, self._outputdir, tmpdir,
2962 2963 keeptmpdir=self.options.keep_tmpdir,
2963 2964 debug=self.options.debug,
2964 2965 first=self.options.first,
2965 2966 timeout=self.options.timeout,
2966 2967 startport=self._getport(count),
2967 2968 extraconfigopts=self.options.extra_config_opt,
2968 2969 py3warnings=self.options.py3_warnings,
2969 2970 shell=self.options.shell,
2970 2971 hgcommand=self._hgcommand,
2971 2972 usechg=bool(self.options.with_chg or self.options.chg),
2972 2973 useipv6=useipv6, **kwds)
2973 2974 t.should_reload = True
2974 2975 return t
2975 2976
2976 2977 def _cleanup(self):
2977 2978 """Clean up state from this test invocation."""
2978 2979 if self.options.keep_tmpdir:
2979 2980 return
2980 2981
2981 2982 vlog("# Cleaning up HGTMP", self._hgtmp)
2982 2983 shutil.rmtree(self._hgtmp, True)
2983 2984 for f in self._createdfiles:
2984 2985 try:
2985 2986 os.remove(f)
2986 2987 except OSError:
2987 2988 pass
2988 2989
2989 2990 def _usecorrectpython(self):
2990 2991 """Configure the environment to use the appropriate Python in tests."""
2991 2992 # Tests must use the same interpreter as us or bad things will happen.
2992 2993 pyexename = sys.platform == 'win32' and b'python.exe' or b'python'
2993 2994
2994 2995 # os.symlink() is a thing with py3 on Windows, but it requires
2995 2996 # Administrator rights.
2996 2997 if getattr(os, 'symlink', None) and os.name != 'nt':
2997 2998 vlog("# Making python executable in test path a symlink to '%s'" %
2998 2999 sys.executable)
2999 3000 mypython = os.path.join(self._tmpbindir, pyexename)
3000 3001 try:
3001 3002 if os.readlink(mypython) == sys.executable:
3002 3003 return
3003 3004 os.unlink(mypython)
3004 3005 except OSError as err:
3005 3006 if err.errno != errno.ENOENT:
3006 3007 raise
3007 3008 if self._findprogram(pyexename) != sys.executable:
3008 3009 try:
3009 3010 os.symlink(sys.executable, mypython)
3010 3011 self._createdfiles.append(mypython)
3011 3012 except OSError as err:
3012 3013 # child processes may race, which is harmless
3013 3014 if err.errno != errno.EEXIST:
3014 3015 raise
3015 3016 else:
3016 3017 exedir, exename = os.path.split(sys.executable)
3017 3018 vlog("# Modifying search path to find %s as %s in '%s'" %
3018 3019 (exename, pyexename, exedir))
3019 3020 path = os.environ['PATH'].split(os.pathsep)
3020 3021 while exedir in path:
3021 3022 path.remove(exedir)
3022 3023 os.environ['PATH'] = os.pathsep.join([exedir] + path)
3023 3024 if not self._findprogram(pyexename):
3024 3025 print("WARNING: Cannot find %s in search path" % pyexename)
3025 3026
3026 3027 def _installhg(self):
3027 3028 """Install hg into the test environment.
3028 3029
3029 3030 This will also configure hg with the appropriate testing settings.
3030 3031 """
3031 3032 vlog("# Performing temporary installation of HG")
3032 3033 installerrs = os.path.join(self._hgtmp, b"install.err")
3033 3034 compiler = ''
3034 3035 if self.options.compiler:
3035 3036 compiler = '--compiler ' + self.options.compiler
3036 3037 if self.options.pure:
3037 3038 pure = b"--pure"
3038 3039 else:
3039 3040 pure = b""
3040 3041
3041 3042 # Run installer in hg root
3042 3043 script = os.path.realpath(sys.argv[0])
3043 3044 exe = sys.executable
3044 3045 if PYTHON3:
3045 3046 compiler = _bytespath(compiler)
3046 3047 script = _bytespath(script)
3047 3048 exe = _bytespath(exe)
3048 3049 hgroot = os.path.dirname(os.path.dirname(script))
3049 3050 self._hgroot = hgroot
3050 3051 os.chdir(hgroot)
3051 3052 nohome = b'--home=""'
3052 3053 if os.name == 'nt':
3053 3054 # The --home="" trick works only on OS where os.sep == '/'
3054 3055 # because of a distutils convert_path() fast-path. Avoid it at
3055 3056 # least on Windows for now, deal with .pydistutils.cfg bugs
3056 3057 # when they happen.
3057 3058 nohome = b''
3058 3059 cmd = (b'"%(exe)s" setup.py %(pure)s clean --all'
3059 3060 b' build %(compiler)s --build-base="%(base)s"'
3060 3061 b' install --force --prefix="%(prefix)s"'
3061 3062 b' --install-lib="%(libdir)s"'
3062 3063 b' --install-scripts="%(bindir)s" %(nohome)s >%(logfile)s 2>&1'
3063 3064 % {b'exe': exe, b'pure': pure,
3064 3065 b'compiler': compiler,
3065 3066 b'base': os.path.join(self._hgtmp, b"build"),
3066 3067 b'prefix': self._installdir, b'libdir': self._pythondir,
3067 3068 b'bindir': self._bindir,
3068 3069 b'nohome': nohome, b'logfile': installerrs})
3069 3070
3070 3071 # setuptools requires install directories to exist.
3071 3072 def makedirs(p):
3072 3073 try:
3073 3074 os.makedirs(p)
3074 3075 except OSError as e:
3075 3076 if e.errno != errno.EEXIST:
3076 3077 raise
3077 3078 makedirs(self._pythondir)
3078 3079 makedirs(self._bindir)
3079 3080
3080 3081 vlog("# Running", cmd)
3081 3082 if subprocess.call(_strpath(cmd), shell=True) == 0:
3082 3083 if not self.options.verbose:
3083 3084 try:
3084 3085 os.remove(installerrs)
3085 3086 except OSError as e:
3086 3087 if e.errno != errno.ENOENT:
3087 3088 raise
3088 3089 else:
3089 3090 with open(installerrs, 'rb') as f:
3090 3091 for line in f:
3091 3092 if PYTHON3:
3092 3093 sys.stdout.buffer.write(line)
3093 3094 else:
3094 3095 sys.stdout.write(line)
3095 3096 sys.exit(1)
3096 3097 os.chdir(self._testdir)
3097 3098
3098 3099 self._usecorrectpython()
3099 3100
3100 3101 if self.options.py3_warnings and not self.options.anycoverage:
3101 3102 vlog("# Updating hg command to enable Py3k Warnings switch")
3102 3103 with open(os.path.join(self._bindir, 'hg'), 'rb') as f:
3103 3104 lines = [line.rstrip() for line in f]
3104 3105 lines[0] += ' -3'
3105 3106 with open(os.path.join(self._bindir, 'hg'), 'wb') as f:
3106 3107 for line in lines:
3107 3108 f.write(line + '\n')
3108 3109
3109 3110 hgbat = os.path.join(self._bindir, b'hg.bat')
3110 3111 if os.path.isfile(hgbat):
3111 3112 # hg.bat expects to be put in bin/scripts while run-tests.py
3112 3113 # installation layout put it in bin/ directly. Fix it
3113 3114 with open(hgbat, 'rb') as f:
3114 3115 data = f.read()
3115 3116 if br'"%~dp0..\python" "%~dp0hg" %*' in data:
3116 3117 data = data.replace(br'"%~dp0..\python" "%~dp0hg" %*',
3117 3118 b'"%~dp0python" "%~dp0hg" %*')
3118 3119 with open(hgbat, 'wb') as f:
3119 3120 f.write(data)
3120 3121 else:
3121 3122 print('WARNING: cannot fix hg.bat reference to python.exe')
3122 3123
3123 3124 if self.options.anycoverage:
3124 3125 custom = os.path.join(self._testdir, 'sitecustomize.py')
3125 3126 target = os.path.join(self._pythondir, 'sitecustomize.py')
3126 3127 vlog('# Installing coverage trigger to %s' % target)
3127 3128 shutil.copyfile(custom, target)
3128 3129 rc = os.path.join(self._testdir, '.coveragerc')
3129 3130 vlog('# Installing coverage rc to %s' % rc)
3130 3131 os.environ['COVERAGE_PROCESS_START'] = rc
3131 3132 covdir = os.path.join(self._installdir, '..', 'coverage')
3132 3133 try:
3133 3134 os.mkdir(covdir)
3134 3135 except OSError as e:
3135 3136 if e.errno != errno.EEXIST:
3136 3137 raise
3137 3138
3138 3139 os.environ['COVERAGE_DIR'] = covdir
3139 3140
3140 3141 def _checkhglib(self, verb):
3141 3142 """Ensure that the 'mercurial' package imported by python is
3142 3143 the one we expect it to be. If not, print a warning to stderr."""
3143 3144 if ((self._bindir == self._pythondir) and
3144 3145 (self._bindir != self._tmpbindir)):
3145 3146 # The pythondir has been inferred from --with-hg flag.
3146 3147 # We cannot expect anything sensible here.
3147 3148 return
3148 3149 expecthg = os.path.join(self._pythondir, b'mercurial')
3149 3150 actualhg = self._gethgpath()
3150 3151 if os.path.abspath(actualhg) != os.path.abspath(expecthg):
3151 3152 sys.stderr.write('warning: %s with unexpected mercurial lib: %s\n'
3152 3153 ' (expected %s)\n'
3153 3154 % (verb, actualhg, expecthg))
3154 3155 def _gethgpath(self):
3155 3156 """Return the path to the mercurial package that is actually found by
3156 3157 the current Python interpreter."""
3157 3158 if self._hgpath is not None:
3158 3159 return self._hgpath
3159 3160
3160 3161 cmd = b'"%s" -c "import mercurial; print (mercurial.__path__[0])"'
3161 3162 cmd = cmd % PYTHON
3162 3163 if PYTHON3:
3163 3164 cmd = _strpath(cmd)
3164 3165
3165 3166 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
3166 3167 out, err = p.communicate()
3167 3168
3168 3169 self._hgpath = out.strip()
3169 3170
3170 3171 return self._hgpath
3171 3172
3172 3173 def _installchg(self):
3173 3174 """Install chg into the test environment"""
3174 3175 vlog('# Performing temporary installation of CHG')
3175 3176 assert os.path.dirname(self._bindir) == self._installdir
3176 3177 assert self._hgroot, 'must be called after _installhg()'
3177 3178 cmd = (b'"%(make)s" clean install PREFIX="%(prefix)s"'
3178 3179 % {b'make': 'make', # TODO: switch by option or environment?
3179 3180 b'prefix': self._installdir})
3180 3181 cwd = os.path.join(self._hgroot, b'contrib', b'chg')
3181 3182 vlog("# Running", cmd)
3182 3183 proc = subprocess.Popen(cmd, shell=True, cwd=cwd,
3183 3184 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
3184 3185 stderr=subprocess.STDOUT)
3185 3186 out, _err = proc.communicate()
3186 3187 if proc.returncode != 0:
3187 3188 if PYTHON3:
3188 3189 sys.stdout.buffer.write(out)
3189 3190 else:
3190 3191 sys.stdout.write(out)
3191 3192 sys.exit(1)
3192 3193
3193 3194 def _outputcoverage(self):
3194 3195 """Produce code coverage output."""
3195 3196 import coverage
3196 3197 coverage = coverage.coverage
3197 3198
3198 3199 vlog('# Producing coverage report')
3199 3200 # chdir is the easiest way to get short, relative paths in the
3200 3201 # output.
3201 3202 os.chdir(self._hgroot)
3202 3203 covdir = os.path.join(self._installdir, '..', 'coverage')
3203 3204 cov = coverage(data_file=os.path.join(covdir, 'cov'))
3204 3205
3205 3206 # Map install directory paths back to source directory.
3206 3207 cov.config.paths['srcdir'] = ['.', self._pythondir]
3207 3208
3208 3209 cov.combine()
3209 3210
3210 3211 omit = [os.path.join(x, '*') for x in [self._bindir, self._testdir]]
3211 3212 cov.report(ignore_errors=True, omit=omit)
3212 3213
3213 3214 if self.options.htmlcov:
3214 3215 htmldir = os.path.join(self._outputdir, 'htmlcov')
3215 3216 cov.html_report(directory=htmldir, omit=omit)
3216 3217 if self.options.annotate:
3217 3218 adir = os.path.join(self._outputdir, 'annotated')
3218 3219 if not os.path.isdir(adir):
3219 3220 os.mkdir(adir)
3220 3221 cov.annotate(directory=adir, omit=omit)
3221 3222
3222 3223 def _findprogram(self, program):
3223 3224 """Search PATH for a executable program"""
3224 3225 dpb = _bytespath(os.defpath)
3225 3226 sepb = _bytespath(os.pathsep)
3226 3227 for p in osenvironb.get(b'PATH', dpb).split(sepb):
3227 3228 name = os.path.join(p, program)
3228 3229 if os.name == 'nt' or os.access(name, os.X_OK):
3229 3230 return name
3230 3231 return None
3231 3232
3232 3233 def _checktools(self):
3233 3234 """Ensure tools required to run tests are present."""
3234 3235 for p in self.REQUIREDTOOLS:
3235 3236 if os.name == 'nt' and not p.endswith(b'.exe'):
3236 3237 p += b'.exe'
3237 3238 found = self._findprogram(p)
3238 3239 if found:
3239 3240 vlog("# Found prerequisite", p, "at", found)
3240 3241 else:
3241 3242 print("WARNING: Did not find prerequisite tool: %s " %
3242 3243 p.decode("utf-8"))
3243 3244
3244 3245 def aggregateexceptions(path):
3245 3246 exceptioncounts = collections.Counter()
3246 3247 testsbyfailure = collections.defaultdict(set)
3247 3248 failuresbytest = collections.defaultdict(set)
3248 3249
3249 3250 for f in os.listdir(path):
3250 3251 with open(os.path.join(path, f), 'rb') as fh:
3251 3252 data = fh.read().split(b'\0')
3252 3253 if len(data) != 5:
3253 3254 continue
3254 3255
3255 3256 exc, mainframe, hgframe, hgline, testname = data
3256 3257 exc = exc.decode('utf-8')
3257 3258 mainframe = mainframe.decode('utf-8')
3258 3259 hgframe = hgframe.decode('utf-8')
3259 3260 hgline = hgline.decode('utf-8')
3260 3261 testname = testname.decode('utf-8')
3261 3262
3262 3263 key = (hgframe, hgline, exc)
3263 3264 exceptioncounts[key] += 1
3264 3265 testsbyfailure[key].add(testname)
3265 3266 failuresbytest[testname].add(key)
3266 3267
3267 3268 # Find test having fewest failures for each failure.
3268 3269 leastfailing = {}
3269 3270 for key, tests in testsbyfailure.items():
3270 3271 fewesttest = None
3271 3272 fewestcount = 99999999
3272 3273 for test in sorted(tests):
3273 3274 if len(failuresbytest[test]) < fewestcount:
3274 3275 fewesttest = test
3275 3276 fewestcount = len(failuresbytest[test])
3276 3277
3277 3278 leastfailing[key] = (fewestcount, fewesttest)
3278 3279
3279 3280 # Create a combined counter so we can sort by total occurrences and
3280 3281 # impacted tests.
3281 3282 combined = {}
3282 3283 for key in exceptioncounts:
3283 3284 combined[key] = (exceptioncounts[key],
3284 3285 len(testsbyfailure[key]),
3285 3286 leastfailing[key][0],
3286 3287 leastfailing[key][1])
3287 3288
3288 3289 return {
3289 3290 'exceptioncounts': exceptioncounts,
3290 3291 'total': sum(exceptioncounts.values()),
3291 3292 'combined': combined,
3292 3293 'leastfailing': leastfailing,
3293 3294 'byfailure': testsbyfailure,
3294 3295 'bytest': failuresbytest,
3295 3296 }
3296 3297
3297 3298 if __name__ == '__main__':
3298 3299 runner = TestRunner()
3299 3300
3300 3301 try:
3301 3302 import msvcrt
3302 3303 msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
3303 3304 msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3304 3305 msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)
3305 3306 except ImportError:
3306 3307 pass
3307 3308
3308 3309 sys.exit(runner.run(sys.argv[1:]))
General Comments 0
You need to be logged in to leave comments. Login now