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.)
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.
14 # In which case, we need to stop t/TEST actually running tests, as all
15 # t/harness needs are its subroutines.
18 # directories with special sets of test switches
23 '../ext/File-Glob/t' => '-I.. -MTestInit', # FIXME - tests assume t/
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
31 '../cpan/Archive-Extract' => 1,
32 '../cpan/Archive-Tar' => 1,
33 '../cpan/AutoLoader' => 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/Tie-File' => 1,
55 '../cpan/podlators' => 1,
57 '../dist/ExtUtils-Command' => 1,
58 '../dist/ExtUtils-Install' => 1,
59 '../dist/ExtUtils-Manifest' => 1,
60 '../dist/ExtUtils-ParseXS' => 1,
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,
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 for my $envname (qw(PERL5LIB PERLLIB PERL5OPT)) {
85 my $override = $ENV{"${envname}_TEST"};
86 if (defined $override) {
87 warn "$0: $envname=$override\n";
88 $ENV{$envname} = $override;
91 delete $ENV{$envname};
99 # Location to put the Valgrind log.
104 # for testing TEST only
105 #BEGIN { require '../lib/strict.pm'; "strict"->import() };
106 #BEGIN { require '../lib/warnings.pm'; "warnings"->import() };
108 # remove empty elements due to insertion of empty symbols via "''p1'" syntax
109 @ARGV = grep($_,@ARGV) if $^O eq 'VMS';
110 our $show_elapsed_time = $ENV{HARNESS_TIMER} || 0;
112 # Cheesy version of Getopt::Std. We can't replace it with that, because we
113 # can't rely on require working.
116 foreach my $idx (0..$#ARGV) {
117 push( @argv, $ARGV[$idx] ), next unless $ARGV[$idx] =~ /^-(\S+)$/;
118 $::benchmark = 1 if $1 eq 'benchmark';
119 $::core = 1 if $1 eq 'core';
120 $::verbose = 1 if $1 eq 'v';
121 $::torture = 1 if $1 eq 'torture';
122 $::with_utf8 = 1 if $1 eq 'utf8';
123 $::with_utf16 = 1 if $1 eq 'utf16';
124 $::taintwarn = 1 if $1 eq 'taintwarn';
125 if ($1 =~ /^deparse(,.+)?$/) {
127 $::deparse_opts = $1;
133 chdir 't' if -f 't/TEST';
134 if (-f 'TEST' && -f 'harness' && -d '../lib') {
138 die "You need to run \"make test\" first to set things up.\n"
139 unless -e 'perl' or -e 'perl.exe' or -e 'perl.pm';
141 if ($ENV{PERL_3LOG}) { # Tru64 third(1) tool, see perlhack
142 unless (-x 'perl.third') {
143 unless (-x '../perl.third') {
144 die "You need to run \"make perl.third first.\n";
147 print "Symlinking ../perl.third as perl.third...\n";
148 die "Failed to symlink: $!\n"
149 unless symlink("../perl.third", "perl.third");
150 die "Symlinked but no executable perl.third: $!\n"
151 unless -x 'perl.third';
156 # check leakage for embedders
157 $ENV{PERL_DESTRUCT_LEVEL} = 2 unless exists $ENV{PERL_DESTRUCT_LEVEL};
159 $ENV{EMXSHELL} = 'sh'; # For OS/2
161 if ($show_elapsed_time) { require Time::HiRes }
162 my %timings = (); # testname => [@et] pairs if $show_elapsed_time.
173 # Roll your own File::Find!
176 opendir DIR, $dir or die "Trouble opening $dir: $!";
177 foreach my $f (sort { $a cmp $b } readdir DIR) {
180 my $fullpath = "$dir/$f";
183 _find_tests($fullpath);
184 } elsif ($f =~ /\.t$/) {
185 push @ARGV, $fullpath;
191 # Scan the text of the test program to find switches and special options
192 # we might need to apply.
194 my($test, $type) = @_;
196 open(my $script, "<", $test) or die "Can't read $test.\n";
197 my $first_line = <$script>;
199 $first_line =~ tr/\0//d if $::with_utf16;
202 if ($first_line =~ /#!.*\bperl.*\s-\w*([tT])/) {
206 # not all tests are expected to pass with this option
214 if ($type eq 'deparse') {
215 # Look for #line directives which change the filename
217 $file_opts = $file_opts . ",-f$3$4"
218 if /^#\s*line\s+(\d+)\s+((\w+)|"([^"]+)")/;
229 $test =~ /^(.+)\/[^\/]+/;
231 my $testswitch = $dir_to_switch{$dir};
232 if (!defined $testswitch) {
233 if ($test =~ s!^(\.\./(cpan|dist|ext)/[^/]+)/t!t!) {
235 $return_dir = '../../t';
237 $perl = '../../t/perl';
238 $testswitch = "-I../.. -MTestInit=U2T";
239 if ($2 eq 'cpan' || $2 eq 'dist') {
241 $testswitch = $testswitch . ',A';
243 if ($temp_no_core{$run_dir}) {
244 $testswitch = $testswitch . ',NC';
247 } elsif ($test =~ m!^\.\./lib!) {
248 $testswitch = '-I.. -MTestInit=U1'; # -T will remove . from @INC
250 $testswitch = '-I.. -MTestInit'; # -T will remove . from @INC
254 my $utf8 = ($::with_utf8 || $::with_utf16) ? "-I$lib -Mutf8" : '';
261 return_dir => $return_dir,
262 testswitch => $testswitch,
272 my($options, $type) = @_;
274 my $test = $options->{test};
277 if ($type eq 'deparse') {
278 my $perl = "$options->{perl} $options->{testswitch}";
279 my $lib = $options->{lib};
282 "$perl $options->{switch} -I$lib -MO=-qq,Deparse,-sv1.,".
283 "-l$::deparse_opts$options->{file} ".
285 "&& $perl $options->{switch} -I$lib $test.dp"
288 elsif ($type eq 'perl') {
289 my $perl = $options->{perl};
290 my $redir = $^O eq 'VMS' ? '2>&1' : '';
292 if ($ENV{PERL_VALGRIND}) {
293 my $perl_supp = $options->{return_dir} ? "$options->{return_dir}/perl.supp" : "perl.supp";
294 my $valgrind_exe = $ENV{VALGRIND} // 'valgrind';
295 my $vg_opts = $ENV{VG_OPTS}
297 . "--suppressions=$perl_supp --leak-check=yes "
298 . "--leak-resolution=high --show-reachable=yes "
299 . "--num-callers=50 --track-origins=yes";
300 $perl = "$valgrind_exe $vg_opts $perl";
301 $redir = "3>$Valgrind_Log";
302 if ($options->{run_dir}) {
303 $Valgrind_Log = "$options->{run_dir}/$Valgrind_Log";
307 my $args = "$options->{testswitch} $options->{switch} $options->{utf8}";
308 $cmd = $perl . _quote_args($args) . " $test $redir";
316 if ($options->{run_dir}) {
317 my $run_dir = $options->{run_dir};
318 chdir $run_dir or die "Can't chdir to '$run_dir': $!";
327 if ($options->{return_dir}) {
328 my $return_dir = $options->{return_dir};
330 or die "Can't chdir from '$options->{run_dir}' to '$return_dir': $!";
337 my ($test, $type) = @_;
339 my $options = _scan_test($test, $type);
340 # $test might have changed if we're in ext/Foo, so don't use it anymore
341 # from now on. Use $options->{test} instead.
343 _before_fork($options);
345 my $cmd = _cmd($options, $type);
347 open(my $results, "$cmd |") or print "can't run '$cmd': $!.\n";
349 _after_fork($options);
351 # Our environment may force us to use UTF-8, but we can't be sure that
352 # anything we're reading from will be generating (well formed) UTF-8
353 # This may not be the best way - possibly we should unset ${^OPEN} up
364 foreach (split(/\s+/,$args)) {
365 # In VMS protect with doublequotes because otherwise
366 # DCL will lowercase -- unless already doublequoted.
367 $_ = q(").$_.q(") if ($^O eq 'VMS') && !/^\"/ && length($_) > 0;
368 $argstring = $argstring . ' ' . $_;
374 return unless defined $_[0];
375 return map {$_, 1} split /\s+/, $_[0];
378 sub _tests_from_manifest {
379 my ($extensions, $known_extensions) = @_;
381 my %extensions = _populate_hash($extensions);
382 my %known_extensions = _populate_hash($known_extensions);
384 foreach (keys %known_extensions) {
385 $skip{$_} = 1 unless $extensions{$_};
389 my $mani = '../MANIFEST';
390 if (open(MANI, $mani)) {
392 if (m!^((?:cpan|dist|ext)/(\S+)/+(?:[^/\s]+\.t|test\.pl)|lib/\S+?(?:\.t|test\.pl))\s!) {
395 if (!$::core || $t =~ m!^lib/[a-z]!) {
396 if (defined $extension) {
397 $extension =~ s!/t(:?/\S+)*$!!;
398 # XXX Do I want to warn that I'm skipping these?
399 next if $skip{$extension};
400 my $flat_extension = $extension;
401 $flat_extension =~ s!-!/!g;
402 next if $skip{$flat_extension}; # Foo/Bar may live in Foo-Bar
405 push @results, $path;
406 $::path_to_name{$path} = $t;
412 warn "$0: cannot open $mani: $!\n";
418 # base first, as TEST bails out if that can't run
419 # then comp, to validate that require works
420 # then run, to validate that -M works
421 # then we know we can -MTestInit for everything else, making life simpler
422 foreach my $dir (qw(base comp run cmd io re op uni mro)) {
425 _find_tests("lib") unless $::core;
426 # Config.pm may be broken for make minitest. And this is only a refinement
427 # for skipping tests on non-default builds, so it is allowed to fail.
428 # What we want to to is make a list of extensions which we did not build.
429 my $configsh = '../config.sh';
430 my ($extensions, $known_extensions);
432 open FH, $configsh or die "Can't open $configsh: $!";
434 if (/^extensions=['"](.*)['"]$/) {
437 elsif (/^known_extensions=['"](.*)['"]$/) {
438 $known_extensions = $1;
441 if (!defined $known_extensions) {
442 warn "No known_extensions line found in $configsh";
444 if (!defined $extensions) {
445 warn "No extensions line found in $configsh";
448 # The "complex" constructions of list return from a subroutine, and push of
449 # a list, might fail if perl is really hosed, but they aren't needed for
450 # make minitest, and the building of extensions will likely also fail if
451 # something is that badly wrong.
452 push @ARGV, _tests_from_manifest($extensions, $known_extensions);
455 _find_tests('porting');
456 _find_tests('japh') if $::torture;
457 _find_tests('t/benchmark') if $::benchmark or $ENV{PERL_BENCHMARK};
462 _testprogs('deparse', '', @ARGV);
464 elsif ($::with_utf16) {
467 print STDERR "# ENDIAN $e BOM $b\n";
470 my $u = $a . "." . ($e ? "l" : "b") . "e" . ($b ? "b" : "");
471 my $f = $e ? "v" : "n";
475 if (open(U, ">$u")) {
476 print U pack("$f", 0xFEFF) if $b;
478 print U pack("$f*", unpack("C*", $_));
485 _testprogs('perl', '', @UARGV);
491 _testprogs('perl', '', @ARGV);
495 my ($type, $args, @tests) = @_;
497 print <<'EOT' if ($type eq 'deparse');
498 ------------------------------------------------------------------------------
500 ------------------------------------------------------------------------------
505 foreach my $t (@tests) {
506 unless (exists $::path_to_name{$t}) {
508 $::path_to_name{$t} = $tname;
512 foreach (@::path_to_name{@tests}) {
513 s/\.\w+\z/ /; # space gives easy doubleclick to select fname
515 $maxlen = $len if $len > $maxlen;
517 # + 3 : we want three dots between the test name and the "ok"
518 my $dotdotdot = $maxlen + 3 ;
519 my $grind_ct = 0; # count of non-empty valgrind reports
520 my $total_files = @tests;
522 my $tested_files = 0;
526 while (my $test = shift @tests) {
527 my ($test_start_time, @starttimes) = 0;
528 if ($show_elapsed_time) {
529 $test_start_time = Time::HiRes::time();
530 # times() reports usage by TEST, but we want usage of each
531 # testprog it calls, so record accumulated times now,
532 # subtract them out afterwards. Ideally, we'd take times
533 # in BEGIN/END blocks (giving better visibility of self vs
534 # children of each testprog), but that would require some
535 # IPC to send results back here, or a completely different
536 # collection scheme (Storable isnt tuned for incremental use)
542 if ($type eq 'deparse') {
543 if ($test eq "comp/redef.t") {
544 # Redefinition happens at compile time
547 elsif ($test =~ m{lib/Switch/t/}) {
548 # B::Deparse doesn't support source filtering
552 my $te = $::path_to_name{$test} . '.'
553 x ($dotdotdot - length($::path_to_name{$test})) .' ';
555 if ($^O ne 'VMS') { # defer printing on VMS due to piping bug
560 (local $Valgrind_Log = "$test.valgrind-current") =~ s/^.*\///;
561 my $results = _run_test($test, $type);
567 my $trailing_leader = 0;
571 next if /^\s*$/; # skip blank lines
572 if (/^1..$/ && ($^O eq 'VMS')) {
573 # VMS pipe bug inserts blank lines.
575 if ($l2 =~ /^\s*$/) {
584 if ($trailing_leader) {
585 # shouldn't be anything following a postfix 1..n
586 $failure = 'FAILED--extra output after trailing 1..n';
589 if (/^1\.\.([0-9]+)( todo ([\d ]+))?/) {
591 $failure = 'FAILED--seen duplicate leader';
595 %todo = map { $_ => 1 } split / /, $3 if $3;
596 $totmax = $totmax + $max;
597 $tested_files = $tested_files + 1;
599 # 1..n appears at end of file
600 $trailing_leader = 1;
602 $failure = "FAILED--expected $max tests, saw $next";
612 if (/^(not )?ok(?: (\d+))?[^\#]*(\s*\#.*)?/) {
613 unless ($seen_leader) {
620 my($not, $num, $extra, $istodo) = ($1, $2, $3, 0);
621 $num = $next unless $num;
625 # SKIP is essentially the same as TODO for t/TEST
626 # this still conforms to TAP:
627 # http://testanything.org/wiki/index.php/TAP_specification
628 $extra and $istodo = $extra =~ /#\s*(?:TODO|SKIP)\b/;
629 $istodo = 1 if $todo{$num};
631 if( $not && !$istodo ) {
632 $failure = "FAILED at test $num";
637 $failure ="FAILED--expected test $next, saw test $num";
641 elsif (/^Bail out!\s*(.*)/i) { # magic words
642 die "FAILED--Further testing stopped" . ($1 ? ": $1\n" : ".\n");
645 # module tests are allowed extra output,
646 # because Test::Harness allows it
647 next if $test =~ /^\W*(cpan|dist|ext|lib)\b/;
648 $failure = "FAILED--unexpected output at test $next";
656 if (not defined $failure) {
657 $failure = 'FAILED--no leader found' unless $seen_leader;
660 if ($ENV{PERL_VALGRIND}) {
661 my $toolnm = $ENV{VALGRIND};
662 $toolnm =~ s|.*/||; # keep basename
663 my @valgrind; # gets content of file
664 if (-e $Valgrind_Log) {
665 if (open(V, $Valgrind_Log)) {
669 warn "$0: Failed to open '$Valgrind_Log': $!\n";
672 if ($ENV{VG_OPTS} =~ /(cachegrind)/ or $toolnm =~ /(perf)/) {
674 if ($toolnm eq 'perf') {
675 # append perfs subcommand, not just stat
676 my ($sub) = split /\s/, $ENV{VG_OPTS};
679 if (rename $Valgrind_Log, "$test.$toolnm") {
682 warn "$0: Failed to create '$test.$toolnm': $!\n";
688 for my $i (0..$#valgrind) {
689 local $_ = $valgrind[$i];
690 if (/^==\d+== ERROR SUMMARY: (\d+) errors? /) {
691 $errors = $errors + $1; # there may be multiple error summaries
692 } elsif (/^==\d+== LEAK SUMMARY:/) {
693 for my $off (1 .. 4) {
694 if ($valgrind[$i+$off] =~
695 /(?:lost|reachable):\s+\d+ bytes in (\d+) blocks/) {
696 $leaks = $leaks + $1;
701 if ($errors or $leaks) {
702 if (rename $Valgrind_Log, "$test.valgrind") {
703 $grind_ct = $grind_ct + 1;
705 warn "$0: Failed to create '$test.valgrind': $!\n";
709 warn "No valgrind output?\n";
711 if (-e $Valgrind_Log) {
713 or warn "$0: Failed to unlink '$Valgrind_Log': $!\n";
716 if ($type eq 'deparse') {
719 if ($ENV{PERL_3LOG}) {
723 $tpp =~ s:\.t$:.3log:;
724 rename("perl.3log", $tpp) ||
725 die "rename: perl3.log to $tpp: $!\n";
727 if (not defined $failure and $next != $max) {
728 $failure="FAILED--expected $max tests, saw $next";
731 if( !defined $failure # don't mask a test failure
734 $failure = "FAILED--non-zero wait status: $?";
737 if (defined $failure) {
738 print "${te}$failure\n";
739 $::bad_files = $::bad_files + 1;
740 if ($test =~ /^base/) {
741 die "Failed a basic test ($test) -- cannot continue.\n";
743 $failed_tests{$test} = 1;
747 my ($elapsed, $etms) = ("", 0);
748 if ( $show_elapsed_time ) {
749 $etms = (Time::HiRes::time() - $test_start_time) * 1000;
750 $elapsed = sprintf(" %8.0f ms", $etms);
752 my (@endtimes) = times;
753 $endtimes[$_] -= $starttimes[$_] for 0..$#endtimes;
754 splice @endtimes, 0, 2; # drop self/harness times
755 $_ *= 1000 for @endtimes; # and scale to ms
756 $timings{$test} = [$etms,@endtimes];
757 $elapsed .= sprintf(" %5.0f ms", $_) for @endtimes;
759 print "${te}ok$elapsed\n";
760 $good_files = $good_files + 1;
763 print "${te}skipped\n";
764 $tested_files = $tested_files - 1;
769 if ($::bad_files == 0) {
771 print "All tests successful.\n";
772 # XXX add mention of 'perlbug -ok' ?
775 die "FAILED--no tests were run for some reason.\n";
779 my $pct = $tested_files ? sprintf("%.2f", ($tested_files - $::bad_files) / $tested_files * 100) : "0.00";
780 my $s = $::bad_files == 1 ? "" : "s";
781 warn "Failed $::bad_files test$s out of $tested_files, $pct% okay.\n";
782 for my $test ( sort keys %failed_tests ) {
786 ### Since not all tests were successful, you may want to run some of
787 ### them individually and examine any diagnostic messages they produce.
788 ### See the INSTALL document's section on "make test".
790 warn <<'SHRDLU_2' if $good_files / $total_files > 0.8;
791 ### You have a good chance to get more information by running
793 ### in the 't' directory since most (>=80%) of the tests succeeded.
795 if (eval {require Config; import Config; 1}) {
796 if ($::Config{usedl} && (my $p = $::Config{ldlibpthname})) {
798 ### You may have to set your dynamic library search path,
799 ### $p, to point to the build directory:
801 if (exists $ENV{$p} && $ENV{$p} ne '') {
803 ### setenv $p `pwd`:\$$p; cd t; ./perl harness
804 ### $p=`pwd`:\$$p; export $p; cd t; ./perl harness
805 ### export $p=`pwd`:\$$p; cd t; ./perl harness
809 ### setenv $p `pwd`; cd t; ./perl harness
810 ### $p=`pwd`; export $p; cd t; ./perl harness
811 ### export $p=`pwd`; cd t; ./perl harness
815 ### for csh-style shells, like tcsh; or for traditional/modern
816 ### Bourne-style shells, like bash, ksh, and zsh, respectively.
821 my ($user,$sys,$cuser,$csys) = times;
822 my $tot = sprintf("u=%.2f s=%.2f cu=%.2f cs=%.2f scripts=%d tests=%d",
823 $user,$sys,$cuser,$csys,$tested_files,$totmax);
826 if (-d $show_elapsed_time) {
827 # HARNESS_TIMER = <a-directory>. Save timings etc to
828 # storable file there. NB: the test cds to ./t/, so
829 # relative path must account for that, ie ../../perf
830 # points to dir next to source tree.
833 $dt[5] += 1900; $dt[4] += 1; # fix year, month
834 my $fn = "$show_elapsed_time/".join('-', @dt[5,4,3,2,1]).".ttimes";
835 Storable::store({ perf => \%timings,
836 gather_conf_platform_info(),
839 print "wrote storable file: $fn\n";
842 if ($ENV{PERL_VALGRIND}) {
843 my $s = $grind_ct == 1 ? '' : 's';
844 print "$grind_ct valgrind report$s created.\n", ;
847 exit ($::bad_files != 0);
849 # Collect platform, config data that should allow comparing
850 # performance data between different machines. With enough data,
851 # and/or clever statistical analysis, it should be possible to
852 # determine the effect of config choices, more memory, etc
854 sub gather_conf_platform_info {
855 # currently rather quick & dirty, and subject to change
856 # for both content and format.
858 my (%conf, @platform) = ();
859 $conf{$_} = $Config::Config{$_} for
860 grep /cc|git|config_arg\d+/, keys %Config::Config;
861 if (-f '/proc/cpuinfo') {
862 open my $fh, '/proc/cpuinfo' or warn "$!: /proc/cpuinfo\n";
863 @platform = grep /name|cpu/, <$fh>;
864 chomp $_ for @platform;
866 unshift @platform, $^O;
870 platform => {cpu => \@platform,
871 mem => [ grep s/\s+/ /,
872 grep chomp, `free` ],
873 load => [ grep chomp, `uptime` ],
875 host => (grep chomp, `hostname -f`),
876 version => '0.03', # bump for conf, platform, or data collection changes
880 # ex: set ts=8 sts=4 sw=4 noet: