testlib.py 42.2 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 97 98 99 100 101 102 103 104 105 106 107 108 109 110
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
            p = subprocess.Popen([config.ghc_pkg, 'describe', lib],
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.PIPE)
            # read from stdout and stderr to avoid blocking due to
            # buffers filling
            p.communicate()
            r = p.wait()
        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 121 122
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

123 124 125
def ignore_output( opts ):
    opts.ignore_output = 1

126 127 128
def no_stdin( opts ):
    opts.no_stdin = 1

129 130 131 132 133 134 135 136
# -----

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
137 138 139 140
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
141
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
142

143 144 145 146 147 148 149 150 151 152
# -----

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

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

# -----

153 154 155 156 157 158 159 160
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

161 162 163 164 165 166 167 168
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
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
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:
	opts.skip = 1

# -----

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:
	opts.skip = 1

# -----

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
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

209 210 211 212 213 214 215 216
# -----

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

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

217 218
# -----

219 220 221 222 223 224 225 226 227 228
def space( field, min, max ):
    return lambda opts, f=field, n=min, x=max: _space(opts, f, n, x);

def _space( opts, f, n, x ):
    opts.space_field = f
    opts.space_min = n
    opts.space_max = x

# -----

229 230 231 232
def skip_if_no_ghci(opts):
  if not ('ghci' in config.run_ways):
      opts.skip = 1

233 234 235 236 237 238
# ----

def skip_if_fast(opts):
  if config.fast:
      opts.skip = 1

Simon Marlow's avatar
Simon Marlow committed
239 240
# -----

241
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
242
    if config.platform == plat:
243
        return f
244 245 246 247 248 249
    else:
        return normal

def if_os( os, f ):
    if config.os == os:
        return f
250 251 252
    else:
        return normal

253 254
# ---

255 256 257 258 259 260
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
261
def if_compiler_lt( compiler, version, f ):
262
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
263 264 265 266
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
267

Ian Lynagh's avatar
Ian Lynagh committed
268
def if_compiler_le( compiler, version, f ):
269 270
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
271 272 273
        return f
    else:
        return normal
274

Ian Lynagh's avatar
Ian Lynagh committed
275
def if_compiler_gt( compiler, version, f ):
276
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
277 278 279 280
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
281

Ian Lynagh's avatar
Ian Lynagh committed
282
def if_compiler_ge( compiler, version, f ):
283
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
284 285 286 287
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
288

Ian Lynagh's avatar
Ian Lynagh committed
289 290
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
291

Ian Lynagh's avatar
Ian Lynagh committed
292 293
def _namebase( opts, nb ):
    opts.with_namebase = nb
294

295 296
# ---

297
def if_tag( tag, f ):
298
    if tag in config.compiler_tags:
299 300 301
        return f
    else:
        return normal
302

303
def unless_tag( tag, f ):
304
    if not (tag in config.compiler_tags):
305 306 307
        return f
    else:
        return normal
308

ei@vuokko.info's avatar
ei@vuokko.info committed
309
# ---
310 311
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
312

Ian Lynagh's avatar
Ian Lynagh committed
313 314 315 316
# ---
def literate( opts ):
    opts.literate = 1;

317 318 319
def c_src( opts ):
    opts.c_src = 1;

320 321 322 323 324 325 326 327
# ----

def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

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

328 329 330 331 332
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

333 334 335 336 337 338
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

339 340 341
# ----
# Function for composing two opt-fns together

342 343 344
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

def _compose( opts, f, g ):    
    f(opts)
    g(opts)

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

global testdir
testdir = '.'

def newTestDir( dir ):
    global testdir, thisdir_testopts
    testdir = dir
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)

def getTestDir():
    return testdir

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

# name  :: String
# setup :: TestOpts -> IO ()  
ei@vuokko.info's avatar
ei@vuokko.info committed
372 373 374
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
375 376 377 378

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

ei@vuokko.info's avatar
ei@vuokko.info committed
379
    setup(opts)
380

381
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
382
        n = config.threads
383

ei@vuokko.info's avatar
ei@vuokko.info committed
384 385
    ok = 0

386
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
387
        t.thread_pool.acquire()
388 389 390 391 392 393 394 395 396 397 398 399
        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)
400

401 402 403 404 405 406 407 408 409 410 411
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()
412
    
ei@vuokko.info's avatar
ei@vuokko.info committed
413 414 415
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
416
    # All the ways we might run this test
417
    if func == compile or func == multimod_compile:
418
        all_ways = config.compile_ways
419
    elif func == compile_and_run or func == multimod_compile_and_run:
420
        all_ways = config.run_ways
421 422
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
423
            all_ways = ['ghci']
424
        else:
425
            all_ways = []
426
    else:
427 428
        all_ways = ['normal']

429 430 431
    # 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)
432

433 434 435
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
436
        not getTestOpts().skip \
437
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
438
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
439
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
440
        and way not in getTestOpts().omit_ways
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455

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

457
    clean(map (lambda suff: name + suff,
Ian Lynagh's avatar
Ian Lynagh committed
458
              ['', '.exe', '.exe.manifest', '.genscript',
459
               '.stderr.normalised',        '.stdout.normalised',
Ian Lynagh's avatar
Ian Lynagh committed
460 461 462 463
               '.run.stderr',               '.run.stdout',
               '.run.stderr.normalised',    '.run.stdout.normalised',
               '.comp.stderr',              '.comp.stdout',
               '.comp.stderr.normalised',   '.comp.stdout.normalised',
464 465
               '.interp.stderr',            '.interp.stdout',
               '.interp.stderr.normalised', '.interp.stdout.normalised',
466
               '.stats',
Ian Lynagh's avatar
Ian Lynagh committed
467
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
Simon Marlow's avatar
Simon Marlow committed
468
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))
469

470 471
    clean(getTestOpts().clean_files)

472 473 474 475 476 477 478
def clean(names):
    clean_full_paths(map (lambda name: in_testdir(name), names))

def clean_o_hi():
    clean_full_paths(glob.glob(in_testdir('*.o')) + glob.glob(in_testdir('*.hi')))

def clean_full_paths(names):
ei@vuokko.info's avatar
ei@vuokko.info committed
479
    if getTestOpts().cleanup != '':
480
        for name in names:
481
            try:
482
                # Remove files...
483
                os.remove(name)
484
            except OSError, e1:
485 486 487
                try:
                    # ... and empty directories
                    os.rmdir(name)
488 489 490 491 492 493 494 495 496
                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
497

498
def do_test(name, way, func, args):
499 500 501 502 503
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
504 505
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
506 507 508
        try:
            result = apply(func, [name,way] + args)
        finally:
509 510
            if config.use_threads:
                t.lock.acquire()
511
        
ei@vuokko.info's avatar
ei@vuokko.info committed
512
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
513
           result != 'pass' and result != 'fail':
514
            framework_fail(name, way, 'bad results ' + result)
515 516

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
517 518
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
519
                t.n_expected_passes = t.n_expected_passes + 1
520 521 522 523
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
524 525 526
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
527 528 529 530
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
531
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
532 533
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
534 535
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
536 537 538 539
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
540 541
            else:
                t.n_expected_failures = t.n_expected_failures + 1
542 543 544 545
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
546
    except:
547
        framework_fail(name, way, 'do_test exception')
548 549
        traceback.print_exc()

550
def skiptest (name, way):
551 552
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
553 554 555 556
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
557

558 559 560
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
561
    t.n_framework_failures = t.n_framework_failures + 1
562 563 564 565
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
566

567 568 569 570
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
571 572 573 574 575 576
#
# 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.
577

578
def run_command( name, way, cmd ):
579
    return simple_run( name, '', cmd, '' )
580

581 582 583 584
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
585
    # filter out -fforce-recomp from compiler_always_flags, because we're
586
    # actually testing the recompilation behaviour in the GHCi tests.
587
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
588
    flags.append(getTestOpts().extra_hc_opts)
589 590 591 592 593 594

    # 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 + "'" + \
595
          ' --interactive -v0 -ignore-dot-ghci ' + \
596 597
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
598
    getTestOpts().stdin = script
599
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
600

601 602 603 604 605 606 607 608 609 610 611 612
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
    return do_compile( name, way, 0, '', extra_hc_opts )

def compile_fail( name, way, extra_hc_opts ):
    return do_compile( name, way, 1, '', extra_hc_opts )

def multimod_compile( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 0, top_mod, extra_hc_opts )

613 614 615
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
def do_compile( name, way, should_fail, top_mod, extra_hc_opts ):
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0 )
    
    if should_fail:
        if result == 0:
            return 'fail'
    else:
        if result != 0:
            return 'fail'

    # 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
632
    if getTestOpts().with_namebase == None:
633 634
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
635
        namebase = getTestOpts().with_namebase
636 637

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
638 639
    actual_stderr_file = qualify(name, 'comp.stderr')

640 641 642
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
643 644 645 646 647 648 649

    # no problems found, this test passed
    return 'pass'

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

650
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
651 652 653
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

654
    if way == 'ghci': # interpreted...
655
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
656
    elif way == 'extcore' or way == 'optextcore' :
657
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
658
    else: # compiled...
659 660
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
661 662 663
        if result != 0:
            return 'fail'

664
        cmd = './' + name;
665 666
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
667

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

671 672
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
673

674 675 676 677 678 679 680 681 682 683
def compile_and_run_space( name, way, extra_hc_opts ):
    stats_file = name + '.stats'
    opts = getTestOpts()
    opts.extra_run_opts += ' +RTS -t' + stats_file + " --machine-readable -RTS"
    setLocalTestOpts(opts)

    result = compile_and_run__( name, way, extra_hc_opts, '')
    if result != 'pass':
        return 'fail'

684
    f = open(in_testdir(stats_file))
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
    contents = f.read()
    f.close()

    m = re.search('\("' + opts.space_field + '", "([0-9]+)"\)', contents)
    if m == None:
        print "Failed to find space field: ", opts.space_field
        return 'fail'
    val = int(m.group(1))

    if val < opts.space_min:
        print 'Space usage ', val, \
              ' less than minimum allowed ', opts.space_min
        return 'fail'
    if val > opts.space_max:
        print 'Space usage ', val, \
              ' more than maximum allowed ', opts.space_max
        return 'fail'
    else:
        return 'pass';

705
def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
706
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
707

708 709 710 711 712 713 714 715 716 717 718
# -----------------------------------------------------------------------------
# Build a single-module program

def simple_build( name, way, extra_hc_opts, should_fail, top_mod, link ):
    errname = add_suffix(name, 'comp.stderr')
    rm_no_fail( errname )
    rm_no_fail( name )
    
    if top_mod != '':
        srcname = top_mod
    else:
Ian Lynagh's avatar
Ian Lynagh committed
719
        srcname = add_hs_lhs_suffix(name)
720 721 722 723 724 725

    to_do = ''
    if top_mod != '':
        to_do = '--make -o ' + name
    elif link:
        to_do = '-o ' + name
ei@vuokko.info's avatar
ei@vuokko.info committed
726
    elif getTestOpts().compile_to_hc:
727 728 729 730 731 732 733 734
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
735 736
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
737
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
738
          + getTestOpts().extra_hc_opts + ' ' \
739
          + '>' + errname + ' 2>&1'
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758

    result = runCmd(cmd)

    if result != 0 and not should_fail:
        actual_stderr = qualify(name, 'comp.stderr')
        if_verbose(1,'Compile failed (status ' + `result` + ') errors were:')
        if_verbose(1,open(actual_stderr).read())

    # ToDo: if the sub-shell was killed by ^C, then exit

    return result

# -----------------------------------------------------------------------------
# Run a program and check its output
#
# If testname.stdin exists, route input from that, else
# from /dev/null.  Route output to testname.run.stdout and 
# testname.run.stderr.  Returns the exit code of the run.

759
def simple_run( name, way, prog, args ):
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
    opts = getTestOpts()

    # figure out what to use for stdin
    if opts.stdin != '':
        use_stdin = opts.stdin
    else:
        stdin_file = add_suffix(name, 'stdin')
        if os.path.exists(in_testdir(stdin_file)):
            use_stdin = stdin_file
        else:
            use_stdin = '/dev/null'

    run_stdout = add_suffix(name,'run.stdout')
    run_stderr = add_suffix(name,'run.stderr')

    rm_no_fail(qualify(name,'run.stdout'))
    rm_no_fail(qualify(name,'run.stderr'))
    rm_no_fail(qualify(name, 'hp'))
    rm_no_fail(qualify(name,'ps'))
    rm_no_fail(qualify(name, 'prof'))
780
   
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
    my_rts_flags = rts_flags(way)

    if opts.no_stdin:
        stdin_comes_from = ''
    else:
        stdin_comes_from = ' <' + use_stdin
    cmd = 'cd ' + testdir + ' && ' \
	    + prog + ' ' + args + ' '  \
        + my_rts_flags + ' '       \
        + stdin_comes_from         \
        + ' >' + run_stdout        \
        + ' 2>' + run_stderr

    # run the command
    result = runCmd(cmd)

    exit_code = result >> 8
    signal    = result & 0xff

    # check the exit code
    if exit_code != opts.exit_code:
        print 'Wrong exit code (expected', opts.exit_code, ', actual', exit_code, ')'
        dump_stdout(name)
        dump_stderr(name)
        return 'fail'

    check_hp = my_rts_flags.find("-h") != -1
    check_prof = my_rts_flags.find("-p") != -1

810 811 812 813 814
    if not opts.ignore_output:
        if not check_stderr_ok(name):
            return 'fail'
        if not check_stdout_ok(name):
            return 'fail'
815
        # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
816 817 818 819 820 821
        if check_hp and (exit_code <= 127 or exit_code == 251) and not check_hp_ok(name):
            return 'fail'
        if check_prof and not check_prof_ok(name):
            return 'fail'

    return 'pass'
822

823 824 825 826 827 828 829 830 831 832 833
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

    if args == []:
        return ''
    else:
        return '+RTS ' + join(args,' ') + ' -RTS'

834 835 836
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

837
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
838 839 840 841 842 843
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
844 845 846 847 848
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

849
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
850
        srcname = add_hs_lhs_suffix(name)
851 852 853
    else:
        srcname = top_mod
        
854
    scriptname = add_suffix(name, 'genscript')
855 856 857 858 859 860 861 862 863 864
    qscriptname = in_testdir(scriptname)
    rm_no_fail(qscriptname)

    delimiter = '===== program output begins here\n'

    script = open(qscriptname, 'w')
    if not compile_only:
        # set the prog name and command-line args to match the compiled
        # environment.
        script.write(':set prog ' + name + '\n')
ei@vuokko.info's avatar
ei@vuokko.info committed
865
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
866 867 868 869
        # Add marker lines to the stdout and stderr output files, so we
        # can separate GHCi's output from the program's.
        script.write(':! echo ' + delimiter)
        script.write(':! echo 1>&2 ' + delimiter)
870 871
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
872 873
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
874
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
875 876
    script.close()

877
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
878 879
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
880 881 882
    else:
        stdin_file = qualify(name, 'stdin')

883 884 885 886
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
887 888
    script.close()

889
    cmd = 'cd ' + testdir + " && " + cmd_prefix + "'" \
890 891 892 893 894
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
895
          + getTestOpts().extra_hc_opts + ' ' \
896 897 898 899
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

900 901 902
    exit_code = result >> 8
    signal    = result & 0xff

903 904 905 906 907 908 909 910
    # split the stdout into compilation/program output
    split_file(in_testdir(outname), delimiter,
               qualify(name, 'comp.stdout'),
               qualify(name, 'run.stdout'))
    split_file(in_testdir(errname), delimiter,
               qualify(name, 'comp.stderr'),
               qualify(name, 'run.stderr'))

911 912 913 914 915 916 917
    # check the exit code
    if exit_code != getTestOpts().exit_code:
        print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
        dump_stdout(name)
        dump_stderr(name)
        return 'fail'

918 919
    # ToDo: if the sub-shell was killed by ^C, then exit

920 921
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
922 923 924 925 926 927 928 929 930 931 932
        return 'pass'
    else:
        return 'fail'


def split_file(in_fn, delimiter, out1_fn, out2_fn):
    infile = open(in_fn)
    out1 = open(out1_fn, 'w')
    out2 = open(out2_fn, 'w')

    line = infile.readline()
933
    line = re.sub('\r', '', line) # ignore Windows EOL
934
    while (re.sub('^\s*','',line) != delimiter and line != ''):
935 936
        out1.write(line)
        line = infile.readline()
937
	line = re.sub('\r', '', line)
938
    out1.close()
939 940 941 942 943

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
944
    out2.close()
945
    
krc's avatar
krc committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
# -----------------------------------------------------------------------------
# Generate External Core for the given program, then compile the resulting Core
# and compare its output to the expected output

def extcore_run( name, way, extra_hc_opts, compile_only, top_mod ):
 
    depsfilename = qualify(name, 'deps')
    errname = add_suffix(name, 'comp.stderr')
    qerrname = qualify(errname,'')
    
    hcname = qualify(name, 'hc')
    oname = qualify(name, 'o')
    
    rm_no_fail( qerrname )
    rm_no_fail( qualify(name, '') )

    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
963
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
    else:
        srcname = top_mod

    qcorefilename = qualify(name, 'hcr')
    corefilename = add_suffix(name, 'hcr')
    rm_no_fail(qcorefilename)

    # Generate External Core
    
    if (top_mod == ''):
        to_do = ' ' + srcname + ' '
    else:
        to_do = ' --make ' + top_mod + ' ' 

    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
983
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
          + to_do \
          + '>' + errname + ' 2>&1'
    result = runCmd(cmd)

    exit_code = result >> 8

    if exit_code != 0:
         if_verbose(1,'Compiling to External Core failed (status ' + `result` + ') errors were:')
         if_verbose(1,open(qerrname).read())
         return 'fail'

     # Compile the resulting files -- if there's more than one module, we need to read the output
     # of the previous compilation in order to find the dependencies
    if (top_mod == ''):
        to_compile = corefilename
    else:
        result = runCmd('grep Compiling ' + qerrname + ' |  awk \'{print $4}\' > ' + depsfilename)
        deps = open(depsfilename).read()
        deplist = string.replace(deps, '\n',' ');
        deplist2 = string.replace(deplist,'.lhs,', '.hcr');
        to_compile = string.replace(deplist2,'.hs,', '.hcr');
        
    flags = join(filter(lambda f: f != '-fext-core',config.way_flags[way]),' ')
    
    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + to_compile + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
1013
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
          + flags                   \
          + ' -fglasgow-exts -o ' + name \
          + '>' + errname + ' 2>&1'
          
    result = runCmd(cmd)
    exit_code = result >> 8

    if exit_code != 0:
        if_verbose(1,'Compiling External Core file(s) failed (status ' + `result` + ') errors were:')
        if_verbose(1,open(qerrname).read())
        return 'fail'

    # Clean up
    rm_no_fail ( oname )
    rm_no_fail ( hcname )
    rm_no_fail ( qcorefilename )
    rm_no_fail ( depsfilename )
    
1032
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
1033

1034 1035 1036 1037
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
1038
   if getTestOpts().with_namebase == None:
1039 1040
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
1041
       namebase = getTestOpts().with_namebase
1042

1043
   actual_stdout_file   = qualify(name, 'run.stdout')
1044
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(namebase, 'stdout')
1045

1046 1047 1048 1049 1050
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
1051

1052
   return compare_outputs('stdout', norm, getTestOpts().extra_normaliser, \
1053
                          expected_stdout_file, actual_stdout_file)
1054

1055 1056 1057 1058
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

1059
def check_stderr_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
1060
   if getTestOpts().with_namebase == None:
1061 1062
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
1063
       namebase = getTestOpts().with_namebase
1064

1065
   actual_stderr_file   = qualify(name, 'run.stderr')
1066
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
1067

1068 1069 1070 1071