2 # t/test.pl - most of Test::More functionality without the fuss
20 print STDOUT "1..$n\n";
26 if (!$NO_ENDING && defined $planned && $planned != $ran) {
27 print STDERR "# Looks like you planned $planned tests but ran $ran.\n";
31 # Use this instead of "print STDERR" when outputing failure diagnostic
35 my @mess = map { /^#/ ? "$_\n" : "# $_\n" }
36 map { split /\n/ } @_;
37 my $fh = $TODO ? *STDOUT : *STDERR;
44 print STDOUT "1..0 # Skipped: @_\n";
46 print STDOUT "1..0\n";
52 my ($pass, $where, $name, @mess) = @_;
53 # Do not try to microoptimize by factoring out the "not ".
57 # escape out '#' or it will interfere with '# skip' and such
59 $out = $pass ? "ok $test - $name" : "not ok $test - $name";
61 $out = $pass ? "ok $test" : "not ok $test";
64 $out .= " # TODO $TODO" if $TODO;
65 print STDOUT "$out\n";
68 _diag "# Failed $where\n";
71 # Ensure that the message is properly escaped.
80 my @caller = caller($Level);
81 return "at $caller[1] line $caller[2]";
84 # DON'T use this for matches. Use like() instead.
86 my ($pass, $name, @mess) = @_;
87 _ok($pass, _where(), $name, @mess);
92 return 'undef' unless defined $x;
101 return defined $x ? '"' . display ($x) . '"' : 'undef';
104 # keys are the codes \n etc map to, values are 2 char strings such as \n
105 my %backslash_escape;
106 foreach my $x (split //, 'nrtfa\\\'"') {
107 $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
109 # A way to display scalars containing control characters and Unicode.
110 # Trying to avoid setting $_, or relying on local $_ to work.
114 if (defined $x and not ref $x) {
116 foreach my $c (unpack("U*", $x)) {
118 $y .= sprintf "\\x{%x}", $c;
119 } elsif ($backslash_escape{$c}) {
120 $y .= $backslash_escape{$c};
122 my $z = chr $c; # Maybe we can get away with a literal...
123 $z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/;
129 return $x unless wantarray;
136 my ($got, $expected, $name, @mess) = @_;
139 if( !defined $got || !defined $expected ) {
140 # undef only matches undef
141 $pass = !defined $got && !defined $expected;
144 $pass = $got eq $expected;
148 unshift(@mess, "# got "._q($got)."\n",
149 "# expected "._q($expected)."\n");
151 _ok($pass, _where(), $name, @mess);
155 my ($got, $isnt, $name, @mess) = @_;
158 if( !defined $got || !defined $isnt ) {
159 # undef only matches undef
160 $pass = defined $got || defined $isnt;
163 $pass = $got ne $isnt;
167 unshift(@mess, "# it should not be "._q($got)."\n",
170 _ok($pass, _where(), $name, @mess);
174 my($got, $type, $expected, $name, @mess) = @_;
179 local($@,$!); # don't interfere with $@
180 # eval() sometimes resets $!
181 $pass = eval "\$got $type \$expected";
184 # It seems Irix long doubles can have 2147483648 and 2147483648
185 # that stringify to the same thing but are acutally numerically
186 # different. Display the numbers if $type isn't a string operator,
187 # and the numbers are stringwise the same.
188 # (all string operators have alphabetic names, so tr/a-z// is true)
189 # This will also show numbers for some uneeded cases, but will
190 # definately be helpful for things such as == and <= that fail
191 if ($got eq $expected and $type !~ tr/a-z//) {
192 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
194 unshift(@mess, "# got "._q($got)."\n",
195 "# expected $type "._q($expected)."\n");
197 _ok($pass, _where(), $name, @mess);
200 # Check that $got is within $range of $expected
201 # if $range is 0, then check it's exact
202 # else if $expected is 0, then $range is an absolute value
203 # otherwise $range is a fractional error.
204 # Here $range must be numeric, >= 0
205 # Non numeric ranges might be a useful future extension. (eg %)
207 my ($got, $expected, $range, $name, @mess) = @_;
209 if (!defined $got or !defined $expected or !defined $range) {
210 # This is a fail, but doesn't need extra diagnostics
211 } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
213 unshift @mess, "# got, expected and range must be numeric\n";
214 } elsif ($range < 0) {
215 # This is also a fail
216 unshift @mess, "# range must not be negative\n";
217 } elsif ($range == 0) {
219 $pass = $got == $expected;
220 } elsif ($expected == 0) {
221 # If expected is 0, treat range as absolute
222 $pass = ($got <= $range) && ($got >= - $range);
224 my $diff = $got - $expected;
225 $pass = abs ($diff / $expected) < $range;
228 if ($got eq $expected) {
229 unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
231 unshift@mess, "# got "._q($got)."\n",
232 "# expected "._q($expected)." (within "._q($range).")\n";
234 _ok($pass, _where(), $name, @mess);
237 # Note: this isn't quite as fancy as Test::More::like().
239 sub like ($$@) { like_yn (0,@_) }; # 0 for -
240 sub unlike ($$@) { like_yn (1,@_) }; # 1 for un-
243 my ($flip, $got, $expected, $name, @mess) = @_;
245 $pass = $got =~ /$expected/ if !$flip;
246 $pass = $got !~ /$expected/ if $flip;
248 unshift(@mess, "# got '$got'\n",
249 "# expected /$expected/\n");
251 _ok($pass, _where(), $name, @mess);
259 _ok(0, _where(), @_);
271 # Note: can't pass multipart messages since we try to
272 # be compatible with Test::More::skip().
275 my $n = @_ ? shift : 1;
277 print STDOUT "ok $test # skip: $why\n";
286 return 0 unless $#$ra == $#$rb;
287 for my $i (0..$#$ra) {
288 return 0 unless $ra->[$i] eq $rb->[$i];
294 my ($orig, $suspect) = @_;
296 while (my ($key, $value) = each %$suspect) {
297 # Force a hash recompute if this perl's internals can cache the hash key.
299 if (exists $orig->{$key}) {
300 if ($orig->{$key} ne $value) {
301 print STDOUT "# key ", _qq($key), " was ", _qq($orig->{$key}),
302 " now ", _qq($value), "\n";
306 print STDOUT "# key ", _qq($key), " is ", _qq($value),
307 ", not in original.\n";
311 foreach (keys %$orig) {
312 # Force a hash recompute if this perl's internals can cache the hash key.
314 next if (exists $suspect->{$_});
315 print STDOUT "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
326 _ok(!$@, _where(), "require $require");
334 _ok(!$@, _where(), "use $use");
337 # runperl - Runs a separate perl interpreter.
339 # switches => [ command-line switches ]
340 # nolib => 1 # don't use -I../lib (included by default)
341 # prog => one-liner (avoid quotes)
342 # progs => [ multi-liner (avoid quotes) ]
343 # progfile => perl script
344 # stdin => string to feed the stdin
345 # stderr => redirect stderr to stdout
346 # args => [ command-line arguments to the perl program ]
347 # verbose => print the command line
349 my $is_mswin = $^O eq 'MSWin32';
350 my $is_netware = $^O eq 'NetWare';
351 my $is_macos = $^O eq 'MacOS';
352 my $is_vms = $^O eq 'VMS';
355 my ($runperl, $args) = @_;
358 # In VMS protect with doublequotes because otherwise
359 # DCL will lowercase -- unless already doublequoted.
360 $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
361 $$runperl .= ' ' . $_;
365 sub _create_runperl { # Create the string to qx in runperl().
367 my $runperl = $^X =~ m/\s/ ? qq{"$^X"} : $^X;
368 unless ($args{nolib}) {
370 $runperl .= ' -I::lib';
371 # Use UNIX style error messages instead of MPW style.
372 $runperl .= ' -MMac::err=unix' if $args{stderr};
375 $runperl .= ' "-I../lib"'; # doublequotes because of VMS
378 if ($args{switches}) {
380 die "test.pl:runperl(): 'switches' must be an ARRAYREF " . _where()
381 unless ref $args{switches} eq "ARRAY";
382 _quote_args(\$runperl, $args{switches});
384 if (defined $args{prog}) {
385 die "test.pl:runperl(): both 'prog' and 'progs' cannot be used " . _where()
386 if defined $args{progs};
387 $args{progs} = [$args{prog}]
389 if (defined $args{progs}) {
390 die "test.pl:runperl(): 'progs' must be an ARRAYREF " . _where()
391 unless ref $args{progs} eq "ARRAY";
392 foreach my $prog (@{$args{progs}}) {
393 if ($is_mswin || $is_netware || $is_vms) {
394 $runperl .= qq ( -e "$prog" );
397 $runperl .= qq ( -e '$prog' );
400 } elsif (defined $args{progfile}) {
401 $runperl .= qq( "$args{progfile}");
403 if (defined $args{stdin}) {
404 # so we don't try to put literal newlines and crs onto the
406 $args{stdin} =~ s/\n/\\n/g;
407 $args{stdin} =~ s/\r/\\r/g;
409 if ($is_mswin || $is_netware || $is_vms) {
410 $runperl = qq{$^X -e "print qq(} .
411 $args{stdin} . q{)" | } . $runperl;
414 # MacOS can only do two processes under MPW at once;
415 # the test itself is one; we can't do two more, so
417 my $stdin = qq{$^X -e 'print qq(} . $args{stdin} . qq{)' > teststdin; };
418 if ($args{verbose}) {
419 my $stdindisplay = $stdin;
420 $stdindisplay =~ s/\n/\n\#/g;
421 print STDERR "# $stdindisplay\n";
424 $runperl .= q{ < teststdin };
427 $runperl = qq{$^X -e 'print qq(} .
428 $args{stdin} . q{)' | } . $runperl;
431 if (defined $args{args}) {
432 _quote_args(\$runperl, $args{args});
434 $runperl .= ' 2>&1' if $args{stderr} && !$is_macos;
435 $runperl .= " \xB3 Dev:Null" if !$args{stderr} && $is_macos;
436 if ($args{verbose}) {
437 my $runperldisplay = $runperl;
438 $runperldisplay =~ s/\n/\n\#/g;
439 print STDERR "# $runperldisplay\n";
445 my $runperl = &_create_runperl;
446 my $result = `$runperl`;
447 $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
451 *run_perl = \&runperl; # Nice alias.
454 print STDERR "# @_\n";
458 # A somewhat safer version of the sometimes wrong $^X.
461 unless (defined $Perl) {
464 # VMS should have 'perl' aliased properly
465 return $Perl if $^O eq 'VMS';
468 eval "require Config; Config->import";
470 warn "test.pl had problems loading Config: $@";
473 $exe = $Config{_exe};
475 $exe = '' unless defined $exe;
477 # This doesn't absolutize the path: beware of future chdirs().
478 # We could do File::Spec->abs2rel() but that does getcwd()s,
479 # which is a bit heavyweight to do here.
481 if ($Perl =~ /^perl\Q$exe\E$/i) {
482 my $perl = "perl$exe";
483 eval "require File::Spec";
485 warn "test.pl had problems loading File::Spec: $@";
488 $Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
492 # Build up the name of the executable file from the name of
495 if ($Perl !~ /\Q$exe\E$/i) {
499 warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
501 # For subcommands to use.
502 $ENV{PERLEXE} = $Perl;
508 foreach my $file (@_) {
509 1 while unlink $file;
510 print STDERR "# Couldn't unlink '$file': $!\n" if -f $file;
515 my $tmpfile = "misctmp000";
516 1 while -f ++$tmpfile;
517 END { unlink_all $tmpfile }
522 # The $resolve must be a subref that tests the first argument
523 # for success, or returns the definition of success (e.g. the
524 # expected scalar) if given no arguments.
528 my($prog, $resolve, $runperl_args, $name) = @_;
530 $runperl_args ||= {};
531 $runperl_args->{progfile} = $tmpfile;
532 $runperl_args->{stderr} = 1;
534 open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
538 $prog =~ s#/dev/null#NL:#;
541 $prog =~ s{if \(-e _ and -f _ and -r _\)}
545 print TEST $prog, "\n";
546 close TEST or die "Cannot close $tmpfile: $!";
548 my $results = runperl(%$runperl_args);
551 # Clean up the results into something a bit more predictable.
552 $results =~ s/\n+$//;
553 $results =~ s/at\s+misctmp\d+\s+line/at - line/g;
554 $results =~ s/of\s+misctmp\d+\s+aborted/of - aborted/g;
556 # bison says 'parse error' instead of 'syntax error',
557 # various yaccs may or may not capitalize 'syntax'.
558 $results =~ s/^(syntax|parse) error/syntax error/mig;
561 # some tests will trigger VMS messages that won't be expected
562 $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
564 # pipes double these sometimes
565 $results =~ s/\n\n/\n/g;
568 my $pass = $resolve->($results);
570 _diag "# PROG: \n$prog\n";
571 _diag "# EXPECTED:\n", $resolve->(), "\n";
572 _diag "# GOT:\n$results\n";
573 _diag "# STATUS: $status\n";
576 # Use the first line of the program as a name if none was given
578 ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
579 $name .= '...' if length $first_line > length $name;
582 _ok($pass, _where(), "fresh_perl - $name");
588 # Combination of run_perl() and is().
592 my($prog, $expected, $runperl_args, $name) = @_;
595 sub { @_ ? $_[0] eq $expected : $expected },
596 $runperl_args, $name);
602 # Combination of run_perl() and like().
605 sub fresh_perl_like {
606 my($prog, $expected, $runperl_args, $name) = @_;
610 $_[0] =~ (ref $expected ? $expected : /$expected/) :
612 $runperl_args, $name);