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/Math-Complex' => 1,
46 '../cpan/Module-Build' => 1,
47 '../cpan/Module-Load' => 1,
48 '../cpan/Module-Load-Conditional' => 1,
49 '../cpan/Object-Accessor' => 1,
50 '../cpan/Package-Constants' => 1,
51 '../cpan/Parse-CPAN-Meta' => 1,
52 '../cpan/Pod-Simple' => 1,
53 '../cpan/Term-UI' => 1,
54 '../cpan/Test-Simple' => 1,
55 '../cpan/Tie-File' => 1,
56 '../cpan/podlators' => 1,
58 '../dist/ExtUtils-Command' => 1,
59 '../dist/ExtUtils-Install' => 1,
60 '../dist/ExtUtils-Manifest' => 1,
61 '../dist/ExtUtils-ParseXS' => 1,
65 ('../cpan/B-Debug' => 1,
66 '../cpan/Compress-Raw-Bzip2' => 1,
67 '../cpan/Compress-Raw-Zlib' => 1,
68 '../cpan/Devel-PPPort' => 1,
69 '../cpan/Getopt-Long' => 1,
70 '../cpan/IO-Compress' => 1,
71 '../cpan/MIME-Base64' => 1,
72 '../cpan/parent' => 1,
73 '../cpan/Parse-CPAN-Meta' => 1,
74 '../cpan/Pod-Simple' => 1,
75 '../cpan/podlators' => 1,
76 '../cpan/Test-Simple' => 1,
77 '../cpan/Tie-RefHash' => 1,
78 '../cpan/Time-HiRes' => 1,
79 '../cpan/Unicode-Collate' => 1,
80 '../cpan/Unicode-Normalize' => 1,
83 # delete env vars that may influence the results
84 # but allow override via *_TEST env var if wanted
85 # (e.g. PERL5OPT_TEST=-d:NYTProf)
86 for my $envname (qw(PERL5LIB PERLLIB PERL5OPT)) {
87 my $override = $ENV{"${envname}_TEST"};
88 if (defined $override) {
89 warn "$0: $envname=$override\n";
90 $ENV{$envname} = $override;
93 delete $ENV{$envname};
101 # Location to put the Valgrind log.
106 # for testing TEST only
107 #BEGIN { require '../lib/strict.pm'; "strict"->import() };
108 #BEGIN { require '../lib/warnings.pm'; "warnings"->import() };
110 # remove empty elements due to insertion of empty symbols via "''p1'" syntax
111 @ARGV = grep($_,@ARGV) if $^O eq 'VMS';
112 our $show_elapsed_time = $ENV{HARNESS_TIMER} || 0;
114 # Cheesy version of Getopt::Std. We can't replace it with that, because we
115 # can't rely on require working.
118 foreach my $idx (0..$#ARGV) {
119 push( @argv, $ARGV[$idx] ), next unless $ARGV[$idx] =~ /^-(\S+)$/;
120 $::benchmark = 1 if $1 eq 'benchmark';
121 $::core = 1 if $1 eq 'core';
122 $::verbose = 1 if $1 eq 'v';
123 $::torture = 1 if $1 eq 'torture';
124 $::with_utf8 = 1 if $1 eq 'utf8';
125 $::with_utf16 = 1 if $1 eq 'utf16';
126 $::taintwarn = 1 if $1 eq 'taintwarn';
127 if ($1 =~ /^deparse(,.+)?$/) {
129 $::deparse_opts = $1;
135 chdir 't' if -f 't/TEST';
136 if (-f 'TEST' && -f 'harness' && -d '../lib') {
140 die "You need to run \"make test\" first to set things up.\n"
141 unless -e 'perl' or -e 'perl.exe' or -e 'perl.pm';
143 if ($ENV{PERL_3LOG}) { # Tru64 third(1) tool, see perlhack
144 unless (-x 'perl.third') {
145 unless (-x '../perl.third') {
146 die "You need to run \"make perl.third first.\n";
149 print "Symlinking ../perl.third as perl.third...\n";
150 die "Failed to symlink: $!\n"
151 unless symlink("../perl.third", "perl.third");
152 die "Symlinked but no executable perl.third: $!\n"
153 unless -x 'perl.third';
158 # check leakage for embedders
159 $ENV{PERL_DESTRUCT_LEVEL} = 2 unless exists $ENV{PERL_DESTRUCT_LEVEL};
161 $ENV{EMXSHELL} = 'sh'; # For OS/2
163 if ($show_elapsed_time) { require Time::HiRes }
174 # Roll your own File::Find!
177 opendir DIR, $dir or die "Trouble opening $dir: $!";
178 foreach my $f (sort { $a cmp $b } readdir DIR) {
181 my $fullpath = "$dir/$f";
184 _find_tests($fullpath);
185 } elsif ($f =~ /\.t$/) {
186 push @ARGV, $fullpath;
192 # Scan the text of the test program to find switches and special options
193 # we might need to apply.
195 my($test, $type) = @_;
197 open(my $script, "<", $test) or die "Can't read $test.\n";
198 my $first_line = <$script>;
200 $first_line =~ tr/\0//d if $::with_utf16;
203 if ($first_line =~ /#!.*\bperl.*\s-\w*([tT])/) {
207 # not all tests are expected to pass with this option
215 if ($type eq 'deparse') {
216 # Look for #line directives which change the filename
218 $file_opts = $file_opts . ",-f$3$4"
219 if /^#\s*line\s+(\d+)\s+((\w+)|"([^"]+)")/;
230 $test =~ /^(.+)\/[^\/]+/;
232 my $testswitch = $dir_to_switch{$dir};
233 if (!defined $testswitch) {
234 if ($test =~ s!^(\.\./(cpan|dist|ext)/[^/]+)/t!t!) {
236 $return_dir = '../../t';
238 $perl = '../../t/perl';
239 $testswitch = "-I../.. -MTestInit=U2T";
240 if ($2 eq 'cpan' || $2 eq 'dist') {
242 $testswitch = $testswitch . ',A';
244 if ($temp_no_core{$run_dir}) {
245 $testswitch = $testswitch . ',NC';
248 } elsif ($test =~ m!^\.\./lib!) {
249 $testswitch = '-I.. -MTestInit=U1'; # -T will remove . from @INC
251 $testswitch = '-I.. -MTestInit'; # -T will remove . from @INC
255 my $utf8 = ($::with_utf8 || $::with_utf16) ? "-I$lib -Mutf8" : '';
262 return_dir => $return_dir,
263 testswitch => $testswitch,
273 my($options, $type) = @_;
275 my $test = $options->{test};
278 if ($type eq 'deparse') {
279 my $perl = "$options->{perl} $options->{testswitch}";
280 my $lib = $options->{lib};
283 "$perl $options->{switch} -I$lib -MO=-qq,Deparse,-sv1.,".
284 "-l$::deparse_opts$options->{file} ".
286 "&& $perl $options->{switch} -I$lib $test.dp"
289 elsif ($type eq 'perl') {
290 my $perl = $options->{perl};
291 my $redir = $^O eq 'VMS' ? '2>&1' : '';
293 if ($ENV{PERL_VALGRIND}) {
294 my $perl_supp = $options->{return_dir} ? "$options->{return_dir}/perl.supp" : "perl.supp";
295 my $valgrind = $ENV{VALGRIND} // 'valgrind';
296 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 --log-fd=3 $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";
317 if ($options->{run_dir}) {
318 my $run_dir = $options->{run_dir};
319 chdir $run_dir or die "Can't chdir to '$run_dir': $!";
328 if ($options->{return_dir}) {
329 my $return_dir = $options->{return_dir};
331 or die "Can't chdir from '$options->{run_dir}' to '$return_dir': $!";
338 my ($test, $type) = @_;
340 my $options = _scan_test($test, $type);
341 # $test might have changed if we're in ext/Foo, so don't use it anymore
342 # from now on. Use $options->{test} instead.
344 _before_fork($options);
346 my $cmd = _cmd($options, $type);
348 open(my $results, "$cmd |") or print "can't run '$cmd': $!.\n";
350 _after_fork($options);
352 # Our environment may force us to use UTF-8, but we can't be sure that
353 # anything we're reading from will be generating (well formed) UTF-8
354 # This may not be the best way - possibly we should unset ${^OPEN} up
365 foreach (split(/\s+/,$args)) {
366 # In VMS protect with doublequotes because otherwise
367 # DCL will lowercase -- unless already doublequoted.
368 $_ = q(").$_.q(") if ($^O eq 'VMS') && !/^\"/ && length($_) > 0;
369 $argstring = $argstring . ' ' . $_;
375 return unless defined $_[0];
376 return map {$_, 1} split /\s+/, $_[0];
379 sub _tests_from_manifest {
380 my ($extensions, $known_extensions) = @_;
382 my %extensions = _populate_hash($extensions);
383 my %known_extensions = _populate_hash($known_extensions);
385 foreach (keys %known_extensions) {
386 $skip{$_} = 1 unless $extensions{$_};
390 my $mani = '../MANIFEST';
391 if (open(MANI, $mani)) {
393 if (m!^((?:cpan|dist|ext)/(\S+)/+(?:[^/\s]+\.t|test\.pl)|lib/\S+?(?:\.t|test\.pl))\s!) {
396 if (!$::core || $t =~ m!^lib/[a-z]!) {
397 if (defined $extension) {
398 $extension =~ s!/t(:?/\S+)*$!!;
399 # XXX Do I want to warn that I'm skipping these?
400 next if $skip{$extension};
401 my $flat_extension = $extension;
402 $flat_extension =~ s!-!/!g;
403 next if $skip{$flat_extension}; # Foo/Bar may live in Foo-Bar
406 push @results, $path;
407 $::path_to_name{$path} = $t;
413 warn "$0: cannot open $mani: $!\n";
419 # base first, as TEST bails out if that can't run
420 # then comp, to validate that require works
421 # then run, to validate that -M works
422 # then we know we can -MTestInit for everything else, making life simpler
423 foreach my $dir (qw(base comp run cmd io re op uni mro)) {
426 _find_tests("lib") unless $::core;
427 # Config.pm may be broken for make minitest. And this is only a refinement
428 # for skipping tests on non-default builds, so it is allowed to fail.
429 # What we want to to is make a list of extensions which we did not build.
430 my $configsh = '../config.sh';
431 my ($extensions, $known_extensions);
433 open FH, $configsh or die "Can't open $configsh: $!";
435 if (/^extensions=['"](.*)['"]$/) {
438 elsif (/^known_extensions=['"](.*)['"]$/) {
439 $known_extensions = $1;
442 if (!defined $known_extensions) {
443 warn "No known_extensions line found in $configsh";
445 if (!defined $extensions) {
446 warn "No extensions line found in $configsh";
449 # The "complex" constructions of list return from a subroutine, and push of
450 # a list, might fail if perl is really hosed, but they aren't needed for
451 # make minitest, and the building of extensions will likely also fail if
452 # something is that badly wrong.
453 push @ARGV, _tests_from_manifest($extensions, $known_extensions);
456 _find_tests('porting');
457 _find_tests('japh') if $::torture;
458 _find_tests('t/benchmark') if $::benchmark or $ENV{PERL_BENCHMARK};
463 _testprogs('deparse', '', @ARGV);
465 elsif ($::with_utf16) {
468 print STDERR "# ENDIAN $e BOM $b\n";
471 my $u = $a . "." . ($e ? "l" : "b") . "e" . ($b ? "b" : "");
472 my $f = $e ? "v" : "n";
476 if (open(U, ">$u")) {
477 print U pack("$f", 0xFEFF) if $b;
479 print U pack("$f*", unpack("C*", $_));
486 _testprogs('perl', '', @UARGV);
492 _testprogs('perl', '', @ARGV);
496 my ($type, $args, @tests) = @_;
498 print <<'EOT' if ($type eq 'deparse');
499 ------------------------------------------------------------------------------
501 ------------------------------------------------------------------------------
506 foreach my $t (@tests) {
507 unless (exists $::path_to_name{$t}) {
509 $::path_to_name{$t} = $tname;
513 foreach (@::path_to_name{@tests}) {
516 $maxlen = $len if $len > $maxlen;
518 # + 3 : we want three dots between the test name and the "ok"
519 my $dotdotdot = $maxlen + 3 ;
521 my $total_files = @tests;
523 my $tested_files = 0;
527 while (my $test = shift @tests) {
528 my $test_start_time = $show_elapsed_time ? Time::HiRes::time() : 0;
533 if ($type eq 'deparse') {
534 if ($test eq "comp/redef.t") {
535 # Redefinition happens at compile time
538 elsif ($test =~ m{lib/Switch/t/}) {
539 # B::Deparse doesn't support source filtering
543 my $te = $::path_to_name{$test} . '.'
544 x ($dotdotdot - length($::path_to_name{$test}));
546 if ($^O ne 'VMS') { # defer printing on VMS due to piping bug
551 (local $Valgrind_Log = "$test.valgrind-current") =~ s/^.*\///;
552 my $results = _run_test($test, $type);
558 my $trailing_leader = 0;
562 next if /^\s*$/; # skip blank lines
563 if (/^1..$/ && ($^O eq 'VMS')) {
564 # VMS pipe bug inserts blank lines.
566 if ($l2 =~ /^\s*$/) {
575 if ($trailing_leader) {
576 # shouldn't be anything following a postfix 1..n
577 $failure = 'FAILED--extra output after trailing 1..n';
580 if (/^1\.\.([0-9]+)( todo ([\d ]+))?/) {
582 $failure = 'FAILED--seen duplicate leader';
586 %todo = map { $_ => 1 } split / /, $3 if $3;
587 $totmax = $totmax + $max;
588 $tested_files = $tested_files + 1;
590 # 1..n appears at end of file
591 $trailing_leader = 1;
593 $failure = "FAILED--expected $max tests, saw $next";
603 if (/^(not )?ok(?: (\d+))?[^\#]*(\s*\#.*)?/) {
604 unless ($seen_leader) {
611 my($not, $num, $extra, $istodo) = ($1, $2, $3, 0);
612 $num = $next unless $num;
616 # SKIP is essentially the same as TODO for t/TEST
617 # this still conforms to TAP:
618 # http://search.cpan.org/dist/TAP/TAP.pm
619 $extra and $istodo = $extra =~ /#\s*(?:TODO|SKIP)\b/;
620 $istodo = 1 if $todo{$num};
622 if( $not && !$istodo ) {
623 $failure = "FAILED at test $num";
628 $failure ="FAILED--expected test $next, saw test $num";
632 elsif (/^Bail out!\s*(.*)/i) { # magic words
633 die "FAILED--Further testing stopped" . ($1 ? ": $1\n" : ".\n");
636 # module tests are allowed extra output,
637 # because Test::Harness allows it
638 next if $test =~ /^\W*(cpan|dist|ext|lib)\b/;
639 $failure = "FAILED--unexpected output at test $next";
647 if (not defined $failure) {
648 $failure = 'FAILED--no leader found' unless $seen_leader;
651 if ($ENV{PERL_VALGRIND}) {
653 if (-e $Valgrind_Log) {
654 if (open(V, $Valgrind_Log)) {
658 warn "$0: Failed to open '$Valgrind_Log': $!\n";
661 if ($ENV{VG_OPTS} =~ /cachegrind/) {
662 if (rename $Valgrind_Log, "$test.valgrind") {
663 $valgrind = $valgrind + 1;
665 warn "$0: Failed to create '$test.valgrind': $!\n";
671 for my $i (0..$#valgrind) {
672 local $_ = $valgrind[$i];
673 if (/^==\d+== ERROR SUMMARY: (\d+) errors? /) {
674 $errors = $errors + $1; # there may be multiple error summaries
675 } elsif (/^==\d+== LEAK SUMMARY:/) {
676 for my $off (1 .. 4) {
677 if ($valgrind[$i+$off] =~
678 /(?:lost|reachable):\s+\d+ bytes in (\d+) blocks/) {
679 $leaks = $leaks + $1;
684 if ($errors or $leaks) {
685 if (rename $Valgrind_Log, "$test.valgrind") {
686 $valgrind = $valgrind + 1;
688 warn "$0: Failed to create '$test.valgrind': $!\n";
692 warn "No valgrind output?\n";
694 if (-e $Valgrind_Log) {
696 or warn "$0: Failed to unlink '$Valgrind_Log': $!\n";
699 if ($type eq 'deparse') {
702 if ($ENV{PERL_3LOG}) {
706 $tpp =~ s:\.t$:.3log:;
707 rename("perl.3log", $tpp) ||
708 die "rename: perl3.log to $tpp: $!\n";
710 if (not defined $failure and $next != $max) {
711 $failure="FAILED--expected $max tests, saw $next";
714 if( !defined $failure # don't mask a test failure
717 $failure = "FAILED--non-zero wait status: $?";
720 if (defined $failure) {
721 print "${te}$failure\n";
722 $::bad_files = $::bad_files + 1;
723 if ($test =~ /^base/) {
724 die "Failed a basic test ($test) -- cannot continue.\n";
726 $failed_tests{$test} = 1;
731 if ( $show_elapsed_time ) {
732 $elapsed = sprintf( " %8.0f ms", (Time::HiRes::time() - $test_start_time) * 1000 );
737 print "${te}ok$elapsed\n";
738 $good_files = $good_files + 1;
741 print "${te}skipped\n";
742 $tested_files = $tested_files - 1;
747 if ($::bad_files == 0) {
749 print "All tests successful.\n";
750 # XXX add mention of 'perlbug -ok' ?
753 die "FAILED--no tests were run for some reason.\n";
757 my $pct = $tested_files ? sprintf("%.2f", ($tested_files - $::bad_files) / $tested_files * 100) : "0.00";
758 my $s = $::bad_files == 1 ? "" : "s";
759 warn "Failed $::bad_files test$s out of $tested_files, $pct% okay.\n";
760 for my $test ( sort keys %failed_tests ) {
764 ### Since not all tests were successful, you may want to run some of
765 ### them individually and examine any diagnostic messages they produce.
766 ### See the INSTALL document's section on "make test".
768 warn <<'SHRDLU_2' if $good_files / $total_files > 0.8;
769 ### You have a good chance to get more information by running
771 ### in the 't' directory since most (>=80%) of the tests succeeded.
773 if (eval {require Config; import Config; 1}) {
774 if ($::Config{usedl} && (my $p = $::Config{ldlibpthname})) {
776 ### You may have to set your dynamic library search path,
777 ### $p, to point to the build directory:
779 if (exists $ENV{$p} && $ENV{$p} ne '') {
781 ### setenv $p `pwd`:\$$p; cd t; ./perl harness
782 ### $p=`pwd`:\$$p; export $p; cd t; ./perl harness
783 ### export $p=`pwd`:\$$p; cd t; ./perl harness
787 ### setenv $p `pwd`; cd t; ./perl harness
788 ### $p=`pwd`; export $p; cd t; ./perl harness
789 ### export $p=`pwd`; cd t; ./perl harness
793 ### for csh-style shells, like tcsh; or for traditional/modern
794 ### Bourne-style shells, like bash, ksh, and zsh, respectively.
799 my ($user,$sys,$cuser,$csys) = times;
800 print sprintf("u=%.2f s=%.2f cu=%.2f cs=%.2f scripts=%d tests=%d\n",
801 $user,$sys,$cuser,$csys,$tested_files,$totmax);
802 if ($ENV{PERL_VALGRIND}) {
803 my $s = $valgrind == 1 ? '' : 's';
804 print "$valgrind valgrind report$s created.\n", ;
807 exit ($::bad_files != 0);
809 # ex: set ts=8 sts=4 sw=4 noet: