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

5
from __future__ import print_function
6

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

22
from testglobals import *
23 24
from testutil import *

25 26
if config.use_threads:
    import threading
27 28 29 30
    try:
        import thread
    except ImportError: # Python 3
        import _thread as thread
31

32 33 34 35 36 37 38 39
global wantToStop
wantToStop = False
def stopNow():
    global wantToStop
    wantToStop = True
def stopping():
    return wantToStop

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

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
54 55 56
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
57

58 59 60 61 62
def isStatsTest():
    opts = getTestOpts()
    return len(opts.compiler_stats_range_fields) > 0 or len(opts.stats_range_fields) > 0


63 64 65
# This can be called at the top of a file of tests, to set default test options
# for the following tests.
def setTestOpts( f ):
66
    global thisdir_settings
67
    thisdir_settings = [thisdir_settings, f]
68 69 70 71 72 73 74 75 76 77 78 79

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

80
def normal( name, opts ):
81 82
    return;

83
def skip( name, opts ):
84 85
    opts.skip = 1

86
def expect_fail( name, opts ):
87 88
    opts.expect = 'fail';

89
def reqlib( lib ):
90
    return lambda name, opts, l=lib: _reqlib (name, opts, l )
91

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

96
def _reqlib( name, opts, lib ):
97
    if lib in have_lib:
98
        got_it = have_lib[lib]
99
    else:
100 101 102 103 104 105 106 107
        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()
108 109 110 111
        got_it = r == 0
        have_lib[lib] = got_it

    if not got_it:
112
        opts.expect = 'missing-lib'
113

114 115 116 117
def req_haddock( name, opts ):
    if not config.haddock:
        opts.expect = 'missing-lib'

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

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

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

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

134
def ignore_output( name, opts ):
135 136
    opts.ignore_output = 1

137
def no_stdin( name, opts ):
138 139
    opts.no_stdin = 1

140
def combined_output( name, opts ):
pcapriotti's avatar
pcapriotti committed
141 142
    opts.combined_output = True

143 144 145
# -----

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

148
def _expect_fail_for( name, opts, ways ):
149 150
    opts.expect_fail_for = ways

151 152 153 154
def expect_broken( bug ):
    return lambda name, opts, b=bug: _expect_broken (name, opts, b )

def _expect_broken( name, opts, bug ):
155
    record_broken(name, opts, bug)
156 157
    opts.expect = 'fail';

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

161
def _expect_broken_for( name, opts, bug, ways ):
162
    record_broken(name, opts, bug)
Ian Lynagh's avatar
Ian Lynagh committed
163
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
164

165
def record_broken(name, opts, bug):
166
    global brokens
167
    me = (bug, opts.testdir, name)
168 169 170
    if not me in brokens:
        brokens.append(me)

171 172 173 174 175
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

176 177 178
# -----

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

181
def _omit_ways( name, opts, ways ):
182 183 184 185
    opts.omit_ways = ways

# -----

186
def only_ways( ways ):
187
    return lambda name, opts, w=ways: _only_ways( name, opts, w )
188

189
def _only_ways( name, opts, ways ):
190 191 192 193
    opts.only_ways = ways

# -----

194
def extra_ways( ways ):
195
    return lambda name, opts, w=ways: _extra_ways( name, opts, w )
196

197
def _extra_ways( name, opts, ways ):
198 199 200 201
    opts.extra_ways = ways

# -----

ross's avatar
ross committed
202
def omit_compiler_types( compiler_types ):
203
   return lambda name, opts, c=compiler_types: _omit_compiler_types(name, opts, c)
ross's avatar
ross committed
204

205
def _omit_compiler_types( name, opts, compiler_types ):
ross's avatar
ross committed
206
    if config.compiler_type in compiler_types:
dterei's avatar
dterei committed
207
        opts.skip = 1
ross's avatar
ross committed
208 209 210 211

# -----

def only_compiler_types( compiler_types ):
212
   return lambda name, opts, c=compiler_types: _only_compiler_types(name, opts, c)
ross's avatar
ross committed
213

214
def _only_compiler_types( name, opts, compiler_types ):
ross's avatar
ross committed
215
    if config.compiler_type not in compiler_types:
dterei's avatar
dterei committed
216
        opts.skip = 1
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
def timeout_multiplier( val ):
248
    return lambda name, opts, v=val: _timeout_multiplier(name, opts, v)
249

250
def _timeout_multiplier( name, opts, v ):
251 252 253 254
    opts.timeout_multiplier = v

# -----

255
def extra_run_opts( val ):
256
    return lambda name, opts, v=val: _extra_run_opts(name, opts, v);
257

258
def _extra_run_opts( name, opts, v ):
259 260
    opts.extra_run_opts = v

261 262
# -----

Simon Marlow's avatar
Simon Marlow committed
263
def extra_hc_opts( val ):
264
    return lambda name, opts, v=val: _extra_hc_opts(name, opts, v);
Simon Marlow's avatar
Simon Marlow committed
265

266
def _extra_hc_opts( name, opts, v ):
Simon Marlow's avatar
Simon Marlow committed
267 268 269 270
    opts.extra_hc_opts = v

# -----

271
def extra_clean( files ):
272
    assert not isinstance(files, str), files
273
    return lambda name, opts, v=files: _extra_clean(name, opts, v);
274

275
def _extra_clean( name, opts, v ):
276 277
    opts.clean_files = v

278 279
# -----

280 281 282 283 284 285 286
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')

287
    if type(expecteds) is list:
288 289 290 291 292
        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')
293

294 295 296
    else:
        (expected, dev) = expecteds
        opts.stats_range_fields[field] = (expected, dev)
297 298 299

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

301 302 303 304
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')

305 306
    # Compiler performance numbers change when debugging is on, making the results
    # useless and confusing. Therefore, skip if debugging is on.
307 308 309
    if compiler_debugged():
        skip(name, opts)

310 311 312 313
    for (b, expected, dev) in expecteds:
        if b:
            opts.compiler_stats_range_fields[field] = (expected, dev)
            return
314

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

317 318
# -----

319
def when(b, f):
ian@well-typed.com's avatar
ian@well-typed.com committed
320 321 322
    # When list_brokens is on, we want to see all expect_broken calls,
    # so we always do f
    if b or config.list_broken:
323 324 325 326 327 328 329
        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
330 331 332
def doing_ghci():
    return 'ghci' in config.run_ways

333
def ghci_dynamic( ):
ian@well-typed.com's avatar
ian@well-typed.com committed
334
    return config.ghc_dynamic
335 336 337 338

def fast():
    return config.fast

339 340
def platform( plat ):
    return config.platform == plat
Ian Lynagh's avatar
Ian Lynagh committed
341

342 343
def opsys( os ):
    return config.os == os
Ian Lynagh's avatar
Ian Lynagh committed
344

345 346
def arch( arch ):
    return config.arch == arch
347

348 349
def wordsize( ws ):
    return config.wordsize == str(ws)
tibbe's avatar
tibbe committed
350

351 352
def msys( ):
    return config.msys
ian@well-typed.com's avatar
ian@well-typed.com committed
353

354 355
def cygwin( ):
    return config.cygwin
Ian Lynagh's avatar
Ian Lynagh committed
356

357 358
def have_vanilla( ):
    return config.have_vanilla
359

360 361
def have_dynamic( ):
    return config.have_dynamic
362

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

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

369 370
def compiler_type( compiler ):
    return config.compiler_type == compiler
371

372 373 374
def compiler_lt( compiler, version ):
    return config.compiler_type == compiler and \
           version_lt(config.compiler_version, version)
375

376 377 378
def compiler_le( compiler, version ):
    return config.compiler_type == compiler and \
           version_le(config.compiler_version, version)
379

380 381 382
def compiler_gt( compiler, version ):
    return config.compiler_type == compiler and \
           version_gt(config.compiler_version, version)
383

384 385 386
def compiler_ge( compiler, version ):
    return config.compiler_type == compiler and \
           version_ge(config.compiler_version, version)
387

388 389 390 391 392 393
def unregisterised( ):
    return config.unregisterised

def compiler_profiled( ):
    return config.compiler_profiled

394 395
def compiler_debugged( ):
    return config.compiler_debugged
396

397 398 399 400 401
def tag( t ):
    return t in config.compiler_tags

# ---

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

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

408 409
# ---

410
def high_memory_usage(name, opts):
411 412
    opts.alone = True

413 414 415 416 417
# 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
418
# ---
419
def literate( name, opts ):
Ian Lynagh's avatar
Ian Lynagh committed
420 421
    opts.literate = 1;

422
def c_src( name, opts ):
423 424
    opts.c_src = 1;

425
def objc_src( name, opts ):
Austin Seipp's avatar
Austin Seipp committed
426 427
    opts.objc_src = 1;

428
def objcpp_src( name, opts ):
429 430
    opts.objcpp_src = 1;

431
def cmm_src( name, opts ):
432 433
    opts.cmm_src = 1;

434
def outputdir( odir ):
435
    return lambda name, opts, d=odir: _outputdir(name, opts, d)
436

437
def _outputdir( name, opts, odir ):
438 439
    opts.outputdir = odir;

440 441
# ----

442
def pre_cmd( cmd ):
443
    return lambda name, opts, c=cmd: _pre_cmd(name, opts, cmd)
444

445
def _pre_cmd( name, opts, cmd ):
446 447 448 449
    opts.pre_cmd = cmd

# ----

450
def clean_cmd( cmd ):
451
    return lambda name, opts, c=cmd: _clean_cmd(name, opts, cmd)
452

453
def _clean_cmd( name, opts, cmd ):
454 455 456 457
    opts.clean_cmd = cmd

# ----

458
def cmd_prefix( prefix ):
459
    return lambda name, opts, p=prefix: _cmd_prefix(name, opts, prefix)
460

461
def _cmd_prefix( name, opts, prefix ):
462 463 464 465 466
    opts.cmd_wrapper = lambda cmd, p=prefix: p + ' ' + cmd;

# ----

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

469
def _cmd_wrapper( name, opts, fun ):
470
    opts.cmd_wrapper = fun
471

472 473
# ----

Ian Lynagh's avatar
Ian Lynagh committed
474
def compile_cmd_prefix( prefix ):
475
    return lambda name, opts, p=prefix: _compile_cmd_prefix(name, opts, prefix)
Ian Lynagh's avatar
Ian Lynagh committed
476

477
def _compile_cmd_prefix( name, opts, prefix ):
Ian Lynagh's avatar
Ian Lynagh committed
478 479 480 481
    opts.compile_cmd_prefix = prefix

# ----

482 483 484 485 486 487 488 489
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

# ----

490
def normalise_slashes( name, opts ):
491
    _normalise_fun(name, opts, normalise_slashes_)
492

493
def normalise_exe( name, opts ):
494
    _normalise_fun(name, opts, normalise_exe_)
495

496 497
def normalise_fun( *fs ):
    return lambda name, opts: _normalise_fun(name, opts, fs)
498

499
def _normalise_fun( name, opts, *fs ):
500
    opts.extra_normaliser = join_normalisers(opts.extra_normaliser, fs)
501

502 503
def normalise_errmsg_fun( *fs ):
    return lambda name, opts: _normalise_errmsg_fun(name, opts, fs)
504

505
def _normalise_errmsg_fun( name, opts, *fs ):
506 507 508 509 510 511 512 513 514 515 516 517 518
    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__
519

thomie's avatar
thomie committed
520 521 522 523
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))

524 525
def join_normalisers(*a):
    """
526
    Compose functions, flattening sequences.
527

528
       join_normalisers(f1,[f2,f3],f4)
529 530 531

    is the same as

532
       lambda x: f1(f2(f3(f4(x))))
533 534
    """

535 536 537 538 539 540 541 542 543 544 545 546
    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)
547 548 549

    fn = lambda x:x # identity function
    for f in a:
550
        assert callable(f)
551 552 553
        fn = lambda x,f=f,fn=fn: fn(f(x))
    return fn

554 555 556
# ----
# Function for composing two opt-fns together

557
def executeSetups(fs, name, opts):
558
    if type(fs) is list:
559
        # If we have a list of setups, then execute each one
560 561
        for f in fs:
            executeSetups(f, name, opts)
562 563 564
    else:
        # fs is a single function, so just apply it
        fs(name, opts)
565

566 567 568 569
# -----------------------------------------------------------------------------
# The current directory of tests

def newTestDir( dir ):
570
    global thisdir_settings
571
    # reset the options for this test directory
572 573 574 575 576
    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
577 578 579 580

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

581 582
parallelTests = []
aloneTests = []
583
allTestNames = set([])
584

