2 # t/test.pl - most of Test::More functionality without the fuss, plus
3 # has mappings native_to_latin1 and latin1_to_native so that fewer tests
4 # on non ASCII-ish platforms need to be skipped
9 # Increment ($x++) has a certain amount of cleverness for things like
12 # $x++; # $x eq 'aaa';
14 # stands more chance of breaking than just a simple
18 # In this file, we use the latter "Baby Perl" approach, and increment
19 # will be worked over by t/op/inc.t
25 my $Perl; # Safer version of $^X set by which_perl()
27 # This defines ASCII/UTF-8 vs EBCDIC/UTF-EBCDIC
28 $::IS_ASCII = ord 'A' == 65;
29 $::IS_EBCDIC = ord 'A' == 193;
33 $Tests_Are_Passing = 1;
35 # Use this instead of print to avoid interference while testing globals.
37 local($\, $", $,) = (undef, ' ', '');
42 local($\, $", $,) = (undef, ' ', '');
50 if ($n eq 'no_plan') {
58 _print "1..$n\n" unless $noplan;
63 # Set the plan at the end. See Test::More::done_testing.
76 if (defined $planned && $planned != $ran) {
78 "# Looks like you planned $planned tests but ran $ran.\n";
87 my @mess = _comment(@_);
88 $TODO ? _print(@mess) : _print_stderr(@mess);
91 # Use this instead of "print STDERR" when outputting failure diagnostic
97 # Use this instead of "print" when outputting informational messages
100 _print( _comment(@_) );
104 return !defined &DynaLoader::boot_DynaLoader;
108 return map { /^#/ ? "$_\n" : "# $_\n" }
109 map { split /\n/ } @_;
114 _print "1..0 # Skip @_\n";
121 sub skip_all_if_miniperl {
122 skip_all(@_) if is_miniperl();
125 sub skip_all_without_dynamic_extension {
126 my $extension = shift;
127 skip_all("no dynamic loading on miniperl, no $extension") if is_miniperl();
128 unless (eval {require Config; 1}) {
129 warn "test.pl had problems loading Config: $@";
132 $extension =~ s!::!/!g;
133 return if ($Config::Config{extensions} =~ /\b$extension\b/);
134 skip_all("$extension was not built");
137 sub skip_all_without_perlio {
138 skip_all('no PerlIO') unless PerlIO::Layer->find('perlio');
141 sub skip_all_without_config {
142 unless (eval {require Config; 1}) {
143 warn "test.pl had problems loading Config: $@";
147 next if $Config::Config{$_};
148 my $key = $_; # Need to copy, before trying to modify.
155 sub find_git_or_skip {
156 my ($found_dir, $reason);
159 } elsif (-l 'MANIFEST' && -l 'AUTHORS') {
160 my $where = readlink 'MANIFEST';
161 die "Can't readling MANIFEST: $!" unless defined $where;
162 die "Confusing symlink target for MANIFEST, '$where'"
163 unless $where =~ s!/MANIFEST\z!!;
164 if (-d "$where/.git") {
165 # Looks like we are in a symlink tree
166 chdir $where or die "Can't chdir '$where': $!";
167 note("Found source tree at $where");
172 my $version_string = `git --version`;
173 if (defined $version_string
174 && $version_string =~ /\Agit version (\d+\.\d+\.\d+)(.*)/) {
175 return if eval "v$1 ge v1.5.0";
176 # If you have earlier than 1.5.0 and it works, change this test
177 $reason = "in git checkout, but git version '$1$2' too old";
179 $reason = "in git checkout, but cannot run git";
182 $reason = 'not being run from a git checkout';
184 skip_all($reason) if $_[0] && $_[0] eq 'all';
189 my ($pass, $where, $name, @mess) = @_;
190 # Do not try to microoptimize by factoring out the "not ".
194 # escape out '#' or it will interfere with '# skip' and such
196 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
198 $out = $pass ? "ok $test" : "not ok $test";
202 $out = $out . " # TODO $TODO";
204 $Tests_Are_Passing = 0 unless $pass;
210 note @mess; # Ensure that the message is properly escaped.
213 _diag "# Failed $where\n";
217 $test = $test + 1; # don't use ++
223 my @caller = caller($Level);
224 return "at $caller[1] line $caller[2]";
227 # DON'T use this for matches. Use like() instead.
229 my ($pass, $name, @mess) = @_;
230 _ok($pass, _where(), $name, @mess);
235 return 'undef' unless defined $x;
244 return defined $x ? '"' . display ($x) . '"' : 'undef';
247 # keys are the codes \n etc map to, values are 2 char strings such as \n
248 my %backslash_escape;
249 foreach my $x (split //, 'nrtfa\\\'"') {
250 $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
252 # A way to display scalars containing control characters and Unicode.
253 # Trying to avoid setting $_, or relying on local $_ to work.
257 if (defined $x and not ref $x) {
259 foreach my $c (unpack("U*", $x)) {
261 $y = $y . sprintf "\\x{%x}", $c;
262 } elsif ($backslash_escape{$c}) {
263 $y = $y . $backslash_escape{$c};
265 my $z = chr $c; # Maybe we can get away with a literal...
266 if ($z =~ /[[:^print:]]/) {
268 # Use octal for characters traditionally expressed as
269 # such: the low controls
271 $z = sprintf "\\%03o", $c;
273 $z = sprintf "\\x{%x}", $c;
281 return $x unless wantarray;
288 my ($got, $expected, $name, @mess) = @_;
291 if( !defined $got || !defined $expected ) {
292 # undef only matches undef
293 $pass = !defined $got && !defined $expected;
296 $pass = $got eq $expected;
300 unshift(@mess, "# got "._qq($got)."\n",
301 "# expected "._qq($expected)."\n");
303 _ok($pass, _where(), $name, @mess);
307 my ($got, $isnt, $name, @mess) = @_;
310 if( !defined $got || !defined $isnt ) {
311 # undef only matches undef
312 $pass = defined $got || defined $isnt;
315 $pass = $got ne $isnt;
319 unshift(@mess, "# it should not be "._qq($got)."\n",
322 _ok($pass, _where(), $name, @mess);
326 my($got, $type, $expected, $name, @mess) = @_;
331 local($@,$!); # don't interfere with $@
332 # eval() sometimes resets $!
333 $pass = eval "\$got $type \$expected";
336 # It seems Irix long doubles can have 2147483648 and 2147483648
337 # that stringify to the same thing but are actually numerically
338 # different. Display the numbers if $type isn't a string operator,
339 # and the numbers are stringwise the same.
340 # (all string operators have alphabetic names, so tr/a-z// is true)
341 # This will also show numbers for some unneeded cases, but will
342 # definitely be helpful for things such as == and <= that fail
343 if ($got eq $expected and $type !~ tr/a-z//) {
344 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
346 unshift(@mess, "# got "._qq($got)."\n",
347 "# expected $type "._qq($expected)."\n");
349 _ok($pass, _where(), $name, @mess);
352 # Check that $got is within $range of $expected
353 # if $range is 0, then check it's exact
354 # else if $expected is 0, then $range is an absolute value
355 # otherwise $range is a fractional error.
356 # Here $range must be numeric, >= 0
357 # Non numeric ranges might be a useful future extension. (eg %)
359 my ($got, $expected, $range, $name, @mess) = @_;
361 if (!defined $got or !defined $expected or !defined $range) {
362 # This is a fail, but doesn't need extra diagnostics
363 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
365 unshift @mess, "# got, expected and range must be numeric\n";
366 } elsif ($range < 0) {
367 # This is also a fail
368 unshift @mess, "# range must not be negative\n";
369 } elsif ($range == 0) {
371 $pass = $got == $expected;
372 } elsif ($expected == 0) {
373 # If expected is 0, treat range as absolute
374 $pass = ($got <= $range) && ($got >= - $range);
376 my $diff = $got - $expected;
377 $pass = abs ($diff / $expected) < $range;
380 if ($got eq $expected) {
381 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
383 unshift@mess, "# got "._qq($got)."\n",
384 "# expected "._qq($expected)." (within "._qq($range).")\n";
386 _ok($pass, _where(), $name, @mess);
389 # Note: this isn't quite as fancy as Test::More::like().
391 sub like ($$@) { like_yn (0,@_) }; # 0 for -
392 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
395 my ($flip, undef, $expected, $name, @mess) = @_;
397 $pass = $_[1] =~ /$expected/ if !$flip;
398 $pass = $_[1] !~ /$expected/ if $flip;
400 unshift(@mess, "# got '$_[1]'\n",
402 ? "# expected !~ /$expected/\n" : "# expected /$expected/\n");
404 local $Level = $Level + 1;
405 _ok($pass, _where(), $name, @mess);
413 _ok(0, _where(), @_);
423 $test = $test + 1; # don't use ++
427 # Note: can't pass multipart messages since we try to
428 # be compatible with Test::More::skip().
431 my $n = @_ ? shift : 1;
433 _print "ok $test # skip $why\n";
440 sub skip_if_miniperl {
441 skip(@_) if is_miniperl();
446 my $n = @_ ? shift : 1;
449 _print "not ok $test # TODO & SKIP $why\n";
458 return 0 unless $#$ra == $#$rb;
459 for my $i (0..$#$ra) {
460 next if !defined $ra->[$i] && !defined $rb->[$i];
461 return 0 if !defined $ra->[$i];
462 return 0 if !defined $rb->[$i];
463 return 0 unless $ra->[$i] eq $rb->[$i];
469 my ($orig, $suspect) = @_;
471 while (my ($key, $value) = each %$suspect) {
472 # Force a hash recompute if this perl's internals can cache the hash key.
474 if (exists $orig->{$key}) {
475 if ($orig->{$key} ne $value) {
476 _print "# key ", _qq($key), " was ", _qq($orig->{$key}),
477 " now ", _qq($value), "\n";
481 _print "# key ", _qq($key), " is ", _qq($value),
482 ", not in original.\n";
486 foreach (keys %$orig) {
487 # Force a hash recompute if this perl's internals can cache the hash key.
489 next if (exists $suspect->{$_});
490 _print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
496 # We only provide a subset of the Test::More functionality.
499 if ($require =~ tr/[A-Za-z0-9:.]//c) {
500 fail("Invalid character in \"$require\", passed to require_ok");
505 is($@, '', _where(), "require $require");
511 if ($use =~ tr/[A-Za-z0-9:.]//c) {
512 fail("Invalid character in \"$use\", passed to use");
517 is($@, '', _where(), "use $use");
521 # runperl - Runs a separate perl interpreter.
523 # switches => [ command-line switches ]
524 # nolib => 1 # don't use -I../lib (included by default)
525 # non_portable => Don't warn if a one liner contains quotes
526 # prog => one-liner (avoid quotes)
527 # progs => [ multi-liner (avoid quotes) ]
528 # progfile => perl script
529 # stdin => string to feed the stdin
530 # stderr => redirect stderr to stdout
531 # args => [ command-line arguments to the perl program ]
532 # verbose => print the command line
534 my $is_mswin = $^O eq 'MSWin32';
535 my $is_netware = $^O eq 'NetWare';
536 my $is_vms = $^O eq 'VMS';
537 my $is_cygwin = $^O eq 'cygwin';
540 my ($runperl, $args) = @_;
543 # In VMS protect with doublequotes because otherwise
544 # DCL will lowercase -- unless already doublequoted.
545 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
546 $runperl = $runperl . ' ' . $_;
551 sub _create_runperl { # Create the string to qx in runperl().
553 my $runperl = which_perl();
554 if ($runperl =~ m/\s/) {
555 $runperl = qq{"$runperl"};
557 #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
558 if ($ENV{PERL_RUNPERL_DEBUG}) {
559 $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
561 unless ($args{nolib}) {
562 $runperl = $runperl . ' "-I../lib"'; # doublequotes because of VMS
564 if ($args{switches}) {
566 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
567 unless ref $args{switches} eq "ARRAY";
568 $runperl = _quote_args($runperl, $args{switches});
570 if (defined $args{prog}) {
571 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
572 if defined $args{progs};
573 $args{progs} = [$args{prog}]
575 if (defined $args{progs}) {
576 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
577 unless ref $args{progs} eq "ARRAY";
578 foreach my $prog (@{$args{progs}}) {
579 if ($prog =~ tr/'"// && !$args{non_portable}) {
580 warn "quotes in prog >>$prog<< are not portable";
582 if ($is_mswin || $is_netware || $is_vms) {
583 $runperl = $runperl . qq ( -e "$prog" );
586 $runperl = $runperl . qq ( -e '$prog' );
589 } elsif (defined $args{progfile}) {
590 $runperl = $runperl . qq( "$args{progfile}");
592 # You probably didn't want to be sucking in from the upstream stdin
593 die "test.pl:runperl(): none of prog, progs, progfile, args, "
594 . " switches or stdin specified"
595 unless defined $args{args} or defined $args{switches}
596 or defined $args{stdin};
598 if (defined $args{stdin}) {
599 # so we don't try to put literal newlines and crs onto the
601 $args{stdin} =~ s/\n/\\n/g;
602 $args{stdin} =~ s/\r/\\r/g;
604 if ($is_mswin || $is_netware || $is_vms) {
605 $runperl = qq{$Perl -e "print qq(} .
606 $args{stdin} . q{)" | } . $runperl;
609 $runperl = qq{$Perl -e 'print qq(} .
610 $args{stdin} . q{)' | } . $runperl;
613 if (defined $args{args}) {
614 $runperl = _quote_args($runperl, $args{args});
616 $runperl = $runperl . ' 2>&1' if $args{stderr};
617 if ($args{verbose}) {
618 my $runperldisplay = $runperl;
619 $runperldisplay =~ s/\n/\n\#/g;
620 _print_stderr "# $runperldisplay\n";
626 die "test.pl:runperl() does not take a hashref"
627 if ref $_[0] and ref $_[0] eq 'HASH';
628 my $runperl = &_create_runperl;
631 my $tainted = ${^TAINT};
633 exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
636 # We will assume that if you're running under -T, you really mean to
637 # run a fresh perl, so we'll brute force launder everything for you
640 if (! eval {require Config; 1}) {
641 warn "test.pl had problems loading Config: $@";
644 $sep = $Config::Config{path_sep};
647 my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
648 local @ENV{@keys} = ();
649 # Untaint, plus take out . and empty string:
650 local $ENV{'DCL$PATH'} = $1 if $is_vms && exists($ENV{'DCL$PATH'}) && ($ENV{'DCL$PATH'} =~ /(.*)/s);
651 $ENV{PATH} =~ /(.*)/s;
653 join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and
654 ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
655 split quotemeta ($sep), $1;
656 if ($is_cygwin) { # Must have /bin under Cygwin
657 if (length $ENV{PATH}) {
658 $ENV{PATH} = $ENV{PATH} . $sep;
660 $ENV{PATH} = $ENV{PATH} . '/bin';
665 $result = `$runperl`;
667 $result = `$runperl`;
669 $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
674 *run_perl = *run_perl = \&runperl; # shut up "used only once" warning
677 _print_stderr "# @_\n";
681 # A somewhat safer version of the sometimes wrong $^X.
683 unless (defined $Perl) {
686 # VMS should have 'perl' aliased properly
687 return $Perl if $is_vms;
690 if (! eval {require Config; 1}) {
691 warn "test.pl had problems loading Config: $@";
694 $exe = $Config::Config{_exe};
696 $exe = '' unless defined $exe;
698 # This doesn't absolutize the path: beware of future chdirs().
699 # We could do File::Spec->abs2rel() but that does getcwd()s,
700 # which is a bit heavyweight to do here.
702 if ($Perl =~ /^perl\Q$exe\E$/i) {
703 my $perl = "perl$exe";
704 if (! eval {require File::Spec; 1}) {
705 warn "test.pl had problems loading File::Spec: $@";
708 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
712 # Build up the name of the executable file from the name of
715 if ($Perl !~ /\Q$exe\E$/i) {
716 $Perl = $Perl . $exe;
719 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
721 # For subcommands to use.
722 $ENV{PERLEXE} = $Perl;
729 foreach my $file (@_) {
730 1 while unlink $file;
732 _print_stderr "# Couldn't unlink '$file': $!\n";
741 END { unlink_all keys %tmpfiles }
743 # A regexp that matches the tempfile names
744 $::tempfile_regexp = 'tmp\d+[A-Z][A-Z]?';
746 # Avoid ++, avoid ranges, avoid split //
747 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);
754 $try = $try . $letters[$temp % 26];
755 $temp = int ($temp / 26);
757 # Need to note all the file names we allocated, as a second request may
758 # come before the first is created.
759 if (!-e $try && !$tmpfiles{$try}) {
765 } while $count < 26 * 26;
766 die "Can't find temporary file name starting 'tmp$$'";
769 # This is the temporary file for _fresh_perl
770 my $tmpfile = tempfile();
773 my($prog, $action, $expect, $runperl_args, $name) = @_;
775 # Given the choice of the mis-parsable {}
776 # (we want an anon hash, but a borked lexer might think that it's a block)
777 # or relying on taking a reference to a lexical
778 # (\ might be mis-parsed, and the reference counting on the pad may go
780 # it feels like the least-worse thing is to assume that auto-vivification
781 # works. At least, this is only going to be a run-time failure, so won't
782 # affect tests using this file but not this function.
783 $runperl_args->{progfile} = $tmpfile;
784 $runperl_args->{stderr} = 1;
786 open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
790 $prog =~ s#/dev/null#NL:#;
793 $prog =~ s{if \(-e _ and -f _ and -r _\)}
798 close TEST or die "Cannot close $tmpfile: $!";
800 my $results = runperl(%$runperl_args);
803 # Clean up the results into something a bit more predictable.
804 $results =~ s/\n+$//;
805 $results =~ s/at\s+$::tempfile_regexp\s+line/at - line/g;
806 $results =~ s/of\s+$::tempfile_regexp\s+aborted/of - aborted/g;
808 # bison says 'parse error' instead of 'syntax error',
809 # various yaccs may or may not capitalize 'syntax'.
810 $results =~ s/^(syntax|parse) error/syntax error/mig;
813 # some tests will trigger VMS messages that won't be expected
814 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
816 # pipes double these sometimes
817 $results =~ s/\n\n/\n/g;
820 # Use the first line of the program as a name if none was given
822 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
823 $name = $name . '...' if length $first_line > length $name;
826 # Historically this was implemented using a closure, but then that means
827 # that the tests for closures avoid using this code. Given that there
828 # are exactly two callers, doing exactly two things, the simpler approach
829 # feels like a better trade off.
831 if ($action eq 'eq') {
832 $pass = is($results, $expect, $name);
833 } elsif ($action eq '=~') {
834 $pass = like($results, $expect, $name);
836 die "_fresh_perl can't process action '$action'";
840 _diag "# PROG: \n$prog\n";
841 _diag "# STATUS: $status\n";
850 # Combination of run_perl() and is().
854 my($prog, $expected, $runperl_args, $name) = @_;
856 # _fresh_perl() is going to clip the trailing newlines off the result.
857 # This will make it so the test author doesn't have to know that.
858 $expected =~ s/\n+$//;
861 _fresh_perl($prog, 'eq', $expected, $runperl_args, $name);
867 # Combination of run_perl() and like().
870 sub fresh_perl_like {
871 my($prog, $expected, $runperl_args, $name) = @_;
873 _fresh_perl($prog, '=~', $expected, $runperl_args, $name);
876 # Many tests use the same format in __DATA__ or external files to specify a
877 # sequence of (fresh) tests to run, extra files they may temporarily need, and
878 # what the expected output is. So have excatly one copy of the code to run that
880 sub run_multiple_progs {
884 # The tests in lib run in a temporary subdirectory of t, and always
885 # pass in a list of "programs" to run
888 # The tests below t run in t and pass in a file handle.
891 @prgs = split "\n########\n", <$fh>;
894 my $tmpfile = tempfile();
904 if (s/^(\s*-\w+)//) {
907 my ($prog, $expected) = split(/\nEXPECT(?:\n|$)/, $_, 2);
910 foreach my $what (qw(skip todo)) {
911 $prog =~ s/^#\s*\U$what\E\s*(.*)\n//m and $reason{$what} = $1;
912 # If the SKIP reason starts ? then it's taken as a code snippet to
913 # evaluate. This provides the flexibility to have conditional SKIPs
914 if ($reason{$what} && $reason{$what} =~ s/^\?//) {
915 my $temp = eval $reason{$what};
917 die "# In \U$what\E code reason:\n# $reason{$what}\n$@";
919 $reason{$what} = $temp;
923 if ($prog =~ /--FILE--/) {
924 my @files = split(/\n--FILE--\s*([^\s\n]*)\s*\n/, $prog) ;
926 die "Internal error: test $_ didn't split into pairs, got " .
927 scalar(@files) . "[" . join("%%%%", @files) ."]\n"
930 my $filename = shift @files;
931 my $code = shift @files;
932 push @temps, $filename;
933 if ($filename =~ m#(.*)/# && $filename !~ m#^\.\./#) {
935 File::Path::mkpath($1);
936 push(@temp_path, $1);
938 open my $fh, '>', $filename or die "Cannot open $filename: $!\n";
940 close $fh or die "Cannot close $filename: $!\n";
943 $prog = shift @files;
946 open my $fh, '>', $tmpfile or die "Cannot open >$tmpfile: $!";
949 open STDERR, '>&', STDOUT
950 or die "Can't dup STDOUT->STDERR: $!;";
953 print $fh "\n#line 1\n"; # So the line numbers don't get messed up.
954 print $fh $prog,"\n";
955 close $fh or die "Cannot close $tmpfile: $!";
956 my $results = runperl( stderr => 1, progfile => $tmpfile, $up
957 ? (switches => ["-I$up/lib", $switch], nolib => 1)
958 : (switches => [$switch])
961 $results =~ s/\n+$//;
962 # allow expected output to be written as if $prog is on STDIN
963 $results =~ s/$::tempfile_regexp/-/g;
965 # some tests will trigger VMS messages that won't be expected
966 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
968 # pipes double these sometimes
969 $results =~ s/\n\n/\n/g;
971 # bison says 'parse error' instead of 'syntax error',
972 # various yaccs may or may not capitalize 'syntax'.
973 $results =~ s/^(syntax|parse) error/syntax error/mig;
974 # allow all tests to run when there are leaks
975 $results =~ s/Scalars leaked: \d+\n//g;
977 $expected =~ s/\n+$//;
978 my $prefix = ($results =~ s#^PREFIX(\n|$)##) ;
979 # any special options? (OPTIONS foo bar zap)
980 my $option_regex = 0;
981 my $option_random = 0;
982 if ($expected =~ s/^OPTIONS? (.+)\n//) {
983 foreach my $option (split(' ', $1)) {
984 if ($option eq 'regex') { # allow regular expressions
987 elsif ($option eq 'random') { # all lines match, but in any order
991 die "$0: Unknown OPTION '$option'\n";
995 die "$0: can't have OPTION regex and random\n"
996 if $option_regex + $option_random > 1;
998 if ($results =~ s/^SKIPPED\n//) {
1002 elsif ($option_random) {
1003 my @got = sort split "\n", $results;
1004 my @expected = sort split "\n", $expected;
1006 $ok = "@got" eq "@expected";
1008 elsif ($option_regex) {
1009 $ok = $results =~ /^$expected/;
1012 $ok = $results =~ /^\Q$expected/;
1015 $ok = $results eq $expected;
1018 local $::TODO = $reason{todo};
1021 my $err_line = "PROG: $switch\n$prog\n" .
1022 "EXPECTED:\n$expected\n" .
1025 $err_line =~ s/^/# /mg;
1026 print $err_line; # Harness can't filter it out from STDERR.
1029 print STDERR $err_line;
1038 foreach (@temp_path) {
1039 File::Path::rmtree $_ if -d $_;
1045 my($proto, @methods) = @_;
1046 my $class = ref $proto || $proto;
1048 unless( @methods ) {
1049 return _ok( 0, _where(), "$class->can(...)" );
1053 foreach my $method (@methods) {
1054 local($!, $@); # don't interfere with caller's $@
1055 # eval sometimes resets $!
1056 eval { $proto->can($method) } || push @nok, $method;
1060 $name = @methods == 1 ? "$class->can('$methods[0]')"
1061 : "$class->can(...)";
1063 _ok( !@nok, _where(), $name );
1067 # Call $class->new( @$args ); and run the result through isa_ok.
1068 # See Test::More::new_ok
1070 my($class, $args, $obj_name) = @_;
1072 $object_name = "The object" unless defined $obj_name;
1074 local $Level = $Level + 1;
1077 my $ok = eval { $obj = $class->new(@$args); 1 };
1081 isa_ok($obj, $class, $object_name);
1084 ok( 0, "new() died" );
1085 diag("Error was: $@");
1094 my($object, $class, $obj_name) = @_;
1097 $obj_name = 'The object' unless defined $obj_name;
1098 my $name = "$obj_name isa $class";
1099 if( !defined $object ) {
1100 $diag = "$obj_name isn't defined";
1102 elsif( !ref $object ) {
1103 $diag = "$obj_name isn't a reference";
1106 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
1107 local($@, $!); # eval sometimes resets $!
1108 my $rslt = eval { $object->isa($class) };
1110 if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) {
1111 if( !UNIVERSAL::isa($object, $class) ) {
1112 my $ref = ref $object;
1113 $diag = "$obj_name isn't a '$class' it's a '$ref'";
1117 WHOA! I tried to call ->isa on your object and got some weird error.
1118 This should never happen. Please contact the author immediately.
1125 my $ref = ref $object;
1126 $diag = "$obj_name isn't a '$class' it's a '$ref'";
1130 _ok( !$diag, _where(), $name );
1133 # Purposefully avoiding a closure.
1135 push @::__capture, join "", @_;
1138 sub capture_warnings {
1142 local $SIG {__WARN__} = \&__capture;
1144 return @::__capture;
1147 # This will generate a variable number of tests.
1148 # Use done_testing() instead of a fixed plan.
1150 my ($code, $expect, $name) = @_;
1151 local $Level = $Level + 1;
1153 my @w = capture_warnings($code);
1155 cmp_ok(scalar @w, '==', scalar @$expect, $name);
1156 foreach my $e (@$expect) {
1158 like(shift @w, $e, $name);
1160 is(shift @w, $e, $name);
1164 diag("Saw these additional warnings:");
1165 diag($_) foreach @w;
1169 sub _fail_excess_warnings {
1170 my($expect, $got, $name) = @_;
1171 local $Level = $Level + 1;
1172 # This will fail, and produce diagnostics
1173 is($expect, scalar @$got, $name);
1174 diag("Saw these warnings:");
1175 diag($_) foreach @$got;
1179 my ($code, $expect, $name) = @_;
1180 die sprintf "Expect must be a string or undef, not a %s reference", ref $expect
1182 local $Level = $Level + 1;
1183 my @w = capture_warnings($code);
1185 _fail_excess_warnings(0 + defined $expect, \@w, $name);
1187 is($w[0], $expect, $name);
1192 my ($code, $expect, $name) = @_;
1193 die sprintf "Expect must be a regexp object"
1194 unless ref $expect eq 'Regexp';
1195 local $Level = $Level + 1;
1196 my @w = capture_warnings($code);
1198 _fail_excess_warnings(0 + defined $expect, \@w, $name);
1200 like($w[0], $expect, $name);
1204 # Set a watchdog to timeout the entire test file
1205 # NOTE: If the test file uses 'threads', then call the watchdog() function
1206 # _AFTER_ the 'threads' module is loaded.
1209 my $timeout = shift;
1210 my $method = shift || "";
1211 my $timeout_msg = 'Test process timed out - terminating';
1213 # Valgrind slows perl way down so give it more time before dying.
1214 $timeout *= 10 if $ENV{PERL_VALGRIND};
1216 my $pid_to_kill = $$; # PID for this process
1218 if ($method eq "alarm") {
1219 goto WATCHDOG_VIA_ALARM;
1222 # shut up use only once warning
1223 my $threads_on = $threads::threads && $threads::threads;
1225 # Don't use a watchdog process if 'threads' is loaded -
1226 # use a watchdog thread instead
1229 # On Windows and VMS, try launching a watchdog process
1230 # using system(1, ...) (see perlport.pod)
1231 if ($is_mswin || $is_vms) {
1232 # On Windows, try to get the 'real' PID
1234 eval { require Win32; };
1235 if (defined(&Win32::GetCurrentProcessId)) {
1236 $pid_to_kill = Win32::GetCurrentProcessId();
1240 # If we still have a fake PID, we can't use this method at all
1241 return if ($pid_to_kill <= 0);
1243 # Launch watchdog process
1246 local $SIG{'__WARN__'} = sub {
1247 _diag("Watchdog warning: $_[0]");
1249 my $sig = $is_vms ? 'TERM' : 'KILL';
1250 my $cmd = _create_runperl( prog => "sleep($timeout);" .
1251 "warn qq/# $timeout_msg" . '\n/;' .
1252 "kill($sig, $pid_to_kill);");
1253 $watchdog = system(1, $cmd);
1255 if ($@ || ($watchdog <= 0)) {
1256 _diag('Failed to start watchdog');
1262 # Add END block to parent to terminate and
1263 # clean up watchdog process
1264 eval "END { local \$! = 0; local \$? = 0;
1265 wait() if kill('KILL', $watchdog); };";
1269 # Try using fork() to generate a watchdog process
1271 eval { $watchdog = fork() };
1272 if (defined($watchdog)) {
1273 if ($watchdog) { # Parent process
1274 # Add END block to parent to terminate and
1275 # clean up watchdog process
1276 eval "END { local \$! = 0; local \$? = 0;
1277 wait() if kill('KILL', $watchdog); };";
1281 ### Watchdog process code
1283 # Load POSIX if available
1284 eval { require POSIX; };
1286 # Execute the timeout
1287 sleep($timeout - 2) if ($timeout > 2); # Workaround for perlbug #49073
1290 # Kill test process if still running
1291 if (kill(0, $pid_to_kill)) {
1292 _diag($timeout_msg);
1293 kill('KILL', $pid_to_kill);
1296 # Don't execute END block (added at beginning of this file)
1299 # Terminate ourself (i.e., the watchdog)
1300 POSIX::_exit(1) if (defined(&POSIX::_exit));
1304 # fork() failed - fall through and try using a thread
1307 # Use a watchdog thread because either 'threads' is loaded,
1309 if (eval {require threads; 1}) {
1310 'threads'->create(sub {
1311 # Load POSIX if available
1312 eval { require POSIX; };
1314 # Execute the timeout
1315 my $time_left = $timeout;
1317 $time_left = $time_left - sleep($time_left);
1318 } while ($time_left > 0);
1320 # Kill the parent (and ourself)
1321 select(STDERR); $| = 1;
1322 _diag($timeout_msg);
1323 POSIX::_exit(1) if (defined(&POSIX::_exit));
1324 my $sig = $is_vms ? 'TERM' : 'KILL';
1325 kill($sig, $pid_to_kill);
1330 # If everything above fails, then just use an alarm timeout
1332 if (eval { alarm($timeout); 1; }) {
1333 # Load POSIX if available
1334 eval { require POSIX; };
1336 # Alarm handler will do the actual 'killing'
1337 $SIG{'ALRM'} = sub {
1338 select(STDERR); $| = 1;
1339 _diag($timeout_msg);
1340 POSIX::_exit(1) if (defined(&POSIX::_exit));
1341 my $sig = $is_vms ? 'TERM' : 'KILL';
1342 kill($sig, $pid_to_kill);
1347 my $cp_0037 = # EBCDIC code page 0037
1348 '\x00\x01\x02\x03\x37\x2D\x2E\x2F\x16\x05\x25\x0B\x0C\x0D\x0E\x0F' .
1349 '\x10\x11\x12\x13\x3C\x3D\x32\x26\x18\x19\x3F\x27\x1C\x1D\x1E\x1F' .
1350 '\x40\x5A\x7F\x7B\x5B\x6C\x50\x7D\x4D\x5D\x5C\x4E\x6B\x60\x4B\x61' .
1351 '\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\x7A\x5E\x4C\x7E\x6E\x6F' .
1352 '\x7C\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xD1\xD2\xD3\xD4\xD5\xD6' .
1353 '\xD7\xD8\xD9\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xBA\xE0\xBB\xB0\x6D' .
1354 '\x79\x81\x82\x83\x84\x85\x86\x87\x88\x89\x91\x92\x93\x94\x95\x96' .
1355 '\x97\x98\x99\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xC0\x4F\xD0\xA1\x07' .
1356 '\x20\x21\x22\x23\x24\x15\x06\x17\x28\x29\x2A\x2B\x2C\x09\x0A\x1B' .
1357 '\x30\x31\x1A\x33\x34\x35\x36\x08\x38\x39\x3A\x3B\x04\x14\x3E\xFF' .
1358 '\x41\xAA\x4A\xB1\x9F\xB2\x6A\xB5\xBD\xB4\x9A\x8A\x5F\xCA\xAF\xBC' .
1359 '\x90\x8F\xEA\xFA\xBE\xA0\xB6\xB3\x9D\xDA\x9B\x8B\xB7\xB8\xB9\xAB' .
1360 '\x64\x65\x62\x66\x63\x67\x9E\x68\x74\x71\x72\x73\x78\x75\x76\x77' .
1361 '\xAC\x69\xED\xEE\xEB\xEF\xEC\xBF\x80\xFD\xFE\xFB\xFC\xAD\xAE\x59' .
1362 '\x44\x45\x42\x46\x43\x47\x9C\x48\x54\x51\x52\x53\x58\x55\x56\x57' .
1363 '\x8C\x49\xCD\xCE\xCB\xCF\xCC\xE1\x70\xDD\xDE\xDB\xDC\x8D\x8E\xDF';
1365 my $cp_1047 = # EBCDIC code page 1047
1366 '\x00\x01\x02\x03\x37\x2D\x2E\x2F\x16\x05\x15\x0B\x0C\x0D\x0E\x0F' .
1367 '\x10\x11\x12\x13\x3C\x3D\x32\x26\x18\x19\x3F\x27\x1C\x1D\x1E\x1F' .
1368 '\x40\x5A\x7F\x7B\x5B\x6C\x50\x7D\x4D\x5D\x5C\x4E\x6B\x60\x4B\x61' .
1369 '\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\x7A\x5E\x4C\x7E\x6E\x6F' .
1370 '\x7C\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xD1\xD2\xD3\xD4\xD5\xD6' .
1371 '\xD7\xD8\xD9\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xAD\xE0\xBD\x5F\x6D' .
1372 '\x79\x81\x82\x83\x84\x85\x86\x87\x88\x89\x91\x92\x93\x94\x95\x96' .
1373 '\x97\x98\x99\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xC0\x4F\xD0\xA1\x07' .
1374 '\x20\x21\x22\x23\x24\x25\x06\x17\x28\x29\x2A\x2B\x2C\x09\x0A\x1B' .
1375 '\x30\x31\x1A\x33\x34\x35\x36\x08\x38\x39\x3A\x3B\x04\x14\x3E\xFF' .
1376 '\x41\xAA\x4A\xB1\x9F\xB2\x6A\xB5\xBB\xB4\x9A\x8A\xB0\xCA\xAF\xBC' .
1377 '\x90\x8F\xEA\xFA\xBE\xA0\xB6\xB3\x9D\xDA\x9B\x8B\xB7\xB8\xB9\xAB' .
1378 '\x64\x65\x62\x66\x63\x67\x9E\x68\x74\x71\x72\x73\x78\x75\x76\x77' .
1379 '\xAC\x69\xED\xEE\xEB\xEF\xEC\xBF\x80\xFD\xFE\xFB\xFC\xBA\xAE\x59' .
1380 '\x44\x45\x42\x46\x43\x47\x9C\x48\x54\x51\x52\x53\x58\x55\x56\x57' .
1381 '\x8C\x49\xCD\xCE\xCB\xCF\xCC\xE1\x70\xDD\xDE\xDB\xDC\x8D\x8E\xDF';
1383 my $cp_bc = # EBCDIC code page POSiX-BC
1384 '\x00\x01\x02\x03\x37\x2D\x2E\x2F\x16\x05\x15\x0B\x0C\x0D\x0E\x0F' .
1385 '\x10\x11\x12\x13\x3C\x3D\x32\x26\x18\x19\x3F\x27\x1C\x1D\x1E\x1F' .
1386 '\x40\x5A\x7F\x7B\x5B\x6C\x50\x7D\x4D\x5D\x5C\x4E\x6B\x60\x4B\x61' .
1387 '\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\x7A\x5E\x4C\x7E\x6E\x6F' .
1388 '\x7C\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xD1\xD2\xD3\xD4\xD5\xD6' .
1389 '\xD7\xD8\xD9\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xBB\xBC\xBD\x6A\x6D' .
1390 '\x4A\x81\x82\x83\x84\x85\x86\x87\x88\x89\x91\x92\x93\x94\x95\x96' .
1391 '\x97\x98\x99\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xFB\x4F\xFD\xFF\x07' .
1392 '\x20\x21\x22\x23\x24\x25\x06\x17\x28\x29\x2A\x2B\x2C\x09\x0A\x1B' .
1393 '\x30\x31\x1A\x33\x34\x35\x36\x08\x38\x39\x3A\x3B\x04\x14\x3E\x5F' .
1394 '\x41\xAA\xB0\xB1\x9F\xB2\xD0\xB5\x79\xB4\x9A\x8A\xBA\xCA\xAF\xA1' .
1395 '\x90\x8F\xEA\xFA\xBE\xA0\xB6\xB3\x9D\xDA\x9B\x8B\xB7\xB8\xB9\xAB' .
1396 '\x64\x65\x62\x66\x63\x67\x9E\x68\x74\x71\x72\x73\x78\x75\x76\x77' .
1397 '\xAC\x69\xED\xEE\xEB\xEF\xEC\xBF\x80\xE0\xFE\xDD\xFC\xAD\xAE\x59' .
1398 '\x44\x45\x42\x46\x43\x47\x9C\x48\x54\x51\x52\x53\x58\x55\x56\x57' .
1399 '\x8C\x49\xCD\xCE\xCB\xCF\xCC\xE1\x70\xC0\xDE\xDB\xDC\x8D\x8E\xDF';
1401 my $straight = # Avoid ranges
1402 '\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F' .
1403 '\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F' .
1404 '\x20\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2A\x2B\x2C\x2D\x2E\x2F' .
1405 '\x30\x31\x32\x33\x34\x35\x36\x37\x38\x39\x3A\x3B\x3C\x3D\x3E\x3F' .
1406 '\x40\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4A\x4B\x4C\x4D\x4E\x4F' .
1407 '\x50\x51\x52\x53\x54\x55\x56\x57\x58\x59\x5A\x5B\x5C\x5D\x5E\x5F' .
1408 '\x60\x61\x62\x63\x64\x65\x66\x67\x68\x69\x6A\x6B\x6C\x6D\x6E\x6F' .
1409 '\x70\x71\x72\x73\x74\x75\x76\x77\x78\x79\x7A\x7B\x7C\x7D\x7E\x7F' .
1410 '\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8A\x8B\x8C\x8D\x8E\x8F' .
1411 '\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9A\x9B\x9C\x9D\x9E\x9F' .
1412 '\xA0\xA1\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xAA\xAB\xAC\xAD\xAE\xAF' .
1413 '\xB0\xB1\xB2\xB3\xB4\xB5\xB6\xB7\xB8\xB9\xBA\xBB\xBC\xBD\xBE\xBF' .
1414 '\xC0\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF' .
1415 '\xD0\xD1\xD2\xD3\xD4\xD5\xD6\xD7\xD8\xD9\xDA\xDB\xDC\xDD\xDE\xDF' .
1416 '\xE0\xE1\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xEA\xEB\xEC\xED\xEE\xEF' .
1417 '\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\xFA\xFB\xFC\xFD\xFE\xFF';
1419 # The following 2 functions allow tests to work on both EBCDIC and
1420 # ASCII-ish platforms. They convert string scalars between the native
1421 # character set and the set of 256 characters which is usually called
1424 # These routines don't work on UTF-EBCDIC and UTF-8.
1426 sub native_to_latin1($) {
1429 return $string if ord('^') == 94; # ASCII, Latin1
1431 if (ord('^') == 95) { # EBCDIC 1047
1434 elsif (ord('^') == 106) { # EBCDIC POSIX-BC
1437 elsif (ord('^') == 176) { # EBCDIC 037 */
1441 die "Unknown native character set";
1444 eval '$string =~ tr/' . $$cp . '/' . $straight . '/';
1448 sub latin1_to_native($) {
1451 return $string if ord('^') == 94; # ASCII, Latin1
1453 if (ord('^') == 95) { # EBCDIC 1047
1456 elsif (ord('^') == 106) { # EBCDIC POSIX-BC
1459 elsif (ord('^') == 176) { # EBCDIC 037 */
1463 die "Unknown native character set";
1466 eval '$string =~ tr/' . $straight . '/' . $$cp . '/';
1470 sub ord_latin1_to_native {
1471 # given an input code point, return the platform's native
1472 # equivalent value. Anything above latin1 is itself.
1475 return $ord if $ord > 255;
1476 return ord latin1_to_native(chr $ord);
1479 sub ord_native_to_latin1 {
1480 # given an input platform code point, return the latin1 equivalent value.
1481 # Anything above latin1 is itself.
1484 return $ord if $ord > 255;
1485 return ord native_to_latin1(chr $ord);