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