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 $ENV{PERL_CORE_MINITEST} = 1 unless defined &DynaLoader::boot_DynaLoader;
137 chdir 't' if -f 't/TEST';
138 if (-f 'TEST' && -f 'harness' && -d '../lib') {
142 die "You need to run \"make test\" first to set things up.\n"
143 unless -e 'perl' or -e 'perl.exe' or -e 'perl.pm';
145 if ($ENV{PERL_3LOG}) { # Tru64 third(1) tool, see perlhack
146 unless (-x 'perl.third') {
147 unless (-x '../perl.third') {
148 die "You need to run \"make perl.third first.\n";
151 print "Symlinking ../perl.third as perl.third...\n";
152 die "Failed to symlink: $!\n"
153 unless symlink("../perl.third", "perl.third");
154 die "Symlinked but no executable perl.third: $!\n"
155 unless -x 'perl.third';
160 # check leakage for embedders
161 $ENV{PERL_DESTRUCT_LEVEL} = 2 unless exists $ENV{PERL_DESTRUCT_LEVEL};
163 $ENV{EMXSHELL} = 'sh'; # For OS/2
165 if ($show_elapsed_time) { require Time::HiRes }
176 # Roll your own File::Find!
179 opendir DIR, $dir or die "Trouble opening $dir: $!";
180 foreach my $f (sort { $a cmp $b } readdir DIR) {
183 my $fullpath = "$dir/$f";
186 _find_tests($fullpath);
187 } elsif ($f =~ /\.t$/) {
188 push @ARGV, $fullpath;
194 # Scan the text of the test program to find switches and special options
195 # we might need to apply.
197 my($test, $type) = @_;
199 open(my $script, "<", $test) or die "Can't read $test.\n";
200 my $first_line = <$script>;
202 $first_line =~ tr/\0//d if $::with_utf16;
205 if ($first_line =~ /#!.*\bperl.*\s-\w*([tT])/) {
209 # not all tests are expected to pass with this option
217 if ($type eq 'deparse') {
218 # Look for #line directives which change the filename
220 $file_opts = $file_opts . ",-f$3$4"
221 if /^#\s*line\s+(\d+)\s+((\w+)|"([^"]+)")/;
232 $test =~ /^(.+)\/[^\/]+/;
234 my $testswitch = $dir_to_switch{$dir};
235 if (!defined $testswitch) {
236 if ($test =~ s!^(\.\./(cpan|dist|ext)/[^/]+)/t!t!) {
238 $return_dir = '../../t';
240 $perl = '../../t/perl';
241 $testswitch = "-I../.. -MTestInit=U2T";
242 if ($2 eq 'cpan' || $2 eq 'dist') {
244 $testswitch = $testswitch . ',A';
246 if ($temp_no_core{$run_dir}) {
247 $testswitch = $testswitch . ',NC';
250 } elsif ($test =~ m!^\.\./lib!) {
251 $testswitch = '-I.. -MTestInit=U1'; # -T will remove . from @INC
253 $testswitch = '-I.. -MTestInit'; # -T will remove . from @INC
257 my $utf8 = ($::with_utf8 || $::with_utf16) ? "-I$lib -Mutf8" : '';
264 return_dir => $return_dir,
265 testswitch => $testswitch,
275 my($options, $type) = @_;
277 my $test = $options->{test};
280 if ($type eq 'deparse') {
281 my $perl = "$options->{perl} $options->{testswitch}";
282 my $lib = $options->{lib};
285 "$perl $options->{switch} -I$lib -MO=-qq,Deparse,-sv1.,".
286 "-l$::deparse_opts$options->{file} ".
288 "&& $perl $options->{switch} -I$lib $test.dp"
291 elsif ($type eq 'perl') {
292 my $perl = $options->{perl};
293 my $redir = $^O eq 'VMS' ? '2>&1' : '';
295 if ($ENV{PERL_VALGRIND}) {
296 my $perl_supp = $options->{return_dir} ? "$options->{return_dir}/perl.supp" : "perl.supp";
297 my $valgrind = $ENV{VALGRIND} // 'valgrind';
298 my $vg_opts = $ENV{VG_OPTS}
299 // "--suppressions=$perl_supp --leak-check=yes "
300 . "--leak-resolution=high --show-reachable=yes "
301 . "--num-callers=50 --track-origins=yes";
302 $perl = "$valgrind --log-fd=3 $vg_opts $perl";
303 $redir = "3>$Valgrind_Log";
304 if ($options->{run_dir}) {
305 $Valgrind_Log = "$options->{run_dir}/$Valgrind_Log";
309 my $args = "$options->{testswitch} $options->{switch} $options->{utf8}";
310 $cmd = $perl . _quote_args($args) . " $test $redir";
319 if ($options->{run_dir}) {
320 my $run_dir = $options->{run_dir};
321 chdir $run_dir or die "Can't chdir to '$run_dir': $!";
330 if ($options->{return_dir}) {
331 my $return_dir = $options->{return_dir};
333 or die "Can't chdir from '$options->{run_dir}' to '$return_dir': $!";
340 my ($test, $type) = @_;
342 my $options = _scan_test($test, $type);
343 # $test might have changed if we're in ext/Foo, so don't use it anymore
344 # from now on. Use $options->{test} instead.
346 _before_fork($options);
348 my $cmd = _cmd($options, $type);
350 open(my $results, "$cmd |") or print "can't run '$cmd': $!.\n";
352 _after_fork($options);
354 # Our environment may force us to use UTF-8, but we can't be sure that
355 # anything we're reading from will be generating (well formed) UTF-8
356 # This may not be the best way - possibly we should unset ${^OPEN} up
367 foreach (split(/\s+/,$args)) {
368 # In VMS protect with doublequotes because otherwise
369 # DCL will lowercase -- unless already doublequoted.
370 $_ = q(").$_.q(") if ($^O eq 'VMS') && !/^\"/ && length($_) > 0;
371 $argstring = $argstring . ' ' . $_;
377 return unless defined $_[0];
378 return map {$_, 1} split /\s+/, $_[0];
381 sub _tests_from_manifest {
382 my ($extensions, $known_extensions) = @_;
384 my %extensions = _populate_hash($extensions);
385 my %known_extensions = _populate_hash($known_extensions);
387 foreach (keys %known_extensions) {
388 $skip{$_} = 1 unless $extensions{$_};
392 my $mani = '../MANIFEST';
393 if (open(MANI, $mani)) {
395 if (m!^((?:cpan|dist|ext)/(\S+)/+(?:[^/\s]+\.t|test\.pl)|lib/\S+?(?:\.t|test\.pl))\s!) {
398 if (!$::core || $t =~ m!^lib/[a-z]!) {
399 if (defined $extension) {
400 $extension =~ s!/t(:?/\S+)*$!!;
401 # XXX Do I want to warn that I'm skipping these?
402 next if $skip{$extension};
403 my $flat_extension = $extension;
404 $flat_extension =~ s!-!/!g;
405 next if $skip{$flat_extension}; # Foo/Bar may live in Foo-Bar
408 push @results, $path;
409 $::path_to_name{$path} = $t;
415 warn "$0: cannot open $mani: $!\n";
421 # base first, as TEST bails out if that can't run
422 # then comp, to validate that require works
423 # then run, to validate that -M works
424 # then we know we can -MTestInit for everything else, making life simpler
425 foreach my $dir (qw(base comp run cmd io re op uni mro)) {
428 _find_tests("lib") unless $::core;
429 # Config.pm may be broken for make minitest. And this is only a refinement
430 # for skipping tests on non-default builds, so it is allowed to fail.
431 # What we want to to is make a list of extensions which we did not build.
432 my $configsh = '../config.sh';
433 my ($extensions, $known_extensions);
435 open FH, $configsh or die "Can't open $configsh: $!";
437 if (/^extensions=['"](.*)['"]$/) {
440 elsif (/^known_extensions=['"](.*)['"]$/) {
441 $known_extensions = $1;
444 if (!defined $known_extensions) {
445 warn "No known_extensions line found in $configsh";
447 if (!defined $extensions) {
448 warn "No extensions line found in $configsh";
451 # The "complex" constructions of list return from a subroutine, and push of
452 # a list, might fail if perl is really hosed, but they aren't needed for
453 # make minitest, and the building of extensions will likely also fail if
454 # something is that badly wrong.
455 push @ARGV, _tests_from_manifest($extensions, $known_extensions);
458 _find_tests('porting');
459 _find_tests('japh') if $::torture;
460 _find_tests('t/benchmark') if $::benchmark or $ENV{PERL_BENCHMARK};
465 _testprogs('deparse', '', @ARGV);
467 elsif ($::with_utf16) {
470 print STDERR "# ENDIAN $e BOM $b\n";
473 my $u = $a . "." . ($e ? "l" : "b") . "e" . ($b ? "b" : "");
474 my $f = $e ? "v" : "n";
478 if (open(U, ">$u")) {
479 print U pack("$f", 0xFEFF) if $b;
481 print U pack("$f*", unpack("C*", $_));
488 _testprogs('perl', '', @UARGV);
494 _testprogs('perl', '', @ARGV);
498 my ($type, $args, @tests) = @_;
500 print <<'EOT' if ($type eq 'deparse');
501 ------------------------------------------------------------------------------
503 ------------------------------------------------------------------------------
508 foreach my $t (@tests) {
509 unless (exists $::path_to_name{$t}) {
511 $::path_to_name{$t} = $tname;
515 foreach (@::path_to_name{@tests}) {
518 $maxlen = $len if $len > $maxlen;
520 # + 3 : we want three dots between the test name and the "ok"
521 my $dotdotdot = $maxlen + 3 ;
523 my $total_files = @tests;
525 my $tested_files = 0;
529 while (my $test = shift @tests) {
530 my $test_start_time = $show_elapsed_time ? Time::HiRes::time() : 0;
535 if ($type eq 'deparse') {
536 if ($test eq "comp/redef.t") {
537 # Redefinition happens at compile time
540 elsif ($test =~ m{lib/Switch/t/}) {
541 # B::Deparse doesn't support source filtering
545 my $te = $::path_to_name{$test} . '.'
546 x ($dotdotdot - length($::path_to_name{$test}));
548 if ($^O ne 'VMS') { # defer printing on VMS due to piping bug
553 (local $Valgrind_Log = "$test.valgrind-current") =~ s/^.*\///;
554 my $results = _run_test($test, $type);
560 my $trailing_leader = 0;
564 next if /^\s*$/; # skip blank lines
565 if (/^1..$/ && ($^O eq 'VMS')) {
566 # VMS pipe bug inserts blank lines.
568 if ($l2 =~ /^\s*$/) {
577 if ($trailing_leader) {
578 # shouldn't be anything following a postfix 1..n
579 $failure = 'FAILED--extra output after trailing 1..n';
582 if (/^1\.\.([0-9]+)( todo ([\d ]+))?/) {
584 $failure = 'FAILED--seen duplicate leader';
588 %todo = map { $_ => 1 } split / /, $3 if $3;
589 $totmax = $totmax + $max;
590 $tested_files = $tested_files + 1;
592 # 1..n appears at end of file
593 $trailing_leader = 1;
595 $failure = "FAILED--expected $max tests, saw $next";
605 if (/^(not )?ok(?: (\d+))?[^\#]*(\s*\#.*)?/) {
606 unless ($seen_leader) {
613 my($not, $num, $extra, $istodo) = ($1, $2, $3, 0);
614 $num = $next unless $num;
618 # SKIP is essentially the same as TODO for t/TEST
619 # this still conforms to TAP:
620 # http://search.cpan.org/dist/TAP/TAP.pm
621 $extra and $istodo = $extra =~ /#\s*(?:TODO|SKIP)\b/;
622 $istodo = 1 if $todo{$num};
624 if( $not && !$istodo ) {
625 $failure = "FAILED at test $num";
630 $failure ="FAILED--expected test $next, saw test $num";
634 elsif (/^Bail out!\s*(.*)/i) { # magic words
635 die "FAILED--Further testing stopped" . ($1 ? ": $1\n" : ".\n");
638 # module tests are allowed extra output,
639 # because Test::Harness allows it
640 next if $test =~ /^\W*(cpan|dist|ext|lib)\b/;
641 $failure = "FAILED--unexpected output at test $next";
649 if (not defined $failure) {
650 $failure = 'FAILED--no leader found' unless $seen_leader;
653 if ($ENV{PERL_VALGRIND}) {
655 if (-e $Valgrind_Log) {
656 if (open(V, $Valgrind_Log)) {
660 warn "$0: Failed to open '$Valgrind_Log': $!\n";
663 if ($ENV{VG_OPTS} =~ /cachegrind/) {
664 if (rename $Valgrind_Log, "$test.valgrind") {
665 $valgrind = $valgrind + 1;
667 warn "$0: Failed to create '$test.valgrind': $!\n";
673 for my $i (0..$#valgrind) {
674 local $_ = $valgrind[$i];
675 if (/^==\d+== ERROR SUMMARY: (\d+) errors? /) {
676 $errors = $errors + $1; # there may be multiple error summaries
677 } elsif (/^==\d+== LEAK SUMMARY:/) {
678 for my $off (1 .. 4) {
679 if ($valgrind[$i+$off] =~
680 /(?:lost|reachable):\s+\d+ bytes in (\d+) blocks/) {
681 $leaks = $leaks + $1;
686 if ($errors or $leaks) {
687 if (rename $Valgrind_Log, "$test.valgrind") {
688 $valgrind = $valgrind + 1;
690 warn "$0: Failed to create '$test.valgrind': $!\n";
694 warn "No valgrind output?\n";
696 if (-e $Valgrind_Log) {
698 or warn "$0: Failed to unlink '$Valgrind_Log': $!\n";
701 if ($type eq 'deparse') {
704 if ($ENV{PERL_3LOG}) {
708 $tpp =~ s:\.t$:.3log:;
709 rename("perl.3log", $tpp) ||
710 die "rename: perl3.log to $tpp: $!\n";
712 if (not defined $failure and $next != $max) {
713 $failure="FAILED--expected $max tests, saw $next";
716 if( !defined $failure # don't mask a test failure
719 $failure = "FAILED--non-zero wait status: $?";
722 if (defined $failure) {
723 print "${te}$failure\n";
724 $::bad_files = $::bad_files + 1;
725 if ($test =~ /^base/) {
726 die "Failed a basic test ($test) -- cannot continue.\n";
728 $failed_tests{$test} = 1;
733 if ( $show_elapsed_time ) {
734 $elapsed = sprintf( " %8.0f ms", (Time::HiRes::time() - $test_start_time) * 1000 );
739 print "${te}ok$elapsed\n";
740 $good_files = $good_files + 1;
743 print "${te}skipped\n";
744 $tested_files = $tested_files - 1;
749 if ($::bad_files == 0) {
751 print "All tests successful.\n";
752 # XXX add mention of 'perlbug -ok' ?
755 die "FAILED--no tests were run for some reason.\n";
759 my $pct = $tested_files ? sprintf("%.2f", ($tested_files - $::bad_files) / $tested_files * 100) : "0.00";
760 my $s = $::bad_files == 1 ? "" : "s";
761 warn "Failed $::bad_files test$s out of $tested_files, $pct% okay.\n";
762 for my $test ( sort keys %failed_tests ) {
766 ### Since not all tests were successful, you may want to run some of
767 ### them individually and examine any diagnostic messages they produce.
768 ### See the INSTALL document's section on "make test".
770 warn <<'SHRDLU_2' if $good_files / $total_files > 0.8;
771 ### You have a good chance to get more information by running
773 ### in the 't' directory since most (>=80%) of the tests succeeded.
775 if (eval {require Config; import Config; 1}) {
776 if ($::Config{usedl} && (my $p = $::Config{ldlibpthname})) {
778 ### You may have to set your dynamic library search path,
779 ### $p, to point to the build directory:
781 if (exists $ENV{$p} && $ENV{$p} ne '') {
783 ### setenv $p `pwd`:\$$p; cd t; ./perl harness
784 ### $p=`pwd`:\$$p; export $p; cd t; ./perl harness
785 ### export $p=`pwd`:\$$p; cd t; ./perl harness
789 ### setenv $p `pwd`; cd t; ./perl harness
790 ### $p=`pwd`; export $p; cd t; ./perl harness
791 ### export $p=`pwd`; cd t; ./perl harness
795 ### for csh-style shells, like tcsh; or for traditional/modern
796 ### Bourne-style shells, like bash, ksh, and zsh, respectively.
801 my ($user,$sys,$cuser,$csys) = times;
802 print sprintf("u=%.2f s=%.2f cu=%.2f cs=%.2f scripts=%d tests=%d\n",
803 $user,$sys,$cuser,$csys,$tested_files,$totmax);
804 if ($ENV{PERL_VALGRIND}) {
805 my $s = $valgrind == 1 ? '' : 's';
806 print "$valgrind valgrind report$s created.\n", ;
809 exit ($::bad_files != 0);
811 # ex: set ts=8 sts=4 sw=4 noet: