testlib.py 67 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

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

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

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

# 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).
45

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
57 58 59
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
60 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

# 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';

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

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

93
def _reqlib( opts, lib ):
94 95
    if have_lib.has_key(lib):
        got_it = have_lib[lib]
96
    else:
97 98 99
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
100
            p = subprocess.Popen([config.ghc_pkg, '--no-user-package-db', 'describe', lib],
101 102 103 104 105 106 107 108 109 110 111 112 113
                                 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:
114
        opts.expect = 'missing-lib'
115

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

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

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

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

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

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

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

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

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

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

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
155 156 157 158
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
159
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
160

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

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

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

# -----

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

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

# -----

179 180 181 182 183 184 185 186
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
187 188 189 190 191
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
192
        opts.skip = 1
ross's avatar
ross committed
193 194 195 196 197 198 199 200

# -----

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
201
        opts.skip = 1
ross's avatar
ross committed
202 203 204

# -----

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
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

# -----

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

227 228
# -----

Simon Marlow's avatar
Simon Marlow committed
229 230 231 232 233 234 235 236
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

# -----

237 238 239 240 241 242
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

243 244
# -----

245 246
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
247

248
def _stats_num_field( opts, f, x, y ):
249 250 251
    # 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)
252

Ian Lynagh's avatar
Ian Lynagh committed
253 254 255 256
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 ):
257 258 259
    # 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
260

261 262
# -----

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
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)

# -----

281
def skip_if_no_ghci(opts):
dterei's avatar
dterei committed
282 283
    if not ('ghci' in config.run_ways):
        opts.skip = 1
284

285 286 287
# ----

def skip_if_fast(opts):
dterei's avatar
dterei committed
288 289
    if config.fast:
        opts.skip = 1
290

Simon Marlow's avatar
Simon Marlow committed
291 292
# -----

293
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
294
    if config.platform == plat:
295
        return f
296 297 298
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
299 300 301 302 303 304
def if_not_platform( plat, f ):
    if config.platform != plat:
        return f
    else:
        return normal

305 306 307
def if_os( os, f ):
    if config.os == os:
        return f
308 309 310
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
311 312 313 314 315 316
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

317 318 319 320 321 322
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
323
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
324
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
325 326 327 328
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
329 330 331 332 333 334 335 336 337 338 339 340
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

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

341 342
# ---

343 344 345 346 347 348 349 350 351 352 353 354
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

355 356 357 358 359
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
360 361 362 363 364 365

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

367 368 369 370 371 372
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
373
def if_compiler_lt( compiler, version, f ):
374
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
375 376 377 378
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
379

Ian Lynagh's avatar
Ian Lynagh committed
380
def if_compiler_le( compiler, version, f ):
381 382
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
383 384 385
        return f
    else:
        return normal
386

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

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

Ian Lynagh's avatar
Ian Lynagh committed
401 402
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
403

Ian Lynagh's avatar
Ian Lynagh committed
404 405
def _namebase( opts, nb ):
    opts.with_namebase = nb
406

407 408
# ---

409
def if_tag( tag, f ):
410
    if tag in config.compiler_tags:
411 412 413
        return f
    else:
        return normal
414

415
def unless_tag( tag, f ):
416
    if not (tag in config.compiler_tags):
417 418 419
        return f
    else:
        return normal
420

ei@vuokko.info's avatar
ei@vuokko.info committed
421
# ---
422
def alone(opts):
423
    opts.alone = True
ei@vuokko.info's avatar
ei@vuokko.info committed
424

Ian Lynagh's avatar
Ian Lynagh committed
425 426 427 428
# ---
def literate( opts ):
    opts.literate = 1;

429 430 431
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
432 433 434
def objc_src( opts ):
    opts.objc_src = 1;

435 436 437
def objcpp_src( opts ):
    opts.objcpp_src = 1;

438 439
# ----

440 441 442 443 444 445 446 447
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

448 449 450 451 452 453 454 455
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

456 457 458 459
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
460 461 462 463 464 465 466 467 468
    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
469

470 471
# ----

Ian Lynagh's avatar
Ian Lynagh committed
472 473 474 475 476 477 478 479
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

# ----

480 481 482
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

483 484 485
def normalise_exe( opts ):
    opts.extra_normaliser = normalise_exe_

486 487 488 489 490 491
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

492 493 494 495 496 497 498 499 500
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))

501 502 503
# ----
# Function for composing two opt-fns together

504 505 506
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

507 508 509
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

510
def _compose( opts, f, g ):
511 512 513 514 515 516 517
    f(opts)
    g(opts)

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

def newTestDir( dir ):
518
    global thisdir_testopts
519 520
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
521
    thisdir_testopts.testdir = dir
522
    thisdir_testopts.compiler_always_flags = config.compiler_always_flags
523 524 525 526

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

527
allTests = []
528
allTestNames = set([])
529 530

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
531
    n = 1
532 533 534 535

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

ei@vuokko.info's avatar
ei@vuokko.info committed
536
    setup(opts)
537

538
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
539
        n = config.threads
540

ei@vuokko.info's avatar
ei@vuokko.info committed
541 542
    ok = 0

543
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
544
        t.thread_pool.acquire()
545 546 547 548 549 550 551 552 553 554 555 556
        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)
557

558
# name  :: String
559
# setup :: TestOpts -> IO ()
560 561
def test (name, setup, func, args):
    global allTests
562 563 564
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
565 566
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
567
    allTestNames.add(name)
568

569 570 571 572 573 574 575 576 577 578 579
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()
580

581 582 583 584 585 586 587 588 589 590
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
591
def test_common_work (name, opts, func, args):
592 593 594 595 596 597 598 599 600
    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
601
        elif func == compile_and_run or func == multimod_compile_and_run:
602 603 604 605 606 607
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
608
        else:
609 610 611 612 613 614 615 616 617 618 619
            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) \
620
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
            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']))

655
            if func == multi_compile or func == multi_compile_fail:
656 657 658 659 660
                    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
661

662 663 664 665 666 667 668 669
            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')
670

671
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
672

673 674
        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))
675

676 677 678 679 680 681 682 683 684 685 686 687
        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
688

689 690 691 692
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
693

694
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
695 696 697 698
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
699
            try:
Ian Lynagh's avatar
Ian Lynagh committed
700 701 702 703 704 705 706 707 708 709 710
                # ... 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
711

712
def do_test(name, way, func, args):
713 714 715
    full_name = name + '(' + way + ')'

    try:
716 717 718 719
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
720

721 722
        if config.use_threads:
            t.lock.release()
723 724 725 726

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
727
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
728 729 730 731 732
                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
733 734 735
        try:
            result = apply(func, [name,way] + args)
        finally:
736 737
            if config.use_threads:
                t.lock.acquire()
738

739 740 741
        if getTestOpts().expect != 'pass' and \
                getTestOpts().expect != 'fail' and \
                getTestOpts().expect != 'missing-lib':
742
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
743

744 745 746 747 748 749
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
750 751
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
752
                t.n_expected_passes = t.n_expected_passes + 1
753 754 755 756
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
757 758 759
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
760
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
761
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
762 763
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
764 765
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
766 767
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
768
            else:
769 770 771 772 773 774
                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]
775
                else:
776 777 778 779 780
                    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]
781 782
        else:
            framework_fail(name, way, 'bad result ' + passFail)
783
    except:
784
        framework_fail(name, way, 'do_test exception')
785 786
        traceback.print_exc()

787
def addPassingTestInfo (testInfos, directory, name, way):
788 789 790 791 792 793 794 795 796 797
    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)

798 799 800 801 802 803 804 805 806 807 808 809 810 811
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)

812
def skiptest (name, way):
813 814
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
815 816 817 818
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
819

820 821 822
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
823
    t.n_framework_failures = t.n_framework_failures + 1
824 825 826 827
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
828

829 830 831 832 833 834 835 836 837 838 839 840 841 842
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}

843 844 845 846
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
847 848 849 850 851 852
#
# 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.
853

854
def run_command( name, way, cmd ):
855
    return simple_run( name, '', cmd, '' )
856

857 858 859 860
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
861
    # filter out -fforce-recomp from compiler_always_flags, because we're
862
    # actually testing the recompilation behaviour in the GHCi tests.
863
    flags = filter(lambda f: f != '-fforce-recomp', getTestOpts().compiler_always_flags)
864
    flags.append(getTestOpts().extra_hc_opts)
865 866 867 868 869 870

    # 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 + "'" + \
871
          ' --interactive -v0 -ignore-dot-ghci ' + \
872 873
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
874
    getTestOpts().stdin = script
875
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
876

877 878 879 880
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
881
    return do_compile( name, way, 0, '', [], extra_hc_opts )
882 883

def compile_fail( name, way, extra_hc_opts ):
884
    return do_compile( name, way, 1, '', [], extra_hc_opts )
885 886

def multimod_compile( name, way, top_mod, extra_hc_opts ):
887
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
888

889
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
890 891 892 893 894 895 896 897 898
    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 ):
899 900
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
901 902 903 904 905 906

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

907 908 909
    force = 0
    if extra_mods:
       force = 1
910 911
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

912
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
913
        return result
914 915 916 917 918

    # 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
919
    if getTestOpts().with_namebase == None:
920 921
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
922
        namebase = getTestOpts().with_namebase
923 924

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
925 926
    actual_stderr_file = qualify(name, 'comp.stderr')

927 928
    if not compare_outputs('stderr', \
                           two_normalisers(two_normalisers(getTestOpts().extra_errmsg_normaliser, normalise_errmsg), normalise_whitespace), \
929
                           expected_stderr_file, actual_stderr_file):
930
        return failBecause('stderr mismatch')
931 932

    # no problems found, this test passed
933
    return passed()
934 935 936 937

# -----------------------------------------------------------------------------
# Compile-and-run tests

938
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
939 940 941
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

942 943 944 945
    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
946

947
    if way == 'ghci': # interpreted...
948
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
949
    elif way == 'extcore' or way == 'optextcore' :
950
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
951
    else: # compiled...
dterei's avatar
dterei committed
952 953 954 955
        force = 0
        if extra_mods:
           force = 1

956
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
957
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
958
            return result
959

960 961
        cmd = './' + name;

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

965
def compile_and_run( name, way, extra_hc_opts ):
966
    return compile_and_run__( name, way, '', [], extra_hc_opts)
967 968

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

971 972
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)
973

Ian Lynagh's avatar
Ian Lynagh committed
974 975 976
# -----------------------------------------------------------------------------
# Check -t stats info

977
def checkStats(stats_file, range_fields, num_fields):
978
    result = passed()
Simon Marlow's avatar
Simon Marlow committed
979
    if len(num_fields) + len(range_fields) > 0:
Ian Lynagh's avatar
Ian Lynagh committed
980 981 982 983
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
        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
1005
        for (field, (min, max)) in num_fields.items():
Ian Lynagh's avatar
Ian Lynagh committed
1006 1007 1008
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
1009
                result = failBecause('no such stats field')
Ian Lynagh's avatar
Ian Lynagh committed
1010 1011 1012 1013 1014 1015
            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'
1016
                result = failBecause('stat too good')
Ian Lynagh's avatar
Ian Lynagh committed
1017 1018
            if val > max:
                print field, val, 'is more than maximum allowed', max
1019
                result = failBecause('stat not good enough')