testlib.py 37.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 14 15 16 17 18 19
have_subprocess = False
try:
    import subprocess
    have_subprocess = True
except:
    print "Warning: subprocess not found, will fall back to spawnv"

20
from string import join
21
from testglobals import *
22 23
from testutil import *

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
41
global testopts_local
42 43 44 45 46 47
if config.use_threads:
    testopts_local = threading.local()
else:
    class TestOpts_Local:
        pass
    testopts_local = TestOpts_Local()
48 49

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

ei@vuokko.info's avatar
ei@vuokko.info committed
52 53 54
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

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

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

def _reqlib( opts, lib ):
    # opts.reqlibs.append(lib)
86 87 88 89 90 91 92 93 94 95 96
    if have_subprocess:
        # By preference we use subprocess, as the alternative uses /dev/null
        # which mingw doesn't have.
        p = subprocess.Popen([config.ghc_pkg, 'describe', lib],
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
        # read from stdout and stderr to avoid blocking due to buffers filling
        p.communicate()
        r = p.wait()
    else:
        r = os.system(config.ghc_pkg + ' describe ' + lib + ' > /dev/null 2> /dev/null')

97 98 99
    if r != 0:
        opts.expect = 'fail'

100 101 102 103
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
104 105 106 107 108 109
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

110 111 112
def ignore_output( opts ):
    opts.ignore_output = 1

113 114 115
def no_stdin( opts ):
    opts.no_stdin = 1

116 117 118 119 120 121 122 123
# -----

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
124 125 126 127
def expect_broken_for( bug, ways ):
    return lambda opts, b=bug, w=ways: _expect_broken_for( opts, b, w )

def _expect_broken_for( opts, bug, ways ):
Ian Lynagh's avatar
Ian Lynagh committed
128
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
129

130 131 132 133 134 135 136 137 138 139
# -----

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

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

# -----

140 141 142 143 144 145 146 147
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

148 149 150 151 152 153 154 155
def extra_ways( ways ):
    return lambda opts, w=ways: _extra_ways( opts, w )

def _extra_ways( opts, ways ):
    opts.extra_ways = ways

# -----

ross's avatar
ross committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
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

# -----

174 175 176 177 178 179
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'
180 181 182 183 184 185 186

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'
187 188 189
	
# -----

ross's avatar
ross committed
190 191 192 193 194 195 196
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
197
def expect_broken_if_compiler_type( bug, compiler_type ):
Ian Lynagh's avatar
Ian Lynagh committed
198 199 200 201 202 203
   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
204 205
# -----

206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
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

228 229 230
def no_clean( opts ):
    opts.cleanup = '';

231 232 233 234 235 236
# -----

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

237 238 239 240 241 242
# ----

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

Simon Marlow's avatar
Simon Marlow committed
243 244 245 246 247 248 249 250 251
# -----

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
	
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
# ---

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
268
# ---
269 270
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
271

Ian Lynagh's avatar
Ian Lynagh committed
272 273 274 275
# ---
def literate( opts ):
    opts.literate = 1;

276 277 278
def c_src( opts ):
    opts.c_src = 1;

279 280 281
# ----
# Function for composing two opt-fns together

282 283 284
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
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
312 313 314 315
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
    setup(opts)
316
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
317
        n = config.threads
318

ei@vuokko.info's avatar
ei@vuokko.info committed
319 320
    ok = 0

321
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
322
        t.thread_pool.acquire()
323 324 325 326 327 328 329 330 331 332 333 334
        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)
335

336 337 338 339 340 341 342 343 344 345 346
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()
347
    
ei@vuokko.info's avatar
ei@vuokko.info committed
348 349 350
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
351
    # All the ways we might run this test
352
    if func == compile or func == multimod_compile:
353
        all_ways = config.compile_ways
354
    elif func == compile_and_run or func == multimod_compile_and_run:
355
        all_ways = config.run_ways
356 357
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
358
            all_ways = ['ghci']
359
        else:
360
            all_ways = []
361
    else:
362 363
        all_ways = ['normal']

364 365 366
    # A test itself can request extra ways by setting opts.extra_ways
    all_ways = all_ways + filter(lambda way: way not in all_ways,
                                 opts.extra_ways)
367

368 369 370
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
371
        not getTestOpts().skip \
372
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
373
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
374
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
375
        and way not in getTestOpts().omit_ways
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390

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

392
    clean(map (lambda suff: name + suff,
393 394 395 396 397 398 399
              ['', '.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
400
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
401
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
402 403 404 405 406 407 408 409

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
410
    if getTestOpts().cleanup != '':
411
        for name in names:
412
            try:
413
                os.remove(name)
414 415
            except OSError:
                pass
416

417
def do_test(name, way, func, args):
418 419 420 421 422
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
423 424
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
425 426 427
        try:
            result = apply(func, [name,way] + args)
        finally:
428 429
            if config.use_threads:
                t.lock.acquire()
430
        
ei@vuokko.info's avatar
ei@vuokko.info committed
431
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
432
           result != 'pass' and result != 'fail':
433
            framework_fail(name, way)
434 435

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
436 437
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
438
                t.n_expected_passes = t.n_expected_passes + 1
439 440 441 442
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
443 444 445
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
446 447 448 449
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
450
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
451 452
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
453 454
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
455 456 457 458
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
459 460
            else:
                t.n_expected_failures = t.n_expected_failures + 1
461 462 463 464
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
465 466 467
    except:
        print '*** framework failure for', full_name, ':'
        traceback.print_exc()
468
        framework_fail(name, way)
469

470
def skiptest (name, way):
471 472
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
473 474 475 476
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
477

478
def framework_fail( name, way ):
479
    t.n_framework_failures = t.n_framework_failures + 1
480 481 482 483
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
484

485 486 487 488
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
489 490 491 492 493 494
#
# 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.
495

496
def run_command( name, way, cmd ):
497
    return simple_run( name, '', cmd, '' )
498

499 500 501 502
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
503 504 505 506 507 508 509 510 511
    # 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 + "'" + \
512
          ' --interactive -v0 ' + \
513 514
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
515
    getTestOpts().stdin = script
516
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
517

518 519 520 521 522 523 524 525 526 527 528 529
# -----------------------------------------------------------------------------
# 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 )

530 531 532
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
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).

549
    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
550 551
    actual_stderr_file = qualify(name, 'comp.stderr')

552 553 554
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
555 556 557 558 559 560 561

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

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

562
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
563 564 565
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

566
    if way == 'ghci': # interpreted...
567
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
568
    elif way == 'extcore' or way == 'optextcore' :
569
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
570
    else: # compiled...
571 572
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
573 574 575 576
        if result != 0:
            return 'fail'

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

579 580
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '' )
581 582

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
583
    return compile_and_run__( name, way, extra_hc_opts, top_mod )
584

585 586 587 588 589 590 591 592 593 594 595
# -----------------------------------------------------------------------------
# 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
596
        srcname = add_hs_lhs_suffix(name)
597 598 599 600 601 602

    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
603
    elif getTestOpts().compile_to_hc:
604 605 606 607 608 609 610 611
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
612 613
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
614
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
615
          + getTestOpts().extra_hc_opts + ' ' \
616
          + '>' + errname + ' 2>&1'
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635

    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.

636
def simple_run( name, way, prog, args ):
637
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
638 639
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
640 641 642 643 644 645 646 647 648 649 650
   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'))
651
   rm_no_fail(qualify(name,'run.stderr'))
652 653 654 655
   rm_no_fail(qualify(name, 'hp'))
   rm_no_fail(qualify(name,'ps'))
   
   my_rts_flags = rts_flags(way)
656

657 658 659 660
   if getTestOpts().no_stdin:
     stdin_comes_from = ''
   else:
     stdin_comes_from = ' <' + use_stdin
661
   cmd = 'cd ' + testdir + ' && ' \
662
	  + prog + ' ' + args + ' ' \
663
          + my_rts_flags + ' ' \
664
          + stdin_comes_from \
665 666
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
667 668 669 670

   # run the command
   result = runCmd(cmd)

671
   exit_code = result >> 8
672 673 674
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
675 676
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
677 678
       dump_stdout(name)
       dump_stderr(name)
679 680
       return 'fail'

681 682
   check_hp = my_rts_flags.find("-h") != -1

683 684
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
685
                                      (not check_hp or check_hp_ok(name))):
686 687 688 689
       return 'pass'
   else:
       return 'fail'

690 691 692 693 694 695 696 697 698 699 700
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

701 702 703
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

704
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
705 706 707 708 709 710
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
711
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
712
        srcname = add_hs_lhs_suffix(name)
713 714 715
    else:
        srcname = top_mod
        
716
    scriptname = add_suffix(name, 'genscript')
717 718 719 720 721 722 723 724 725 726
    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
727
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
728 729 730 731
        # 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)
732 733
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
734 735
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
736
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
737 738
    script.close()

739
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
740 741
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
742 743 744
    else:
        stdin_file = qualify(name, 'stdin')

745 746 747 748
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
749 750 751 752 753 754 755 756
    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
757
          + getTestOpts().extra_hc_opts + ' ' \
758 759 760 761
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

762 763 764
    exit_code = result >> 8
    signal    = result & 0xff

765 766 767 768 769 770 771 772
    # 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'))

773 774 775 776 777 778 779
    # 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'

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

782 783
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
784 785 786 787 788 789 790 791 792 793 794
        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()
795
    line = re.sub('\r', '', line) # ignore Windows EOL
796
    while (re.sub('^\s*','',line) != delimiter and line != ''):
797 798
        out1.write(line)
        line = infile.readline()
799
	line = re.sub('\r', '', line)
800
    out1.close()
801 802 803 804 805

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
806
    out2.close()
807
    
krc's avatar
krc committed
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
# -----------------------------------------------------------------------------
# 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
825
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
    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
845
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
          + 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
875
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
          + 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 )
    
894
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
895

896 897 898 899 900
# -----------------------------------------------------------------------------
# Utils

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

903 904 905 906 907
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
908

909 910
   return compare_outputs('stdout', norm, id, \
                          expected_stdout_file, actual_stdout_file)
911

912 913 914 915
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

916 917
def check_stderr_ok( name ):
   actual_stderr_file   = qualify(name, 'run.stderr')
918
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
919

920 921 922 923 924
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
925

926 927
   return compare_outputs('stderr', norm, id, \
                          expected_stderr_file, actual_stderr_file)
928

929 930 931 932
def dump_stderr( name ):
   print "Stderr:"
   print read_no_crs(qualify(name, 'run.stderr'))

933 934 935 936 937
def read_no_crs(file):
    h = open(file)
    str = h.read()
    h.close
    return re.sub('\r', '', str)
938

939 940 941 942
def write_file(file, str):
    h = open(file, 'w')
    h.write(str)
    h.close
943

944 945 946 947 948 949 950
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)

951 952 953 954
    if config.platform == 'i386-unknown-mingw32':
        actual_ps_file = qualify(name, 'exe.ps')
    else:   
        actual_ps_file = qualify(name, 'ps')
955 956 957 958 959 960 961 962 963 964 965
    
    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: 
966
            print "hp2ps did not generate PostScript for " + name
967 968 969 970 971
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

Ian Lynagh's avatar
Ian Lynagh committed
972
# Compare expected output to actual output, and optionally accept the
973 974 975 976 977 978 979 980 981 982
# 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 = ''
983

984 985
    actual_raw = read_no_crs(actual_file)
    actual_str = normaliser(actual_raw)
986

987 988 989 990 991
    if extra_normaliser(expected_str) != extra_normaliser(actual_str):
        print 'Actual ' + kind + ' output differs from expected:'

        if expected_file == '':
            expected_normalised_file = '/dev/null'
992 993

        else:
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
            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
1013

1014 1015
def id(str):
    return str
1016

1017
def normalise_whitespace( str ):
1018
    # Merge contiguous whitespace characters into a single space.
1019 1020 1021 1022
    str = re.sub('[ \t\n]+', ' ', str)
    return str

def normalise_errmsg( str ):
1023 1024 1025 1026 1027 1028 1029
    # 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
1030
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1031 1032
    return str

1033 1034 1035
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
1036
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1037 1038
    return str

1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
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 []

Simon Peyton Jones's avatar
Simon Peyton Jones committed
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
# cmd is a complex command in Bourne-shell syntax 
# e.g (cd . && 'c:/users/simonpj/darcs/HEAD/compiler/stage1/ghc-inplace' ...etc)
# Hence it must ultimately be run by a Bourne shell
# 
# Mostly it invokes the command wrapped in 'timeout' thus
#	timeout 300 'cd . && ...blah blah'
# so it's timeout's job to invoke the Bourne shell
#
# But watch out for the case when there is no timeout program!
# Then, when using the native Python, os.system will invoke the cmd shell

1063 1064
def runCmd( cmd ):
    if_verbose( 1, cmd )
1065 1066 1067 1068
    r = 0
    if config.platform == 'i386-unknown-mingw32':
	# On MinGW, we will always have timeout
        assert config.timeout_prog!=''
1069 1070

    if config.timeout_prog != '':
1071
        # We prefer subprocess.call to os.spawnv as the latter
1072 1073 1074
        # seems to send its arguments through a shell or something
        # with the Windows (non-cygwin) python. An argument "a b c"
        # turns into three arguments ["a", "b", "c"].
1075 1076 1077 1078 1079 1080 1081 1082 1083

        # However, subprocess is new in python 2.4, so fall back to
        # using spawnv if we don't have it

        if have_subprocess:
            r = subprocess.call([config.timeout_prog, str(config.timeout), cmd])
        else:
            r = os.spawnv(os.P_WAIT, config.timeout_prog,
                          [config.timeout_prog, str(config.timeout), cmd])
1084
    else:
1085 1086
        r = os.system(cmd)
    return r << 8
1087

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
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();

1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
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
1130
def add_hs_lhs_suffix(name):
Simon Marlow's avatar