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
31 if ($n eq 'no_plan') {
39 print STDOUT "1..$n\n" unless $noplan;
46 if (defined $planned && $planned != $ran) {
48 "# Looks like you planned $planned tests but ran $ran.\n";
55 # Use this instead of "print STDERR" when outputing failure diagnostic
59 my @mess = map { /^#/ ? "$_\n" : "# $_\n" }
60 map { split /\n/ } @_;
61 my $fh = $TODO ? *STDOUT : *STDERR;
72 print STDOUT "1..0 # Skipped: @_\n";
74 print STDOUT "1..0\n";
80 my ($pass, $where, $name, @mess) = @_;
81 # Do not try to microoptimize by factoring out the "not ".
85 # escape out '#' or it will interfere with '# skip' and such
87 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
89 $out = $pass ? "ok $test" : "not ok $test";
92 $out .= " # TODO $TODO" if $TODO;
93 print STDOUT "$out\n";
96 _diag "# Failed $where\n";
99 # Ensure that the message is properly escaped.
102 $test = $test + 1; # don't use ++
108 my @caller = caller($Level);
109 return "at $caller[1] line $caller[2]";
112 # DON'T use this for matches. Use like() instead.
114 my ($pass, $name, @mess) = @_;
115 _ok($pass, _where(), $name, @mess);
120 return 'undef' unless defined $x;
129 return defined $x ? '"' . display ($x) . '"' : 'undef';
132 # keys are the codes \n etc map to, values are 2 char strings such as \n
133 my %backslash_escape;
134 foreach my $x (split //, 'nrtfa\\\'"') {
135 $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
137 # A way to display scalars containing control characters and Unicode.
138 # Trying to avoid setting $_, or relying on local $_ to work.
142 if (defined $x and not ref $x) {
144 foreach my $c (unpack("U*", $x)) {
146 $y .= sprintf "\\x{%x}", $c;
147 } elsif ($backslash_escape{$c}) {
148 $y .= $backslash_escape{$c};
150 my $z = chr $c; # Maybe we can get away with a literal...
151 $z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/;
157 return $x unless wantarray;
164 my ($got, $expected, $name, @mess) = @_;
167 if( !defined $got || !defined $expected ) {
168 # undef only matches undef
169 $pass = !defined $got && !defined $expected;
172 $pass = $got eq $expected;
176 unshift(@mess, "# got "._q($got)."\n",
177 "# expected "._q($expected)."\n");
179 _ok($pass, _where(), $name, @mess);
183 my ($got, $isnt, $name, @mess) = @_;
186 if( !defined $got || !defined $isnt ) {
187 # undef only matches undef
188 $pass = defined $got || defined $isnt;
191 $pass = $got ne $isnt;
195 unshift(@mess, "# it should not be "._q($got)."\n",
198 _ok($pass, _where(), $name, @mess);
202 my($got, $type, $expected, $name, @mess) = @_;
207 local($@,$!); # don't interfere with $@
208 # eval() sometimes resets $!
209 $pass = eval "\$got $type \$expected";
212 # It seems Irix long doubles can have 2147483648 and 2147483648
213 # that stringify to the same thing but are acutally numerically
214 # different. Display the numbers if $type isn't a string operator,
215 # and the numbers are stringwise the same.
216 # (all string operators have alphabetic names, so tr/a-z// is true)
217 # This will also show numbers for some uneeded cases, but will
218 # definately be helpful for things such as == and <= that fail
219 if ($got eq $expected and $type !~ tr/a-z//) {
220 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
222 unshift(@mess, "# got "._q($got)."\n",
223 "# expected $type "._q($expected)."\n");
225 _ok($pass, _where(), $name, @mess);
228 # Check that $got is within $range of $expected
229 # if $range is 0, then check it's exact
230 # else if $expected is 0, then $range is an absolute value
231 # otherwise $range is a fractional error.
232 # Here $range must be numeric, >= 0
233 # Non numeric ranges might be a useful future extension. (eg %)
235 my ($got, $expected, $range, $name, @mess) = @_;
237 if (!defined $got or !defined $expected or !defined $range) {
238 # This is a fail, but doesn't need extra diagnostics
239 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
241 unshift @mess, "# got, expected and range must be numeric\n";
242 } elsif ($range < 0) {
243 # This is also a fail
244 unshift @mess, "# range must not be negative\n";
245 } elsif ($range == 0) {
247 $pass = $got == $expected;
248 } elsif ($expected == 0) {
249 # If expected is 0, treat range as absolute
250 $pass = ($got <= $range) && ($got >= - $range);
252 my $diff = $got - $expected;
253 $pass = abs ($diff / $expected) < $range;
256 if ($got eq $expected) {
257 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
259 unshift@mess, "# got "._q($got)."\n",
260 "# expected "._q($expected)." (within "._q($range).")\n";
262 _ok($pass, _where(), $name, @mess);
265 # Note: this isn't quite as fancy as Test::More::like().
267 sub like ($$@) { like_yn (0,@_) }; # 0 for -
268 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
271 my ($flip, $got, $expected, $name, @mess) = @_;
273 $pass = $got =~ /$expected/ if !$flip;
274 $pass = $got !~ /$expected/ if $flip;
276 unshift(@mess, "# got '$got'\n",
277 "# expected /$expected/\n");
280 _ok($pass, _where(), $name, @mess);
288 _ok(0, _where(), @_);
298 $test = $test + 1; # don't use ++
302 # Note: can't pass multipart messages since we try to
303 # be compatible with Test::More::skip().
306 my $n = @_ ? shift : 1;
308 print STDOUT "ok $test # skip: $why\n";
317 my $n = @_ ? shift : 1;
320 print STDOUT "not ok $test # TODO & SKIP: $why\n";
329 return 0 unless $#$ra == $#$rb;
330 for my $i (0..$#$ra) {
331 next if !defined $ra->[$i] && !defined $rb->[$i];
332 return 0 if !defined $ra->[$i];
333 return 0 if !defined $rb->[$i];
334 return 0 unless $ra->[$i] eq $rb->[$i];
340 my ($orig, $suspect) = @_;
342 while (my ($key, $value) = each %$suspect) {
343 # Force a hash recompute if this perl's internals can cache the hash key.
345 if (exists $orig->{$key}) {
346 if ($orig->{$key} ne $value) {
347 print STDOUT "# key ", _qq($key), " was ", _qq($orig->{$key}),
348 " now ", _qq($value), "\n";
352 print STDOUT "# key ", _qq($key), " is ", _qq($value),
353 ", not in original.\n";
357 foreach (keys %$orig) {
358 # Force a hash recompute if this perl's internals can cache the hash key.
360 next if (exists $suspect->{$_});
361 print STDOUT "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
372 _ok(!$@, _where(), "require $require");
380 _ok(!$@, _where(), "use $use");
383 # runperl - Runs a separate perl interpreter.
385 # switches => [ command-line switches ]
386 # nolib => 1 # don't use -I../lib (included by default)
387 # prog => one-liner (avoid quotes)
388 # progs => [ multi-liner (avoid quotes) ]
389 # progfile => perl script
390 # stdin => string to feed the stdin
391 # stderr => redirect stderr to stdout
392 # args => [ command-line arguments to the perl program ]
393 # verbose => print the command line
395 my $is_mswin = $^O eq 'MSWin32';
396 my $is_netware = $^O eq 'NetWare';
397 my $is_macos = $^O eq 'MacOS';
398 my $is_vms = $^O eq 'VMS';
401 my ($runperl, $args) = @_;
404 # In VMS protect with doublequotes because otherwise
405 # DCL will lowercase -- unless already doublequoted.
406 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
407 $$runperl .= ' ' . $_;
411 sub _create_runperl { # Create the string to qx in runperl().
413 my $runperl = $^X =~ m/\s/ ? qq{"$^X"} : $^X;
414 #- this allows, for example, to set PERL_RUNPERL_DEBUG=/usr/bin/valgrind
415 if ($ENV{PERL_RUNPERL_DEBUG}) {
416 $runperl = "$ENV{PERL_RUNPERL_DEBUG} $runperl";
418 unless ($args{nolib}) {
420 $runperl .= ' -I::lib';
421 # Use UNIX style error messages instead of MPW style.
422 $runperl .= ' -MMac::err=unix' if $args{stderr};
425 $runperl .= ' "-I../lib"'; # doublequotes because of VMS
428 if ($args{switches}) {
430 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
431 unless ref $args{switches} eq "ARRAY";
432 _quote_args(\$runperl, $args{switches});
434 if (defined $args{prog}) {
435 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
436 if defined $args{progs};
437 $args{progs} = [$args{prog}]
439 if (defined $args{progs}) {
440 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
441 unless ref $args{progs} eq "ARRAY";
442 foreach my $prog (@{$args{progs}}) {
443 if ($is_mswin || $is_netware || $is_vms) {
444 $runperl .= qq ( -e "$prog" );
447 $runperl .= qq ( -e '$prog' );
450 } elsif (defined $args{progfile}) {
451 $runperl .= qq( "$args{progfile}");
453 # You probaby didn't want to be sucking in from the upstream stdin
454 die "test.pl:runperl(): none of prog, progs, progfile, args, "
455 . " switches or stdin specified"
456 unless defined $args{args} or defined $args{switches}
457 or defined $args{stdin};
459 if (defined $args{stdin}) {
460 # so we don't try to put literal newlines and crs onto the
462 $args{stdin} =~ s/\n/\\n/g;
463 $args{stdin} =~ s/\r/\\r/g;
465 if ($is_mswin || $is_netware || $is_vms) {
466 $runperl = qq{$^X -e "print qq(} .
467 $args{stdin} . q{)" | } . $runperl;
470 # MacOS can only do two processes under MPW at once;
471 # the test itself is one; we can't do two more, so
473 my $stdin = qq{$^X -e 'print qq(} . $args{stdin} . qq{)' > teststdin; };
474 if ($args{verbose}) {
475 my $stdindisplay = $stdin;
476 $stdindisplay =~ s/\n/\n\#/g;
477 print STDERR "# $stdindisplay\n";
480 $runperl .= q{ < teststdin };
483 $runperl = qq{$^X -e 'print qq(} .
484 $args{stdin} . q{)' | } . $runperl;
487 if (defined $args{args}) {
488 _quote_args(\$runperl, $args{args});
490 $runperl .= ' 2>&1' if $args{stderr} && !$is_macos;
491 $runperl .= " \xB3 Dev:Null" if !$args{stderr} && $is_macos;
492 if ($args{verbose}) {
493 my $runperldisplay = $runperl;
494 $runperldisplay =~ s/\n/\n\#/g;
495 print STDERR "# $runperldisplay\n";
501 die "test.pl:runperl() does not take a hashref"
502 if ref $_[0] and ref $_[0] eq 'HASH';
503 my $runperl = &_create_runperl;
506 my $tainted = ${^TAINT};
508 exists $args{switches} && grep m/^-T$/, @{$args{switches}} and $tainted = $tainted + 1;
511 # We will assume that if you're running under -T, you really mean to
512 # run a fresh perl, so we'll brute force launder everything for you
515 eval "require Config; Config->import";
517 warn "test.pl had problems loading Config: $@";
520 $sep = $Config{path_sep};
523 my @keys = grep {exists $ENV{$_}} qw(CDPATH IFS ENV BASH_ENV);
524 local @ENV{@keys} = ();
525 # Untaint, plus take out . and empty string:
526 local $ENV{'DCL$PATH'} = $1 if $is_vms && ($ENV{'DCL$PATH'} =~ /(.*)/s);
527 $ENV{PATH} =~ /(.*)/s;
529 join $sep, grep { $_ ne "" and $_ ne "." and
530 ($is_mswin or $is_vms or !(stat && (stat _)[2]&0022)) }
531 split quotemeta ($sep), $1;
536 $result = `$runperl`;
538 $result = `$runperl`;
540 $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
544 *run_perl = \&runperl; # Nice alias.
547 print STDERR "# @_\n";
551 # A somewhat safer version of the sometimes wrong $^X.
554 unless (defined $Perl) {
557 # VMS should have 'perl' aliased properly
558 return $Perl if $^O eq 'VMS';
561 eval "require Config; Config->import";
563 warn "test.pl had problems loading Config: $@";
566 $exe = $Config{_exe};
568 $exe = '' unless defined $exe;
570 # This doesn't absolutize the path: beware of future chdirs().
571 # We could do File::Spec->abs2rel() but that does getcwd()s,
572 # which is a bit heavyweight to do here.
574 if ($Perl =~ /^perl\Q$exe\E$/i) {
575 my $perl = "perl$exe";
576 eval "require File::Spec";
578 warn "test.pl had problems loading File::Spec: $@";
581 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
585 # Build up the name of the executable file from the name of
588 if ($Perl !~ /\Q$exe\E$/i) {
592 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
594 # For subcommands to use.
595 $ENV{PERLEXE} = $Perl;
601 foreach my $file (@_) {
602 1 while unlink $file;
603 print STDERR "# Couldn't unlink '$file': $!\n" if -f $file;
608 my $tmpfile = "misctmp000";
609 1 while -f ++$tmpfile;
610 END { unlink_all $tmpfile }
615 # The $resolve must be a subref that tests the first argument
616 # for success, or returns the definition of success (e.g. the
617 # expected scalar) if given no arguments.
621 my($prog, $resolve, $runperl_args, $name) = @_;
623 $runperl_args ||= {};
624 $runperl_args->{progfile} = $tmpfile;
625 $runperl_args->{stderr} = 1;
627 open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
631 $prog =~ s#/dev/null#NL:#;
634 $prog =~ s{if \(-e _ and -f _ and -r _\)}
639 close TEST or die "Cannot close $tmpfile: $!";
641 my $results = runperl(%$runperl_args);
644 # Clean up the results into something a bit more predictable.
645 $results =~ s/\n+$//;
646 $results =~ s/at\s+misctmp\d+\s+line/at - line/g;
647 $results =~ s/of\s+misctmp\d+\s+aborted/of - aborted/g;
649 # bison says 'parse error' instead of 'syntax error',
650 # various yaccs may or may not capitalize 'syntax'.
651 $results =~ s/^(syntax|parse) error/syntax error/mig;
654 # some tests will trigger VMS messages that won't be expected
655 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
657 # pipes double these sometimes
658 $results =~ s/\n\n/\n/g;
661 my $pass = $resolve->($results);
663 _diag "# PROG: \n$prog\n";
664 _diag "# EXPECTED:\n", $resolve->(), "\n";
665 _diag "# GOT:\n$results\n";
666 _diag "# STATUS: $status\n";
669 # Use the first line of the program as a name if none was given
671 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
672 $name .= '...' if length $first_line > length $name;
675 _ok($pass, _where(), "fresh_perl - $name");
681 # Combination of run_perl() and is().
685 my($prog, $expected, $runperl_args, $name) = @_;
688 sub { @_ ? $_[0] eq $expected : $expected },
689 $runperl_args, $name);
695 # Combination of run_perl() and like().
698 sub fresh_perl_like {
699 my($prog, $expected, $runperl_args, $name) = @_;
703 $_[0] =~ (ref $expected ? $expected : /$expected/) :
705 $runperl_args, $name);
709 my($proto, @methods) = @_;
710 my $class = ref $proto || $proto;
713 return _ok( 0, _where(), "$class->can(...)" );
717 foreach my $method (@methods) {
718 local($!, $@); # don't interfere with caller's $@
719 # eval sometimes resets $!
720 eval { $proto->can($method) } || push @nok, $method;
724 $name = @methods == 1 ? "$class->can('$methods[0]')"
725 : "$class->can(...)";
727 _ok( !@nok, _where(), $name );
731 my($object, $class, $obj_name) = @_;
734 $obj_name = 'The object' unless defined $obj_name;
735 my $name = "$obj_name isa $class";
736 if( !defined $object ) {
737 $diag = "$obj_name isn't defined";
739 elsif( !ref $object ) {
740 $diag = "$obj_name isn't a reference";
743 # We can't use UNIVERSAL::isa because we want to honor isa() overrides
744 local($@, $!); # eval sometimes resets $!
745 my $rslt = eval { $object->isa($class) };
747 if( $@ =~ /^Can't call method "isa" on unblessed reference/ ) {
748 if( !UNIVERSAL::isa($object, $class) ) {
749 my $ref = ref $object;
750 $diag = "$obj_name isn't a '$class' it's a '$ref'";
754 WHOA! I tried to call ->isa on your object and got some weird error.
755 This should never happen. Please contact the author immediately.
762 my $ref = ref $object;
763 $diag = "$obj_name isn't a '$class' it's a '$ref'";
767 _ok( !$diag, _where(), $name );