This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
bb277943342ca7e00c2679d71e765ef1e5db0e5e
[perl5.git] / t / test.pl
1 #
2 # t/test.pl - most of Test::More functionality without the fuss
3
4
5 # NOTE:
6 #
7 # Increment ($x++) has a certain amount of cleverness for things like
8 #
9 #   $x = 'zz';
10 #   $x++; # $x eq 'aaa';
11 #
12 # stands more chance of breaking than just a simple
13 #
14 #   $x = $x + 1
15 #
16 # In this file, we use the latter "Baby Perl" approach, and increment
17 # will be worked over by t/op/inc.t
18
19 $Level = 1;
20 my $test = 1;
21 my $planned;
22 my $noplan;
23 my $Perl;       # Safer version of $^X set by which_perl()
24
25 $TODO = 0;
26 $NO_ENDING = 0;
27
28 # Use this instead of print to avoid interference while testing globals.
29 sub _print {
30     local($\, $", $,) = (undef, ' ', '');
31     print STDOUT @_;
32 }
33
34 sub _print_stderr {
35     local($\, $", $,) = (undef, ' ', '');
36     print STDERR @_;
37 }
38
39 sub plan {
40     my $n;
41     if (@_ == 1) {
42         $n = shift;
43         if ($n eq 'no_plan') {
44           undef $n;
45           $noplan = 1;
46         }
47     } else {
48         my %plan = @_;
49         $n = $plan{tests};
50     }
51     _print "1..$n\n" unless $noplan;
52     $planned = $n;
53 }
54
55 END {
56     my $ran = $test - 1;
57     if (!$NO_ENDING) {
58         if (defined $planned && $planned != $ran) {
59             _print_stderr
60                 "# Looks like you planned $planned tests but ran $ran.\n";
61         } elsif ($noplan) {
62             _print "1..$ran\n";
63         }
64     }
65 }
66
67 # Use this instead of "print STDERR" when outputing failure diagnostic
68 # messages
69 sub _diag {
70     return unless @_;
71     my @mess = map { /^#/ ? "$_\n" : "# $_\n" }
72                map { split /\n/ } @_;
73     $TODO ? _print(@mess) : _print_stderr(@mess);
74 }
75
76 sub diag {
77     _diag(@_);
78 }
79
80 sub skip_all {
81     if (@_) {
82         _print "1..0 # Skip @_\n";
83     } else {
84         _print "1..0\n";
85     }
86     exit(0);
87 }
88
89 sub _ok {
90     my ($pass, $where, $name, @mess) = @_;
91     # Do not try to microoptimize by factoring out the "not ".
92     # VMS will avenge.
93     my $out;
94     if ($name) {
95         # escape out '#' or it will interfere with '# skip' and such
96         $name =~ s/#/\\#/g;
97         $out = $pass ? "ok $test - $name" : "not ok $test - $name";
98     } else {
99         $out = $pass ? "ok $test" : "not ok $test";
100     }
101
102     $out = $out . " # TODO $TODO" if $TODO;
103     _print "$out\n";
104
105     unless ($pass) {
106         _diag "# Failed $where\n";
107     }
108
109     # Ensure that the message is properly escaped.
110     _diag @mess;
111
112     $test = $test + 1; # don't use ++
113
114     return $pass;
115 }
116
117 sub _where {
118     my @caller = caller($Level);
119     return "at $caller[1] line $caller[2]";
120 }
121
122 # DON'T use this for matches. Use like() instead.
123 sub ok ($@) {
124     my ($pass, $name, @mess) = @_;
125     _ok($pass, _where(), $name, @mess);
126 }
127
128 sub _q {
129     my $x = shift;
130     return 'undef' unless defined $x;
131     my $q = $x;
132     $q =~ s/\\/\\\\/g;
133     $q =~ s/'/\\'/g;
134     return "'$q'";
135 }
136
137 sub _qq {
138     my $x = shift;
139     return defined $x ? '"' . display ($x) . '"' : 'undef';
140 };
141
142 # keys are the codes \n etc map to, values are 2 char strings such as \n
143 my %backslash_escape;
144 foreach my $x (split //, 'nrtfa\\\'"') {
145     $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
146 }
147 # A way to display scalars containing control characters and Unicode.
148 # Trying to avoid setting $_, or relying on local $_ to work.
149 sub display {
150     my @result;
151     foreach my $x (@_) {
152         if (defined $x and not ref $x) {
153             my $y = '';
154             foreach my $c (unpack("U*", $x)) {
155                 if ($c > 255) {
156                     $y = $y . sprintf "\\x{%x}", $c;
157                 } elsif ($backslash_escape{$c}) {
158                     $y = $y . $backslash_escape{$c};
159                 } else {
160                     my $z = chr $c; # Maybe we can get away with a literal...
161                     if ($z =~ /[[:^print:]]/) {
162
163                         # Use octal for characters traditionally expressed as
164                         # such: the low controls
165                         if ($c <= 037) {
166                             $z = sprintf "\\%03o", $c;
167                         } else {
168                             $z = sprintf "\\x{%x}", $c;
169                         }
170                     }
171                     $y = $y . $z;
172                 }
173             }
174             $x = $y;
175         }
176         return $x unless wantarray;
177         push @result, $x;
178     }
179     return @result;
180 }
181
182 sub is ($$@) {
183     my ($got, $expected, $name, @mess) = @_;
184
185     my $pass;
186     if( !defined $got || !defined $expected ) {
187         # undef only matches undef
188         $pass = !defined $got && !defined $expected;
189     }
190     else {
191         $pass = $got eq $expected;
192     }
193
194     unless ($pass) {
195         unshift(@mess, "#      got "._qq($got)."\n",
196                        "# expected "._qq($expected)."\n");
197     }
198     _ok($pass, _where(), $name, @mess);
199 }
200
201 sub isnt ($$@) {
202     my ($got, $isnt, $name, @mess) = @_;
203
204     my $pass;
205     if( !defined $got || !defined $isnt ) {
206         # undef only matches undef
207         $pass = defined $got || defined $isnt;
208     }
209     else {
210         $pass = $got ne $isnt;
211     }
212
213     unless( $pass ) {
214         unshift(@mess, "# it should not be "._qq($got)."\n",
215                        "# but it is.\n");
216     }
217     _ok($pass, _where(), $name, @mess);
218 }
219
220 sub cmp_ok ($$$@) {
221     my($got, $type, $expected, $name, @mess) = @_;
222
223     my $pass;
224     {
225         local $^W = 0;
226         local($@,$!);   # don't interfere with $@
227                         # eval() sometimes resets $!
228         $pass = eval "\$got $type \$expected";
229     }
230     unless ($pass) {
231         # It seems Irix long doubles can have 2147483648 and 2147483648
232         # that stringify to the same thing but are acutally numerically
233         # different. Display the numbers if $type isn't a string operator,
234         # and the numbers are stringwise the same.
235         # (all string operators have alphabetic names, so tr/a-z// is true)
236         # This will also show numbers for some uneeded cases, but will
237         # definately be helpful for things such as == and <= that fail
238         if ($got eq $expected and $type !~ tr/a-z//) {
239             unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
240         }
241         unshift(@mess, "#      got "._qq($got)."\n",
242                        "# expected $type "._qq($expected)."\n");
243     }
244     _ok($pass, _where(), $name, @mess);
245 }
246
247 # Check that $got is within $range of $expected
248 # if $range is 0, then check it's exact
249 # else if $expected is 0, then $range is an absolute value
250 # otherwise $range is a fractional error.
251 # Here $range must be numeric, >= 0
252 # Non numeric ranges might be a useful future extension. (eg %)
253 sub within ($$$@) {
254     my ($got, $expected, $range, $name, @mess) = @_;
255     my $pass;
256     if (!defined $got or !defined $expected or !defined $range) {
257         # This is a fail, but doesn't need extra diagnostics
258     } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
259         # This is a fail
260         unshift @mess, "# got, expected and range must be numeric\n";
261     } elsif ($range < 0) {
262         # This is also a fail
263         unshift @mess, "# range must not be negative\n";
264     } elsif ($range == 0) {
265         # Within 0 is ==
266         $pass = $got == $expected;
267     } elsif ($expected == 0) {
268         # If expected is 0, treat range as absolute
269         $pass = ($got <= $range) && ($got >= - $range);
270     } else {
271         my $diff = $got - $expected;
272         $pass = abs ($diff / $expected) < $range;
273     }
274     unless ($pass) {
275         if ($got eq $expected) {
276             unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
277         }
278         unshift@mess, "#      got "._qq($got)."\n",
279                       "# expected "._qq($expected)." (within "._qq($range).")\n";
280     }
281     _ok($pass, _where(), $name, @mess);
282 }
283
284 # Note: this isn't quite as fancy as Test::More::like().
285
286 sub like   ($$@) { like_yn (0,@_) }; # 0 for -
287 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
288
289 sub like_yn ($$$@) {
290     my ($flip, $got, $expected, $name, @mess) = @_;
291     my $pass;
292     $pass = $got =~ /$expected/ if !$flip;
293     $pass = $got !~ /$expected/ if $flip;
294     unless ($pass) {
295         unshift(@mess, "#      got '$got'\n",
296                 $flip
297                 ? "# expected !~ /$expected/\n" : "# expected /$expected/\n");
298     }
299     local $Level = $Level + 1;
300     _ok($pass, _where(), $name, @mess);
301 }
302
303 sub pass {
304     _ok(1, '', @_);
305 }
306
307 sub fail {
308     _ok(0, _where(), @_);
309 }
310
311 sub curr_test {
312     $test = shift if @_;
313     return $test;
314 }
315
316 sub next_test {
317   my $retval = $test;
318   $test = $test + 1; # don't use ++
319   $retval;
320 }
321
322 # Note: can't pass multipart messages since we try to
323 # be compatible with Test::More::skip().
324 sub skip {
325     my $why = shift;
326     my $n    = @_ ? shift : 1;
327     for (1..$n) {
328         _print "ok $test # skip $why\n";
329         $test = $test + 1;
330     }
331     local $^W = 0;
332     last SKIP;
333 }
334
335 sub todo_skip {
336     my $why = shift;
337     my $n   = @_ ? shift : 1;
338
339     for (1..$n) {
340         _print "not ok $test # TODO & SKIP $why\n";
341         $test = $test + 1;
342     }
343     local $^W = 0;
344     last TODO;
345 }
346
347 sub eq_array {
348     my ($ra, $rb) = @_;
349     return 0 unless $#$ra == $#$rb;
350     for my $i (0..$#$ra) {
351         next     if !defined $ra->[$i] && !defined $rb->[$i];
352         return 0 if !defined $ra->[$i];
353         return 0 if !defined $rb->[$i];
354         return 0 unless $ra->[$i] eq $rb->[$i];
355     }
356     return 1;
357 }
358
359 sub eq_hash {
360   my ($orig, $suspect) = @_;
361   my $fail;
362   while (my ($key, $value) = each %$suspect) {
363     # Force a hash recompute if this perl's internals can cache the hash key.
364     $key = "" . $key;
365     if (exists $orig->{$key}) {
366       if ($orig->{$key} ne $value) {
367         _print "# key ", _qq($key), " was ", _qq($orig->{$key}),
368                      " now ", _qq($value), "\n";
369         $fail = 1;
370       }
371     } else {
372       _print "# key ", _qq($key), " is ", _qq($value),
373                    ", not in original.\n";
374       $fail = 1;
375     }
376   }
377   foreach (keys %$orig) {
378     # Force a hash recompute if this perl's internals can cache the hash key.
379     $_ = "" . $_;
380     next if (exists $suspect->{$_});
381     _print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
382     $fail = 1;
383   }
384   !$fail;
385 }
386
387 sub require_ok ($) {
388     my ($require) = @_;
389     eval <<REQUIRE_OK;
390 require $require;
391 REQUIRE_OK
392     _ok(!$@, _where(), "require $require");
393 }
394
395 sub use_ok ($) {
396     my ($use) = @_;
397     eval <<USE_OK;
398 use $use;
399 USE_OK
400     _ok(!$@, _where(), "use $use");
401 }
402
403 # runperl - Runs a separate perl interpreter.
404 # Arguments :
405 #   switches => [ command-line switches ]
406 #   nolib    => 1 # don't use -I../lib (included by default)
407 #   prog     => one-liner (avoid quotes)
408 #   progs    => [ multi-liner (avoid quotes) ]
409 #   progfile => perl script
410 #   stdin    => string to feed the stdin
411 #   stderr   => redirect stderr to stdout
412 #   args     => [ command-line arguments to the perl program ]
413 #   verbose  => print the command line
414
415 my $is_mswin    = $^O eq 'MSWin32';
416 my $is_netware  = $^O eq 'NetWare';
417 my $is_vms      = $^O eq 'VMS';
418 my $is_cygwin   = $^O eq 'cygwin';
419
420 sub _quote_args {
421     my ($runperl, $args) = @_;
422
423     foreach (@$args) {
424         # In VMS protect with doublequotes because otherwise
425         # DCL will lowercase -- unless already doublequoted.
426        $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
427        $runperl = $runperl . ' ' . $_;
428     }
429     return $runperl;
430 }
431
432 sub _create_runperl { # Create the string to qx in runperl().
433     my %args = @_;
434     my $runperl = which_perl();
435     if ($runperl =~ m/\s/) {
436         $runperl = qq{"$runperl"};
437     }
438     #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
439     if ($ENV{PERL_RUNPERL_DEBUG}) {
440         $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
441     }
442     unless ($args{nolib}) {
443         $runperl = $runperl . ' "-I../lib"'; # doublequotes because of VMS
444     }
445     if ($args{switches}) {
446         local $Level = 2;
447         die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
448             unless ref $args{switches} eq "ARRAY";
449         $runperl = _quote_args($runperl, $args{switches});
450     }
451     if (defined $args{prog}) {
452         die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
453             if defined $args{progs};
454         $args{progs} = [$args{prog}]
455     }
456     if (defined $args{progs}) {
457         die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
458             unless ref $args{progs} eq "ARRAY";
459         foreach my $prog (@{$args{progs}}) {
460             if ($is_mswin || $is_netware || $is_vms) {
461                 $runperl = $runperl . qq ( -e "$prog" );
462             }
463             else {
464                 $runperl = $runperl . qq ( -e '$prog' );
465             }
466         }
467     } elsif (defined $args{progfile}) {
468         $runperl = $runperl . qq( "$args{progfile}");
469     } else {
470         # You probaby didn't want to be sucking in from the upstream stdin
471         die "test.pl:runperl(): none of prog, progs, progfile, args, "
472             . " switches or stdin specified"
473             unless defined $args{args} or defined $args{switches}
474                 or defined $args{stdin};
475     }
476     if (defined $args{stdin}) {
477         # so we don't try to put literal newlines and crs onto the
478         # command line.
479         $args{stdin} =~ s/\n/\\n/g;
480         $args{stdin} =~ s/\r/\\r/g;
481
482         if ($is_mswin || $is_netware || $is_vms) {
483             $runperl = qq{$Perl -e "print qq(} .
484                 $args{stdin} . q{)" | } . $runperl;
485         }
486         else {
487             $runperl = qq{$Perl -e 'print qq(} .
488                 $args{stdin} . q{)' | } . $runperl;
489         }
490     }
491     if (defined $args{args}) {
492         $runperl = _quote_args($runperl, $args{args});
493     }
494     $runperl = $runperl . ' 2>&1' if $args{stderr};
495     if ($args{verbose}) {
496         my $runperldisplay = $runperl;
497         $runperldisplay =~ s/\n/\n\#/g;
498         _print_stderr "# $runperldisplay\n";
499     }
500     return $runperl;
501 }
502
503 sub runperl {
504     die "test.pl:runperl() does not take a hashref"
505         if ref $_[0] and ref $_[0] eq 'HASH';
506     my $runperl = &_create_runperl;
507     my $result;
508
509     my $tainted = ${^TAINT};
510     my %args = @_;
511     exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
512
513     if ($tainted) {
514         # We will assume that if you're running under -T, you really mean to
515         # run a fresh perl, so we'll brute force launder everything for you
516         my $sep;
517
518         if (! eval 'require Config; 1') {
519             warn "test.pl had problems loading Config: $@";
520             $sep = ':';
521         } else {
522             $sep = $Config::Config{path_sep};
523         }
524
525         my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
526         local @ENV{@keys} = ();
527         # Untaint, plus take out . and empty string:
528         local $ENV{'DCL$PATH'} = $1 if $is_vms && ($ENV{'DCL$PATH'} =~ /(.*)/s);
529         $ENV{PATH} =~ /(.*)/s;
530         local $ENV{PATH} =
531             join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and
532                 ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
533                     split quotemeta ($sep), $1;
534         $ENV{PATH} = $ENV{PATH} . "$sep/bin" if $is_cygwin;  # Must have /bin under Cygwin
535
536         $runperl =~ /(.*)/s;
537         $runperl = $1;
538
539         $result = `$runperl`;
540     } else {
541         $result = `$runperl`;
542     }
543     $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
544     return $result;
545 }
546
547 *run_perl = \&runperl; # Nice alias.
548
549 sub DIE {
550     _print_stderr "# @_\n";
551     exit 1;
552 }
553
554 # A somewhat safer version of the sometimes wrong $^X.
555 sub which_perl {
556     unless (defined $Perl) {
557         $Perl = $^X;
558
559         # VMS should have 'perl' aliased properly
560         return $Perl if $^O eq 'VMS';
561
562         my $exe;
563         if (! eval 'require Config; 1') {
564             warn "test.pl had problems loading Config: $@";
565             $exe = '';
566         } else {
567             $exe = $Config::Config{_exe};
568         }
569        $exe = '' unless defined $exe;
570
571         # This doesn't absolutize the path: beware of future chdirs().
572         # We could do File::Spec->abs2rel() but that does getcwd()s,
573         # which is a bit heavyweight to do here.
574
575         if ($Perl =~ /^perl\Q$exe\E$/i) {
576             my $perl = "perl$exe";
577             if (! eval 'require File::Spec; 1') {
578                 warn "test.pl had problems loading File::Spec: $@";
579                 $Perl = "./$perl";
580             } else {
581                 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
582             }
583         }
584
585         # Build up the name of the executable file from the name of
586         # the command.
587
588         if ($Perl !~ /\Q$exe\E$/i) {
589             $Perl = $Perl . $exe;
590         }
591
592         warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
593
594         # For subcommands to use.
595         $ENV{PERLEXE} = $Perl;
596     }
597     return $Perl;
598 }
599
600 sub unlink_all {
601     foreach my $file (@_) {
602         1 while unlink $file;
603         _print_stderr "# Couldn't unlink '$file': $!\n" if -f $file;
604     }
605 }
606
607 my %tmpfiles;
608 END { unlink_all keys %tmpfiles }
609
610 # A regexp that matches the tempfile names
611 $::tempfile_regexp = 'tmp\d+[A-Z][A-Z]?';
612
613 # Avoid ++, avoid ranges, avoid split //
614 my @letters = qw(A B C D E F G H I J K L M N O P Q R S T U V W X Y Z);
615 sub tempfile {
616     my $count = 0;
617     do {
618         my $temp = $count;
619         my $try = "tmp$$";
620         do {
621             $try = $try . $letters[$temp % 26];
622             $temp = int ($temp / 26);
623         } while $temp;
624         # Need to note all the file names we allocated, as a second request may
625         # come before the first is created.
626         if (!-e $try && !$tmpfiles{$try}) {
627             # We have a winner
628             $tmpfiles{$try} = 1;
629             return $try;
630         }
631         $count = $count + 1;
632     } while $count < 26 * 26;
633     die "Can't find temporary file name starting 'tmp$$'";
634 }
635
636 # This is the temporary file for _fresh_perl
637 my $tmpfile = tempfile();
638
639 #
640 # _fresh_perl
641 #
642 # The $resolve must be a subref that tests the first argument
643 # for success, or returns the definition of success (e.g. the
644 # expected scalar) if given no arguments.
645 #
646
647 sub _fresh_perl {
648     my($prog, $resolve, $runperl_args, $name) = @_;
649
650     # Given the choice of the mis-parsable {}
651     # (we want an anon hash, but a borked lexer might think that it's a block)
652     # or relying on taking a reference to a lexical
653     # (\ might be mis-parsed, and the reference counting on the pad may go
654     #  awry)
655     # it feels like the least-worse thing is to assume that auto-vivification
656     # works. At least, this is only going to be a run-time failure, so won't
657     # affect tests using this file but not this function.
658     $runperl_args->{progfile} = $tmpfile;
659     $runperl_args->{stderr} = 1;
660
661     open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
662
663     # VMS adjustments
664     if( $^O eq 'VMS' ) {
665         $prog =~ s#/dev/null#NL:#;
666
667         # VMS file locking
668         $prog =~ s{if \(-e _ and -f _ and -r _\)}
669                   {if (-e _ and -f _)}
670     }
671
672     print TEST $prog;
673     close TEST or die "Cannot close $tmpfile: $!";
674
675     my $results = runperl(%$runperl_args);
676     my $status = $?;
677
678     # Clean up the results into something a bit more predictable.
679     $results  =~ s/\n+$//;
680     $results =~ s/at\s+$::tempfile_regexp\s+line/at - line/g;
681     $results =~ s/of\s+$::tempfile_regexp\s+aborted/of - aborted/g;
682
683     # bison says 'parse error' instead of 'syntax error',
684     # various yaccs may or may not capitalize 'syntax'.
685     $results =~ s/^(syntax|parse) error/syntax error/mig;
686
687     if ($^O eq 'VMS') {
688         # some tests will trigger VMS messages that won't be expected
689         $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
690
691         # pipes double these sometimes
692         $results =~ s/\n\n/\n/g;
693     }
694
695     my $pass = $resolve->($results);
696     unless ($pass) {
697         _diag "# PROG: \n$prog\n";
698         _diag "# EXPECTED:\n", $resolve->(), "\n";
699         _diag "# GOT:\n$results\n";
700         _diag "# STATUS: $status\n";
701     }
702
703     # Use the first line of the program as a name if none was given
704     unless( $name ) {
705         ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
706         $name = $name . '...' if length $first_line > length $name;
707     }
708
709     _ok($pass, _where(), "fresh_perl - $name");
710 }
711
712 #
713 # fresh_perl_is
714 #
715 # Combination of run_perl() and is().
716 #
717
718 sub fresh_perl_is {
719     my($prog, $expected, $runperl_args, $name) = @_;
720
721     # _fresh_perl() is going to clip the trailing newlines off the result.
722     # This will make it so the test author doesn't have to know that.
723     $expected =~ s/\n+$//;
724
725     local $Level = 2;
726     _fresh_perl($prog,
727                 sub { @_ ? $_[0] eq $expected : $expected },
728                 $runperl_args, $name);
729 }
730
731 #
732 # fresh_perl_like
733 #
734 # Combination of run_perl() and like().
735 #
736
737 sub fresh_perl_like {
738     my($prog, $expected, $runperl_args, $name) = @_;
739     local $Level = 2;
740     _fresh_perl($prog,
741                 sub { @_ ?
742                           $_[0] =~ (ref $expected ? $expected : /$expected/) :
743                           $expected },
744                 $runperl_args, $name);
745 }
746
747 sub can_ok ($@) {
748     my($proto, @methods) = @_;
749     my $class = ref $proto || $proto;
750
751     unless( @methods ) {
752         return _ok( 0, _where(), "$class->can(...)" );
753     }
754
755     my @nok = ();
756     foreach my $method (@methods) {
757         local($!, $@);  # don't interfere with caller's $@
758                         # eval sometimes resets $!
759         eval { $proto->can($method) } || push @nok, $method;
760     }
761
762     my $name;
763     $name = @methods == 1 ? "$class->can('$methods[0]')"
764                           : "$class->can(...)";
765
766     _ok( !@nok, _where(), $name );
767 }
768
769 sub isa_ok ($$;$) {
770     my($object, $class, $obj_name) = @_;
771
772     my $diag;
773     $obj_name = 'The object' unless defined $obj_name;
774     my $name = "$obj_name isa $class";
775     if( !defined $object ) {
776         $diag = "$obj_name isn't defined";
777     }
778     elsif( !ref $object ) {
779         $diag = "$obj_name isn't a reference";
780     }
781     else {
782         # We can't use UNIVERSAL::isa because we want to honor isa() overrides
783         local($@, $!);  # eval sometimes resets $!
784         my $rslt = eval { $object->isa($class) };
785         if( $@ ) {
786             if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) {
787                 if( !UNIVERSAL::isa($object, $class) ) {
788                     my $ref = ref $object;
789                     $diag = "$obj_name isn't a '$class' it's a '$ref'";
790                 }
791             } else {
792                 die <<WHOA;
793 WHOA! I tried to call ->isa on your object and got some weird error.
794 This should never happen.  Please contact the author immediately.
795 Here's the error.
796 $@
797 WHOA
798             }
799         }
800         elsif( !$rslt ) {
801             my $ref = ref $object;
802             $diag = "$obj_name isn't a '$class' it's a '$ref'";
803         }
804     }
805
806     _ok( !$diag, _where(), $name );
807 }
808
809 # Set a watchdog to timeout the entire test file
810 # NOTE:  If the test file uses 'threads', then call the watchdog() function
811 #        _AFTER_ the 'threads' module is loaded.
812 sub watchdog ($)
813 {
814     my $timeout = shift;
815     my $timeout_msg = 'Test process timed out - terminating';
816
817     my $pid_to_kill = $$;   # PID for this process
818
819     # Don't use a watchdog process if 'threads' is loaded -
820     #   use a watchdog thread instead
821     if (! $threads::threads) {
822
823         # On Windows and VMS, try launching a watchdog process
824         #   using system(1, ...) (see perlport.pod)
825         if (($^O eq 'MSWin32') || ($^O eq 'VMS')) {
826             # On Windows, try to get the 'real' PID
827             if ($^O eq 'MSWin32') {
828                 eval { require Win32; };
829                 if (defined(&Win32::GetCurrentProcessId)) {
830                     $pid_to_kill = Win32::GetCurrentProcessId();
831                 }
832             }
833
834             # If we still have a fake PID, we can't use this method at all
835             return if ($pid_to_kill <= 0);
836
837             # Launch watchdog process
838             my $watchdog;
839             eval {
840                 local $SIG{'__WARN__'} = sub {
841                     _diag("Watchdog warning: $_[0]");
842                 };
843                 my $sig = $^O eq 'VMS' ? 'TERM' : 'KILL';
844                 my $cmd = _create_runperl( prog =>  "sleep($timeout);" .
845                                                     "warn qq/# $timeout_msg" . '\n/;' .
846                                                     "kill($sig, $pid_to_kill);");
847                 $watchdog = system(1, $cmd);
848             };
849             if ($@ || ($watchdog <= 0)) {
850                 _diag('Failed to start watchdog');
851                 _diag($@) if $@;
852                 undef($watchdog);
853                 return;
854             }
855
856             # Add END block to parent to terminate and
857             #   clean up watchdog process
858             eval "END { local \$! = 0; local \$? = 0;
859                         wait() if kill('KILL', $watchdog); };";
860             return;
861         }
862
863         # Try using fork() to generate a watchdog process
864         my $watchdog;
865         eval { $watchdog = fork() };
866         if (defined($watchdog)) {
867             if ($watchdog) {   # Parent process
868                 # Add END block to parent to terminate and
869                 #   clean up watchdog process
870                 eval "END { local \$! = 0; local \$? = 0;
871                             wait() if kill('KILL', $watchdog); };";
872                 return;
873             }
874
875             ### Watchdog process code
876
877             # Load POSIX if available
878             eval { require POSIX; };
879
880             # Execute the timeout
881             sleep($timeout - 2) if ($timeout > 2);   # Workaround for perlbug #49073
882             sleep(2);
883
884             # Kill test process if still running
885             if (kill(0, $pid_to_kill)) {
886                 _diag($timeout_msg);
887                 kill('KILL', $pid_to_kill);
888             }
889
890             # Don't execute END block (added at beginning of this file)
891             $NO_ENDING = 1;
892
893             # Terminate ourself (i.e., the watchdog)
894             POSIX::_exit(1) if (defined(&POSIX::_exit));
895             exit(1);
896         }
897
898         # fork() failed - fall through and try using a thread
899     }
900
901     # Use a watchdog thread because either 'threads' is loaded,
902     #   or fork() failed
903     if (eval 'require threads; 1') {
904         threads->create(sub {
905                 # Load POSIX if available
906                 eval { require POSIX; };
907
908                 # Execute the timeout
909                 my $time_left = $timeout;
910                 do {
911                     $time_left = $time_left - sleep($time_left);
912                 } while ($time_left > 0);
913
914                 # Kill the parent (and ourself)
915                 select(STDERR); $| = 1;
916                 _diag($timeout_msg);
917                 POSIX::_exit(1) if (defined(&POSIX::_exit));
918                 my $sig = $^O eq 'VMS' ? 'TERM' : 'KILL';
919                 kill($sig, $pid_to_kill);
920             })->detach();
921         return;
922     }
923
924     # If everything above fails, then just use an alarm timeout
925     if (eval { alarm($timeout); 1; }) {
926         # Load POSIX if available
927         eval { require POSIX; };
928
929         # Alarm handler will do the actual 'killing'
930         $SIG{'ALRM'} = sub {
931             select(STDERR); $| = 1;
932             _diag($timeout_msg);
933             POSIX::_exit(1) if (defined(&POSIX::_exit));
934             my $sig = $^O eq 'VMS' ? 'TERM' : 'KILL';
935             kill($sig, $pid_to_kill);
936         };
937     }
938 }
939
940 1;