testlib.py 70.7 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 43 44 45 46

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

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
59 60 61
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87

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

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

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

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

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

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

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

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

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

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

140 141 142
def ignore_output( opts ):
    opts.ignore_output = 1

143 144 145
def no_stdin( opts ):
    opts.no_stdin = 1

pcapriotti's avatar
pcapriotti committed
146 147 148
def combined_output( opts ):
    opts.combined_output = True

149 150 151 152 153 154 155 156
# -----

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

163 164 165 166 167 168 169 170 171 172
# -----

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

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

# -----

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

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

# -----

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

# -----

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

# -----

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

# -----

223 224 225 226 227 228 229 230
def timeout_multiplier( val ):
    return lambda opts, v=val: _timeout_multiplier(opts, v)

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

# -----

231 232 233 234 235 236
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

237 238
# -----

Simon Marlow's avatar
Simon Marlow committed
239 240 241 242 243 244 245 246
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

# -----

247 248 249 250 251 252
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

253 254
# -----

255 256
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
257

258
def _stats_num_field( opts, f, x, y ):
259 260 261
    # 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)
262

Ian Lynagh's avatar
Ian Lynagh committed
263 264 265 266
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 ):
267 268 269
    # 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
270

271 272
# -----

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
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)

# -----

291
def skip_if_no_ghci(opts):
dterei's avatar
dterei committed
292 293
    if not ('ghci' in config.run_ways):
        opts.skip = 1
294

295 296 297
# ----

def skip_if_fast(opts):
dterei's avatar
dterei committed
298 299
    if config.fast:
        opts.skip = 1
300

Simon Marlow's avatar
Simon Marlow committed
301 302
# -----

303
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
304
    if config.platform == plat:
305
        return f
306 307 308
    else:
        return normal

309
def unless_platform( plat, f ):
Ian Lynagh's avatar
Ian Lynagh committed
310 311 312 313 314
    if config.platform != plat:
        return f
    else:
        return normal

315 316 317
def if_os( os, f ):
    if config.os == os:
        return f
318 319 320
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
321 322 323 324 325 326
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

327 328 329 330 331 332
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

333 334 335 336 337 338
def unless_arch( arch, f ):
    if config.arch == arch:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
339
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
340
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
341 342 343 344
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
345 346 347 348 349 350 351 352 353 354 355 356
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

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

357 358
# ---

359 360 361 362 363 364
def if_ghci_dynamic( f ):
    if config.ghc_dynamic_by_default:
        return f
    else:
        return normal

365 366 367 368 369 370 371 372 373 374 375 376
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

377 378 379 380 381
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
382 383 384 385 386 387

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

389 390 391 392 393 394
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

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

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

Ian Lynagh's avatar
Ian Lynagh committed
409
def if_compiler_gt( compiler, version, f ):
410
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
411 412 413 414
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
415

Ian Lynagh's avatar
Ian Lynagh committed
416
def if_compiler_ge( compiler, version, f ):
417
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
418 419 420 421
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
422

Ian Lynagh's avatar
Ian Lynagh committed
423 424
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
425

Ian Lynagh's avatar
Ian Lynagh committed
426 427
def _namebase( opts, nb ):
    opts.with_namebase = nb
428

429 430
# ---

431
def if_tag( tag, f ):
432
    if tag in config.compiler_tags:
433 434 435
        return f
    else:
        return normal
436

437
def unless_tag( tag, f ):
438
    if not (tag in config.compiler_tags):
439 440 441
        return f
    else:
        return normal
442

ei@vuokko.info's avatar
ei@vuokko.info committed
443
# ---
444
def alone(opts):
445
    opts.alone = True
ei@vuokko.info's avatar
ei@vuokko.info committed
446

447 448 449
def high_memory_usage(opts):
    opts.alone = True

Ian Lynagh's avatar
Ian Lynagh committed
450 451 452 453
# ---
def literate( opts ):
    opts.literate = 1;

454 455 456
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
457 458 459
def objc_src( opts ):
    opts.objc_src = 1;

460 461 462
def objcpp_src( opts ):
    opts.objcpp_src = 1;

463 464 465 466 467 468
def outputdir( odir ):
    return lambda opts, d=odir: _outputdir(opts, d)

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

469 470
# ----

471 472 473 474 475 476 477 478
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

479 480 481 482 483 484 485 486
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

487 488 489 490
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
491 492 493 494 495 496 497 498 499
    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
500

501 502
# ----

Ian Lynagh's avatar
Ian Lynagh committed
503 504 505 506 507 508 509 510
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

# ----

511 512 513
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

514 515 516
def normalise_exe( opts ):
    opts.extra_normaliser = normalise_exe_

517 518 519 520 521 522
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

523 524 525 526 527 528 529 530 531
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))

532 533 534
# ----
# Function for composing two opt-fns together

535 536 537
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

538 539 540
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

541
def _compose( opts, f, g ):
542 543 544 545 546 547 548
    f(opts)
    g(opts)

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

def newTestDir( dir ):
549
    global thisdir_testopts
550 551
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
552
    thisdir_testopts.testdir = dir
553
    thisdir_testopts.compiler_always_flags = config.compiler_always_flags
554 555 556 557

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

558 559
parallelTests = []
aloneTests = []
560
allTestNames = set([])
561

562
def runTest (opts, name, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
563 564
    ok = 0

565
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
566
        t.thread_pool.acquire()
567
        try:
568
            while config.threads<(t.running_threads+1):
569
                t.thread_pool.wait()
570
            t.running_threads = t.running_threads+1
571 572
            ok=1
            t.thread_pool.release()
573
            thread.start_new_thread(test_common_thread, (name, opts, func, args))
574 575 576 577 578
        except:
            if not ok:
                t.thread_pool.release()
    else:
        test_common_work (name, opts, func, args)
579

580
# name  :: String
581
# setup :: TestOpts -> IO ()
582
def test (name, setup, func, args):
583 584
    global aloneTests
    global parallelTests
585 586 587
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
588
    myTestOpts = copy.copy(thisdir_testopts)
589 590 591 592 593 594 595 596 597 598 599

    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)
600
    allTestNames.add(name)
601

602
if config.use_threads:
603
    def test_common_thread(name, opts, func, args):
604 605 606 607 608 609
        t.lock.acquire()
        try:
            test_common_work(name,opts,func,args)
        finally:
            t.lock.release()
            t.thread_pool.acquire()
610
            t.running_threads = t.running_threads - 1
611 612
            t.thread_pool.notify()
            t.thread_pool.release()
613

614 615 616 617 618 619 620 621 622 623
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
624
def test_common_work (name, opts, func, args):
625 626 627 628 629 630 631 632 633
    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
634
        elif func == compile_and_run or func == multimod_compile_and_run:
635 636 637 638 639 640
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
641
        else:
642 643 644 645 646 647 648 649 650 651 652
            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) \
653
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
            and (config.cmdline_ways == [] or way in config.cmdline_ways) \
            and way not in getTestOpts().omit_ways

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

        # In fast mode, we skip all but one way
        if config.fast and len(do_ways) > 0:
            do_ways = [do_ways[0]]

        if not config.clean_only:
            # Run the required tests...
            for way in do_ways:
                do_test (name, way, func, args)

            for way in all_ways:
                if way not in do_ways:
                    skiptest (name,way)

        if getTestOpts().cleanup != '' and (config.clean_only or do_ways != []):
            clean(map (lambda suff: name + suff,
                      ['', '.exe', '.exe.manifest', '.genscript',
                       '.stderr.normalised',        '.stdout.normalised',
                       '.run.stderr',               '.run.stdout',
                       '.run.stderr.normalised',    '.run.stdout.normalised',
                       '.comp.stderr',              '.comp.stdout',
                       '.comp.stderr.normalised',   '.comp.stdout.normalised',
                       '.interp.stderr',            '.interp.stdout',
                       '.interp.stderr.normalised', '.interp.stdout.normalised',
                       '.stats', '.comp.stats',
                       '.hi', '.o', '.prof', '.exe.prof', '.hc',
                       '_stub.h', '_stub.c', '_stub.o',
                       '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))

688
            if func == multi_compile or func == multi_compile_fail:
689 690 691 692 693
                    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
694

695 696 697 698 699 700 701
            if getTestOpts().outputdir != None:
                odir = in_testdir(getTestOpts().outputdir)
                try:
                    shutil.rmtree(odir)
                except:
                    pass

702 703 704 705 706 707 708 709
            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')
710

711
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
712

713 714
        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))
715

716 717 718 719 720 721 722 723 724 725 726 727
        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
728

729 730 731 732
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
733

734
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
735 736 737 738
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
739
            try:
Ian Lynagh's avatar
Ian Lynagh committed
740 741 742 743 744 745 746 747 748 749 750
                # ... 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
751

752
def do_test(name, way, func, args):
753 754 755
    full_name = name + '(' + way + ')'

    try:
756
        print '=====>', full_name, t.total_tests, 'of', len(allTestNames), \
757 758 759
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
760

761 762
        if config.use_threads:
            t.lock.release()
763 764 765 766

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
767
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
768 769 770 771 772
                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
773 774 775
        try:
            result = apply(func, [name,way] + args)
        finally:
776 777
            if config.use_threads:
                t.lock.acquire()
778

779 780 781
        if getTestOpts().expect != 'pass' and \
                getTestOpts().expect != 'fail' and \
                getTestOpts().expect != 'missing-lib':
782
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
783

784 785 786 787 788 789
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
790 791
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
792
                t.n_expected_passes = t.n_expected_passes + 1
793 794 795 796
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
797 798 799
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
800
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
801
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
802 803
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
804 805
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
806 807
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
808
            else:
809 810 811 812 813 814
                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]
815
                else:
816 817 818 819 820
                    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]
821 822
        else:
            framework_fail(name, way, 'bad result ' + passFail)
823
    except:
824
        framework_fail(name, way, 'do_test exception')
825 826
        traceback.print_exc()

827
def addPassingTestInfo (testInfos, directory, name, way):
828 829 830 831 832 833 834 835 836 837
    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)

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

852
def skiptest (name, way):
853 854
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
855 856 857 858
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
859

860 861 862
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
863
    t.n_framework_failures = t.n_framework_failures + 1
864 865 866 867
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
868

869 870 871 872 873 874 875 876 877 878 879 880 881 882
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}

883 884 885 886
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
887 888 889 890 891 892
#
# 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.
893

894
def run_command( name, way, cmd ):
895
    return simple_run( name, '', cmd, '' )
896

897 898 899 900
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
901
    # filter out -fforce-recomp from compiler_always_flags, because we're
902
    # actually testing the recompilation behaviour in the GHCi tests.
903
    flags = filter(lambda f: f != '-fforce-recomp', getTestOpts().compiler_always_flags)
904
    flags.append(getTestOpts().extra_hc_opts)
905 906
    if getTestOpts().outputdir != None:
        flags.extend(["-outputdir", getTestOpts().outputdir])
907 908 909 910 911 912

    # 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 + "'" + \
913
          ' --interactive -v0 -ignore-dot-ghci ' + \
914 915
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
916
    getTestOpts().stdin = script
917
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
918

919 920 921 922
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
923
    return do_compile( name, way, 0, '', [], extra_hc_opts )
924 925

def compile_fail( name, way, extra_hc_opts ):
926
    return do_compile( name, way, 1, '', [], extra_hc_opts )
927 928

def multimod_compile( name, way, top_mod, extra_hc_opts ):
929
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
930

931
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
932 933 934 935 936 937 938 939 940
    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 ):
941 942
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
943 944 945 946 947 948

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

949 950 951
    force = 0
    if extra_mods:
       force = 1
952 953
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

954
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
955
        return result
956 957 958 959 960

    # 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
961
    if getTestOpts().with_namebase == None:
962 963
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
964
        namebase = getTestOpts().with_namebase
965 966

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
967 968
    actual_stderr_file = qualify(name, 'comp.stderr')

969 970
    if not compare_outputs('stderr', \
                           two_normalisers(two_normalisers(getTestOpts().extra_errmsg_normaliser, normalise_errmsg), normalise_whitespace), \
971
                           expected_stderr_file, actual_stderr_file):
972
        return failBecause('stderr mismatch')
973 974

    # no problems found, this test passed
975
    return passed()
976

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
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()

1004 1005 1006
# -----------------------------------------------------------------------------
# Compile-and-run tests

1007
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
1008 1009 1010
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

1011 1012 1013 1014
    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
1015

1016
    if way == 'ghci': # interpreted...
1017
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
1018
    elif way == 'extcore' or way == 'optextcore' :
1019
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
1020
    else: # compiled...
dterei's avatar
dterei committed
1021 1022 1023 1024
        force = 0
        if extra_mods:
           force = 1

1025
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
1026
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
1027
            return result
1028

1029 1030
        cmd = './' + name;

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

1034
def compile_and_run( name, way, extra_hc_opts ):
1035
    return compile_and_run__( name, way, '', [], extra_hc_opts)
1036 1037

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

1040 1041
def multi_compile_and_run( name, way, top_mod, extra_mods, extra_hc_opts ):
    return compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts)
1042

1043 1044 1045 1046 1047
def stats( name, way, stats_file ):
    opts = getTestOpts()
    return checkStats(stats_file, opts.stats_range_fields
                                , opts.stats_num_fields)

Ian Lynagh's avatar
Ian Lynagh committed
1048 1049 1050
# -----------------------------------------------------------------------------
# Check -t stats info

1051
def checkStats(stats_file, range_fields, num_fields):
1052
    result = passed()
Simon Marlow's avatar
Simon Marlow committed
1053
    if len(num_fields) + len(range_fields) > 0:
Ian Lynagh's avatar
Ian Lynagh committed
1054 1055 1056 1057
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
        for (field, (expected, dev)) in range_fields.items():
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
                result = failBecause('no such stats field')
            val = int(m.group(1))

            min = expected * ((100 - float(dev))/100);
            max = expected * ((100 + float(dev))/100);

            if val < min:
                print field, val, 'is more than ' + repr(dev) + '%'
                print 'less than the exepected value', expected
                print 'If this is because you have improved GHC, please'
                print 'update the test so that GHC doesn\'t regress again'
                result = failBecause('stat too good')
            if val > max:
                print field, val, 'is more than ' + repr(dev) + '% greater than the expected value,', expected