2 # t/test.pl - most of Test::More functionality without the fuss
7 # Do not rely on features found only in more modern Perls here, as some CPAN
8 # distributions copy this file and must operate on older Perls. Similarly, keep
9 # things, simple as this may be run under fairly broken circumstances. For
10 # example, increment ($x++) has a certain amount of cleverness for things like
13 # $x++; # $x eq 'aaa';
15 # This stands more chance of breaking than just a simple
19 # In this file, we use the latter "Baby Perl" approach, and increment
20 # will be worked over by t/op/inc.t
27 my $Perl; # Safer version of $^X set by which_perl()
29 # This defines ASCII/UTF-8 vs EBCDIC/UTF-EBCDIC
30 $::IS_ASCII = ord 'A' == 65;
31 $::IS_EBCDIC = ord 'A' == 193;
35 $Tests_Are_Passing = 1;
37 # Use this instead of print to avoid interference while testing globals.
39 local($\, $", $,) = (undef, ' ', '');
44 local($\, $", $,) = (undef, ' ', '');
52 if ($n eq 'no_plan') {
58 $plan{skip_all} and skip_all($plan{skip_all});
61 _print "1..$n\n" unless $noplan;
66 # Set the plan at the end. See Test::More::done_testing.
79 if (defined $planned && $planned != $ran) {
81 "# Looks like you planned $planned tests but ran $ran.\n";
90 my @mess = _comment(@_);
91 $TODO ? _print(@mess) : _print_stderr(@mess);
94 # Use this instead of "print STDERR" when outputting failure diagnostic
100 # Use this instead of "print" when outputting informational messages
103 _print( _comment(@_) );
107 return !defined &DynaLoader::boot_DynaLoader;
111 # Don’t clobber @INC under miniperl
112 @INC = () unless is_miniperl;
117 return map { /^#/ ? "$_\n" : "# $_\n" }
118 map { split /\n/ } @_;
121 sub _have_dynamic_extension {
122 my $extension = shift;
123 unless (eval {require Config; 1}) {
124 warn "test.pl had problems loading Config: $@";
127 $extension =~ s!::!/!g;
128 return 1 if ($Config::Config{extensions} =~ /\b$extension\b/);
133 _print "1..0 # Skip @_\n";
140 sub skip_all_if_miniperl {
141 skip_all(@_) if is_miniperl();
144 sub skip_all_without_dynamic_extension {
145 my ($extension) = @_;
146 skip_all("no dynamic loading on miniperl, no $extension") if is_miniperl();
147 return if &_have_dynamic_extension;
148 skip_all("$extension was not built");
151 sub skip_all_without_perlio {
152 skip_all('no PerlIO') unless PerlIO::Layer->find('perlio');
155 sub skip_all_without_config {
156 unless (eval {require Config; 1}) {
157 warn "test.pl had problems loading Config: $@";
161 next if $Config::Config{$_};
162 my $key = $_; # Need to copy, before trying to modify.
169 sub skip_all_without_unicode_tables { # (but only under miniperl)
171 skip_all_if_miniperl("Unicode tables not built yet")
172 unless eval 'require "unicore/Heavy.pl"';
176 sub find_git_or_skip {
177 my ($source_dir, $reason);
180 } elsif (-l 'MANIFEST' && -l 'AUTHORS') {
181 my $where = readlink 'MANIFEST';
182 die "Can't readling MANIFEST: $!" unless defined $where;
183 die "Confusing symlink target for MANIFEST, '$where'"
184 unless $where =~ s!/MANIFEST\z!!;
185 if (-d "$where/.git") {
186 # Looks like we are in a symlink tree
187 if (exists $ENV{GIT_DIR}) {
188 diag("Found source tree at $where, but \$ENV{GIT_DIR} is $ENV{GIT_DIR}. Not changing it");
190 note("Found source tree at $where, setting \$ENV{GIT_DIR}");
191 $ENV{GIT_DIR} = "$where/.git";
193 $source_dir = $where;
195 } elsif (exists $ENV{GIT_DIR}) {
196 my $commit = '8d063cd8450e59ea1c611a2f4f5a21059a2804f1';
197 my $out = `git rev-parse --verify --quiet '$commit^{commit}'`;
199 if($out eq $commit) {
203 if ($ENV{'PERL_BUILD_PACKAGING'}) {
204 $reason = 'PERL_BUILD_PACKAGING is set';
205 } elsif ($source_dir) {
206 my $version_string = `git --version`;
207 if (defined $version_string
208 && $version_string =~ /\Agit version (\d+\.\d+\.\d+)(.*)/) {
209 return $source_dir if eval "v$1 ge v1.5.0";
210 # If you have earlier than 1.5.0 and it works, change this test
211 $reason = "in git checkout, but git version '$1$2' too old";
213 $reason = "in git checkout, but cannot run git";
216 $reason = 'not being run from a git checkout';
218 skip_all($reason) if $_[0] && $_[0] eq 'all';
224 _print("Bail out! $reason\n");
229 my ($pass, $where, $name, @mess) = @_;
230 # Do not try to microoptimize by factoring out the "not ".
234 # escape out '#' or it will interfere with '# skip' and such
236 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
238 $out = $pass ? "ok $test" : "not ok $test";
242 $out = $out . " # TODO $TODO";
244 $Tests_Are_Passing = 0 unless $pass;
250 note @mess; # Ensure that the message is properly escaped.
253 my $msg = "# Failed test $test - ";
254 $msg.= "$name " if $name;
260 $test = $test + 1; # don't use ++
266 my @caller = caller($Level);
267 return "at $caller[1] line $caller[2]";
270 # DON'T use this for matches. Use like() instead.
272 my ($pass, $name, @mess) = @_;
273 _ok($pass, _where(), $name, @mess);
278 return 'undef' unless defined $x;
287 return defined $x ? '"' . display ($x) . '"' : 'undef';
290 # Support pre-5.10 Perls, for the benefit of CPAN dists that copy this file.
291 # Note that chr(90) exists in both ASCII ("Z") and EBCDIC ("!").
292 my $chars_template = defined(eval { pack "W*", 90 }) ? "W*" : "U*";
293 eval 'sub re::is_regexp { ref($_[0]) eq "Regexp" }'
294 if !defined &re::is_regexp;
296 # keys are the codes \n etc map to, values are 2 char strings such as \n
297 my %backslash_escape;
298 foreach my $x (split //, 'nrtfa\\\'"') {
299 $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
301 # A way to display scalars containing control characters and Unicode.
302 # Trying to avoid setting $_, or relying on local $_ to work.
306 if (defined $x and not ref $x) {
308 foreach my $c (unpack($chars_template, $x)) {
310 $y = $y . sprintf "\\x{%x}", $c;
311 } elsif ($backslash_escape{$c}) {
312 $y = $y . $backslash_escape{$c};
314 my $z = chr $c; # Maybe we can get away with a literal...
316 if ($z !~ /[^[:^print:][:^ascii:]]/) {
317 # The pattern above is equivalent (by de Morgan's
319 # $z !~ /(?[ [:print:] & [:ascii:] ])/
320 # or, $z is not an ascii printable character
322 # Use octal for characters with small ordinals that
323 # are traditionally expressed as octal: the controls
324 # below space, which on EBCDIC are almost all the
325 # controls, but on ASCII don't include DEL nor the C1
328 $z = sprintf "\\%03o", $c;
330 $z = sprintf "\\x{%x}", $c;
338 return $x unless wantarray;
345 my ($got, $expected, $name, @mess) = @_;
348 if( !defined $got || !defined $expected ) {
349 # undef only matches undef
350 $pass = !defined $got && !defined $expected;
353 $pass = $got eq $expected;
357 unshift(@mess, "# got "._qq($got)."\n",
358 "# expected "._qq($expected)."\n");
360 _ok($pass, _where(), $name, @mess);
364 my ($got, $isnt, $name, @mess) = @_;
367 if( !defined $got || !defined $isnt ) {
368 # undef only matches undef
369 $pass = defined $got || defined $isnt;
372 $pass = $got ne $isnt;
376 unshift(@mess, "# it should not be "._qq($got)."\n",
379 _ok($pass, _where(), $name, @mess);
383 my($got, $type, $expected, $name, @mess) = @_;
388 local($@,$!); # don't interfere with $@
389 # eval() sometimes resets $!
390 $pass = eval "\$got $type \$expected";
393 # It seems Irix long doubles can have 2147483648 and 2147483648
394 # that stringify to the same thing but are actually numerically
395 # different. Display the numbers if $type isn't a string operator,
396 # and the numbers are stringwise the same.
397 # (all string operators have alphabetic names, so tr/a-z// is true)
398 # This will also show numbers for some unneeded cases, but will
399 # definitely be helpful for things such as == and <= that fail
400 if ($got eq $expected and $type !~ tr/a-z//) {
401 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
403 unshift(@mess, "# got "._qq($got)."\n",
404 "# expected $type "._qq($expected)."\n");
406 _ok($pass, _where(), $name, @mess);
409 # Check that $got is within $range of $expected
410 # if $range is 0, then check it's exact
411 # else if $expected is 0, then $range is an absolute value
412 # otherwise $range is a fractional error.
413 # Here $range must be numeric, >= 0
414 # Non numeric ranges might be a useful future extension. (eg %)
416 my ($got, $expected, $range, $name, @mess) = @_;
418 if (!defined $got or !defined $expected or !defined $range) {
419 # This is a fail, but doesn't need extra diagnostics
420 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
422 unshift @mess, "# got, expected and range must be numeric\n";
423 } elsif ($range < 0) {
424 # This is also a fail
425 unshift @mess, "# range must not be negative\n";
426 } elsif ($range == 0) {
428 $pass = $got == $expected;
429 } elsif ($expected == 0) {
430 # If expected is 0, treat range as absolute
431 $pass = ($got <= $range) && ($got >= - $range);
433 my $diff = $got - $expected;
434 $pass = abs ($diff / $expected) < $range;
437 if ($got eq $expected) {
438 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
440 unshift@mess, "# got "._qq($got)."\n",
441 "# expected "._qq($expected)." (within "._qq($range).")\n";
443 _ok($pass, _where(), $name, @mess);
446 # Note: this isn't quite as fancy as Test::More::like().
448 sub like ($$@) { like_yn (0,@_) }; # 0 for -
449 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
452 my ($flip, undef, $expected, $name, @mess) = @_;
454 # We just accept like(..., qr/.../), not like(..., '...'), and
455 # definitely not like(..., '/.../') like
456 # Test::Builder::maybe_regex() does.
457 unless (re::is_regexp($expected)) {
458 die "PANIC: The value '$expected' isn't a regexp. The like() function needs a qr// pattern, not a string";
462 $pass = $_[1] =~ /$expected/ if !$flip;
463 $pass = $_[1] !~ /$expected/ if $flip;
464 my $display_got = $_[1];
465 $display_got = display($display_got);
466 my $display_expected = $expected;
467 $display_expected = display($display_expected);
469 unshift(@mess, "# got '$display_got'\n",
471 ? "# expected !~ /$display_expected/\n"
472 : "# expected /$display_expected/\n");
474 local $Level = $Level + 1;
475 _ok($pass, _where(), $name, @mess);
483 _ok(0, _where(), @_);
493 $test = $test + 1; # don't use ++
497 # Note: can't pass multipart messages since we try to
498 # be compatible with Test::More::skip().
501 my $n = @_ ? shift : 1;
506 $bad_swap = $why > 0 && $n == 0;
507 $both_zero = $why == 0 && $n == 0;
509 if ($bad_swap || $both_zero || @_) {
510 my $arg = "'$why', '$n'";
512 $arg .= join(", ", '', map { qq['$_'] } @_);
514 die qq[$0: expected skip(why, count), got skip($arg)\n];
517 _print "ok $test # skip $why\n";
524 sub skip_if_miniperl {
525 skip(@_) if is_miniperl();
528 sub skip_without_dynamic_extension {
529 my $extension = shift;
530 skip("no dynamic loading on miniperl, no extension $extension", @_)
532 return if &_have_dynamic_extension($extension);
533 skip("extension $extension was not built", @_);
538 my $n = @_ ? shift : 1;
541 _print "not ok $test # TODO & SKIP $why\n";
550 return 0 unless $#$ra == $#$rb;
551 for my $i (0..$#$ra) {
552 next if !defined $ra->[$i] && !defined $rb->[$i];
553 return 0 if !defined $ra->[$i];
554 return 0 if !defined $rb->[$i];
555 return 0 unless $ra->[$i] eq $rb->[$i];
561 my ($orig, $suspect) = @_;
563 while (my ($key, $value) = each %$suspect) {
564 # Force a hash recompute if this perl's internals can cache the hash key.
566 if (exists $orig->{$key}) {
568 defined $orig->{$key} != defined $value
569 || (defined $value && $orig->{$key} ne $value)
571 _print "# key ", _qq($key), " was ", _qq($orig->{$key}),
572 " now ", _qq($value), "\n";
576 _print "# key ", _qq($key), " is ", _qq($value),
577 ", not in original.\n";
581 foreach (keys %$orig) {
582 # Force a hash recompute if this perl's internals can cache the hash key.
584 next if (exists $suspect->{$_});
585 _print "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
591 # We only provide a subset of the Test::More functionality.
594 if ($require =~ tr/[A-Za-z0-9:.]//c) {
595 fail("Invalid character in \"$require\", passed to require_ok");
600 is($@, '', _where(), "require $require");
606 if ($use =~ tr/[A-Za-z0-9:.]//c) {
607 fail("Invalid character in \"$use\", passed to use");
612 is($@, '', _where(), "use $use");
616 # runperl - Runs a separate perl interpreter and returns its output.
618 # switches => [ command-line switches ]
619 # nolib => 1 # don't use -I../lib (included by default)
620 # non_portable => Don't warn if a one liner contains quotes
621 # prog => one-liner (avoid quotes)
622 # progs => [ multi-liner (avoid quotes) ]
623 # progfile => perl script
624 # stdin => string to feed the stdin (or undef to redirect from /dev/null)
625 # stderr => If 'devnull' suppresses stderr, if other TRUE value redirect
627 # args => [ command-line arguments to the perl program ]
628 # verbose => print the command line
630 my $is_mswin = $^O eq 'MSWin32';
631 my $is_netware = $^O eq 'NetWare';
632 my $is_vms = $^O eq 'VMS';
633 my $is_cygwin = $^O eq 'cygwin';
636 my ($runperl, $args) = @_;
639 # In VMS protect with doublequotes because otherwise
640 # DCL will lowercase -- unless already doublequoted.
641 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
642 $runperl = $runperl . ' ' . $_;
647 sub _create_runperl { # Create the string to qx in runperl().
649 my $runperl = which_perl();
650 if ($runperl =~ m/\s/) {
651 $runperl = qq{"$runperl"};
653 #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
654 if ($ENV{PERL_RUNPERL_DEBUG}) {
655 $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
657 unless ($args{nolib}) {
658 $runperl = $runperl . ' "-I../lib" "-I." '; # doublequotes because of VMS
660 if ($args{switches}) {
662 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
663 unless ref $args{switches} eq "ARRAY";
664 $runperl = _quote_args($runperl, $args{switches});
666 if (defined $args{prog}) {
667 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
668 if defined $args{progs};
669 $args{progs} = [split /\n/, $args{prog}, -1]
671 if (defined $args{progs}) {
672 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
673 unless ref $args{progs} eq "ARRAY";
674 foreach my $prog (@{$args{progs}}) {
675 if (!$args{non_portable}) {
676 if ($prog =~ tr/'"//) {
677 warn "quotes in prog >>$prog<< are not portable";
679 if ($prog =~ /^([<>|]|2>)/) {
680 warn "Initial $1 in prog >>$prog<< is not portable";
682 if ($prog =~ /&\z/) {
683 warn "Trailing & in prog >>$prog<< is not portable";
686 if ($is_mswin || $is_netware || $is_vms) {
687 $runperl = $runperl . qq ( -e "$prog" );
690 $runperl = $runperl . qq ( -e '$prog' );
693 } elsif (defined $args{progfile}) {
694 $runperl = $runperl . qq( "$args{progfile}");
696 # You probably didn't want to be sucking in from the upstream stdin
697 die "test.pl:runperl(): none of prog, progs, progfile, args, "
698 . " switches or stdin specified"
699 unless defined $args{args} or defined $args{switches}
700 or defined $args{stdin};
702 if (defined $args{stdin}) {
703 # so we don't try to put literal newlines and crs onto the
705 $args{stdin} =~ s/\n/\\n/g;
706 $args{stdin} =~ s/\r/\\r/g;
708 if ($is_mswin || $is_netware || $is_vms) {
709 $runperl = qq{$Perl -e "print qq(} .
710 $args{stdin} . q{)" | } . $runperl;
713 $runperl = qq{$Perl -e 'print qq(} .
714 $args{stdin} . q{)' | } . $runperl;
716 } elsif (exists $args{stdin}) {
717 # Using the pipe construction above can cause fun on systems which use
718 # ksh as /bin/sh, as ksh does pipes differently (with one less process)
719 # With sh, for the command line 'perl -e 'print qq()' | perl -e ...'
720 # the sh process forks two children, which use exec to start the two
721 # perl processes. The parent shell process persists for the duration of
722 # the pipeline, and the second perl process starts with no children.
723 # With ksh (and zsh), the shell saves a process by forking a child for
724 # just the first perl process, and execing itself to start the second.
725 # This means that the second perl process starts with one child which
726 # it didn't create. This causes "fun" when if the tests assume that
727 # wait (or waitpid) will only return information about processes
728 # started within the test.
729 # They also cause fun on VMS, where the pipe implementation returns
730 # the exit code of the process at the front of the pipeline, not the
731 # end. This messes up any test using OPTION FATAL.
732 # Hence it's useful to have a way to make STDIN be at eof without
733 # needing a pipeline, so that the fork tests have a sane environment
734 # without these surprises.
736 # /dev/null appears to be surprisingly portable.
737 $runperl = $runperl . ($is_mswin ? ' <nul' : ' </dev/null');
739 if (defined $args{args}) {
740 $runperl = _quote_args($runperl, $args{args});
742 if (exists $args{stderr} && $args{stderr} eq 'devnull') {
743 $runperl = $runperl . ($is_mswin ? ' 2>nul' : ' 2>/dev/null');
745 elsif ($args{stderr}) {
746 $runperl = $runperl . ' 2>&1';
748 if ($args{verbose}) {
749 my $runperldisplay = $runperl;
750 $runperldisplay =~ s/\n/\n\#/g;
751 _print_stderr "# $runperldisplay\n";
756 # sub run_perl {} is alias to below
758 die "test.pl:runperl() does not take a hashref"
759 if ref $_[0] and ref $_[0] eq 'HASH';
760 my $runperl = &_create_runperl;
763 my $tainted = ${^TAINT};
765 exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
768 # We will assume that if you're running under -T, you really mean to
769 # run a fresh perl, so we'll brute force launder everything for you
772 if (! eval {require Config; 1}) {
773 warn "test.pl had problems loading Config: $@";
776 $sep = $Config::Config{path_sep};
779 my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
780 local @ENV{@keys} = ();
781 # Untaint, plus take out . and empty string:
782 local $ENV{'DCL$PATH'} = $1 if $is_vms && exists($ENV{'DCL$PATH'}) && ($ENV{'DCL$PATH'} =~ /(.*)/s);
783 $ENV{PATH} =~ /(.*)/s;
785 join $sep, grep { $_ ne "" and $_ ne "." and -d $_ and
786 ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
787 split quotemeta ($sep), $1;
788 if ($is_cygwin) { # Must have /bin under Cygwin
789 if (length $ENV{PATH}) {
790 $ENV{PATH} = $ENV{PATH} . $sep;
792 $ENV{PATH} = $ENV{PATH} . '/bin';
797 $result = `$runperl`;
799 $result = `$runperl`;
801 $result =~ s/\n\n/\n/g if $is_vms; # XXX pipes sometimes double these
806 *run_perl = *run_perl = \&runperl; # shut up "used only once" warning
809 _print_stderr "# @_\n";
813 # A somewhat safer version of the sometimes wrong $^X.
815 unless (defined $Perl) {
818 # VMS should have 'perl' aliased properly
819 return $Perl if $is_vms;
822 if (! eval {require Config; 1}) {
823 warn "test.pl had problems loading Config: $@";
826 $exe = $Config::Config{_exe};
828 $exe = '' unless defined $exe;
830 # This doesn't absolutize the path: beware of future chdirs().
831 # We could do File::Spec->abs2rel() but that does getcwd()s,
832 # which is a bit heavyweight to do here.
834 if ($Perl =~ /^perl\Q$exe\E$/i) {
835 my $perl = "perl$exe";
836 if (! eval {require File::Spec; 1}) {
837 warn "test.pl had problems loading File::Spec: $@";
840 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
844 # Build up the name of the executable file from the name of
847 if ($Perl !~ /\Q$exe\E$/i) {
848 $Perl = $Perl . $exe;
851 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
853 # For subcommands to use.
854 $ENV{PERLEXE} = $Perl;
861 foreach my $file (@_) {
862 1 while unlink $file;
864 _print_stderr "# Couldn't unlink '$file': $!\n";
866 $count = $count + 1; # don't use ++
872 # _num_to_alpha - Returns a string of letters representing a positive integer.
875 # maximum number of letters
877 # returns undef if the number is negative
878 # returns undef if the number of letters is greater than the maximum wanted
880 # _num_to_alpha( 0) eq 'A';
881 # _num_to_alpha( 1) eq 'B';
882 # _num_to_alpha(25) eq 'Z';
883 # _num_to_alpha(26) eq 'AA';
884 # _num_to_alpha(27) eq 'AB';
886 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);
888 # Avoid ++ -- ranges split negative numbers
890 my($num,$max_char) = @_;
891 return unless $num >= 0;
894 $max_char = 0 if $max_char < 0;
897 $alpha = $letters[ $num % 26 ] . $alpha;
898 $num = int( $num / 26 );
903 next unless $max_char;
904 $char_count = $char_count + 1;
905 return if $char_count == $max_char;
911 END { unlink_all keys %tmpfiles }
913 # A regexp that matches the tempfile names
914 $::tempfile_regexp = 'tmp\d+[A-Z][A-Z]?';
916 # Avoid ++, avoid ranges, avoid split //
917 my $tempfile_count = 0;
920 my $try = (-d "t" ? "t/" : "")."tmp$$";
921 my $alpha = _num_to_alpha($tempfile_count,2);
922 last unless defined $alpha;
923 $try = $try . $alpha;
924 $tempfile_count = $tempfile_count + 1;
926 # Need to note all the file names we allocated, as a second request may
927 # come before the first is created.
928 if (!$tmpfiles{$try} && !-e $try) {
934 die "Can't find temporary file name starting \"tmp$$\"";
937 # register_tempfile - Adds a list of files to be removed at the end of the current test file
939 # a list of files to be removed later
941 # returns a count of how many file names were actually added
943 # Reuses %tmpfiles so that tempfile() will also skip any files added here
944 # even if the file doesn't exist yet.
946 sub register_tempfile {
950 _print_stderr "# Temporary file '$_' already added\n";
959 # This is the temporary file for fresh_perl
960 my $tmpfile = tempfile();
963 my($prog, $runperl_args) = @_;
965 # Run 'runperl' with the complete perl program contained in '$prog', and
966 # arguments in the hash referred to by '$runperl_args'. The results are
967 # returned, with $? set to the exit code. Unless overridden, stderr is
968 # redirected to stdout.
970 die sprintf "Third argument to fresh_perl_.* must be hashref of args to fresh_perl (or {})"
971 unless !(defined $runperl_args) || ref($runperl_args) eq 'HASH';
973 # Given the choice of the mis-parsable {}
974 # (we want an anon hash, but a borked lexer might think that it's a block)
975 # or relying on taking a reference to a lexical
976 # (\ might be mis-parsed, and the reference counting on the pad may go
978 # it feels like the least-worse thing is to assume that auto-vivification
979 # works. At least, this is only going to be a run-time failure, so won't
980 # affect tests using this file but not this function.
981 $runperl_args->{progfile} ||= $tmpfile;
982 $runperl_args->{stderr} = 1 unless exists $runperl_args->{stderr};
984 open TEST, '>', $tmpfile or die "Cannot open $tmpfile: $!";
985 binmode TEST, ':utf8' if $runperl_args->{wide_chars};
987 close TEST or die "Cannot close $tmpfile: $!";
989 my $results = runperl(%$runperl_args);
990 my $status = $?; # Not necessary to save this, but it makes it clear to
991 # future maintainers.
993 # Clean up the results into something a bit more predictable.
994 $results =~ s/\n+$//;
995 $results =~ s/at\s+$::tempfile_regexp\s+line/at - line/g;
996 $results =~ s/of\s+$::tempfile_regexp\s+aborted/of - aborted/g;
998 # bison says 'parse error' instead of 'syntax error',
999 # various yaccs may or may not capitalize 'syntax'.
1000 $results =~ s/^(syntax|parse) error/syntax error/mig;
1003 # some tests will trigger VMS messages that won't be expected
1004 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
1006 # pipes double these sometimes
1007 $results =~ s/\n\n/\n/g;
1016 my($prog, $action, $expect, $runperl_args, $name) = @_;
1018 my $results = fresh_perl($prog, $runperl_args);
1021 # Use the first line of the program as a name if none was given
1023 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
1024 $name = $name . '...' if length $first_line > length $name;
1027 # Historically this was implemented using a closure, but then that means
1028 # that the tests for closures avoid using this code. Given that there
1029 # are exactly two callers, doing exactly two things, the simpler approach
1030 # feels like a better trade off.
1032 if ($action eq 'eq') {
1033 $pass = is($results, $expect, $name);
1034 } elsif ($action eq '=~') {
1035 $pass = like($results, $expect, $name);
1037 die "_fresh_perl can't process action '$action'";
1041 _diag "# PROG: \n$prog\n";
1042 _diag "# STATUS: $status\n";
1051 # Combination of run_perl() and is().
1055 my($prog, $expected, $runperl_args, $name) = @_;
1057 # _fresh_perl() is going to clip the trailing newlines off the result.
1058 # This will make it so the test author doesn't have to know that.
1059 $expected =~ s/\n+$//;
1062 _fresh_perl($prog, 'eq', $expected, $runperl_args, $name);
1068 # Combination of run_perl() and like().
1071 sub fresh_perl_like {
1072 my($prog, $expected, $runperl_args, $name) = @_;
1074 _fresh_perl($prog, '=~', $expected, $runperl_args, $name);
1077 # Many tests use the same format in __DATA__ or external files to specify a
1078 # sequence of (fresh) tests to run, extra files they may temporarily need, and
1079 # what the expected output is. Putting it here allows common code to serve
1080 # these multiple tests.
1082 # Each program is source code to run followed by an "EXPECT" line, followed
1083 # by the expected output.
1085 # The first line of the code to run may be a command line switch such as -wE
1086 # or -0777 (alphanumerics only; only one cluster, beginning with a minus is
1087 # allowed). Later lines may contain (note the '# ' on each):
1088 # # TODO reason for todo
1089 # # SKIP reason for skip
1090 # # SKIP ?code to test if this should be skipped
1091 # # NAME name of the test (as with ok($ok, $name))
1093 # The expected output may contain:
1094 # OPTION list of options
1095 # OPTIONS list of options
1097 # The possible options for OPTION may be:
1098 # regex - the expected output is a regular expression
1099 # random - all lines match but in any order
1100 # fatal - the code will fail fatally (croak, die)
1102 # If the actual output contains a line "SKIPPED" the test will be
1105 # If the actual output contains a line "PREFIX", any output starting with that
1106 # line will be ignored when comparing with the expected output
1108 # If the global variable $FATAL is true then OPTION fatal is the
1111 sub _setup_one_file {
1113 # Store the filename as a program that started at line 0.
1114 # Real files count lines starting at line 1.
1115 my @these = (0, shift);
1116 my ($lineno, $current);
1118 if ($_ eq "########\n") {
1119 if (defined $current) {
1120 push @these, $lineno, $current;
1124 if (!defined $current) {
1130 if (defined $current) {
1131 push @these, $lineno, $current;
1133 ((scalar @these) / 2 - 1, @these);
1136 sub setup_multiple_progs {
1138 foreach my $file (@_) {
1139 next if $file =~ /(?:~|\.orig|,v)$/;
1140 next if $file =~ /perlio$/ && !PerlIO::Layer->find('perlio');
1143 open my $fh, '<', $file or die "Cannot open $file: $!\n" ;
1147 $found = $found + 1; # don't use ++
1151 # This is an internal error, and should never happen. All bar one of
1152 # the files had an __END__ marker to signal the end of their preamble,
1153 # although for some it wasn't technically necessary as they have no
1154 # tests. It might be possible to process files without an __END__ by
1155 # seeking back to the start and treating the whole file as tests, but
1156 # it's simpler and more reliable just to make the rule that all files
1157 # must have __END__ in. This should never fail - a file without an
1158 # __END__ should not have been checked in, because the regression tests
1159 # would not have passed.
1160 die "Could not find '__END__' in $file"
1163 my ($t, @p) = _setup_one_file($fh, $file);
1168 or die "Cannot close $file: $!\n";
1170 return ($tests, @prgs);
1173 sub run_multiple_progs {
1177 # The tests in lib run in a temporary subdirectory of t, and always
1178 # pass in a list of "programs" to run
1181 # The tests below t run in t and pass in a file handle. In theory we
1182 # can pass (caller)[1] as the second argument to report errors with
1183 # the filename of our caller, as the handle is always DATA. However,
1184 # line numbers in DATA count from the __END__ token, so will be wrong.
1185 # Which is more confusing than not providing line numbers. So, for now,
1186 # don't provide line numbers. No obvious clean solution - one hack
1187 # would be to seek DATA back to the start and read to the __END__ token,
1188 # but that feels almost like we should just open $0 instead.
1190 # Not going to rely on undef in list assignment.
1192 ($dummy, @prgs) = _setup_one_file(shift);
1195 my $tmpfile = tempfile();
1199 while (defined ($line = shift @prgs)) {
1203 if (defined $file) {
1204 print "# From $file\n";
1211 if (s/^(\s*-\w+)//) {
1214 my ($prog, $expected) = split(/\nEXPECT(?:\n|$)/, $_, 2);
1217 foreach my $what (qw(skip todo)) {
1218 $prog =~ s/^#\s*\U$what\E\s*(.*)\n//m and $reason{$what} = $1;
1219 # If the SKIP reason starts ? then it's taken as a code snippet to
1220 # evaluate. This provides the flexibility to have conditional SKIPs
1221 if ($reason{$what} && $reason{$what} =~ s/^\?//) {
1222 my $temp = eval $reason{$what};
1224 die "# In \U$what\E code reason:\n# $reason{$what}\n$@";
1226 $reason{$what} = $temp;
1231 if ($prog =~ s/^#\s*NAME\s+(.+)\n//m) {
1235 if ($reason{skip}) {
1238 skip($name ? "$name - $reason{skip}" : $reason{skip}, 1);
1243 if ($prog =~ /--FILE--/) {
1244 my @files = split(/\n?--FILE--\s*([^\s\n]*)\s*\n/, $prog) ;
1246 die "Internal error: test $_ didn't split into pairs, got " .
1247 scalar(@files) . "[" . join("%%%%", @files) ."]\n"
1249 while (@files > 2) {
1250 my $filename = shift @files;
1251 my $code = shift @files;
1252 push @temps, $filename;
1253 if ($filename =~ m#(.*)/# && $filename !~ m#^\.\./#) {
1255 File::Path::mkpath($1);
1256 push(@temp_path, $1);
1258 open my $fh, '>', $filename or die "Cannot open $filename: $!\n";
1260 close $fh or die "Cannot close $filename: $!\n";
1263 $prog = shift @files;
1266 open my $fh, '>', $tmpfile or die "Cannot open >$tmpfile: $!";
1270 open STDERR, '>&', STDOUT
1271 or die "Can't dup STDOUT->STDERR: $!;";
1274 print $fh "\n#line 1\n"; # So the line numbers don't get messed up.
1275 print $fh $prog,"\n";
1276 close $fh or die "Cannot close $tmpfile: $!";
1277 my $results = runperl( stderr => 1, progfile => $tmpfile,
1279 ? (switches => ["-I$up/lib", $switch], nolib => 1)
1280 : (switches => [$switch])
1283 $results =~ s/\n+$//;
1284 # allow expected output to be written as if $prog is on STDIN
1285 $results =~ s/$::tempfile_regexp/-/g;
1287 # some tests will trigger VMS messages that won't be expected
1288 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
1290 # pipes double these sometimes
1291 $results =~ s/\n\n/\n/g;
1293 # bison says 'parse error' instead of 'syntax error',
1294 # various yaccs may or may not capitalize 'syntax'.
1295 $results =~ s/^(syntax|parse) error/syntax error/mig;
1296 # allow all tests to run when there are leaks
1297 $results =~ s/Scalars leaked: \d+\n//g;
1299 $expected =~ s/\n+$//;
1300 my $prefix = ($results =~ s#^PREFIX(\n|$)##) ;
1301 # any special options? (OPTIONS foo bar zap)
1302 my $option_regex = 0;
1303 my $option_random = 0;
1305 if ($expected =~ s/^OPTIONS? (.+)\n//) {
1306 foreach my $option (split(' ', $1)) {
1307 if ($option eq 'regex') { # allow regular expressions
1310 elsif ($option eq 'random') { # all lines match, but in any order
1313 elsif ($option eq 'fatal') { # perl should fail
1317 die "$0: Unknown OPTION '$option'\n";
1321 die "$0: can't have OPTION regex and random\n"
1322 if $option_regex + $option_random > 1;
1324 if ($results =~ s/^SKIPPED\n//) {
1325 print "$results\n" ;
1329 if ($option_random) {
1330 my @got = sort split "\n", $results;
1331 my @expected = sort split "\n", $expected;
1333 $ok = "@got" eq "@expected";
1335 elsif ($option_regex) {
1336 $ok = $results =~ /^$expected/;
1339 $ok = $results =~ /^\Q$expected/;
1342 $ok = $results eq $expected;
1345 if ($ok && $fatal && !($status >> 8)) {
1350 local $::TODO = $reason{todo};
1353 my $err_line = "PROG: $switch\n$prog\n" .
1354 "EXPECTED:\n$expected\n";
1355 $err_line .= "EXIT STATUS: != 0\n" if $fatal;
1356 $err_line .= "GOT:\n$results\n";
1357 $err_line .= "EXIT STATUS: " . ($status >> 8) . "\n" if $fatal;
1359 $err_line =~ s/^/# /mg;
1360 print $err_line; # Harness can't filter it out from STDERR.
1363 print STDERR $err_line;
1367 if (defined $file) {
1368 _ok($ok, "at $file line $line", $name);
1370 # We don't have file and line number data for the test, so report
1371 # errors as coming from our caller.
1372 local $Level = $Level + 1;
1379 foreach (@temp_path) {
1380 File::Path::rmtree $_ if -d $_;
1386 my($proto, @methods) = @_;
1387 my $class = ref $proto || $proto;
1389 unless( @methods ) {
1390 return _ok( 0, _where(), "$class->can(...)" );
1394 foreach my $method (@methods) {
1395 local($!, $@); # don't interfere with caller's $@
1396 # eval sometimes resets $!
1397 eval { $proto->can($method) } || push @nok, $method;
1401 $name = @methods == 1 ? "$class->can('$methods[0]')"
1402 : "$class->can(...)";
1404 _ok( !@nok, _where(), $name );
1408 # Call $class->new( @$args ); and run the result through object_ok.
1409 # See Test::More::new_ok
1411 my($class, $args, $obj_name) = @_;
1413 $object_name = "The object" unless defined $obj_name;
1415 local $Level = $Level + 1;
1418 my $ok = eval { $obj = $class->new(@$args); 1 };
1422 object_ok($obj, $class, $object_name);
1425 ok( 0, "new() died" );
1426 diag("Error was: $@");
1435 my($object, $class, $obj_name) = @_;
1438 $obj_name = 'The object' unless defined $obj_name;
1439 my $name = "$obj_name isa $class";
1440 if( !defined $object ) {
1441 $diag = "$obj_name isn't defined";
1444 my $whatami = ref $object ? 'object' : 'class';
1446 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
1447 local($@, $!); # eval sometimes resets $!
1448 my $rslt = eval { $object->isa($class) };
1449 my $error = $@; # in case something else blows away $@
1452 if( $error =~ /^Can't call method "isa" on unblessed reference/ ) {
1453 # It's an unblessed reference
1454 $obj_name = 'The reference' unless defined $obj_name;
1455 if( !UNIVERSAL::isa($object, $class) ) {
1456 my $ref = ref $object;
1457 $diag = "$obj_name isn't a '$class' it's a '$ref'";
1460 elsif( $error =~ /Can't call method "isa" without a package/ ) {
1461 # It's something that can't even be a class
1462 $obj_name = 'The thing' unless defined $obj_name;
1463 $diag = "$obj_name isn't a class or reference";
1467 WHOA! I tried to call ->isa on your object and got some weird error.
1468 This should never happen. Please contact the author immediately.
1475 $obj_name = "The $whatami" unless defined $obj_name;
1476 my $ref = ref $object;
1477 $diag = "$obj_name isn't a '$class' it's a '$ref'";
1481 _ok( !$diag, _where(), $name );
1486 my($class, $isa, $class_name) = @_;
1488 # Written so as to count as one test
1489 local $Level = $Level + 1;
1491 ok( 0, "$class is a reference, not a class name" );
1494 isa_ok($class, $isa, $class_name);
1500 my($obj, $isa, $obj_name) = @_;
1502 local $Level = $Level + 1;
1504 ok( 0, "$obj is not a reference" );
1507 isa_ok($obj, $isa, $obj_name);
1512 # Purposefully avoiding a closure.
1514 push @::__capture, join "", @_;
1517 sub capture_warnings {
1521 local $SIG {__WARN__} = \&__capture;
1524 return @::__capture;
1527 # This will generate a variable number of tests.
1528 # Use done_testing() instead of a fixed plan.
1530 my ($code, $expect, $name) = @_;
1531 local $Level = $Level + 1;
1533 my @w = capture_warnings($code);
1535 cmp_ok(scalar @w, '==', scalar @$expect, $name);
1536 foreach my $e (@$expect) {
1538 like(shift @w, $e, $name);
1540 is(shift @w, $e, $name);
1544 diag("Saw these additional warnings:");
1545 diag($_) foreach @w;
1549 sub _fail_excess_warnings {
1550 my($expect, $got, $name) = @_;
1551 local $Level = $Level + 1;
1552 # This will fail, and produce diagnostics
1553 is($expect, scalar @$got, $name);
1554 diag("Saw these warnings:");
1555 diag($_) foreach @$got;
1559 my ($code, $expect, $name) = @_;
1560 die sprintf "Expect must be a string or undef, not a %s reference", ref $expect
1562 local $Level = $Level + 1;
1563 my @w = capture_warnings($code);
1565 _fail_excess_warnings(0 + defined $expect, \@w, $name);
1567 is($w[0], $expect, $name);
1572 my ($code, $expect, $name) = @_;
1573 die sprintf "Expect must be a regexp object"
1574 unless ref $expect eq 'Regexp';
1575 local $Level = $Level + 1;
1576 my @w = capture_warnings($code);
1578 _fail_excess_warnings(0 + defined $expect, \@w, $name);
1580 like($w[0], $expect, $name);
1584 # Set a watchdog to timeout the entire test file
1585 # NOTE: If the test file uses 'threads', then call the watchdog() function
1586 # _AFTER_ the 'threads' module is loaded.
1589 my $timeout = shift;
1590 my $method = shift || "";
1591 my $timeout_msg = 'Test process timed out - terminating';
1593 # Valgrind slows perl way down so give it more time before dying.
1594 $timeout *= 10 if $ENV{PERL_VALGRIND};
1596 my $pid_to_kill = $$; # PID for this process
1598 if ($method eq "alarm") {
1599 goto WATCHDOG_VIA_ALARM;
1602 # shut up use only once warning
1603 my $threads_on = $threads::threads && $threads::threads;
1605 # Don't use a watchdog process if 'threads' is loaded -
1606 # use a watchdog thread instead
1607 if (!$threads_on || $method eq "process") {
1609 # On Windows and VMS, try launching a watchdog process
1610 # using system(1, ...) (see perlport.pod)
1611 if ($is_mswin || $is_vms) {
1612 # On Windows, try to get the 'real' PID
1614 eval { require Win32; };
1615 if (defined(&Win32::GetCurrentProcessId)) {
1616 $pid_to_kill = Win32::GetCurrentProcessId();
1620 # If we still have a fake PID, we can't use this method at all
1621 return if ($pid_to_kill <= 0);
1623 # Launch watchdog process
1626 local $SIG{'__WARN__'} = sub {
1627 _diag("Watchdog warning: $_[0]");
1629 my $sig = $is_vms ? 'TERM' : 'KILL';
1630 my $prog = "sleep($timeout);" .
1631 "warn qq/# $timeout_msg" . '\n/;' .
1632 "kill(q/$sig/, $pid_to_kill);";
1634 # On Windows use the indirect object plus LIST form to guarantee
1635 # that perl is launched directly rather than via the shell (see
1636 # perlfunc.pod), and ensure that the LIST has multiple elements
1637 # since the indirect object plus COMMANDSTRING form seems to
1638 # hang (see perl #121283). Don't do this on VMS, which doesn't
1639 # support the LIST form at all.
1641 my $runperl = which_perl();
1642 if ($runperl =~ m/\s/) {
1643 $runperl = qq{"$runperl"};
1645 $watchdog = system({ $runperl } 1, $runperl, '-e', $prog);
1648 my $cmd = _create_runperl(prog => $prog);
1649 $watchdog = system(1, $cmd);
1652 if ($@ || ($watchdog <= 0)) {
1653 _diag('Failed to start watchdog');
1659 # Add END block to parent to terminate and
1660 # clean up watchdog process
1661 eval("END { local \$! = 0; local \$? = 0;
1662 wait() if kill('KILL', $watchdog); };");
1666 # Try using fork() to generate a watchdog process
1668 eval { $watchdog = fork() };
1669 if (defined($watchdog)) {
1670 if ($watchdog) { # Parent process
1671 # Add END block to parent to terminate and
1672 # clean up watchdog process
1673 eval "END { local \$! = 0; local \$? = 0;
1674 wait() if kill('KILL', $watchdog); };";
1678 ### Watchdog process code
1680 # Load POSIX if available
1681 eval { require POSIX; };
1683 # Execute the timeout
1684 sleep($timeout - 2) if ($timeout > 2); # Workaround for perlbug #49073
1687 # Kill test process if still running
1688 if (kill(0, $pid_to_kill)) {
1689 _diag($timeout_msg);
1690 kill('KILL', $pid_to_kill);
1692 # sometimes the above isn't enough on cygwin
1693 sleep 1; # wait a little, it might have worked after all
1694 system("/bin/kill -f $pid_to_kill");
1698 # Don't execute END block (added at beginning of this file)
1701 # Terminate ourself (i.e., the watchdog)
1702 POSIX::_exit(1) if (defined(&POSIX::_exit));
1706 # fork() failed - fall through and try using a thread
1709 # Use a watchdog thread because either 'threads' is loaded,
1711 if (eval {require threads; 1}) {
1712 'threads'->create(sub {
1713 # Load POSIX if available
1714 eval { require POSIX; };
1716 # Execute the timeout
1717 my $time_left = $timeout;
1719 $time_left = $time_left - sleep($time_left);
1720 } while ($time_left > 0);
1722 # Kill the parent (and ourself)
1723 select(STDERR); $| = 1;
1724 _diag($timeout_msg);
1725 POSIX::_exit(1) if (defined(&POSIX::_exit));
1726 my $sig = $is_vms ? 'TERM' : 'KILL';
1727 kill($sig, $pid_to_kill);
1732 # If everything above fails, then just use an alarm timeout
1734 if (eval { alarm($timeout); 1; }) {
1735 # Load POSIX if available
1736 eval { require POSIX; };
1738 # Alarm handler will do the actual 'killing'
1739 $SIG{'ALRM'} = sub {
1740 select(STDERR); $| = 1;
1741 _diag($timeout_msg);
1742 POSIX::_exit(1) if (defined(&POSIX::_exit));
1743 my $sig = $is_vms ? 'TERM' : 'KILL';
1744 kill($sig, $pid_to_kill);
1749 # Orphaned Docker or Linux containers do not necessarily attach to PID 1. They might attach to 0 instead.
1750 sub is_linux_container {
1752 if ($^O eq 'linux' && open my $fh, '<', '/proc/1/cgroup') {
1754 if (m{^\d+:pids:(.*)} && $1 ne '/init.scope') {