testlib.py 45.7 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 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 294
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
295
def if_compiler_lt( compiler, version, f ):
296
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
297 298 299 300
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
301

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
323 324
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
325

Ian Lynagh's avatar
Ian Lynagh committed
326 327
def _namebase( opts, nb ):
    opts.with_namebase = nb
328

329 330
# ---

331
def if_tag( tag, f ):
332
    if tag in config.compiler_tags:
333 334 335
        return f
    else:
        return normal
336

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

ei@vuokko.info's avatar
ei@vuokko.info committed
343
# ---
344 345
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
346

Ian Lynagh's avatar
Ian Lynagh committed
347 348 349 350
# ---
def literate( opts ):
    opts.literate = 1;

351 352 353
def c_src( opts ):
    opts.c_src = 1;

354 355
# ----

356 357 358 359 360 361 362 363
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

364 365 366 367 368 369 370 371
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

372 373 374 375 376 377
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

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

378 379 380 381 382
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

383 384 385 386 387 388
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

389 390 391
# ----
# Function for composing two opt-fns together

392 393 394
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

395 396 397 398 399 400 401 402 403 404 405
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 ):
406
    global thisdir_testopts
407 408
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
409
    thisdir_testopts.testdir = dir
410 411 412 413

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

414
allTests = []
415
allTestNames = set([])
416 417

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
418
    n = 1
419 420 421 422

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

ei@vuokko.info's avatar
ei@vuokko.info committed
423
    setup(opts)
424

425
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
426
        n = config.threads
427

ei@vuokko.info's avatar
ei@vuokko.info committed
428 429
    ok = 0

430
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
431
        t.thread_pool.acquire()
432 433 434 435 436 437 438 439 440 441 442 443
        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)
444

445 446 447 448
# name  :: String
# setup :: TestOpts -> IO ()  
def test (name, setup, func, args):
    global allTests
449 450 451
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
452 453
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
454
    allTestNames.add(name)
455

456 457 458 459 460 461 462 463 464 465 466
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()
467
    
ei@vuokko.info's avatar
ei@vuokko.info committed
468 469 470
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
471
    # All the ways we might run this test
472
    if func == compile or func == multimod_compile:
473
        all_ways = config.compile_ways
474
    elif func == compile_and_run or func == multimod_compile_and_run:
475
        all_ways = config.run_ways
476 477
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
478
            all_ways = ['ghci']
479
        else:
480
            all_ways = []
481
    else:
482 483
        all_ways = ['normal']

484 485 486
    # 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)
487

488 489 490
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
491
        not getTestOpts().skip \
492
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
493
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
494
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
495
        and way not in getTestOpts().omit_ways
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

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

512
    if getTestOpts().cleanup != '':
Ian Lynagh's avatar
Ian Lynagh committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
        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)

529 530 531 532 533 534 535 536
        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')
537

538 539 540 541
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
542 543 544 545 546
    for name in names:
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
547
            try:
Ian Lynagh's avatar
Ian Lynagh committed
548 549 550 551 552 553 554 555 556 557 558
                # ... 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
559

560
def do_test(name, way, func, args):
561 562 563
    full_name = name + '(' + way + ')'

    try:
564 565 566 567
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
568
        
569 570
        if config.use_threads:
            t.lock.release()
571 572 573 574 575 576 577 578 579 580

        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
581 582 583
        try:
            result = apply(func, [name,way] + args)
        finally:
584 585
            if config.use_threads:
                t.lock.acquire()
586
        
ei@vuokko.info's avatar
ei@vuokko.info committed
587
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
588
           result != 'pass' and result != 'fail':
589
            framework_fail(name, way, 'bad results ' + result)
590 591

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
592 593
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
594
                t.n_expected_passes = t.n_expected_passes + 1
595 596 597 598
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
599 600 601
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
602 603 604 605
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
606
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
607 608
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
609 610
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
611 612 613 614
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
615 616
            else:
                t.n_expected_failures = t.n_expected_failures + 1
617 618 619 620
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
621
    except:
622
        framework_fail(name, way, 'do_test exception')
623 624
        traceback.print_exc()

625
def skiptest (name, way):
626 627
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
628 629 630 631
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
632

633 634 635
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
636
    t.n_framework_failures = t.n_framework_failures + 1
637 638 639 640
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
641

642 643 644 645
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
646 647 648 649 650 651
#
# 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.
652

653
def run_command( name, way, cmd ):
654
    return simple_run( name, '', cmd, '' )
655

656 657 658 659
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
660
    # filter out -fforce-recomp from compiler_always_flags, because we're
661
    # actually testing the recompilation behaviour in the GHCi tests.
662
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
663
    flags.append(getTestOpts().extra_hc_opts)
664 665 666 667 668 669

    # 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 + "'" + \
670
          ' --interactive -v0 -ignore-dot-ghci ' + \
671 672
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
673
    getTestOpts().stdin = script
674
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
675

676 677 678 679 680 681 682 683 684 685 686 687
# -----------------------------------------------------------------------------
# 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 )

688 689 690
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

691 692 693 694 695
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
696 697
    if result == 'fail':
        return result
698 699 700 701 702

    # 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
703
    if getTestOpts().with_namebase == None:
704 705
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
706
        namebase = getTestOpts().with_namebase
707 708

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
709 710
    actual_stderr_file = qualify(name, 'comp.stderr')

711 712 713
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
714 715 716 717 718 719 720

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

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

721
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
722 723 724
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

725
    if way == 'ghci': # interpreted...
726
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
727
    elif way == 'extcore' or way == 'optextcore' :
728
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
729
    else: # compiled...
730
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
Ian Lynagh's avatar
Ian Lynagh committed
731 732
        if result == 'fail':
            return result
733

734
        cmd = './' + name;
735 736
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
737

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

741 742
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
743 744

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
745
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
746

Ian Lynagh's avatar
Ian Lynagh committed
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775
# -----------------------------------------------------------------------------
# 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'

776 777 778 779
# -----------------------------------------------------------------------------
# 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
780
    opts = getTestOpts()
781 782 783 784 785 786 787
    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
788
        srcname = add_hs_lhs_suffix(name)
789 790 791 792 793 794

    to_do = ''
    if top_mod != '':
        to_do = '--make -o ' + name
    elif link:
        to_do = '-o ' + name
Ian Lynagh's avatar
Ian Lynagh committed
795
    elif opts.compile_to_hc:
796 797 798 799
        to_do = '-C'
    else:
        to_do = '-c' # just compile

Ian Lynagh's avatar
Ian Lynagh committed
800 801
    stats_file = name + '.comp.stats'
    if opts.compiler_stats_num_fields != []:
802
        extra_hc_opts += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
803

804
    cmd = 'cd ' + getTestOpts().testdir + " && '" \
805 806
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
807 808
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
809
          + extra_hc_opts + ' ' \
Ian Lynagh's avatar
Ian Lynagh committed
810
          + opts.extra_hc_opts + ' ' \
811
          + '>' + errname + ' 2>&1'
812 813 814 815 816 817 818 819 820 821

    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
822 823 824 825 826 827 828 829 830 831 832 833 834
    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'
835 836 837 838 839 840 841 842

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

843
def simple_run( name, way, prog, args ):
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
    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'))
864
   
865 866
    my_rts_flags = rts_flags(way)

Ian Lynagh's avatar
Ian Lynagh committed
867
    stats_file = name + '.stats'
868
    if opts.stats_num_fields != []:
869
        args += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
870

871 872 873 874
    if opts.no_stdin:
        stdin_comes_from = ''
    else:
        stdin_comes_from = ' <' + use_stdin
875
    cmd = 'cd ' + getTestOpts().testdir + ' && ' \
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
	    + 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

898 899 900 901 902
    if not opts.ignore_output:
        if not check_stderr_ok(name):
            return 'fail'
        if not check_stdout_ok(name):
            return 'fail'
903
        # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
904 905 906 907 908
        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
909
    num_field_fail = checkStats(stats_file, opts.stats_num_fields)
910

Ian Lynagh's avatar
Ian Lynagh committed
911 912
    if num_field_fail:
        return 'fail'
913

914
    return 'pass'
915

916 917 918 919 920 921 922 923 924 925 926
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

927 928 929
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

930
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
931 932 933 934 935 936
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
937 938 939 940 941
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

942
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
943
        srcname = add_hs_lhs_suffix(name)
944 945 946
    else:
        srcname = top_mod
        
947
    scriptname = add_suffix(name, 'genscript')
948 949 950 951 952 953 954 955 956 957
    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
958
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
959 960 961 962
        # 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)
963 964
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
965 966
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
967
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
968 969
    script.close()

970
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
971 972
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
973 974 975
    else:
        stdin_file = qualify(name, 'stdin')

976 977 978 979
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
980 981
    script.close()

982
    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
983 984 985 986 987
          + 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
988
          + getTestOpts().extra_hc_opts + ' ' \
989 990 991 992
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

993 994 995
    exit_code = result >> 8
    signal    = result & 0xff

996 997 998 999 1000 1001 1002 1003
    # 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'))

1004 1005 1006 1007 1008 1009 1010
    # 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'

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

1013 1014
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
        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()
1026
    line = re.sub('\r', '', line) # ignore Windows EOL
1027
    while (re.sub('^\s*','',line) != delimiter and line != ''):
1028 1029
        out1.write(line)
        line = infile.readline()
1030
	line = re.sub('\r', '', line)
1031
    out1.close()
1032 1033 1034 1035 1036

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
1037
    out2.close()
1038
    
krc's avatar
krc committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
# -----------------------------------------------------------------------------
# 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
1056
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
    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 + ' ' 

1071
    cmd = 'cd ' + getTestOpts().testdir + " && '" \
krc's avatar
krc committed
1072 1073 1074 1075
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
1076
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
          + 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]),' ')
    
1101
    cmd = 'cd ' + getTestOpts().testdir + " && '" \
krc's avatar
krc committed
1102 1103 1104 1105
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + to_compile + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
1106
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar