testlib.py 46.5 KB
Newer Older
1 2 3 4 5 6
# 
# (c) Simon Marlow 2002
#

import sys
import os
7
import errno
8 9 10 11
import string
import re
import traceback
import copy
12
import glob
13
import types
14

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

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

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

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

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

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

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

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

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

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

90
def _reqlib( opts, lib ):
91 92
    if have_lib.has_key(lib):
        got_it = have_lib[lib]
93
    else:
94 95 96
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
97
            p = subprocess.Popen([config.ghc_pkg, '--no-user-package-conf', 'describe', lib],
98 99 100 101 102 103 104 105 106 107 108 109 110
                                 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:
111 112
        opts.expect = 'fail'

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

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

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

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

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

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

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

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

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

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

# -----

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

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

# -----

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

# -----

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
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

209 210 211 212 213 214 215 216
# -----

def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

217 218
# -----

219 220
def stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _stats_num_field(opts, f, x, y);
221

222 223
def _stats_num_field( opts, f, x, y ):
    opts.stats_num_fields = opts.stats_num_fields + [(f, x, y)]
224

Ian Lynagh's avatar
Ian Lynagh committed
225 226 227 228 229 230
def compiler_stats_num_field( field, min, max ):
    return lambda opts, f=field, x=min, y=max: _compiler_stats_num_field(opts, f, x, y);

def _compiler_stats_num_field( opts, f, x, y ):
    opts.compiler_stats_num_fields = opts.compiler_stats_num_fields + [(f, x, y)]

231 232
# -----

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

237 238 239 240 241 242
# ----

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

Simon Marlow's avatar
Simon Marlow committed
243 244
# -----

245
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
246
    if config.platform == plat:
247
        return f
248 249 250
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
251 252 253 254 255 256
def if_not_platform( plat, f ):
    if config.platform != plat:
        return f
    else:
        return normal

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

263 264 265 266 267 268
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
269
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
270
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
271 272 273 274
        return f
    else:
        return normal

275 276
# ---

277 278 279 280 281 282 283 284 285 286 287 288
def if_in_tree_compiler( f ):
    if config.in_tree_compiler:
        return f
    else:
        return normal

def unless_in_tree_compiler( f ):
    if config.in_tree_compiler:
        return normal
    else:
        return f

289 290 291 292 293
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
294 295 296 297 298 299

def if_compiler_profiled( f ):
    if config.compiler_profiled:
        return f
    else:
        return normal
300

Ian Lynagh's avatar
Ian Lynagh committed
301
def if_compiler_lt( compiler, version, f ):
302
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
303 304 305 306
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
307

Ian Lynagh's avatar
Ian Lynagh committed
308
def if_compiler_le( compiler, version, f ):
309 310
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
311 312 313
        return f
    else:
        return normal
314

Ian Lynagh's avatar
Ian Lynagh committed
315
def if_compiler_gt( compiler, version, f ):
316
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
317 318 319 320
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
321

Ian Lynagh's avatar
Ian Lynagh committed
322
def if_compiler_ge( compiler, version, f ):
323
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
324 325 326 327
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
328

Ian Lynagh's avatar
Ian Lynagh committed
329 330
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
331

Ian Lynagh's avatar
Ian Lynagh committed
332 333
def _namebase( opts, nb ):
    opts.with_namebase = nb
334

335 336
# ---

337
def if_tag( tag, f ):
338
    if tag in config.compiler_tags:
339 340 341
        return f
    else:
        return normal
342

343
def unless_tag( tag, f ):
344
    if not (tag in config.compiler_tags):
345 346 347
        return f
    else:
        return normal
348

ei@vuokko.info's avatar
ei@vuokko.info committed
349
# ---
350 351
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
352

Ian Lynagh's avatar
Ian Lynagh committed
353 354 355 356
# ---
def literate( opts ):
    opts.literate = 1;

357 358 359
def c_src( opts ):
    opts.c_src = 1;

360 361
# ----

362 363 364 365 366 367 368 369
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

def _pre_cmd( opts, cmd ):
    opts.pre_cmd = cmd

# ----

370 371 372 373 374 375 376 377
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

def _clean_cmd( opts, cmd ):
    opts.clean_cmd = cmd

# ----

378 379 380 381 382 383
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

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

384 385
# ----

Ian Lynagh's avatar
Ian Lynagh committed
386 387 388 389 390 391 392 393
def compile_cmd_prefix( prefix ):
    return lambda opts, p=prefix: _compile_cmd_prefix(opts, prefix)

def _compile_cmd_prefix( opts, prefix ):
    opts.compile_cmd_prefix = prefix

# ----

394 395 396
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

397 398 399 400 401 402
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

def _normalise_fun( opts, f ):
    opts.extra_normaliser = f

403 404 405
# ----
# Function for composing two opt-fns together

406 407 408
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

409 410 411 412 413 414 415 416 417 418 419
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

def newTestDir( dir ):
420
    global thisdir_testopts
421 422
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
423
    thisdir_testopts.testdir = dir
424 425 426 427

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

428
allTests = []
429
allTestNames = set([])
430 431

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
432
    n = 1
433 434 435 436

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

ei@vuokko.info's avatar
ei@vuokko.info committed
437
    setup(opts)
438

439
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
440
        n = config.threads
441

ei@vuokko.info's avatar
ei@vuokko.info committed
442 443
    ok = 0

444
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
445
        t.thread_pool.acquire()
446 447 448 449 450 451 452 453 454 455 456 457
        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)
458

459 460 461 462
# name  :: String
# setup :: TestOpts -> IO ()  
def test (name, setup, func, args):
    global allTests
463 464 465
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
466 467
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
468
    allTestNames.add(name)
469

470 471 472 473 474 475 476 477 478 479 480
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()
481
    
ei@vuokko.info's avatar
ei@vuokko.info committed
482 483 484
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
485
    # All the ways we might run this test
486
    if func == compile or func == multimod_compile:
487
        all_ways = config.compile_ways
488
    elif func == compile_and_run or func == multimod_compile_and_run:
489
        all_ways = config.run_ways
490 491
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
492
            all_ways = ['ghci']
493
        else:
494
            all_ways = []
495
    else:
496 497
        all_ways = ['normal']

498 499 500
    # 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)
501

502 503 504
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
505
        not getTestOpts().skip \
506
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
507
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
508
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
509
        and way not in getTestOpts().omit_ways
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524

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

526
    if getTestOpts().cleanup != '':
Ian Lynagh's avatar
Ian Lynagh committed
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
        clean(map (lambda suff: name + suff,
                  ['', '.exe', '.exe.manifest', '.genscript',
                   '.stderr.normalised',        '.stdout.normalised',
                   '.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',
                   '.stats',
                   '.hi', '.o', '.prof', '.exe.prof', '.hc',
                   '_stub.h', '_stub.c', '_stub.o',
                   '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))

        clean(getTestOpts().clean_files)

543 544 545 546 547 548 549 550
        try:
            cleanCmd = getTestOpts().clean_cmd
            if cleanCmd != None:
                result = runCmd('cd ' + getTestOpts().testdir + ' && ' + cleanCmd)
                if result != 0:
                    framework_fail(name, 'cleaning', 'clean-command failed: ' + str(result))
        except e:
            framework_fail(name, way, 'clean-command exception')
551

552 553 554 555
def clean(names):
    clean_full_paths(map (lambda name: in_testdir(name), names))

def clean_full_paths(names):
Ian Lynagh's avatar
Ian Lynagh committed
556 557 558 559 560
    for name in names:
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
561
            try:
Ian Lynagh's avatar
Ian Lynagh committed
562 563 564 565 566 567 568 569 570 571 572
                # ... and empty directories
                os.rmdir(name)
            except OSError, e2:
                # We don't want to fail here, but we do want to know
                # what went wrong, so print out the exceptions.
                # ENOENT isn't a problem, though, as we clean files
                # that don't necessarily exist.
                if e1.errno != errno.ENOENT:
                    print e1
                if e2.errno != errno.ENOENT:
                    print e2
573

574
def do_test(name, way, func, args):
575 576 577
    full_name = name + '(' + way + ')'

    try:
578 579 580 581
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
582
        
583 584
        if config.use_threads:
            t.lock.release()
585 586 587 588 589 590 591 592 593 594

        try:
            preCmd = getTestOpts().pre_cmd
            if preCmd != None:
                result = runCmd('cd ' + getTestOpts().testdir + ' && ' + preCmd)
                if result != 0:
                    framework_fail(name, way, 'pre-command failed: ' + str(result))
        except e:
            framework_fail(name, way, 'pre-command exception')

ei@vuokko.info's avatar
ei@vuokko.info committed
595 596 597
        try:
            result = apply(func, [name,way] + args)
        finally:
598 599
            if config.use_threads:
                t.lock.acquire()
600
        
ei@vuokko.info's avatar
ei@vuokko.info committed
601
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
602
           result != 'pass' and result != 'fail':
603
            framework_fail(name, way, 'bad results ' + result)
604 605

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
606 607
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
608
                t.n_expected_passes = t.n_expected_passes + 1
609 610 611 612
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
613 614 615
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
616 617 618 619
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
620
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
621 622
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
623 624
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
625 626 627 628
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
629 630
            else:
                t.n_expected_failures = t.n_expected_failures + 1
631 632 633 634
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
635
    except:
636
        framework_fail(name, way, 'do_test exception')
637 638
        traceback.print_exc()

639
def skiptest (name, way):
640 641
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
642 643 644 645
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
646

647 648 649
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
650
    t.n_framework_failures = t.n_framework_failures + 1
651 652 653 654
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
655

656 657 658 659
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
660 661 662 663 664 665
#
# 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.
666

667
def run_command( name, way, cmd ):
668
    return simple_run( name, '', cmd, '' )
669

670 671 672 673
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
674
    # filter out -fforce-recomp from compiler_always_flags, because we're
675
    # actually testing the recompilation behaviour in the GHCi tests.
676
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
677
    flags.append(getTestOpts().extra_hc_opts)
678 679 680 681 682 683

    # 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 + "'" + \
684
          ' --interactive -v0 -ignore-dot-ghci ' + \
685 686
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
687
    getTestOpts().stdin = script
688
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
689

690 691 692 693 694 695 696 697 698 699 700 701
# -----------------------------------------------------------------------------
# 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 )

702 703 704
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

705 706 707 708 709
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 )
    
Ian Lynagh's avatar
Ian Lynagh committed
710 711
    if result == 'fail':
        return result
712 713 714 715 716

    # 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
717
    if getTestOpts().with_namebase == None:
718 719
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
720
        namebase = getTestOpts().with_namebase
721 722

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
723 724
    actual_stderr_file = qualify(name, 'comp.stderr')

725 726 727
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
728 729 730 731 732 733 734

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

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

735
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
736 737 738
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

739
    if way == 'ghci': # interpreted...
740
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
741
    elif way == 'extcore' or way == 'optextcore' :
742
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
743
    else: # compiled...
744
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
Ian Lynagh's avatar
Ian Lynagh committed
745 746
        if result == 'fail':
            return result
747

748
        cmd = './' + name;
749 750
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
751

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

755 756
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
757 758

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
759
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
760

Ian Lynagh's avatar
Ian Lynagh committed
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
# -----------------------------------------------------------------------------
# Check -t stats info

def checkStats(stats_file, num_fields):
    if num_fields != []:
        num_field_fail = False
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

        for (field, min, max) in num_fields:
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
                return 'fail'
            val = int(m.group(1))

            if val < min:
                print field, val, 'is less than minimum allowed', min
                print 'If this is because you have improved GHC, please'
                print 'update the test so that GHC doesn\'t regress again'
                num_field_fail = True
            if val > max:
                print field, val, 'is more than maximum allowed', max
                num_field_fail = True

        if num_field_fail:
            return 'fail'

790 791 792 793
# -----------------------------------------------------------------------------
# Build a single-module program

def simple_build( name, way, extra_hc_opts, should_fail, top_mod, link ):
Ian Lynagh's avatar
Ian Lynagh committed
794
    opts = getTestOpts()
795 796 797 798 799 800 801
    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
802
        srcname = add_hs_lhs_suffix(name)
803 804 805 806 807 808

    to_do = ''
    if top_mod != '':
        to_do = '--make -o ' + name
    elif link:
        to_do = '-o ' + name
Ian Lynagh's avatar
Ian Lynagh committed
809
    elif opts.compile_to_hc:
810 811 812 813
        to_do = '-C'
    else:
        to_do = '-c' # just compile

Ian Lynagh's avatar
Ian Lynagh committed
814 815
    stats_file = name + '.comp.stats'
    if opts.compiler_stats_num_fields != []:
816
        extra_hc_opts += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
817

Ian Lynagh's avatar
Ian Lynagh committed
818 819 820 821 822 823
    if getTestOpts().compile_cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().compile_cmd_prefix + ' '

    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
824 825
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
826 827
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
828
          + extra_hc_opts + ' ' \
Ian Lynagh's avatar
Ian Lynagh committed
829
          + opts.extra_hc_opts + ' ' \
830
          + '>' + errname + ' 2>&1'
831 832 833 834 835 836 837 838 839 840

    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

Ian Lynagh's avatar
Ian Lynagh committed
841 842 843 844 845 846 847 848 849 850 851 852 853
    num_field_fail = checkStats(stats_file, opts.compiler_stats_num_fields)

    if num_field_fail:
        return 'fail'

    if should_fail:
        if result == 0:
            return 'fail'
    else:
        if result != 0:
            return 'fail'

    return 'pass'
854 855 856 857 858 859 860 861

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

862
def simple_run( name, way, prog, args ):
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
    opts = getTestOpts()

    # figure out what to use for stdin
    if opts.stdin != '':
        use_stdin = opts.stdin
    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'))
    rm_no_fail(qualify(name,'run.stderr'))
    rm_no_fail(qualify(name, 'hp'))
    rm_no_fail(qualify(name,'ps'))
    rm_no_fail(qualify(name, 'prof'))
883
   
884 885
    my_rts_flags = rts_flags(way)

Ian Lynagh's avatar
Ian Lynagh committed
886
    stats_file = name + '.stats'
887
    if opts.stats_num_fields != []:
888
        args += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
889

890 891 892 893
    if opts.no_stdin:
        stdin_comes_from = ''
    else:
        stdin_comes_from = ' <' + use_stdin
894
    cmd = 'cd ' + getTestOpts().testdir + ' && ' \
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
	    + prog + ' ' + args + ' '  \
        + my_rts_flags + ' '       \
        + stdin_comes_from         \
        + ' >' + run_stdout        \
        + ' 2>' + run_stderr

    # run the command
    result = runCmd(cmd)

    exit_code = result >> 8
    signal    = result & 0xff

    # check the exit code
    if exit_code != opts.exit_code:
        print 'Wrong exit code (expected', opts.exit_code, ', actual', exit_code, ')'
        dump_stdout(name)
        dump_stderr(name)
        return 'fail'

    check_hp = my_rts_flags.find("-h") != -1
    check_prof = my_rts_flags.find("-p") != -1

917 918 919 920 921
    if not opts.ignore_output:
        if not check_stderr_ok(name):
            return 'fail'
        if not check_stdout_ok(name):
            return 'fail'
922
        # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
923 924 925 926 927
        if check_hp and (exit_code <= 127 or exit_code == 251) and not check_hp_ok(name):
            return 'fail'
        if check_prof and not check_prof_ok(name):
            return 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
928
    num_field_fail = checkStats(stats_file, opts.stats_num_fields)
929

Ian Lynagh's avatar
Ian Lynagh committed
930 931
    if num_field_fail:
        return 'fail'
932

933
    return 'pass'
934

935 936 937 938 939 940 941 942 943 944 945
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

946 947 948
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

949
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
950 951 952 953 954 955
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
956 957 958 959 960
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

961
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
962
        srcname = add_hs_lhs_suffix(name)
963 964 965
    else:
        srcname = top_mod
        
966
    scriptname = add_suffix(name, 'genscript')
967 968 969 970 971 972 973 974 975 976
    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
977
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
978 979 980 981
        # 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)
982 983
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
984 985
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
986
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
987 988
    script.close()

989
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
990 991
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
992 993 994
    else:
        stdin_file = qualify(name, 'stdin')

995 996 997 998
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
999 1000
    script.close()

1001
    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
1002 1003 1004 1005 1006
          + 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
1007
          + getTestOpts().extra_hc_opts + ' ' \
1008 1009 1010 1011
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

1012 1013 1014
    exit_code = result >> 8
    signal    = result & 0xff

1015 1016 1017 1018 1019 1020 1021 1022
    # 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'))

1023 1024 1025 1026 1027 1028 1029
    # 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'

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

1032 1033
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
        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()
1045
    line = re.sub('\r', '', line) # ignore Windows EOL