2 # t/test.pl - most of Test::More functionality without the fuss
17 if ($n eq 'no_plan') {
25 print STDOUT "1..$n\n" unless $noplan;
32 if (defined $planned && $planned != $ran) {
34 "# Looks like you planned $planned tests but ran $ran.\n";
41 # Use this instead of "print STDERR" when outputing failure diagnostic
45 my @mess = map { /^#/ ? "$_\n" : "# $_\n" }
46 map { split /\n/ } @_;
47 my $fh = $TODO ? *STDOUT : *STDERR;
54 print STDOUT "1..0 # Skipped: @_\n";
56 print STDOUT "1..0\n";
62 my ($pass, $where, $name, @mess) = @_;
63 # Do not try to microoptimize by factoring out the "not ".
67 # escape out '#' or it will interfere with '# skip' and such
69 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
71 $out = $pass ? "ok $test" : "not ok $test";
74 $out .= " # TODO $TODO" if $TODO;
75 print STDOUT "$out\n";
78 _diag "# Failed $where\n";
81 # Ensure that the message is properly escaped.
90 my @caller = caller($Level);
91 return "at $caller[1] line $caller[2]";
94 # DON'T use this for matches. Use like() instead.
96 my ($pass, $name, @mess) = @_;
97 _ok($pass, _where(), $name, @mess);
102 return 'undef' unless defined $x;
111 return defined $x ? '"' . display ($x) . '"' : 'undef';
114 # keys are the codes \n etc map to, values are 2 char strings such as \n
115 my %backslash_escape;
116 foreach my $x (split //, 'nrtfa\\\'"') {
117 $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
119 # A way to display scalars containing control characters and Unicode.
120 # Trying to avoid setting $_, or relying on local $_ to work.
124 if (defined $x and not ref $x) {
126 foreach my $c (unpack("U*", $x)) {
128 $y .= sprintf "\\x{%x}", $c;
129 } elsif ($backslash_escape{$c}) {
130 $y .= $backslash_escape{$c};
132 my $z = chr $c; # Maybe we can get away with a literal...
133 $z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/;
139 return $x unless wantarray;
146 my ($got, $expected, $name, @mess) = @_;
149 if( !defined $got || !defined $expected ) {
150 # undef only matches undef
151 $pass = !defined $got && !defined $expected;
154 $pass = $got eq $expected;
158 unshift(@mess, "# got "._q($got)."\n",
159 "# expected "._q($expected)."\n");
161 _ok($pass, _where(), $name, @mess);
165 my ($got, $isnt, $name, @mess) = @_;
168 if( !defined $got || !defined $isnt ) {
169 # undef only matches undef
170 $pass = defined $got || defined $isnt;
173 $pass = $got ne $isnt;
177 unshift(@mess, "# it should not be "._q($got)."\n",
180 _ok($pass, _where(), $name, @mess);
184 my($got, $type, $expected, $name, @mess) = @_;
189 local($@,$!); # don't interfere with $@
190 # eval() sometimes resets $!
191 $pass = eval "\$got $type \$expected";
194 # It seems Irix long doubles can have 2147483648 and 2147483648
195 # that stringify to the same thing but are acutally numerically
196 # different. Display the numbers if $type isn't a string operator,
197 # and the numbers are stringwise the same.
198 # (all string operators have alphabetic names, so tr/a-z// is true)
199 # This will also show numbers for some uneeded cases, but will
200 # definately be helpful for things such as == and <= that fail
201 if ($got eq $expected and $type !~ tr/a-z//) {
202 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
204 unshift(@mess, "# got "._q($got)."\n",
205 "# expected $type "._q($expected)."\n");
207 _ok($pass, _where(), $name, @mess);
210 # Check that $got is within $range of $expected
211 # if $range is 0, then check it's exact
212 # else if $expected is 0, then $range is an absolute value
213 # otherwise $range is a fractional error.
214 # Here $range must be numeric, >= 0
215 # Non numeric ranges might be a useful future extension. (eg %)
217 my ($got, $expected, $range, $name, @mess) = @_;
219 if (!defined $got or !defined $expected or !defined $range) {
220 # This is a fail, but doesn't need extra diagnostics
221 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
223 unshift @mess, "# got, expected and range must be numeric\n";
224 } elsif ($range < 0) {
225 # This is also a fail
226 unshift @mess, "# range must not be negative\n";
227 } elsif ($range == 0) {
229 $pass = $got == $expected;
230 } elsif ($expected == 0) {
231 # If expected is 0, treat range as absolute
232 $pass = ($got <= $range) && ($got >= - $range);
234 my $diff = $got - $expected;
235 $pass = abs ($diff / $expected) < $range;
238 if ($got eq $expected) {
239 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
241 unshift@mess, "# got "._q($got)."\n",
242 "# expected "._q($expected)." (within "._q($range).")\n";
244 _ok($pass, _where(), $name, @mess);
247 # Note: this isn't quite as fancy as Test::More::like().
249 sub like ($$@) { like_yn (0,@_) }; # 0 for -
250 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
253 my ($flip, $got, $expected, $name, @mess) = @_;
255 $pass = $got =~ /$expected/ if !$flip;
256 $pass = $got !~ /$expected/ if $flip;
258 unshift(@mess, "# got '$got'\n",
259 "# expected /$expected/\n");
261 _ok($pass, _where(), $name, @mess);
269 _ok(0, _where(), @_);
281 # Note: can't pass multipart messages since we try to
282 # be compatible with Test::More::skip().
285 my $n = @_ ? shift : 1;
287 print STDOUT "ok $test # skip: $why\n";
296 return 0 unless $#$ra == $#$rb;
297 for my $i (0..$#$ra) {
298 next if !defined $ra->[$i] && !defined $rb->[$i];
299 return 0 if !defined $ra->[$i];
300 return 0 if !defined $rb->[$i];
301 return 0 unless $ra->[$i] eq $rb->[$i];
307 my ($orig, $suspect) = @_;
309 while (my ($key, $value) = each %$suspect) {
310 # Force a hash recompute if this perl's internals can cache the hash key.
312 if (exists $orig->{$key}) {
313 if ($orig->{$key} ne $value) {
314 print STDOUT "# key ", _qq($key), " was ", _qq($orig->{$key}),
315 " now ", _qq($value), "\n";
319 print STDOUT "# key ", _qq($key), " is ", _qq($value),
320 ", not in original.\n";
324 foreach (keys %$orig) {
325 # Force a hash recompute if this perl's internals can cache the hash key.
327 next if (exists $suspect->{$_});
328 print STDOUT "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
339 _ok(!$@, _where(), "require $require");
347 _ok(!$@, _where(), "use $use");
350 # runperl - Runs a separate perl interpreter.
352 # switches => [ command-line switches ]
353 # nolib => 1 # don't use -I../lib (included by default)
354 # prog => one-liner (avoid quotes)
355 # progs => [ multi-liner (avoid quotes) ]
356 # progfile => perl script
357 # stdin => string to feed the stdin
358 # stderr => redirect stderr to stdout
359 # args => [ command-line arguments to the perl program ]
360 # verbose => print the command line
362 my $is_mswin = $^O eq 'MSWin32';
363 my $is_netware = $^O eq 'NetWare';
364 my $is_macos = $^O eq 'MacOS';
365 my $is_vms = $^O eq 'VMS';
368 my ($runperl, $args) = @_;
371 # In VMS protect with doublequotes because otherwise
372 # DCL will lowercase -- unless already doublequoted.
373 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
374 $$runperl .= ' ' . $_;
378 sub _create_runperl { # Create the string to qx in runperl().
380 my $runperl = $^X =~ m/\s/ ? qq{"$^X"} : $^X;
381 unless ($args{nolib}) {
383 $runperl .= ' -I::lib';
384 # Use UNIX style error messages instead of MPW style.
385 $runperl .= ' -MMac::err=unix' if $args{stderr};
388 $runperl .= ' "-I../lib"'; # doublequotes because of VMS
391 if ($args{switches}) {
393 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
394 unless ref $args{switches} eq "ARRAY";
395 _quote_args(\$runperl, $args{switches});
397 if (defined $args{prog}) {
398 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
399 if defined $args{progs};
400 $args{progs} = [$args{prog}]
402 if (defined $args{progs}) {
403 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
404 unless ref $args{progs} eq "ARRAY";
405 foreach my $prog (@{$args{progs}}) {
406 if ($is_mswin || $is_netware || $is_vms) {
407 $runperl .= qq ( -e "$prog" );
410 $runperl .= qq ( -e '$prog' );
413 } elsif (defined $args{progfile}) {
414 $runperl .= qq( "$args{progfile}");
416 if (defined $args{stdin}) {
417 # so we don't try to put literal newlines and crs onto the
419 $args{stdin} =~ s/\n/\\n/g;
420 $args{stdin} =~ s/\r/\\r/g;
422 if ($is_mswin || $is_netware || $is_vms) {
423 $runperl = qq{$^X -e "print qq(} .
424 $args{stdin} . q{)" | } . $runperl;
427 # MacOS can only do two processes under MPW at once;
428 # the test itself is one; we can't do two more, so
430 my $stdin = qq{$^X -e 'print qq(} . $args{stdin} . qq{)' > teststdin; };
431 if ($args{verbose}) {
432 my $stdindisplay = $stdin;
433 $stdindisplay =~ s/\n/\n\#/g;
434 print STDERR "# $stdindisplay\n";
437 $runperl .= q{ < teststdin };
440 $runperl = qq{$^X -e 'print qq(} .
441 $args{stdin} . q{)' | } . $runperl;
444 if (defined $args{args}) {
445 _quote_args(\$runperl, $args{args});
447 $runperl .= ' 2>&1' if $args{stderr} && !$is_macos;
448 $runperl .= " \xB3 Dev:Null" if !$args{stderr} && $is_macos;
449 if ($args{verbose}) {
450 my $runperldisplay = $runperl;
451 $runperldisplay =~ s/\n/\n\#/g;
452 print STDERR "# $runperldisplay\n";
458 my $runperl = &_create_runperl;
459 my $result = `$runperl`;
460 $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
464 *run_perl = \&runperl; # Nice alias.
467 print STDERR "# @_\n";
471 # A somewhat safer version of the sometimes wrong $^X.
474 unless (defined $Perl) {
477 # VMS should have 'perl' aliased properly
478 return $Perl if $^O eq 'VMS';
481 eval "require Config; Config->import";
483 warn "test.pl had problems loading Config: $@";
486 $exe = $Config{_exe};
488 $exe = '' unless defined $exe;
490 # This doesn't absolutize the path: beware of future chdirs().
491 # We could do File::Spec->abs2rel() but that does getcwd()s,
492 # which is a bit heavyweight to do here.
494 if ($Perl =~ /^perl\Q$exe\E$/i) {
495 my $perl = "perl$exe";
496 eval "require File::Spec";
498 warn "test.pl had problems loading File::Spec: $@";
501 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
505 # Build up the name of the executable file from the name of
508 if ($Perl !~ /\Q$exe\E$/i) {
512 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
514 # For subcommands to use.
515 $ENV{PERLEXE} = $Perl;
521 foreach my $file (@_) {
522 1 while unlink $file;
523 print STDERR "# Couldn't unlink '$file': $!\n" if -f $file;
528 my $tmpfile = "misctmp000";
529 1 while -f ++$tmpfile;
530 END { unlink_all $tmpfile }
535 # The $resolve must be a subref that tests the first argument
536 # for success, or returns the definition of success (e.g. the
537 # expected scalar) if given no arguments.
541 my($prog, $resolve, $runperl_args, $name) = @_;
543 $runperl_args ||= {};
544 $runperl_args->{progfile} = $tmpfile;
545 $runperl_args->{stderr} = 1;
547 open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
551 $prog =~ s#/dev/null#NL:#;
554 $prog =~ s{if \(-e _ and -f _ and -r _\)}
558 print TEST $prog, "\n";
559 close TEST or die "Cannot close $tmpfile: $!";
561 my $results = runperl(%$runperl_args);
564 # Clean up the results into something a bit more predictable.
565 $results =~ s/\n+$//;
566 $results =~ s/at\s+misctmp\d+\s+line/at - line/g;
567 $results =~ s/of\s+misctmp\d+\s+aborted/of - aborted/g;
569 # bison says 'parse error' instead of 'syntax error',
570 # various yaccs may or may not capitalize 'syntax'.
571 $results =~ s/^(syntax|parse) error/syntax error/mig;
574 # some tests will trigger VMS messages that won't be expected
575 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
577 # pipes double these sometimes
578 $results =~ s/\n\n/\n/g;
581 my $pass = $resolve->($results);
583 _diag "# PROG: \n$prog\n";
584 _diag "# EXPECTED:\n", $resolve->(), "\n";
585 _diag "# GOT:\n$results\n";
586 _diag "# STATUS: $status\n";
589 # Use the first line of the program as a name if none was given
591 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
592 $name .= '...' if length $first_line > length $name;
595 _ok($pass, _where(), "fresh_perl - $name");
601 # Combination of run_perl() and is().
605 my($prog, $expected, $runperl_args, $name) = @_;
608 sub { @_ ? $_[0] eq $expected : $expected },
609 $runperl_args, $name);
615 # Combination of run_perl() and like().
618 sub fresh_perl_like {
619 my($prog, $expected, $runperl_args, $name) = @_;
623 $_[0] =~ (ref $expected ? $expected : /$expected/) :
625 $runperl_args, $name);