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