testlib.py 35.1 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
ei@vuokko.info's avatar
ei@vuokko.info committed
12 13
import threading
import thread
14 15 16 17 18 19 20

from string import join
from testutil import *

# -----------------------------------------------------------------------------
# Configuration info

21 22 23 24 25 26 27 28
# There is a single global instance of this structure, stored in the
# variable config below.  The fields of the structure are filled in by
# the appropriate config script(s) for this compiler/platform, in
# ../config.
# 
# Bits of the structure may also be filled in from the command line,
# via the build system, using the '-e' option to runtests.

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
class TestConfig:
    def __init__(self):

        # Directory below which to look for test description files (foo.T)
        self.rootdir = '.'

        # Run these tests only (run all tests if empty)
        self.only = []

        # Accept new output which differs from the sample?
        self.accept = 0

        # File in which to save the summary
        self.output_summary = ''

        # What platform are we running on?
        self.platform = ''

47 48 49
        # What is the wordsize (in bits) of this platform?
        self.wordsize = ''

50 51 52
        # Verbosity level
        self.verbose = 1

53 54 55
        # run the "fast" version of the test suite
        self.fast = 0

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
        # Compiler type (ghc, hugs, nhc, etc.)
        self.compiler_type = ''

        # Path to the compiler
        self.compiler = ''

        # Flags we always give to this compiler
        self.compiler_always_flags = []
        
        # Which ways to run tests (when compiling and running respectively)
        # Other ways are added from the command line if we have the appropriate
        # libraries.
        self.compile_ways = []
        self.run_ways     = []

        # Lists of flags for each way
        self.way_flags = {}
73
        self.way_rts_flags = {}
74

75 76 77
        # the timeout program
        self.timeout_prog = ''
        self.timeout = 300
ei@vuokko.info's avatar
ei@vuokko.info committed
78 79 80
        
        # threads
        self.threads = 1
81

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
global config
config = TestConfig()

def getConfig():
    return config

# -----------------------------------------------------------------------------
# Information about the current test run

class TestRun:
   def __init__(self):
       self.start_time = ''
       self.total_tests = 0
       self.total_test_cases = 0
       self.n_framework_failures = 0
97
       self.framework_failures = {}
98
       self.n_tests_skipped = 0
99
       self.tests_skipped = {}
100
       self.n_expected_passes = 0
101
       self.expected_passes = {}
102
       self.n_expected_failures = 0
103
       self.expected_failures = {}
104
       self.n_unexpected_passes = 0
105
       self.unexpected_passes = {}
106
       self.n_unexpected_failures = 0
107
       self.unexpected_failures = {}
ei@vuokko.info's avatar
ei@vuokko.info committed
108 109 110 111
       
       self.lock = threading.Lock()
       self.thread_pool = threading.Condition(self.lock)
       self.running_threads = 0
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132

global t
t = TestRun()

def getTestRun():
    return t

# -----------------------------------------------------------------------------
# Information about the current test

class TestOptions:
   def __init__(self):

       # skip this test?
       self.skip = 0;

       # skip these ways
       self.omit_ways = []

       # skip all ways except these ([] == do all ways)
       self.only_ways = []
ross's avatar
ross committed
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
       # the result we normally expect for this test
       self.expect = 'pass';

       # override the expected result for certain ways
       self.expect_fail_for = [];

       # the stdin file that this test will use (empty for <name>.stdin)
       self.stdin = ''

       # compile this test to .hc only
       self.compile_to_hc = 0

       # extra compiler opts for this test
       self.extra_hc_opts = ''

       # extra run opts for this test
       self.extra_run_opts = ''

       # expected exit code
       self.exit_code = 0

155 156 157
       # should we clean up after ourselves?
       self.cleanup = ''

ei@vuokko.info's avatar
ei@vuokko.info committed
158 159
       # should we run this test alone, ie disable THREADS
       self.nothreads = 0
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

# The default set of options
global default_testopts
default_testopts = TestOptions()

# 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).
ei@vuokko.info's avatar
ei@vuokko.info committed
177 178
global testopts_local
testopts_local = threading.local()
179 180

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

ei@vuokko.info's avatar
ei@vuokko.info committed
183 184 185
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229

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

# -----

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

# -----

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

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

# -----

230 231 232 233 234 235 236 237
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

ross's avatar
ross committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
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

# -----

256 257 258 259 260 261 262 263 264
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'
	
# -----

ross's avatar
ross committed
265 266 267 268 269 270 271 272 273
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'

# -----

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
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

296 297 298
def no_clean( opts ):
    opts.cleanup = '';

299 300 301 302 303 304
# -----

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

305 306 307 308 309 310
# ----

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

ei@vuokko.info's avatar
ei@vuokko.info committed
311 312 313 314
# ---
def nothreads(opts):
    opts.nothreads=1

315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
# ----
# Function for composing two opt-fns together

def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

def _compose( opts, f, g ):    
    f(opts)
    g(opts)

# -----------------------------------------------------------------------------
# The current directory of tests

global testdir
testdir = '.'

def newTestDir( dir ):
    global testdir, thisdir_testopts
    testdir = dir
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)

def getTestDir():
    return testdir

# -----------------------------------------------------------------------------
# Actually doing tests

# name  :: String
# setup :: TestOpts -> IO ()  
ei@vuokko.info's avatar
ei@vuokko.info committed
345 346 347 348 349 350 351 352 353 354 355 356
def test ( name, setup, func, args):
    return test_common(0,name,setup,func,args)

def test_alone (name, setup, func, args):
    return test_common(1,name,setup,func,args)

def test_common (ser, name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
    setup(opts)
    if ser or opts.nothreads:
        n = config.threads
357

ei@vuokko.info's avatar
ei@vuokko.info committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
    ok = 0
    t.thread_pool.acquire()
    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()

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()
            
382 383

    
ei@vuokko.info's avatar
ei@vuokko.info committed
384 385 386
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
387
    # All the ways we might run this test
388
    if func == compile or func == multimod_compile:
389
        all_ways = config.compile_ways
390
    elif func == compile_and_run or func == multimod_compile_and_run:
391
        all_ways = config.run_ways
392 393
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
394
            all_ways = ['ghci']
395
        else:
396
            all_ways = []
397
    else:
398 399 400 401 402
        all_ways = ['normal']

    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
403
        not getTestOpts().skip \
404
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
405 406
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
        and way not in getTestOpts().omit_ways
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421

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

423 424 425 426 427
    clean(map (lambda suff: name + suff,
              ['', '.genscript', '.run.stderr', '.run.stdout',
               '.comp.stderr', '.comp.stdout',
               '.interp.stderr', '.interp.stdout',
               '.hi', '.o', '.prof', '.hc', '_stub.h', '_stub.c',
Ian Lynagh's avatar
Ian Lynagh committed
428
               '_stub.o', '.hp']))
429 430 431 432 433 434 435 436

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
437
    if getTestOpts().cleanup != '':
438 439 440
        for name in names:
            if os.access(name, os.F_OK) :
                os.remove(name)
441

442
def do_test(name, way, func, args):
443 444 445 446 447
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
ei@vuokko.info's avatar
ei@vuokko.info committed
448 449 450 451 452
        t.lock.release()
        try:
            result = apply(func, [name,way] + args)
        finally:
            t.lock.acquire()
453
        
ei@vuokko.info's avatar
ei@vuokko.info committed
454
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
455 456 457 458
           result != 'pass' and result != 'fail':
            framework_fail(full_name)

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
459 460
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
461
                t.n_expected_passes = t.n_expected_passes + 1
462 463 464 465
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
466 467 468
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
469 470 471 472
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
473
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
474 475
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
476 477
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
478 479 480 481
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
482 483
            else:
                t.n_expected_failures = t.n_expected_failures + 1
484 485 486 487
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
488 489 490 491 492
    except:
        print '*** framework failure for', full_name, ':'
        traceback.print_exc()
        framework_fail(full_name)

493
def skiptest (name, way):
494 495
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
496 497 498 499
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
500 501 502 503 504

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

505 506 507 508
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
509 510 511 512 513 514
#
# 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.
515

516
def run_command( name, way, cmd ):
517
    return simple_run( name, '', cmd, '', 0 )
518 519

def run_command_ignore_output( name, way, cmd ):
520
    return simple_run( name, '', cmd, '', 1 )
521

522 523 524 525
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
526 527 528 529 530 531 532 533 534
    # 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 + "'" + \
535
          ' --interactive -v0 ' + \
536 537
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
538
    getTestOpts().stdin = script
539
    return simple_run( name, way, cmd, '', 0 )
540

541 542 543 544 545 546 547 548 549 550 551 552
# -----------------------------------------------------------------------------
# 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 )

553 554 555
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
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).

572
    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
573 574 575 576 577 578 579 580
    actual_stderr_file = qualify(name, 'comp.stderr')
    actual_stderr = normalise_errmsg(open(actual_stderr_file).read())

    if os.path.exists(expected_stderr_file):
        expected_stderr = normalise_errmsg(open(expected_stderr_file).read())
    else:
        expected_stderr = ''
        expected_stderr_file = ''
581

582 583
    if different_outputs(expected_stderr, actual_stderr):
        print actual_stderr, '\n', expected_stderr
584 585 586 587 588 589 590 591 592 593 594 595 596
        if not outputs_differ('stderr', expected_stderr_file, actual_stderr_file):
            return 'fail'

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

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

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

597
    if way == 'ghci': # interpreted...
598
        return interpreter_run( name, way, extra_hc_opts, 0, '' )
krc's avatar
krc committed
599 600
    elif way == 'extcore' or way == 'optextcore' :
        return extcore_run( name, way, extra_hc_opts, 0, '' )
601 602
    else: # compiled...
        result = simple_build( name, way, extra_hc_opts, 0, '', 1 )
603

604 605 606 607
        if result != 0:
            return 'fail'

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


def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
    pretest_cleanup(name)
613 614 615

    if way == 'ghci': # interpreted...
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
616 617
    elif way == 'extcore' or way == 'optextcore' :
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
618 619
    else: # compiled...
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
620 621 622 623 624

    if result != 0:
        return 'fail'

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

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
def multimod_compile_and_run_ignore_output( name, way, top_mod, extra_hc_opts ):
    pretest_cleanup(name)

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

    if result != 0:
        return 'fail'

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

644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
# -----------------------------------------------------------------------------
# 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:
        srcname = add_suffix(name, 'hs')

    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
662
    elif getTestOpts().compile_to_hc:
663 664 665 666 667 668 669 670
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
671 672
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
673
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
674
          + getTestOpts().extra_hc_opts + ' ' \
675
          + '>' + errname + ' 2>&1'
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694

    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.

695
def simple_run( name, way, prog, args, ignore_output_files ):
696
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
697 698
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
699 700 701 702 703 704 705 706 707 708 709
   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'))
710
   rm_no_fail(qualify(name,'run.stderr'))
711 712

   cmd = 'cd ' + testdir + ' && ' \
713
	  + prog + ' ' + args + ' ' \
714 715 716 717
          + rts_flags(way) + ' ' \
          + ' <' + use_stdin \
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
718 719 720 721

   # run the command
   result = runCmd(cmd)

722
   exit_code = result >> 8
723 724 725
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
726 727
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
728 729
       return 'fail'

730
   if ignore_output_files or (check_stdout_ok(name) and check_stderr_ok(name)):
731 732 733 734
       return 'pass'
   else:
       return 'fail'

735 736 737 738 739 740 741 742 743 744 745
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

746 747 748
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

749
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
750 751 752 753 754 755
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
756 757 758 759 760
    if (top_mod == ''):
        srcname = add_suffix(name, 'hs')
    else:
        srcname = top_mod
        
761
    scriptname = add_suffix(name, 'genscript')
762 763 764 765 766 767 768 769 770 771
    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
772
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
773 774 775 776
        # 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)
777 778
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
779 780
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
781
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
782 783
    script.close()

784
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
785 786
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
787 788 789
    else:
        stdin_file = qualify(name, 'stdin')

790 791 792 793
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
794 795 796 797 798 799 800 801
    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
802
          + getTestOpts().extra_hc_opts + ' ' \
803 804 805 806
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

807 808 809 810
    exit_code = result >> 8
    signal    = result & 0xff

    # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
811 812
    if exit_code != getTestOpts().exit_code:
        print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
813
        return 'fail'
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836

    # split the stdout into compilation/program output
    split_file(in_testdir(outname), delimiter,
               qualify(name, 'comp.stdout'),
               qualify(name, 'run.stdout'))
    split_file(in_testdir(errname), delimiter,
               qualify(name, 'comp.stderr'),
               qualify(name, 'run.stderr'))

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

    if check_stdout_ok(name) and check_stderr_ok(name):
        return 'pass'
    else:
        return 'fail'


def split_file(in_fn, delimiter, out1_fn, out2_fn):
    infile = open(in_fn)
    out1 = open(out1_fn, 'w')
    out2 = open(out2_fn, 'w')

    line = infile.readline()
837
    line = re.sub('\r', '', line) # ignore Windows EOL
838
    while (re.sub('^\s*','',line) != delimiter and line != ''):
839 840
        out1.write(line)
        line = infile.readline()
841
	line = re.sub('\r', '', line)
842 843 844 845 846 847

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
    
krc's avatar
krc committed
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 875 876 877 878 879 880 881 882 883 884
# -----------------------------------------------------------------------------
# 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 == ''):
        srcname = add_suffix(name, 'hs')
    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
885
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
          + 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
915
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
          + flags                   \
          + ' -fglasgow-exts -o ' + name \
          + '>' + errname + ' 2>&1'
          
    result = runCmd(cmd)
    exit_code = result >> 8

    if exit_code != 0:
        if_verbose(1,'Compiling External Core file(s) failed (status ' + `result` + ') errors were:')
        if_verbose(1,open(qerrname).read())
        return 'fail'

    # Clean up
    rm_no_fail ( oname )
    rm_no_fail ( hcname )
    rm_no_fail ( qcorefilename )
    rm_no_fail ( depsfilename )
    
ei@vuokko.info's avatar
ei@vuokko.info committed
934
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts, 0 )
krc's avatar
krc committed
935

936 937 938 939 940
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
   actual_stdout_file   = qualify(name, 'run.stdout')
941
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(name, 'stdout')
942 943 944 945 946 947 948 949

   if os.path.exists(expected_stdout_file):
       expected_stdout = open(expected_stdout_file).read()
   else:
       expected_stdout = ''
       expected_stdout_file = ''

   if os.path.exists(actual_stdout_file):
950 951 952
       actual_stdout = open(actual_stdout_file).read()
       if not platform_specific:
           actual_stdout = normalise_output(actual_stdout)
953 954 955 956
   else:
       actual_stdout = ''
       actual_stdout_file = ''

957
   if different_outputs(actual_stdout, expected_stdout):
958 959 960 961 962 963
       return outputs_differ( 'stdout', expected_stdout_file, actual_stdout_file )
   else:
       return 1

def check_stderr_ok( name ):
   actual_stderr_file   = qualify(name, 'run.stderr')
964
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(name, 'stderr')
965 966 967 968 969 970 971 972

   if os.path.exists(expected_stderr_file):
       expected_stderr = open(expected_stderr_file).read()
   else:
       expected_stderr = ''
       expected_stderr_file = ''

   if os.path.exists(actual_stderr_file):
973 974 975
       actual_stderr = open(actual_stderr_file).read()
       if not platform_specific:
           actual_stderr = normalise_output(actual_stderr)
976 977 978 979
   else:
       actual_stderr = ''
       actual_stderr_file = ''

980
   if different_outputs( actual_stderr,expected_stderr ):
981 982 983 984 985
       return outputs_differ( 'stderr', expected_stderr_file, actual_stderr_file )
   else:
       return 1


986 987 988 989
def different_outputs( str1, str2 ):
   # On Windows, remove '\r' characters from the output
   return re.sub('\r', '', str1) != re.sub('\r', '', str2)

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
# Output a message indicating that an expected output differed from the
# actual output, and optionally accept the new output.  Returns true
# if the output was accepted, or false otherwise.
def outputs_differ( kind, expected, actual ):
    print 'Actual ' + kind + ' output differs from expected:'

    if expected == '':
        expected1 = '/dev/null'
    else:
        expected1 = expected
        
    if actual == '':
        actual1 = '/dev/null'
    else:
        actual1 = actual
        
    os.system( 'diff -c ' + expected1 + ' ' + actual1 )

    if config.accept:
        if expected == '':
            print '*** cannot accept new output: ' + kind + \
                  ' file does not exist.'
            return 0
        else:
            print 'Accepting new output.'
            os.system( 'cp ' + actual + ' ' + expected )
            return 1


def normalise_errmsg( str ):
    # Merge contiguous whitespace characters into a single space.
1021
    str = re.sub('[ \r\t\n]+', ' ', str)
1022 1023 1024 1025 1026 1027 1028
    # 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
1029
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1030 1031
    return str

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

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
def if_verbose( n, str ):
    if config.verbose >= n:
        print str

# Guess flags suitable for the compiler.
def guess_compiler_flags():
   if config.compiler_type == 'ghc':
       return ['-no-recomp', '-dcore-lint']
   elif config.compiler_type == 'nhc':
       return ['-an-nhc-specific-flag']
   else:
        return []

def runCmd( cmd ):
    if_verbose( 1, cmd )
1053 1054 1055 1056 1057
    # On Windows, we need to run the command via the cygwin shell here,
    # rather than CMD.EXE.  os.system() does the right thing (as long as
    # Python is the cygwin Python), but our timeout program doesn't.  So
    # We disable the use of the timeout program on Windows, for now.
    if (config.timeout_prog == '' or config.platform == 'i386-unknown-mingw32'):
1058 1059
        return os.system( cmd )
    else:
1060
        r = os.spawnv(os.P_WAIT, config.timeout_prog,
1061
                         [config.timeout_prog,`config.timeout`,cmd] )
1062
        return r << 8
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081

def rm_no_fail( file ):
   try:
       os.remove( file )    
   finally:
       return

def add_suffix( name, suffix ):
    if suffix == '':
        return name
    else:
        return name + '.' + suffix    

def in_testdir( name ):
    return os.path.join(testdir, name)

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

1082
# "foo" -> qualify("foo-platform") if it exists, otherwise
ross's avatar
ross committed
1083 1084
# try qualify("foo-compiler_type"), qualify("foo-ws-wordsize")
# or finally qualify("foo")
1085
def platform_wordsize_qualify( name, suff ):
1086 1087
    path = qualify(name, suff)
    platform_path = path + '-' + config.platform
ross's avatar
ross committed
1088
    compiler_type_path = path + '-' + config.compiler_type
1089
    wordsize_path = path + '-ws-' + config.wordsize
1090
    if os.path.exists(platform_path):
1091
        return (1,platform_path)
ross's avatar
ross committed
1092
    elif os.path.exists(compiler_type_path):
1093
        return (0,compiler_type_path)
1094
    elif os.path.exists(wordsize_path):
1095
        return (0,wordsize_path)
1096
    else:
1097
        return (0,path)
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125

# Clean up prior to the test, so that we can't spuriously conclude
# that it passed on the basis of old run outputs.
def pretest_cleanup(name):
   rm_no_fail(qualify(name,'comp.stderr'))
   rm_no_fail(qualify(name,'run.stderr'))
   rm_no_fail(qualify(name,'run.stdout'))
   # simple_build zaps the following:
   # rm_nofail(qualify("o"))
   # rm_nofail(qualify(""))
   # not interested in the return code

# -----------------------------------------------------------------------------
# Return a list of all the files ending in '.T' below the directory dir.

def findTFiles(path):
    if os.path.isdir(path):
        paths = map(lambda x, p=path: p + '/' + x, os.listdir(path))
        return concat(map(findTFiles, paths))
    elif path[-2:] == '.T':
        return [path]
    else:
        return []

# -----------------------------------------------------------------------------
# Output a test summary to the specified file object

def summary(t, file):
krc's avatar
krc committed
1126

1127 1128
    file.write('\n')
    file.write('OVERALL SUMMARY for test run started at ' \
krc's avatar
krc committed
1129
               + t.start_time + '\n'\
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
               + string.rjust(`t.total_tests`, 8) \
               + ' total tests, which gave rise to\n' \
               + string.rjust(`t.total_test_cases`, 8) \
               + ' test cases, of which\n' \
               + string.rjust(`t.n_framework_failures`, 8) \
               + ' caused framework failures\n' \
               + string.rjust(`t.n_tests_skipped`, 8)
               + ' were skipped\n\n' \
               + string.rjust(`t.n_expected_passes`, 8)
               + ' expected passes\n' \
               + string.rjust(`t.n_expected_failures`, 8) \
               + ' expected failures\n' \
               + string.rjust(`t.n_unexpected_passes`, 8) \
               + ' unexpected passes\n'
               + string.rjust(`t.n_unexpected_failures`, 8) \
               + ' unexpected failures\n'
               + '\n')

    if t.n_unexpected_passes > 0:
        file.write('Unexpected passes:\n')
1150 1151 1152
        keys = t.unexpected_passes.keys()
        keys.sort()
        for test in keys:
1153 1154
            file.write('   ' + test + '(' + \
                       join(t.unexpected_passes[test],',') + ')\n')
1155 1156 1157 1158
        file.write('\n')
            
    if t.n_unexpected_failures > 0:
        file.write('Unexpected failures:\n')
1159 1160 1161
        keys = t.unexpected_failures.keys()
        keys.sort()
        for test in keys:
1162 1163
            file.write('   ' + test + '(' + \
                       join(t.unexpected_failures[test],',') + ')\n')
1164
        file.write('\n')