testlib.py 77.1 KB
Newer Older
1
# coding=utf8
2
#
3 4 5
# (c) Simon Marlow 2002
#

6
from __future__ import print_function
7

8
import shutil
9 10
import sys
import os
11
import errno
12 13 14
import string
import re
import traceback
15 16
import time
import datetime
17
import copy
18
import glob
ian@well-typed.com's avatar
ian@well-typed.com committed
19
from math import ceil, trunc
20
import collections
21
import subprocess
22

23
from testglobals import *
24 25
from testutil import *

26 27 28 29 30
try:
    basestring
except: # Python 3
    basestring = (str,bytes)

31 32
if config.use_threads:
    import threading
33 34 35 36
    try:
        import thread
    except ImportError: # Python 3
        import _thread as thread
37

38 39 40 41 42 43 44 45
global wantToStop
wantToStop = False
def stopNow():
    global wantToStop
    wantToStop = True
def stopping():
    return wantToStop

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

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
60 61 62
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
63

64 65 66 67 68
def isStatsTest():
    opts = getTestOpts()
    return len(opts.compiler_stats_range_fields) > 0 or len(opts.stats_range_fields) > 0


69 70 71
# This can be called at the top of a file of tests, to set default test options
# for the following tests.
def setTestOpts( f ):
72
    global thisdir_settings
73
    thisdir_settings = [thisdir_settings, f]
74 75 76 77 78 79 80 81 82 83 84 85

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

86
def normal( name, opts ):
87 88
    return;

89
def skip( name, opts ):
90 91
    opts.skip = 1

92
def expect_fail( name, opts ):
93 94 95
    # The compiler, testdriver, OS or platform is missing a certain
    # feature, and we don't plan to or can't fix it now or in the
    # future.
96 97
    opts.expect = 'fail';

98
def reqlib( lib ):
99
    return lambda name, opts, l=lib: _reqlib (name, opts, l )
100

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

105
def _reqlib( name, opts, lib ):
106
    if lib in have_lib:
107
        got_it = have_lib[lib]
108
    else:
109 110 111 112 113 114 115 116
        cmd = strip_quotes(config.ghc_pkg)
        p = subprocess.Popen([cmd, '--no-user-package-db', 'describe', lib],
                             stdout=subprocess.PIPE,
                             stderr=subprocess.PIPE)
        # read from stdout and stderr to avoid blocking due to
        # buffers filling
        p.communicate()
        r = p.wait()
117 118 119 120
        got_it = r == 0
        have_lib[lib] = got_it

    if not got_it:
121
        opts.expect = 'missing-lib'
122

123 124 125 126
def req_haddock( name, opts ):
    if not config.haddock:
        opts.expect = 'missing-lib'

127
def req_profiling( name, opts ):
128
    '''Require the profiling libraries (add 'GhcLibWays += p' to mk/build.mk)'''
129 130 131
    if not config.have_profiling:
        opts.expect = 'fail'

132
def req_shared_libs( name, opts ):
Simon Marlow's avatar
Simon Marlow committed
133 134 135
    if not config.have_shared_libs:
        opts.expect = 'fail'

136
def req_interp( name, opts ):
Ian Lynagh's avatar
Ian Lynagh committed
137 138 139
    if not config.have_interp:
        opts.expect = 'fail'

140
def req_smp( name, opts ):
Simon Marlow's avatar
Simon Marlow committed
141 142 143
    if not config.have_smp:
        opts.expect = 'fail'

144
def ignore_output( name, opts ):
145 146
    opts.ignore_output = 1

147
def no_stdin( name, opts ):
148 149
    opts.no_stdin = 1

150
def combined_output( name, opts ):
pcapriotti's avatar
pcapriotti committed
151 152
    opts.combined_output = True

153 154 155
# -----

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

158
def _expect_fail_for( name, opts, ways ):
159 160
    opts.expect_fail_for = ways

161
def expect_broken( bug ):
162 163
    # This test is a expected not to work due to the indicated trac bug
    # number.
164 165 166
    return lambda name, opts, b=bug: _expect_broken (name, opts, b )

def _expect_broken( name, opts, bug ):
167
    record_broken(name, opts, bug)
168 169
    opts.expect = 'fail';

Ian Lynagh's avatar
Ian Lynagh committed
170
def expect_broken_for( bug, ways ):
171
    return lambda name, opts, b=bug, w=ways: _expect_broken_for( name, opts, b, w )
Ian Lynagh's avatar
Ian Lynagh committed
172

173
def _expect_broken_for( name, opts, bug, ways ):
174
    record_broken(name, opts, bug)
Ian Lynagh's avatar
Ian Lynagh committed
175
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
176

177
def record_broken(name, opts, bug):
178
    global brokens
179
    me = (bug, opts.testdir, name)
180 181 182
    if not me in brokens:
        brokens.append(me)

183 184 185 186 187
def _expect_pass(way):
    # Helper function. Not intended for use in .T files.
    opts = getTestOpts()
    return opts.expect == 'pass' and way not in opts.expect_fail_for

188 189 190
# -----

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

193
def _omit_ways( name, opts, ways ):
194 195 196 197
    opts.omit_ways = ways

# -----

198
def only_ways( ways ):
199
    return lambda name, opts, w=ways: _only_ways( name, opts, w )
200

201
def _only_ways( name, opts, ways ):
202 203 204 205
    opts.only_ways = ways

# -----

206
def extra_ways( ways ):
207
    return lambda name, opts, w=ways: _extra_ways( name, opts, w )
208

209
def _extra_ways( name, opts, ways ):
210 211 212 213
    opts.extra_ways = ways

# -----

214 215
def only_compiler_types( _compiler_types ):
   # Don't delete yet. The libraries unix, stm and hpc still call this function.
216
   return lambda _name, _opts: None
ross's avatar
ross committed
217 218 219

# -----

220
def set_stdin( file ):
221
   return lambda name, opts, f=file: _set_stdin(name, opts, f);
222

223
def _set_stdin( name, opts, f ):
224 225 226 227 228
   opts.stdin = f

# -----

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

231
def _exit_code( name, opts, v ):
232 233
    opts.exit_code = v

234 235 236 237 238 239 240 241 242 243 244
def signal_exit_code( val ):
    if opsys('solaris2'):
        return exit_code( val );
    else:
        # When application running on Linux receives fatal error
        # signal, then its exit code is encoded as 128 + signal
        # value. See http://www.tldp.org/LDP/abs/html/exitcodes.html
        # I assume that Mac OS X behaves in the same way at least Mac
        # OS X builder behavior suggests this.
        return exit_code( val+128 );

245 246
# -----

247 248
def compile_timeout_multiplier( val ):
    return lambda name, opts, v=val: _compile_timeout_multiplier(name, opts, v)
249

250 251 252 253 254 255 256 257
def _compile_timeout_multiplier( name, opts, v ):
    opts.compile_timeout_multiplier = v

def run_timeout_multiplier( val ):
    return lambda name, opts, v=val: _run_timeout_multiplier(name, opts, v)

def _run_timeout_multiplier( name, opts, v ):
    opts.run_timeout_multiplier = v
258 259 260

# -----

261
def extra_run_opts( val ):
262
    return lambda name, opts, v=val: _extra_run_opts(name, opts, v);
263

264
def _extra_run_opts( name, opts, v ):
265 266
    opts.extra_run_opts = v

267 268
# -----

Simon Marlow's avatar
Simon Marlow committed
269
def extra_hc_opts( val ):
270
    return lambda name, opts, v=val: _extra_hc_opts(name, opts, v);
Simon Marlow's avatar
Simon Marlow committed
271

272
def _extra_hc_opts( name, opts, v ):
Simon Marlow's avatar
Simon Marlow committed
273 274 275 276
    opts.extra_hc_opts = v

# -----

277
def extra_clean( files ):
278
    assert not isinstance(files, str), files
279
    return lambda name, opts, v=files: _extra_clean(name, opts, v);
280

281
def _extra_clean( name, opts, v ):
282 283
    opts.clean_files = v

284 285
# -----

286 287 288 289 290 291 292
def stats_num_field( field, expecteds ):
    return lambda name, opts, f=field, e=expecteds: _stats_num_field(name, opts, f, e);

def _stats_num_field( name, opts, field, expecteds ):
    if field in opts.stats_range_fields:
        framework_fail(name, 'duplicate-numfield', 'Duplicate ' + field + ' num_field check')

293
    if type(expecteds) is list:
294 295 296 297 298
        for (b, expected, dev) in expecteds:
            if b:
                opts.stats_range_fields[field] = (expected, dev)
                return
        framework_fail(name, 'numfield-no-expected', 'No expected value found for ' + field + ' in num_field check')
299

300 301 302
    else:
        (expected, dev) = expecteds
        opts.stats_range_fields[field] = (expected, dev)
303 304 305

def compiler_stats_num_field( field, expecteds ):
    return lambda name, opts, f=field, e=expecteds: _compiler_stats_num_field(name, opts, f, e);
306

307 308 309 310
def _compiler_stats_num_field( name, opts, field, expecteds ):
    if field in opts.compiler_stats_range_fields:
        framework_fail(name, 'duplicate-numfield', 'Duplicate ' + field + ' num_field check')

311 312
    # Compiler performance numbers change when debugging is on, making the results
    # useless and confusing. Therefore, skip if debugging is on.
313 314 315
    if compiler_debugged():
        skip(name, opts)

316 317 318 319
    for (b, expected, dev) in expecteds:
        if b:
            opts.compiler_stats_range_fields[field] = (expected, dev)
            return
320

321 322
    framework_fail(name, 'numfield-no-expected', 'No expected value found for ' + field + ' in num_field check')

323 324
# -----

325
def when(b, f):
ian@well-typed.com's avatar
ian@well-typed.com committed
326 327 328
    # When list_brokens is on, we want to see all expect_broken calls,
    # so we always do f
    if b or config.list_broken:
329 330 331 332 333 334 335
        return f
    else:
        return normal

def unless(b, f):
    return when(not b, f)

ian@well-typed.com's avatar
ian@well-typed.com committed
336 337 338
def doing_ghci():
    return 'ghci' in config.run_ways

339
def ghci_dynamic( ):
ian@well-typed.com's avatar
ian@well-typed.com committed
340
    return config.ghc_dynamic
341 342

def fast():
343
    return config.speed == 2
344

345 346
def platform( plat ):
    return config.platform == plat
Ian Lynagh's avatar
Ian Lynagh committed
347

348 349
def opsys( os ):
    return config.os == os
Ian Lynagh's avatar
Ian Lynagh committed
350

351 352
def arch( arch ):
    return config.arch == arch
353

354 355
def wordsize( ws ):
    return config.wordsize == str(ws)
tibbe's avatar
tibbe committed
356

357 358
def msys( ):
    return config.msys
ian@well-typed.com's avatar
ian@well-typed.com committed
359

360 361
def cygwin( ):
    return config.cygwin
Ian Lynagh's avatar
Ian Lynagh committed
362

363 364
def have_vanilla( ):
    return config.have_vanilla
365

366 367
def have_dynamic( ):
    return config.have_dynamic
368

369 370
def have_profiling( ):
    return config.have_profiling
371

372 373
def in_tree_compiler( ):
    return config.in_tree_compiler
374

375
def compiler_lt( compiler, version ):
376 377
    assert compiler == 'ghc'
    return version_lt(config.compiler_version, version)
378

379
def compiler_le( compiler, version ):
380 381
    assert compiler == 'ghc'
    return version_le(config.compiler_version, version)
382

383
def compiler_gt( compiler, version ):
384 385
    assert compiler == 'ghc'
    return version_gt(config.compiler_version, version)
386

387
def compiler_ge( compiler, version ):
388 389
    assert compiler == 'ghc'
    return version_ge(config.compiler_version, version)
390

391 392 393 394 395 396
def unregisterised( ):
    return config.unregisterised

def compiler_profiled( ):
    return config.compiler_profiled

397 398
def compiler_debugged( ):
    return config.compiler_debugged
399

400 401 402 403 404
def tag( t ):
    return t in config.compiler_tags

# ---

405
def high_memory_usage(name, opts):
406 407
    opts.alone = True

