testlib.py 39.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
import types
13

14 15 16 17 18 19 20
have_subprocess = False
try:
    import subprocess
    have_subprocess = True
except:
    print "Warning: subprocess not found, will fall back to spawnv"

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

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

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

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
53 54 55
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
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 81

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

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

85 86 87 88
# Cache the results of looking to see if we have a library or not.
# This makes quite a difference, especially on Windows.
have_lib = {}

89
def _reqlib( opts, lib ):
90 91
    if have_lib.has_key(lib):
        got_it = have_lib[lib]
92
    else:
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
            p = subprocess.Popen([config.ghc_pkg, 'describe', lib],
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.PIPE)
            # read from stdout and stderr to avoid blocking due to
            # buffers filling
            p.communicate()
            r = p.wait()
        else:
            r = os.system(config.ghc_pkg + ' describe ' + lib
                                         + ' > /dev/null 2> /dev/null')
        got_it = r == 0
        have_lib[lib] = got_it

    if not got_it:
110 111
        opts.expect = 'fail'

112 113 114 115
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
116 117 118 119 120 121
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

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

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

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

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

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

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

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

# -----

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

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

# -----

160 161 162 163 164 165 166 167
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
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
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

# -----

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

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
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

224 225
# -----

226 227 228
def no_clean( opts ):
    opts.cleanup = '';

229 230 231 232 233 234
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

235 236 237 238 239 240
# -----

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

241 242 243 244 245 246
# ----

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

Simon Marlow's avatar
Simon Marlow committed
247 248
# -----

249
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
250
    if config.platform == plat:
251 252 253 254
        return f
    else:
        return normal

255 256
# ---

Ian Lynagh's avatar
Ian Lynagh committed
257
def if_compiler_lt( compiler, version, f ):
258
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
259 260 261 262
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
263

Ian Lynagh's avatar
Ian Lynagh committed
264
def if_compiler_le( compiler, version, f ):
265 266
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
267 268 269
        return f
    else:
        return normal
270

Ian Lynagh's avatar
Ian Lynagh committed
271
def if_compiler_gt( compiler, version, f ):
272
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
273 274 275 276
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
277

Ian Lynagh's avatar
Ian Lynagh committed
278
def if_compiler_ge( compiler, version, f ):
279
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
280 281 282 283
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
284

Ian Lynagh's avatar
Ian Lynagh committed
285 286
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
287

Ian Lynagh's avatar
Ian Lynagh committed
288 289
def _namebase( opts, nb ):
    opts.with_namebase = nb
290

291 292
# ---

293 294 295 296 297 298 299 300 301 302 303 304 305
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
306

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

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

315 316 317
def c_src( opts ):
    opts.c_src = 1;

318 319 320 321 322 323 324 325
# ----

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

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

326 327 328 329 330
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

331 332 333
# ----
# Function for composing two opt-fns together

334 335 336
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
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
364 365 366
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
367 368 369 370

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

ei@vuokko.info's avatar
ei@vuokko.info committed
371
    setup(opts)
372

373
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
374
        n = config.threads
375

ei@vuokko.info's avatar
ei@vuokko.info committed
376 377
    ok = 0

378
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
379
        t.thread_pool.acquire()
380 381 382 383 384 385 386 387 388 389 390 391
        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)
392

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

421 422 423
    # 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)
424

425 426 427
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
428
        not getTestOpts().skip \
429
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
430
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
431
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
432
        and way not in getTestOpts().omit_ways
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447

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

449
    clean(map (lambda suff: name + suff,
450 451 452 453 454 455 456
              ['', '.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
457
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
458
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
459

460 461
    clean(getTestOpts().clean_files)

462 463 464 465 466 467 468
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
469
    if getTestOpts().cleanup != '':
470
        for name in names:
471
            try:
472
                os.remove(name)
473 474
            except OSError:
                pass
475

476
def do_test(name, way, func, args):
477 478 479 480 481
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
482 483
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
484 485 486
        try:
            result = apply(func, [name,way] + args)
        finally:
487 488
            if config.use_threads:
                t.lock.acquire()
489
        
ei@vuokko.info's avatar
ei@vuokko.info committed
490
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
491
           result != 'pass' and result != 'fail':
492
            framework_fail(name, way, 'bad results ' + result)
493 494

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
495 496
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
497
                t.n_expected_passes = t.n_expected_passes + 1
498 499 500 501
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
502 503 504
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
505 506 507 508
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
509
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
510 511
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
512 513
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
514 515 516 517
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
518 519
            else:
                t.n_expected_failures = t.n_expected_failures + 1
520 521 522 523
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
524
    except:
525
        framework_fail(name, way, 'do_test exception')
526 527
        traceback.print_exc()

528
def skiptest (name, way):
529 530
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
531 532 533 534
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
535

536 537 538
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
539
    t.n_framework_failures = t.n_framework_failures + 1
540 541 542 543
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
544

545 546 547 548
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
549 550 551 552 553 554
#
# 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.
555

556
def run_command( name, way, cmd ):
557
    return simple_run( name, '', cmd, '' )
558

559 560 561 562
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
563 564 565
    # 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)
566
    flags.append(getTestOpts().extra_hc_opts)
567 568 569 570 571 572

    # 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 + "'" + \
573
          ' --interactive -v0 -ignore-dot-ghci ' + \
574 575
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
576
    getTestOpts().stdin = script
577
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
578

579 580 581 582 583 584 585 586 587 588 589 590
# -----------------------------------------------------------------------------
# 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 )

591 592 593
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
def do_compile( name, way, should_fail, top_mod, extra_hc_opts ):
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0 )
    
    if should_fail:
        if result == 0:
            return 'fail'
    else:
        if result != 0:
            return 'fail'

    # the actual stderr should always match the expected, regardless
    # of whether we expected the compilation to fail or not (successful
    # compilations may generate warnings).

Ian Lynagh's avatar
Ian Lynagh committed
610
    if getTestOpts().with_namebase == None:
611 612
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
613
        namebase = getTestOpts().with_namebase
614 615

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
616 617
    actual_stderr_file = qualify(name, 'comp.stderr')

618 619 620
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
621 622 623 624 625 626 627

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

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

628
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
629 630 631
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

632
    if way == 'ghci': # interpreted...
633
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
634
    elif way == 'extcore' or way == 'optextcore' :
635
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
636
    else: # compiled...
637 638
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
639 640 641
        if result != 0:
            return 'fail'

642
        cmd = './' + name;
643 644
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
645

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

649 650
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
651 652

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
653
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
654

655 656 657 658 659 660 661 662 663 664 665
# -----------------------------------------------------------------------------
# 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
666
        srcname = add_hs_lhs_suffix(name)
667 668 669 670 671 672

    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
673
    elif getTestOpts().compile_to_hc:
674 675 676 677 678 679 680 681
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
682 683
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
684
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
685
          + getTestOpts().extra_hc_opts + ' ' \
686
          + '>' + errname + ' 2>&1'
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

    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.

706
def simple_run( name, way, prog, args ):
707
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
708 709
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
710 711 712 713 714 715 716 717 718 719 720
   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'))
721
   rm_no_fail(qualify(name,'run.stderr'))
722 723 724 725
   rm_no_fail(qualify(name, 'hp'))
   rm_no_fail(qualify(name,'ps'))
   
   my_rts_flags = rts_flags(way)
726

727 728 729 730
   if getTestOpts().no_stdin:
     stdin_comes_from = ''
   else:
     stdin_comes_from = ' <' + use_stdin
731
   cmd = 'cd ' + testdir + ' && ' \
732
	  + prog + ' ' + args + ' ' \
733
          + my_rts_flags + ' ' \
734
          + stdin_comes_from \
735 736
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
737 738 739 740

   # run the command
   result = runCmd(cmd)

741
   exit_code = result >> 8
742 743 744
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
745 746
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
747 748
       dump_stdout(name)
       dump_stderr(name)
749 750
       return 'fail'

751 752
   check_hp = my_rts_flags.find("-h") != -1

753 754
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
755 756
                                      (not check_hp or exit_code > 127 or check_hp_ok(name))):
       # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
757 758 759 760
       return 'pass'
   else:
       return 'fail'

761 762 763 764 765 766 767 768 769 770 771
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

772 773 774
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

775
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
776 777 778 779 780 781
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
782 783 784 785 786
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

787
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
788
        srcname = add_hs_lhs_suffix(name)
789 790 791
    else:
        srcname = top_mod
        
792
    scriptname = add_suffix(name, 'genscript')
793 794 795 796 797 798 799 800 801 802
    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
803
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
804 805 806 807
        # 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)
808 809
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
810 811
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
812
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
813 814
    script.close()

815
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
816 817
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
818 819 820
    else:
        stdin_file = qualify(name, 'stdin')

821 822 823 824
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
825 826
    script.close()

827
    cmd = 'cd ' + testdir + " && " + cmd_prefix + "'" \
828 829 830 831 832
          + 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
833
          + getTestOpts().extra_hc_opts + ' ' \
834 835 836 837
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

838 839 840
    exit_code = result >> 8
    signal    = result & 0xff

841 842 843 844 845 846 847 848
    # 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'))

849 850 851 852 853 854 855
    # 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'

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

858 859
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
860 861 862 863 864 865 866 867 868 869 870
        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()
871
    line = re.sub('\r', '', line) # ignore Windows EOL
872
    while (re.sub('^\s*','',line) != delimiter and line != ''):
873 874
        out1.write(line)
        line = infile.readline()
875
	line = re.sub('\r', '', line)
876
    out1.close()
877 878 879 880 881

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
882
    out2.close()
883
    
krc's avatar
krc committed
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
# -----------------------------------------------------------------------------
# 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
901
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
    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
921
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
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
          + 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
951
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
          + 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 )
    
970
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
971

972 973 974 975
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
976
   if getTestOpts().with_namebase == None:
977 978
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
979
       namebase = getTestOpts().with_namebase
980

981
   actual_stdout_file   = qualify(name, 'run.stdout')
982
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(namebase, 'stdout')
983

984 985 986 987 988
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
989

990
   return compare_outputs('stdout', norm, getTestOpts().extra_normaliser, \
991
                          expected_stdout_file, actual_stdout_file)
992

993 994 995 996
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

997
def check_stderr_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
998
   if getTestOpts().with_namebase == None:
999 1000
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
1001
       namebase = getTestOpts().with_namebase
1002

1003
   actual_stderr_file   = qualify(name, 'run.stderr')
1004
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
1005

1006 1007 1008 1009 1010
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
1011

1012
   return compare_outputs('stderr', norm, getTestOpts().extra_normaliser, \
1013
                          expected_stderr_file, actual_stderr_file)
1014

1015 1016 1017 1018
def dump_stderr( name ):
   print "Stderr:"
   print read_no_crs(qualify(name, 'run.stderr'))

1019 1020 1021 1022 1023
def read_no_crs(file):
    h = open(file)
    str = h.read()
    h.close
    return re.sub('\r', '', str)
1024

1025 1026 1027 1028
def write_file(file, str):
    h = open(file, 'w')
    h.write(str)
    h.close
1029

1030 1031 1032 1033 1034 1035 1036
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)

1037 1038 1039 1040
    if config.platform == 'i386-unknown-mingw32':
        actual_ps_file = qualify(name, 'exe.ps')
    else:   
        actual_ps_file = qualify(name, 'ps')
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
    
    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: