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

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

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

22
from string import join
23
from testglobals import *
24 25
from testutil import *

26 27 28
if config.use_threads:
    import threading
    import thread
29 30 31 32 33 34 35 36 37 38 39 40 41

# 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).
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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

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

83 84 85
def reqlib( lib ):
    return lambda opts, l=lib: _reqlib (opts, l )

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

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

113 114 115 116
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
117 118 119 120
def req_interp( opts ):
    if not config.have_interp:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
121 122 123 124 125 126
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

127 128 129
def ignore_output( opts ):
    opts.ignore_output = 1

130 131 132
def no_stdin( opts ):
    opts.no_stdin = 1

133 134 135 136 137 138 139 140
# -----

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
141 142 143 144
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
145
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
146

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

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

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

# -----

157 158 159 160 161 162 163 164
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

165 166 167 168 169 170 171 172
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
173 174 175 176 177
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
178
        opts.skip = 1
ross's avatar
ross committed
179 180 181 182 183 184 185 186

# -----

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
187
        opts.skip = 1
ross's avatar
ross committed
188 189 190

# -----

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
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

213 214 215 216 217 218 219 220
# -----

def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

221 222
# -----

223 224
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
225

226 227
def _stats_num_field( opts, f, x, y ):
    opts.stats_num_fields = opts.stats_num_fields + [(f, x, y)]
228

Ian Lynagh's avatar
Ian Lynagh committed
229 230 231 232 233 234
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 ):
    opts.compiler_stats_num_fields = opts.compiler_stats_num_fields + [(f, x, y)]

235 236
# -----

237
def skip_if_no_ghci(opts):
dterei's avatar
dterei committed
238 239
    if not ('ghci' in config.run_ways):
        opts.skip = 1
240

241 242 243
# ----

def skip_if_fast(opts):
dterei's avatar
dterei committed
244 245
    if config.fast:
        opts.skip = 1
246

Simon Marlow's avatar
Simon Marlow committed
247 248
# -----

249
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
250
    if config.platform == plat:
251
        return f
252 253 254
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
255 256 257 258 259 260
def if_not_platform( plat, f ):
    if config.platform != plat:
        return f
    else:
        return normal

261 262 263
def if_os( os, f ):
    if config.os == os:
        return f
264 265 266
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
267 268 269 270 271 272
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

273 274 275 276 277 278
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
279
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
280
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
281 282 283 284
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
285 286 287 288 289 290 291 292 293 294 295 296
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

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

297 298
# ---

299 300 301 302 303 304 305 306 307 308 309 310
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

311 312 313 314 315
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
316 317 318 319 320 321

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

323 324 325 326 327 328
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
329
def if_compiler_lt( compiler, version, f ):
330
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
331 332 333 334
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
335

Ian Lynagh's avatar
Ian Lynagh committed
336
def if_compiler_le( compiler, version, f ):
337 338
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
339 340 341
        return f
    else:
        return normal
342

Ian Lynagh's avatar
Ian Lynagh committed
343
def if_compiler_gt( compiler, version, f ):
344
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
345 346 347 348
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
349

Ian Lynagh's avatar
Ian Lynagh committed
350
def if_compiler_ge( compiler, version, f ):
351
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
352 353 354 355
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
356

Ian Lynagh's avatar
Ian Lynagh committed
357 358
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
359

Ian Lynagh's avatar
Ian Lynagh committed
360 361
def _namebase( opts, nb ):
    opts.with_namebase = nb
362

363 364
# ---

365
def if_tag( tag, f ):
366
    if tag in config.compiler_tags:
367 368 369
        return f
    else:
        return normal
370

371
def unless_tag( tag, f ):
372
    if not (tag in config.compiler_tags):
373 374 375
        return f
    else:
        return normal
376

ei@vuokko.info's avatar
ei@vuokko.info committed
377
# ---
378 379
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
380

Ian Lynagh's avatar
Ian Lynagh committed
381 382 383 384
# ---
def literate( opts ):
    opts.literate = 1;

385 386 387
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
388 389 390
def objc_src( opts ):
    opts.objc_src = 1;

391 392 393
def objcpp_src( opts ):
    opts.objcpp_src = 1;

394 395
# ----

396 397 398 399 400 401 402 403
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

404 405 406 407 408 409 410 411
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

412 413 414 415 416 417
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

def _cmd_prefix( opts, prefix ):
    opts.cmd_prefix = prefix

418 419
# ----

Ian Lynagh's avatar
Ian Lynagh committed
420 421 422 423 424 425 426 427
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

# ----

428 429 430
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

431 432 433 434 435 436
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

437 438 439
# ----
# Function for composing two opt-fns together

440 441 442
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

443 444 445
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

446
def _compose( opts, f, g ):
447 448 449 450 451 452 453
    f(opts)
    g(opts)

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

def newTestDir( dir ):
454
    global thisdir_testopts
455 456
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
457
    thisdir_testopts.testdir = dir
458 459 460 461

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

462
allTests = []
463
allTestNames = set([])
464 465

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
466
    n = 1
467 468 469 470

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

ei@vuokko.info's avatar
ei@vuokko.info committed
471
    setup(opts)
472

473
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
474
        n = config.threads
475

ei@vuokko.info's avatar
ei@vuokko.info committed
476 477
    ok = 0

478
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
479
        t.thread_pool.acquire()
480 481 482 483 484 485 486 487 488 489 490 491
        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)
492

493
# name  :: String
494
# setup :: TestOpts -> IO ()
495 496
def test (name, setup, func, args):
    global allTests
497 498 499
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
500 501
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
502
    allTestNames.add(name)
503

504 505 506 507 508 509 510 511 512 513 514
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()
515

516 517 518 519 520 521 522 523 524 525
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
526 527 528
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
529

530
    package_conf_cache_file_start_timestamp = get_package_cache_timestamp()
531

532
    # All the ways we might run this test
533
    if func == compile or func == multimod_compile:
534
        all_ways = config.compile_ways
dterei's avatar
dterei committed
535
    elif func == compile_and_run or func == multimod_compile_and_run or func == multisrc_compile_and_run:
536
        all_ways = config.run_ways
537 538
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
539
            all_ways = ['ghci']
540
        else:
541
            all_ways = []
542
    else:
543 544
        all_ways = ['normal']

545 546 547
    # 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)
548

549 550 551
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
552
        not getTestOpts().skip \
553
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
554
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
555
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
556
        and way not in getTestOpts().omit_ways
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

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

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

573
    if getTestOpts().cleanup != '':
Ian Lynagh's avatar
Ian Lynagh committed
574 575 576 577 578 579 580 581 582
        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',
Ian Lynagh's avatar
Ian Lynagh committed
583
                   '.stats', '.comp.stats',
Ian Lynagh's avatar
Ian Lynagh committed
584 585 586 587 588 589
                   '.hi', '.o', '.prof', '.exe.prof', '.hc',
                   '_stub.h', '_stub.c', '_stub.o',
                   '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))

        clean(getTestOpts().clean_files)

590 591 592 593 594 595 596
        try:
            cleanCmd = getTestOpts().clean_cmd
            if cleanCmd != None:
                result = runCmd('cd ' + getTestOpts().testdir + ' && ' + cleanCmd)
                if result != 0:
                    framework_fail(name, 'cleaning', 'clean-command failed: ' + str(result))
        except e:
597 598
            framework_fail(name, 'cleaning', 'clean-command exception')

599
    package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
600 601 602

    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))
603

604 605 606 607
def clean(strs):
    for str in strs:
        for name in glob.glob(in_testdir(str)):
            clean_full_path(name)
608

609
def clean_full_path(name):
Ian Lynagh's avatar
Ian Lynagh committed
610 611 612 613
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
614
            try:
Ian Lynagh's avatar
Ian Lynagh committed
615 616 617 618 619 620 621 622 623 624 625
                # ... 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
626

627
def do_test(name, way, func, args):
628 629 630
    full_name = name + '(' + way + ')'

    try:
631 632 633 634
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
635

636 637
        if config.use_threads:
            t.lock.release()
638 639 640 641 642 643 644 645 646 647

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
                result = runCmd('cd ' + getTestOpts().testdir + ' && ' + preCmd)
                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
648 649 650
        try:
            result = apply(func, [name,way] + args)
        finally:
651 652
            if config.use_threads:
                t.lock.acquire()
653

654 655
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail':
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
656

657 658 659 660 661 662
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
663 664
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
665
                t.n_expected_passes = t.n_expected_passes + 1
666 667 668 669
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
670 671 672
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
673
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
674
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
675 676
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
677 678
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
679 680
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
681 682
            else:
                t.n_expected_failures = t.n_expected_failures + 1
683 684 685 686
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
687 688
        else:
            framework_fail(name, way, 'bad result ' + passFail)
689
    except:
690
        framework_fail(name, way, 'do_test exception')
691 692
        traceback.print_exc()

693
def addPassingTestInfo (testInfos, directory, name, way):
694 695 696 697 698 699 700 701 702 703
    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)

704 705 706 707 708 709 710 711 712 713 714 715 716 717
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)

718
def skiptest (name, way):
719 720
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
721 722 723 724
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
725

726 727 728
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
729
    t.n_framework_failures = t.n_framework_failures + 1
730 731 732 733
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
734

735 736 737 738 739 740 741 742 743 744 745 746 747 748
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}

749 750 751 752
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
753 754 755 756 757 758
#
# 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.
759

760
def run_command( name, way, cmd ):
761
    return simple_run( name, '', cmd, '' )
762

763 764 765 766
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
767
    # filter out -fforce-recomp from compiler_always_flags, because we're
768
    # actually testing the recompilation behaviour in the GHCi tests.
769
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
770
    flags.append(getTestOpts().extra_hc_opts)
771 772 773 774 775 776

    # 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 + "'" + \
777
          ' --interactive -v0 -ignore-dot-ghci ' + \
778 779
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
780
    getTestOpts().stdin = script
781
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
782

783 784 785 786
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
787
    return do_compile( name, way, 0, '', [], extra_hc_opts )
788 789

def compile_fail( name, way, extra_hc_opts ):
790
    return do_compile( name, way, 1, '', [], extra_hc_opts )
791 792

def multimod_compile( name, way, top_mod, extra_hc_opts ):
793
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
794

795
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
796 797 798 799 800 801 802 803 804
    return do_compile( name, way, 1, top_mod, [], extra_hc_opts )

def multisrc_compile( name, way, top_mod, extra_mods, extra_hc_opts ):
    extra_mods = map ((lambda y : (y, '')), extra_mods)
    return do_compile( name, way, 0, top_mod, extra_mods, extra_hc_opts)

def multisrc_compile_fail( name, way, top_mod, extra_mods, extra_hc_opts ):
    extra_mods = map ((lambda y : (y, '')), extra_mods)
    return do_compile( name, way, 1, top_mod, extra_mods, extra_hc_opts)
805

806 807 808 809 810 811 812
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 ):
813 814
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
815 816 817 818 819 820

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

821 822 823
    force = 0
    if extra_mods:
       force = 1
824 825
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

826
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
827
        return result
828 829 830 831 832

    # 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
833
    if getTestOpts().with_namebase == None:
834 835
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
836
        namebase = getTestOpts().with_namebase
837 838

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
839 840
    actual_stderr_file = qualify(name, 'comp.stderr')

841 842
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
843
        return failBecause('stderr mismatch')
844 845

    # no problems found, this test passed
846
    return passed()
847 848 849 850

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

851
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
852 853 854
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

855 856 857 858
    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
859

860
    if way == 'ghci': # interpreted...
861
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
862
    elif way == 'extcore' or way == 'optextcore' :
863
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
864
    else: # compiled...
dterei's avatar
dterei committed
865 866 867 868
        force = 0
        if extra_mods:
           force = 1

869
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
870
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
871
            return result
872

873
        cmd = './' + name;
874 875
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
876

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

880
def compile_and_run( name, way, extra_hc_opts ):
881
    return compile_and_run__( name, way, '', [], extra_hc_opts)
882 883

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
884
    return compile_and_run__( name, way, top_mod, [], extra_hc_opts)
dterei's avatar
dterei committed
885 886

def multisrc_compile_and_run( name, way, top_mod, extra_mods, extra_hc_opts ):
887 888 889 890 891
    extra_mods = map ((lambda y : (y, '')), extra_mods)
    return compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts)

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)
892

Ian Lynagh's avatar
Ian Lynagh committed
893 894 895 896
# -----------------------------------------------------------------------------
# Check -t stats info

def checkStats(stats_file, num_fields):
897
    result = passed()
Ian Lynagh's avatar
Ian Lynagh committed
898 899 900 901 902 903 904 905 906
    if num_fields != []:
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

        for (field, min, max) in num_fields:
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
907
                result = failBecause('no such stats field')
Ian Lynagh's avatar
Ian Lynagh committed
908 909 910 911 912 913
            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'
914
                result = failBecause('stat too good')
Ian Lynagh's avatar
Ian Lynagh committed
915 916
            if val > max:
                print field, val, 'is more than maximum allowed', max
917
                result = failBecause('stat not good enough')
Ian Lynagh's avatar
Ian Lynagh committed
918

919
    return result
Ian Lynagh's avatar
Ian Lynagh committed
920

921 922 923
# -----------------------------------------------------------------------------
# Build a single-module program

924 925 926 927 928 929 930 931 932 933 934 935 936
def extras_build( way, extra_mods, extra_hc_opts ):
    for modopts in extra_mods:
        mod, opts = modopts
        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')
        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
937
    opts = getTestOpts()
938
    errname = add_suffix(name, 'comp.stderr')
939 940
    rm_no_fail( qualify(errname, '') )

941 942
    if top_mod != '':
        srcname = top_mod
943 944 945 946
        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
947
    elif addsuf:
Ian Lynagh's avatar
Ian Lynagh committed
948
        srcname = add_hs_lhs_suffix(name)
949
        rm_no_fail( qualify(name, '') )
dterei's avatar
dterei committed
950 951
    else:
        srcname = name
952 953 954
        rm_no_fail( qualify(name, 'o') )

    rm_no_fail( qualify(replace_suffix(srcname, "o"), '') )
955 956 957

    to_do = ''
    if top_mod != '':
958 959 960
        to_do = '--make '
        if link:
            to_do = to_do + '-o ' + name
961 962
    elif link:
        to_do = '-o ' + name
Ian Lynagh's avatar
Ian Lynagh committed
963
    elif opts.compile_to_hc:
964 965 966 967
        to_do = '-C'
    else:
        to_do = '-c' # just compile

Ian Lynagh's avatar
Ian Lynagh committed
968 969
    stats_file = name + '.comp.stats'
    if opts.compiler_stats_num_fields != []:
970
        extra_hc_opts += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
971

Ian Lynagh's avatar
Ian Lynagh committed
972 973 974 975 976
    if getTestOpts().compile_cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().compile_cmd_prefix + ' '

977 978 979 980
    comp_flags = config.compiler_always_flags
    if noforce: