testlib.py 35.2 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'

83 84 85 86
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
87 88 89 90 91 92
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

93 94 95
def ignore_output( opts ):
    opts.ignore_output = 1

96 97 98 99 100 101 102 103
# -----

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
104 105 106 107 108 109
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

110 111 112 113 114 115 116 117 118 119
# -----

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

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

# -----

120 121 122 123 124 125 126 127
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
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
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

# -----

146 147 148 149 150 151
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'
152 153 154 155 156 157 158

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'
159 160 161
	
# -----

ross's avatar
ross committed
162 163 164 165 166 167 168
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
169
def expect_broken_if_compiler_type( bug, compiler_type ):
Ian Lynagh's avatar
Ian Lynagh committed
170 171 172 173 174 175
   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
176 177
# -----

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
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

200 201 202
def no_clean( opts ):
    opts.cleanup = '';

203 204 205 206 207 208
# -----

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

209 210 211 212 213 214
# ----

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

Simon Marlow's avatar
Simon Marlow committed
215 216 217 218 219 220 221 222 223
# -----

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
	
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
# ---

def skip_if_tag( tag ):
   return lambda opts, t=tag: _skip_if_tag(opts, t)

def _skip_if_tag( opts, tag ):
    if tag in config.compiler_tags:
	opts.skip = 1
	
def skip_unless_tag( tag ):
   return lambda opts, t=tag: _skip_unless_tag(opts, t)

def _skip_unless_tag( opts, tag ):
    if not (tag in config.compiler_tags):
	opts.skip = 1
	
ei@vuokko.info's avatar
ei@vuokko.info committed
240
# ---
241 242
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
243

Ian Lynagh's avatar
Ian Lynagh committed
244 245 246 247
# ---
def literate( opts ):
    opts.literate = 1;

248 249 250
def c_src( opts ):
    opts.c_src = 1;

251 252 253
# ----
# Function for composing two opt-fns together

254 255 256
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
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
284 285 286 287
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
    setup(opts)
288
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
289
        n = config.threads
290

ei@vuokko.info's avatar
ei@vuokko.info committed
291 292
    ok = 0

293
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
294
        t.thread_pool.acquire()
295 296 297 298 299 300 301 302 303 304 305 306
        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)
307

308 309 310 311 312 313 314 315 316 317 318
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()
319
    
ei@vuokko.info's avatar
ei@vuokko.info committed
320 321 322
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
323
    # All the ways we might run this test
324
    if func == compile or func == multimod_compile:
325
        all_ways = config.compile_ways
326
    elif func == compile_and_run or func == multimod_compile_and_run:
327
        all_ways = config.run_ways
328 329
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
330
            all_ways = ['ghci']
331
        else:
332
            all_ways = []
333
    else:
334 335 336 337 338
        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
339
        not getTestOpts().skip \
340
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
341 342
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
        and way not in getTestOpts().omit_ways
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

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

359
    clean(map (lambda suff: name + suff,
360 361 362 363 364 365 366
              ['', '.exe', '.genscript',
               '.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
367
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
368
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
369 370 371 372 373 374 375 376

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
377
    if getTestOpts().cleanup != '':
378
        for name in names:
379
            try:
380
                os.remove(name)
381 382
            except OSError:
                pass
383

384
def do_test(name, way, func, args):
385 386 387 388 389
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
390 391
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
392 393 394
        try:
            result = apply(func, [name,way] + args)
        finally:
395 396
            if config.use_threads:
                t.lock.acquire()
397
        
ei@vuokko.info's avatar
ei@vuokko.info committed
398
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
399
           result != 'pass' and result != 'fail':
400
            framework_fail(name, way)
401 402

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
403 404
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
405
                t.n_expected_passes = t.n_expected_passes + 1
406 407 408 409
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
410 411 412
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
413 414 415 416
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
417
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
418 419
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
420 421
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
422 423 424 425
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
426 427
            else:
                t.n_expected_failures = t.n_expected_failures + 1
428 429 430 431
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
432 433 434
    except:
        print '*** framework failure for', full_name, ':'
        traceback.print_exc()
435
        framework_fail(name, way)
436

437
def skiptest (name, way):
438 439
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
440 441 442 443
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
444

445
def framework_fail( name, way ):
446
    t.n_framework_failures = t.n_framework_failures + 1
447 448 449 450
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
451

452 453 454 455
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
456 457 458 459 460 461
#
# 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.
462

463
def run_command( name, way, cmd ):
464
    return simple_run( name, '', cmd, '' )
465

466 467 468 469
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
470 471 472 473 474 475 476 477 478
    # 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 + "'" + \
479
          ' --interactive -v0 ' + \
480 481
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
482
    getTestOpts().stdin = script
483
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
484

485 486 487 488 489 490 491 492 493 494 495 496
# -----------------------------------------------------------------------------
# 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 )

497 498 499
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
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).

516
    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
517 518
    actual_stderr_file = qualify(name, 'comp.stderr')

519 520 521
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
522 523 524 525 526 527 528

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

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

529
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
530 531 532
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

533
    if way == 'ghci': # interpreted...
534
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
535
    elif way == 'extcore' or way == 'optextcore' :
536
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
537
    else: # compiled...
538 539
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
540 541 542 543
        if result != 0:
            return 'fail'

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

546 547
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '' )
548 549

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
550
    return compile_and_run__( name, way, extra_hc_opts, top_mod )
551

552 553 554 555 556 557 558 559 560 561 562
# -----------------------------------------------------------------------------
# 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
563
        srcname = add_hs_lhs_suffix(name)
564 565 566 567 568 569

    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
570
    elif getTestOpts().compile_to_hc:
571 572 573 574 575 576 577 578
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
579 580
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
581
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
582
          + getTestOpts().extra_hc_opts + ' ' \
583
          + '>' + errname + ' 2>&1'
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

    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.

603
def simple_run( name, way, prog, args ):
604
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
605 606
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
607 608 609 610 611 612 613 614 615 616 617
   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'))
618
   rm_no_fail(qualify(name,'run.stderr'))
619 620 621 622
   rm_no_fail(qualify(name, 'hp'))
   rm_no_fail(qualify(name,'ps'))
   
   my_rts_flags = rts_flags(way)
623 624

   cmd = 'cd ' + testdir + ' && ' \
625
	  + prog + ' ' + args + ' ' \
626
          + my_rts_flags + ' ' \
627 628 629
          + ' <' + use_stdin \
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
630 631 632 633

   # run the command
   result = runCmd(cmd)

634
   exit_code = result >> 8
635 636 637
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
638 639
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
640 641
       dump_stdout(name)
       dump_stderr(name)
642 643
       return 'fail'

644 645
   check_hp = my_rts_flags.find("-h") != -1

646 647
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
648
                                      (not check_hp or check_hp_ok(name))):
649 650 651 652
       return 'pass'
   else:
       return 'fail'

653 654 655 656 657 658 659 660 661 662 663
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

664 665 666
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

667
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
668 669 670 671 672 673
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
674
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
675
        srcname = add_hs_lhs_suffix(name)
676 677 678
    else:
        srcname = top_mod
        
679
    scriptname = add_suffix(name, 'genscript')
680 681 682 683 684 685 686 687 688 689
    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
690
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
691 692 693 694
        # 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)
695 696
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
697 698
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
699
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
700 701
    script.close()

702
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
703 704
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
705 706 707
    else:
        stdin_file = qualify(name, 'stdin')

708 709 710 711
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
712 713 714 715 716 717 718 719
    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
720
          + getTestOpts().extra_hc_opts + ' ' \
721 722 723 724
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

725 726 727
    exit_code = result >> 8
    signal    = result & 0xff

728 729 730 731 732 733 734 735
    # 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'))

736 737 738 739 740 741 742
    # 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'

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

745 746
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
747 748 749 750 751 752 753 754 755 756 757
        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()
758
    line = re.sub('\r', '', line) # ignore Windows EOL
759
    while (re.sub('^\s*','',line) != delimiter and line != ''):
760 761
        out1.write(line)
        line = infile.readline()
762
	line = re.sub('\r', '', line)
763
    out1.close()
764 765 766 767 768

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
769
    out2.close()
770
    
krc's avatar
krc committed
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
# -----------------------------------------------------------------------------
# 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
788
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
    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
808
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
          + 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
838
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
          + 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 )
    
857
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
858

859 860 861 862 863
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
   actual_stdout_file   = qualify(name, 'run.stdout')
864
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(name, 'stdout')
865

866 867 868 869 870
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
871

872 873
   return compare_outputs('stdout', norm, id, \
                          expected_stdout_file, actual_stdout_file)
874

875 876 877 878
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

879 880
def check_stderr_ok( name ):
   actual_stderr_file   = qualify(name, 'run.stderr')
881
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
882

883 884 885 886 887
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
888

889 890
   return compare_outputs('stderr', norm, id, \
                          expected_stderr_file, actual_stderr_file)
891

892 893 894 895
def dump_stderr( name ):
   print "Stderr:"
   print read_no_crs(qualify(name, 'run.stderr'))

896 897 898 899 900
def read_no_crs(file):
    h = open(file)
    str = h.read()
    h.close
    return re.sub('\r', '', str)
901

902 903 904 905
def write_file(file, str):
    h = open(file, 'w')
    h.write(str)
    h.close
906

907 908 909 910 911 912 913
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)

914 915 916 917
    if config.platform == 'i386-unknown-mingw32':
        actual_ps_file = qualify(name, 'exe.ps')
    else:   
        actual_ps_file = qualify(name, 'ps')
918 919 920 921 922 923 924 925 926 927 928
    
    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: 
929
            print "hp2ps did not generate PostScript for " + name
930 931 932 933 934
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

Ian Lynagh's avatar
Ian Lynagh committed
935
# Compare expected output to actual output, and optionally accept the
936 937 938 939 940 941 942 943 944 945
# new output. Returns true if output matched or was accepted, false
# otherwise.
def compare_outputs( kind, normaliser, extra_normaliser,
                     expected_file, actual_file ):
    if os.path.exists(expected_file):
        expected_raw = read_no_crs(expected_file)
        expected_str = normaliser(expected_raw)
    else:
        expected_str = ''
        expected_file = ''
946

947 948
    actual_raw = read_no_crs(actual_file)
    actual_str = normaliser(actual_raw)
949

950 951 952 953 954
    if extra_normaliser(expected_str) != extra_normaliser(actual_str):
        print 'Actual ' + kind + ' output differs from expected:'

        if expected_file == '':
            expected_normalised_file = '/dev/null'
955 956

        else:
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
            expected_normalised_file = expected_file + ".normalised"
            write_file(expected_normalised_file, expected_str)
        actual_normalised_file = actual_file + ".normalised"
        write_file(actual_normalised_file, actual_str)

        os.system( 'diff -u ' + expected_normalised_file + \
                          ' ' + actual_normalised_file )

        if config.accept:
            if expected_file == '':
                print '*** cannot accept new output: ' + kind + \
                      ' file does not exist.'
                return 0
            else:
                print 'Accepting new output.'
                write_file(expected_file, actual_raw)
                return 1
        return 0
    return 1
976

977 978
def id(str):
    return str
979

980
def normalise_whitespace( str ):
981
    # Merge contiguous whitespace characters into a single space.
982 983 984 985
    str = re.sub('[ \t\n]+', ' ', str)
    return str

def normalise_errmsg( str ):
986 987 988 989 990 991 992
    # 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
993
    str = re.sub('([^\\s])\\.exe', '\\1', str)
994 995
    return str

996 997 998
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
999
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1000 1001
    return str

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
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 )
1017 1018 1019 1020 1021
    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,
1022
		      config.timeout_prog,`config.timeout`,cmd )
1023 1024 1025
    elif config.timeout_prog!='':
    	r = os.spawnv(os.P_WAIT, config.timeout_prog,
		      [config.timeout_prog,`config.timeout`,cmd] )
1026
    else:
1027 1028
        r = os.system(cmd)
    return r << 8
1029

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
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();

1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
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
1072
def add_hs_lhs_suffix(name):
1073 1074 1075
    if getTestOpts().c_src:
        return add_suffix(name, 'c')
    elif getTestOpts().literate:
Ian Lynagh's avatar
Ian Lynagh committed
1076 1077 1078 1079
        return add_suffix(name, 'lhs')
    else:
        return add_suffix(name, 'hs')

1080 1081 1082 1083 1084 1085
def in_testdir( name ):
    return os.path.join(testdir, name)

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

1086
# "foo" -> qualify("foo-platform") if it exists, otherwise
ross's avatar
ross committed
1087 1088
# try qualify("foo-compiler_type"), qualify("foo-ws-wordsize")
# or finally qualify("foo")
1089
def platform_wordsize_qualify( name, suff ):
1090 1091
    path = qualify(name, suff)
    platform_path = path + '-' + config.platform
ross's avatar
ross committed
1092
    compiler_type_path = path + '-' + config.compiler_type
1093
    wordsize_path = path + '-ws-' + config.wordsize
1094
    if os.path.exists(platform_path):
1095
        return (1,platform_path)
ross's avatar
ross committed
1096
    elif os.path.exists(compiler_type_path):
1097
        return (0,compiler_type_path)
1098
    elif os.path.exists(wordsize_path):
1099
        return (0,wordsize_path)
1100
    else:
1101
        return (0,path)
1102 1103 1104 1105 1106 1107 1108

# 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'))
1109
   rm_no_fail(qualify(name,'tix'))	# remove the old tix file
1110 1111 1112 1113 1114 1115 1116 1117
   # 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.

1118 1119 1120 1121
def findTFiles(roots):
    return concat(map(findTFiles_,roots))

def findTFiles_(path):    
1122 1123
    if os.path.isdir(path):
        paths = map(lambda x, p=path: p + '/' + x, os.listdir(path))
1124
        return findTFiles(paths)
1125 1126 1127 1128 1129 1130 1131 1132 1133
    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
1134

1135 1136
    file.write('\n')
    file.write('OVERALL SUMMARY for test run started at ' \
krc's avatar
krc committed
1137
               + t.start_time + '\n'\
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
               + 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')
1158 1159 1160
        keys = t.unexpected_passes.keys()
        keys.sort()
        for test in keys:
1161 1162
            file.write('   ' + test + '(' + \
                       join(t.unexpected_passes[test],',') + ')\n')
1163 1164 1165 1166
        file.write('\n')
            
    if t.n_unexpected_failures > 0:
        file.write('Unexpected failures:\n')
1167 1168 1169
        keys = t.unexpected_failures.keys()
        keys.sort()
        for test in keys:
1170 1171
            file.write('   ' + test + '(' + \
                       join(t.unexpected_failures[test],',') + ')\n')
1172
        file.write('\n')