testlib.py 39.8 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
221
222
# -----

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

223
224
225
226
227
228
# ----

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

Simon Marlow's avatar
Simon Marlow committed
229
230
# -----

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

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

243
244
# ---

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

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

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

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

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

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

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

285
286
# ---

287
def if_tag( tag, f ):
288
    if tag in config.compiler_tags:
289
290
291
        return f
    else:
        return normal
292

293
def unless_tag( tag, f ):
294
    if not (tag in config.compiler_tags):
295
296
297
        return f
    else:
        return normal
298

ei@vuokko.info's avatar
ei@vuokko.info committed
299
# ---
300
301
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
302

Ian Lynagh's avatar
Ian Lynagh committed
303
304
305
306
# ---
def literate( opts ):
    opts.literate = 1;

307
308
309
def c_src( opts ):
    opts.c_src = 1;

310
311
312
313
314
315
316
317
# ----

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

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

318
319
320
321
322
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

323
324
325
# ----
# Function for composing two opt-fns together

326
327
328
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
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
356
357
358
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
359
360
361
362

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

ei@vuokko.info's avatar
ei@vuokko.info committed
363
    setup(opts)
364

365
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
366
        n = config.threads
367

ei@vuokko.info's avatar
ei@vuokko.info committed
368
369
    ok = 0

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

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

413
414
415
    # 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)
416

417
418
419
    t.total_test_cases = t.total_test_cases + len(all_ways)

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

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

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

453
454
    clean(getTestOpts().clean_files)

455
456
457
458
459
460
461
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
462
    if getTestOpts().cleanup != '':
463
        for name in names:
464
            try:
465
                # Remove files...
466
                os.remove(name)
467
            except OSError, e1:
468
469
470
                try:
                    # ... and empty directories
                    os.rmdir(name)
471
472
473
474
475
476
477
478
479
                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
480

481
def do_test(name, way, func, args):
482
483
484
485
486
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
487
488
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
489
490
491
        try:
            result = apply(func, [name,way] + args)
        finally:
492
493
            if config.use_threads:
                t.lock.acquire()
494
        
ei@vuokko.info's avatar
ei@vuokko.info committed
495
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
496
           result != 'pass' and result != 'fail':
497
            framework_fail(name, way, 'bad results ' + result)
498
499

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

533
def skiptest (name, way):
534
535
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
536
537
538
539
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
540

541
542
543
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
544
    t.n_framework_failures = t.n_framework_failures + 1
545
546
547
548
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
549

550
551
552
553
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
554
555
556
557
558
559
#
# 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.
560

561
def run_command( name, way, cmd ):
562
    return simple_run( name, '', cmd, '' )
563

564
565
566
567
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
568
    # filter out -fforce-recomp from compiler_always_flags, because we're
569
    # actually testing the recompilation behaviour in the GHCi tests.
570
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
simonpj's avatar
simonpj committed
571
    flags.append(getTestOpts().extra_hc_opts)
572
573
574
575
576
577

    # 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 + "'" + \
578
          ' --interactive -v0 -ignore-dot-ghci ' + \
579
580
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
581
    getTestOpts().stdin = script
582
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
583

584
585
586
587
588
589
590
591
592
593
594
595
# -----------------------------------------------------------------------------
# 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 )

596
597
598
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
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
615
    if getTestOpts().with_namebase == None:
616
617
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
618
        namebase = getTestOpts().with_namebase
619
620

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
621
622
    actual_stderr_file = qualify(name, 'comp.stderr')

623
624
625
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
626
627
628
629
630
631
632

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

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

633
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
634
635
636
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

637
    if way == 'ghci': # interpreted...
638
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
639
    elif way == 'extcore' or way == 'optextcore' :
640
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
641
    else: # compiled...
642
643
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
644
645
646
        if result != 0:
            return 'fail'

647
        cmd = './' + name;
648
649
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
650

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

654
655
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
656
657

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
658
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
659

660
661
662
663
664
665
666
667
668
669
670
# -----------------------------------------------------------------------------
# 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
671
        srcname = add_hs_lhs_suffix(name)
672
673
674
675
676
677

    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
678
    elif getTestOpts().compile_to_hc:
679
680
681
682
683
684
685
686
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
687
688
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
689
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
690
          + getTestOpts().extra_hc_opts + ' ' \
691
          + '>' + errname + ' 2>&1'
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710

    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.

711
def simple_run( name, way, prog, args ):
712
   # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
713
714
   if getTestOpts().stdin != '':
       use_stdin = getTestOpts().stdin
715
716
717
718
719
720
721
722
723
724
725
   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'))
726
   rm_no_fail(qualify(name,'run.stderr'))
727
728
729
730
   rm_no_fail(qualify(name, 'hp'))
   rm_no_fail(qualify(name,'ps'))
   
   my_rts_flags = rts_flags(way)
731

732
733
734
735
   if getTestOpts().no_stdin:
     stdin_comes_from = ''
   else:
     stdin_comes_from = ' <' + use_stdin
736
   cmd = 'cd ' + testdir + ' && ' \
737
	  + prog + ' ' + args + ' ' \
738
          + my_rts_flags + ' ' \
739
          + stdin_comes_from \
740
741
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
742
743
744
745

   # run the command
   result = runCmd(cmd)

746
   exit_code = result >> 8
747
748
749
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
750
751
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
752
753
       dump_stdout(name)
       dump_stderr(name)
754
755
       return 'fail'

756
757
   check_hp = my_rts_flags.find("-h") != -1

758
759
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
760
761
                                      (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.
762
763
764
765
       return 'pass'
   else:
       return 'fail'

766
767
768
769
770
771
772
773
774
775
776
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

777
778
779
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

780
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
781
782
783
784
785
786
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
    
787
788
789
790
791
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

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

820
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
821
822
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
823
824
825
    else:
        stdin_file = qualify(name, 'stdin')

826
827
828
829
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
830
831
    script.close()

832
    cmd = 'cd ' + testdir + " && " + cmd_prefix + "'" \
833
834
835
836
837
          + 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
838
          + getTestOpts().extra_hc_opts + ' ' \
839
840
841
842
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

843
844
845
    exit_code = result >> 8
    signal    = result & 0xff

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

854
855
856
857
858
859
860
    # 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'

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

863
864
    if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                       check_stdout_ok(name)):
865
866
867
868
869
870
871
872
873
874
875
        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()
876
    line = re.sub('\r', '', line) # ignore Windows EOL
877
    while (re.sub('^\s*','',line) != delimiter and line != ''):
878
879
        out1.write(line)
        line = infile.readline()
880
	line = re.sub('\r', '', line)
881
    out1.close()
882
883
884
885
886

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
887
    out2.close()
888
    
krc's avatar
krc committed
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
# -----------------------------------------------------------------------------
# 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
906
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
    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
926
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
          + 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
956
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
          + 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 )
    
975
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
976

977
978
979
980
# -----------------------------------------------------------------------------
# Utils

def check_stdout_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
981
   if getTestOpts().with_namebase == None:
982
983
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
984
       namebase = getTestOpts().with_namebase
985

986
   actual_stdout_file   = qualify(name, 'run.stdout')
987
   (platform_specific, expected_stdout_file) = platform_wordsize_qualify(namebase, 'stdout')
988

989
990
991
992
993
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
994

995
   return compare_outputs('stdout', norm, getTestOpts().extra_normaliser, \
996
                          expected_stdout_file, actual_stdout_file)
997

998
999
1000
1001
def dump_stdout( name ):
   print "Stdout:"
   print read_no_crs(qualify(name, 'run.stdout'))

1002
def check_stderr_ok( name ):
Ian Lynagh's avatar
Ian Lynagh committed
1003
   if getTestOpts().with_namebase == None:
1004
1005
       namebase = name
   else:
Ian Lynagh's avatar
Ian Lynagh committed
1006
       namebase = getTestOpts().with_namebase
1007

1008
   actual_stderr_file   = qualify(name, 'run.stderr')
1009
   (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
1010

1011
1012
1013
1014
1015
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
1016

1017
   return compare_outputs('stderr', norm, getTestOpts().extra_normaliser, \
1018
                          expected_stderr_file, actual_stderr_file)
1019

1020
1021
1022
1023
def dump_stderr( name ):
   print "Stderr:"
   print read_no_crs(qualify(name, 'run.stderr'))

1024
1025
1026
1027
1028
def read_no_crs(file):
    h = open(file)
    str = h.read()
    h.close
    return re.sub('\r', '', str)
1029

1030
1031
1032
1033
def write_file(file, str):
    h = open(file, 'w')
    h.write(str)
    h.close
1034

1035
1036
1037
1038
1039
1040
1041
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)

1042
    actual_ps_file = qualify(name, 'ps')
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
    
    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: 
1054
            print "hp2ps did not generate PostScript for " + name
1055
1056
1057
1058
1059
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

Ian Lynagh's avatar
Ian Lynagh committed
1060
# Compare expected output to actual output, and optionally accept the
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
# 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 = ''
1071

1072
1073
    actual_raw = read_no_crs(actual_file)
    actual_str = normaliser(actual_raw)
1074

1075
1076
1077
1078
1079
    if extra_normaliser(expected_str) != extra_normaliser(actual_str):
        print 'Actual ' + kind + ' output differs from expected:'

        if expected_file == '':
            expected_normalised_file = '/dev/null'
1080
1081

        else:
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
            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
1101

1102
def normalise_whitespace( str ):
1103
    # Merge contiguous whitespace characters into a single space.
1104
1105
1106
1107
    str = re.sub('[ \t\n]+', ' ', str)
    return str

def normalise_errmsg( str ):
1108
1109
1110
1111
1112
1113
1114
    # 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
1115
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1116
1117
    return str

1118
1119
1120
1121
def normalise_slashes_( str ):
    str = re.sub('\\\\', '/', str)
    return str

1122
1123
1124
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
1125
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1126
1127
    return str

1128
1129
1130
1131
1132
1133
1134
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':
1135
       return ['-fforce-recomp', '-dcore-lint']
1136
1137
1138
1139
1140
   elif config.compiler_type == 'nhc':
       return ['-an-nhc-specific-flag']
   else:
        return []

1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
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
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
# 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

1166
1167
def runCmd( cmd ):
    if_verbose( 1, cmd )
1168
1169
1170
1171
    r = 0
    if config.platform == 'i386-unknown-mingw32':
	# On MinGW, we will always have timeout
        assert config.timeout_prog!=''
1172
1173

    if config.timeout_prog != '':
1174
        r = rawSystem([config.timeout_prog, str(config.timeout), cmd])
1175
    else:
1176
1177
        r = os.system(cmd)
    return r << 8
1178

1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
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
1194
1195
1196
gs_working = 0
if config.have_profiling:
  if config.gs != '':
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
    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();
1207
  else:
1208
1209
    gsNotWorking();

1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
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
1222
def add_hs_lhs_suffix(name):
1223
1224
1225
    if getTestOpts().c_src:
        return add_suffix(name, 'c')
    elif getTestOpts().literate:
Ian Lynagh's avatar
Ian Lynagh committed
1226
1227
1228
1229
        return add_suffix(name, 'lhs')
    else:
        return add_suffix(name, 'hs')

1230
1231
1232
1233
1234
1235
def in_testdir( name ):
    return os.path.join(testdir, name)

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

1236
1237
1238
1239
1240
1241
1242
1243
1244

# 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().
#
1245
def platform_wordsize_qualify( name, suff ):
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271

    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)
1272
1273
1274
1275
1276
1277
1278

# 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'))
1279
   rm_no_fail(qualify(name,'tix'))	# remove the old tix file
1280
1281
1282
1283
1284
1285
1286
1287
   # 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.