testlib.py 39.6 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
85
86
def reqlib( lib ):
    return lambda opts, l=lib: _reqlib (opts, l )

def _reqlib( opts, lib ):
    # opts.reqlibs.append(lib)
87
88
89
90
91
92
93
94
95
96
97
    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')

98
99
100
    if r != 0:
        opts.expect = 'fail'

101
102
103
104
def req_profiling( opts ):
    if not config.have_profiling:
        opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
105
106
107
108
109
110
def expect_broken( bug ):
    return lambda opts, b=bug: _expect_broken (opts, b )

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

111
112
113
def ignore_output( opts ):
    opts.ignore_output = 1

114
115
116
def no_stdin( opts ):
    opts.no_stdin = 1

117
118
119
120
121
122
123
124
# -----

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
125
126
127
128
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
129
    opts.expect_fail_for = ways
Ian Lynagh's avatar
Ian Lynagh committed
130

131
132
133
134
135
136
137
138
139
140
# -----

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

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

# -----

141
142
143
144
145
146
147
148
def only_ways( ways ):
    return lambda opts, w=ways: _only_ways( opts, w )

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

# -----

149
150
151
152
153
154
155
156
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
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

# -----

175
176
177
178
179
180
def expect_fail_if_platform( plat ):
   return lambda opts, p=plat: _expect_fail_if_platform(opts, p)

def _expect_fail_if_platform( opts, plat ):
    if config.platform == plat:
	opts.expect = 'fail'
181
182
183
184
185
186
187

def expect_broken_if_platform( bug, plat ):
   return lambda opts, b=bug, p=plat: _expect_broken_if_platform(opts, b, p)

def _expect_broken_if_platform( opts, bug, plat ):
    if config.platform == plat:
	opts.expect = 'fail'
188
189
190
	
# -----

ross's avatar
ross committed
191
192
193
194
195
196
197
def expect_fail_if_compiler_type( compiler_type ):
   return lambda opts, c=compiler_type: _expect_fail_if_compiler_type(opts, c)

def _expect_fail_if_compiler_type( opts, compiler_type ):
    if config.compiler_type == compiler_type:
	opts.expect = 'fail'

Ian Lynagh's avatar
Ian Lynagh committed
198
def expect_broken_if_compiler_type( bug, compiler_type ):
Ian Lynagh's avatar
Ian Lynagh committed
199
200
201
202
203
204
   return lambda opts, b=bug, c=compiler_type: _expect_broken_if_compiler_type(opts, b, c)

def _expect_broken_if_compiler_type( opts, bug, compiler_type ):
    if config.compiler_type == compiler_type:
	opts.expect = 'fail'

ross's avatar
ross committed
205
206
# -----

207
208
209
210
211
212
213
214
215
216
217
218
219
220
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

221
222
223
224
225
226
227
def exit_code_if_platform( val, plat ):
   return lambda opts, v=val, p=plat: _exit_code_if_platform(opts, v, p)

def _exit_code_if_platform( opts, val, plat ):
    if config.platform == plat:
        opts.exit_code = val

228
229
230
231
232
233
234
235
# -----

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

236
237
# -----

238
239
240
def no_clean( opts ):
    opts.cleanup = '';

241
242
243
244
245
246
def extra_clean( files ):
    return lambda opts, v=files: _extra_clean(opts, v);

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

247
248
249
250
251
252
# -----

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

253
254
255
256
257
258
# ----

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

Simon Marlow's avatar
Simon Marlow committed
259
260
261
262
263
264
265
266
267
# -----

def skip_if_platform( plat ):
   return lambda opts, p=plat: _skip_if_platform(opts, p)

def _skip_if_platform( opts, plat ):
    if config.platform == plat:
	opts.skip = 1
	
268
269
# ---

Ian Lynagh's avatar
Ian Lynagh committed
270
def if_compiler_lt( compiler, version, f ):
271
    if config.compiler_type == compiler and \
Ian Lynagh's avatar
Ian Lynagh committed
272
273
274
275
       version_lt(config.compiler_version, version):
        return f
    else:
        return normal
276

Ian Lynagh's avatar
Ian Lynagh committed
277
def if_compiler_le( compiler, version, f ):
278
279
    if config.compiler_type == compiler and \
       version_le(config.compiler_version, version):
Ian Lynagh's avatar
Ian Lynagh committed
280
281
282
        return f
    else:
        return normal
283

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

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

Ian Lynagh's avatar
Ian Lynagh committed
298
299
def namebase( nb ):
   return lambda opts, nb=nb: _namebase(opts, nb)
300

Ian Lynagh's avatar
Ian Lynagh committed
301
302
def _namebase( opts, nb ):
    opts.with_namebase = nb
303

304
305
# ---

306
307
308
309
310
311
312
313
314
315
316
317
318
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
319

ei@vuokko.info's avatar
ei@vuokko.info committed
320
# ---
321
322
def alone(opts):
    opts.alone = 1
ei@vuokko.info's avatar
ei@vuokko.info committed
323

Ian Lynagh's avatar
Ian Lynagh committed
324
325
326
327
# ---
def literate( opts ):
    opts.literate = 1;

328
329
330
def c_src( opts ):
    opts.c_src = 1;

331
332
333
334
335
336
337
338
# ----

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

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

339
340
341
342
343
# ----

def normalise_slashes( opts ):
    opts.extra_normaliser = normalise_slashes_

344
345
346
# ----
# Function for composing two opt-fns together

347
348
349
def composes( fs ):
    return reduce(lambda f, g: compose(f, g), fs)

350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
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
377
378
379
def test ( name, setup, func, args):
    n = 1
    opts = copy.copy(thisdir_testopts)
380
381
382
383

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

ei@vuokko.info's avatar
ei@vuokko.info committed
384
    setup(opts)
385
    if opts.alone:
ei@vuokko.info's avatar
ei@vuokko.info committed
386
        n = config.threads
387

ei@vuokko.info's avatar
ei@vuokko.info committed
388
389
    ok = 0

390
    if config.use_threads:
ei@vuokko.info's avatar
ei@vuokko.info committed
391
        t.thread_pool.acquire()
392
393
394
395
396
397
398
399
400
401
402
403
        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)
404

405
406
407
408
409
410
411
412
413
414
415
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()
416
    
ei@vuokko.info's avatar
ei@vuokko.info committed
417
418
419
def test_common_work (name, opts, func, args):
    t.total_tests = t.total_tests+1
    setLocalTestOpts(opts)
420
    # All the ways we might run this test
421
    if func == compile or func == multimod_compile:
422
        all_ways = config.compile_ways
423
    elif func == compile_and_run or func == multimod_compile_and_run:
424
        all_ways = config.run_ways
425
426
    elif func == ghci_script:
        if 'ghci' in config.run_ways:
427
            all_ways = ['ghci']
428
        else:
429
            all_ways = []
430
    else:
431
432
        all_ways = ['normal']

433
434
435
    # 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)
436

437
438
439
    t.total_test_cases = t.total_test_cases + len(all_ways)

    ok_way = lambda way: \
ei@vuokko.info's avatar
ei@vuokko.info committed
440
        not getTestOpts().skip \
441
        and (config.only == [] or name in config.only) \
ei@vuokko.info's avatar
ei@vuokko.info committed
442
        and (getTestOpts().only_ways == [] or way in getTestOpts().only_ways) \
443
        and (config.cmdline_ways == [] or way in config.cmdline_ways) \
ei@vuokko.info's avatar
ei@vuokko.info committed
444
        and way not in getTestOpts().omit_ways
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459

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

461
    clean(map (lambda suff: name + suff,
462
463
464
465
466
467
468
              ['', '.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
469
               '.hi', '.o', '.prof', '.exe.prof', '.hc', '_stub.h', '_stub.c',
470
               '_stub.o', '.hp', '.exe.hp', '.ps', '.aux', '.hcr']))
471

472
473
    clean(getTestOpts().clean_files)

474
475
476
477
478
479
480
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
481
    if getTestOpts().cleanup != '':
482
        for name in names:
483
            try:
484
                os.remove(name)
485
486
            except OSError:
                pass
487

488
def do_test(name, way, func, args):
489
490
491
492
493
    full_name = name + '(' + way + ')'

    try:
        print '=====>', full_name
        
494
495
        if config.use_threads:
            t.lock.release()
ei@vuokko.info's avatar
ei@vuokko.info committed
496
497
498
        try:
            result = apply(func, [name,way] + args)
        finally:
499
500
            if config.use_threads:
                t.lock.acquire()
501
        
ei@vuokko.info's avatar
ei@vuokko.info committed
502
        if getTestOpts().expect != 'pass' and getTestOpts().expect != 'fail' or \
503
           result != 'pass' and result != 'fail':
504
            framework_fail(name, way, 'bad results ' + result)
505
506

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

540
def skiptest (name, way):
541
542
    # print 'Skipping test \"', name, '\"'
    t.n_tests_skipped = t.n_tests_skipped + 1
543
544
545
546
    if name in t.tests_skipped:
        t.tests_skipped[name].append(way)
    else:
        t.tests_skipped[name] = [way]
547

548
549
550
def framework_fail( name, way, reason ):
    full_name = name + '(' + way + ')'
    print '*** framework failure for', full_name, reason, ':'
551
    t.n_framework_failures = t.n_framework_failures + 1
552
553
554
555
    if name in t.framework_failures:
        t.framework_failures[name].append(way)
    else:
        t.framework_failures[name] = [way]
556

557
558
559
560
# -----------------------------------------------------------------------------
# Generic command tests

# A generic command test is expected to run and exit successfully.
561
562
563
564
565
566
#
# 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.
567

568
def run_command( name, way, cmd ):
569
    return simple_run( name, '', cmd, '' )
570

571
572
573
574
# -----------------------------------------------------------------------------
# GHCi tests

def ghci_script( name, way, script ):
575
576
577
    # filter out -no-recomp from compiler_always_flags, becuase we're
    # actually testing the recompilation behaviour in the GHCi tests.
    flags = filter(lambda f: f != '-no-recomp', config.compiler_always_flags)
578
    flags.append(getTestOpts().extra_hc_opts)
579
580
581
582
583
584

    # 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 + "'" + \
585
          ' --interactive -v0 -ignore-dot-ghci ' + \
586
587
          join(flags,' ')

ei@vuokko.info's avatar
ei@vuokko.info committed
588
    getTestOpts().stdin = script
589
    return simple_run( name, way, cmd, getTestOpts().extra_run_opts )
590

591
592
593
594
595
596
597
598
599
600
601
602
# -----------------------------------------------------------------------------
# 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 )

603
604
605
def multimod_compile_fail( name, way, top_mod, extra_hc_opts ):
    return do_compile( name, way, 1, top_mod, extra_hc_opts )

606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
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
622
    if getTestOpts().with_namebase == None:
623
624
        namebase = name
    else:
Ian Lynagh's avatar
Ian Lynagh committed
625
        namebase = getTestOpts().with_namebase
626
627

    (platform_specific, expected_stderr_file) = platform_wordsize_qualify(namebase, 'stderr')
628
629
    actual_stderr_file = qualify(name, 'comp.stderr')

630
631
632
    if not compare_outputs('stderr', normalise_errmsg, normalise_whitespace, \
                           expected_stderr_file, actual_stderr_file):
        return 'fail'
633
634
635
636
637
638
639

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

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

640
def compile_and_run__( name, way, extra_hc_opts, top_mod ):
641
642
643
    # print 'Compile and run, extra args = ', extra_hc_opts
    pretest_cleanup(name)

644
    if way == 'ghci': # interpreted...
645
        return interpreter_run( name, way, extra_hc_opts, 0, top_mod )
krc's avatar
krc committed
646
    elif way == 'extcore' or way == 'optextcore' :
647
        return extcore_run( name, way, extra_hc_opts, 0, top_mod )
648
    else: # compiled...
649
650
        result = simple_build( name, way, extra_hc_opts, 0, top_mod, 1 )
        
651
652
653
        if result != 0:
            return 'fail'

654
        cmd = './' + name;
655
656
        if getTestOpts().cmd_prefix != '':
            cmd = getTestOpts().cmd_prefix + ' ' + cmd;
657

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

661
662
def compile_and_run( name, way, extra_hc_opts ):
    return compile_and_run__( name, way, extra_hc_opts, '')
663
664

def multimod_compile_and_run( name, way, top_mod, extra_hc_opts ):
665
    return compile_and_run__( name, way, extra_hc_opts, top_mod)
666

667
668
669
670
671
672
673
674
675
676
677
# -----------------------------------------------------------------------------
# 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
678
        srcname = add_hs_lhs_suffix(name)
679
680
681
682
683
684

    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
685
    elif getTestOpts().compile_to_hc:
686
687
688
689
690
691
692
693
        to_do = '-C'
    else:
        to_do = '-c' # just compile


    cmd = 'cd ' + testdir + " && '" \
          + config.compiler + "' " \
          + join(config.compiler_always_flags,' ') + ' ' \
694
695
          + to_do + ' ' + srcname + ' ' \
          + join(config.way_flags[way],' ') + ' ' \
696
          + extra_hc_opts + ' ' \
ei@vuokko.info's avatar
ei@vuokko.info committed
697
          + getTestOpts().extra_hc_opts + ' ' \
698
          + '>' + errname + ' 2>&1'
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717

    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.

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

739
740
741
742
   if getTestOpts().no_stdin:
     stdin_comes_from = ''
   else:
     stdin_comes_from = ' <' + use_stdin
743
   cmd = 'cd ' + testdir + ' && ' \
744
	  + prog + ' ' + args + ' ' \
745
          + my_rts_flags + ' ' \
746
          + stdin_comes_from \
747
748
          + ' >' + run_stdout \
          + ' 2>' + run_stderr
749
750
751
752

   # run the command
   result = runCmd(cmd)

753
   exit_code = result >> 8
754
755
756
   signal    = result & 0xff

   # check the exit code
ei@vuokko.info's avatar
ei@vuokko.info committed
757
758
   if exit_code != getTestOpts().exit_code:
       print 'Wrong exit code (expected', getTestOpts().exit_code, ', actual', exit_code, ')'
759
760
       dump_stdout(name)
       dump_stderr(name)
761
762
       return 'fail'

763
764
   check_hp = my_rts_flags.find("-h") != -1

765
766
   if getTestOpts().ignore_output or (check_stderr_ok(name) and
                                      check_stdout_ok(name) and
767
768
                                      (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.
769
770
771
772
       return 'pass'
   else:
       return 'fail'

773
774
775
776
777
778
779
780
781
782
783
def rts_flags(way):
    if (way == ''):
        return ''
    else:
        args = config.way_rts_flags[way]

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

784
785
786
# -----------------------------------------------------------------------------
# Run a program in the interpreter and check its output

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

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

828
829
830
831
    if os.path.exists(stdin_file):
        stdin = open(stdin_file, 'r')
        os.system('cat ' + stdin_file + ' >>' + qscriptname)
        
832
833
834
835
836
837
838
839
    script.close()

    cmd = 'cd ' + testdir + " && '" \
          + 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
840
          + getTestOpts().extra_hc_opts + ' ' \
841
842
843
844
          + '<' + scriptname +  ' 1>' + outname + ' 2>' + errname

    result = runCmd(cmd)

845
846
847
    exit_code = result >> 8
    signal    = result & 0xff

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

856
857
858
859
860
861
862
    # 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'

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

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

    line = infile.readline()
    while (line != ''):
        out2.write(line)
        line = infile.readline()
889
    out2.close()
890
    
krc's avatar
krc committed
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
# -----------------------------------------------------------------------------
# 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
908
        srcname = add_hs_lhs_suffix(name)
krc's avatar
krc committed
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
    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
928
          + getTestOpts().extra_hc_opts \
krc's avatar
krc committed
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
956
957
          + 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
958
          + getTestOpts().extra_hc_opts + ' ' \
krc's avatar
krc committed
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
          + 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 )
    
977
    return simple_run ( name, way, './'+name, getTestOpts().extra_run_opts )
krc's avatar
krc committed
978

979
980
981
982
# -----------------------------------------------------------------------------
# Utils

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

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

991
992
993
994
995
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
996

997
   return compare_outputs('stdout', norm, getTestOpts().extra_normaliser, \
998
                          expected_stdout_file, actual_stdout_file)
999

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

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

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

1013
1014
1015
1016
1017
   def norm(str):
      if platform_specific:
         return str
      else:
         return normalise_output(str)
1018

1019
   return compare_outputs('stderr', norm, getTestOpts().extra_normaliser, \
1020
                          expected_stderr_file, actual_stderr_file)
1021

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

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

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

1037
1038
1039
1040
1041
1042
1043
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)

1044
1045
1046
1047
    if config.platform == 'i386-unknown-mingw32':
        actual_ps_file = qualify(name, 'exe.ps')
    else:   
        actual_ps_file = qualify(name, 'ps')
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
    
    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: 
1059
            print "hp2ps did not generate PostScript for " + name
1060
1061
1062
1063
1064
            return (False) 
    else:
        print "hp2ps error when processing heap profile for " + name
        return(False)

Ian Lynagh's avatar
Ian Lynagh committed
1065
# Compare expected output to actual output, and optionally accept the
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
# 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 = ''
1076

1077
1078
    actual_raw = read_no_crs(actual_file)
    actual_str = normaliser(actual_raw)
1079

1080
1081
1082
1083
1084
    if extra_normaliser(expected_str) != extra_normaliser(actual_str):
        print 'Actual ' + kind + ' output differs from expected:'

        if expected_file == '':
            expected_normalised_file = '/dev/null'
1085
1086

        else:
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
            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
1106

1107
def normalise_whitespace( str ):
1108
    # Merge contiguous whitespace characters into a single space.
1109
1110
1111
1112
    str = re.sub('[ \t\n]+', ' ', str)
    return str

def normalise_errmsg( str ):
1113
1114
1115
1116
1117
1118
1119
    # 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
1120
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1121
1122
    return str

1123
1124
1125
1126
def normalise_slashes_( str ):
    str = re.sub('\\\\', '/', str)
    return str

1127
1128
1129
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
1130
    str = re.sub('([^\\s])\\.exe', '\\1', str)
1131
1132
    return str

1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
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':
       return ['-no-recomp', '-dcore-lint']
   elif config.compiler_type == 'nhc':
       return ['-an-nhc-specific-flag']
   else:
        return []

1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
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)

Simon Peyton Jones's avatar
Simon Peyton Jones committed
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# 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

1171
1172
def runCmd( cmd ):
    if_verbose( 1, cmd )
1173
1174
1175
1176
    r = 0
    if config.platform == 'i386-unknown-mingw32':
	# On MinGW, we will always have timeout
        assert config.timeout_prog!=''
1177
1178

    if config.timeout_prog != '':
1179
        r = rawSystem([config.timeout_prog, str(config.timeout), cmd])
1180
    else:
1181
1182
        r = os.system(cmd)
    return r << 8
1183

1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
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"
    gs_working = 0;

global gs_working
if config.gs != '':
    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();
else:
    gsNotWorking();

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

1234
1235
1236
1237
1238
1239
def in_testdir( name ):
    return os.path.join(testdir, name)

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

1240
# "foo" -> qualify("foo-platform") if it exists, otherwise
ross's avatar
ross committed
1241
1242
# try qualify("foo-compiler_type"), qualify("foo-ws-wordsize")
# or finally qualify("foo")
1243
def platform_wordsize_qualify( name, suff ):
1244
1245
    path = qualify(name, suff)
    platform_path = path + '-' + config.platform
ross's avatar
ross committed
1246
    compiler_type_path = path + '-' + config.compiler_type
1247
    wordsize_path = path + '-ws-' + config.wordsize
1248
    if os.path.exists(platform_path):
1249
        return (1,platform_path)
ross's avatar
ross committed
1250
    elif os.path.exists(compiler_type_path):
1251
        return (0,compiler_type_path)
1252
    elif os.path.exists(wordsize_path):
1253
        return (0,wordsize_path)
1254
    else:
1255
        return (0,path)
1256
1257
1258
1259
1260
1261
1262

# 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'))
1263
   rm_no_fail(qualify(name,'tix'))	# remove the old tix file
1264
1265
1266
1267
1268
1269
1270
1271
   # 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.

1272
1273
1274
1275
def findTFiles(roots):
    return concat(map(findTFiles_,roots))

def findTFiles_(path):    
1276
1277
    if os.path.isdir(path):
        paths = map(lambda x, p=path: p + '/' + x, os.listdir(path))
1278
        return findTFiles(paths)
1279
1280
1281
1282
1283
1284
1285
1286
1287
    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
1288

1289
1290
    file.write('\n')
    file.write('OVERALL SUMMARY for test run started at ' \
krc's avatar
krc committed
1291
               + t.start_time + '\n'\
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
               + string.rjust(`t.total_tests`, 8) \
               + ' total tests, which gave rise to\n' \
               + string.rjust(`t.total_test_cases`, 8) \
               + ' test cases, of which\n' \
               + string.rjust(`t.n_framework_failures`, 8) \
               + ' caused framework fai