testlib.py 39.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
# 
# (c) Simon Marlow 2002
#

import sys
import os
import string
import re
import traceback
import copy
11
import glob
12
import types
13

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

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

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

# Options valid for all the tests in the current "directory".  After
# each test, we reset the options to these.  To change the options for
# multiple tests, the function setTestOpts() below can be used to alter
# these options.
global thisdir_testopts
thisdir_testopts = TestOptions()

def getThisDirTestOpts():
    return thisdir_testopts

# Options valid for the current test only (these get reset to
# testdir_testopts after each test).
41

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

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

ei@vuokko.info's avatar
ei@vuokko.info committed
53
54
55
def setLocalTestOpts(opts):
    global testopts_local
    testopts_local.x=opts
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# This can be called at the top of a file of tests, to set default test options
# for the following tests.
def setTestOpts( f ):
    f( thisdir_testopts );

# -----------------------------------------------------------------------------
# Canned setup functions for common cases.  eg. for a test you might say
#
#      test('test001', normal, compile, [''])
#
# to run it without any options, but change it to
#
#      test('test001', expect_fail, compile, [''])
#
# to expect failure for this test.

def normal( opts ):
    return;

def skip( opts ):
    opts.skip = 1

def expect_fail( opts ):
    opts.expect = 'fail';

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

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

89
def _reqlib( opts, lib ):
90
91
    if have_lib.has_key(lib):
        got_it = have_lib[lib]
92
    else:
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
        if have_subprocess:
            # By preference we use subprocess, as the alternative uses
            # /dev/null which mingw doesn't have.
            p = subprocess.Popen([config.ghc_pkg, 'describe', lib],
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.PIPE)
            # read from stdout and stderr to avoid blocking due to
            # buffers filling
            p.communicate()
            r = p.wait()
        else:
            r = os.system(config.ghc_pkg + ' describe ' + lib
                                         + ' > /dev/null 2> /dev/null')
        got_it = r == 0
        have_lib[lib] = got_it

    if not got_it:
110
111
        opts.expect = 'fail'

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

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

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

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

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

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

def expect_fail_for( ways ):
    return lambda opts, w=ways: _expect_fail_for( opts, w )

def _expect_fail_for( opts, ways ):
    opts.expect_fail_for = ways

Ian Lynagh's avatar
Ian Lynagh committed
136
137
138
139
def expect_broken_for( bug, ways ):
    return lambda opts, b=bug, w=ways: _expect_broken_for( opts, b, w )

def _expect_broken_for( opts, bug, ways ):
Ian Lynagh's avatar
Ian Lynagh committed
140
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
141

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

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

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

# -----

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

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

# -----

160
161
162
163
164
165
166
167
def extra_ways( ways ):
    return lambda opts, w=ways: _extra_ways( opts, w )

def _extra_ways( opts, ways ):
    opts.extra_ways = ways

# -----

ross's avatar
ross committed
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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

# -----

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

208
209
# -----

210
211
212
def no_clean( opts ):
    opts.cleanup = '';

213
214
215
216
217
218
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

219
220
221
222
223
224
# -----

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

225
226
227
228
229
230
# ----

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

Simon Marlow's avatar
Simon Marlow committed
231
232
# -----

233
def if_platform( plat, f ):
Simon Marlow's avatar
Simon Marlow committed
234
    if config.platform == plat:
235
        return f
236
237
238
239
240
241
    else:
        return normal

def if_os( os, f ):
    if config.os == os:
        return f
242
243
244
    else:
        return normal

245
246
# ---

247
248
249
250
251
252
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
253
def if_compiler_lt( compiler, version, f ):
254
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
255
256
257
258
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
259

Ian Lynagh's avatar
Ian Lynagh committed
260
def if_compiler_le( compiler, version, f ):
261
262
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
263
264
265
        return f
    else:
        return normal
266

Ian Lynagh's avatar
Ian Lynagh committed
267
def if_compiler_gt( compiler, version, f ):
268
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
269
270
271
272
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
273

Ian Lynagh's avatar
Ian Lynagh committed
274
def if_compiler_ge( compiler, version, f ):
275
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
276
277
278
279
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
280

Ian Lynagh's avatar
Ian Lynagh committed
281
282
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
283

Ian Lynagh's avatar
Ian Lynagh committed
284
285
def _namebase( opts, nb ):
    opts.with_namebase = nb
286

287
288
# ---

289
290
291
292
293
294
295
296
297
298
299
300
301
def skip_if_tag( tag ):
   return lambda opts, t=tag: _skip_if_tag(opts, t)

def _skip_if_tag( opts, tag ):
    if tag in config.compiler_tags:
	opts.skip = 1
	
def skip_unless_tag( tag ):
   return lambda opts, t=tag: _skip_unless_tag(opts, t)

def _skip_unless_tag( opts, tag ):
    if not (tag in config.compiler_tags):
	opts.skip = 1
302

ei@vuokko.info's avatar
ei@vuokko.info committed
303
# ---
304
305
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
306

Ian Lynagh's avatar
Ian Lynagh committed
307
308
309
310
# ---
def literate( opts ):
    opts.literate = 1;

311
312
313
def c_src( opts ):
    opts.c_src = 1;

314
315
316
317
318
319
320
321
# ----

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

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

322
323
324
325
326
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

327
328
329
# ----
# Function for composing two opt-fns together

330
331
332
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

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

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

global testdir
testdir = '.'

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

def getTestDir():
    return testdir

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

# name  :: String
# setup :: TestOpts -> IO ()  
ei@vuokko.info's avatar
ei@vuokko.info committed
360
361
362
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
363
364
365
366

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

ei@vuokko.info's avatar
ei@vuokko.info committed
367
    setup(opts)
368

369
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
370
        n = config.threads
371

ei@vuokko.info's avatar
ei@vuokko.info committed
372
373
    ok = 0

374
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
375
        t.thread_pool.acquire()
376
377
378
379
380
381
382
383
384
385
386
387
        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)
388

389
390
391
392
393
394
395
396
397
398
399
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()
400
    
ei@vuokko.info's avatar
ei@vuokko.info committed
401
402
403
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
404
    # All the ways we might run this test
405
    if func == compile or func == multimod_compile:
406
        all_ways = config.compile_ways
407
    elif func == compile_and_run or func == multimod_compile_and_run:
408
        all_ways = config.run_ways
409
410
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
411
            all_ways = ['ghci']
412
        else:
413
            all_ways = []
414
    else:
415
416
        all_ways = ['normal']

417
418
419
    # 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)
420

421
422
423
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
424
        not getTestOpts().skip \
425
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
426
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
427
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
428
        and way not in getTestOpts().omit_ways
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443

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

445
    clean(map (lambda suff: name + suff,
446
447
448
449
450
451
452
              ['', '.exe', '.genscript',
               '.run.stderr',            '.run.stdout',
               '.run.stderr.normalised', '.run.stdout.normalised',
               '.comp.stderr',            '.comp.stdout',
               '.comp.stderr.normalised', '.comp.stdout.normalised',
               '.interp.stderr',            '.interp.stdout',
               '.interp.stderr.normalised', '.interp.stdout.normalised',
Ian Lynagh's avatar
Ian Lynagh committed
453
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
454
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
455

456
457
    clean(getTestOpts().clean_files)

458
459
460
461
462
463
464
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
465
    if getTestOpts().cleanup != '':
466
        for name in names:
467
            try:
468
                os.remove(name)
469
470
            except OSError:
                pass
471

472
def do_test(name, way, func, args):
473
474
475
476
477
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
478
479
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
480
481
482
        try:
            result = apply(func, [name,way] + args)
        finally:
483
484
            if config.use_threads:
                t.lock.acquire()
485
        
ei@vuokko.info's avatar
ei@vuokko.info committed
486
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
487
           result != 'pass' and result != 'fail':
488
            framework_fail(name, way, 'bad results ' + result)
489
490

        if result == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
491
492
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
493
                t.n_expected_passes = t.n_expected_passes + 1
494
495
496
497
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
498
499
500
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
501
502
503
504
                if name in t.unexpected_passes:
                    t.unexpected_passes[name].append(way)
                else:
                    t.unexpected_passes[name] = [way]
505
        else:
ei@vuokko.info's avatar
ei@vuokko.info committed
506
507
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
508
509
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
510
511
512
513
                if name in t.unexpected_failures:
                    t.unexpected_failures[name].append(way)
                else:
                    t.unexpected_failures[name] = [way]
514
515
            else:
                t.n_expected_failures = t.n_expected_failures + 1
516
517
518
519
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
520
    except:
521
        framework_fail(name, way, 'do_test exception')
522
523
        traceback.print_exc()

524
def skiptest (name, way):
525
526
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
527
528
529
530
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
531

532
533
534
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
535
    t.n_framework_failures = t.n_framework_failures + 1
536
537
538
539
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
540

541
542
543
544
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
545
546
547
548
549
550
#
# 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.
551

552
def run_command( name, way, cmd ):
553
    return simple_run( name, '', cmd, '' )
554

555
556
557
558
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
559
    # filter out -fforce-recomp from compiler_always_flags, because we're
560
    # actually testing the recompilation behaviour in the GHCi tests.
561
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
simonpj's avatar
simonpj committed
562
    flags.append(getTestOpts().extra_hc_opts)
563
564
565
566
567
568

    # 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 + "'" + \
569
          ' --interactive -v0 -ignore-dot-ghci ' + \
570
571
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
572
    getTestOpts().stdin = script
573
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
574

575
576
577
578
579
580
581
582
583
584
585
586
# -----------------------------------------------------------------------------
# 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 )

587
588
589
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
def do_compile( name, way, should_fail, top_mod, extra_hc_opts ):
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0 )
    
    if should_fail:
        if result == 0:
            return 'fail'
    else:
        if result != 0:
            return 'fail'

    # the actual stderr should always match the expected, regardless
    # of whether we expected the compilation to fail or not (successful
    # compilations may generate warnings).

Ian Lynagh's avatar
Ian Lynagh committed
606
    if getTestOpts().with_namebase == None:
607
608
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
609
        namebase = getTestOpts().with_namebase
610
611

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
612
613
    actual_stderr_file = qualify(name, 'comp.stderr')

614
615
616
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
617
618
619
620
621
622
623

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

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

624
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
625
626
627
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

628
    if way == 'ghci': # interpreted...
629
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
630
    elif way == 'extcore' or way == 'optextcore' :
631
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
632
    else: # compiled...
633
634
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
635
636
637
        if result != 0:
            return 'fail'

638
        cmd = './' + name;
639
640
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
641

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

645
646
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
647
648

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
649
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
650

651
652
653
654
655
656
657
658
659
660
661
# -----------------------------------------------------------------------------
# Build a single-module program

def simple_build( name, way, extra_hc_opts, should_fail, top_mod, link ):
    errname = add_suffix(name, 'comp.stderr')
    rm_no_fail( errname )
    rm_no_fail( name )
    
    if top_mod != '':
        srcname = top_mod
    else:
Ian Lynagh's avatar
Ian Lynagh committed
662
        srcname = add_hs_lhs_suffix(name)
663
664
665
666
667
668

    to_do = ''
    if top_mod != '':
        to_do = '--make -o ' + name
    elif link:
        to_do = '-o ' + name
ei@vuokko.info's avatar
ei@vuokko.info committed
669
    elif getTestOpts().compile_to_hc:
670
671
672
673
674
675
676
677
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
678
679
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
680
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
681
          + getTestOpts().extra_hc_opts + ' ' \
682
          + '>' + errname + ' 2>&1'
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701

    result = runCmd(cmd)

    if result != 0 and not should_fail:
        actual_stderr = qualify(name, 'comp.stderr')
        if_verbose(1,'Compile failed (status ' + `result` + ') errors were:')
        if_verbose(1,open(actual_stderr).read())

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

    return result

# -----------------------------------------------------------------------------
# Run a program and check its output
#
# If testname.stdin exists, route input from that, else
# from /dev/null.  Route output to testname.run.stdout and 
# testname.run.stderr.  Returns the exit code of the run.

702
def simple_run( name, way, prog, args ):
703
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
704
705
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
706
707
708
709
710
711
712
713
714
715
716
   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'))
717
   rm_no_fail(qualify(name,'run.stderr'))
718
719
720
721
   rm_no_fail(qualify(name, 'hp'))
   rm_no_fail(qualify(name,'ps'))
   
   my_rts_flags = rts_flags(way)
722

723
724
725
726
   if getTestOpts().no_stdin:
     stdin_comes_from = ''
   else:
     stdin_comes_from = ' <' + use_stdin
727
   cmd = 'cd ' + testdir + ' && ' \
728
	  + prog + ' ' + args + ' ' \
729
          + my_rts_flags + ' ' \
730
          + stdin_comes_from \
731
732
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
733
734
735
736

   # run the command
   result = runCmd(cmd)

737
   exit_code = result >> 8
738
739
740
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
741
742
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
743
744
       dump_stdout(name)
       dump_stderr(name)
745
746
       return 'fail'

747
748
   check_hp = my_rts_flags.find("-h") != -1

749
750
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
751
752
                                      (not check_hp or exit_code > 127 or check_hp_ok(name))):
       # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
753
754
755
756
       return 'pass'
   else:
       return 'fail'

757
758
759
760
761
762
763
764
765
766
767
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

768
769
770
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

771
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
772
773
774
775
776
777
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
778
779
780
781
782
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

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

811
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
812
813
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
814
815
816
    else:
        stdin_file = qualify(name, 'stdin')

817
818
819
820
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
821
822
    script.close()

823
    cmd = 'cd ' + testdir + " && " + cmd_prefix + "'" \
824
825
826
827
828
          + 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
829
          + getTestOpts().extra_hc_opts + ' ' \
830
831
832
833
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

834
835
836
    exit_code = result >> 8
    signal    = result & 0xff

837
838
839
840
841
842
843
844
    # 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'))

845
846
847
848
849
850
851
    # 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'

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

854
855
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
856
857
858
859
860
861
862
863
864
865
866
        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()
867
    line = re.sub('\r', '', line) # ignore Windows EOL
868
    while (re.sub('^\s*','',line) != delimiter and line != ''):
869
870
        out1.write(line)
        line = infile.readline()
871
	line = re.sub('\r', '', line)
872
    out1.close()
873
874
875
876
877

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
878
    out2.close()
879
    
krc's avatar
krc committed
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
# -----------------------------------------------------------------------------
# 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
897
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
    else:
        srcname = top_mod

    qcorefilename = qualify(name, 'hcr')
    corefilename = add_suffix(name, 'hcr')
    rm_no_fail(qcorefilename)

    # Generate External Core
    
    if (top_mod == ''):
        to_do = ' ' + srcname + ' '
    else:
        to_do = ' --make ' + top_mod + ' ' 

    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
917
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
          + to_do \
          + '>' + errname + ' 2>&1'
    result = runCmd(cmd)

    exit_code = result >> 8

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

     # Compile the resulting files -- if there's more than one module, we need to read the output
     # of the previous compilation in order to find the dependencies
    if (top_mod == ''):
        to_compile = corefilename
    else:
        result = runCmd('grep Compiling ' + qerrname + ' |  awk \'{print $4}\' > ' + depsfilename)
        deps = open(depsfilename).read()
        deplist = string.replace(deps, '\n',' ');
        deplist2 = string.replace(deplist,'.lhs,', '.hcr');
        to_compile = string.replace(deplist2,'.hs,', '.hcr');
        
    flags = join(filter(lambda f: f != '-fext-core',config.way_flags[way]),' ')
    
    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
          + to_compile + ' ' \
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
947
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
          + 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 )
    
966
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
967

968
969
970
971
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
972
   if getTestOpts().with_namebase == None:
973
974
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
975
       namebase = getTestOpts().with_namebase
976

977
   actual_stdout_file   = qualify(name, 'run.stdout')
978
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(namebase, 'stdout')
979

980
981
982
983
984
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
985

986
   return compare_outputs('stdout', norm, getTestOpts().extra_normaliser, \
987
                          expected_stdout_file, actual_stdout_file)
988

989
990
991
992
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

993
def check_stderr_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
994
   if getTestOpts().with_namebase == None:
995
996
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
997
       namebase = getTestOpts().with_namebase
998

999
   actual_stderr_file   = qualify(name, 'run.stderr')
1000
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
1001

1002
1003
1004
1005
1006
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
1007

1008
   return compare_outputs('stderr', norm, getTestOpts().extra_normaliser, \
1009
                          expected_stderr_file, actual_stderr_file)
1010

1011
1012
1013
1014
def dump_stderr( name ):
   print "Stderr:"
   print read_no_crs(qualify(name, 'run.stderr'))

1015
1016
1017
1018
1019
def read_no_crs(file):
    h = open(file)
    str = h.read()
    h.close
    return re.sub('\r', '', str)
1020

1021
1022
1023
1024
def write_file(file, str):
    h = open(file, 'w')
    h.write(str)
    h.close
1025

1026
1027
1028
1029
1030
1031
1032
def check_hp_ok(name):

    # do not qualify for hp2ps because we should be in the right directory
    hp2psCmd = 'cd ' + testdir + ' && ' + config.hp2ps + ' ' + name 

    hp2psResult = runCmdExitCode(hp2psCmd)

