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