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,
37 '../cpan/Devel-PPPort' => 1,
38 '../cpan/Encode' => 1,
39 '../cpan/ExtUtils-Command' => 1,
40 '../cpan/ExtUtils-Constant' => 1,
41 '../cpan/ExtUtils-MakeMaker' => 1,
42 '../cpan/ExtUtils-Manifest' => 1,
43 '../cpan/ExtUtils-ParseXS' => 1,
44 '../cpan/File-Fetch' => 1,
45 '../cpan/IPC-Cmd' => 1,
46 '../cpan/IPC-SysV' => 1,
47 '../cpan/Locale-Codes' => 1,
48 '../cpan/Log-Message' => 1,
49 '../cpan/Math-BigInt' => 1,
50 '../cpan/Math-BigRat' => 1,
51 '../cpan/Math-Complex' => 1,
52 '../cpan/Module-Build' => 1,
53 '../cpan/Module-Load' => 1,
54 '../cpan/Module-Load-Conditional' => 1,
55 '../cpan/Object-Accessor' => 1,
56 '../cpan/Package-Constants' => 1,
57 '../cpan/Parse-CPAN-Meta' => 1,
58 '../cpan/Pod-Simple' => 1,
59 '../cpan/Term-UI' => 1,
60 '../cpan/Test-Simple' => 1,
61 '../cpan/Tie-File' => 1,
62 '../cpan/bignum' => 1,
63 '../cpan/podlators' => 1,
64 '../dist/ExtUtils-Install' => 1,
68 ('../cpan/B-Debug' => 1,
69 '../cpan/Compress-Raw-Bzip2' => 1,
70 '../cpan/Compress-Raw-Zlib' => 1,
71 '../cpan/Devel-PPPort' => 1,
72 '../cpan/Getopt-Long' => 1,
73 '../cpan/IO-Compress' => 1,
74 '../cpan/Math-BigInt' => 1,
75 '../cpan/Math-BigRat' => 1,
76 '../cpan/MIME-Base64' => 1,
78 '../cpan/parent' => 1,
79 '../cpan/Parse-CPAN-Meta' => 1,
80 '../cpan/Pod-Simple' => 1,
81 '../cpan/podlators' => 1,
82 '../cpan/Test-Simple' => 1,
83 '../cpan/Tie-RefHash' => 1,
84 '../cpan/Time-HiRes' => 1,
85 '../cpan/Unicode-Collate' => 1,
86 '../cpan/Unicode-Normalize' => 1,
93 # Location to put the Valgrind log.
94 my $Valgrind_Log = 'current.valgrind';
98 # for testing TEST only
99 #BEGIN { require '../lib/strict.pm'; "strict"->import() };
100 #BEGIN { require '../lib/warnings.pm'; "warnings"->import() };
102 delete $ENV{PERL5LIB};
103 delete $ENV{PERLLIB};
104 delete $ENV{PERL5OPT};
106 # remove empty elements due to insertion of empty symbols via "''p1'" syntax
107 @ARGV = grep($_,@ARGV) if $^O eq 'VMS';
108 our $show_elapsed_time = $ENV{HARNESS_TIMER} || 0;
110 # Cheesy version of Getopt::Std. We can't replace it with that, because we
111 # can't rely on require working.
114 foreach my $idx (0..$#ARGV) {
115 push( @argv, $ARGV[$idx] ), next unless $ARGV[$idx] =~ /^-(\S+)$/;
116 $::benchmark = 1 if $1 eq 'benchmark';
117 $::core = 1 if $1 eq 'core';
118 $::verbose = 1 if $1 eq 'v';
119 $::torture = 1 if $1 eq 'torture';
120 $::with_utf8 = 1 if $1 eq 'utf8';
121 $::with_utf16 = 1 if $1 eq 'utf16';
122 $::taintwarn = 1 if $1 eq 'taintwarn';
123 $ENV{PERL_CORE_MINITEST} = 1 if $1 eq 'minitest';
124 if ($1 =~ /^deparse(,.+)?$/) {
126 $::deparse_opts = $1;
132 chdir 't' if -f 't/TEST';
133 if (-f 'TEST' && -f 'harness' && -d '../lib') {
137 die "You need to run \"make test\" first to set things up.\n"
138 unless -e 'perl' or -e 'perl.exe' or -e 'perl.pm';
140 if ($ENV{PERL_3LOG}) { # Tru64 third(1) tool, see perlhack
141 unless (-x 'perl.third') {
142 unless (-x '../perl.third') {
143 die "You need to run \"make perl.third first.\n";
146 print "Symlinking ../perl.third as perl.third...\n";
147 die "Failed to symlink: $!\n"
148 unless symlink("../perl.third", "perl.third");
149 die "Symlinked but no executable perl.third: $!\n"
150 unless -x 'perl.third';
155 # check leakage for embedders
156 $ENV{PERL_DESTRUCT_LEVEL} = 2 unless exists $ENV{PERL_DESTRUCT_LEVEL};
158 $ENV{EMXSHELL} = 'sh'; # For OS/2
160 if ($show_elapsed_time) { require Time::HiRes }
171 # Roll your own File::Find!
174 opendir DIR, $dir or die "Trouble opening $dir: $!";
175 foreach my $f (sort { $a cmp $b } readdir DIR) {
178 my $fullpath = "$dir/$f";
181 _find_tests($fullpath);
182 } elsif ($f =~ /\.t$/) {
183 push @ARGV, $fullpath;
189 # Scan the text of the test program to find switches and special options
190 # we might need to apply.
192 my($test, $type) = @_;
194 open(my $script, "<", $test) or die "Can't read $test.\n";
195 my $first_line = <$script>;
197 $first_line =~ tr/\0//d if $::with_utf16;
200 if ($first_line =~ /#!.*\bperl.*\s-\w*([tT])/) {
204 # not all tests are expected to pass with this option
212 if ($type eq 'deparse') {
213 # Look for #line directives which change the filename
215 $file_opts = $file_opts . ",-f$3$4"
216 if /^#\s*line\s+(\d+)\s+((\w+)|"([^"]+)")/;
227 $test =~ /^(.+)\/[^\/]+/;
229 my $testswitch = $dir_to_switch{$dir};
230 if (!defined $testswitch) {
231 if ($test =~ s!^(\.\./(cpan|dist|ext)/[^/]+)/t!t!) {
233 $return_dir = '../../t';
235 $perl = '../../t/perl';
236 $testswitch = "-I../.. -MTestInit=U2T";
237 if ($2 eq 'cpan' || $2 eq 'dist') {
239 $testswitch = $testswitch . ',A';
241 if ($temp_no_core{$run_dir}) {
242 $testswitch = $testswitch . ',NC';
246 $testswitch = '-I.. -MTestInit'; # -T will remove . from @INC
250 my $utf8 = ($::with_utf8 || $::with_utf16) ? "-I$lib -Mutf8" : '';
257 return_dir => $return_dir,
258 testswitch => $testswitch,
268 my($options, $type) = @_;
270 my $test = $options->{test};
273 if ($type eq 'deparse') {
274 my $perl = "$options->{perl} $options->{testswitch}";
275 my $lib = $options->{lib};
278 "$perl $options->{switch} -I$lib -MO=-qq,Deparse,-sv1.,".
279 "-l$::deparse_opts$options->{file} ".
281 "&& $perl $options->{switch} -I$lib $test.dp"
284 elsif ($type eq 'perl') {
285 my $perl = $options->{perl};
286 my $redir = $^O eq 'VMS' ? '2>&1' : '';
288 if ($ENV{PERL_VALGRIND}) {
289 my $valgrind = $ENV{VALGRIND} // 'valgrind';
290 my $vg_opts = $ENV{VG_OPTS}
291 // "--suppressions=perl.supp --leak-check=yes "
292 . "--leak-resolution=high --show-reachable=yes "
293 . "--num-callers=50";
294 $perl = "$valgrind --log-fd=3 $vg_opts $perl";
295 $redir = "3>$Valgrind_Log";
298 my $args = "$options->{testswitch} $options->{switch} $options->{utf8}";
299 $cmd = $perl . _quote_args($args) . " $test $redir";
308 if ($options->{run_dir}) {
309 my $run_dir = $options->{run_dir};
310 chdir $run_dir or die "Can't chdir to '$run_dir': $!";
319 if ($options->{return_dir}) {
320 my $return_dir = $options->{return_dir};
322 or die "Can't chdir from '$options->{run_dir}' to '$return_dir': $!";
329 my ($test, $type) = @_;
331 my $options = _scan_test($test, $type);
332 # $test might have changed if we're in ext/Foo, so don't use it anymore
333 # from now on. Use $options->{test} instead.
335 _before_fork($options);
337 my $cmd = _cmd($options, $type);
339 open(my $results, "$cmd |") or print "can't run '$cmd': $!.\n";
341 _after_fork($options);
343 # Our environment may force us to use UTF-8, but we can't be sure that
344 # anything we're reading from will be generating (well formed) UTF-8
345 # This may not be the best way - possibly we should unset ${^OPEN} up
356 foreach (split(/\s+/,$args)) {
357 # In VMS protect with doublequotes because otherwise
358 # DCL will lowercase -- unless already doublequoted.
359 $_ = q(").$_.q(") if ($^O eq 'VMS') && !/^\"/ && length($_) > 0;
360 $argstring = $argstring . ' ' . $_;
366 return unless defined $_[0];
367 return map {$_, 1} split /\s+/, $_[0];
370 sub _tests_from_manifest {
371 my ($extensions, $known_extensions) = @_;
373 my %extensions = _populate_hash($extensions);
374 my %known_extensions = _populate_hash($known_extensions);
376 foreach (keys %known_extensions) {
377 $skip{$_} = 1 unless $extensions{$_};
381 my $mani = '../MANIFEST';
382 if (open(MANI, $mani)) {
384 if (m!^((?:cpan|dist|ext)/(\S+)/+(?:[^/\s]+\.t|test\.pl)|lib/\S+?(?:\.t|test\.pl))\s!) {
387 if (!$::core || $t =~ m!^lib/[a-z]!) {
388 if (defined $extension) {
389 $extension =~ s!/t$!!;
390 # XXX Do I want to warn that I'm skipping these?
391 next if $skip{$extension};
392 my $flat_extension = $extension;
393 $flat_extension =~ s!-!/!g;
394 next if $skip{$flat_extension}; # Foo/Bar may live in Foo-Bar
397 push @results, $path;
398 $::path_to_name{$path} = $t;
404 warn "$0: cannot open $mani: $!\n";
410 # base first, as TEST bails out if that can't run
411 # then comp, to validate that require works
412 # then run, to validate that -M works
413 # then we know we can -MTestInit for everything else, making life simpler
414 foreach my $dir (qw(base comp run cmd io re op uni mro)) {
417 _find_tests("lib") unless $::core;
418 # Config.pm may be broken for make minitest. And this is only a refinement
419 # for skipping tests on non-default builds, so it is allowed to fail.
420 # What we want to to is make a list of extensions which we did not build.
421 my $configsh = '../config.sh';
422 my ($extensions, $known_extensions);
424 open FH, $configsh or die "Can't open $configsh: $!";
426 if (/^extensions=['"](.*)['"]$/) {
429 elsif (/^known_extensions=['"](.*)['"]$/) {
430 $known_extensions = $1;
433 if (!defined $known_extensions) {
434 warn "No known_extensions line found in $configsh";
436 if (!defined $extensions) {
437 warn "No extensions line found in $configsh";
440 # The "complex" constructions of list return from a subroutine, and push of
441 # a list, might fail if perl is really hosed, but they aren't needed for
442 # make minitest, and the building of extensions will likely also fail if
443 # something is that badly wrong.
444 push @ARGV, _tests_from_manifest($extensions, $known_extensions);
447 _find_tests('porting');
448 _find_tests('japh') if $::torture;
449 _find_tests('t/benchmark') if $::benchmark or $ENV{PERL_BENCHMARK};
454 _testprogs('deparse', '', @ARGV);
456 elsif ($::with_utf16) {
459 print STDERR "# ENDIAN $e BOM $b\n";
462 my $u = $a . "." . ($e ? "l" : "b") . "e" . ($b ? "b" : "");
463 my $f = $e ? "v" : "n";
467 if (open(U, ">$u")) {
468 print U pack("$f", 0xFEFF) if $b;
470 print U pack("$f*", unpack("C*", $_));
477 _testprogs('perl', '', @UARGV);
483 _testprogs('perl', '', @ARGV);
487 my ($type, $args, @tests) = @_;
489 print <<'EOT' if ($type eq 'deparse');
490 ------------------------------------------------------------------------------
492 ------------------------------------------------------------------------------
497 foreach my $t (@tests) {
498 unless (exists $::path_to_name{$t}) {
500 $::path_to_name{$t} = $tname;
504 foreach (@::path_to_name{@tests}) {
507 $maxlen = $len if $len > $maxlen;
509 # + 3 : we want three dots between the test name and the "ok"
510 my $dotdotdot = $maxlen + 3 ;
512 my $total_files = @tests;
514 my $tested_files = 0;
518 while (my $test = shift @tests) {
519 my $test_start_time = $show_elapsed_time ? Time::HiRes::time() : 0;
524 if ($type eq 'deparse') {
525 if ($test eq "comp/redef.t") {
526 # Redefinition happens at compile time
529 elsif ($test =~ m{lib/Switch/t/}) {
530 # B::Deparse doesn't support source filtering
534 my $te = $::path_to_name{$test} . '.'
535 x ($dotdotdot - length($::path_to_name{$test}));
537 if ($^O ne 'VMS') { # defer printing on VMS due to piping bug
542 my $results = _run_test($test, $type);
548 my $trailing_leader = 0;
552 next if /^\s*$/; # skip blank lines
553 if (/^1..$/ && ($^O eq 'VMS')) {
554 # VMS pipe bug inserts blank lines.
556 if ($l2 =~ /^\s*$/) {
565 if ($trailing_leader) {
566 # shouldn't be anything following a postfix 1..n
567 $failure = 'FAILED--extra output after trailing 1..n';
570 if (/^1\.\.([0-9]+)( todo ([\d ]+))?/) {
572 $failure = 'FAILED--seen duplicate leader';
576 %todo = map { $_ => 1 } split / /, $3 if $3;
577 $totmax = $totmax + $max;
578 $tested_files = $tested_files + 1;
580 # 1..n appears at end of file
581 $trailing_leader = 1;
583 $failure = "FAILED--expected $max tests, saw $next";
593 if (/^(not )?ok(?: (\d+))?[^\#]*(\s*\#.*)?/) {
594 unless ($seen_leader) {
601 my($not, $num, $extra, $istodo) = ($1, $2, $3, 0);
602 $num = $next unless $num;
606 # SKIP is essentially the same as TODO for t/TEST
607 # this still conforms to TAP:
608 # http://search.cpan.org/dist/TAP/TAP.pm
609 $extra and $istodo = $extra =~ /#\s*(?:TODO|SKIP)\b/;
610 $istodo = 1 if $todo{$num};
612 if( $not && !$istodo ) {
613 $failure = "FAILED at test $num";
618 $failure ="FAILED--expected test $next, saw test $num";
622 elsif (/^Bail out!\s*(.*)/i) { # magic words
623 die "FAILED--Further testing stopped" . ($1 ? ": $1\n" : ".\n");
626 # module tests are allowed extra output,
627 # because Test::Harness allows it
628 next if $test =~ /^\W*(cpan|dist|ext|lib)\b/;
629 $failure = "FAILED--unexpected output at test $next";
637 if (not defined $failure) {
638 $failure = 'FAILED--no leader found' unless $seen_leader;
641 if ($ENV{PERL_VALGRIND}) {
643 if (-e $Valgrind_Log) {
644 if (open(V, $Valgrind_Log)) {
648 warn "$0: Failed to open '$Valgrind_Log': $!\n";
651 if ($ENV{VG_OPTS} =~ /cachegrind/) {
652 if (rename $Valgrind_Log, "$test.valgrind") {
653 $valgrind = $valgrind + 1;
655 warn "$0: Failed to create '$test.valgrind': $!\n";
661 for my $i (0..$#valgrind) {
662 local $_ = $valgrind[$i];
663 if (/^==\d+== ERROR SUMMARY: (\d+) errors? /) {
664 $errors = $errors + $1; # there may be multiple error summaries
665 } elsif (/^==\d+== LEAK SUMMARY:/) {
666 for my $off (1 .. 4) {
667 if ($valgrind[$i+$off] =~
668 /(?:lost|reachable):\s+\d+ bytes in (\d+) blocks/) {
669 $leaks = $leaks + $1;
674 if ($errors or $leaks) {
675 if (rename $Valgrind_Log, "$test.valgrind") {
676 $valgrind = $valgrind + 1;
678 warn "$0: Failed to create '$test.valgrind': $!\n";
682 warn "No valgrind output?\n";
684 if (-e $Valgrind_Log) {
686 or warn "$0: Failed to unlink '$Valgrind_Log': $!\n";
689 if ($type eq 'deparse') {
692 if ($ENV{PERL_3LOG}) {
696 $tpp =~ s:\.t$:.3log:;
697 rename("perl.3log", $tpp) ||
698 die "rename: perl3.log to $tpp: $!\n";
700 if (not defined $failure and $next != $max) {
701 $failure="FAILED--expected $max tests, saw $next";
704 if( !defined $failure # don't mask a test failure
707 $failure = "FAILED--non-zero wait status: $?";
710 if (defined $failure) {
711 print "${te}$failure\n";
712 $::bad_files = $::bad_files + 1;
713 if ($test =~ /^base/) {
714 die "Failed a basic test ($test) -- cannot continue.\n";
716 $failed_tests{$test} = 1;
721 if ( $show_elapsed_time ) {
722 $elapsed = sprintf( " %8.0f ms", (Time::HiRes::time() - $test_start_time) * 1000 );
727 print "${te}ok$elapsed\n";
728 $good_files = $good_files + 1;
731 print "${te}skipped\n";
732 $tested_files = $tested_files - 1;
737 if ($::bad_files == 0) {
739 print "All tests successful.\n";
740 # XXX add mention of 'perlbug -ok' ?
743 die "FAILED--no tests were run for some reason.\n";
747 my $pct = $tested_files ? sprintf("%.2f", ($tested_files - $::bad_files) / $tested_files * 100) : "0.00";
748 my $s = $::bad_files == 1 ? "" : "s";
749 warn "Failed $::bad_files test$s out of $tested_files, $pct% okay.\n";
750 for my $test ( sort keys %failed_tests ) {
754 ### Since not all tests were successful, you may want to run some of
755 ### them individually and examine any diagnostic messages they produce.
756 ### See the INSTALL document's section on "make test".
758 warn <<'SHRDLU_2' if $good_files / $total_files > 0.8;
759 ### You have a good chance to get more information by running
761 ### in the 't' directory since most (>=80%) of the tests succeeded.
763 if (eval {require Config; import Config; 1}) {
764 if ($::Config{usedl} && (my $p = $::Config{ldlibpthname})) {
766 ### You may have to set your dynamic library search path,
767 ### $p, to point to the build directory:
769 if (exists $ENV{$p} && $ENV{$p} ne '') {
771 ### setenv $p `pwd`:\$$p; cd t; ./perl harness
772 ### $p=`pwd`:\$$p; export $p; cd t; ./perl harness
773 ### export $p=`pwd`:\$$p; cd t; ./perl harness
777 ### setenv $p `pwd`; cd t; ./perl harness
778 ### $p=`pwd`; export $p; cd t; ./perl harness
779 ### export $p=`pwd`; cd t; ./perl harness
783 ### for csh-style shells, like tcsh; or for traditional/modern
784 ### Bourne-style shells, like bash, ksh, and zsh, respectively.
789 my ($user,$sys,$cuser,$csys) = times;
790 print sprintf("u=%.2f s=%.2f cu=%.2f cs=%.2f scripts=%d tests=%d\n",
791 $user,$sys,$cuser,$csys,$tested_files,$totmax);
792 if ($ENV{PERL_VALGRIND}) {
793 my $s = $valgrind == 1 ? '' : 's';
794 print "$valgrind valgrind report$s created.\n", ;
797 exit ($::bad_files != 0);
799 # ex: set ts=8 sts=4 sw=4 noet: