testlib.py 69.3 KB
Newer Older
1
#
2 3 4
# (c) Simon Marlow 2002
#

5 6 7
# This allows us to use the "with X:" syntax with python 2.5:
from __future__ import with_statement

8 9
import sys
import os
10
import errno
11 12 13 14
import string
import re
import traceback
import copy
15
import glob
16
import types
17
import math
18

19 20 21 22 23 24 25
have_subprocess = False
try:
    import subprocess
    have_subprocess = True
except:
    print "Warning: subprocess not found, will fall back to spawnv"

26
from string import join
27
from testglobals import *
28 29
from testutil import *

30 31 32
if config.use_threads:
    import threading
    import thread
33 34 35 36 37 38 39 40 41 42 43 44 45

# Options valid for all the tests in the current "directory".  After
# each test, we reset the options to these.  To change the options for
# multiple tests, the function setTestOpts() below can be used to alter
# these options.
global thisdir_testopts
thisdir_testopts = TestOptions()

def getThisDirTestOpts():
    return thisdir_testopts

# Options valid for the current test only (these get reset to
# testdir_testopts after each test).
46

ei@vuokko.info's avatar
ei@vuokko.info committed
47
global testopts_local
48 49 50 51 52 53
if config.use_threads:
    testopts_local = threading.local()
else:
    class TestOpts_Local:
        pass
    testopts_local = TestOpts_Local()
54 55

def getTestOpts():
ei@vuokko.info's avatar
ei@vuokko.info committed
56
    return testopts_local.x
57

ei@vuokko.info's avatar
ei@vuokko.info committed
58 59 60
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86

# This can be called at the top of a file of tests, to set default test options
# for the following tests.
def setTestOpts( f ):
    f( thisdir_testopts );

# -----------------------------------------------------------------------------
# Canned setup functions for common cases.  eg. for a test you might say
#
#      test('test001', normal, compile, [''])
#
# to run it without any options, but change it to
#
#      test('test001', expect_fail, compile, [''])
#
# to expect failure for this test.

def normal( opts ):
    return;

def skip( opts ):
    opts.skip = 1

def expect_fail( opts ):
    opts.expect = 'fail';

87 88 89
def reqlib( lib ):
    return lambda opts, l=lib: _reqlib (opts, l )

90 91 92 93
# Cache the results of looking to see if we have a library or not.
# This makes quite a difference, especially on Windows.
have_lib = {}

94
def _reqlib( opts, lib ):
95 96
    if have_lib.has_key(lib):
        got_it = have_lib[lib]
97
    else:
98 99 100
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
101
            p = subprocess.Popen([config.ghc_pkg, '--no-user-package-db', 'describe', lib],
102 103 104 105 106 107 108 109 110 111 112 113 114
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.PIPE)
            # read from stdout and stderr to avoid blocking due to
            # buffers filling
            p.communicate()
            r = p.wait()
        else:
            r = os.system(config.ghc_pkg + ' describe ' + lib
                                         + ' > /dev/null 2> /dev/null')
        got_it = r == 0
        have_lib[lib] = got_it

    if not got_it:
115
        opts.expect = 'missing-lib'
116

117 118 119 120
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Simon Marlow's avatar
Simon Marlow committed
121 122 123 124
def req_shared_libs( opts ):
    if not config.have_shared_libs:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
125 126 127 128
def req_interp( opts ):
    if not config.have_interp:
        opts.expect = 'fail'

Simon Marlow's avatar
Simon Marlow committed
129 130 131 132
def req_smp( opts ):
    if not config.have_smp:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
133 134 135 136 137 138
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

def _expect_broken( opts, bug ):
    opts.expect = 'fail';

139 140 141
def ignore_output( opts ):
    opts.ignore_output = 1

142 143 144
def no_stdin( opts ):
    opts.no_stdin = 1

pcapriotti's avatar
pcapriotti committed
145 146 147
def combined_output( opts ):
    opts.combined_output = True

148 149 150 151 152 153 154 155
# -----

def expect_fail_for( ways ):
    return lambda opts, w=ways: _expect_fail_for( opts, w )

def _expect_fail_for( opts, ways ):
    opts.expect_fail_for = ways

Ian Lynagh's avatar
Ian Lynagh committed
156 157 158 159
def expect_broken_for( bug, ways ):
    return lambda opts, b=bug, w=ways: _expect_broken_for( opts, b, w )

def _expect_broken_for( opts, bug, ways ):
Ian Lynagh's avatar
Ian Lynagh committed
160
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
161

162 163 164 165 166 167 168 169 170 171
# -----

def omit_ways( ways ):
    return lambda opts, w=ways: _omit_ways( opts, w )

def _omit_ways( opts, ways ):
    opts.omit_ways = ways

# -----

172 173 174 175 176 177 178 179
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

def _only_ways( opts, ways ):
    opts.only_ways = ways

# -----

180 181 182 183 184 185 186 187
def extra_ways( ways ):
    return lambda opts, w=ways: _extra_ways( opts, w )

def _extra_ways( opts, ways ):
    opts.extra_ways = ways

# -----

ross's avatar
ross committed
188 189 190 191 192
def omit_compiler_types( compiler_types ):
   return lambda opts, c=compiler_types: _omit_compiler_types(opts, c)

def _omit_compiler_types( opts, compiler_types ):
    if config.compiler_type in compiler_types:
dterei's avatar
dterei committed
193
        opts.skip = 1
ross's avatar
ross committed
194 195 196 197 198 199 200 201

# -----

def only_compiler_types( compiler_types ):
   return lambda opts, c=compiler_types: _only_compiler_types(opts, c)

def _only_compiler_types( opts, compiler_types ):
    if config.compiler_type not in compiler_types:
dterei's avatar
dterei committed
202
        opts.skip = 1
ross's avatar
ross committed
203 204 205

# -----

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
def set_stdin( file ):
   return lambda opts, f=file: _set_stdin(opts, f);

def _set_stdin( opts, f ):
   opts.stdin = f

# -----

def exit_code( val ):
    return lambda opts, v=val: _exit_code(opts, v);

def _exit_code( opts, v ):
    opts.exit_code = v

# -----

222 223 224 225 226 227 228 229
def timeout_multiplier( val ):
    return lambda opts, v=val: _timeout_multiplier(opts, v)

def _timeout_multiplier( opts, v ):
    opts.timeout_multiplier = v

# -----

230 231 232 233 234 235
def extra_run_opts( val ):
    return lambda opts, v=val: _extra_run_opts(opts, v);

def _extra_run_opts( opts, v ):
    opts.extra_run_opts = v

236 237
# -----

Simon Marlow's avatar
Simon Marlow committed
238 239 240 241 242 243 244 245
def extra_hc_opts( val ):
    return lambda opts, v=val: _extra_hc_opts(opts, v);

def _extra_hc_opts( opts, v ):
    opts.extra_hc_opts = v

# -----

246 247 248 249 250 251
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

def _extra_clean( opts, v ):
    opts.clean_files = v

252 253
# -----

254 255
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
256

257
def _stats_num_field( opts, f, x, y ):
258 259 260
    # copy the dictionary, as the config gets shared between all tests
    opts.stats_num_fields = opts.stats_num_fields.copy()
    opts.stats_num_fields[f] = (x, y)
261

Ian Lynagh's avatar
Ian Lynagh committed
262 263 264 265
def compiler_stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _compiler_stats_num_field(opts, f, x, y);

def _compiler_stats_num_field( opts, f, x, y ):
266 267 268
    # copy the dictionary, as the config gets shared between all tests
    opts.compiler_stats_num_fields = opts.compiler_stats_num_fields.copy()
    opts.compiler_stats_num_fields[f] = (x, y)
Ian Lynagh's avatar
Ian Lynagh committed
269

270 271
# -----

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
def stats_range_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_range_field(opts, f, x, y);

def _stats_range_field( opts, f, x, y ):
    # copy the dictionary, as the config gets shared between all tests
    opts.stats_range_fields = opts.stats_range_fields.copy()
    opts.stats_range_fields[f] = (x, y)

def compiler_stats_range_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _compiler_stats_range_field(opts, f, x, y);

def _compiler_stats_range_field( opts, f, x, y ):
    # copy the dictionary, as the config gets shared between all tests
    opts.compiler_stats_range_fields = opts.compiler_stats_range_fields.copy()
    opts.compiler_stats_range_fields[f] = (x, y)

# -----

290
def skip_if_no_ghci(opts):
dterei's avatar
dterei committed
291 292
    if not ('ghci' in config.run_ways):
        opts.skip = 1
293

294 295 296
# ----

def skip_if_fast(opts):
dterei's avatar
dterei committed
297 298
    if config.fast:
        opts.skip = 1
299

Simon Marlow's avatar
Simon Marlow committed
300 301
# -----

302
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
303
    if config.platform == plat:
304
        return f
305 306 307
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
308 309 310 311 312 313
def if_not_platform( plat, f ):
    if config.platform != plat:
        return f
    else:
        return normal

314 315 316
def if_os( os, f ):
    if config.os == os:
        return f
317 318 319
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
320 321 322 323 324 325
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

326 327 328 329 330 331
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

332 333 334 335 336 337
def unless_arch( arch, f ):
    if config.arch == arch:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
338
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
339
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
340 341 342 343
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
344 345 346 347 348 349 350 351 352 353 354 355
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

def if_cygwin( f ):
    if config.cygwin:
        return f
    else:
        return normal

356 357
# ---

358 359 360 361 362 363 364 365 366 367 368 369
def if_in_tree_compiler( f ):
    if config.in_tree_compiler:
        return f
    else:
        return normal

def unless_in_tree_compiler( f ):
    if config.in_tree_compiler:
        return normal
    else:
        return f

370 371 372 373 374
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
375 376 377 378 379 380

def if_compiler_profiled( f ):
    if config.compiler_profiled:
        return f
    else:
        return normal
381

382 383 384 385 386 387
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
388
def if_compiler_lt( compiler, version, f ):
389
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
390 391 392 393
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
394

Ian Lynagh's avatar
Ian Lynagh committed
395
def if_compiler_le( compiler, version, f ):
396 397
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
398 399 400
        return f
    else:
        return normal
401

Ian Lynagh's avatar
Ian Lynagh committed
402
def if_compiler_gt( compiler, version, f ):
403
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
404 405 406 407
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
408

Ian Lynagh's avatar
Ian Lynagh committed
409
def if_compiler_ge( compiler, version, f ):
410
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
411 412 413 414
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
415

Ian Lynagh's avatar
Ian Lynagh committed
416 417
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
418

Ian Lynagh's avatar
Ian Lynagh committed
419 420
def _namebase( opts, nb ):
    opts.with_namebase = nb
421

422 423
# ---

424
def if_tag( tag, f ):
425
    if tag in config.compiler_tags:
426 427 428
        return f
    else:
        return normal
429

430
def unless_tag( tag, f ):
431
    if not (tag in config.compiler_tags):
432 433 434
        return f
    else:
        return normal
435

ei@vuokko.info's avatar
ei@vuokko.info committed
436
# ---
437
def alone(opts):
438
    opts.alone = True
ei@vuokko.info's avatar
ei@vuokko.info committed
439

Ian Lynagh's avatar
Ian Lynagh committed
440 441 442 443
# ---
def literate( opts ):
    opts.literate = 1;

444 445 446
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
447 448 449
def objc_src( opts ):
    opts.objc_src = 1;

450 451 452
def objcpp_src( opts ):
    opts.objcpp_src = 1;

453 454
# ----

455 456 457 458 459 460 461 462
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

def _pre_cmd( opts, cmd ):
    opts.pre_cmd = cmd

# ----

463 464 465 466 467 468 469 470
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

def _clean_cmd( opts, cmd ):
    opts.clean_cmd = cmd

# ----

471 472 473 474
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
475 476 477 478 479 480 481 482 483
    opts.cmd_wrapper = lambda cmd, p=prefix: p + ' ' + cmd;

# ----

def cmd_wrapper( fun ):
    return lambda opts, f=fun: _cmd_wrapper(opts, fun)

def _cmd_wrapper( opts, fun ):
    opts.cmd_wrapper = fun
484

485 486
# ----

Ian Lynagh's avatar
Ian Lynagh committed
487 488 489 490 491 492 493 494
def compile_cmd_prefix( prefix ):
    return lambda opts, p=prefix: _compile_cmd_prefix(opts, prefix)

def _compile_cmd_prefix( opts, prefix ):
    opts.compile_cmd_prefix = prefix

# ----

495 496 497
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

498 499 500
def normalise_exe( opts ):
    opts.extra_normaliser = normalise_exe_

501 502 503 504 505 506
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

def _normalise_fun( opts, f ):
    opts.extra_normaliser = f

507 508 509 510 511 512 513 514 515
def normalise_errmsg_fun( fun ):
    return lambda opts, f=fun: _normalise_errmsg_fun(opts, f)

def _normalise_errmsg_fun( opts, f ):
    opts.extra_errmsg_normaliser = f

def two_normalisers(f, g):
    return lambda x, f=f, g=g: f(g(x))

516 517 518
# ----
# Function for composing two opt-fns together

519 520 521
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

522 523 524
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

525
def _compose( opts, f, g ):
526 527 528 529 530 531 532
    f(opts)
    g(opts)

# -----------------------------------------------------------------------------
# The current directory of tests

def newTestDir( dir ):
533
    global thisdir_testopts
534 535
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
536
    thisdir_testopts.testdir = dir
537
    thisdir_testopts.compiler_always_flags = config.compiler_always_flags
538 539 540 541

# -----------------------------------------------------------------------------
# Actually doing tests

542
allTests = []
543
allTestNames = set([])
544 545

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
546
    n = 1
547 548 549 550

    if type(setup) is types.ListType:
       setup = composes(setup)

ei@vuokko.info's avatar
ei@vuokko.info committed
551
    setup(opts)
552

553
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
554
        n = config.threads
555

ei@vuokko.info's avatar
ei@vuokko.info committed
556 557
    ok = 0

558
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
559
        t.thread_pool.acquire()
560 561 562 563 564 565 566 567 568 569 570 571
        try:
            while config.threads<(t.running_threads+n):
                t.thread_pool.wait()
            t.running_threads = t.running_threads+n
            ok=1
            t.thread_pool.release()
            thread.start_new_thread(test_common_thread, (n, name, opts, func, args))
        except:
            if not ok:
                t.thread_pool.release()
    else:
        test_common_work (name, opts, func, args)
572

573
# name  :: String
574
# setup :: TestOpts -> IO ()
575 576
def test (name, setup, func, args):
    global allTests
577 578 579
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
580 581
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
582
    allTestNames.add(name)
583

584 585 586 587 588 589 590 591 592 593 594
if config.use_threads:
    def test_common_thread(n, name, opts, func, args):
        t.lock.acquire()
        try:
            test_common_work(name,opts,func,args)
        finally:
            t.lock.release()
            t.thread_pool.acquire()
            t.running_threads = t.running_threads - n
            t.thread_pool.notify()
            t.thread_pool.release()
595

596 597 598 599 600 601 602 603 604 605
def get_package_cache_timestamp():
    if config.package_conf_cache_file == '':
        return 0.0
    else:
        try:
            return os.stat(config.package_conf_cache_file).st_mtime
        except:
            return 0.0


