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

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

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

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

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

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

def getThisDirTestOpts():
    return thisdir_testopts

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

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

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

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

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

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

def normal( opts ):
    return;

def skip( opts ):
    opts.skip = 1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# -----

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

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

# -----

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

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

# -----

ross's avatar
ross committed
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def omit_compiler_types( compiler_types ):
   return lambda opts, c=compiler_types: _omit_compiler_types(opts, c)

def _omit_compiler_types( opts, compiler_types ):
    if config.compiler_type in compiler_types:
	opts.skip = 1

# -----

def only_compiler_types( compiler_types ):
   return lambda opts, c=compiler_types: _only_compiler_types(opts, c)

def _only_compiler_types( opts, compiler_types ):
    if config.compiler_type not in compiler_types:
	opts.skip = 1

# -----

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def set_stdin( file ):
   return lambda opts, f=file: _set_stdin(opts, f);

def _set_stdin( opts, f ):
   opts.stdin = f

# -----

def exit_code( val ):
    return lambda opts, v=val: _exit_code(opts, v);

def _exit_code( opts, v ):
    opts.exit_code = v

# -----

def extra_run_opts( val ):
    return lambda opts, v=val: _extra_run_opts(opts, v);

def _extra_run_opts( opts, v ):
    opts.extra_run_opts = v

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

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

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

217
218
# -----

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

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

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

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

231
232
# -----

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

237
238
239
240
241
242
# ----

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

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

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
263
264
265
266
267
268
def unless_os( os, f ):
    if config.os == os:
        return normal
    else:
        return f

269
270
271
272
273
274
def if_arch( arch, f ):
    if config.arch == arch:
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
275
def if_wordsize( ws, f ):
Ian Lynagh's avatar
Ian Lynagh committed
276
    if config.wordsize == str(ws):
Ian Lynagh's avatar
Ian Lynagh committed
277
278
279
280
        return f
    else:
        return normal

Ian Lynagh's avatar
Ian Lynagh committed
281
282
283
284
285
286
287
288
289
290
291
292
def if_msys( f ):
    if config.msys:
        return f
    else:
        return normal

def if_cygwin( f ):
    if config.cygwin:
        return f
    else:
        return normal

293
294
# ---

295
296
297
298
299
300
301
302
303
304
305
306
def if_in_tree_compiler( f ):
    if config.in_tree_compiler:
        return f
    else:
        return normal

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

307
308
309
310
311
def if_compiler_type( compiler, f ):
    if config.compiler_type == compiler:
        return f
    else:
        return normal
312
313
314
315
316
317

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

319
320
321
322
323
324
def unless_compiler_profiled( f ):
    if config.compiler_profiled:
        return normal
    else:
        return f

Ian Lynagh's avatar
Ian Lynagh committed
325
def if_compiler_lt( compiler, version, f ):
326
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
327
328
329
330
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
331

Ian Lynagh's avatar
Ian Lynagh committed
332
def if_compiler_le( compiler, version, f ):
333
334
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
335
336
337
        return f
    else:
        return normal
338

Ian Lynagh's avatar
Ian Lynagh committed
339
def if_compiler_gt( compiler, version, f ):
340
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
341
342
343
344
       version_gt(config.compiler_version, version):
        return f
    else:
        return normal
345

Ian Lynagh's avatar
Ian Lynagh committed
346
def if_compiler_ge( compiler, version, f ):
347
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
348
349
350
351
       version_ge(config.compiler_version, version):
        return f
    else:
        return normal
352

Ian Lynagh's avatar
Ian Lynagh committed
353
354
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
355

Ian Lynagh's avatar
Ian Lynagh committed
356
357
def _namebase( opts, nb ):
    opts.with_namebase = nb
358

359
360
# ---

361
def if_tag( tag, f ):
362
    if tag in config.compiler_tags:
363
364
365
        return f
    else:
        return normal
366

367
def unless_tag( tag, f ):
368
    if not (tag in config.compiler_tags):
369
370
371
        return f
    else:
        return normal
372

ei@vuokko.info's avatar
ei@vuokko.info committed
373
# ---
374
375
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
376

Ian Lynagh's avatar
Ian Lynagh committed
377
378
379
380
# ---
def literate( opts ):
    opts.literate = 1;

381
382
383
def c_src( opts ):
    opts.c_src = 1;

Austin Seipp's avatar
Austin Seipp committed
384
385
386
def objc_src( opts ):
    opts.objc_src = 1;

387
388
# ----

389
390
391
392
393
394
395
396
def pre_cmd( cmd ):
    return lambda opts, c=cmd: _pre_cmd(opts, cmd)

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

# ----

397
398
399
400
401
402
403
404
def clean_cmd( cmd ):
    return lambda opts, c=cmd: _clean_cmd(opts, cmd)

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

# ----

405
406
407
408
409
410
def cmd_prefix( prefix ):
    return lambda opts, p=prefix: _cmd_prefix(opts, prefix)

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

411
412
# ----

Ian Lynagh's avatar
Ian Lynagh committed
413
414
415
416
417
418
419
420
def compile_cmd_prefix( prefix ):
    return lambda opts, p=prefix: _compile_cmd_prefix(opts, prefix)

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

# ----

421
422
423
def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

424
425
426
427
428
429
def normalise_fun( fun ):
    return lambda opts, f=fun: _normalise_fun(opts, f)

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

430
431
432
# ----
# Function for composing two opt-fns together

433
434
435
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

436
437
438
def compose( f, g ):
    return lambda opts, f=f, g=g: _compose(opts,f,g)

439
def _compose( opts, f, g ):
440
441
442
443
444
445
446
    f(opts)
    g(opts)

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

def newTestDir( dir ):
447
    global thisdir_testopts
448
449
    # reset the options for this test directory
    thisdir_testopts = copy.copy(default_testopts)
450
    thisdir_testopts.testdir = dir
451
452
453
454

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

455
allTests = []
456
allTestNames = set([])
457
458

def runTest (opts, name, setup, func, args):
ei@vuokko.info's avatar
ei@vuokko.info committed
459
    n = 1
460
461
462
463

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

ei@vuokko.info's avatar
ei@vuokko.info committed
464
    setup(opts)
465

466
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
467
        n = config.threads
468

ei@vuokko.info's avatar
ei@vuokko.info committed
469
470
    ok = 0

471
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
472
        t.thread_pool.acquire()
473
474
475
476
477
478
479
480
481
482
483
484
        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)
485

486
# name  :: String
487
# setup :: TestOpts -> IO ()
488
489
def test (name, setup, func, args):
    global allTests
490
491
492
    global allTestNames
    if name in allTestNames:
        framework_fail(name, 'duplicate', 'There are multiple tests with this name')
493
494
    myTestOpts = copy.copy(thisdir_testopts)
    allTests += [lambda : runTest(myTestOpts, name, setup, func, args)]
495
    allTestNames.add(name)
496

497
498
499
500
501
502
503
504
505
506
507
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()
508

509
510
511
512
513
514
515
516
517
518
def get_package_cache_timestamp():
    if config.package_conf_cache_file == '':
        return 0.0
    else:
        try:
            return os.stat(config.package_conf_cache_file).st_mtime
        except:
            return 0.0


ei@vuokko.info's avatar
ei@vuokko.info committed
519
520
521
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
522

523
    package_conf_cache_file_start_timestamp = get_package_cache_timestamp()
524

525
    # All the ways we might run this test
526
    if func == compile or func == multimod_compile:
527
        all_ways = config.compile_ways
dterei's avatar
dterei committed
528
    elif func == compile_and_run or func == multimod_compile_and_run or func == multisrc_compile_and_run:
529
        all_ways = config.run_ways
530
531
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
532
            all_ways = ['ghci']
533
        else:
534
            all_ways = []
535
    else:
536
537
        all_ways = ['normal']

538
539
540
    # 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)
541

542
543
544
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
545
        not getTestOpts().skip \
546
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
547
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
548
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
549
        and way not in getTestOpts().omit_ways
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564

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

566
    if getTestOpts().cleanup != '':
Ian Lynagh's avatar
Ian Lynagh committed
567
568
569
570
571
572
573
574
575
        clean(map (lambda suff: name + suff,
                  ['', '.exe', '.exe.manifest', '.genscript',
                   '.stderr.normalised',        '.stdout.normalised',
                   '.run.stderr',               '.run.stdout',
                   '.run.stderr.normalised',    '.run.stdout.normalised',
                   '.comp.stderr',              '.comp.stdout',
                   '.comp.stderr.normalised',   '.comp.stdout.normalised',
                   '.interp.stderr',            '.interp.stdout',
                   '.interp.stderr.normalised', '.interp.stdout.normalised',
Ian Lynagh's avatar
Ian Lynagh committed
576
                   '.stats', '.comp.stats',
Ian Lynagh's avatar
Ian Lynagh committed
577
578
579
580
581
582
                   '.hi', '.o', '.prof', '.exe.prof', '.hc',
                   '_stub.h', '_stub.c', '_stub.o',
                   '.hp', '.exe.hp', '.ps', '.aux', '.hcr', '.eventlog']))

        clean(getTestOpts().clean_files)

583
584
585
586
587
588
589
        try:
            cleanCmd = getTestOpts().clean_cmd
            if cleanCmd != None:
                result = runCmd('cd ' + getTestOpts().testdir + ' && ' + cleanCmd)
                if result != 0:
                    framework_fail(name, 'cleaning', 'clean-command failed: ' + str(result))
        except e:
590
591
            framework_fail(name, 'cleaning', 'clean-command exception')

592
    package_conf_cache_file_end_timestamp = get_package_cache_timestamp();
593
594
595

    if package_conf_cache_file_start_timestamp != package_conf_cache_file_end_timestamp:
        framework_fail(name, 'whole-test', 'Package cache timestamps do not match: ' + str(package_conf_cache_file_start_timestamp) + ' ' + str(package_conf_cache_file_end_timestamp))
596

597
598
599
600
def clean(names):
    clean_full_paths(map (lambda name: in_testdir(name), names))

def clean_full_paths(names):
Ian Lynagh's avatar
Ian Lynagh committed
601
602
603
604
605
    for name in names:
        try:
            # Remove files...
            os.remove(name)
        except OSError, e1:
606
            try:
Ian Lynagh's avatar
Ian Lynagh committed
607
608
609
610
611
612
613
614
615
616
617
                # ... and empty directories
                os.rmdir(name)
            except OSError, e2:
                # We don't want to fail here, but we do want to know
                # what went wrong, so print out the exceptions.
                # ENOENT isn't a problem, though, as we clean files
                # that don't necessarily exist.
                if e1.errno != errno.ENOENT:
                    print e1
                if e2.errno != errno.ENOENT:
                    print e2
618

619
def do_test(name, way, func, args):
620
621
622
    full_name = name + '(' + way + ')'

    try:
623
624
625
626
        print '=====>', full_name, t.total_tests, 'of', len(allTests), \
                        str([t.n_unexpected_passes,   \
                             t.n_unexpected_failures, \
                             t.n_framework_failures])
627

628
629
        if config.use_threads:
            t.lock.release()
630
631
632
633
634
635
636
637
638
639

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

ei@vuokko.info's avatar
ei@vuokko.info committed
640
641
642
        try:
            result = apply(func, [name,way] + args)
        finally:
643
644
            if config.use_threads:
                t.lock.acquire()
645

646
647
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail':
            framework_fail(name, way, 'bad expected ' + getTestOpts().expect)
648

649
650
651
652
653
654
        try:
            passFail = result['passFail']
        except:
            passFail = 'No passFail found'

        if passFail == 'pass':
ei@vuokko.info's avatar
ei@vuokko.info committed
655
656
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
657
                t.n_expected_passes = t.n_expected_passes + 1
658
659
660
661
                if name in t.expected_passes:
                    t.expected_passes[name].append(way)
                else:
                    t.expected_passes[name] = [way]
662
663
664
            else:
                print '*** unexpected pass for', full_name
                t.n_unexpected_passes = t.n_unexpected_passes + 1
665
                addPassingTestInfo(t.unexpected_passes, getTestOpts().testdir, name, way)
666
        elif passFail == 'fail':
ei@vuokko.info's avatar
ei@vuokko.info committed
667
668
            if getTestOpts().expect == 'pass' \
               and way not in getTestOpts().expect_fail_for:
669
670
                print '*** unexpected failure for', full_name
                t.n_unexpected_failures = t.n_unexpected_failures + 1
671
672
                reason = result['reason']
                addFailingTestInfo(t.unexpected_failures, getTestOpts().testdir, name, reason, way)
673
674
            else:
                t.n_expected_failures = t.n_expected_failures + 1
675
676
677
678
                if name in t.expected_failures:
                    t.expected_failures[name].append(way)
                else:
                    t.expected_failures[name] = [way]
679
680
        else:
            framework_fail(name, way, 'bad result ' + passFail)
681
    except:
682
        framework_fail(name, way, 'do_test exception')
683
684
        traceback.print_exc()

685
def addPassingTestInfo (testInfos, directory, name, way):
686
687
688
689
690
691
692
693
694
695
    directory = re.sub('^\\.[/\\\\]', '', directory)

    if not directory in testInfos:
        testInfos[directory] = {}

    if not name in testInfos[directory]:
        testInfos[directory][name] = []

    testInfos[directory][name].append(way)

696
697
698
699
700
701
702
703
704
705
706
707
708
709
def addFailingTestInfo (testInfos, directory, name, reason, way):
    directory = re.sub('^\\.[/\\\\]', '', directory)

    if not directory in testInfos:
        testInfos[directory] = {}

    if not name in testInfos[directory]:
        testInfos[directory][name] = {}

    if not reason in testInfos[directory][name]:
        testInfos[directory][name][reason] = []

    testInfos[directory][name][reason].append(way)

710
def skiptest (name, way):
711
712
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
713
714
715
716
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
717

718
719
720
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
721
    t.n_framework_failures = t.n_framework_failures + 1
722
723
724
725
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
726

727
728
729
730
731
732
733
734
735
736
737
738
739
740
def badResult(result):
    try:
        if result['passFail'] == 'pass':
            return False
        return True
    except:
        return True

def passed():
    return {'passFail': 'pass'}

def failBecause(reason):
    return {'passFail': 'fail', 'reason': reason}

741
742
743
744
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
745
746
747
748
749
750
#
# 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.
751

752
def run_command( name, way, cmd ):
753
    return simple_run( name, '', cmd, '' )
754

755
756
757
758
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
759
    # filter out -fforce-recomp from compiler_always_flags, because we're
760
    # actually testing the recompilation behaviour in the GHCi tests.
761
    flags = filter(lambda f: f != '-fforce-recomp', config.compiler_always_flags)
762
    flags.append(getTestOpts().extra_hc_opts)
763
764
765
766
767
768

    # 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 + "'" + \
769
          ' --interactive -v0 -ignore-dot-ghci ' + \
770
771
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
772
    getTestOpts().stdin = script
773
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
774

775
776
777
778
# -----------------------------------------------------------------------------
# Compile-only tests

def compile( name, way, extra_hc_opts ):
779
    return do_compile( name, way, 0, '', [], extra_hc_opts )
780
781

def compile_fail( name, way, extra_hc_opts ):
782
    return do_compile( name, way, 1, '', [], extra_hc_opts )
783
784

def multimod_compile( name, way, top_mod, extra_hc_opts ):
785
    return do_compile( name, way, 0, top_mod, [], extra_hc_opts )
786

787
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
788
789
790
791
792
793
794
795
796
    return do_compile( name, way, 1, top_mod, [], extra_hc_opts )

def multisrc_compile( name, way, top_mod, extra_mods, extra_hc_opts ):
    extra_mods = map ((lambda y : (y, '')), extra_mods)
    return do_compile( name, way, 0, top_mod, extra_mods, extra_hc_opts)

def multisrc_compile_fail( name, way, top_mod, extra_mods, extra_hc_opts ):
    extra_mods = map ((lambda y : (y, '')), extra_mods)
    return do_compile( name, way, 1, top_mod, extra_mods, extra_hc_opts)
797

798
799
800
801
802
803
804
def multi_compile( name, way, top_mod, extra_mods, extra_hc_opts ):
    return do_compile( name, way, 0, top_mod, extra_mods, extra_hc_opts)

def multi_compile_fail( name, way, top_mod, extra_mods, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_mods, extra_hc_opts)

def do_compile( name, way, should_fail, top_mod, extra_mods, extra_hc_opts ):
805
806
    # print 'Compile only, extra args = ', extra_hc_opts
    pretest_cleanup(name)
807
808
809
810
811
812
813
814
815

    result = extras_build( way, extra_mods, extra_hc_opts )
    if badResult(result):
       return result
    extra_hc_opts = result['hc_opts']

    force = 1 if extra_mods else 0
    result = simple_build( name, way, extra_hc_opts, should_fail, top_mod, 0, 1, force)

816
    if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
817
        return result
818
819
820
821
822

    # 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
823
    if getTestOpts().with_namebase == None:
824
825
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
826
        namebase = getTestOpts().with_namebase
827
828

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
829
830
    actual_stderr_file = qualify(name, 'comp.stderr')

831
832
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
833
        return failBecause('stderr mismatch')
834
835

    # no problems found, this test passed
836
    return passed()
837
838
839
840

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

841
def compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts ):
842
843
844
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

845
846
847
848
    result = extras_build( way, extra_mods, extra_hc_opts )
    if badResult(result):
       return result
    extra_hc_opts = result['hc_opts']
dterei's avatar
dterei committed
849

850
    if way == 'ghci': # interpreted...
851
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
852
    elif way == 'extcore' or way == 'optextcore' :
853
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
854
    else: # compiled...
855
856
        force = 1 if extra_mods else 0
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1, 1, force)
857
        if badResult(result):
Ian Lynagh's avatar
Ian Lynagh committed
858
            return result
859

860
        cmd = './' + name;
861
862
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
863

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

867
def compile_and_run( name, way, extra_hc_opts ):
868
    return compile_and_run__( name, way, '', [], extra_hc_opts)
869
870

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
871
    return compile_and_run__( name, way, top_mod, [], extra_hc_opts)
dterei's avatar
dterei committed
872
873

def multisrc_compile_and_run( name, way, top_mod, extra_mods, extra_hc_opts ):
874
875
876
877
878
    extra_mods = map ((lambda y : (y, '')), extra_mods)
    return compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts)

def multi_compile_and_run( name, way, top_mod, extra_mods, extra_hc_opts ):
    return compile_and_run__( name, way, top_mod, extra_mods, extra_hc_opts)
879

Ian Lynagh's avatar
Ian Lynagh committed
880
881
882
883
# -----------------------------------------------------------------------------
# Check -t stats info

def checkStats(stats_file, num_fields):
884
    result = passed()
Ian Lynagh's avatar
Ian Lynagh committed
885
886
887
888
889
890
891
892
893
    if num_fields != []:
        f = open(in_testdir(stats_file))
        contents = f.read()
        f.close()

        for (field, min, max) in num_fields:
            m = re.search('\("' + field + '", "([0-9]+)"\)', contents)
            if m == None:
                print 'Failed to find field: ', field
894
                result = failBecause('no such stats field')
Ian Lynagh's avatar
Ian Lynagh committed
895
896
897
898
899
900
            val = int(m.group(1))

            if val < min:
                print field, val, 'is less than minimum allowed', min
                print 'If this is because you have improved GHC, please'
                print 'update the test so that GHC doesn\'t regress again'
901
                result = failBecause('stat too good')
Ian Lynagh's avatar
Ian Lynagh committed
902
903
            if val > max:
                print field, val, 'is more than maximum allowed', max
904
                result = failBecause('stat not good enough')
Ian Lynagh's avatar
Ian Lynagh committed
905

906
    return result
Ian Lynagh's avatar
Ian Lynagh committed
907

908
909
910
# -----------------------------------------------------------------------------
# Build a single-module program

911
912
913
914
915
916
917
918
919
920
921
922
923
def extras_build( way, extra_mods, extra_hc_opts ):
    for modopts in extra_mods:
        mod, opts = modopts
        result = simple_build( mod, way, opts + extra_hc_opts, 0, '', 0, 0, 0)
        if not (mod.endswith(".hs") or mod.endswith(".lhs")):
            extra_hc_opts += " " + replace_suffix(mod, 'o')
        if badResult(result):
            return result

    return {'passFail' : 'pass', 'hc_opts' : extra_hc_opts}


def simple_build( name, way, extra_hc_opts, should_fail, top_mod, link, addsuf, noforce ):
Ian Lynagh's avatar
Ian Lynagh committed
924
    opts = getTestOpts()
925
    errname = add_suffix(name, 'comp.stderr')
926
927
    rm_no_fail( qualify(errname, '') )

928
929
    if top_mod != '':
        srcname = top_mod
930
931
932
933
        rm_no_fail( qualify(name, '') )
        base, suf = os.path.splitext(top_mod)
        rm_no_fail( qualify(base, '') )
        rm_no_fail( qualify(base, 'exe') )
dterei's avatar
dterei committed
934
    elif addsuf:
Ian Lynagh's avatar
Ian Lynagh committed
935
        srcname = add_hs_lhs_suffix(name)
936
        rm_no_fail( qualify(name, '') )
dterei's avatar
dterei committed
937
938
    else:
        srcname = name
939
940
941
        rm_no_fail( qualify(name, 'o') )

    rm_no_fail( qualify(replace_suffix(srcname, "o"), '') )
942
943
944

    to_do = ''
    if top_mod != '':
945
946
947
        to_do = '--make '
        if link:
            to_do = to_do + '-o ' + name
948
949
    elif link:
        to_do = '-o ' + name
Ian Lynagh's avatar
Ian Lynagh committed
950
    elif opts.compile_to_hc:
951
952
953
954
        to_do = '-C'
    else:
        to_do = '-c' # just compile

Ian Lynagh's avatar
Ian Lynagh committed
955
956
    stats_file = name + '.comp.stats'
    if opts.compiler_stats_num_fields != []:
957
        extra_hc_opts += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
958

Ian Lynagh's avatar
Ian Lynagh committed
959
960
961
962
963
    if getTestOpts().compile_cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().compile_cmd_prefix + ' '

964
965
966
967
    comp_flags = config.compiler_always_flags
    if noforce:
        comp_flags = filter(lambda f: f != '-fforce-recomp', comp_flags)

Ian Lynagh's avatar
Ian Lynagh committed
968
    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
969
          + config.compiler + "' " \
970
          + join(comp_flags,' ') + ' ' \
971
972
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
973
          + extra_hc_opts + ' ' \
Ian Lynagh's avatar
Ian Lynagh committed
974
          + opts.extra_hc_opts + ' ' \
975
          + '>' + errname + ' 2>&1'
976
977
978
979
980
981
982
983
984
985

    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

986
    statsResult = checkStats(stats_file, opts.compiler_stats_num_fields)
Ian Lynagh's avatar
Ian Lynagh committed
987

988
989
    if badResult(statsResult):
        return statsResult
Ian Lynagh's avatar
Ian Lynagh committed
990
991
992

    if should_fail:
        if result == 0:
993
            return failBecause('exit code 0')
Ian Lynagh's avatar
Ian Lynagh committed
994
995
    else:
        if result != 0:
996
            return failBecause('exit code non-0')
Ian Lynagh's avatar
Ian Lynagh committed
997

998
    return passed()
999
1000
1001
1002
1003

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

1007
def simple_run( name, way, prog, args ):
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
    opts = getTestOpts()

    # figure out what to use for stdin
    if opts.stdin != '':
        use_stdin = opts.stdin
    else:
        stdin_file = add_suffix(name, 'stdin')
        if os.path.exists(in_testdir(stdin_file)):
            use_stdin = stdin_file
        else:
            use_stdin = '/dev/null'

    run_stdout = add_suffix(name,'run.stdout')
    run_stderr = add_suffix(name,'run.stderr')

    rm_no_fail(qualify(name,'run.stdout'))
    rm_no_fail(qualify(name,'run.stderr'))
    rm_no_fail(qualify(name, 'hp'))
    rm_no_fail(qualify(name,'ps'))
    rm_no_fail(qualify(name, 'prof'))
1028

1029
1030
    my_rts_flags = rts_flags(way)

Ian Lynagh's avatar
Ian Lynagh committed
1031
    stats_file = name + '.stats'
1032
    if opts.stats_num_fields != []:
1033
        args += ' +RTS -V0 -t' + stats_file + ' --machine-readable -RTS'
1034

1035
1036
1037
1038
    if opts.no_stdin:
        stdin_comes_from = ''
    else:
        stdin_comes_from = ' <' + use_stdin
1039
    cmd = 'cd ' + getTestOpts().testdir + ' && ' \
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
	    + prog + ' ' + args + ' '  \
        + my_rts_flags + ' '       \
        + stdin_comes_from         \
        + ' >' + run_stdout        \
        + ' 2>' + run_stderr

    # run the command
    result = runCmd(cmd)

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

    # check the exit code
    if exit_code != opts.exit_code:
        print 'Wrong exit code (expected', opts.exit_code, ', actual', exit_code, ')'
        dump_stdout(name)
        dump_stderr(name)
1057
        return failBecause('bad exit code')
1058
1059
1060
1061

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

1062
1063
    if not opts.ignore_output:
        if not check_stderr_ok(name):
1064
            return failBecause('bad stderr')
1065
        if not check_stdout_ok(name):
1066
            return failBecause('bad stdout')
1067
        # exit_code > 127 probably indicates a crash, so don't try to run hp2ps.
1068
        if check_hp and (exit_code <= 127 or exit_code == 251) and not check_hp_ok(name):
1069
            return failBecause('bad heap profile')
1070
        if check_prof and not check_prof_ok(name):
1071
            return failBecause('bad profile')
1072

1073
    return checkStats(stats_file, opts.stats_num_fields)
1074

1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

1086
1087
1088
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

1089
def interpreter_run( name, way, extra_hc_opts, compile_only, top_mod ):
1090
1091
1092
1093
1094
    outname = add_suffix(name, 'interp.stdout')
    errname = add_suffix(name, 'interp.stderr')
    rm_no_fail(outname)
    rm_no_fail(errname)
    rm_no_fail(name)
1095

1096
1097
1098
1099
1100
    if getTestOpts().cmd_prefix == '':
        cmd_prefix = ''
    else:
        cmd_prefix = getTestOpts().cmd_prefix + ' '

1101
    if (top_mod == ''):
Ian Lynagh's avatar
Ian Lynagh committed
1102
        srcname = add_hs_lhs_suffix(name)
1103
1104
    else:
        srcname = top_mod
1105

1106
    scriptname = add_suffix(name, 'genscript')
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
    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
1117
        script.write(':set args ' + getTestOpts().extra_run_opts + '\n')
1118
1119
1120
1121
        # 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)
1122
1123
        # Set stdout to be line-buffered to match the compiled environment.
        script.write('System.IO.hSetBuffering System.IO.stdout System.IO.LineBuffering\n')
1124
1125
        # wrapping in GHC.TopHandler.runIO ensures we get the same output
        # in the event of an exception as for the compiled program.
1126
        script.write('GHC.TopHandler.runIOFastExit Main.main Prelude.>> Prelude.return ()\n')
1127
1128
    script.close()

1129
    # figure out what to use for stdin
ei@vuokko.info's avatar
ei@vuokko.info committed
1130
1131
    if getTestOpts().stdin != '':
        stdin_file = in_testdir(getTestOpts().stdin)
1132
1133
1134
    else:
        stdin_file = qualify(name, 'stdin')

1135
1136
1137
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
1138

1139
1140
    script.close()

1141
    cmd = 'cd ' + getTestOpts().testdir + " && " + cmd_prefix + "'" \
1142
1143
1144
1145
1146
          + 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
1147
          + getTestOpts().extra_hc_opts + ' ' \
1148
1149
1150
1151
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

1152
1153
1154
    exit_code = result >> 8
    signal    = result & 0xff

1155
1156
1157
1158
1159
1160
1161
1162
    # 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'))

1163
1164
1165
1166
1167
    # 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)
1168
        return failBecause('bad exit code')
1169

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