This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add valgrind testing target.
[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.
5
6 $| = 1;
7
8 # Let tests know they're running in the perl core.  Useful for modules
9 # which live dual lives on CPAN.
10 $ENV{PERL_CORE} = 1;
11
12 # remove empty elements due to insertion of empty symbols via "''p1'" syntax
13 @ARGV = grep($_,@ARGV) if $^O eq 'VMS';
14
15 # Cheesy version of Getopt::Std.  Maybe we should replace it with that.
16 @argv = ();
17 if ($#ARGV >= 0) {
18     foreach my $idx (0..$#ARGV) {
19         push( @argv, $ARGV[$idx] ), next unless $ARGV[$idx] =~ /^-(\S+)$/;
20         $core    = 1 if $1 eq 'core';
21         $verbose = 1 if $1 eq 'v';
22         $torture = 1 if $1 eq 'torture';
23         $with_utf= 1 if $1 eq 'utf8';
24         $bytecompile = 1 if $1 eq 'bytecompile';
25         $compile = 1 if $1 eq 'compile';
26         if ($1 =~ /^deparse(,.+)?$/) {
27             $deparse = 1;
28             $deparse_opts = $1;
29         }
30     }
31 }
32 @ARGV = @argv;
33
34 chdir 't' if -f 't/TEST';
35
36 die "You need to run \"make test\" first to set things up.\n"
37   unless -e 'perl' or -e 'perl.exe' or -e 'perl.pm';
38
39 if ($ENV{PERL_3LOG}) { # Tru64 third(1) tool, see perlhack
40     unless (-x 'perl.third') {
41         unless (-x '../perl.third') {
42             die "You need to run \"make perl.third first.\n";
43         }
44         else {
45             print "Symlinking ../perl.third as perl.third...\n";
46             die "Failed to symlink: $!\n"
47                 unless symlink("../perl.third", "perl.third");
48             die "Symlinked but no executable perl.third: $!\n"
49                 unless -x 'perl.third';
50         }
51     }
52 }
53
54 # check leakage for embedders
55 $ENV{PERL_DESTRUCT_LEVEL} = 2 unless exists $ENV{PERL_DESTRUCT_LEVEL};
56
57 $ENV{EMXSHELL} = 'sh';        # For OS/2
58
59 # Roll your own File::Find!
60 use TestInit;
61 use File::Spec;
62 my $curdir = File::Spec->curdir;
63 my $updir  = File::Spec->updir;
64
65 sub _find_tests {
66     my($dir) = @_;
67     opendir DIR, $dir || die "Trouble opening $dir: $!";
68     foreach my $f (sort { $a cmp $b } readdir DIR) {
69         next if $f eq $curdir or $f eq $updir;
70
71         my $fullpath = File::Spec->catfile($dir, $f);
72
73         _find_tests($fullpath) if -d $fullpath;
74         $fullpath = VMS::Filespec::unixify($fullpath) if $^O eq 'VMS';
75         push @ARGV, $fullpath if $f =~ /\.t$/;
76     }
77 }
78
79 sub _quote_args {
80     my ($args) = @_;
81     my $argstring = '';
82
83     foreach (split(/\s+/,$args)) {
84        # In VMS protect with doublequotes because otherwise
85        # DCL will lowercase -- unless already doublequoted.
86        $_ = q(").$_.q(") if ($^O eq 'VMS') && !/^\"/ && length($_) > 0;
87        $argstring .= ' ' . $_;
88     }
89     return $argstring;
90 }
91
92 unless (@ARGV) {
93     foreach my $dir (qw(base comp cmd run io op uni)) {
94         _find_tests($dir);
95     }
96     _find_tests("lib") unless $core;
97     my $mani = File::Spec->catfile($updir, "MANIFEST");
98     if (open(MANI, $mani)) {
99         while (<MANI>) { # similar code in t/harness
100             if (m!^(ext/\S+/?(?:[^/\s]+\.t|test\.pl)|lib/\S+?(?:\.t|test\.pl))\s!) {
101                 $t = $1;
102                 if (!$core || $t =~ m!^lib/[a-z]!)
103                 {
104                     $path = File::Spec->catfile($updir, $t);
105                     push @ARGV, $path;
106                     $name{$path} = $t;
107                 }
108             }
109         }
110         close MANI;
111     } else {
112         warn "$0: cannot open $mani: $!\n";
113     }
114     unless ($core) {
115         _find_tests('pod');  
116         _find_tests('x2p');
117         _find_tests('japh') if $torture;
118     }
119 }
120
121 # Tests known to cause infinite loops for the perlcc tests.
122 # %infinite = ( 'comp/require.t', 1, 'op/bop.t', 1, 'lib/hostname.t', 1 );
123 %infinite = ();
124
125 if ($deparse) {
126     _testprogs('deparse', '',   @ARGV);
127 }
128 elsif( $compile ) { 
129     _testprogs('compile', '',   @ARGV);
130 }
131 elsif( $bytecompile ) {
132     _testprogs('bytecompile', '', @ARGV);
133 }
134 else {
135     _testprogs('compile', '',   @ARGV) if -e "../testcompile";
136     _testprogs('perl',    '',   @ARGV);
137 }
138
139 sub _testprogs {
140     $type = shift @_;
141     $args = shift;
142     @tests = @_;
143
144     print <<'EOT' if ($type eq 'compile');
145 ------------------------------------------------------------------------------
146 TESTING COMPILER
147 ------------------------------------------------------------------------------
148 EOT
149
150     print <<'EOT' if ($type eq 'deparse');
151 ------------------------------------------------------------------------------
152 TESTING DEPARSER
153 ------------------------------------------------------------------------------
154 EOT
155
156     print <<EOT if ($type eq 'bytecompile');
157 ------------------------------------------------------------------------------
158 TESTING BYTECODE COMPILER
159 ------------------------------------------------------------------------------
160 EOT
161
162     $ENV{PERLCC_TIMEOUT} = 120
163           if ($type eq 'compile' && !$ENV{PERLCC_TIMEOUT});
164
165     $bad = 0;
166     $good = 0;
167     $total = @tests;
168     $files  = 0;
169     $totmax = 0;
170
171     foreach my $t (@tests) {
172       unless (exists $name{$t}) {
173         my $tname = File::Spec->catfile('t',$t);
174         $tname = VMS::Filespec::unixify($tname) if $^O eq 'VMS';
175         $name{$t} = $tname;
176       }
177     }
178     my $maxlen = 0;
179     foreach (@name{@tests}) {
180         s/\.\w+\z/./;
181         my $len = length ;
182         $maxlen = $len if $len > $maxlen;
183     }
184     # + 3 : we want three dots between the test name and the "ok"
185     $dotdotdot = $maxlen + 3 ;
186     my $valgrind = 0;
187     while ($test = shift @tests) {
188
189         if ( $infinite{$test} && $type eq 'compile' ) {
190             print STDERR "$test creates infinite loop! Skipping.\n";
191             next;
192         }
193         if ($test =~ /^$/) {
194             next;
195         }
196         if ($type eq 'deparse') {
197             if ($test eq "comp/redef.t") {
198                 # Redefinition happens at compile time
199                 next;
200             }
201             elsif ($test =~ m{lib/Switch/t/}) {
202                 # B::Deparse doesn't support source filtering
203                 next;
204             }
205         }
206         $te = $name{$test} . '.' x ($dotdotdot - length($name{$test}));
207
208         if ($^O ne 'VMS') {  # defer printing on VMS due to piping bug
209             print $te;
210             $te = '';
211         }
212
213         $test = $OVER{$test} if exists $OVER{$test};
214
215         open(SCRIPT,"<$test") or die "Can't run $test.\n";
216         $_ = <SCRIPT>;
217         close(SCRIPT) unless ($type eq 'deparse');
218         if (/#!.*\bperl.*\s-\w*([tT])/) {
219             $switch = qq{"-$1"};
220         }
221         else {
222             $switch = '';
223         }
224
225         my $test_executable; # for 'compile' tests
226         my $file_opts = "";
227         if ($type eq 'deparse') {
228             # Look for #line directives which change the filename
229             while (<SCRIPT>) {
230                 $file_opts .= ",-f$3$4"
231                         if /^#\s*line\s+(\d+)\s+((\w+)|"([^"]+)")/;
232             }
233             close(SCRIPT);
234         }
235
236         my $utf = $with_utf ? '-I../lib -Mutf8' : '';
237         my $testswitch = '-I. -MTestInit'; # -T will strict . from @INC
238         if ($type eq 'deparse') {
239             my $deparse =
240                 "./perl $testswitch $switch -I../lib -MO=-qq,Deparse,-sv1.,".
241                 "-l$deparse_opts$file_opts ".
242                 "$test > $test.dp ".
243                 "&& ./perl $testswitch $switch -I../lib $test.dp |";
244             open(RESULTS, $deparse)
245                 or print "can't deparse '$deparse': $!.\n";
246         }
247         elsif ($type eq 'bytecompile') {
248             my $perl = $ENV{PERL} || './perl';
249             my $redir = ($^O eq 'VMS' ? '2>&1' : '');
250             my $bswitch = "-MO=Bytecode,-H,-TI,-s`pwd`/$test,";
251             $bswitch .= "-TF$test.plc,"
252                 if $test =~ m(chdir|pod/|CGI/t/carp|lib/DB);
253             $bswitch .= "-k,"
254                 if $test =~ m(deparse|terse|ext/Storable/t/code);
255             $bswitch .= "-b,"
256                 if $test =~ m(op/getpid);
257             my $bytecompile =
258                 "$perl $testswitch $switch -I../lib $bswitch". 
259                 "-o$test.plc $test 2>/dev/null &&".
260                 "$perl $testswitch $switch -I../lib $utf $test.plc $redir|";
261             open(RESULTS,$bytecompile)
262                 or print "can't byte-compile '$bytecompile': $!.\n";
263         }
264         elsif ($type eq 'perl') {
265             my $perl = $ENV{PERL} || './perl';
266             my $redir = ($^O eq 'VMS' || $ENV{PERL_VALGRIND} ? '2>&1' : '');
267             if ($ENV{PERL_VALGRIND}) {
268                 $perl = "valgrind --num-callers=50 --leak-check=yes $perl";
269             }
270             my $run = "$perl" . _quote_args("$testswitch $switch $utf") . " $test $redir|";
271             open(RESULTS,$run) or print "can't run '$run': $!.\n";
272         }
273         else {
274             my $compile;
275             my $pl2c = "$testswitch -I../lib ../utils/perlcc --testsuite " .
276               # -O9 for good measure, -fcog is broken ATM
277                        "$switch -Wb=-O9,-fno-cog -L .. " .
278                        "-I \".. ../lib/CORE\" $args $utf $test -o ";
279
280             if( $^O eq 'MSWin32' ) {
281                 $test_executable = "$test.exe";
282                 # hopefully unused name...
283                 open HACK, "> xweghyz.pl";
284                 print HACK <<EOT;
285 #!./perl
286
287 open HACK, '.\\perl $pl2c $test_executable |';
288 # cl.exe prints the name of the .c file on stdout (\%^\$^#)
289 while(<HACK>) {m/^\\w+\\.[cC]\$/ && next;print}
290 open HACK, '$test_executable |';
291 while(<HACK>) {print}
292 EOT
293                 close HACK;
294                 $compile = 'xweghyz.pl |';
295             }
296             else {
297                 $test_executable = "$test.plc";
298                 $compile = "./perl $pl2c $test_executable && $test_executable |";
299             }
300             unlink $test_executable if -f $test_executable;
301             open(RESULTS, $compile)
302                 or print "can't compile '$compile': $!.\n";
303         }
304
305         $ok = 0;
306         $next = 0;
307         my $seen_leader = 0;
308         my $seen_ok = 0;
309         my @valgrind;
310         while (<RESULTS>) {
311             next if /^\s*$/; # skip blank lines
312             if ($verbose) {
313                 print $_;
314             }
315             if ($ENV{PERL_VALGRIND} && /^==\d+== /) {
316                 push @valgrind, $_;
317                 next;
318             }
319             unless (/^\#/) {
320                 if (/^1\.\.([0-9]+)( todo ([\d ]+))?/) {
321                     $max = $1;
322                     %todo = map { $_ => 1 } split / /, $3 if $3;
323                     $totmax += $max;
324                     $files += 1;
325                     unless ($seen_ok) {
326                       $next = 1;
327                       $ok = 1;
328                     }
329                     $seen_leader = 1;
330                 }
331                 else {
332                     if (/^(not )?ok (\d+)[^\#]*(\s*\#.*)?/) {
333                         unless ($seen_leader) {
334                             unless ($seen_ok) {
335                                 $next = 1;
336                                 $ok = 1;
337                             }
338                         }
339                         $seen_ok = 1;
340                         if ($2 == $next) {
341                             my($not, $num, $extra) = ($1, $2, $3);
342                             my($istodo) = $extra =~ /^\s*#\s*TODO/ if $extra;
343                             $istodo = 1 if $todo{$num};
344
345                             if( $not && !$istodo ) {
346                                 $ok = 0;
347                                 $next = $num;
348                                 last;
349                             }
350                             else {
351                                 $next = $next + 1;
352                             }
353                         }
354                     }
355                     elsif (/^Bail out!\s*(.*)/i) { # magic words
356                         die "FAILED--Further testing stopped" . ($1 ? ": $1\n" : ".\n");
357                     }
358                     else {
359                         $ok = 0;
360                     }
361                 }
362             }
363         }
364         close RESULTS;
365         if ($ENV{PERL_VALGRIND}) {
366             if (@valgrind) {
367                 my $skip_pthread_mutex_unlock;
368                 for my $i (0..$#valgrind) {
369                     local $_ = $valgrind[$i];
370                     my $pid;
371                     if (/^==(\d+)== pthread_mutex_unlock: mutex is not locked/ &&
372                         ($pid = $1) &&
373                         $valgrind[$i+2] =~ m{\(in .+/libc.+\.so\)}) {
374                         $skip_pthread_mutex_unlock++;
375                     } elsif (/^==\d+== ERROR SUMMARY: (\d+) errors? /) {
376                         $errors = $1;
377                     }
378                 }
379                 if (defined $errors) {
380                     $errors -= $skip_pthread_mutex_unlock;
381                     if ($errors) {
382                         if (open(V, ">$test.valgrind")) {
383                             for (@valgrind) {
384                                 print V $_;
385                             }
386                             close V;
387                             $valgrind++;
388                         } else {
389                             warn "$0: Failed to create '$test.valgrind': $!\n";
390                         }
391                     }
392                 }
393             } else {
394                 warn "No valgrind output?\n";
395             }
396         }
397         if ($type eq 'deparse') {
398             unlink "./$test.dp";
399         }
400         if ($ENV{PERL_3LOG}) {
401             my $tpp = $test;
402             $tpp =~ s:^\.\./::;
403             $tpp =~ s:/:_:g;
404             $tpp =~ s:\.t$:.3log:;
405             rename("perl.3log", $tpp) ||
406                 die "rename: perl3.log to $tpp: $!\n";
407         }
408         $next = $next - 1;
409         # test if the compiler compiled something
410         if( $type eq 'compile' && !-e "$test_executable" ) {
411             $ok = 0;
412             print "Test did not compile\n";
413         }
414         if ($ok && $next == $max ) {
415             if ($max) {
416                 print "${te}ok\n";
417                 $good = $good + 1;
418             }
419             else {
420                 print "${te}skipping test on this platform\n";
421                 $files -= 1;
422             }
423         }
424         else {
425             $next += 1;
426             print "${te}FAILED at test $next\n";
427             $bad = $bad + 1;
428             $_ = $test;
429             if (/^base/) {
430                 die "Failed a basic test--cannot continue.\n";
431             }
432         }
433     }
434
435     if ($bad == 0) {
436         if ($ok) {
437             print "All tests successful.\n";
438             # XXX add mention of 'perlbug -ok' ?
439         }
440         else {
441             die "FAILED--no tests were run for some reason.\n";
442         }
443     }
444     else {
445         $pct = $files ? sprintf("%.2f", ($files - $bad) / $files * 100) : "0.00";
446         if ($bad == 1) {
447             warn "Failed 1 test script out of $files, $pct% okay.\n";
448         }
449         else {
450             warn "Failed $bad test scripts out of $files, $pct% okay.\n";
451         }
452         warn <<'SHRDLU_1';
453 ### Since not all tests were successful, you may want to run some of
454 ### them individually and examine any diagnostic messages they produce.
455 ### See the INSTALL document's section on "make test".
456 SHRDLU_1
457         warn <<'SHRDLU_2' if $good / $total > 0.8;
458 ### You have a good chance to get more information by running
459 ###   ./perl harness
460 ### in the 't' directory since most (>=80%) of the tests succeeded.
461 SHRDLU_2
462         if (eval {require Config; import Config; 1}) {
463             if ($Config{usedl} && (my $p = $Config{ldlibpthname})) {
464                 warn <<SHRDLU_3;
465 ### You may have to set your dynamic library search path,
466 ### $p, to point to the build directory:
467 SHRDLU_3
468                 if (exists $ENV{$p} && $ENV{$p} ne '') {
469                     warn <<SHRDLU_4a;
470 ###   setenv $p `pwd`:\$$p; cd t; ./perl harness
471 ###   $p=`pwd`:\$$p; export $p; cd t; ./perl harness
472 ###   export $p=`pwd`:\$$p; cd t; ./perl harness
473 SHRDLU_4a
474                 } else {
475                     warn <<SHRDLU_4b;
476 ###   setenv $p `pwd`; cd t; ./perl harness
477 ###   $p=`pwd`; export $p; cd t; ./perl harness
478 ###   export $p=`pwd`; cd t; ./perl harness
479 SHRDLU_4b
480                 }    
481                 warn <<SHRDLU_5;
482 ### for csh-style shells, like tcsh; or for traditional/modern
483 ### Bourne-style shells, like bash, ksh, and zsh, respectively.
484 SHRDLU_5
485             }
486         }
487     }
488     ($user,$sys,$cuser,$csys) = times;
489     print sprintf("u=%g  s=%g  cu=%g  cs=%g  scripts=%d  tests=%d\n",
490         $user,$sys,$cuser,$csys,$files,$totmax);
491     if ($ENV{PERL_VALGRIND}) {
492         my $s = $valgrind == 1 ? '' : 's';
493         print "$valgrind valgrind report$s created.\n", ;
494     }
495 }
496 exit ($bad != 0);