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