585
def runTest (opts, name, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
586 587
    ok = 0

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

603
# name  :: String
604
# setup :: TestOpts -> IO ()
605
def test (name, setup, func, args):
606 607
    global aloneTests
    global parallelTests
608
    global allTestNames
609
    global thisdir_settings
610 611
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
612
    if not re.match('^[0-9]*[a-zA-Z][a-zA-Z0-9._-]*$', name):
613
        framework_fail(name, 'bad_name', 'This test has an invalid name')
614 615 616 617 618

    # 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)
619

620
    executeSetups([thisdir_settings, setup], name, myTestOpts)
621 622 623 624 625 626

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

629
if config.use_threads:
630
    def test_common_thread(name, opts, func, args):
631 632 633 634 635 636
        t.lock.acquire()
        try:
            test_common_work(name,opts,func,args)
        finally:
            t.lock.release()
            t.thread_pool.acquire()
637
            t.running_threads = t.running_threads - 1
638 639
            t.thread_pool.notify()
            t.thread_pool.release()
640

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

        # A test itself can request extra ways by setting opts.extra_ways
672
        all_ways = all_ways + [way for way in opts.extra_ways if way not in all_ways]
673 674 675 676 677 678

        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) \
679
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
680
            and (config.cmdline_ways == [] or way in config.cmdline_ways) \
681
            and (not (config.skip_perf_tests and isStatsTest())) \
682 683 684
            and way not in getTestOpts().omit_ways

        # Which ways we are asked to skip
685
        do_ways = list(filter (ok_way,all_ways))
686 687 688 689 690 691 692 693

        # 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:
694 695
                if stopping():
                    break
696 697 698 699 700 701 702
                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 != []):
703
            pretest_cleanup(name)
704 705
            clean([name + suff for suff in [
                       '', '.exe', '.exe.manifest', '.genscript',
706 707 708 709 710 711 712
                       '.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',
713
                       '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']])
714

715
            if func == multi_compile or func == multi_compile_fail:
716
                    extra_mods = args[1]
717 718 719
                    clean([replace_suffix(fx[0],'o') for fx in extra_mods])
                    clean([replace_suffix(fx[0], 'hi') for fx in extra_mods])

720 721

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

723 724 725 726 727 728 729
            if getTestOpts().outputdir != None:
                odir = in_testdir(getTestOpts().outputdir)
                try:
                    shutil.rmtree(odir)
                except:
                    pass

730 731 732 733 734
            try:
                shutil.rmtree(in_testdir('.hpc.' + name))
            except:
                pass

735 736 737 738 739 740
            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))
741
            except:
742
                framework_fail(name, 'cleaning', 'clean-command exception')
743

744
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
745

746 747
        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))
748

749 750 751 752 753 754 755 756 757 758
        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
759
    except Exception as e:
760
        framework_fail(name, 'runTest', 'Unhandled exception: ' + str(e))
Ian Lynagh's avatar
Ian Lynagh committed
761

762 763
def clean(strs):
    for str in strs:
764 765 766 767 768
        if (str.endswith('.package.conf') or
            str.startswith('package.conf.') and not str.endswith('/*')):
            # Package confs are directories now.
            str += '/*'

769 770
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
771

772
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
773 774 775
        try:
            # Remove files...
            os.remove(name)
776
        except OSError as e1:
777
            try:
Ian Lynagh's avatar
Ian Lynagh committed
778 779
                # ... and empty directories
                os.rmdir(name)
780
            except OSError as e2:
Ian Lynagh's avatar
Ian Lynagh committed
781 782 783 784 785
                # 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:
786
                    print(e1)
Ian Lynagh's avatar
Ian Lynagh committed
787
                if e2.errno != errno.ENOENT:
788
                    print(e2)
789

790
def do_test(name, way, func, args):
791 792 793
    full_name = name + '(' + way + ')'

    try:
794 795 796 797 798
        if_verbose(2, "=====> %s %d of %d %s " % \
                    (full_name, t.total_tests, len(allTestNames), \
                    [t.n_unexpected_passes, \
                     t.n_unexpected_failures, \
                     t.n_framework_failures]))
799

800 801
        if config.use_threads:
            t.lock.release()
802 803 804 805

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
806
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
807 808
                if result != 0:
                    framework_fail(name, way, 'pre-command failed: ' + str(result))
809
        except:
810 811
            framework_fail(name, way, 'pre-command exception')

ei@vuokko.info's avatar
ei@vuokko.info committed
812
        try:
813
            result = func(*[name,way] + args)
ei@vuokko.info's avatar
ei@vuokko.info committed
814
        finally:
815 816
            if config.use_threads:
                t.lock.acquire()
817

818 819 820
        if getTestOpts().expect != 'pass' and \
                getTestOpts().expect != 'fail' and \
                getTestOpts().expect != 'missing-lib':
821
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
822

823 824 825 826 827 828
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
829
            if _expect_pass(way):
830
                t.n_expected_passes = t.n_expected_passes + 1
831 832 833 834
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way