testlib.py 72.8 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
import shutil
9 10
import sys
import os
11
import errno
12 13 14 15
import string
import re
import traceback
import copy
16
import glob
17
import types
18
import math
19

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

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

31 32 33
if config.use_threads:
    import threading
    import thread
34

35 36 37 38 39 40 41 42
global wantToStop
wantToStop = False
def stopNow():
    global wantToStop
    wantToStop = True
def stopping():
    return wantToStop

43 44 45 46 47 48 49 50 51 52 53 54
# 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).
55

ei@vuokko.info's avatar
ei@vuokko.info committed
56
global testopts_local
57 58 59 60 61 62
if config.use_threads:
    testopts_local = threading.local()
else:
    class TestOpts_Local:
        pass
    testopts_local = TestOpts_Local()
63 64

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

ei@vuokko.info's avatar
ei@vuokko.info committed
67 68 69
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

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

96 97 98
def reqlib( lib ):
    return lambda opts, l=lib: _reqlib (opts, l )

99 100 101 102
# Cache the results of looking to see if we have a library or not.
# This makes quite a difference, especially on Windows.
have_lib = {}

103
def _reqlib( opts, lib ):
104 105
    if have_lib.has_key(lib):
        got_it = have_lib[lib]
106
    else:
107 108 109
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
110
            p = subprocess.Popen([config.ghc_pkg, '--no-user-package-db', 'describe', lib],
111 112 113 114 115 116 117 118 119 120 121 122 123
                                 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:
124
        opts.expect = 'missing-lib'
125

126 127 128 129
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Simon Marlow's avatar
Simon Marlow committed
130 131 132 133
def req_shared_libs( opts ):
    if not config.have_shared_libs:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
134 135 136 137
def req_interp( opts ):
    if not config.have_interp:
        opts.expect = 'fail'

Simon Marlow's avatar
Simon Marlow committed
138 139 140 141
def req_smp( opts ):
    if not config.have_smp:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
142 143 144 145 146 147
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

148 149 150
def ignore_output( opts ):
    opts.ignore_output = 1

151 152 153
def no_stdin( opts ):
    opts.no_stdin = 1

pcapriotti's avatar
pcapriotti committed
154 155 156
def combined_output( opts ):
    opts.combined_output = True

157 158 159 160 161 162 163 164
# -----

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
165 166 167 168
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
169
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
170

171 172 173 174 175 176 177 178 179 180
# -----

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

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

# -----

181 182 183 184 185 186 187 188
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

189 190 191 192 193 194 195 196
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
197 198 199 200 201
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
202
        opts.skip = 1
ross's avatar
ross committed
203 204 205 206 207 208 209 210

# -----

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
211
        opts.skip = 1
ross's avatar
ross committed
212 213 214

# -----

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
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

# -----

231 232 233 234 235 236 237 238
def timeout_multiplier( val ):
    return lambda opts, v=val: _timeout_multiplier(opts, v)

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

# -----

239 240 241 242 243 244
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

245 246
# -----

Simon Marlow's avatar
Simon Marlow committed
247 248 249 250 251 252 253 254
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

# -----

255 256 257 258 259 260
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

261 262
# -----

263 264
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
265

266
def _stats_num_field( opts, f, x, y ):
267 268 269
    # 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)
270

Ian Lynagh's avatar
Ian Lynagh committed
271 272 273 274
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 ):
275 276 277
    # 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
278

279 280
# -----

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
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)

# -----

299
def skip_if_no_ghci(opts):
dterei's avatar
dterei committed
300 301
    if not ('ghci' in config.run_ways):
        opts.skip = 1
302

303 304 305
# ----

def skip_if_fast(opts):
dterei's avatar
dterei committed
306 307
    if config.fast:
        opts.skip = 1
308

Simon Marlow's avatar
Simon Marlow committed
309 310
# -----

311
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
312
    if config.platform == plat:
313
        return f
314 315 316
    else:
        return normal

317
def unless_platform( plat, f ):
Ian Lynagh's avatar
Ian Lynagh committed
318 319 320 321 322
    if config.platform != plat:
        return f
    else:
        return normal

323 324 325
def if_os( os, f ):
    if config.os == os:
        return f
326 327 328
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
329 330 331 332 333 334
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

335 336 337 338 339 340
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

341 342 343 344 345 346
def unless_arch( arch, f ):
    if config.arch == arch:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
347
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
348
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
349 350 351 352
        return f
    else:
        return normal

tibbe's avatar
tibbe committed
353 354 355 356 357 358
def unless_wordsize( ws, f ):
    if config.wordsize == str(ws):
        return normal
    else:
        return f

ian@well-typed.com's avatar
ian@well-typed.com committed
359 360 361 362 363 364 365 366 367 368 369 370
def if_unregisterised( f ):
    if config.unregisterised:
        return f
    else:
        return normal

def unless_unregisterised( f ):
    if config.unregisterised:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
371 372 373 374 375 376 377 378 379 380 381 382
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

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

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
def when_have_vanilla( f ):
    if config.have_vanilla:
        return f
    else:
        return normal

def unless_have_vanilla( f ):
    if config.have_vanilla:
        return normal
    else:
        return f

def when_have_dynamic( f ):
    if config.have_dynamic:
        return f
    else:
        return normal

def unless_have_dynamic( f ):
    if config.have_dynamic:
        return normal
    else:
        return f

def when_have_profiling( f ):
    if config.have_profiling:
        return f
    else:
        return normal

def unless_have_profiling( f ):
    if config.have_profiling:
        return normal
    else:
        return f

419 420
# ---

421 422 423 424 425 426
def if_ghci_dynamic( f ):
    if config.ghc_dynamic_by_default:
        return f
    else:
        return normal

427 428 429 430 431 432 433 434 435 436 437 438
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

439 440 441 442 443
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
444 445 446 447 448 449

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

451 452 453 454 455 456
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
457
def if_compiler_lt( compiler, version, f ):
458
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
459 460 461 462
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
463

Ian Lynagh's avatar
Ian Lynagh committed
464
def if_compiler_le( compiler, version, f ):
465 466
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
467 468 469
        return f
    else:
        return normal
470

Ian Lynagh's avatar
Ian Lynagh committed
471
def if_compiler_gt( compiler, version, f ):
472
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
473 474 475 476
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
477

Ian Lynagh's avatar
Ian Lynagh committed
478
def if_compiler_ge( compiler, version, f ):
479
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
480 481 482 483
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
484

485 486 487 488 489 490
def if_compiler_debugged( f ):
    if config.compiler_debugged:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
491 492
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
493

Ian Lynagh's avatar
Ian Lynagh committed
494 495
def _namebase( opts, nb ):
    opts.with_namebase = nb
496

497 498
# ---

499
def if_tag( tag, f ):
500
    if tag in config.compiler_tags:
501 502 503
        return f
    else:
        return normal
504

505
def unless_tag( tag, f ):
506
    if not (tag in config.compiler_tags):
507 508 509
        return f
    else:
        return normal
510

ei@vuokko.info's avatar
ei@vuokko.info committed
511
# ---
512 513 514
def high_memory_usage(opts):
    opts.alone = True

Ian Lynagh's avatar
Ian Lynagh committed
515 516 517 518
# ---
def literate( opts ):
    opts.literate = 1;

519 520 521
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
522 523 524
def objc_src( opts ):
    opts.objc_src = 1;

525 526 527
def objcpp_src( opts ):
    opts.objcpp_src = 1;

528 529 530
def cmm_src( opts ):
    opts.cmm_src = 1;

531 532 533 534 535 536
def outputdir( odir ):
    return lambda opts, d=odir: _outputdir(opts, d)

def _outputdir( opts, odir ):
    opts.outputdir = odir;

537 538
# ----

539 540 541 542 543 544 545 546
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

547 548 549 550 551 552 553 554
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

555 556 557 558
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
559 560 561 562 563 564 565 566 567
    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
568

569 570
# ----

Ian Lynagh's avatar
Ian Lynagh committed
571 572 573 574 575 576 577 578
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

# ----

579 580 581
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

582 583 584
def normalise_exe( opts ):
    opts.extra_normaliser = normalise_exe_

585 586 587 588 589 590
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

591 592 593 594 595 596 597 598 599
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))

600 601 602
# ----
# Function for composing two opt-fns together

603 604 605
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

606 607 608
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

609
def _compose( opts, f, g ):
610 611 612 613 614 615 616
    f(opts)
    g(opts)

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

def newTestDir( dir ):
617
    global thisdir_testopts
618 619
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
620
    thisdir_testopts.testdir = dir
621
    thisdir_testopts.compiler_always_flags = config.compiler_always_flags
622 623 624 625

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

626 627
parallelTests = []
aloneTests = []
628
allTestNames = set([])
629

630
def runTest (opts, name, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
631 632
    ok = 0

633
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
634
        t.thread_pool.acquire()
635
        try:
636
            while config.threads<(t.running_threads+1):
637
                t.thread_pool.wait()
638
            t.running_threads = t.running_threads+1
639 640
            ok=1
            t.thread_pool.release()
641
            thread.start_new_thread(test_common_thread, (name, opts, func, args))
642 643 644 645 646
        except:
            if not ok:
                t.thread_pool.release()
    else:
        test_common_work (name, opts, func, args)
647

648
# name  :: String
649
# setup :: TestOpts -> IO ()
650
def test (name, setup, func, args):
651 652
    global aloneTests
    global parallelTests
653 654 655
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
656
    if not re.match('^[0-9]*[a-zA-Z][a-zA-Z0-9._-]*$', name):
657
        framework_fail(name, 'bad_name', 'This test has an invalid name')
658
    myTestOpts = copy.copy(thisdir_testopts)
659 660 661 662 663 664 665 666 667 668 669

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

    setup(myTestOpts)

    thisTest = lambda : runTest(myTestOpts, name, func, args)
    if myTestOpts.alone:
        aloneTests.append(thisTest)
    else:
        parallelTests.append(thisTest)
670
    allTestNames.add(name)
671

672
if config.use_threads:
673
    def test_common_thread(name, opts, func, args):
674 675 676 677 678 679
        t.lock.acquire()
        try:
            test_common_work(name,opts,func,args)
        finally:
            t.lock.release()
            t.thread_pool.acquire()
680
            t.running_threads = t.running_threads - 1
681 682
            t.thread_pool.notify()
            t.thread_pool.release()
683

684 685 686 687 688 689 690 691 692 693
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
694
def test_common_work (name, opts, func, args):
695 696 697 698 699 700 701 702 703
    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
704
        elif func == compile_and_run or func == multimod_compile_and_run:
705 706 707 708 709 710
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
711
        else:
712 713 714 715 716 717 718 719 720 721 722
            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) \
723
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
724 725 726 727 728 729 730 731 732 733 734 735 736
            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:
737 738
                if stopping():
                    break
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
                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']))

760
            if func == multi_compile or func == multi_compile_fail:
761 762 763 764 765
                    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
766

767 768 769 770 771 772 773
            if getTestOpts().outputdir != None:
                odir = in_testdir(getTestOpts().outputdir)
                try:
                    shutil.rmtree(odir)
                except:
                    pass

774 775 776 777 778
            try:
                shutil.rmtree(in_testdir('.hpc.' + name))
            except:
                pass

779 780 781 782 783 784 785 786
            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')
787

788
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
789

790 791
        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))
792

793 794 795 796 797 798 799 800 801 802 803 804
        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
805

806 807 808 809
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
810

811
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
812 813 814 815
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
816
            try:
Ian Lynagh's avatar
Ian Lynagh committed
817 818 819 820 821 822 823 824 825 826 827
                # ... 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
828

829
def do_test(name, way, func, args):
830 831 832
    full_name = name + '(' + way + ')'

    try:
833
        print '=====>', full_name, t.total_tests, 'of', len(allTestNames), \
834 835 836
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
837

838 839
        if config.use_threads:
            t.lock.release()
840 841 842 843

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
844
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
845 846 847 848 849
                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
850 851 852
        try:
            result = apply(func, [name,way] + args)
        finally:
853 854
            if config.use_threads:
                t.lock.acquire()
855

856 857 858
        if getTestOpts().expect != 'pass' and \
                getTestOpts().expect != 'fail' and \
                getTestOpts().expect != 'missing-lib':
859
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
860

861 862 863 864 865 866
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
867 868
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
869
                t.n_expected_passes = t.n_expected_passes + 1
870 871 872 873
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
874 875 876
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
877
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
878
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
879 880
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
881 882
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
883 884
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
885
            else:
886 887 888 889 890 891
                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]
892
                else:
893 894 895 896 897
                    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]
898 899
        else:
            framework_fail(name, way, 'bad result ' + passFail)
900
    except KeyboardInterrupt:
901
        stopNow()
902
    except:
903
        framework_fail(name, way, 'do_test exception')
904 905
        traceback.print_exc()

906
def addPassingTestInfo (testInfos, directory, name, way):
907 908 909 910 911 912 913 914 915 916
    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)

917 918 919 920 921 922 923 924 925 926 927 928 929 930
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)

931
def skiptest (name, way):
932 933
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
934 935 936 937
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
938

939 940
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
941
    print '*** framework failure for', full_name, reason
942
    t.n_framework_failures = t.n_framework_failures + 1
943 944 945 946
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
947

948 949 950 951 952 953 954 955 956 957 958 959 960 961
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}

962 963 964 965
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
966 967 968 969 970 971
#
# 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.
972

973
def run_command( name, way, cmd ):
974
    return simple_run( name, '', cmd, '' )
975

976 977 978 979
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
980
    # filter out -fforce-recomp from compiler_always_flags, because we're
981
    # actually testing the recompilation behaviour in the GHCi tests.
982
    flags = filter(lambda f: f != '-fforce-recomp', getTestOpts().compiler_always_flags)
983
    flags.append(getTestOpts().extra_hc_opts)
984 985
    if getTestOpts().outputdir != None:
        flags.extend(["-outputdir", getTestOpts().outputdir])
986 987 988 989 990 991

    # 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 + "'" + \
992
          ' --interactive -v0 -ignore-dot-ghci ' + \
993 994
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
995
    getTestOpts().stdin = script
996
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
997

998 999 1000 1001
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
1002
    return do_compile( name, way, 0, '', [], extra_hc_opts )
1003 1004

def compile_fail( name, way, extra_hc_opts ):
1005
    return do_compile( name, way, 1, '', [], extra_hc_opts )
1006 1007

def multimod_compile( name, way, top_mod, extra_hc_opts ):
1008
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
1009

1010
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
1011 1012 1013 1014 1015 1016 1017 1018 1019
    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 ):
1020 1021
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
1022 1023 1024 1025 1026 1027

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

1028 1029 1030
    force = 0
    if extra_mods:
       force = 1
1031 1032
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

1033
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
1034
        return result
1035 1036 1037 1038 1039

    # 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
1040
    if getTestOpts().with_namebase == None:
1041 1042
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
1043
        namebase = getTestOpts().with_namebase
1044 1045

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
1046 1047
    actual_stderr_file = qualify(name, 'comp.stderr')

1048 1049
    if not compare_outputs('stderr', \
                           two_normalisers(two_normalisers(getTestOpts().extra_errmsg_normaliser, normalise_errmsg), normalise_whitespace), \
1050
                           expected_stderr_file, actual_stderr_file):
1051
        return failBecause('stderr mismatch')
1052 1053

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

1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
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()

1083 1084 1085
# -----------------------------------------------------------------------------
# Compile-and-run tests

1086
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
1087 1088 1089
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

1090 1091 1092 1093
    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
1094

1095
    if way == 'ghci': # interpreted...
1096
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
1097
    elif way == 'extcore' or way == 'optextcore' :
1098
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
1099
    else: # compiled...
dterei's avatar
dterei committed
1100 1101 1102 1103
        force = 0
        if extra_mods:
           force = 1

1104
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
1105
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
1106
            return result
1107