testlib.py 44.2 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 97 98 99 100 101 102 103 104 105 106 107 108 109 110
        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:
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
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal

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

Ian Lynagh's avatar
Ian Lynagh committed
290
def if_compiler_le( compiler, version, f ):
291 292
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
293 294 295
        return f
    else:
        return normal
296

Ian Lynagh's avatar
Ian Lynagh committed
297
def if_compiler_gt( compiler, version, f ):
298
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
299 300 301 302
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
303

Ian Lynagh's avatar
Ian Lynagh committed
304
def if_compiler_ge( compiler, version, f ):
305
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
306 307 308 309
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
310

Ian Lynagh's avatar
Ian Lynagh committed
311 312
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
313

Ian Lynagh's avatar
Ian Lynagh committed
314 315
def _namebase( opts, nb ):
    opts.with_namebase = nb
316

317 318
# ---

319
def if_tag( tag, f ):
320
    if tag in config.compiler_tags:
321 322 323
        return f
    else:
        return normal
324

325
def unless_tag( tag, f ):
326
    if not (tag in config.compiler_tags):
327 328 329
        return f
    else:
        return normal
330

ei@vuokko.info's avatar
ei@vuokko.info committed
331
# ---
332 333
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
334

Ian Lynagh's avatar
Ian Lynagh committed
335 336 337 338
# ---
def literate( opts ):
    opts.literate = 1;

339 340 341
def c_src( opts ):
    opts.c_src = 1;

342 343 344 345 346 347 348 349
# ----

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

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

350 351 352 353 354
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

355 356 357 358 359 360
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

361 362 363
# ----
# Function for composing two opt-fns together

364 365 366
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

367 368 369 370 371 372 373 374 375 376 377
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 ):
378
    global thisdir_testopts
379 380
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
381
    thisdir_testopts.testdir = dir
382 383 384 385

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

386 387 388
allTests = []

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
389
    n = 1
390 391 392 393

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

ei@vuokko.info's avatar
ei@vuokko.info committed
394
    setup(opts)
395

396
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
397
        n = config.threads
398

ei@vuokko.info's avatar
ei@vuokko.info committed
399 400
    ok = 0

401
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
402
        t.thread_pool.acquire()
403 404 405 406 407 408 409 410 411 412 413 414
        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)
415

416 417 418 419 420 421 422
# name  :: String
# setup :: TestOpts -> IO ()  
def test (name, setup, func, args):
    global allTests
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]

423 424 425 426 427 428 429 430 431 432 433
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()
434
    
ei@vuokko.info's avatar
ei@vuokko.info committed
435 436 437
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
438
    # All the ways we might run this test
439
    if func == compile or func == multimod_compile:
440
        all_ways = config.compile_ways
441
    elif func == compile_and_run or func == multimod_compile_and_run:
442
        all_ways = config.run_ways
443 444
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
445
            all_ways = ['ghci']
446
        else:
447
            all_ways = []
448
    else:
449 450
        all_ways = ['normal']

451 452 453
    # 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)
454

455 456 457
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
458
        not getTestOpts().skip \
459
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
460
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
461
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
462
        and way not in getTestOpts().omit_ways
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477

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

479
    clean(map (lambda suff: name + suff,
Ian Lynagh's avatar
Ian Lynagh committed
480
              ['', '.exe', '.exe.manifest', '.genscript',
481
               '.stderr.normalised',        '.stdout.normalised',
Ian Lynagh's avatar
Ian Lynagh committed
482 483 484 485
               '.run.stderr',               '.run.stdout',
               '.run.stderr.normalised',    '.run.stdout.normalised',
               '.comp.stderr',              '.comp.stdout',
               '.comp.stderr.normalised',   '.comp.stdout.normalised',
486 487
               '.interp.stderr',            '.interp.stdout',
               '.interp.stderr.normalised', '.interp.stdout.normalised',
488
               '.stats',
Ian Lynagh's avatar
Ian Lynagh committed
489
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
Simon Marlow's avatar
Simon Marlow committed
490
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))
491

492 493
    clean(getTestOpts().clean_files)

494 495 496 497 498 499 500
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
501
    if getTestOpts().cleanup != '':
502
        for name in names:
503
            try:
504
                # Remove files...
505
                os.remove(name)
506
            except OSError, e1:
507 508 509
                try:
                    # ... and empty directories
                    os.rmdir(name)
510 511 512 513 514 515 516 517 518
                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
519

520
def do_test(name, way, func, args):
521 522 523
    full_name = name + '(' + way + ')'

    try:
524
        print '=====>', full_name, t.total_tests, 'of', len(allTests)
525
        
526 527
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
528 529 530
        try:
            result = apply(func, [name,way] + args)
        finally:
531 532
            if config.use_threads:
                t.lock.acquire()
533
        
ei@vuokko.info's avatar
ei@vuokko.info committed
534
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
535
           result != 'pass' and result != 'fail':
536
            framework_fail(name, way, 'bad results ' + result)
537 538

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
539 540
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
541
                t.n_expected_passes = t.n_expected_passes + 1
542 543 544 545
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
546 547 548
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
549 550 551 552
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
553
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
554 555
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
556 557
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
558 559 560 561
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
562 563
            else:
                t.n_expected_failures = t.n_expected_failures + 1
564 565 566 567
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
568
    except:
569
        framework_fail(name, way, 'do_test exception')
570 571
        traceback.print_exc()

572
def skiptest (name, way):
573 574
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
575 576 577 578
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
579

580 581 582
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
583
    t.n_framework_failures = t.n_framework_failures + 1
584 585 586 587
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
588

589 590 591 592
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
593 594 595 596 597 598
#
# 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.
599

600
def run_command( name, way, cmd ):
601
    return simple_run( name, '', cmd, '' )
602

603 604 605 606
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
607
    # filter out -fforce-recomp from compiler_always_flags, because we're
608
    # actually testing the recompilation behaviour in the GHCi tests.
609
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
610
    flags.append(getTestOpts().extra_hc_opts)
611 612 613 614 615 616

    # 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 + "'" + \
617
          ' --interactive -v0 -ignore-dot-ghci ' + \
618 619
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
620
    getTestOpts().stdin = script
621
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
622

623 624 625 626 627 628 629 630 631 632 633 634
# -----------------------------------------------------------------------------
# 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 )

635 636 637
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

638 639 640 641 642
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
643 644
    if result == 'fail':
        return result
645 646 647 648 649

    # 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
650
    if getTestOpts().with_namebase == None:
651 652
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
653
        namebase = getTestOpts().with_namebase
654 655

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
656 657
    actual_stderr_file = qualify(name, 'comp.stderr')

658 659 660
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
661 662 663 664 665 666 667

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

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

668
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
669 670 671
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

672
    if way == 'ghci': # interpreted...
673
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
674
    elif way == 'extcore' or way == 'optextcore' :
675
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
676
    else: # compiled...
677
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
Ian Lynagh's avatar
Ian Lynagh committed
678 679
        if result == 'fail':
            return result
680

681
        cmd = './' + name;
682 683
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
684

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

688 689
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
690 691

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
692
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
693

Ian Lynagh's avatar
Ian Lynagh committed
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
# -----------------------------------------------------------------------------
# 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'

723 724 725 726
# -----------------------------------------------------------------------------
# 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
727
    opts = getTestOpts()
728 729 730 731 732 733 734
    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
735
        srcname = add_hs_lhs_suffix(name)
736 737 738 739 740 741

    to_do = ''
    if top_mod != '':
        to_do = '--make -o ' + name
    elif link:
        to_do = '-o ' + name
Ian Lynagh's avatar
Ian Lynagh committed
742
    elif opts.compile_to_hc:
743 744 745 746
        to_do = '-C'
    else:
        to_do = '-c' # just compile

Ian Lynagh's avatar
Ian Lynagh committed
747 748
    stats_file = name + '.comp.stats'
    if opts.compiler_stats_num_fields != []:
749
        extra_hc_opts += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
750

751
    cmd = 'cd ' + getTestOpts().testdir + " && '" \
752 753
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
754 755
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
756
          + extra_hc_opts + ' ' \
Ian Lynagh's avatar
Ian Lynagh committed
757
          + opts.extra_hc_opts + ' ' \
758
          + '>' + errname + ' 2>&1'
759 760 761 762 763 764 765 766 767 768

    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
769 770 771 772 773 774 775 776 777 778 779 780 781
    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'
782 783 784 785 786 787 788 789

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

790
def simple_run( name, way, prog, args ):
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
    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'))
811
   
812 813
    my_rts_flags = rts_flags(way)

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

818 819 820 821
    if opts.no_stdin:
        stdin_comes_from = ''
    else:
        stdin_comes_from = ' <' + use_stdin
822
    cmd = 'cd ' + getTestOpts().testdir + ' && ' \
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
	    + 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

845 846 847 848 849
    if not opts.ignore_output:
        if not check_stderr_ok(name):
            return 'fail'
        if not check_stdout_ok(name):
            return 'fail'
850
        # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
851 852 853 854 855
        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
856
    num_field_fail = checkStats(stats_file, opts.stats_num_fields)
857

Ian Lynagh's avatar
Ian Lynagh committed
858 859
    if num_field_fail:
        return 'fail'
860

861
    return 'pass'
862

863 864 865 866 867 868 869 870 871 872 873
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

874 875 876
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

877
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
878 879 880 881 882 883
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
884 885 886 887 888
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

889
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
890
        srcname = add_hs_lhs_suffix(name)
891 892 893
    else:
        srcname = top_mod
        
894
    scriptname = add_suffix(name, 'genscript')
895 896 897 898 899 900 901 902 903 904
    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
905
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
906 907 908 909
        # 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)
910 911
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
912 913
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
914
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
915 916
    script.close()

917
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
918 919
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
920 921 922
    else:
        stdin_file = qualify(name, 'stdin')

923 924 925 926
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
927 928
    script.close()

929
    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
930 931 932 933 934
          + 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
935
          + getTestOpts().extra_hc_opts + ' ' \
936 937 938 939
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

940 941 942
    exit_code = result >> 8
    signal    = result & 0xff

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

951 952 953 954 955 956 957
    # 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'

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

960 961
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
962 963 964 965 966 967 968 969 970 971 972
        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()
973
    line = re.sub('\r', '', line) # ignore Windows EOL
974
    while (re.sub('^\s*','',line) != delimiter and line != ''):
975 976
        out1.write(line)
        line = infile.readline()
977
	line = re.sub('\r', '', line)
978
    out1.close()
979 980 981 982 983

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
984
    out2.close()
985
    
krc's avatar
krc committed
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
# -----------------------------------------------------------------------------
# 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
1003
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
    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 + ' ' 

1018
    cmd = 'cd ' + getTestOpts().testdir + " && '" \
krc's avatar
krc committed
1019 1020 1021 1022
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
1023
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
          + 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]),' ')
    
1048
    cmd = 'cd ' + getTestOpts().testdir + " && '" \
krc's avatar
krc committed
1049 1050 1051 1052
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + to_compile + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
1053
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
          + 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 )
    
1072
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
1073

1074 1075 1076 1077
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
1078
   if getTestOpts().with_namebase == None:
1079 1080
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
1081
       namebase = getTestOpts().with_namebase
1082