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