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