ei@vuokko.info's avatar
ei@vuokko.info committed
606
def test_common_work (name, opts, func, args):
607 608 609 610 611 612 613 614 615
    try:
        t.total_tests = t.total_tests+1
        setLocalTestOpts(opts)

        package_conf_cache_file_start_timestamp = get_package_cache_timestamp()

        # All the ways we might run this test
        if func == compile or func == multimod_compile:
            all_ways = config.compile_ways
616
        elif func == compile_and_run or func == multimod_compile_and_run:
617 618 619 620 621 622
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
623
        else:
624 625 626 627 628 629 630 631 632 633 634
            all_ways = ['normal']

        # A test itself can request extra ways by setting opts.extra_ways
        all_ways = all_ways + filter(lambda way: way not in all_ways,
                                     opts.extra_ways)

        t.total_test_cases = t.total_test_cases + len(all_ways)

        ok_way = lambda way: \
            not getTestOpts().skip \
            and (config.only == [] or name in config.only) \
635
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
            and (config.cmdline_ways == [] or way in config.cmdline_ways) \
            and way not in getTestOpts().omit_ways

        # Which ways we are asked to skip
        do_ways = filter (ok_way,all_ways)

        # In fast mode, we skip all but one way
        if config.fast and len(do_ways) > 0:
            do_ways = [do_ways[0]]

        if not config.clean_only:
            # Run the required tests...
            for way in do_ways:
                do_test (name, way, func, args)

            for way in all_ways:
                if way not in do_ways:
                    skiptest (name,way)

        if getTestOpts().cleanup != '' and (config.clean_only or do_ways != []):
            clean(map (lambda suff: name + suff,
                      ['', '.exe', '.exe.manifest', '.genscript',
                       '.stderr.normalised',        '.stdout.normalised',
                       '.run.stderr',               '.run.stdout',
                       '.run.stderr.normalised',    '.run.stdout.normalised',
                       '.comp.stderr',              '.comp.stdout',
                       '.comp.stderr.normalised',   '.comp.stdout.normalised',
                       '.interp.stderr',            '.interp.stdout',
                       '.interp.stderr.normalised', '.interp.stdout.normalised',
                       '.stats', '.comp.stats',
                       '.hi', '.o', '.prof', '.exe.prof', '.hc',
                       '_stub.h', '_stub.c', '_stub.o',
                       '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))

670
            if func == multi_compile or func == multi_compile_fail:
671 672 673 674 675
                    extra_mods = args[1]
                    clean(map (lambda (f,x): replace_suffix(f, 'o'), extra_mods))
                    clean(map (lambda (f,x): replace_suffix(f, 'hi'), extra_mods))

            clean(getTestOpts().clean_files)
Ian Lynagh's avatar
Ian Lynagh committed
676

677 678 679 680 681 682 683 684
            try:
                cleanCmd = getTestOpts().clean_cmd
                if cleanCmd != None:
                    result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + cleanCmd)
                    if result != 0:
                        framework_fail(name, 'cleaning', 'clean-command failed: ' + str(result))
            except e:
                framework_fail(name, 'cleaning', 'clean-command exception')
685

686
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
687

688 689
        if package_conf_cache_file_start_timestamp != package_conf_cache_file_end_timestamp:
            framework_fail(name, 'whole-test', 'Package cache timestamps do not match: ' + str(package_conf_cache_file_start_timestamp) + ' ' + str(package_conf_cache_file_end_timestamp))
690

691 692 693 694 695 696 697 698 699 700 701 702
        try:
            for f in files_written[name]:
                if os.path.exists(f):
                    try:
                        if not f in files_written_not_removed[name]:
                            files_written_not_removed[name].append(f)
                    except:
                        files_written_not_removed[name] = [f]
        except:
            pass
    except Exception, e:
        framework_fail(name, 'runTest', 'Unhandled exception: ' + str(e))
Ian Lynagh's avatar
Ian Lynagh committed
703

704 705 706 707
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
708

709
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
710 711 712 713
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
714
            try:
Ian Lynagh's avatar
Ian Lynagh committed
715 716 717 718 719 720 721 722 723 724 725
                # ... and empty directories
                os.rmdir(name)
            except OSError, e2:
                # We don't want to fail here, but we do want to know
                # what went wrong, so print out the exceptions.
                # ENOENT isn't a problem, though, as we clean files
                # that don't necessarily exist.
                if e1.errno != errno.ENOENT:
                    print e1
                if e2.errno != errno.ENOENT:
                    print e2
726

727
def do_test(name, way, func, args):
728 729 730
    full_name = name + '(' + way + ')'

    try:
731 732 733 734
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
735

736 737
        if config.use_threads:
            t.lock.release()
738 739 740 741

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
742
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
743 744 745 746 747
                if result != 0:
                    framework_fail(name, way, 'pre-command failed: ' + str(result))
        except e:
            framework_fail(name, way, 'pre-command exception')

ei@vuokko.info's avatar
ei@vuokko.info committed
748 749 750
        try:
            result = apply(func, [name,way] + args)
        finally:
751 752
            if config.use_threads:
                t.lock.acquire()
753

754 755 756
        if getTestOpts().expect != 'pass' and \
                getTestOpts().expect != 'fail' and \
                getTestOpts().expect != 'missing-lib':
757
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
758

759 760 761 762 763 764
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
765 766
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
767
                t.n_expected_passes = t.n_expected_passes + 1
768 769 770 771
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
772 773 774
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
775
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
776
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
777 778
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
779 780
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
781 782
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
783
            else:
784 785 786 787 788 789
                if getTestOpts().expect == 'missing-lib':
                    t.n_missing_libs = t.n_missing_libs + 1
                    if name in t.missing_libs:
                        t.missing_libs[name].append(way)
                    else:
                        t.missing_libs[name] = [way]
790
                else:
791 792 793 794 795
                    t.n_expected_failures = t.n_expected_failures + 1
                    if name in t.expected_failures:
                        t.expected_failures[name].append(way)
                    else:
                        t.expected_failures[name] = [way]
796 797
        else:
            framework_fail(name, way, 'bad result ' + passFail)
798
    except:
799
        framework_fail(name, way, 'do_test exception')
800 801
        traceback.print_exc()

802
def addPassingTestInfo (testInfos, directory, name, way):
803 804 805 806 807 808 809 810 811 812
    directory = re.sub('^\\.[/\\\\]', '', directory)

    if not directory in testInfos:
        testInfos[directory] = {}

    if not name in testInfos[directory]:
        testInfos[directory][name] = []

    testInfos[directory][name].append(way)

813 814 815 816 817 818 819 820 821 822 823 824 825 826
def addFailingTestInfo (testInfos, directory, name, reason, way):
    directory = re.sub('^\\.[/\\\\]', '', directory)

    if not directory in testInfos:
        testInfos[directory] = {}

    if not name in testInfos[directory]:
        testInfos[directory][name] = {}

    if not reason in testInfos[directory][name]:
        testInfos[directory][name][reason] = []

    testInfos[directory][name][reason].append(way)

827
def skiptest (name, way):
828 829
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
830 831 832 833
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
834

835 836 837
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
838
    t.n_framework_failures = t.n_framework_failures + 1
839 840 841 842
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
843

844 845 846 847 848 849 850 851 852 853 854 855 856 857
def badResult(result):
    try:
        if result['passFail'] == 'pass':
            return False
        return True
    except:
        return True

def passed():
    return {'passFail': 'pass'}

def failBecause(reason):
    return {'passFail': 'fail', 'reason': reason}

858 859 860 861
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
862 863 864 865 866 867
#
# The expected exit code can be changed via exit_code() as normal, and
# the expected stdout/stderr are stored in <testname>.stdout and
# <testname>.stderr.  The output of the command can be ignored
# altogether by using run_command_ignore_output instead of
# run_command.
868

869
def run_command( name, way, cmd ):
870
    return simple_run( name, '', cmd, '' )
871

872 873 874 875
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
876
    # filter out -fforce-recomp from compiler_always_flags, because we're
877
    # actually testing the recompilation behaviour in the GHCi tests.
878
    flags = filter(lambda f: f != '-fforce-recomp', getTestOpts().compiler_always_flags)
879
    flags.append(getTestOpts().extra_hc_opts)
880 881 882 883 884 885

    # We pass HC and HC_OPTS as environment variables, so that the
    # script can invoke the correct compiler by using ':! $HC $HC_OPTS'
    cmd = "HC='" + config.compiler + "' " + \
          "HC_OPTS='" + join(flags,' ') + "' " + \
          "'" + config.compiler + "'" + \
886
          ' --interactive -v0 -ignore-dot-ghci ' + \
887 888
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
889
    getTestOpts().stdin = script
890
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
891

892 893 894 895
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
896
    return do_compile( name, way, 0, '', [], extra_hc_opts )
897 898

def compile_fail( name, way, extra_hc_opts ):
899
    return do_compile( name, way, 1, '', [], extra_hc_opts )
900 901

def multimod_compile( name, way, top_mod, extra_hc_opts ):
902
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
903

904
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
905 906 907 908 909 910 911 912 913
    return do_compile( name, way, 1, top_mod, [], extra_hc_opts )

def multi_compile( name, way, top_mod, extra_mods, extra_hc_opts ):
    return do_compile( name, way, 0, top_mod, extra_mods, extra_hc_opts)

def multi_compile_fail( name, way, top_mod, extra_mods, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_mods, extra_hc_opts)

def do_compile( name, way, should_fail, top_mod, extra_mods, extra_hc_opts ):
914 915
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
916 917 918 919 920 921

    result = extras_build( way, extra_mods, extra_hc_opts )
    if badResult(result):
       return result
    extra_hc_opts = result['hc_opts']

922 923 924
    force = 0
    if extra_mods:
       force = 1
925 926
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

927
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
928
        return result
929 930 931 932 933

    # the actual stderr should always match the expected, regardless
    # of whether we expected the compilation to fail or not (successful
    # compilations may generate warnings).

Ian Lynagh's avatar
Ian Lynagh committed
934
    if getTestOpts().with_namebase == None:
935 936
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
937
        namebase = getTestOpts().with_namebase
938 939

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
940 941
    actual_stderr_file = qualify(name, 'comp.stderr')

942 943
    if not compare_outputs('stderr', \
                           two_normalisers(two_normalisers(getTestOpts().extra_errmsg_normaliser, normalise_errmsg), normalise_whitespace), \
944
                           expected_stderr_file, actual_stderr_file):
945
        return failBecause('stderr mismatch')
946 947

    # no problems found, this test passed
948
    return passed()
949

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
def compile_cmp_asm( name, way, extra_hc_opts ):
    print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
    result = simple_build( name + '.cmm', way, '-keep-s-files -O ' + extra_hc_opts, 0, '', 0, 0, 0)

    if badResult(result):
        return result

    # the actual stderr should always match the expected, regardless
    # of whether we expected the compilation to fail or not (successful
    # compilations may generate warnings).

    if getTestOpts().with_namebase == None:
        namebase = name
    else:
        namebase = getTestOpts().with_namebase

    (platform_specific, expected_asm_file) = platform_wordsize_qualify(namebase, 'asm')
    actual_asm_file = qualify(name, 's')

    if not compare_outputs('asm', two_normalisers(normalise_errmsg, normalise_asm), \
                           expected_asm_file, actual_asm_file):
        return failBecause('asm mismatch')

    # no problems found, this test passed
    return passed()

977 978 979
# -----------------------------------------------------------------------------
# Compile-and-run tests

980
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
981 982 983
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

984 985 986 987
    result = extras_build( way, extra_mods, extra_hc_opts )
    if badResult(result):
       return result
    extra_hc_opts = result['hc_opts']
dterei's avatar
dterei committed
988

989
    if way == 'ghci': # interpreted...
990
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
991
    elif way == 'extcore' or way == 'optextcore' :
992
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
993
    else: # compiled...
dterei's avatar
dterei committed
994 995 996 997
        force = 0
        if extra_mods:
           force = 1

998
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
999
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
1000
            return result
1001

1002 1003
        cmd = './' + name;

1004
        # we don't check the compiler's stderr for a compile-and-run test
1005 1006
        return simple_run( name, way, cmd, getTestOpts().extra_run_opts )

1007
def compile_and_run( name, way, extra_hc_opts ):
1008
    return compile_and_run__( name, way, '', [], extra_hc_opts)
1009 1010

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
1011
    return compile_and_run__( name, way, top_mod, [], extra_hc_opts)
dterei's avatar
dterei committed
1012

1013 1014
def multi_compile_and_run( name, way, top_mod, extra_mods, extra_hc_opts ):
    return compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts)
1015

1016 1017 1018 1019 1020
def stats( name, way, stats_file ):
    opts = getTestOpts()
    return checkStats(stats_file, opts.stats_range_fields
                                , opts.stats_num_fields)

Ian Lynagh's avatar
Ian Lynagh committed
1021 1022 1023
# -----------------------------------------------------------------------------
# Check -t stats info

1024
def checkStats(stats_file, range_fields, num_fields):
1025
    result = passed()
Simon Marlow's avatar
Simon Marlow committed
1026
    if len(num_fields) + len(range_fields) > 0:
Ian Lynagh's avatar
Ian Lynagh committed
1027 1028 1029 1030
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
        for (field, (expected, dev)) in range_fields.items():
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
                result = failBecause('no such stats field')
            val = int(m.group(1))

            min = expected * ((100 - float(dev))/100);
            max = expected * ((100 + float(dev))/100);

            if val < min:
                print field, val, 'is more than ' + repr(dev) + '%'
                print 'less than the exepected value', expected
                print 'If this is because you have improved GHC, please'
                print 'update the test so that GHC doesn\'t regress again'
                result = failBecause('stat too good')
            if val > max:
                print field, val, 'is more than ' + repr(dev) + '% greater than the expected value,', expected, max
                result = failBecause('stat not good enough')

        # ToDo: remove all uses of this, and delete it
1052
        for (field, (min, max)) in num_fields.items():
Ian Lynagh's avatar
Ian Lynagh committed
1053 1054 1055
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
1056
                result = failBecause('no such stats field')
Ian Lynagh's avatar
Ian Lynagh committed
1057 1058 1059 1060 1061 1062
            val = int(m.group(1))

            if val < min:
                print field, val, 'is less than minimum allowed', min
                print 'If this is because you have improved GHC, please'
                print 'update the test so that GHC doesn\'t regress again'
1063
                result = failBecause('stat too good')
Ian Lynagh's avatar
Ian Lynagh committed
1064 1065
            if val > max:
                print field, val, 'is more than maximum allowed', max
1066
                result = failBecause('stat not good enough')
Ian Lynagh's avatar
Ian Lynagh committed
1067

1068
    return result
Ian Lynagh's avatar
Ian Lynagh committed
1069

1070 1071 1072
# -----------------------------------------------------------------------------
# Build a single-module program

1073 1074 1075
def extras_build( way, extra_mods, extra_hc_opts ):
    for modopts in extra_mods:
        mod, opts = modopts
1076 1077 1078
        result = simple_build( mod, way, opts + ' ' + extra_hc_opts, 0, '', 0, 0, 0)
        if not (mod.endswith('.hs') or mod.endswith('.lhs')):
            extra_hc_opts