This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Make utf8::encode respect magic
[perl5.git] / t / TEST
1 #!./perl
2
3 # This is written in a peculiar style, since we're trying to avoid
4 # most of the constructs we'll be testing for.  (This comment is
5 # probably obsolete on the avoidance side, though still currrent
6 # on the peculiarity side.)
7
8 # t/TEST and t/harness need to share code. The logical way to do this would be
9 # to have the common code in a file both require or use. However, t/TEST needs
10 # to still work, to generate test results, even if require isn't working, so
11 # we cannot do that. t/harness has no such restriction, so it is quite
12 # acceptable to have it require t/TEST.
13
14 # In which case, we need to stop t/TEST actually running tests, as all
15 # t/harness needs are its subroutines.
16
17
18 # directories with special sets of test switches
19 my %dir_to_switch =
20     (base => '',
21      comp => '',
22      run => '',
23      '../ext/File-Glob/t' => '-I.. -MTestInit', # FIXME - tests assume t/
24      );
25
26 # "not absolute" is the the default, as it saves some fakery within TestInit
27 # which can peturb tests, and takes CPU. Working with the upstream author of
28 # any of these, to figure out how to remove them from this list, considered
29 # "a good thing".
30 my %abs = (
31            '../cpan/Archive-Extract' => 1,
32            '../cpan/Archive-Tar' => 1,
33            '../cpan/AutoLoader' => 1,
34            '../cpan/CPAN' => 1,
35            '../cpan/Class-ISA' => 1,
36            '../cpan/Devel-PPPort' => 1,
37            '../cpan/Encode' => 1,
38            '../cpan/ExtUtils-Constant' => 1,
39            '../cpan/ExtUtils-MakeMaker' => 1,
40            '../cpan/File-Fetch' => 1,
41            '../cpan/IPC-Cmd' => 1,
42            '../cpan/IPC-SysV' => 1,
43            '../cpan/Locale-Codes' => 1,
44            '../cpan/Log-Message' => 1,
45            '../cpan/Module-Build' => 1,
46            '../cpan/Module-Load' => 1,
47            '../cpan/Module-Load-Conditional' => 1,
48            '../cpan/Object-Accessor' => 1,
49            '../cpan/Package-Constants' => 1,
50            '../cpan/Parse-CPAN-Meta' => 1,
51            '../cpan/Pod-Simple' => 1,
52            '../cpan/Term-UI' => 1,
53            '../cpan/Test-Simple' => 1,
54            '../cpan/podlators' => 1,
55            '../dist/Cwd' => 1,
56            '../dist/ExtUtils-Command' => 1,
57            '../dist/ExtUtils-Install' => 1,
58            '../dist/ExtUtils-Manifest' => 1,
59            '../dist/ExtUtils-ParseXS' => 1,
60            '../dist/Tie-File' => 1,
61           );
62
63 my %temp_no_core =
64     ('../cpan/B-Debug' => 1,
65      '../cpan/Compress-Raw-Bzip2' => 1,
66      '../cpan/Compress-Raw-Zlib' => 1,
67      '../cpan/Devel-PPPort' => 1,
68      '../cpan/Getopt-Long' => 1,
69      '../cpan/IO-Compress' => 1,
70      '../cpan/MIME-Base64' => 1,
71      '../cpan/parent' => 1,
72      '../cpan/Parse-CPAN-Meta' => 1,
73      '../cpan/Pod-Simple' => 1,
74      '../cpan/podlators' => 1,
75      '../cpan/Test-Simple' => 1,
76      '../cpan/Tie-RefHash' => 1,
77      '../cpan/Unicode-Collate' => 1,
78      '../cpan/Unicode-Normalize' => 1,
79     );
80
81 # delete env vars that may influence the results
82 # but allow override via *_TEST env var if wanted
83 # (e.g. PERL5OPT_TEST=-d:NYTProf)
84 my @bad_env_vars = qw(
85     PERL5LIB PERLLIB PERL5OPT
86     PERL_YAML_BACKEND PERL_JSON_BACKEND
87 );
88
89 for my $envname (@bad_env_vars) {
90     my $override = $ENV{"${envname}_TEST"};
91     if (defined $override) {
92         warn "$0: $envname=$override\n";
93         $ENV{$envname} = $override;
94     }
95     else {
96         delete $ENV{$envname};
97     }
98 }
99
100 if ($::do_nothing) {
101     return 1;
102 }
103
104 # Location to put the Valgrind log.
105 our $Valgrind_Log;
106
107 $| = 1;
108
109 # for testing TEST only
110 #BEGIN { require '../lib/strict.pm'; "strict"->import() };
111 #BEGIN { require '../lib/warnings.pm'; "warnings"->import() };
112
113 # remove empty elements due to insertion of empty symbols via "''p1'" syntax
114 @ARGV = grep($_,@ARGV) if $^O eq 'VMS';
115 our $show_elapsed_time = $ENV{HARNESS_TIMER} || 0;
116
117 # Cheesy version of Getopt::Std.  We can't replace it with that, because we
118 # can't rely on require working.
119 {
120     my @argv = ();
121     foreach my $idx (0..$#ARGV) {
122         push( @argv, $ARGV[$idx] ), next unless $ARGV[$idx] =~ /^-(\S+)$/;
123         $::benchmark = 1 if $1 eq 'benchmark';
124         $::core    = 1 if $1 eq 'core';
125         $::verbose = 1 if $1 eq 'v';
126         $::torture = 1 if $1 eq 'torture';
127         $::with_utf8 = 1 if $1 eq 'utf8';
128         $::with_utf16 = 1 if $1 eq 'utf16';
129         $::taintwarn = 1 if $1 eq 'taintwarn';
130         if ($1 =~ /^deparse(,.+)?$/) {
131             $::deparse = 1;
132             $::deparse_opts = $1;
133         }
134     }
135     @ARGV = @argv;
136 }
137
138 chdir 't' if -f 't/TEST';
139 if (-f 'TEST' && -f 'harness' && -d '../lib') {
140     @INC = '../lib';
141 }
142
143 die "You need to run \"make test\" first to set things up.\n"
144   unless -e 'perl' or -e 'perl.exe' or -e 'perl.pm';
145
146 if ($ENV{PERL_3LOG}) { # Tru64 third(1) tool, see perlhack
147     unless (-x 'perl.third') {
148         unless (-x '../perl.third') {
149             die "You need to run \"make perl.third first.\n";
150         }
151         else {
152             print "Symlinking ../perl.third as perl.third...\n";
153             die "Failed to symlink: $!\n"
154                 unless symlink("../perl.third", "perl.third");
155             die "Symlinked but no executable perl.third: $!\n"
156                 unless -x 'perl.third';
157         }
158     }
159 }
160
161 # check leakage for embedders
162 $ENV{PERL_DESTRUCT_LEVEL} = 2 unless exists $ENV{PERL_DESTRUCT_LEVEL};
163 # check existence of all symbols
164 $ENV{PERL_DL_NONLAZY} = 1 unless exists $ENV{PERL_DL_NONLAZY};
165
166 $ENV{EMXSHELL} = 'sh';        # For OS/2
167
168 if ($show_elapsed_time) { require Time::HiRes }
169 my %timings = (); # testname => [@et] pairs if $show_elapsed_time.
170
171 my %skip = (
172             '.' => 1,
173             '..' => 1,
174             'CVS' => 1,
175             'RCS' => 1,
176             'SCCS' => 1,
177             '.svn' => 1,
178            );
179
180 # Roll your own File::Find!
181 sub _find_tests { our @found=(); push @ARGV, _find_files('\.t$', $_[0]) }
182 sub _find_files {
183     my($patt, @dirs) = @_;
184     for my $dir (@dirs) {
185         opendir DIR, $dir or die "Trouble opening $dir: $!";
186         foreach my $f (sort { $a cmp $b } readdir DIR) {
187             next if $skip{$f};
188
189             my $fullpath = "$dir/$f";
190             
191             if (-d $fullpath) {
192                 _find_files($patt, $fullpath);
193             } elsif ($f =~ /$patt/) {
194                 push @found, $fullpath;
195             }
196         }
197     }
198     @found;
199 }
200
201
202 # Scan the text of the test program to find switches and special options
203 # we might need to apply.
204 sub _scan_test {
205     my($test, $type) = @_;
206
207     open(my $script, "<", $test) or die "Can't read $test.\n";
208     my $first_line = <$script>;
209
210     $first_line =~ tr/\0//d if $::with_utf16;
211
212     my $switch = "";
213     if ($first_line =~ /#!.*\bperl.*\s-\w*([tT])/) {
214         $switch = "-$1";
215     } else {
216         if ($::taintwarn) {
217             # not all tests are expected to pass with this option
218             $switch = '-t';
219         } else {
220             $switch = '';
221         }
222     }
223
224     my $file_opts = "";
225     if ($type eq 'deparse') {
226         # Look for #line directives which change the filename
227         while (<$script>) {
228             $file_opts = $file_opts . ",-f$3$4"
229               if /^#\s*line\s+(\d+)\s+((\w+)|"([^"]+)")/;
230         }
231     }
232
233     close $script;
234
235     my $perl = './perl';
236     my $lib  = '../lib';
237     my $run_dir;
238     my $return_dir;
239
240     $test =~ /^(.+)\/[^\/]+/;
241     my $dir = $1;
242     my $testswitch = $dir_to_switch{$dir};
243     if (!defined $testswitch) {
244         if ($test =~ s!^(\.\./(cpan|dist|ext)/[^/]+)/t!t!) {
245             $run_dir = $1;
246             $return_dir = '../../t';
247             $lib = '../../lib';
248             $perl = '../../t/perl';
249             $testswitch = "-I../.. -MTestInit=U2T";
250             if ($2 eq 'cpan' || $2 eq 'dist') {
251                 if($abs{$run_dir}) {
252                     $testswitch = $testswitch . ',A';
253                 }
254                 if ($temp_no_core{$run_dir}) {
255                     $testswitch = $testswitch . ',NC';
256                 }
257             }
258         } elsif ($test =~ m!^\.\./lib!) {
259             $testswitch = '-I.. -MTestInit=U1'; # -T will remove . from @INC
260         } else {
261             $testswitch = '-I.. -MTestInit';  # -T will remove . from @INC
262         }
263     }
264
265     my $utf8 = ($::with_utf8 || $::with_utf16) ? "-I$lib -Mutf8" : '';
266
267     my %options = (
268         perl => $perl,
269         lib => $lib,
270         test => $test,
271         run_dir => $run_dir,
272         return_dir => $return_dir,
273         testswitch => $testswitch,
274         utf8 => $utf8,
275         file => $file_opts,
276         switch => $switch,
277     );
278
279     return \%options;
280 }
281
282 sub _cmd {
283     my($options, $type) = @_;
284
285     my $test = $options->{test};
286
287     my $cmd;
288     if ($type eq 'deparse') {
289         my $perl = "$options->{perl} $options->{testswitch}";
290         my $lib = $options->{lib};
291
292         $cmd = (
293           "$perl $options->{switch} -I$lib -MO=-qq,Deparse,-sv1.,".
294           "-l$::deparse_opts$options->{file} ".
295           "$test > $test.dp ".
296           "&& $perl $options->{switch} -I$lib $test.dp"
297         );
298     }
299     elsif ($type eq 'perl') {
300         my $perl = $options->{perl};
301         my $redir = $^O eq 'VMS' ? '2>&1' : '';
302
303         if ($ENV{PERL_VALGRIND}) {
304             my $perl_supp = $options->{return_dir} ? "$options->{return_dir}/perl.supp" : "perl.supp";
305             my $valgrind_exe = $ENV{VALGRIND} // 'valgrind';
306             my $vg_opts = $ENV{VG_OPTS}
307               // '--log-fd=3 '
308                   . "--suppressions=$perl_supp --leak-check=yes "
309                   . "--leak-resolution=high --show-reachable=yes "
310                   . "--num-callers=50 --track-origins=yes";
311             $perl = "$valgrind_exe $vg_opts $perl";
312             $redir = "3>$Valgrind_Log";
313             if ($options->{run_dir}) {
314                 $Valgrind_Log = "$options->{run_dir}/$Valgrind_Log";
315             }
316         }
317
318         my $args = "$options->{testswitch} $options->{switch} $options->{utf8}";
319         $cmd = $perl . _quote_args($args) . " $test $redir";
320     }
321     return $cmd;
322 }
323
324 sub _before_fork {
325     my ($options) = @_;
326
327     if ($options->{run_dir}) {
328         my $run_dir = $options->{run_dir};
329         chdir $run_dir or die "Can't chdir to '$run_dir': $!";
330     }
331
332     return;
333 }
334
335 sub _after_fork {
336     my ($options) = @_;
337
338     if ($options->{return_dir}) {
339         my $return_dir = $options->{return_dir};
340         chdir $return_dir
341            or die "Can't chdir from '$options->{run_dir}' to '$return_dir': $!";
342     }
343
344     return;
345 }
346
347 sub _run_test {
348     my ($test, $type) = @_;
349
350     my $options = _scan_test($test, $type);
351     # $test might have changed if we're in ext/Foo, so don't use it anymore
352     # from now on. Use $options->{test} instead.
353
354     _before_fork($options);
355
356     my $cmd = _cmd($options, $type);
357
358     open(my $results, "$cmd |") or print "can't run '$cmd': $!.\n";
359
360     _after_fork($options);
361
362     # Our environment may force us to use UTF-8, but we can't be sure that
363     # anything we're reading from will be generating (well formed) UTF-8
364     # This may not be the best way - possibly we should unset ${^OPEN} up
365     # top?
366     binmode $results;
367
368     return $results;
369 }
370
371 sub _quote_args {
372     my ($args) = @_;
373     my $argstring = '';
374
375     foreach (split(/\s+/,$args)) {
376        # In VMS protect with doublequotes because otherwise
377        # DCL will lowercase -- unless already doublequoted.
378        $_ = q(").$_.q(") if ($^O eq 'VMS') && !/^\"/ && length($_) > 0;
379        $argstring = $argstring . ' ' . $_;
380     }
381     return $argstring;
382 }
383
384 sub _populate_hash {
385     return unless defined $_[0];
386     return map {$_, 1} split /\s+/, $_[0];
387 }
388
389 sub _tests_from_manifest {
390     my ($extensions, $known_extensions) = @_;
391     my %skip;
392     my %extensions = _populate_hash($extensions);
393     my %known_extensions = _populate_hash($known_extensions);
394
395     foreach (keys %known_extensions) {
396         $skip{$_} = 1 unless $extensions{$_};
397     }
398
399     my @results;
400     my $mani = '../MANIFEST';
401     if (open(MANI, $mani)) {
402         while (<MANI>) {
403             if (m!^((?:cpan|dist|ext)/(\S+)/+(?:[^/\s]+\.t|test\.pl)|lib/\S+?(?:\.t|test\.pl))\s!) {
404                 my $t = $1;
405                 my $extension = $2;
406                 if (!$::core || $t =~ m!^lib/[a-z]!) {
407                     if (defined $extension) {
408                         $extension =~ s!/t(:?/\S+)*$!!;
409                         # XXX Do I want to warn that I'm skipping these?
410                         next if $skip{$extension};
411                         my $flat_extension = $extension;
412                         $flat_extension =~ s!-!/!g;
413                         next if $skip{$flat_extension}; # Foo/Bar may live in Foo-Bar
414                     }
415                     my $path = "../$t";
416                     push @results, $path;
417                     $::path_to_name{$path} = $t;
418                 }
419             }
420         }
421         close MANI;
422     } else {
423         warn "$0: cannot open $mani: $!\n";
424     }
425     return @results;
426 }
427
428 unless (@ARGV) {
429     # base first, as TEST bails out if that can't run
430     # then comp, to validate that require works
431     # then run, to validate that -M works
432     # then we know we can -MTestInit for everything else, making life simpler
433     foreach my $dir (qw(base comp run cmd io re op uni mro)) {
434         _find_tests($dir);
435     }
436     unless ($::core) {
437         _find_tests('porting');
438         _find_tests("lib"); 
439     }
440     # Config.pm may be broken for make minitest. And this is only a refinement
441     # for skipping tests on non-default builds, so it is allowed to fail.
442     # What we want to to is make a list of extensions which we did not build.
443     my $configsh = '../config.sh';
444     my ($extensions, $known_extensions);
445     if (-f $configsh) {
446         open FH, $configsh or die "Can't open $configsh: $!";
447         while (<FH>) {
448             if (/^extensions=['"](.*)['"]$/) {
449                 $extensions = $1;
450             }
451             elsif (/^known_extensions=['"](.*)['"]$/) {
452                 $known_extensions = $1;
453             }
454         }
455         if (!defined $known_extensions) {
456             warn "No known_extensions line found in $configsh";
457         }
458         if (!defined $extensions) {
459             warn "No extensions line found in $configsh";
460         }
461     }
462     # The "complex" constructions of list return from a subroutine, and push of
463     # a list, might fail if perl is really hosed, but they aren't needed for
464     # make minitest, and the building of extensions will likely also fail if
465     # something is that badly wrong.
466     push @ARGV, _tests_from_manifest($extensions, $known_extensions);
467     unless ($::core) {
468         _find_tests('x2p');
469         _find_tests('japh') if $::torture;
470         _find_tests('t/benchmark') if $::benchmark or $ENV{PERL_BENCHMARK};
471         _find_tests('bigmem') if $ENV{PERL_TEST_MEMORY};
472     }
473 }
474
475 if ($::deparse) {
476     _testprogs('deparse', '',   @ARGV);
477 }
478 elsif ($::with_utf16) {
479     for my $e (0, 1) {
480         for my $b (0, 1) {
481             print STDERR "# ENDIAN $e BOM $b\n";
482             my @UARGV;
483             for my $a (@ARGV) {
484                 my $u = $a . "." . ($e ? "l" : "b") . "e" . ($b ? "b" : "");
485                 my $f = $e ? "v" : "n";
486                 push @UARGV, $u;
487                 unlink($u);
488                 if (open(A, $a)) {
489                     if (open(U, ">$u")) {
490                         print U pack("$f", 0xFEFF) if $b;
491                         while (<A>) {
492                             print U pack("$f*", unpack("C*", $_));
493                         }
494                         close(U);
495                     }
496                     close(A);
497                 }
498             }
499             _testprogs('perl', '', @UARGV);
500             unlink(@UARGV);
501         }
502     }
503 }
504 else {
505     _testprogs('perl',    '',   @ARGV);
506 }
507
508 sub _testprogs {
509     my ($type, $args, @tests) = @_;
510
511     print <<'EOT' if ($type eq 'deparse');
512 ------------------------------------------------------------------------------
513 TESTING DEPARSER
514 ------------------------------------------------------------------------------
515 EOT
516
517     $::bad_files = 0;
518
519     foreach my $t (@tests) {
520       unless (exists $::path_to_name{$t}) {
521         my $tname = "t/$t";
522         $::path_to_name{$t} = $tname;
523       }
524     }
525     my $maxlen = 0;
526     foreach (@::path_to_name{@tests}) {
527         s/\.\w+\z/ /; # space gives easy doubleclick to select fname
528         my $len = length ;
529         $maxlen = $len if $len > $maxlen;
530     }
531     # + 3 : we want three dots between the test name and the "ok"
532     my $dotdotdot = $maxlen + 3 ;
533     my $grind_ct = 0;           # count of non-empty valgrind reports
534     my $total_files = @tests;
535     my $good_files = 0;
536     my $tested_files  = 0;
537     my $totmax = 0;
538     my %failed_tests;
539     my $toolnm;         # valgrind, cachegrind, perf
540
541     while (my $test = shift @tests) {
542         my ($test_start_time, @starttimes) = 0;
543         if ($show_elapsed_time) {
544             $test_start_time = Time::HiRes::time();
545             # times() reports usage by TEST, but we want usage of each
546             # testprog it calls, so record accumulated times now,
547             # subtract them out afterwards.  Ideally, we'd take times
548             # in BEGIN/END blocks (giving better visibility of self vs
549             # children of each testprog), but that would require some
550             # IPC to send results back here, or a completely different
551             # collection scheme (Storable isnt tuned for incremental use)
552             @starttimes = times;
553         }
554         if ($test =~ /^$/) {
555             next;
556         }
557         if ($type eq 'deparse') {
558             if ($test eq "comp/redef.t") {
559                 # Redefinition happens at compile time
560                 next;
561             }
562             elsif ($test =~ m{lib/Switch/t/}) {
563                 # B::Deparse doesn't support source filtering
564                 next;
565             }
566         }
567         my $te = $::path_to_name{$test} . '.'
568                     x ($dotdotdot - length($::path_to_name{$test})) .' ';
569
570         if ($^O ne 'VMS') {  # defer printing on VMS due to piping bug
571             print $te;
572             $te = '';
573         }
574
575         (local $Valgrind_Log = "$test.valgrind-current") =~ s/^.*\///;
576         my $results = _run_test($test, $type);
577
578         my $failure;
579         my $next = 0;
580         my $seen_leader = 0;
581         my $seen_ok = 0;
582         my $trailing_leader = 0;
583         my $max;
584         my %todo;
585         while (<$results>) {
586             next if /^\s*$/; # skip blank lines
587             if (/^1..$/ && ($^O eq 'VMS')) {
588                 # VMS pipe bug inserts blank lines.
589                 my $l2 = <RESULTS>;
590                 if ($l2 =~ /^\s*$/) {
591                     $l2 = <RESULTS>;
592                 }
593                 $_ = '1..' . $l2;
594             }
595             if ($::verbose) {
596                 print $_;
597             }
598             unless (/^\#/) {
599                 if ($trailing_leader) {
600                     # shouldn't be anything following a postfix 1..n
601                     $failure = 'FAILED--extra output after trailing 1..n';
602                     last;
603                 }
604                 if (/^1\.\.([0-9]+)( todo ([\d ]+))?/) {
605                     if ($seen_leader) {
606                         $failure = 'FAILED--seen duplicate leader';
607                         last;
608                     }
609                     $max = $1;
610                     %todo = map { $_ => 1 } split / /, $3 if $3;
611                     $totmax = $totmax + $max;
612                     $tested_files = $tested_files + 1;
613                     if ($seen_ok) {
614                         # 1..n appears at end of file
615                         $trailing_leader = 1;
616                         if ($next != $max) {
617                             $failure = "FAILED--expected $max tests, saw $next";
618                             last;
619                         }
620                     }
621                     else {
622                         $next = 0;
623                     }
624                     $seen_leader = 1;
625                 }
626                 else {
627                     if (/^(not )?ok(?: (\d+))?[^\#]*(\s*\#.*)?/) {
628                         unless ($seen_leader) {
629                             unless ($seen_ok) {
630                                 $next = 0;
631                             }
632                         }
633                         $seen_ok = 1;
634                         $next = $next + 1;
635                         my($not, $num, $extra, $istodo) = ($1, $2, $3, 0);
636                         $num = $next unless $num;
637
638                         if ($num == $next) {
639
640                             # SKIP is essentially the same as TODO for t/TEST
641                             # this still conforms to TAP:
642                             # http://testanything.org/wiki/index.php/TAP_specification
643                             $extra and $istodo = $extra =~ /#\s*(?:TODO|SKIP)\b/;
644                             $istodo = 1 if $todo{$num};
645
646                             if( $not && !$istodo ) {
647                                 $failure = "FAILED at test $num";
648                                 last;
649                             }
650                         }
651                         else {
652                             $failure ="FAILED--expected test $next, saw test $num";
653                             last;
654                         }
655                     }
656                     elsif (/^Bail out!\s*(.*)/i) { # magic words
657                         die "FAILED--Further testing stopped" . ($1 ? ": $1\n" : ".\n");
658                     }
659                     else {
660                         # module tests are allowed extra output,
661                         # because Test::Harness allows it
662                         next if $test =~ /^\W*(cpan|dist|ext|lib)\b/;
663                         $failure = "FAILED--unexpected output at test $next";
664                         last;
665                     }
666                 }
667             }
668         }
669         close $results;
670
671         if (not defined $failure) {
672             $failure = 'FAILED--no leader found' unless $seen_leader;
673         }
674
675         if ($ENV{PERL_VALGRIND}) {
676             $toolnm = $ENV{VALGRIND};
677             $toolnm =~ s|.*/||;  # keep basename
678             my @valgrind;       # gets content of file
679             if (-e $Valgrind_Log) {
680                 if (open(V, $Valgrind_Log)) {
681                     @valgrind = <V>;
682                     close V;
683                 } else {
684                     warn "$0: Failed to open '$Valgrind_Log': $!\n";
685                 }
686             }
687             if ($ENV{VG_OPTS} =~ /(cachegrind)/ or $toolnm =~ /(perf)/) {
688                 $toolnm = $1;
689                 if ($toolnm eq 'perf') {
690                     # append perfs subcommand, not just stat
691                     my ($sub) = split /\s/, $ENV{VG_OPTS};
692                     $toolnm .= "-$sub";
693                 }
694                 if (rename $Valgrind_Log, "$test.$toolnm") {
695                     $grind_ct++;
696                 } else {
697                     warn "$0: Failed to create '$test.$toolnm': $!\n";
698                 }
699             }
700             elsif (@valgrind) {
701                 my $leaks = 0;
702                 my $errors = 0;
703                 for my $i (0..$#valgrind) {
704                     local $_ = $valgrind[$i];
705                     if (/^==\d+== ERROR SUMMARY: (\d+) errors? /) {
706                         $errors = $errors + $1;   # there may be multiple error summaries
707                     } elsif (/^==\d+== LEAK SUMMARY:/) {
708                         for my $off (1 .. 4) {
709                             if ($valgrind[$i+$off] =~
710                                 /(?:lost|reachable):\s+\d+ bytes in (\d+) blocks/) {
711                                 $leaks = $leaks + $1;
712                             }
713                         }
714                     }
715                 }
716                 if ($errors or $leaks) {
717                     if (rename $Valgrind_Log, "$test.valgrind") {
718                         $grind_ct = $grind_ct + 1;
719                     } else {
720                         warn "$0: Failed to create '$test.valgrind': $!\n";
721                     }
722                 }
723             } else {
724                 warn "No valgrind output?\n";
725             }
726             if (-e $Valgrind_Log) {
727                 unlink $Valgrind_Log
728                     or warn "$0: Failed to unlink '$Valgrind_Log': $!\n";
729             }
730         }
731         if ($type eq 'deparse') {
732             unlink "./$test.dp";
733         }
734         if ($ENV{PERL_3LOG}) {
735             my $tpp = $test;
736             $tpp =~ s:^\.\./::;
737             $tpp =~ s:/:_:g;
738             $tpp =~ s:\.t$:.3log:;
739             rename("perl.3log", $tpp) ||
740                 die "rename: perl3.log to $tpp: $!\n";
741         }
742         if (not defined $failure and $next != $max) {
743             $failure="FAILED--expected $max tests, saw $next";
744         }
745
746         if( !defined $failure  # don't mask a test failure
747             and $? )
748         {
749             $failure = "FAILED--non-zero wait status: $?";
750         }
751
752         if (defined $failure) {
753             print "${te}$failure\n";
754             $::bad_files = $::bad_files + 1;
755             if ($test =~ /^base/) {
756                 die "Failed a basic test ($test) -- cannot continue.\n";
757             }
758             $failed_tests{$test} = 1;
759         }
760         else {
761             if ($max) {
762                 my ($elapsed, $etms) = ("", 0);
763                 if ( $show_elapsed_time ) {
764                     $etms = (Time::HiRes::time() - $test_start_time) * 1000;
765                     $elapsed = sprintf(" %8.0f ms", $etms);
766
767                     my (@endtimes) = times;
768                     $endtimes[$_] -= $starttimes[$_] for 0..$#endtimes;
769                     splice @endtimes, 0, 2;    # drop self/harness times
770                     $_ *= 1000 for @endtimes;  # and scale to ms
771                     $timings{$test} = [$etms,@endtimes];
772                     $elapsed .= sprintf(" %5.0f ms", $_) for @endtimes;
773                 }
774                 print "${te}ok$elapsed\n";
775                 $good_files = $good_files + 1;
776             }
777             else {
778                 print "${te}skipped\n";
779                 $tested_files = $tested_files - 1;
780             }
781         }
782     } # while tests
783
784     if ($::bad_files == 0) {
785         if ($good_files) {
786             print "All tests successful.\n";
787             # XXX add mention of 'perlbug -ok' ?
788         }
789         else {
790             die "FAILED--no tests were run for some reason.\n";
791         }
792     }
793     else {
794         my $pct = $tested_files ? sprintf("%.2f", ($tested_files - $::bad_files) / $tested_files * 100) : "0.00";
795         my $s = $::bad_files == 1 ? "" : "s";
796         warn "Failed $::bad_files test$s out of $tested_files, $pct% okay.\n";
797         for my $test ( sort keys %failed_tests ) {
798             print "\t$test\n";
799         }
800         warn <<'SHRDLU_1';
801 ### Since not all tests were successful, you may want to run some of
802 ### them individually and examine any diagnostic messages they produce.
803 ### See the INSTALL document's section on "make test".
804 SHRDLU_1
805         warn <<'SHRDLU_2' if $good_files / $total_files > 0.8;
806 ### You have a good chance to get more information by running
807 ###   ./perl harness
808 ### in the 't' directory since most (>=80%) of the tests succeeded.
809 SHRDLU_2
810         if (eval {require Config; import Config; 1}) {
811             if ($::Config{usedl} && (my $p = $::Config{ldlibpthname})) {
812                 warn <<SHRDLU_3;
813 ### You may have to set your dynamic library search path,
814 ### $p, to point to the build directory:
815 SHRDLU_3
816                 if (exists $ENV{$p} && $ENV{$p} ne '') {
817                     warn <<SHRDLU_4a;
818 ###   setenv $p `pwd`:\$$p; cd t; ./perl harness
819 ###   $p=`pwd`:\$$p; export $p; cd t; ./perl harness
820 ###   export $p=`pwd`:\$$p; cd t; ./perl harness
821 SHRDLU_4a
822                 } else {
823                     warn <<SHRDLU_4b;
824 ###   setenv $p `pwd`; cd t; ./perl harness
825 ###   $p=`pwd`; export $p; cd t; ./perl harness
826 ###   export $p=`pwd`; cd t; ./perl harness
827 SHRDLU_4b
828                 }
829                 warn <<SHRDLU_5;
830 ### for csh-style shells, like tcsh; or for traditional/modern
831 ### Bourne-style shells, like bash, ksh, and zsh, respectively.
832 SHRDLU_5
833             }
834         }
835     }
836     my ($user,$sys,$cuser,$csys) = times;
837     my $tot = sprintf("u=%.2f  s=%.2f  cu=%.2f  cs=%.2f  scripts=%d  tests=%d",
838                       $user,$sys,$cuser,$csys,$tested_files,$totmax);
839     print "$tot\n";
840     if ($good_files) {
841         if (-d $show_elapsed_time) {
842             # HARNESS_TIMER = <a-directory>.  Save timings etc to
843             # storable file there.  NB: the test cds to ./t/, so
844             # relative path must account for that, ie ../../perf
845             # points to dir next to source tree.
846             require Storable;
847             my @dt = localtime;
848             $dt[5] += 1900; $dt[4] += 1; # fix year, month
849             my $fn = "$show_elapsed_time/".join('-', @dt[5,4,3,2,1]).".ttimes";
850             Storable::store({ perf => \%timings,
851                               gather_conf_platform_info(),
852                               total => $tot,
853                             }, $fn);
854             print "wrote storable file: $fn\n";
855         }
856     }
857     if ($ENV{PERL_VALGRIND}) {
858         my $s = $grind_ct == 1 ? '' : 's';
859         print "$grind_ct valgrind report$s created.\n", ;
860         if ($toolnm eq 'cachegrind') {
861             # cachegrind leaves a lot of cachegrind.out.$pid litter
862             # around the tree, find and delete them
863             unlink _find_files('cachegrind.out.\d+$',
864                              qw ( ../t ../cpan ../ext ../dist/ ));
865         }
866     }
867 }
868 exit ($::bad_files != 0);
869
870 # Collect platform, config data that should allow comparing
871 # performance data between different machines.  With enough data,
872 # and/or clever statistical analysis, it should be possible to
873 # determine the effect of config choices, more memory, etc
874
875 sub gather_conf_platform_info {
876     # currently rather quick & dirty, and subject to change
877     # for both content and format.
878     require Config;
879     my (%conf, @platform) = ();
880     $conf{$_} = $Config::Config{$_} for
881         grep /cc|git|config_arg\d+/, keys %Config::Config;
882     if (-f '/proc/cpuinfo') {
883         open my $fh, '/proc/cpuinfo' or warn "$!: /proc/cpuinfo\n";
884         @platform = grep /name|cpu/, <$fh>;
885         chomp $_ for @platform;
886     }
887     unshift @platform, $^O;
888
889     return (
890         conf => \%conf,
891         platform => {cpu => \@platform,
892                      mem => [ grep s/\s+/ /,
893                               grep chomp, `free` ],
894                      load => [ grep chomp, `uptime` ],
895         },
896         host => (grep chomp, `hostname -f`),
897         version => '0.03', # bump for conf, platform, or data collection changes
898         );
899 }
900
901 # ex: set ts=8 sts=4 sw=4 noet: