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

Ian Lynagh's avatar
Ian Lynagh committed
332
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
333
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
334 335 336 337
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
338 339 340 341 342 343 344 345 346 347 348 349
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

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

350 351
# ---

352 353 354 355 356 357 358 359 360 361 362 363
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

364 365 366 367 368
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
369 370 371 372 373 374

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

376 377 378 379 380 381
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
382
def if_compiler_lt( compiler, version, f ):
383
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
384 385 386 387
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
388

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
410 411
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
412

Ian Lynagh's avatar
Ian Lynagh committed
413 414
def _namebase( opts, nb ):
    opts.with_namebase = nb
415

416 417
# ---

418
def if_tag( tag, f ):
419
    if tag in config.compiler_tags:
420 421 422
        return f
    else:
        return normal
423

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

ei@vuokko.info's avatar
ei@vuokko.info committed
430
# ---
431
def alone(opts):
432
    opts.alone = True
ei@vuokko.info's avatar
ei@vuokko.info committed
433

Ian Lynagh's avatar
Ian Lynagh committed
434 435 436 437
# ---
def literate( opts ):
    opts.literate = 1;

438 439 440
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
441 442 443
def objc_src( opts ):
    opts.objc_src = 1;

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

447 448
# ----

449 450 451 452 453 454 455 456
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

457 458 459 460 461 462 463 464
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

465 466 467 468
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
469 470 471 472 473 474 475 476 477
    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
478

479 480
# ----

Ian Lynagh's avatar
Ian Lynagh committed
481 482 483 484 485 486 487 488
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

# ----

489 490 491
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

492 493 494
def normalise_exe( opts ):
    opts.extra_normaliser = normalise_exe_

495 496 497 498 499 500
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

501 502 503 504 505 506 507 508 509
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))

510 511 512
# ----
# Function for composing two opt-fns together

513 514 515
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

516 517 518
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

519
def _compose( opts, f, g ):
520 521 522 523 524 525 526
    f(opts)
    g(opts)

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

def newTestDir( dir ):
527
    global thisdir_testopts
528 529
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
530
    thisdir_testopts.testdir = dir
531
    thisdir_testopts.compiler_always_flags = config.compiler_always_flags
532 533 534 535

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

536
allTests = []
537
allTestNames = set([])
538 539

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
540
    n = 1
541 542 543 544

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

ei@vuokko.info's avatar
ei@vuokko.info committed
545
    setup(opts)
546

547
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
548
        n = config.threads
549

ei@vuokko.info's avatar
ei@vuokko.info committed
550 551
    ok = 0

552
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
553
        t.thread_pool.acquire()
554 555 556 557 558 559 560 561 562 563 564 565
        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)
566

567
# name  :: String
568
# setup :: TestOpts -> IO ()
569 570
def test (name, setup, func, args):
    global allTests
571 572 573
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
574 575
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
576
    allTestNames.add(name)
577

578 579 580 581 582 583 584 585 586 587 588
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()
589

590 591 592 593 594 595 596 597 598 599
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
600
def test_common_work (name, opts, func, args):
601 602 603 604 605 606 607 608 609
    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
610
        elif func == compile_and_run or func == multimod_compile_and_run:
611 612 613 614 615 616
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
617
        else:
618 619 620 621 622 623 624 625 626 627 628
            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) \
629
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
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 655 656 657 658 659 660 661 662 663
            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']))

664
            if func == multi_compile or func == multi_compile_fail:
665 666 667 668 669
                    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
670

671 672 673 674 675 676 677 678
            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')
679

680
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
681

682 683
        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))
684

685 686 687 688 689 690 691 692 693 694 695 696
        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
697

698 699 700 701
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
702

703
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
704 705 706 707
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
708
            try:
Ian Lynagh's avatar
Ian Lynagh committed
709 710 711 712 713 714 715 716 717 718 719
                # ... 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
720

721
def do_test(name, way, func, args):
722 723 724
    full_name = name + '(' + way + ')'

    try:
725 726 727 728
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
729

730 731
        if config.use_threads:
            t.lock.release()
732 733 734 735

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
736
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
737 738 739 740 741
                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
742 743 744
        try:
            result = apply(func, [name,way] + args)
        finally:
745 746
            if config.use_threads:
                t.lock.acquire()
747

748 749 750
        if getTestOpts().expect != 'pass' and \
                getTestOpts().expect != 'fail' and \
                getTestOpts().expect != 'missing-lib':
751
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
752

753 754 755 756 757 758
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

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

796
def addPassingTestInfo (testInfos, directory, name, way):
797 798 799 800 801 802 803 804 805 806
    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)

807 808 809 810 811 812 813 814 815 816 817 818 819 820
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)

821
def skiptest (name, way):
822 823
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
824 825 826 827
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
828

829 830 831
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
832
    t.n_framework_failures = t.n_framework_failures + 1
833 834 835 836
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
837

838 839 840 841 842 843 844 845 846 847 848 849 850 851
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}

852 853 854 855
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
856 857 858 859 860 861
#
# 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.
862

863
def run_command( name, way, cmd ):
864
    return simple_run( name, '', cmd, '' )
865

866 867 868 869
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
870
    # filter out -fforce-recomp from compiler_always_flags, because we're
871
    # actually testing the recompilation behaviour in the GHCi tests.
872
    flags = filter(lambda f: f != '-fforce-recomp', getTestOpts().compiler_always_flags)
873
    flags.append(getTestOpts().extra_hc_opts)
874 875 876 877 878 879

    # 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 + "'" + \
880
          ' --interactive -v0 -ignore-dot-ghci ' + \
881 882
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
883
    getTestOpts().stdin = script
884
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
885

886 887 888 889
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
890
    return do_compile( name, way, 0, '', [], extra_hc_opts )
891 892

def compile_fail( name, way, extra_hc_opts ):
893
    return do_compile( name, way, 1, '', [], extra_hc_opts )
894 895

def multimod_compile( name, way, top_mod, extra_hc_opts ):
896
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
897

898
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
899 900 901 902 903 904 905 906 907
    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 ):
908 909
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
910 911 912 913 914 915

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

916 917 918
    force = 0
    if extra_mods:
       force = 1
919 920
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

921
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
922
        return result
923 924 925 926 927

    # 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
928
    if getTestOpts().with_namebase == None:
929 930
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
931
        namebase = getTestOpts().with_namebase
932 933

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
934 935
    actual_stderr_file = qualify(name, 'comp.stderr')

936 937
    if not compare_outputs('stderr', \
                           two_normalisers(two_normalisers(getTestOpts().extra_errmsg_normaliser, normalise_errmsg), normalise_whitespace), \
938
                           expected_stderr_file, actual_stderr_file):
939
        return failBecause('stderr mismatch')
940 941

    # no problems found, this test passed
942
    return passed()
943 944 945 946

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

947
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
948 949 950
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

951 952 953 954
    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
955

956
    if way == 'ghci': # interpreted...
957
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
958
    elif way == 'extcore' or way == 'optextcore' :
959
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
960
    else: # compiled...
dterei's avatar
dterei committed
961 962 963 964
        force = 0
        if extra_mods:
           force = 1

965
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
966
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
967
            return result
968

969 970
        cmd = './' + name;

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

974
def compile_and_run( name, way, extra_hc_opts ):
975
    return compile_and_run__( name, way, '', [], extra_hc_opts)
976 977

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

980 981
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)
982

983 984 985 986 987
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
988 989 990
# -----------------------------------------------------------------------------
# Check -t stats info

991
def checkStats(stats_file, range_fields, num_fields):
992
    result = passed()
Simon Marlow's avatar
Simon Marlow committed
993
    if len(num_fields) + len(range_fields) > 0:
Ian Lynagh's avatar
Ian Lynagh committed
994 995 996 997
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
        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
1019
        for (field, (min, max)) in num_fields.items():
Ian Lynagh's avatar
Ian Lynagh committed
1020 1021 1022
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
1023
                result = failBecause('no such stats field')
Ian Lynagh's avatar
Ian Lynagh committed
1024 1025 1026 1027 1028 1029
            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'
1030
                result = failBecause('stat too good')
Ian Lynagh's avatar
Ian Lynagh committed
1031 1032
            if val > max:
                print field, val, 'is more than maximum allowed', max
1033
                result = failBecause('stat not good enough')
Ian Lynagh's avatar
Ian Lynagh committed
1034

1035
    return result
Ian Lynagh's avatar
Ian Lynagh committed
1036

1037 1038 1039
# -----------------------------------------------------------------------------
# Build a single-module program

1040 1041 1042
def extras_build( way, extra_mods, extra_hc_opts ):
    for modopts in extra_mods:
        mod, opts = modopts
1043 1044 1045
        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 += ' ' + replace_suffix(mod, 'o')
1046 1047 1048 1049 1050 1051 1052
        if badResult(result):
            return result

    return {'passFail' : 'pass', 'hc_opts' : extra_hc_opts}


def simple_build( name, way, extra_hc_opts, should_fail, top_mod, link, addsuf, noforce ):
Ian Lynagh's avatar
Ian Lynagh committed
1053
    opts = getTestOpts()
1054
    errname = add_suffix(name, 'comp.stderr')
1055 1056
    rm_no_fail( qualify(errname, '') )

1057 1058
    if top_mod != '':
        srcname = top_mod
1059 1060 1061 1062
        rm_no_fail( qualify(name, '') )
        base, suf = os.path.splitext(top_mod)
        rm_no_fail( qualify(base, '') )
        rm_no_fail( qualify(base, 'exe') )