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