408 409 410 411 412
# If a test is for a multi-CPU race, then running the test alone
# increases the chance that we'll actually see it.
def multi_cpu_race(name, opts):
    opts.alone = True

Ian Lynagh's avatar
Ian Lynagh committed
413
# ---
414
def literate( name, opts ):
Ian Lynagh's avatar
Ian Lynagh committed
415 416
    opts.literate = 1;

417
def c_src( name, opts ):
418 419
    opts.c_src = 1;

420
def objc_src( name, opts ):
Austin Seipp's avatar
Austin Seipp committed
421 422
    opts.objc_src = 1;

423
def objcpp_src( name, opts ):
424 425
    opts.objcpp_src = 1;

426
def cmm_src( name, opts ):
427 428
    opts.cmm_src = 1;

429
def outputdir( odir ):
430
    return lambda name, opts, d=odir: _outputdir(name, opts, d)
431

432
def _outputdir( name, opts, odir ):
433 434
    opts.outputdir = odir;

435 436
# ----

437
def pre_cmd( cmd ):
438
    return lambda name, opts, c=cmd: _pre_cmd(name, opts, cmd)
439

440
def _pre_cmd( name, opts, cmd ):
441 442 443 444
    opts.pre_cmd = cmd

# ----

445
def clean_cmd( cmd ):
446
    return lambda name, opts, c=cmd: _clean_cmd(name, opts, cmd)
447

448
def _clean_cmd( name, opts, cmd ):
449 450 451 452
    opts.clean_cmd = cmd

# ----

453
def cmd_prefix( prefix ):
454
    return lambda name, opts, p=prefix: _cmd_prefix(name, opts, prefix)
455

456
def _cmd_prefix( name, opts, prefix ):
457 458 459 460 461
    opts.cmd_wrapper = lambda cmd, p=prefix: p + ' ' + cmd;

# ----

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

464
def _cmd_wrapper( name, opts, fun ):
465
    opts.cmd_wrapper = fun
466

467 468
# ----

Ian Lynagh's avatar
Ian Lynagh committed
469
def compile_cmd_prefix( prefix ):
470
    return lambda name, opts, p=prefix: _compile_cmd_prefix(name, opts, prefix)
Ian Lynagh's avatar
Ian Lynagh committed
471

472
def _compile_cmd_prefix( name, opts, prefix ):
Ian Lynagh's avatar
Ian Lynagh committed
473 474 475 476
    opts.compile_cmd_prefix = prefix

# ----

477 478 479 480 481 482 483 484
def check_stdout( f ):
    return lambda name, opts, f=f: _check_stdout(name, opts, f)

def _check_stdout( name, opts, f ):
    opts.check_stdout = f

# ----

485
def normalise_slashes( name, opts ):
486
    _normalise_fun(name, opts, normalise_slashes_)
487

488
def normalise_exe( name, opts ):
489
    _normalise_fun(name, opts, normalise_exe_)
490

491 492
def normalise_fun( *fs ):
    return lambda name, opts: _normalise_fun(name, opts, fs)
493

494
def _normalise_fun( name, opts, *fs ):
495
    opts.extra_normaliser = join_normalisers(opts.extra_normaliser, fs)
496

497 498
def normalise_errmsg_fun( *fs ):
    return lambda name, opts: _normalise_errmsg_fun(name, opts, fs)
499

500
def _normalise_errmsg_fun( name, opts, *fs ):
501 502 503 504 505 506 507 508 509 510 511 512 513
    opts.extra_errmsg_normaliser =  join_normalisers(opts.extra_errmsg_normaliser, fs)

def normalise_version_( *pkgs ):
    def normalise_version__( str ):
        return re.sub('(' + '|'.join(map(re.escape,pkgs)) + ')-[0-9.]+',
                      '\\1-<VERSION>', str)
    return normalise_version__

def normalise_version( *pkgs ):
    def normalise_version__( name, opts ):
        _normalise_fun(name, opts, normalise_version_(*pkgs))
        _normalise_errmsg_fun(name, opts, normalise_version_(*pkgs))
    return normalise_version__
514

thomie's avatar
thomie committed
515 516 517 518
def normalise_drive_letter(name, opts):
    # Windows only. Change D:\\ to C:\\.
    _normalise_fun(name, opts, lambda str: re.sub(r'[A-Z]:\\', r'C:\\', str))

519 520
def join_normalisers(*a):
    """
521
    Compose functions, flattening sequences.
522

523
       join_normalisers(f1,[f2,f3],f4)
524 525 526

    is the same as

527
       lambda x: f1(f2(f3(f4(x))))
528 529
    """

530 531 532 533 534 535 536 537 538 539 540 541
    def flatten(l):
        """
        Taken from http://stackoverflow.com/a/2158532/946226
        """
        for el in l:
            if isinstance(el, collections.Iterable) and not isinstance(el, basestring):
                for sub in flatten(el):
                    yield sub
            else:
                yield el

    a = flatten(a)
542 543 544

    fn = lambda x:x # identity function
    for f in a:
545
        assert callable(f)
546 547 548
        fn = lambda x,f=f,fn=fn: fn(f(x))
    return fn

549 550 551
# ----
# Function for composing two opt-fns together

552
def executeSetups(fs, name, opts):
553
    if type(fs) is list:
554
        # If we have a list of setups, then execute each one
555 556
        for f in fs:
            executeSetups(f, name, opts)
557 558 559
    else:
        # fs is a single function, so just apply it
        fs(name, opts)
560

561 562 563 564
# -----------------------------------------------------------------------------
# The current directory of tests

def newTestDir( dir ):
565
    global thisdir_settings
566
    # reset the options for this test directory
567 568 569 570 571
    thisdir_settings = lambda name, opts, dir=dir: _newTestDir( name, opts, dir )

def _newTestDir( name, opts, dir ):
    opts.testdir = dir
    opts.compiler_always_flags = config.compiler_always_flags
572 573 574 575

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

576 577
parallelTests = []
aloneTests = []
578
allTestNames = set([])
579

580
def runTest (opts, name, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
581 582
    ok = 0

583
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
584
        t.thread_pool.acquire()
585
        try:
586
            while config.threads<(t.running_threads+1):
587
                t.thread_pool.wait()
588
            t.running_threads = t.running_threads+1
589 590
            ok=1
            t.thread_pool.release()
591
            thread.start_new_thread(test_common_thread, (name, opts, func, args))
592 593 594 595 596
        except:
            if not ok:
                t.thread_pool.release()
    else:
        test_common_work (name, opts, func, args)
597

598
# name  :: String
599
# setup :: TestOpts -> IO ()
600
def test (name, setup, func, args):
601 602 603 604 605 606 607 608 609 610
    if config.run_only_some_tests:
        if name not in config.only:
            return
        else:
            # Note [Mutating config.only]
            # config.only is initiallly the set of tests requested by
            # the user (via 'make TEST='). We then remove all tests that
            # we've already seen (in .T files), so that we can later
            # report on any tests we couldn't find and error out.
            config.only.remove(name)
611

612 613
    global aloneTests
    global parallelTests
614
    global allTestNames
615
    global thisdir_settings
616 617
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
618
    if not re.match('^[0-9]*[a-zA-Z][a-zA-Z0-9._-]*$', name):
619
        framework_fail(name, 'bad_name', 'This test has an invalid name')
620 621 622 623 624

    # Make a deep copy of the default_testopts, as we need our own copy
    # of any dictionaries etc inside it. Otherwise, if one test modifies
    # them, all tests will see the modified version!
    myTestOpts = copy.deepcopy(default_testopts)
625

626
    executeSetups([thisdir_settings, setup], name, myTestOpts)
627 628 629 630 631 632

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

635
if config.use_threads:
636
    def test_common_thread(name, opts, func, args):
637 638 639 640 641 642
        t.lock.acquire()
        try:
            test_common_work(name,opts,func,args)
        finally:
            t.lock.release()
            t.thread_pool.acquire()
643
            t.running_threads = t.running_threads - 1
644 645
            t.thread_pool.notify()
            t.thread_pool.release()
646

647 648 649 650 651 652 653 654 655 656
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
657
def test_common_work (name, opts, func, args):
658 659 660 661 662 663 664 665 666
    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
667
        elif func == compile_and_run or func == multimod_compile_and_run:
668 669 670 671 672 673
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
674
        else:
675 676 677
            all_ways = ['normal']

        # A test itself can request extra ways by setting opts.extra_ways
678
        all_ways = all_ways + [way for way in opts.extra_ways if way not in all_ways]
679 680 681 682 683

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

        ok_way = lambda way: \
            not getTestOpts().skip \
684
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
685
            and (config.cmdline_ways == [] or way in config.cmdline_ways) \
686
            and (not (config.skip_perf_tests and isStatsTest())) \
687 688 689
            and way not in getTestOpts().omit_ways

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

692 693
        # Only run all ways in slow mode.
        # See Note [validate and testsuite speed] in toplevel Makefile.
694 695
        if config.accept:
            # Only ever run one way
696
            do_ways = do_ways[:1]
697 698 699
        elif config.speed > 0:
            # However, if we EXPLICITLY asked for a way (with extra_ways)
            # please test it!
700 701
            explicit_ways = list(filter(lambda way: way in opts.extra_ways, do_ways))
            other_ways = list(filter(lambda way: way not in opts.extra_ways, do_ways))
702
            do_ways = other_ways[:1] + explicit_ways
703 704 705 706

        if not config.clean_only:
            # Run the required tests...
            for way in do_ways:
707 708
                if stopping():
                    break
709 710 711 712 713 714 715
                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 != []):
716
            pretest_cleanup(name)
717 718
            clean([name + suff for suff in [
                       '', '.exe', '.exe.manifest', '.genscript',
719 720 721 722 723 724 725
                       '.stderr.normalised',        '.stdout.normalised',
                       '.run.stderr.normalised',    '.run.stdout.normalised',
                       '.comp.stderr.normalised',   '.comp.stdout.normalised',
                       '.interp.stderr.normalised', '.interp.stdout.normalised',
                       '.stats', '.comp.stats',
                       '.hi', '.o', '.prof', '.exe.prof', '.hc',
                       '_stub.h', '_stub.c', '_stub.o',
726
                       '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']])
727

728
            if func == multi_compile or func == multi_compile_fail:
729
                    extra_mods = args[1]
730 731 732
                    clean([replace_suffix(fx[0],'o') for fx in extra_mods])
                    clean([replace_suffix(fx[0], 'hi') for fx in extra_mods])

733 734

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

736 737 738 739 740 741 742
            if getTestOpts().outputdir != None:
                odir = in_testdir(getTestOpts().outputdir)
                try:
                    shutil.rmtree(odir)
                except:
                    pass

743 744 745 746 747
            try:
                shutil.rmtree(in_testdir('.hpc.' + name))
            except:
                pass

748 749 750 751 752 753
            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))
754
            except:
755
                framework_fail(name, 'cleaning', 'clean-command exception')
756

757
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
758

759 760
        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))
761

762 763 764 765 766 767 768 769 770 771
        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
772
    except Exception as e:
773
        framework_fail(name, 'runTest', 'Unhandled exception: ' + str(e))
Ian Lynagh's avatar
Ian Lynagh committed
774

775 776
def clean(strs):
    for str in strs:
777 778 779 780 781
        if (str.endswith('.package.conf') or
            str.startswith('package.conf.') and not str.endswith('/*')):
            # Package confs are directories now.
            str += '/*'

782 783
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
784

785
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
786 787 788
        try:
            # Remove files...
            os.remove(name)
789
        except OSError as e1:
790
            try:
Ian Lynagh's avatar
Ian Lynagh committed
791 792
                # ... and empty directories
                os.rmdir(name)
793
            except OSError as e2:
Ian Lynagh's avatar
Ian Lynagh committed
794 795 796 797 798
                # 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:
799
                    print(e1)
Ian Lynagh's avatar
Ian Lynagh committed
800
                if e2.errno != errno.ENOENT:
801
                    print(e2)
802

803
def do_test(name, way, func, args):
804 805 806
    full_name = name + '(' + way + ')'

    try:
807 808 809 810 811
        if_verbose(2, "=====> %s %d of %d %s " % \
                    (full_name, t.total_tests, len(allTestNames), \
                    [t.n_unexpected_passes, \
                     t.