1033
    actual_ps_file = qualify(name, 'ps')
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
    
    if(hp2psResult == 0):
        if (os.path.exists(actual_ps_file)):
            if gs_working:
                gsResult = runCmdExitCode(genGSCmd(actual_ps_file))
                if (gsResult == 0):
                    return (True)
                else:
                    print "hp2ps output for " + name + "is not valid PostScript"
            else: return (True) # assume postscript is valid without ghostscript
        else: 
1045
            print "hp2ps did not generate PostScript for " + name
1046
1047
1048
1049
1050
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

Ian Lynagh's avatar
Ian Lynagh committed
1051
# Compare expected output to actual output, and optionally accept the
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# new output. Returns true if output matched or was accepted, false
# otherwise.
def compare_outputs( kind, normaliser, extra_normaliser,
                     expected_file, actual_file ):
    if os.path.exists(expected_file):
        expected_raw = read_no_crs(expected_file)
        expected_str = normaliser(expected_raw)
    else:
        expected_str = ''
        expected_file = ''
1062

1063
1064
    actual_raw = read_no_crs(actual_file)
    actual_str = normaliser(actual_raw)
1065

1066
1067
1068
1069
1070
    if extra_normaliser(expected_str) != extra_normaliser(actual_str):
        print 'Actual ' + kind + ' output differs from expected:'

        if expected_file == '':
            expected_normalised_file = '/dev/null'
1071
1072

        else:
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
            expected_normalised_file = expected_file + ".normalised"
            write_file(expected_normalised_file, expected_str)
        actual_normalised_file = actual_file + ".normalised"
        write_file(actual_normalised_file, actual_str)

        os.system( 'diff -u ' + expected_normalised_file + \
                          ' ' + actual_normalised_file )

        if config.accept:
            if expected_file == '':
                print '*** cannot accept new output: ' + kind + \
                      ' file does not exist.'
                return 0
            else:
                print 'Accepting new output.'
                write_file(expected_file, actual_raw)
                return 1
        return 0
    return 1
1092

1093
def normalise_whitespace( str ):
1094
    # Merge contiguous whitespace characters into a single space.
1095
1096
1097
1098
    str = re.sub('[ \t\n]+', ' ', str)
    return str

def normalise_errmsg( str ):
1099
1100
1101
1102
1103
1104
1105
    # Look for file names and zap the directory part:
    #    foo/var/xyzzy/somefile  -->  somefile
    str = re.sub('([^\\s/]+/)*([^\\s/])', '\\2', str)
    # If somefile ends in ".exe" or ".exe:", zap ".exe" (for Windows)
    #    the colon is there because it appears in error messages; this
    #    hacky solution is used in place of more sophisticated filename
    #    mangling
Simon Marlow's avatar
Simon Marlow committed
1106
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1107
1108
    return str

1109
1110
1111
1112
def normalise_slashes_( str ):
    str = re.sub('\\\\', '/', str)
    return str

1113
1114
1115
def normalise_output( str ):
    # Remove a .exe extension (for Windows)
    # This can occur in error messages generated by the program.
Simon Marlow's avatar
Simon Marlow committed
1116
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1117
1118
    return str

1119
1120
1121
1122
1123
1124
1125
def if_verbose( n, str ):
    if config.verbose >= n:
        print str

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

1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
def rawSystem(cmd_and_args):
    # We prefer subprocess.call to os.spawnv as the latter
    # seems to send its arguments through a shell or something
    # with the Windows (non-cygwin) python. An argument "a b c"
    # turns into three arguments ["a", "b", "c"].

    # However, subprocess is new in python 2.4, so fall back to
    # using spawnv if we don't have it

    if have_subprocess:
        return subprocess.call(cmd_and_args)
    else:
        return os.spawnv(os.P_WAIT, cmd_and_args[0], cmd_and_args)

simonpj's avatar
simonpj committed
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
# cmd is a complex command in Bourne-shell syntax 
# e.g (cd . && 'c:/users/simonpj/darcs/HEAD/compiler/stage1/ghc-inplace' ...etc)
# Hence it must ultimately be run by a Bourne shell
# 
# Mostly it invokes the command wrapped in 'timeout' thus
#	timeout 300 'cd . && ...blah blah'
# so it's timeout's job to invoke the Bourne shell
#
# But watch out for the case when there is no timeout program!
# Then, when using the native Python, os.system will invoke the cmd shell

1157
1158
def runCmd( cmd ):
    if_verbose( 1, cmd )
1159
1160
1161
1162
    r = 0
    if config.platform == 'i386-unknown-mingw32':
	# On MinGW, we will always have timeout
        assert config.timeout_prog!=''
1163
1164

    if config.timeout_prog != '':
1165
        r = rawSystem([config.timeout_prog, str(config.timeout), cmd])
1166
    else:
1167
1168
        r = os.system(cmd)
    return r << 8
1169

1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
def runCmdExitCode( cmd ):
    return (runCmd(cmd) >> 8);


# -----------------------------------------------------------------------------
# checking if ghostscript is available for checking the output of hp2ps

def genGSCmd(psfile):
    return (config.gs + ' -dNODISPLAY -dBATCH -dQUIET -dNOPAUSE ' + psfile);

def gsNotWorking():
    global gs_working 
    print "GhostScript not available for hp2ps tests"

global gs_working
1185
1186
1187
gs_working = 0
if config.have_profiling:
  if config.gs != '':
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
    resultGood = runCmdExitCode(genGSCmd(config.confdir + '/good.ps'));
    if resultGood == 0:
        resultBad = runCmdExitCode(genGSCmd(config.confdir + '/bad.ps'));
        if resultBad != 0:
            print "GhostScript available for hp2ps tests"
            gs_working = 1;
        else:
            gsNotWorking();
    else:
        gsNotWorking();
1198
  else:
1199
1200
    gsNotWorking();

1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
def rm_no_fail( file ):
   try:
       os.remove( file )    
   finally:
       return

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

Ian Lynagh's avatar
Ian Lynagh committed
1213
def add_hs_lhs_suffix(name):
1214
1215
1216
    if getTestOpts().c_src:
        return add_suffix(name, 'c')
    elif getTestOpts().literate:
Ian Lynagh's avatar
Ian Lynagh committed
1217
1218
1219
1220
        return add_suffix(name, 'lhs')
    else:
        return add_suffix(name, 'hs')

1221
1222
1223
1224
1225
1226
def in_testdir( name ):
    return os.path.join(testdir, name)

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

1227
1228
1229
1230
1231
1232
1233
1234
1235

# Finding the sample output.  The filename is of the form
#
#   <test>.stdout[-<compiler>][-<version>][-ws-<wordsize>][-<platform>]
#
# and we pick the most specific version available.  The <version> is
# the major version of the compiler (e.g. 6.8.2 would be "6.8").  For
# more fine-grained control use if_compiler_lt().
#
1236
def platform_wordsize_qualify( name, suff ):
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262

    basepath = qualify(name, suff)

    fns = [ lambda x: x + '-' + config.compiler_type,
            lambda x: x + '-' + config.compiler_maj_version,
            lambda x: x + '-ws-' + config.wordsize ]

    paths = [ basepath ]
    for fn in fns:
        paths = paths + map(fn, paths)

    paths.reverse()

    plat_paths = map (lambda x: x + '-' + config.platform, paths)

    dir = glob.glob(basepath + '*')

    for f in plat_paths:
       if f in dir:
            return (1,f)

    for f in paths:
       if f in dir:
            return (0,f)

    return (0, basepath)
1263
1264
1265
1266
1267
1268
1269

# Clean up prior to the test, so that we can't spuriously conclude
# that it passed on the basis of old run outputs.
def pretest_cleanup(name):
   rm_no_fail(qualify(name,'comp.stderr'))
   rm_no_fail(qualify(name,'run.stderr'))
   rm_no_fail(qualify(name,'run.stdout'))
1270
   rm_no_fail(qualify(name,'tix'))	# remove the old tix file
1271
1272
1273
1274
1275
1276
1277
1278
   # simple_build zaps the following:
   # rm_nofail(qualify("o"))
   # rm_nofail(qualify(""))
   # not interested in the return code

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

1279
1280
1281
1282
def findTFiles(roots):
    return concat(map(findTFiles_,roots))

def findTFiles_(path):    
1283
1284
    if os.path.isdir(path):
        paths = map(lambda x, p=path: p + '/' + x, os.listdir(path))
1285
        return findTFiles(paths)
1286
1287
1288
1289
1290
1291
1292
1293
1294
    elif path[-2:] == '.T':
        return [path]
    else:
        return []

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

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

1296
1297
    file.write('\n')
    file.write('OVERALL SUMMARY for test run started at ' \
krc's avatar
krc committed
1298
               + t.start_time + '\n'\
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314