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

5 6 7
# This allows us to use the "with X:" syntax with python 2.5:
from __future__ import with_statement

8 9
import sys
import os
10
import errno
11 12 13 14
import string
import re
import traceback
import copy
15
import glob
16
import types
17

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

25
from string import join
26
from testglobals import *
27 28
from testutil import *

29 30 31
if config.use_threads:
    import threading
    import thread
32 33 34 35 36 37 38 39 40 41 42 43 44

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

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

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

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

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

86 87 88
def reqlib( lib ):
    return lambda opts, l=lib: _reqlib (opts, l )

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
128 129 130 131 132 133
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

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

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

140 141 142 143 144 145 146 147
# -----

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
148 149 150 151
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
152
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
153

154 155 156 157 158 159 160 161 162 163
# -----

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

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

# -----

164 165 166 167 168 169 170 171
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

172 173 174 175 176 177 178 179
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
180 181 182 183 184
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
185
        opts.skip = 1
ross's avatar
ross committed
186 187 188 189 190 191 192 193

# -----

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
194
        opts.skip = 1
ross's avatar
ross committed
195 196 197

# -----

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
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

# -----

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

220 221
# -----

Simon Marlow's avatar
Simon Marlow committed
222 223 224 225 226 227 228 229
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

# -----

230 231 232 233 234 235
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

236 237
# -----

238 239
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
240

241
def _stats_num_field( opts, f, x, y ):
242 243 244
    # 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)
245

Ian Lynagh's avatar
Ian Lynagh committed
246 247 248 249
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 ):
250 251 252
    # 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
253

254 255
# -----

256
def skip_if_no_ghci(opts):
dterei's avatar
dterei committed
257 258
    if not ('ghci' in config.run_ways):
        opts.skip = 1
259

260 261 262
# ----

def skip_if_fast(opts):
dterei's avatar
dterei committed
263 264
    if config.fast:
        opts.skip = 1
265

Simon Marlow's avatar
Simon Marlow committed
266 267
# -----

268
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
269
    if config.platform == plat:
270
        return f
271 272 273
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
274 275 276 277 278 279
def if_not_platform( plat, f ):
    if config.platform != plat:
        return f
    else:
        return normal

280 281 282
def if_os( os, f ):
    if config.os == os:
        return f
283 284 285
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
286 287 288 289 290 291
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

292 293 294 295 296 297
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
298
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
299
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
300 301 302 303
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
304 305 306 307 308 309 310 311 312 313 314 315
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

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

316 317
# ---

318 319 320 321 322 323 324 325 326 327 328 329
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

330 331 332 333 334
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
335 336 337 338 339 340

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

342 343 344 345 346 347
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
348
def if_compiler_lt( compiler, version, f ):
349
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
350 351 352 353
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
354

Ian Lynagh's avatar
Ian Lynagh committed
355
def if_compiler_le( compiler, version, f ):
356 357
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
358 359 360
        return f
    else:
        return normal
361

Ian Lynagh's avatar
Ian Lynagh committed
362
def if_compiler_gt( compiler, version, f ):
363
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
364 365 366 367
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
368

Ian Lynagh's avatar
Ian Lynagh committed
369
def if_compiler_ge( compiler, version, f ):
370
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
371 372 373 374
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
375

Ian Lynagh's avatar
Ian Lynagh committed
376 377
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
378

Ian Lynagh's avatar
Ian Lynagh committed
379 380
def _namebase( opts, nb ):
    opts.with_namebase = nb
381

382 383
# ---

384
def if_tag( tag, f ):
385
    if tag in config.compiler_tags:
386 387 388
        return f
    else:
        return normal
389

390
def unless_tag( tag, f ):
391
    if not (tag in config.compiler_tags):
392 393 394
        return f
    else:
        return normal
395

ei@vuokko.info's avatar
ei@vuokko.info committed
396
# ---
397
def alone(opts):
398
    opts.alone = True
ei@vuokko.info's avatar
ei@vuokko.info committed
399

Ian Lynagh's avatar
Ian Lynagh committed
400 401 402 403
# ---
def literate( opts ):
    opts.literate = 1;

404 405 406
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
407 408 409
def objc_src( opts ):
    opts.objc_src = 1;

410 411 412
def objcpp_src( opts ):
    opts.objcpp_src = 1;

413 414
# ----

415 416 417 418 419 420 421 422
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

423 424 425 426 427 428 429 430
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

431 432 433 434
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
435 436 437 438 439 440 441 442 443
    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
444

445 446
# ----

Ian Lynagh's avatar
Ian Lynagh committed
447 448 449 450 451 452 453 454
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

# ----

455 456 457
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

458 459 460 461 462 463
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

464 465 466 467 468 469 470 471 472
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))

473 474 475
# ----
# Function for composing two opt-fns together

476 477 478
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

479 480 481
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

482
def _compose( opts, f, g ):
483 484 485 486 487 488 489
    f(opts)
    g(opts)

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

def newTestDir( dir ):
490
    global thisdir_testopts
491 492
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
493
    thisdir_testopts.testdir = dir
494 495 496 497

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

498
allTests = []
499
allTestNames = set([])
500 501

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
502
    n = 1
503 504 505 506

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

ei@vuokko.info's avatar
ei@vuokko.info committed
507
    setup(opts)
508

509
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
510
        n = config.threads
511

ei@vuokko.info's avatar
ei@vuokko.info committed
512 513
    ok = 0

514
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
515
        t.thread_pool.acquire()
516 517 518 519 520 521 522 523 524 525 526 527
        try:
            while config.threads<(t.running_threads+n):
                t.thread_pool.wait()
            t.running_threads = t.running_threads+n
            ok=1
            t.thread_pool.release()
            thread.start_new_thread(test_common_thread, (n, name, opts, func, args))
        except:
            if not ok:
                t.thread_pool.release()
    else:
        test_common_work (name, opts, func, args)
528

529
# name  :: String
530
# setup :: TestOpts -> IO ()
531 532
def test (name, setup, func, args):
    global allTests
533 534 535
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
536 537
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
538
    allTestNames.add(name)
539

540 541 542 543 544 545 546 547 548 549 550
if config.use_threads:
    def test_common_thread(n, name, opts, func, args):
        t.lock.acquire()
        try:
            test_common_work(name,opts,func,args)
        finally:
            t.lock.release()
            t.thread_pool.acquire()
            t.running_threads = t.running_threads - n
            t.thread_pool.notify()
            t.thread_pool.release()
551

552 553 554 555 556 557 558 559 560 561
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
562
def test_common_work (name, opts, func, args):
563 564 565 566 567 568 569 570 571
    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
572
        elif func == compile_and_run or func == multimod_compile_and_run:
573 574 575 576 577 578
            all_ways = config.run_ways
        elif func == ghci_script:
            if 'ghci' in config.run_ways:
                all_ways = ['ghci']
            else:
                all_ways = []
579
        else:
580 581 582 583 584 585 586 587 588 589 590
            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) \
591
            and (getTestOpts().only_ways == None or way in getTestOpts().only_ways) \
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
            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']))

626
            if func == multi_compile or func == multi_compile_fail:
627 628 629 630 631
                    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
632

633 634 635 636 637 638 639 640
            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')
641

642
        package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
643

644 645
        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))
646

647 648 649 650 651 652 653 654 655 656 657 658
        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
659

660 661 662 663
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
664

665
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
666 667 668 669
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
670
            try:
Ian Lynagh's avatar
Ian Lynagh committed
671 672 673 674 675 676 677 678 679 680 681
                # ... 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
682

683
def do_test(name, way, func, args):
684 685 686
    full_name = name + '(' + way + ')'

    try:
687 688 689 690
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
691

692 693
        if config.use_threads:
            t.lock.release()
694 695 696 697

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
698
                result = runCmdFor(name, 'cd ' + getTestOpts().testdir + ' && ' + preCmd)
699 700 701 702 703
                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
704 705 706
        try:
            result = apply(func, [name,way] + args)
        finally:
707 708
            if config.use_threads:
                t.lock.acquire()
709

710 711
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail':
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
712

713 714 715 716 717 718
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
719 720
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
721
                t.n_expected_passes = t.n_expected_passes + 1
722 723 724 725
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
726 727 728
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
729
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
730
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
731 732
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
733 734
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
735 736
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
737 738
            else:
                t.n_expected_failures = t.n_expected_failures + 1
739 740 741 742
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
743 744
        else:
            framework_fail(name, way, 'bad result ' + passFail)
745
    except:
746
        framework_fail(name, way, 'do_test exception')
747 748
        traceback.print_exc()

749
def addPassingTestInfo (testInfos, directory, name, way):
750 751 752 753 754 755 756 757 758 759
    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)

760 761 762 763 764 765 766 767 768 769 770 771 772 773
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)

774
def skiptest (name, way):
775 776
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
777 778 779 780
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
781

782 783 784
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
785
    t.n_framework_failures = t.n_framework_failures + 1
786 787 788 789
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
790

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

805 806 807 808
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
809 810 811 812 813 814
#
# 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.
815

816
def run_command( name, way, cmd ):
817
    return simple_run( name, '', cmd, '' )
818

819 820 821 822
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
823
    # filter out -fforce-recomp from compiler_always_flags, because we're
824
    # actually testing the recompilation behaviour in the GHCi tests.
825
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
826
    flags.append(getTestOpts().extra_hc_opts)
827 828 829 830 831 832

    # 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 + "'" + \
833
          ' --interactive -v0 -ignore-dot-ghci ' + \
834 835
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
836
    getTestOpts().stdin = script
837
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
838

839 840 841 842
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
843
    return do_compile( name, way, 0, '', [], extra_hc_opts )
844 845

def compile_fail( name, way, extra_hc_opts ):
846
    return do_compile( name, way, 1, '', [], extra_hc_opts )
847 848

def multimod_compile( name, way, top_mod, extra_hc_opts ):
849
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
850

851
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
852 853 854 855 856 857 858 859 860
    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 ):
861 862
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
863 864 865 866 867 868

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

869 870 871
    force = 0
    if extra_mods:
       force = 1
872 873
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

874
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
875
        return result
876 877 878 879 880

    # 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
881
    if getTestOpts().with_namebase == None:
882 883
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
884
        namebase = getTestOpts().with_namebase
885 886

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
887 888
    actual_stderr_file = qualify(name, 'comp.stderr')

889 890
    if not compare_outputs('stderr', \
                           two_normalisers(two_normalisers(getTestOpts().extra_errmsg_normaliser, normalise_errmsg), normalise_whitespace), \
891
                           expected_stderr_file, actual_stderr_file):
892
        return failBecause('stderr mismatch')
893 894

    # no problems found, this test passed
895
    return passed()
896 897 898 899

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

900
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
901 902 903
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

904 905 906 907
    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
908

909
    if way == 'ghci': # interpreted...
910
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
911
    elif way == 'extcore' or way == 'optextcore' :
912
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
913
    else: # compiled...
dterei's avatar
dterei committed
914 915 916 917
        force = 0
        if extra_mods:
           force = 1

918
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
919
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
920
            return result
921

922 923
        cmd = './' + name;

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

927
def compile_and_run( name, way, extra_hc_opts ):
928
    return compile_and_run__( name, way, '', [], extra_hc_opts)
929 930

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

933 934
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)
935

Ian Lynagh's avatar
Ian Lynagh committed
936 937 938 939
# -----------------------------------------------------------------------------
# Check -t stats info

def checkStats(stats_file, num_fields):
940
    result = passed()
941
    if len(num_fields) > 0:
Ian Lynagh's avatar
Ian Lynagh committed
942 943 944 945
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

946
        for (field, (min, max)) in num_fields.items():
Ian Lynagh's avatar
Ian Lynagh committed
947 948 949
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
950
                result = failBecause('no such stats field')
Ian Lynagh's avatar
Ian Lynagh committed
951 952 953 954 955 956
            val = int(m.group(1))

            if val < min:
                print field, val, 'is less than minimum allowed', min
                print 'If this is because you have improved GHC, please'
                print 'update the test so that GHC doesn\'t regress again'
957
                result = failBecause('stat too good')
Ian Lynagh's avatar
Ian Lynagh committed
958 959
            if val > max:
                print field, val, 'is more than maximum allowed', max
960
                result = failBecause('stat not good enough')
Ian Lynagh's avatar
Ian Lynagh committed
961

962
    return result
Ian Lynagh's avatar
Ian Lynagh committed
963

964 965 966
# -----------------------------------------------------------------------------
# Build a single-module program

967 968 969
def extras_build( way, extra_mods, extra_hc_opts ):
    for modopts in extra_mods:
        mod, opts = modopts
970 971 972
        result = simple_build( mod, way, opts + ' ' + extra_hc_opts, 0, '', 0, 0, 0)
        if not (mod.endswith('.hs') or mod.endswith('.lhs')):
            extra_hc_opts += ' ' + replace_suffix(mod, 'o')
973 974 975 976 977 978 979
        if badResult(result):
            return result

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


def simple_build( name, way, extra_hc_opts, should_fail, top_mod, link, addsuf, noforce ):
Ian Lynagh's avatar
Ian Lynagh committed
980
    opts = getTestOpts()
981
    errname = add_suffix(name, 'comp.stderr')
982 983
    rm_no_fail( qualify(errname, '') )

984 985
    if top_mod != '':
        srcname = top_mod
986 987 988 989
        rm_no_fail( qualify(name, '') )
        base, suf = os.path.splitext(top_mod)
        rm_no_fail( qualify(base, '') )
        rm_no_fail( qualify(base, 'exe') )
dterei's avatar
dterei committed
990
    elif addsuf:
Ian Lynagh's avatar
Ian Lynagh committed
991
        srcname = add_hs_lhs_suffix(name)
992
        rm_no_fail( qualify(name, '') )
dterei's avatar
dterei committed
993 994
    else:
        srcname = name
995 996 997
        rm_no_fail( qualify(name, 'o') )

    rm_no_fail( qualify(replace_suffix(srcname, "o"), '') )
998 999 1000

    to_do = ''
    if top_mod != '':
1001 1002 1003
        to_do = '--make '
        if link:
            to_do = to_do + '-o ' + name
1004 1005
    elif link:
        to_do = '-o ' + name
Ian Lynagh's avatar
Ian Lynagh committed
1006
    elif opts.compile_to_hc:
1007 1008 1009 1010
        to_do = '-C'
    else:
        to_do = '-c' # just compile

Ian Lynagh's avatar
Ian Lynagh committed
1011
    stats_file = name + '.comp.stats'
1012
    if len(opts.compiler_stats_num_fields) > 0:
1013
        extra_hc_opts += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
1014

1015 1016 1017 1018 1019 1020
    # Required by GHC 7.3+, harmless for earlier versions:
    if (getTestOpts().c_src or
        getTestOpts().objc_src or
        getTestOpts().objcpp_src):
        extra_hc_opts += ' -no-hs-main '

Ian Lynagh's avatar
Ian Lynagh committed
1021 1022 1023 1024 1025
    if getTestOpts().compile_cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().compile_cmd_prefix + ' '

1026 1027 1028 1029
    comp_flags = config.compiler_always_flags
    if noforce:
        comp_flags = filter(lambda f: f != '-fforce-recomp', comp_flags)

Ian Lynagh's avatar
Ian Lynagh committed
1030
    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
1031
          + config.compiler + "' " \
1032
          + join(comp_flags,' ') + ' ' \
1033 1034
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
1035
          + extra_hc_opts + ' ' \
Ian Lynagh's avatar
Ian Lynagh committed
1036
          + opts.extra_hc_opts + ' ' \
1037
          + '>' + errname + ' 2>&1'
1038