2 # t/test.pl - most of Test::More functionality without the fuss
7 # Increment ($x++) has a certain amount of cleverness for things like
10 # $x++; # $x eq 'aaa';
12 # stands more chance of breaking than just a simple
16 # In this file, we use the latter "Baby Perl" approach, and increment
17 # will be worked over by t/op/inc.t
23 my $Perl; # Safer version of $^X set by which_perl()
28 # Use this instead of print to avoid interference while testing globals.
30 local($\, $", $,) = (undef, ' ', '');
35 local($\, $", $,) = (undef, ' ', '');
43 if ($n eq 'no_plan') {
51 _print "1..$n\n" unless $noplan;
58 if (defined $planned && $planned != $ran) {
60 "# Looks like you planned $planned tests but ran $ran.\n";
67 # Use this instead of "print STDERR" when outputing failure diagnostic
71 my @mess = map { /^#/ ? "$_\n" : "# $_\n" }
72 map { split /\n/ } @_;
73 $TODO ? _print(@mess) : _print_stderr(@mess);
82 _print "1..0 # Skip @_\n";
90 my ($pass, $where, $name, @mess) = @_;
91 # Do not try to microoptimize by factoring out the "not ".
95 # escape out '#' or it will interfere with '# skip' and such
97 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
99 $out = $pass ? "ok $test" : "not ok $test";
102 $out = $out . " # TODO $TODO" if $TODO;
106 _diag "# Failed $where\n";
109 # Ensure that the message is properly escaped.
112 $test = $test + 1; # don't use ++
118 my @caller = caller($Level);
119 return "at $caller[1] line $caller[2]";
122 # DON'T use this for matches. Use like() instead.
124 my ($pass, $name, @mess) = @_;
125 _ok($pass, _where(), $name, @mess);
130 return 'undef' unless defined $x;
139 return defined $x ? '"' . display ($x) . '"' : 'undef';
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";
147 # A way to display scalars containing control characters and Unicode.
148 # Trying to avoid setting $_, or relying on local $_ to work.
152 if (defined $x and not ref $x) {
154 foreach my $c (unpack("U*", $x)) {
156 $y = $y . sprintf "\\x{%x}", $c;
157 } elsif ($backslash_escape{$c}) {
158 $y = $y . $backslash_escape{$c};
160 my $z = chr $c; # Maybe we can get away with a literal...
161 $z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/;
167 return $x unless wantarray;
174 my ($got, $expected, $name, @mess) = @_;
177 if( !defined $got || !defined $expected ) {
178 # undef only matches undef
179 $pass = !defined $got && !defined $expected;
182 $pass = $got eq $expected;
186 unshift(@mess, "# got "._qq($got)."\n",
187 "# expected "._qq($expected)."\n");
189 _ok($pass, _where(), $name, @mess);
193 my ($got, $isnt, $name, @mess) = @_;
196 if( !defined $got || !defined $isnt ) {
197 # undef only matches undef
198 $pass = defined $got || defined $isnt;
201 $pass = $got ne $isnt;
205 unshift(@mess, "# it should not be "._qq($got)."\n",
208 _ok($pass, _where(), $name, @mess);
212 my($got, $type, $expected, $name, @mess) = @_;
217 local($@,$!); # don't interfere with $@
218 # eval() sometimes resets $!
219 $pass = eval "\$got $type \$expected";
222 # It seems Irix long doubles can have 2147483648 and 2147483648
223 # that stringify to the same thing but are acutally numerically
224 # different. Display the numbers if $type isn't a string operator,
225 # and the numbers are stringwise the same.
226 # (all string operators have alphabetic names, so tr/a-z// is true)
227 # This will also show numbers for some uneeded cases, but will
228 # definately be helpful for things such as == and <= that fail
229 if ($got eq $expected and $type !~ tr/a-z//) {
230 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
232 unshift(@mess, "# got "._qq($got)."\n",
233 "# expected $type "._qq($expected)."\n");
235 _ok($pass, _where(), $name, @mess);
238 # Check that $got is within $range of $expected
239 # if $range is 0, then check it's exact
240 # else if $expected is 0, then $range is an absolute value
241 # otherwise $range is a fractional error.
242 # Here $range must be numeric, >= 0
243 # Non numeric ranges might be a useful future extension. (eg %)
245 my ($got, $expected, $range, $name, @mess) = @_;
247 if (!defined $got or !defined $expected or !defined $range) {
248 # This is a fail, but doesn't need extra diagnostics
249 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
251 unshift @mess, "# got, expected and range must be numeric\n";
252 } elsif ($range < 0) {
253 # This is also a fail
254 unshift @mess, "# range must not be negative\n";
255 } elsif ($range == 0) {
257 $pass = $got == $expected;
258 } elsif ($expected == 0) {
259 # If expected is 0, treat range as absolute
260 $pass = ($got <= $range) && ($got >= - $range);
262 my $diff = $got - $expected;
263 $pass = abs ($diff / $expected) < $range;
266 if ($got eq $expected) {
267 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
269 unshift@mess, "# got "._qq($got)."\n",
270 "# expected "._qq($expected)." (within "._qq($range).")\n";
272 _ok($pass, _where(), $name, @mess);
275 # Note: this isn't quite as fancy as Test::More::like().
277 sub like ($$@) { like_yn (0,@_) }; # 0 for -
278 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
281 my ($flip, $got, $expected, $name, @mess) = @_;
283 $pass = $got =~ /$expected/ if !$flip;
284 $pass = $got !~ /$expected/ if $flip;
286 unshift(@mess, "# got '$got'\n",
288 ? "# expected !~ /$expected/\n" : "# expected /$expected/\n");
290 local $Level = $Level + 1;
291 _ok($pass, _where(), $name, @mess);
299 _ok(0, _where(), @_);
309 $test = $test + 1; # don't use ++
313 # Note: can't pass multipart messages since we try to
314 # be compatible with Test::More::skip().
317 my $n = @_ ? shift : 1;
319 _print "ok $test # skip $why\n";
328 my $n = @_ ? shift : 1;
331 _print "not ok $test # TODO & SKIP $why\n";
340 return 0 unless $#$ra == $#$rb;
341 for my $i (0..$#$ra) {
342 next if !defined $ra->[$i] && !defined $rb->[$i];
343 return 0 if !defined $ra->[$i];
344 return 0 if !defined $rb->[$i];
345 return 0 unless $ra->[$i] eq $rb->[$i];
351 my ($orig, $suspect) = @_;
353 while (my ($key, $value) = each %$suspect) {
354 # Force a hash recompute if this perl's internals can cache the hash key.
356 if (exists $orig->{$key}) {
357 if ($orig->{$key} ne $value) {
358 _print "# key ", _qq($key), " was ", _qq($orig->{$key}),
359 " now ", _qq($value), "\n";
363 _print "# key ", _qq($key), " is ", _qq($value),
364 ", not in original.\n";
368 foreach (keys %$orig) {
369 # Force a hash recompute if this perl's internals can cache the hash key.
371 next if (exists $suspect->{$_});
372 _print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
383 _ok(!$@, _where(), "require $require");
391 _ok(!$@, _where(), "use $use");
394 # runperl - Runs a separate perl interpreter.
396 # switches => [ command-line switches ]
397 # nolib => 1 # don't use -I../lib (included by default)
398 # prog => one-liner (avoid quotes)
399 # progs => [ multi-liner (avoid quotes) ]
400 # progfile => perl script
401 # stdin => string to feed the stdin
402 # stderr => redirect stderr to stdout
403 # args => [ command-line arguments to the perl program ]
404 # verbose => print the command line
406 my $is_mswin = $^O eq 'MSWin32';
407 my $is_netware = $^O eq 'NetWare';
408 my $is_vms = $^O eq 'VMS';
409 my $is_cygwin = $^O eq 'cygwin';
412 my ($runperl, $args) = @_;
415 # In VMS protect with doublequotes because otherwise
416 # DCL will lowercase -- unless already doublequoted.
417 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
418 $$runperl = $$runperl . ' ' . $_;
422 sub _create_runperl { # Create the string to qx in runperl().
424 my $runperl = which_perl();
425 if ($runperl =~ m/\s/) {
426 $runperl = qq{"$runperl"};
428 #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
429 if ($ENV{PERL_RUNPERL_DEBUG}) {
430 $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
432 unless ($args{nolib}) {
433 $runperl = $runperl . ' "-I../lib"'; # doublequotes because of VMS
435 if ($args{switches}) {
437 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
438 unless ref $args{switches} eq "ARRAY";
439 _quote_args(\$runperl, $args{switches});
441 if (defined $args{prog}) {
442 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
443 if defined $args{progs};
444 $args{progs} = [$args{prog}]
446 if (defined $args{progs}) {
447 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
448 unless ref $args{progs} eq "ARRAY";
449 foreach my $prog (@{$args{progs}}) {
450 if ($is_mswin || $is_netware || $is_vms) {
451 $runperl = $runperl . qq ( -e "$prog" );
454 $runperl = $runperl . qq ( -e '$prog' );
457 } elsif (defined $args{progfile}) {
458 $runperl = $runperl . qq( "$args{progfile}");
460 # You probaby didn't want to be sucking in from the upstream stdin
461 die "test.pl:runperl(): none of prog, progs, progfile, args, "
462 . " switches or stdin specified"
463 unless defined $args{args} or defined $args{switches}
464 or defined $args{stdin};
466 if (defined $args{stdin}) {
467 # so we don't try to put literal newlines and crs onto the
469 $args{stdin} =~ s/\n/\\n/g;
470 $args{stdin} =~ s/\r/\\r/g;
472 if ($is_mswin || $is_netware || $is_vms) {
473 $runperl = qq{$Perl -e "print qq(} .
474 $args{stdin} . q{)" | } . $runperl;
477 $runperl = qq{$Perl -e 'print qq(} .
478 $args{stdin} . q{)' | } . $runperl;
481 if (defined $args{args}) {
482 _quote_args(\$runperl, $args{args});
484 $runperl = $runperl . ' 2>&1' if $args{stderr};
485 if ($args{verbose}) {
486 my $runperldisplay = $runperl;
487 $runperldisplay =~ s/\n/\n\#/g;
488 _print_stderr "# $runperldisplay\n";
494 die "test.pl:runperl() does not take a hashref"
495 if ref $_[0] and ref $_[0] eq 'HASH';
496 my $runperl = &_create_runperl;
499 my $tainted = ${^TAINT};
501 exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
504 # We will assume that if you're running under -T, you really mean to
505 # run a fresh perl, so we'll brute force launder everything for you
508 if (! eval 'require Config; 1') {
509 warn "test.pl had problems loading Config: $@";
512 $sep = $Config::Config{path_sep};
515 my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
516 local @ENV{@keys} = ();
517 # Untaint, plus take out . and empty string:
518 local $ENV{'DCL$PATH'} = $1 if $is_vms && ($ENV{'DCL$PATH'} =~ /(.*)/s);
519 $ENV{PATH} =~ /(.*)/s;
521 join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and
522 ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
523 split quotemeta ($sep), $1;
524 $ENV{PATH} = $ENV{PATH} . "$sep/bin" if $is_cygwin; # Must have /bin under Cygwin
529 $result = `$runperl`;
531 $result = `$runperl`;
533 $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
537 *run_perl = \&runperl; # Nice alias.
540 _print_stderr "# @_\n";
544 # A somewhat safer version of the sometimes wrong $^X.
546 unless (defined $Perl) {
549 # VMS should have 'perl' aliased properly
550 return $Perl if $^O eq 'VMS';
553 if (! eval 'require Config; 1') {
554 warn "test.pl had problems loading Config: $@";
557 $exe = $Config::Config{_exe};
559 $exe = '' unless defined $exe;
561 # This doesn't absolutize the path: beware of future chdirs().
562 # We could do File::Spec->abs2rel() but that does getcwd()s,
563 # which is a bit heavyweight to do here.
565 if ($Perl =~ /^perl\Q$exe\E$/i) {
566 my $perl = "perl$exe";
567 if (! eval 'require File::Spec; 1') {
568 warn "test.pl had problems loading File::Spec: $@";
571 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
575 # Build up the name of the executable file from the name of
578 if ($Perl !~ /\Q$exe\E$/i) {
579 $Perl = $Perl . $exe;
582 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
584 # For subcommands to use.
585 $ENV{PERLEXE} = $Perl;
591 foreach my $file (@_) {
592 1 while unlink $file;
593 _print_stderr "# Couldn't unlink '$file': $!\n" if -f $file;
598 END { unlink_all keys %tmpfiles }
600 # A regexp that matches the tempfile names
601 $::tempfile_regexp = 'tmp\d+[A-Z][A-Z]?';
603 # Avoid ++, avoid ranges, avoid split //
604 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);
611 $try = $try . $letters[$temp % 26];
612 $temp = int ($temp / 26);
614 # Need to note all the file names we allocated, as a second request may
615 # come before the first is created.
616 if (!-e $try && !$tmpfiles{$try}) {
622 } while $count < 26 * 26;
623 die "Can't find temporary file name starting 'tmp$$'";
626 # This is the temporary file for _fresh_perl
627 my $tmpfile = tempfile();
632 # The $resolve must be a subref that tests the first argument
633 # for success, or returns the definition of success (e.g. the
634 # expected scalar) if given no arguments.
638 my($prog, $resolve, $runperl_args, $name) = @_;
640 # Given the choice of the mis-parsable {}
641 # (we want an anon hash, but a borked lexer might think that it's a block)
642 # or relying on taking a reference to a lexical
643 # (\ might be mis-parsed, and the reference counting on the pad may go
645 # it feels like the least-worse thing is to assume that auto-vivification
646 # works. At least, this is only going to be a run-time failure, so won't
647 # affect tests using this file but not this function.
648 $runperl_args->{progfile} = $tmpfile;
649 $runperl_args->{stderr} = 1;
651 open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
655 $prog =~ s#/dev/null#NL:#;
658 $prog =~ s{if \(-e _ and -f _ and -r _\)}
663 close TEST or die "Cannot close $tmpfile: $!";
665 my $results = runperl(%$runperl_args);
668 # Clean up the results into something a bit more predictable.
669 $results =~ s/\n+$//;
670 $results =~ s/at\s+$::tempfile_regexp\s+line/at - line/g;
671 $results =~ s/of\s+$::tempfile_regexp\s+aborted/of - aborted/g;
673 # bison says 'parse error' instead of 'syntax error',
674 # various yaccs may or may not capitalize 'syntax'.
675 $results =~ s/^(syntax|parse) error/syntax error/mig;
678 # some tests will trigger VMS messages that won't be expected
679 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
681 # pipes double these sometimes
682 $results =~ s/\n\n/\n/g;
685 my $pass = $resolve->($results);
687 _diag "# PROG: \n$prog\n";
688 _diag "# EXPECTED:\n", $resolve->(), "\n";
689 _diag "# GOT:\n$results\n";
690 _diag "# STATUS: $status\n";
693 # Use the first line of the program as a name if none was given
695 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
696 $name = $name . '...' if length $first_line > length $name;
699 _ok($pass, _where(), "fresh_perl - $name");
705 # Combination of run_perl() and is().
709 my($prog, $expected, $runperl_args, $name) = @_;
711 # _fresh_perl() is going to clip the trailing newlines off the result.
712 # This will make it so the test author doesn't have to know that.
713 $expected =~ s/\n+$//;
717 sub { @_ ? $_[0] eq $expected : $expected },
718 $runperl_args, $name);
724 # Combination of run_perl() and like().
727 sub fresh_perl_like {
728 my($prog, $expected, $runperl_args, $name) = @_;
732 $_[0] =~ (ref $expected ? $expected : /$expected/) :
734 $runperl_args, $name);
738 my($proto, @methods) = @_;
739 my $class = ref $proto || $proto;
742 return _ok( 0, _where(), "$class->can(...)" );
746 foreach my $method (@methods) {
747 local($!, $@); # don't interfere with caller's $@
748 # eval sometimes resets $!
749 eval { $proto->can($method) } || push @nok, $method;
753 $name = @methods == 1 ? "$class->can('$methods[0]')"
754 : "$class->can(...)";
756 _ok( !@nok, _where(), $name );
760 my($object, $class, $obj_name) = @_;
763 $obj_name = 'The object' unless defined $obj_name;
764 my $name = "$obj_name isa $class";
765 if( !defined $object ) {
766 $diag = "$obj_name isn't defined";
768 elsif( !ref $object ) {
769 $diag = "$obj_name isn't a reference";
772 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
773 local($@, $!); # eval sometimes resets $!
774 my $rslt = eval { $object->isa($class) };
776 if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) {
777 if( !UNIVERSAL::isa($object, $class) ) {
778 my $ref = ref $object;
779 $diag = "$obj_name isn't a '$class' it's a '$ref'";
783 WHOA! I tried to call ->isa on your object and got some weird error.
784 This should never happen. Please contact the author immediately.
791 my $ref = ref $object;
792 $diag = "$obj_name isn't a '$class' it's a '$ref'";
796 _ok( !$diag, _where(), $name );
799 # Set a watchdog to timeout the entire test file
800 # NOTE: If the test file uses 'threads', then call the watchdog() function
801 # _AFTER_ the 'threads' module is loaded.
805 my $timeout_msg = 'Test process timed out - terminating';
807 my $pid_to_kill = $$; # PID for this process
809 # Don't use a watchdog process if 'threads' is loaded -
810 # use a watchdog thread instead
811 if (! $threads::threads) {
813 # On Windows and VMS, try launching a watchdog process
814 # using system(1, ...) (see perlport.pod)
815 if (($^O eq 'MSWin32') || ($^O eq 'VMS')) {
816 # On Windows, try to get the 'real' PID
817 if ($^O eq 'MSWin32') {
818 eval { require Win32; };
819 if (defined(&Win32::GetCurrentProcessId)) {
820 $pid_to_kill = Win32::GetCurrentProcessId();
824 # If we still have a fake PID, we can't use this method at all
825 return if ($pid_to_kill <= 0);
827 # Launch watchdog process
830 local $SIG{'__WARN__'} = sub {
831 _diag("Watchdog warning: $_[0]");
833 my $sig = $^O eq 'VMS' ? 'TERM' : 'KILL';
834 $watchdog = system(1, which_perl(), '-e',
836 "warn('# $timeout_msg\n');" .
837 "kill($sig, $pid_to_kill);");
839 if ($@ || ($watchdog <= 0)) {
840 _diag('Failed to start watchdog');
846 # Add END block to parent to terminate and
847 # clean up watchdog process
848 eval "END { local \$! = 0; local \$? = 0;
849 wait() if kill('KILL', $watchdog); };";
853 # Try using fork() to generate a watchdog process
855 eval { $watchdog = fork() };
856 if (defined($watchdog)) {
857 if ($watchdog) { # Parent process
858 # Add END block to parent to terminate and
859 # clean up watchdog process
860 eval "END { local \$! = 0; local \$? = 0;
861 wait() if kill('KILL', $watchdog); };";
865 ### Watchdog process code
867 # Load POSIX if available
868 eval { require POSIX; };
870 # Execute the timeout
871 sleep($timeout - 2) if ($timeout > 2); # Workaround for perlbug #49073
874 # Kill test process if still running
875 if (kill(0, $pid_to_kill)) {
877 kill('KILL', $pid_to_kill);
880 # Don't execute END block (added at beginning of this file)
883 # Terminate ourself (i.e., the watchdog)
884 POSIX::_exit(1) if (defined(&POSIX::_exit));
888 # fork() failed - fall through and try using a thread
891 # Use a watchdog thread because either 'threads' is loaded,
893 if (eval 'require threads; 1') {
894 threads->create(sub {
895 # Load POSIX if available
896 eval { require POSIX; };
898 # Execute the timeout
899 my $time_left = $timeout;
901 $time_left = $time_left - sleep($time_left);
902 } while ($time_left > 0);
904 # Kill the parent (and ourself)
905 select(STDERR); $| = 1;
907 POSIX::_exit(1) if (defined(&POSIX::_exit));
908 my $sig = $^O eq 'VMS' ? 'TERM' : 'KILL';
909 kill($sig, $pid_to_kill);
914 # If everything above fails, then just use an alarm timeout
915 if (eval { alarm($timeout); 1; }) {
916 # Load POSIX if available
917 eval { require POSIX; };
919 # Alarm handler will do the actual 'killing'
921 select(STDERR); $| = 1;
923 POSIX::_exit(1) if (defined(&POSIX::_exit));
924 my $sig = $^O eq 'VMS' ? 'TERM' : 'KILL';
925 kill($sig, $pid_to_kill);