testlib.py 34.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
# 
# (c) Simon Marlow 2002
#

import sys
import os
import string
import re
import traceback
import copy
11
import glob
12 13

from string import join
14
from testglobals import *
15 16
from testutil import *

17 18 19
if config.use_threads:
    import threading
    import thread
20 21 22 23 24 25 26 27 28 29 30 31 32

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

ei@vuokko.info's avatar
ei@vuokko.info committed
34
global testopts_local
35 36 37 38 39 40
if config.use_threads:
    testopts_local = threading.local()
else:
    class TestOpts_Local:
        pass
    testopts_local = TestOpts_Local()
41 42

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

ei@vuokko.info's avatar
ei@vuokko.info committed
45 46 47
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

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

74 75 76 77 78 79 80 81 82
def reqlib( lib ):
    return lambda opts, l=lib: _reqlib (opts, l )

def _reqlib( opts, lib ):
    # opts.reqlibs.append(lib)
    r = os.system(config.ghc_pkg + ' describe ' + lib + ' > /dev/null 2> /dev/null')
    if r != 0:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
83 84 85 86 87 88
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

89 90 91
def ignore_output( opts ):
    opts.ignore_output = 1

92 93 94 95 96 97 98 99
# -----

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
100 101 102 103 104 105
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 ):
    opts.expect_broken_for = ways

106 107 108 109 110 111 112 113 114 115
# -----

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

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

# -----

116 117 118 119 120 121 122 123
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

ross's avatar
ross committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
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

# -----

142 143 144 145 146 147
def expect_fail_if_platform( plat ):
   return lambda opts, p=plat: _expect_fail_if_platform(opts, p)

def _expect_fail_if_platform( opts, plat ):
    if config.platform == plat:
	opts.expect = 'fail'
148 149 150 151 152 153 154

def expect_broken_if_platform( bug, plat ):
   return lambda opts, b=bug, p=plat: _expect_broken_if_platform(opts, b, p)

def _expect_broken_if_platform( opts, bug, plat ):
    if config.platform == plat:
	opts.expect = 'fail'
155 156 157
	
# -----

ross's avatar
ross committed
158 159 160 161 162 163 164
def expect_fail_if_compiler_type( compiler_type ):
   return lambda opts, c=compiler_type: _expect_fail_if_compiler_type(opts, c)

def _expect_fail_if_compiler_type( opts, compiler_type ):
    if config.compiler_type == compiler_type:
	opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
165
def expect_broken_if_compiler_type( bug, compiler_type ):
Ian Lynagh's avatar
Ian Lynagh committed
166 167 168 169 170 171
   return lambda opts, b=bug, c=compiler_type: _expect_broken_if_compiler_type(opts, b, c)

def _expect_broken_if_compiler_type( opts, bug, compiler_type ):
    if config.compiler_type == compiler_type:
	opts.expect = 'fail'

ross's avatar
ross committed
172 173
# -----

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
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

196 197 198
def no_clean( opts ):
    opts.cleanup = '';

199 200 201 202 203 204
# -----

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

205 206 207 208 209 210
# ----

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

Simon Marlow's avatar
Simon Marlow committed
211 212 213 214 215 216 217 218 219
# -----

def skip_if_platform( plat ):
   return lambda opts, p=plat: _skip_if_platform(opts, p)

def _skip_if_platform( opts, plat ):
    if config.platform == plat:
	opts.skip = 1
	
ei@vuokko.info's avatar
ei@vuokko.info committed
220
# ---
221 222
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
223

Ian Lynagh's avatar
Ian Lynagh committed
224 225 226 227
# ---
def literate( opts ):
    opts.literate = 1;

228 229 230
def c_src( opts ):
    opts.c_src = 1;

231 232 233
# ----
# Function for composing two opt-fns together

234 235 236
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
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
264 265 266 267
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
    setup(opts)
268
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
269
        n = config.threads
270

ei@vuokko.info's avatar
ei@vuokko.info committed
271 272
    ok = 0

273
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
274
        t.thread_pool.acquire()
275 276 277 278 279 280 281 282 283 284 285 286
        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)
287

288 289 290 291 292 293 294 295 296 297 298
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()
299
    
ei@vuokko.info's avatar
ei@vuokko.info committed
300 301 302
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
303
    # All the ways we might run this test
304
    if func == compile or func == multimod_compile:
305
        all_ways = config.compile_ways
306
    elif func == compile_and_run or func == multimod_compile_and_run:
307
        all_ways = config.run_ways
308 309
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
310
            all_ways = ['ghci']
311
        else:
312
            all_ways = []
313
    else:
314 315 316 317 318
        all_ways = ['normal']

    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
319
        not getTestOpts().skip \
320
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
321 322
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
        and way not in getTestOpts().omit_ways
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337

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

339
    clean(map (lambda suff: name + suff,
Ian Lynagh's avatar
Ian Lynagh committed
340
              ['', '.exe', '.genscript', '.run.stderr', '.run.stdout',
341 342
               '.comp.stderr', '.comp.stdout',
               '.interp.stderr', '.interp.stdout',
Ian Lynagh's avatar
Ian Lynagh committed
343
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
344
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
345 346 347 348 349 350 351 352

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
353
    if getTestOpts().cleanup != '':
354
        for name in names:
355
            try:
356
                os.remove(name)
357 358
            except OSError:
                pass
359

360
def do_test(name, way, func, args):
361 362 363 364 365
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
366 367
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
368 369 370
        try:
            result = apply(func, [name,way] + args)
        finally:
371 372
            if config.use_threads:
                t.lock.acquire()
373
        
ei@vuokko.info's avatar
ei@vuokko.info committed
374
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
375
           result != 'pass' and result != 'fail':
376
            framework_fail(name, way)
377 378

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
379 380
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
381
                t.n_expected_passes = t.n_expected_passes + 1
382 383 384 385
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
386 387 388
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
389 390 391 392
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
393
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
394 395
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
396 397
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
398 399 400 401
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
402 403
            else:
                t.n_expected_failures = t.n_expected_failures + 1
404 405 406 407
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
408 409 410
    except:
        print '*** framework failure for', full_name, ':'
        traceback.print_exc()
411
        framework_fail(name, way)
412

413
def skiptest (name, way):
414 415
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
416 417 418 419
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
420

421
def framework_fail( name, way ):
422
    t.n_framework_failures = t.n_framework_failures + 1
423 424 425 426
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
427

428 429 430 431
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
432 433 434 435 436 437
#
# 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.
438

439
def run_command( name, way, cmd ):
440
    return simple_run( name, '', cmd, '' )
441

442 443 444 445
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
446 447 448 449 450 451 452 453 454
    # filter out -no-recomp from compiler_always_flags, becuase we're
    # actually testing the recompilation behaviour in the GHCi tests.
    flags = filter(lambda f: f != '-no-recomp', config.compiler_always_flags)

    # 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 + "'" + \
455
          ' --interactive -v0 ' + \
456 457
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
458
    getTestOpts().stdin = script
459
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
460

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

473 474 475
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
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).

492
    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
493 494 495 496 497 498 499 500
    actual_stderr_file = qualify(name, 'comp.stderr')
    actual_stderr = normalise_errmsg(open(actual_stderr_file).read())

    if os.path.exists(expected_stderr_file):
        expected_stderr = normalise_errmsg(open(expected_stderr_file).read())
    else:
        expected_stderr = ''
        expected_stderr_file = ''
501

502 503
    if different_outputs(expected_stderr, actual_stderr):
        print actual_stderr, '\n', expected_stderr
504 505 506 507 508 509 510 511 512
        if not outputs_differ('stderr', expected_stderr_file, actual_stderr_file):
            return 'fail'

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

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

513
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
514 515 516
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

517
    if way == 'ghci': # interpreted...
518
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
519
    elif way == 'extcore' or way == 'optextcore' :
520
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
521
    else: # compiled...
522 523
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
524 525 526 527
        if result != 0:
            return 'fail'

        # we don't check the compiler's stderr for a compile-and-run test
528
        return simple_run( name, way, './'+name, getTestOpts().extra_run_opts )
529

530 531
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '' )
532 533

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
534
    return compile_and_run__( name, way, extra_hc_opts, top_mod )
535

536 537 538 539 540 541 542 543 544 545 546
# -----------------------------------------------------------------------------
# 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
547
        srcname = add_hs_lhs_suffix(name)
548 549 550 551 552 553

    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
554
    elif getTestOpts().compile_to_hc:
555 556 557 558 559 560 561 562
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
563 564
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
565
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
566
          + getTestOpts().extra_hc_opts + ' ' \
567
          + '>' + errname + ' 2>&1'
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586

    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.

587
def simple_run( name, way, prog, args ):
588
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
589 590
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
591 592 593 594 595 596 597 598 599 600 601
   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'))
602
   rm_no_fail(qualify(name,'run.stderr'))
603 604 605 606
   rm_no_fail(qualify(name, 'hp'))
   rm_no_fail(qualify(name,'ps'))
   
   my_rts_flags = rts_flags(way)
607 608

   cmd = 'cd ' + testdir + ' && ' \
609
	  + prog + ' ' + args + ' ' \
610
          + my_rts_flags + ' ' \
611 612 613
          + ' <' + use_stdin \
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
614 615 616 617

   # run the command
   result = runCmd(cmd)

618
   exit_code = result >> 8
619 620 621
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
622 623
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
624 625
       return 'fail'

626 627
   check_hp = my_rts_flags.find("-h") != -1

628 629 630
   if getTestOpts().ignore_output or (check_stdout_ok(name) and 
                                      check_stderr_ok(name) and
                                      (not check_hp or check_hp_ok(name))):
631 632 633 634
       return 'pass'
   else:
       return 'fail'

635 636 637 638 639 640 641 642 643 644 645
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

646 647 648
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

649
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
650 651 652 653 654 655
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
656
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
657
        srcname = add_hs_lhs_suffix(name)
658 659 660
    else:
        srcname = top_mod
        
661
    scriptname = add_suffix(name, 'genscript')
662 663 664 665 666 667 668 669 670 671
    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
672
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
673 674 675 676
        # 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)
677 678
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
679 680
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
681
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
682 683
    script.close()

684
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
685 686
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
687 688 689
    else:
        stdin_file = qualify(name, 'stdin')

690 691 692 693
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
694 695 696 697 698 699 700 701
    script.close()

    cmd = 'cd ' + testdir + " && '" \
          + 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
702
          + getTestOpts().extra_hc_opts + ' ' \
703 704 705 706
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

707 708 709 710
    exit_code = result >> 8
    signal    = result & 0xff

    # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
711 712
    if exit_code != getTestOpts().exit_code:
        print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
713
        return 'fail'
714 715 716 717 718 719 720 721 722 723 724

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

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

725 726
    if getTestOpts().ignore_output or (check_stdout_ok(name) and
                                       check_stderr_ok(name)):
727 728 729 730 731 732 733 734 735 736 737
        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()
738
    line = re.sub('\r', '', line) # ignore Windows EOL
739
    while (re.sub('^\s*','',line) != delimiter and line != ''):
740 741
        out1.write(line)
        line = infile.readline()
742
	line = re.sub('\r', '', line)
743 744 745 746 747 748

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
    
krc's avatar
krc committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
# -----------------------------------------------------------------------------
# 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
766
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
    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
786
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
          + 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
816
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
          + 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 )
    
835
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
836

837 838 839 840 841
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
   actual_stdout_file   = qualify(name, 'run.stdout')
842
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(name, 'stdout')
843 844 845 846 847 848 849 850

   if os.path.exists(expected_stdout_file):
       expected_stdout = open(expected_stdout_file).read()
   else:
       expected_stdout = ''
       expected_stdout_file = ''

   if os.path.exists(actual_stdout_file):
851 852 853
       actual_stdout = open(actual_stdout_file).read()
       if not platform_specific:
           actual_stdout = normalise_output(actual_stdout)
854 855 856 857
   else:
       actual_stdout = ''
       actual_stdout_file = ''

858
   if different_outputs(actual_stdout, expected_stdout):
859 860 861 862 863 864
       return outputs_differ( 'stdout', expected_stdout_file, actual_stdout_file )
   else:
       return 1

def check_stderr_ok( name ):
   actual_stderr_file   = qualify(name, 'run.stderr')
865
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
866 867 868 869 870 871 872 873

   if os.path.exists(expected_stderr_file):
       expected_stderr = open(expected_stderr_file).read()
   else:
       expected_stderr = ''
       expected_stderr_file = ''

   if os.path.exists(actual_stderr_file):
874 875 876
       actual_stderr = open(actual_stderr_file).read()
       if not platform_specific:
           actual_stderr = normalise_output(actual_stderr)
877 878 879 880
   else:
       actual_stderr = ''
       actual_stderr_file = ''

881
   if different_outputs( actual_stderr,expected_stderr ):
882 883 884 885 886
       return outputs_differ( 'stderr', expected_stderr_file, actual_stderr_file )
   else:
       return 1


887 888 889 890 891 892 893
def check_hp_ok(name):

    # do not qualify for hp2ps because we should be in the right directory
    hp2psCmd = 'cd ' + testdir + ' && ' + config.hp2ps + ' ' + name 

    hp2psResult = runCmdExitCode(hp2psCmd)

894 895 896 897
    if config.platform == 'i386-unknown-mingw32':
        actual_ps_file = qualify(name, 'exe.ps')
    else:   
        actual_ps_file = qualify(name, 'ps')
898 899 900 901 902 903 904 905 906 907 908
    
    if(hp2psResult == 0):
        if (os.path.exists(actual_ps_file)):
            if gs_working:
                gsResult = runCmdExitCode(genGSCmd(actual_ps_file))
                if (gsResult == 0):
                    return (True)
                else:
                    print "hp2ps output for " + name + "is not valid PostScript"
            else: return (True) # assume postscript is valid without ghostscript
        else: 
909
            print "hp2ps did not generate PostScript for " + name
910 911 912 913 914
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

915 916 917 918
def different_outputs( str1, str2 ):
   # On Windows, remove '\r' characters from the output
   return re.sub('\r', '', str1) != re.sub('\r', '', str2)

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
# Output a message indicating that an expected output differed from the
# actual output, and optionally accept the new output.  Returns true
# if the output was accepted, or false otherwise.
def outputs_differ( kind, expected, actual ):
    print 'Actual ' + kind + ' output differs from expected:'

    if expected == '':
        expected1 = '/dev/null'
    else:
        expected1 = expected
        
    if actual == '':
        actual1 = '/dev/null'
    else:
        actual1 = actual
        
    os.system( 'diff -c ' + expected1 + ' ' + actual1 )

    if config.accept:
        if expected == '':
            print '*** cannot accept new output: ' + kind + \
                  ' file does not exist.'
            return 0
        else:
            print 'Accepting new output.'
            os.system( 'cp ' + actual + ' ' + expected )
            return 1


def normalise_errmsg( str ):
    # Merge contiguous whitespace characters into a single space.
950
    str = re.sub('[ \r\t\n]+', ' ', str)
951 952 953 954 955 956 957
    # Look for file names and zap the directory part:
    #    foo/var/xyzzy/somefile  -->  somefile
    str = re.sub('([^\\s/]+/)*([^\\s/])', '\\2', str)
    # If somefile ends in ".exe" or ".exe:", zap ".exe" (for Windows)
    #    the colon is there because it appears in error messages; this
    #    hacky solution is used in place of more sophisticated filename
    #    mangling
Simon Marlow's avatar
Simon Marlow committed
958
    str = re.sub('([^\\s])\\.exe', '\\1', str)
959 960
    return str

961 962 963
def normalise_output( str ):
    # Remove a .exe extension (for Windows)
    # This can occur in error messages generated by the program.
Simon Marlow's avatar
Simon Marlow committed
964
    str = re.sub('([^\\s])\\.exe', '\\1', str)
965 966
    return str

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
def if_verbose( n, str ):
    if config.verbose >= n:
        print str

# Guess flags suitable for the compiler.
def guess_compiler_flags():
   if config.compiler_type == 'ghc':
       return ['-no-recomp', '-dcore-lint']
   elif config.compiler_type == 'nhc':
       return ['-an-nhc-specific-flag']
   else:
        return []

def runCmd( cmd ):
    if_verbose( 1, cmd )
982 983 984 985 986
    r = 0
    if config.platform == 'i386-unknown-mingw32':
	# On MinGW, we will always have timeout
        assert config.timeout_prog!=''
        r = os.spawnl(os.P_WAIT, config.timeout_prog,
987
		      config.timeout_prog,`config.timeout`,cmd )
988 989 990
    elif config.timeout_prog!='':
    	r = os.spawnv(os.P_WAIT, config.timeout_prog,
		      [config.timeout_prog,`config.timeout`,cmd] )
991
    else:
992 993
        r = os.system(cmd)
    return r << 8
994

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
def runCmdExitCode( cmd ):
    return (runCmd(cmd) >> 8);


# -----------------------------------------------------------------------------
# checking if ghostscript is available for checking the output of hp2ps

def genGSCmd(psfile):
    return (config.gs + ' -dNODISPLAY -dBATCH -dQUIET -dNOPAUSE ' + psfile);

def gsNotWorking():
    global gs_working 
    print "GhostScript not available for hp2ps tests"
    gs_working = 0;

global gs_working
if config.gs != '':
    resultGood = runCmdExitCode(genGSCmd(config.confdir + '/good.ps'));
    if resultGood == 0:
        resultBad = runCmdExitCode(genGSCmd(config.confdir + '/bad.ps'));
        if resultBad != 0:
            print "GhostScript available for hp2ps tests"
            gs_working = 1;
        else:
            gsNotWorking();
    else:
        gsNotWorking();
else:
    gsNotWorking();

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
def rm_no_fail( file ):
   try:
       os.remove( file )    
   finally:
       return

def add_suffix( name, suffix ):
    if suffix == '':
        return name
    else:
        return name + '.' + suffix    

Ian Lynagh's avatar
Ian Lynagh committed
1037
def add_hs_lhs_suffix(name):
1038 1039 1040
    if getTestOpts().c_src:
        return add_suffix(name, 'c')
    elif getTestOpts().literate:
Ian Lynagh's avatar
Ian Lynagh committed
1041 1042 1043 1044
        return add_suffix(name, 'lhs')
    else:
        return add_suffix(name, 'hs')

1045 1046 1047 1048 1049 1050
def in_testdir( name ):
    return os.path.join(testdir, name)

def qualify( name, suff ):
    return in_testdir(add_suffix(name, suff))

1051
# "foo" -> qualify("foo-platform") if it exists, otherwise
ross's avatar
ross committed
1052 1053
# try qualify("foo-compiler_type"), qualify("foo-ws-wordsize")
# or finally qualify("foo")
1054
def platform_wordsize_qualify( name, suff ):
1055 1056
    path = qualify(name, suff)
    platform_path = path + '-' + config.platform
ross's avatar
ross committed
1057
    compiler_type_path = path + '-' + config.compiler_type
1058
    wordsize_path = path + '-ws-' + config.wordsize
1059
    if os.path.exists(platform_path):
1060
        return (1,platform_path)
ross's avatar
ross committed
1061
    elif os.path.exists(compiler_type_path):
1062
        return (0,compiler_type_path)
1063
    elif os.path.exists(wordsize_path):
1064
        return (0,wordsize_path)
1065
    else:
1066
        return (0,path)
1067 1068 1069 1070 1071 1072 1073

# Clean up prior to the test, so that we can't spuriously conclude
# that it passed on the basis of old run outputs.
def pretest_cleanup(name):
   rm_no_fail(qualify(name,'comp.stderr'))
   rm_no_fail(qualify(name,'run.stderr'))
   rm_no_fail(qualify(name,'run.stdout'))
1074
   rm_no_fail(qualify(name,'tix'))	# remove the old tix file
1075 1076 1077 1078 1079 1080 1081 1082
   # simple_build zaps the following:
   # rm_nofail(qualify("o"))
   # rm_nofail(qualify(""))
   # not interested in the return code

# -----------------------------------------------------------------------------
# Return a list of all the files ending in '.T' below the directory dir.

1083 1084 1085 1086
def findTFiles(roots):
    return concat(map(findTFiles_,roots))

def findTFiles_(path):    
1087 1088
    if os.path.isdir(path):
        paths = map(lambda x, p=path: p + '/' + x, os.listdir(path))
1089
        return findTFiles(paths)
1090 1091 1092 1093 1094 1095 1096 1097 1098
    elif path[-2:] == '.T':
        return [path]
    else:
        return []

# -----------------------------------------------------------------------------
# Output a test summary to the specified file object

def summary(t, file):
krc's avatar
krc committed
1099

1100 1101
    file.write('\n')
    file.write('OVERALL SUMMARY for test run started at ' \
krc's avatar
krc committed
1102
               + t.start_time + '\n'\
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
               + string.rjust(`t.total_tests`, 8) \
               + ' total tests, which gave rise to\n' \
               + string.rjust(`t.total_test_cases`, 8) \
               + ' test cases, of which\n' \
               + string.rjust(`t.n_framework_failures`, 8) \
               + ' caused framework failures\n' \
               + string.rjust(`t.n_tests_skipped`, 8)
               + ' were skipped\n\n' \
               + string.rjust(`t.n_expected_passes`, 8)
               + ' expected passes\n' \
               + string.rjust(`t.n_expected_failures`, 8) \
               + ' expected failures\n' \
               + string.rjust(`t.n_unexpected_passes`, 8) \
               + ' unexpected passes\n'
               + string.rjust(`t.n_unexpected_failures`, 8) \
               + ' unexpected failures\n'
               + '\n')

    if t.n_unexpected_passes > 0:
        file.write('Unexpected passes:\n')
1123 1124 1125
        keys = t.unexpected_passes.keys()
        keys.sort()
        for test in keys:
1126 1127
            file.write('   ' + test + '(' + \
                       join(t.unexpected_passes[test],',') + ')\n')
1128 1129 1130 1131
        file.write('\n')
            
    if t.n_unexpected_failures > 0:
        file.write('Unexpected failures:\n')
1132 1133 1134
        keys = t.unexpected_failures.keys()
        keys.sort()
        for test in keys:
1135 1136
            file.write('   ' + test + '(' + \
                       join(t.unexpected_failures[test],',') + ')\n')
1137
        file.write('\n')