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
        return f
252 253 254 255 256 257
    else:
        return normal

def if_os( os, f ):
    if config.os == os:
        return f
258 259 260
    else:
        return normal

261 262
# ---

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
284
def if_compiler_ge( compiler, version, f ):
285
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
286 287 288 289
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
290

Ian Lynagh's avatar
Ian Lynagh committed
291 292
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
293

Ian Lynagh's avatar
Ian Lynagh committed
294 295
def _namebase( opts, nb ):
    opts.with_namebase = nb
296

297 298
# ---

299 300 301 302 303 304 305 306 307 308 309 310 311
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
312

ei@vuokko.info's avatar
ei@vuokko.info committed
313
# ---
314 315
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
316

Ian Lynagh's avatar
Ian Lynagh committed
317 318 319 320
# ---
def literate( opts ):
    opts.literate = 1;

321 322 323
def c_src( opts ):
    opts.c_src = 1;

324 325 326 327 328 329 330 331
# ----

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

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

332 333 334 335 336
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

337 338 339
# ----
# Function for composing two opt-fns together

340 341 342
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
377
    setup(opts)
378

379
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
380
        n = config.threads
381

ei@vuokko.info's avatar
ei@vuokko.info committed
382 383
    ok = 0

384
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
385
        t.thread_pool.acquire()
386 387 388 389 390 391 392 393 394 395 396 397
        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)
398

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

427 428 429
    # 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)
430

431 432 433
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
434
        not getTestOpts().skip \
435
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
436
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
437
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
438
        and way not in getTestOpts().omit_ways
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453

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

455
    clean(map (lambda suff: name + suff,
456 457 458 459 460 461 462
              ['', '.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
463
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
464
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
465

466 467
    clean(getTestOpts().clean_files)

468 469 470 471 472 473 474
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
475
    if getTestOpts().cleanup != '':
476
        for name in names:
477
            try:
478
                os.remove(name)
479 480
            except OSError:
                pass
481

482
def do_test(name, way, func, args):
483 484 485 486 487
    full_name = name + '(' + way + ')'

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

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

534
def skiptest (name, way):
535 536
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
537 538 539 540
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
541

542 543 544
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
545
    t.n_framework_failures = t.n_framework_failures + 1
546 547 548 549
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
550

551 552 553 554
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
555 556 557 558 559 560
#
# 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.
561

562
def run_command( name, way, cmd ):
563
    return simple_run( name, '', cmd, '' )
564

565 566 567 568
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
569 570 571
    # 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)
572
    flags.append(getTestOpts().extra_hc_opts)
573 574 575 576 577 578

    # 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 + "'" + \
579
          ' --interactive -v0 -ignore-dot-ghci ' + \
580 581
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
582
    getTestOpts().stdin = script
583
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
584

585 586 587 588 589 590 591 592 593 594 595 596
# -----------------------------------------------------------------------------
# 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 )

597 598 599
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
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
616
    if getTestOpts().with_namebase == None:
617 618
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
619
        namebase = getTestOpts().with_namebase
620 621

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
622 623
    actual_stderr_file = qualify(name, 'comp.stderr')

624 625 626
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
627 628 629 630 631 632 633

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

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

634
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
635 636 637
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

638
    if way == 'ghci': # interpreted...
639
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
640
    elif way == 'extcore' or way == 'optextcore' :
641
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
642
    else: # compiled...
643 644
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
645 646 647
        if result != 0:
            return 'fail'

648
        cmd = './' + name;
649 650
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
651

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

655 656
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
657 658

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
659
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
660

661 662 663 664 665 666 667 668 669 670 671
# -----------------------------------------------------------------------------
# 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
672
        srcname = add_hs_lhs_suffix(name)
673 674 675 676 677 678

    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
679
    elif getTestOpts().compile_to_hc:
680 681 682 683 684 685 686 687
        to_do = '-C'
    else:
        to_do = '-c' # just compile


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

    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.

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

733 734 735 736
   if getTestOpts().no_stdin:
     stdin_comes_from = ''
   else:
     stdin_comes_from = ' <' + use_stdin
737
   cmd = 'cd ' + testdir + ' && ' \
738
	  + prog + ' ' + args + ' ' \
739
          + my_rts_flags + ' ' \
740
          + stdin_comes_from \
741 742
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
743 744 745 746

   # run the command
   result = runCmd(cmd)

747
   exit_code = result >> 8
748 749 750
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
751 752
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
753 754
       dump_stdout(name)
       dump_stderr(name)
755 756
       return 'fail'

757 758
   check_hp = my_rts_flags.find("-h") != -1

759 760
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
761 762
                                      (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.
763 764 765 766
       return 'pass'
   else:
       return 'fail'

767 768 769 770 771 772 773 774 775 776 777
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

778 779 780
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

781
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
782 783 784 785 786 787
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
788 789 790 791 792
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

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

821
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
822 823
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
824 825 826
    else:
        stdin_file = qualify(name, 'stdin')

827 828 829 830
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
831 832
    script.close()

833
    cmd = 'cd ' + testdir + " && " + cmd_prefix + "'" \
834 835 836 837 838
          + 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
839
          + getTestOpts().extra_hc_opts + ' ' \
840 841 842 843
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

844 845 846
    exit_code = result >> 8
    signal    = result & 0xff

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

855 856 857 858 859 860 861
    # 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'

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

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

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
888
    out2.close()
889
    
krc's avatar
krc committed
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
# -----------------------------------------------------------------------------
# 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
907
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
    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
927
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
          + 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
957
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
          + 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 )
    
976
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
977

978 979 980 981
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
982
   if getTestOpts().with_namebase == None:
983 984
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
985
       namebase = getTestOpts().with_namebase
986

987
   actual_stdout_file   = qualify(name, 'run.stdout')
988
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(namebase, 'stdout')
989

990 991 992 993 994
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
995

996
   return compare_outputs('stdout', norm, getTestOpts().extra_normaliser, \
997
                          expected_stdout_file, actual_stdout_file)
998

999 1000 1001 1002
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

1003
def check_stderr_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
1004
   if getTestOpts().with_namebase == None:
1005 1006
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
1007
       namebase = getTestOpts().with_namebase
1008

1009
   actual_stderr_file   = qualify(name, 'run.stderr')
1010
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
1011

1012 1013 1014 1015 1016
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
1017

1018
   return compare_outputs('stderr', norm, getTestOpts().extra_normaliser, \
1019
                          expected_stderr_file, actual_stderr_file)
1020

1021 1022 1023 1024
def dump_stderr( name ):
   print "Stderr:"
   print read_no_crs(qualify(name, 'run.stderr'))

1025 1026 1027 1028 1029
def read_no_crs(file):
    h = open(file)
    str = h.read()
    h.close
    return re.sub('\r', '', str)
1030

1031 1032 1033 1034
def write_file(file, str):
    h = open(file, 'w')
    h.write(str)
    h.close
1035

1036 1037 1038 1039 1040 1041 1042
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)

1043
    actual_ps_file = qualify(name, 'ps')
1044 1045 1046 1047 1048 1049 1050