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

Ian Lynagh's avatar
Ian Lynagh committed
74 75 76 77 78 79
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

80 81 82 83 84 85 86 87
# -----

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
88 89 90 91 92 93
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

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

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

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

# -----

104 105 106 107 108 109 110 111
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
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
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

# -----

130 131 132 133 134 135
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'
136 137 138 139 140 141 142

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'
143 144 145
	
# -----

ross's avatar
ross committed
146 147 148 149 150 151 152 153 154
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'

# -----

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
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

177 178 179
def no_clean( opts ):
    opts.cleanup = '';

180 181 182 183 184 185
# -----

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

186 187 188 189 190 191
# ----

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

Simon Marlow's avatar
Simon Marlow committed
192 193 194 195 196 197 198 199 200
# -----

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
201
# ---
202 203
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
204

Ian Lynagh's avatar
Ian Lynagh committed
205 206 207 208
# ---
def literate( opts ):
    opts.literate = 1;

209 210 211
def c_src( opts ):
    opts.c_src = 1;

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
# ----
# Function for composing two opt-fns together

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
242 243 244 245
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
    setup(opts)
246
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
247
        n = config.threads
248

ei@vuokko.info's avatar
ei@vuokko.info committed
249 250
    ok = 0

251
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
252
        t.thread_pool.acquire()
253 254 255 256 257 258 259 260 261 262 263 264
        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)
265

266 267 268 269 270 271 272 273 274 275 276
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()
277
    
ei@vuokko.info's avatar
ei@vuokko.info committed
278 279 280
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
281
    # All the ways we might run this test
282
    if func == compile or func == multimod_compile:
283
        all_ways = config.compile_ways
284
    elif func == compile_and_run or func == multimod_compile_and_run:
285
        all_ways = config.run_ways
286 287
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
288
            all_ways = ['ghci']
289
        else:
290
            all_ways = []
291
    else:
292 293 294 295 296
        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
297
        not getTestOpts().skip \
298
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
299 300
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
        and way not in getTestOpts().omit_ways
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315

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

317
    clean(map (lambda suff: name + suff,
Ian Lynagh's avatar
Ian Lynagh committed
318
              ['', '.exe', '.genscript', '.run.stderr', '.run.stdout',
319 320
               '.comp.stderr', '.comp.stdout',
               '.interp.stderr', '.interp.stdout',
Ian Lynagh's avatar
Ian Lynagh committed
321
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
322
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
323 324 325 326 327 328 329 330

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
331
    if getTestOpts().cleanup != '':
332
        for name in names:
333
            try:
334
                os.remove(name)
335 336
            except OSError:
                pass
337

338
def do_test(name, way, func, args):
339 340 341 342 343
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
344 345
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
346 347 348
        try:
            result = apply(func, [name,way] + args)
        finally:
349 350
            if config.use_threads:
                t.lock.acquire()
351
        
ei@vuokko.info's avatar
ei@vuokko.info committed
352
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
353 354 355 356
           result != 'pass' and result != 'fail':
            framework_fail(full_name)

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
357 358
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
359
                t.n_expected_passes = t.n_expected_passes + 1
360 361 362 363
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
364 365 366
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
367 368 369 370
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
371
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
372 373
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
374 375
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
376 377 378 379
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
380 381
            else:
                t.n_expected_failures = t.n_expected_failures + 1
382 383 384 385
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
386 387 388 389 390
    except:
        print '*** framework failure for', full_name, ':'
        traceback.print_exc()
        framework_fail(full_name)

391
def skiptest (name, way):
392 393
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
394 395 396 397
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
398 399 400 401 402

def framework_fail( name ):
    t.n_framework_failures = t.n_framework_failures + 1
    t.framework_failures.append(name)

403 404 405 406
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
407 408 409 410 411 412
#
# 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.
413

414
def run_command( name, way, cmd ):
415
    return simple_run( name, '', cmd, '', 0 )
416 417

def run_command_ignore_output( name, way, cmd ):
418
    return simple_run( name, '', cmd, '', 1 )
419

420 421 422 423
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
424 425 426 427 428 429 430 431 432
    # 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 + "'" + \
433
          ' --interactive -v0 ' + \
434 435
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
436
    getTestOpts().stdin = script
437
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts, 0 )
438

439 440 441 442 443 444 445 446 447 448 449 450
# -----------------------------------------------------------------------------
# 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 )

451 452 453
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
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).

470
    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
471 472 473 474 475 476 477 478
    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 = ''
479

480 481
    if different_outputs(expected_stderr, actual_stderr):
        print actual_stderr, '\n', expected_stderr
482 483 484 485 486 487 488 489 490 491 492 493 494
        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

def compile_and_run( name, way, extra_hc_opts ):
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

495
    if way == 'ghci': # interpreted...
496
        return interpreter_run( name, way, extra_hc_opts, 0, '' )
krc's avatar
krc committed
497 498
    elif way == 'extcore' or way == 'optextcore' :
        return extcore_run( name, way, extra_hc_opts, 0, '' )
499 500
    else: # compiled...
        result = simple_build( name, way, extra_hc_opts, 0, '', 1 )
501

502 503 504 505
        if result != 0:
            return 'fail'

        # we don't check the compiler's stderr for a compile-and-run test
ei@vuokko.info's avatar
ei@vuokko.info committed
506
        return simple_run( name, way, './'+name, getTestOpts().extra_run_opts, 0 )
507 508 509 510


def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
    pretest_cleanup(name)
511 512 513

    if way == 'ghci': # interpreted...
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
514 515
    elif way == 'extcore' or way == 'optextcore' :
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
516 517
    else: # compiled...
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
518 519 520 521 522

    if result != 0:
        return 'fail'

    # we don't check the compiler's stderr for a compile-and-run test
ei@vuokko.info's avatar
ei@vuokko.info committed
523
    return simple_run( name, way, './'+name, getTestOpts().extra_run_opts, 0 )
524

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
def multimod_compile_and_run_ignore_output( name, way, top_mod, extra_hc_opts ):
    pretest_cleanup(name)

    if way == 'ghci': # interpreted...
        # not supported: exit code is too difficult to check.
	return 'pass'
    elif way == 'extcore' or way == 'optextcore' :
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
    else: # compiled...
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )

    if result != 0:
        return 'fail'

    # we don't check the compiler's stderr for a compile-and-run test
ei@vuokko.info's avatar
ei@vuokko.info committed
540
    return simple_run( name, way, './'+name, getTestOpts().extra_run_opts, 1 )
541

542 543 544 545 546 547 548 549 550 551 552
# -----------------------------------------------------------------------------
# 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
553
        srcname = add_hs_lhs_suffix(name)
554 555 556 557 558 559

    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
560
    elif getTestOpts().compile_to_hc:
561 562 563 564 565 566 567 568
        to_do = '-C'
    else:
        to_do = '-c' # just compile


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

    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.

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

   cmd = 'cd ' + testdir + ' && ' \
615
	  + prog + ' ' + args + ' ' \
616
          + my_rts_flags + ' ' \
617 618 619
          + ' <' + use_stdin \
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
620 621 622 623

   # run the command
   result = runCmd(cmd)

624
   exit_code = result >> 8
625 626 627
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
628 629
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
630 631
       return 'fail'

632 633 634 635 636
   check_hp = my_rts_flags.find("-h") != -1

   if ignore_output_files or (check_stdout_ok(name) and 
                              check_stderr_ok(name) and
                              (not check_hp or check_hp_ok(name))):
637 638 639 640
       return 'pass'
   else:
       return 'fail'

641 642 643 644 645 646 647 648 649 650 651
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

652 653 654
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

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

690
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
691 692
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
693 694 695
    else:
        stdin_file = qualify(name, 'stdin')

696 697 698 699
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
700 701 702 703 704 705 706 707
    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
708
          + getTestOpts().extra_hc_opts + ' ' \
709 710 711 712
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

713 714 715 716
    exit_code = result >> 8
    signal    = result & 0xff

    # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
717 718
    if exit_code != getTestOpts().exit_code:
        print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
719
        return 'fail'
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742

    # 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

    if check_stdout_ok(name) and check_stderr_ok(name):
        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()
743
    line = re.sub('\r', '', line) # ignore Windows EOL
744
    while (re.sub('^\s*','',line) != delimiter and line != ''):
745 746
        out1.write(line)
        line = infile.readline()
747
	line = re.sub('\r', '', line)
748 749 750 751 752 753

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

842 843 844 845 846
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
   actual_stdout_file   = qualify(name, 'run.stdout')
847
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(name, 'stdout')
848 849 850 851 852 853 854 855

   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):
856 857 858
       actual_stdout = open(actual_stdout_file).read()
       if not platform_specific:
           actual_stdout = normalise_output(actual_stdout)
859 860 861 862
   else:
       actual_stdout = ''
       actual_stdout_file = ''

863
   if different_outputs(actual_stdout, expected_stdout):
864 865 866 867 868 869
       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')
870
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
871 872 873 874 875 876 877 878

   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):
879 880 881
       actual_stderr = open(actual_stderr_file).read()
       if not platform_specific:
           actual_stderr = normalise_output(actual_stderr)
882 883 884 885
   else:
       actual_stderr = ''
       actual_stderr_file = ''

886
   if different_outputs( actual_stderr,expected_stderr ):
887 888 889 890 891
       return outputs_differ( 'stderr', expected_stderr_file, actual_stderr_file )
   else:
       return 1


892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
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)

    actual_ps_file = qualify(name, 'ps')
    
    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: 
            print "hp2ps did not generate PostScript for" + name
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

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

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 950 951
# 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.
952
    str = re.sub('[ \r\t\n]+', ' ', str)
953 954 955 956 957 958 959
    # 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
960
    str = re.sub('([^\\s])\\.exe', '\\1', str)
961 962
    return str

963 964 965
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
966
    str = re.sub('([^\\s])\\.exe', '\\1', str)
967 968
    return str

969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
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 )
984 985 986 987 988 989 990 991 992 993 994
    r = 0
    if config.platform == 'i386-unknown-mingw32':
	# On MinGW, we will always have timeout
        assert config.timeout_prog!=''
        # We need to add " around the command, because
        # (like Windows programs usually) timeout parses the commandline.
        r = os.spawnl(os.P_WAIT, config.timeout_prog,
		      config.timeout_prog,`config.timeout`,'"%s"'%cmd )
    elif config.timeout_prog!='':
    	r = os.spawnv(os.P_WAIT, config.timeout_prog,
		      [config.timeout_prog,`config.timeout`,cmd] )
995
    else:
996 997
        r = os.system(cmd)
    return r << 8
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 1025 1026 1027 1028
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();

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
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
1041
def add_hs_lhs_suffix(name):
1042 1043 1044
    if getTestOpts().c_src:
        return add_suffix(name, 'c')
    elif getTestOpts().literate:
Ian Lynagh's avatar
Ian Lynagh committed
1045 1046 1047 1048
        return add_suffix(name, 'lhs')
    else:
        return add_suffix(name, 'hs')

1049 1050 1051 1052 1053 1054
def in_testdir( name ):
    return os.path.join(testdir, name)

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

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

# 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'))
1078
   rm_no_fail(qualify(name,'tix'))	# remove the old tix file
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
   # 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.

def findTFiles(path):
    if os.path.isdir(path):
        paths = map(lambda x, p=path: p + '/' + x, os.listdir(path))
        return concat(map(findTFiles, paths))
    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
1100

1101 1102
    file.write('\n')
    file.write('OVERALL SUMMARY for test run started at ' \
krc's avatar
krc committed
1103
               + t.start_time + '\n'\
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
               + 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')
1124 1125 1126
        keys = t.unexpected_passes.keys()
        keys.sort()
        for test in keys:
1127 1128
            file.write('   ' + test + '(' + \
                       join(t.unexpected_passes[test],',') + ')\n')
1129 1130 1131 1132
        file.write('\n')
            
    if t.n_unexpected_failures > 0:
        file.write('Unexpected failures:\n')
1133 1134 1135
        keys = t.unexpected_failures.keys()
        keys.sort()
        for test in keys:
1136 1137
            file.write('   ' + test + '(' + \
                       join(t.unexpected_failures[test],',') + ')\n')
1138
        file.write('\n')