[p5sagit/p5-mst-13.2.git] / t / test.pl

#
# t/test.pl - most of Test::More functionality without the fuss
#

my $test = 1;
my $planned;

$TODO = 0;
$NO_ENDING = 0;

sub plan {
    my $n;
    if (@_ == 1) {
	$n = shift;
    } else {
	my %plan = @_;
	$n = $plan{tests}; 
    }
    print STDOUT "1..$n\n";
    $planned = $n;
}

END {
    my $ran = $test - 1;
    if (!$NO_ENDING && defined $planned && $planned != $ran) {
        print STDERR "# Looks like you planned $planned tests but ran $ran.\n";
    }
}

# Use this instead of "print STDERR" when outputing failure diagnostic 
# messages
sub _diag {
    return unless @_;
    my @mess = map { /^#/ ? "$_\n" : "# $_\n" } 
               map { split /\n/ } @_;
    my $fh = $TODO ? *STDOUT : *STDERR;
    print $fh @mess;

}

sub skip_all {
    if (@_) {
	print STDOUT "1..0 # Skipped: @_\n";
    } else {
	print STDOUT "1..0\n";
    }
    exit(0);
}

sub _ok {
    my ($pass, $where, $name, @mess) = @_;
    # Do not try to microoptimize by factoring out the "not ".
    # VMS will avenge.
    my $out;
    if ($name) {
        # escape out '#' or it will interfere with '# skip' and such
        $name =~ s/#/\\#/g;
	$out = $pass ? "ok $test - $name" : "not ok $test - $name";
    } else {
	$out = $pass ? "ok $test" : "not ok $test";
    }

    $out .= " # TODO $TODO" if $TODO;
    print STDOUT "$out\n";

    unless ($pass) {
	_diag "# Failed $where\n";
    }

    # Ensure that the message is properly escaped.
    _diag @mess;

    $test++;

    return $pass;
}

sub _where {
    my @caller = caller(1);
    return "at $caller[1] line $caller[2]";
}

# DON'T use this for matches. Use like() instead.
sub ok {
    my ($pass, $name, @mess) = @_;
    _ok($pass, _where(), $name, @mess);
}

sub _q {
    my $x = shift;
    return 'undef' unless defined $x;
    my $q = $x;
    $q =~ s/\\/\\\\/;
    $q =~ s/'/\\'/;
    return "'$q'";
}

sub _qq {
    my $x = shift;
    return defined $x ? '"' . display ($x) . '"' : 'undef';
};

# keys are the codes \n etc map to, values are 2 char strings such as \n
my %backslash_escape;
foreach my $x (split //, 'nrtfa\\\'"') {
    $backslash_escape{ord eval "\"\\$x\""} = "\\$x";
}
# A way to display scalars containing control characters and Unicode.
# Trying to avoid setting $_, or relying on local $_ to work.
sub display {
    my @result;
    foreach my $x (@_) {
        if (defined $x and not ref $x) {
            my $y = '';
            foreach my $c (unpack("U*", $x)) {
                if ($c > 255) {
                    $y .= sprintf "\\x{%x}", $c;
                } elsif ($backslash_escape{$c}) {
                    $y .= $backslash_escape{$c};
                } else {
                    my $z = chr $c; # Maybe we can get away with a literal...
                    $z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/;
                    $y .= $z;
                }
            }
            $x = $y;
        }
        return $x unless wantarray;
        push @result, $x;
    }
    return @result;
}

sub is {
    my ($got, $expected, $name, @mess) = @_;

    my $pass;
    if( !defined $got || !defined $expected ) {
        # undef only matches undef
        $pass = !defined $got && !defined $expected;
    }
    else {
        $pass = $got eq $expected;
    }

    unless ($pass) {
	unshift(@mess, "#      got "._q($got)."\n",
		       "# expected "._q($expected)."\n");
    }
    _ok($pass, _where(), $name, @mess);
}

sub isnt {
    my ($got, $isnt, $name, @mess) = @_;

    my $pass;
    if( !defined $got || !defined $isnt ) {
        # undef only matches undef
        $pass = defined $got || defined $isnt;
    }
    else {
        $pass = $got ne $isnt;
    }

    unless( $pass ) {
        unshift(@mess, "# it should not be "._q($got)."\n",
                       "# but it is.\n");
    }
    _ok($pass, _where(), $name, @mess);
}

sub cmp_ok {
    my($got, $type, $expected, $name, @mess) = @_;

    my $pass;
    {
        local $^W = 0;
        local($@,$!);   # don't interfere with $@
                        # eval() sometimes resets $!
        $pass = eval "\$got $type \$expected";
    }
    unless ($pass) {
        # It seems Irix long doubles can have 2147483648 and 2147483648
        # that stringify to the same thing but are acutally numerically
        # different. Display the numbers if $type isn't a string operator,
        # and the numbers are stringwise the same.
        # (all string operators have alphabetic names, so tr/a-z// is true)
        # This will also show numbers for some uneeded cases, but will
        # definately be helpful for things such as == and <= that fail
        if ($got eq $expected and $type !~ tr/a-z//) {
            unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
        }
        unshift(@mess, "#      got "._q($got)."\n",
                       "# expected $type "._q($expected)."\n");
    }
    _ok($pass, _where(), $name, @mess);
}

# Check that $got is within $range of $expected
# if $range is 0, then check it's exact
# else if $expected is 0, then $range is an absolute value
# otherwise $range is a fractional error.
# Here $range must be numeric, >= 0
# Non numeric ranges might be a useful future extension. (eg %)
sub within {
    my ($got, $expected, $range, $name, @mess) = @_;
    my $pass;
    if (!defined $got or !defined $expected or !defined $range) {
        # This is a fail, but doesn't need extra diagnostics
    } elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
        # This is a fail
        unshift @mess, "# got, expected and range must be numeric\n";
    } elsif ($range < 0) {
        # This is also a fail
        unshift @mess, "# range must not be negative\n";
    } elsif ($range == 0) {
        # Within 0 is ==
        $pass = $got == $expected;
    } elsif ($expected == 0) {
        # If expected is 0, treat range as absolute
        $pass = ($got <= $range) && ($got >= - $range);
    } else {
        my $diff = $got - $expected;
        $pass = abs ($diff / $expected) < $range;
    }
    unless ($pass) {
        if ($got eq $expected) {
            unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
        }
	unshift@mess, "#      got "._q($got)."\n",
		      "# expected "._q($expected)." (within "._q($range).")\n";
    }
    _ok($pass, _where(), $name, @mess);
}

# Note: this isn't quite as fancy as Test::More::like().
sub like {
    my ($got, $expected, $name, @mess) = @_;
    my $pass;
    if (ref $expected eq 'Regexp') {
	$pass = $got =~ $expected;
	unless ($pass) {
	    unshift(@mess, "#      got '$got'\n",
		           "# expected /$expected/\n");
	}
    } else {
	$pass = $got =~ /$expected/;
	unless ($pass) {
	    unshift(@mess, "#      got '$got'\n",
		           "# expected /$expected/\n");
	}
    }
    _ok($pass, _where(), $name, @mess);
}

sub pass {
    _ok(1, '', @_);
}

sub fail {
    _ok(0, _where(), @_);
}

sub curr_test {
    $test = shift if @_;
    return $test;
}

sub next_test {
  $test++;
}

# Note: can't pass multipart messages since we try to
# be compatible with Test::More::skip().
sub skip {
    my $why = shift;
    my $n    = @_ ? shift : 1;
    for (1..$n) {
        print STDOUT "ok $test # skip: $why\n";
        $test++;
    }
    local $^W = 0;
    last SKIP;
}

sub eq_array {
    my ($ra, $rb) = @_;
    return 0 unless $#$ra == $#$rb;
    for my $i (0..$#$ra) {
	return 0 unless $ra->[$i] eq $rb->[$i];
    }
    return 1;
}

sub eq_hash {
  my ($orig, $suspect) = @_;
  my $fail;
  while (my ($key, $value) = each %$suspect) {
    # Force a hash recompute if this perl's internals can cache the hash key.
    $key = "" . $key;
    if (exists $orig->{$key}) {
      if ($orig->{$key} ne $value) {
        print STDOUT "# key ", _qq($key), " was ", _qq($orig->{$key}),
                     " now ", _qq($value), "\n";
        $fail = 1;
      }
    } else {
      print STDOUT "# key ", _qq($key), " is ", _qq($value), 
                   ", not in original.\n";
      $fail = 1;
    }
  }
  foreach (keys %$orig) {
    # Force a hash recompute if this perl's internals can cache the hash key.
    $_ = "" . $_;
    next if (exists $suspect->{$_});
    print STDOUT "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
    $fail = 1;
  }
  !$fail;
}

sub require_ok {
    my ($require) = @_;
    eval <<REQUIRE_OK;
require $require;
REQUIRE_OK
    _ok(!$@, _where(), "require $require");
}

sub use_ok {
    my ($use) = @_;
    eval <<USE_OK;
use $use;
USE_OK
    _ok(!$@, _where(), "use $use");
}

# runperl - Runs a separate perl interpreter.
# Arguments :
#   switches => [ command-line switches ]
#   nolib    => 1 # don't use -I../lib (included by default)
#   prog     => one-liner (avoid quotes)
#   progs    => [ multi-liner (avoid quotes) ]
#   progfile => perl script
#   stdin    => string to feed the stdin
#   stderr   => redirect stderr to stdout
#   args     => [ command-line arguments to the perl program ]
#   verbose  => print the command line

my $is_mswin    = $^O eq 'MSWin32';
my $is_netware  = $^O eq 'NetWare';
my $is_macos    = $^O eq 'MacOS';
my $is_vms      = $^O eq 'VMS';

sub _quote_args {
    my ($runperl, $args) = @_;

    foreach (@$args) {
	# In VMS protect with doublequotes because otherwise
	# DCL will lowercase -- unless already doublequoted.
       $_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
	$$runperl .= ' ' . $_;
    }
}

sub _create_runperl { # Create the string to qx in runperl().
    my %args = @_;
    my $runperl = $^X;
    unless ($args{nolib}) {
	if ($is_macos) {
	    $runperl .= ' -I::lib';
	    # Use UNIX style error messages instead of MPW style.
	    $runperl .= ' -MMac::err=unix' if $args{stderr};
	}
	else {
	    $runperl .= ' "-I../lib"'; # doublequotes because of VMS
	}
    }
    if ($args{switches}) {
	_quote_args(\$runperl, $args{switches});
    }
    if (defined $args{prog}) {
        $args{progs} = [$args{prog}]
    }
    if (defined $args{progs}) {
        foreach my $prog (@{$args{progs}}) {
            if ($is_mswin || $is_netware || $is_vms) {
                $runperl .= qq ( -e "$prog" );
            }
            else {
                $runperl .= qq ( -e '$prog' );
            }
        }
    } elsif (defined $args{progfile}) {
	$runperl .= qq( "$args{progfile}");
    }
    if (defined $args{stdin}) {
	# so we don't try to put literal newlines and crs onto the
	# command line.
	$args{stdin} =~ s/\n/\\n/g;
	$args{stdin} =~ s/\r/\\r/g;

	if ($is_mswin || $is_netware || $is_vms) {
	    $runperl = qq{$^X -e "print qq(} .
		$args{stdin} . q{)" | } . $runperl;
	}
	elsif ($is_macos) {
	    # MacOS can only do two processes under MPW at once;
	    # the test itself is one; we can't do two more, so
	    # write to temp file
	    my $stdin = qq{$^X -e 'print qq(} . $args{stdin} . qq{)' > teststdin; };
	    if ($args{verbose}) {
		my $stdindisplay = $stdin;
		$stdindisplay =~ s/\n/\n\#/g;
		print STDERR "# $stdindisplay\n";
	    }
	    `$stdin`;
	    $runperl .= q{ < teststdin };
	}
	else {
	    $runperl = qq{$^X -e 'print qq(} .
		$args{stdin} . q{)' | } . $runperl;
	}
    }
    if (defined $args{args}) {
	_quote_args(\$runperl, $args{args});
    }
    $runperl .= ' 2>&1'          if  $args{stderr} && !$is_macos;
    $runperl .= " \xB3 Dev:Null" if !$args{stderr} &&  $is_macos;
    if ($args{verbose}) {
	my $runperldisplay = $runperl;
	$runperldisplay =~ s/\n/\n\#/g;
	print STDERR "# $runperldisplay\n";
    }
    return $runperl;
}

sub runperl {
    my $runperl = &_create_runperl;
    my $result = `$runperl`;
    $result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
    return $result;
}

*run_perl = \&runperl; # Nice alias.

sub DIE {
    print STDERR "# @_\n";
    exit 1;
}

# A somewhat safer version of the sometimes wrong $^X.
my $Perl;
sub which_perl {
    unless (defined $Perl) {
	$Perl = $^X;
	
	# VMS should have 'perl' aliased properly
	return $Perl if $^O eq 'VMS';

	my $exe;
	eval "require Config; Config->import";
	if ($@) {
	    warn "test.pl had problems loading Config: $@";
	    $exe = '';
	} else {
	    $exe = $Config{_exe};
	}
       $exe = '' unless defined $exe;
	
	# This doesn't absolutize the path: beware of future chdirs().
	# We could do File::Spec->abs2rel() but that does getcwd()s,
	# which is a bit heavyweight to do here.
	
	if ($Perl =~ /^perl\Q$exe\E$/i) {
	    my $perl = "perl$exe";
	    eval "require File::Spec";
	    if ($@) {
		warn "test.pl had problems loading File::Spec: $@";
		$Perl = "./$perl";
	    } else {
		$Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
	    }
	}

	# Build up the name of the executable file from the name of
	# the command.

	if ($Perl !~ /\Q$exe\E$/i) {
	    $Perl .= $exe;
	}

	warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
	
	# For subcommands to use.
	$ENV{PERLEXE} = $Perl;
    }
    return $Perl;
}

sub unlink_all {
    foreach my $file (@_) {
        1 while unlink $file;
        print STDERR "# Couldn't unlink '$file': $!\n" if -f $file;
    }
}


my $tmpfile = "misctmp000";
1 while -f ++$tmpfile;
END { unlink_all $tmpfile }

#
# _fresh_perl
#
# The $resolve must be a subref that tests the first argument
# for success, or returns the definition of success (e.g. the
# expected scalar) if given no arguments.
#

sub _fresh_perl {
    my($prog, $resolve, $runperl_args, $name) = @_;

    $runperl_args ||= {};
    $runperl_args->{progfile} = $tmpfile;
    $runperl_args->{stderr} = 1;

    open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";

    # VMS adjustments
    if( $^O eq 'VMS' ) {
        $prog =~ s#/dev/null#NL:#;

        # VMS file locking 
        $prog =~ s{if \(-e _ and -f _ and -r _\)}
                  {if (-e _ and -f _)}
    }

    print TEST $prog, "\n";
    close TEST or die "Cannot close $tmpfile: $!";

    my $results = runperl(%$runperl_args);
    my $status = $?;

    # Clean up the results into something a bit more predictable.
    $results =~ s/\n+$//;
    $results =~ s/at\s+misctmp\d+\s+line/at - line/g;
    $results =~ s/of\s+misctmp\d+\s+aborted/of - aborted/g;

    # bison says 'parse error' instead of 'syntax error',
    # various yaccs may or may not capitalize 'syntax'.
    $results =~ s/^(syntax|parse) error/syntax error/mig;

    if ($^O eq 'VMS') {
        # some tests will trigger VMS messages that won't be expected
        $results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;

        # pipes double these sometimes
        $results =~ s/\n\n/\n/g;
    }

    my $pass = $resolve->($results);
    unless ($pass) {
        _diag "# PROG: \n$prog\n";
        _diag "# EXPECTED:\n", $resolve->(), "\n";
        _diag "# GOT:\n$results\n";
        _diag "# STATUS: $status\n";
    }

    # Use the first line of the program as a name if none was given
    unless( $name ) {
        ($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
        $name .= '...' if length $first_line > length $name;
    }

    _ok($pass, _where(), "fresh_perl - $name");
}

#
# run_perl_is
#
# Combination of run_perl() and is().
#

sub fresh_perl_is {
    my($prog, $expected, $runperl_args, $name) = @_;
    _fresh_perl($prog,
		sub { @_ ? $_[0] eq $expected : $expected },
		$runperl_args, $name);
}

#
# run_perl_like
#
# Combination of run_perl() and like().
#

sub fresh_perl_like {
    my($prog, $expected, $runperl_args, $name) = @_;
    _fresh_perl($prog,
		sub { @_ ?
			  $_[0] =~ (ref $expected ? $expected : /$expected/) :
		          $expected },
		$runperl_args, $name);
}

1;
Commit	Line	Data
69026470	1	#
	2	# t/test.pl - most of Test::More functionality without the fuss
	3	#
	4
	5	my $test = 1;
	6	my $planned;
	7
7d932aad	8	$TODO = 0;
b6345914	9	$NO_ENDING = 0;
7d932aad	10
69026470	11	sub plan {
	12	my $n;
	13	if (@_ == 1) {
	14	$n = shift;
	15	} else {
	16	my %plan = @_;
	17	$n = $plan{tests};
	18	}
ad20d923	19	print STDOUT "1..$n\n";
69026470	20	$planned = $n;
	21	}
	22
	23	END {
	24	my $ran = $test - 1;
b6345914	25	if (!$NO_ENDING && defined $planned && $planned != $ran) {
75385f53	26	print STDERR "# Looks like you planned $planned tests but ran $ran.\n";
69026470	27	}
	28	}
	29
de522f7a	30	# Use this instead of "print STDERR" when outputing failure diagnostic
	31	# messages
	32	sub _diag {
cf8feb78	33	return unless @_;
	34	my @mess = map { /^#/ ? "$_\n" : "# $_\n" }
	35	map { split /\n/ } @_;
de522f7a	36	my $fh = $TODO ? STDOUT : STDERR;
cf8feb78	37	print $fh @mess;
cf8feb78	38
de522f7a	39	}
de522f7a	40
69026470	41	sub skip_all {
69026470	42	if (@_) {
195d559b	43	print STDOUT "1..0 # Skipped: @_\n";
69026470	44	} else {
ad20d923	45	print STDOUT "1..0\n";
69026470	46	}
	47	exit(0);
	48	}
	49
	50	sub _ok {
7d932aad	51	my ($pass, $where, $name, @mess) = @_;
69026470	52	# Do not try to microoptimize by factoring out the "not ".
69026470	53	# VMS will avenge.
7d932aad	54	my $out;
7d932aad	55	if ($name) {
b734d6c9	56	# escape out '#' or it will interfere with '# skip' and such
b734d6c9	57	$name =~ s/#/\\#/g;
7d932aad	58	$out = $pass ? "ok $test - $name" : "not ok $test - $name";
69026470	59	} else {
7d932aad	60	$out = $pass ? "ok $test" : "not ok $test";
69026470	61	}
7d932aad	62
7d932aad	63	$out .= " # TODO $TODO" if $TODO;
ad20d923	64	print STDOUT "$out\n";
7d932aad	65
69026470	66	unless ($pass) {
de522f7a	67	_diag "# Failed $where\n";
69026470	68	}
7d932aad	69
7d932aad	70	# Ensure that the message is properly escaped.
cf8feb78	71	_diag @mess;
7d932aad	72
69026470	73	$test++;
1577bb16	74
1577bb16	75	return $pass;
69026470	76	}
	77
	78	sub _where {
	79	my @caller = caller(1);
	80	return "at $caller[1] line $caller[2]";
	81	}
	82
1d662fb6	83	# DON'T use this for matches. Use like() instead.
69026470	84	sub ok {
7d932aad	85	my ($pass, $name, @mess) = @_;
7d932aad	86	_ok($pass, _where(), $name, @mess);
69026470	87	}
69026470	88
b3c72391	89	sub _q {
	90	my $x = shift;
	91	return 'undef' unless defined $x;
	92	my $q = $x;
677fb045	93	$q =~ s/\\/\\\\/;
b3c72391	94	$q =~ s/'/\\'/;
	95	return "'$q'";
	96	}
	97
677fb045	98	sub _qq {
	99	my $x = shift;
	100	return defined $x ? '"' . display ($x) . '"' : 'undef';
	101	};
	102
	103	# keys are the codes \n etc map to, values are 2 char strings such as \n
	104	my %backslash_escape;
	105	foreach my $x (split //, 'nrtfa\\\'"') {
	106	$backslash_escape{ord eval "\"\\$x\""} = "\\$x";
	107	}
	108	# A way to display scalars containing control characters and Unicode.
	109	# Trying to avoid setting $_, or relying on local $_ to work.
	110	sub display {
	111	my @result;
	112	foreach my $x (@_) {
	113	if (defined $x and not ref $x) {
	114	my $y = '';
	115	foreach my $c (unpack("U*", $x)) {
	116	if ($c > 255) {
	117	$y .= sprintf "\\x{%x}", $c;
	118	} elsif ($backslash_escape{$c}) {
	119	$y .= $backslash_escape{$c};
	120	} else {
	121	my $z = chr $c; # Maybe we can get away with a literal...
	122	$z = sprintf "\\%03o", $c if $z =~ /[[:^print:]]/;
	123	$y .= $z;
	124	}
	125	}
	126	$x = $y;
	127	}
	128	return $x unless wantarray;
	129	push @result, $x;
	130	}
	131	return @result;
	132	}
	133
69026470	134	sub is {
7d932aad	135	my ($got, $expected, $name, @mess) = @_;
c831d34f	136
	137	my $pass;
	138	if( !defined $got \|\| !defined $expected ) {
	139	# undef only matches undef
	140	$pass = !defined $got && !defined $expected;
	141	}
	142	else {
	143	$pass = $got eq $expected;
	144	}
	145
69026470	146	unless ($pass) {
b3c72391	147	unshift(@mess, "# got "._q($got)."\n",
b3c72391	148	"# expected "._q($expected)."\n");
69026470	149	}
7d932aad	150	_ok($pass, _where(), $name, @mess);
69026470	151	}
69026470	152
3e90d5a3	153	sub isnt {
3e90d5a3	154	my ($got, $isnt, $name, @mess) = @_;
c831d34f	155
	156	my $pass;
	157	if( !defined $got \|\| !defined $isnt ) {
	158	# undef only matches undef
	159	$pass = defined $got \|\| defined $isnt;
	160	}
	161	else {
	162	$pass = $got ne $isnt;
	163	}
	164
3e90d5a3	165	unless( $pass ) {
b3c72391	166	unshift(@mess, "# it should not be "._q($got)."\n",
3e90d5a3	167	"# but it is.\n");
	168	}
	169	_ok($pass, _where(), $name, @mess);
	170	}
	171
58d76dfd	172	sub cmp_ok {
	173	my($got, $type, $expected, $name, @mess) = @_;
	174
	175	my $pass;
	176	{
	177	local $^W = 0;
	178	local($@,$!); # don't interfere with $@
	179	# eval() sometimes resets $!
	180	$pass = eval "\$got $type \$expected";
	181	}
	182	unless ($pass) {
	183	# It seems Irix long doubles can have 2147483648 and 2147483648
	184	# that stringify to the same thing but are acutally numerically
	185	# different. Display the numbers if $type isn't a string operator,
	186	# and the numbers are stringwise the same.
	187	# (all string operators have alphabetic names, so tr/a-z// is true)
	188	# This will also show numbers for some uneeded cases, but will
	189	# definately be helpful for things such as == and <= that fail
	190	if ($got eq $expected and $type !~ tr/a-z//) {
	191	unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
	192	}
	193	unshift(@mess, "# got "._q($got)."\n",
	194	"# expected $type "._q($expected)."\n");
	195	}
	196	_ok($pass, _where(), $name, @mess);
	197	}
	198
	199	# Check that $got is within $range of $expected
	200	# if $range is 0, then check it's exact
	201	# else if $expected is 0, then $range is an absolute value
	202	# otherwise $range is a fractional error.
	203	# Here $range must be numeric, >= 0
	204	# Non numeric ranges might be a useful future extension. (eg %)
	205	sub within {
	206	my ($got, $expected, $range, $name, @mess) = @_;
	207	my $pass;
	208	if (!defined $got or !defined $expected or !defined $range) {
	209	# This is a fail, but doesn't need extra diagnostics
	210	} elsif ($got !~ tr/0-9// or $expected !~ tr/0-9// or $range !~ tr/0-9//) {
	211	# This is a fail
	212	unshift @mess, "# got, expected and range must be numeric\n";
	213	} elsif ($range < 0) {
	214	# This is also a fail
	215	unshift @mess, "# range must not be negative\n";
	216	} elsif ($range == 0) {
	217	# Within 0 is ==
	218	$pass = $got == $expected;
	219	} elsif ($expected == 0) {
	220	# If expected is 0, treat range as absolute
	221	$pass = ($got <= $range) && ($got >= - $range);
	222	} else {
	223	my $diff = $got - $expected;
	224	$pass = abs ($diff / $expected) < $range;
	225	}
	226	unless ($pass) {
	227	if ($got eq $expected) {
	228	unshift @mess, "# $got - $expected = " . ($got - $expected) . "\n";
	229	}
	230	unshift@mess, "# got "._q($got)."\n",
	231	"# expected "._q($expected)." (within "._q($range).")\n";
	232	}
	233	_ok($pass, _where(), $name, @mess);
	234	}
	235
69026470	236	# Note: this isn't quite as fancy as Test::More::like().
69026470	237	sub like {
7d932aad	238	my ($got, $expected, $name, @mess) = @_;
69026470	239	my $pass;
	240	if (ref $expected eq 'Regexp') {
	241	$pass = $got =~ $expected;
	242	unless ($pass) {
435e7af6	243	unshift(@mess, "# got '$got'\n",
435e7af6	244	"# expected /$expected/\n");
69026470	245	}
	246	} else {
	247	$pass = $got =~ /$expected/;
	248	unless ($pass) {
7d932aad	249	unshift(@mess, "# got '$got'\n",
7d932aad	250	"# expected /$expected/\n");
69026470	251	}
69026470	252	}
7d932aad	253	_ok($pass, _where(), $name, @mess);
69026470	254	}
	255
	256	sub pass {
	257	_ok(1, '', @_);
	258	}
	259
	260	sub fail {
	261	_ok(0, _where(), @_);
	262	}
	263
ad20d923	264	sub curr_test {
cf8feb78	265	$test = shift if @_;
ad20d923	266	return $test;
	267	}
	268
3e90d5a3	269	sub next_test {
cf8feb78	270	$test++;
3e90d5a3	271	}
3e90d5a3	272
69026470	273	# Note: can't pass multipart messages since we try to
	274	# be compatible with Test::More::skip().
	275	sub skip {
7d932aad	276	my $why = shift;
982b7cb7	277	my $n = @_ ? shift : 1;
69026470	278	for (1..$n) {
ad20d923	279	print STDOUT "ok $test # skip: $why\n";
e6c299c8	280	$test++;
69026470	281	}
	282	local $^W = 0;
	283	last SKIP;
	284	}
	285
	286	sub eq_array {
	287	my ($ra, $rb) = @_;
	288	return 0 unless $#$ra == $#$rb;
	289	for my $i (0..$#$ra) {
	290	return 0 unless $ra->[$i] eq $rb->[$i];
	291	}
	292	return 1;
	293	}
	294
677fb045	295	sub eq_hash {
	296	my ($orig, $suspect) = @_;
	297	my $fail;
	298	while (my ($key, $value) = each %$suspect) {
	299	# Force a hash recompute if this perl's internals can cache the hash key.
	300	$key = "" . $key;
	301	if (exists $orig->{$key}) {
	302	if ($orig->{$key} ne $value) {
de522f7a	303	print STDOUT "# key ", _qq($key), " was ", _qq($orig->{$key}),
de522f7a	304	" now ", _qq($value), "\n";
677fb045	305	$fail = 1;
	306	}
	307	} else {
de522f7a	308	print STDOUT "# key ", _qq($key), " is ", _qq($value),
75385f53	309	", not in original.\n";
677fb045	310	$fail = 1;
	311	}
	312	}
	313	foreach (keys %$orig) {
	314	# Force a hash recompute if this perl's internals can cache the hash key.
	315	$_ = "" . $_;
	316	next if (exists $suspect->{$_});
de522f7a	317	print STDOUT "# key ", _qq($_), " was ", _qq($orig->{$_}), " now missing.\n";
677fb045	318	$fail = 1;
	319	}
	320	!$fail;
	321	}
	322
69026470	323	sub require_ok {
	324	my ($require) = @_;
	325	eval <<REQUIRE_OK;
	326	require $require;
	327	REQUIRE_OK
1577bb16	328	_ok(!$@, _where(), "require $require");
69026470	329	}
	330
	331	sub use_ok {
	332	my ($use) = @_;
	333	eval <<USE_OK;
	334	use $use;
	335	USE_OK
1577bb16	336	_ok(!$@, _where(), "use $use");
69026470	337	}
69026470	338
137352a2	339	# runperl - Runs a separate perl interpreter.
	340	# Arguments :
	341	# switches => [ command-line switches ]
	342	# nolib => 1 # don't use -I../lib (included by default)
	343	# prog => one-liner (avoid quotes)
d83945bc	344	# progs => [ multi-liner (avoid quotes) ]
137352a2	345	# progfile => perl script
	346	# stdin => string to feed the stdin
	347	# stderr => redirect stderr to stdout
	348	# args => [ command-line arguments to the perl program ]
cb9c5e20	349	# verbose => print the command line
137352a2	350
	351	my $is_mswin = $^O eq 'MSWin32';
	352	my $is_netware = $^O eq 'NetWare';
	353	my $is_macos = $^O eq 'MacOS';
	354	my $is_vms = $^O eq 'VMS';
	355
cb9c5e20	356	sub _quote_args {
	357	my ($runperl, $args) = @_;
	358
	359	foreach (@$args) {
	360	# In VMS protect with doublequotes because otherwise
	361	# DCL will lowercase -- unless already doublequoted.
ea9ac5ad	362	$_ = q(").$_.q(") if $is_vms && !/^\"/ && length($_) > 0;
cb9c5e20	363	$$runperl .= ' ' . $_;
	364	}
	365	}
	366
4cd2bd1f	367	sub _create_runperl { # Create the string to qx in runperl().
137352a2	368	my %args = @_;
137352a2	369	my $runperl = $^X;
f93a5f07	370	unless ($args{nolib}) {
f93a5f07	371	if ($is_macos) {
cb9c5e20	372	$runperl .= ' -I::lib';
f93a5f07	373	# Use UNIX style error messages instead of MPW style.
cb9c5e20	374	$runperl .= ' -MMac::err=unix' if $args{stderr};
137352a2	375	}
137352a2	376	else {
cb9c5e20	377	$runperl .= ' "-I../lib"'; # doublequotes because of VMS
137352a2	378	}
137352a2	379	}
d83945bc	380	if ($args{switches}) {
	381	_quote_args(\$runperl, $args{switches});
	382	}
137352a2	383	if (defined $args{prog}) {
d83945bc	384	$args{progs} = [$args{prog}]
	385	}
	386	if (defined $args{progs}) {
	387	foreach my $prog (@{$args{progs}}) {
	388	if ($is_mswin \|\| $is_netware \|\| $is_vms) {
	389	$runperl .= qq ( -e "$prog" );
	390	}
	391	else {
	392	$runperl .= qq ( -e '$prog' );
	393	}
	394	}
137352a2	395	} elsif (defined $args{progfile}) {
	396	$runperl .= qq( "$args{progfile}");
	397	}
	398	if (defined $args{stdin}) {
dc459aad	399	# so we don't try to put literal newlines and crs onto the
	400	# command line.
	401	$args{stdin} =~ s/\n/\\n/g;
	402	$args{stdin} =~ s/\r/\\r/g;
5ae09a77	403
137352a2	404	if ($is_mswin \|\| $is_netware \|\| $is_vms) {
f93a5f07	405	$runperl = qq{$^X -e "print qq(} .
137352a2	406	$args{stdin} . q{)" \| } . $runperl;
137352a2	407	}
dc459aad	408	elsif ($is_macos) {
	409	# MacOS can only do two processes under MPW at once;
	410	# the test itself is one; we can't do two more, so
	411	# write to temp file
	412	my $stdin = qq{$^X -e 'print qq(} . $args{stdin} . qq{)' > teststdin; };
	413	if ($args{verbose}) {
	414	my $stdindisplay = $stdin;
	415	$stdindisplay =~ s/\n/\n\#/g;
	416	print STDERR "# $stdindisplay\n";
	417	}
	418	`$stdin`;
	419	$runperl .= q{ < teststdin };
	420	}
137352a2	421	else {
f93a5f07	422	$runperl = qq{$^X -e 'print qq(} .
137352a2	423	$args{stdin} . q{)' \| } . $runperl;
	424	}
	425	}
	426	if (defined $args{args}) {
cb9c5e20	427	_quote_args(\$runperl, $args{args});
	428	}
	429	$runperl .= ' 2>&1' if $args{stderr} && !$is_macos;
	430	$runperl .= " \xB3 Dev:Null" if !$args{stderr} && $is_macos;
	431	if ($args{verbose}) {
	432	my $runperldisplay = $runperl;
	433	$runperldisplay =~ s/\n/\n\#/g;
75385f53	434	print STDERR "# $runperldisplay\n";
137352a2	435	}
4cd2bd1f	436	return $runperl;
	437	}
	438
	439	sub runperl {
	440	my $runperl = &_create_runperl;
137352a2	441	my $result = `$runperl`;
	442	$result =~ s/\n\n/\n/ if $is_vms; # XXX pipes sometimes double these
	443	return $result;
	444	}
	445
d2c6a9c9	446	*run_perl = \&runperl; # Nice alias.
8799135f	447
c4fbe247	448	sub DIE {
75385f53	449	print STDERR "# @_\n";
c4fbe247	450	exit 1;
8799135f	451	}
8799135f	452
b5fe401b	453	# A somewhat safer version of the sometimes wrong $^X.
17a740d5	454	my $Perl;
	455	sub which_perl {
	456	unless (defined $Perl) {
	457	$Perl = $^X;
	458
73421c4a	459	# VMS should have 'perl' aliased properly
	460	return $Perl if $^O eq 'VMS';
	461
17a740d5	462	my $exe;
17a740d5	463	eval "require Config; Config->import";
85363d30	464	if ($@) {
17a740d5	465	warn "test.pl had problems loading Config: $@";
17a740d5	466	$exe = '';
85363d30	467	} else {
17a740d5	468	$exe = $Config{_exe};
85363d30	469	}
da405c16	470	$exe = '' unless defined $exe;
17a740d5	471
	472	# This doesn't absolutize the path: beware of future chdirs().
	473	# We could do File::Spec->abs2rel() but that does getcwd()s,
	474	# which is a bit heavyweight to do here.
	475
	476	if ($Perl =~ /^perl\Q$exe\E$/i) {
8db06b02	477	my $perl = "perl$exe";
17a740d5	478	eval "require File::Spec";
	479	if ($@) {
	480	warn "test.pl had problems loading File::Spec: $@";
8db06b02	481	$Perl = "./$perl";
17a740d5	482	} else {
8db06b02	483	$Perl = File::Spec->catfile(File::Spec->curdir(), $perl);
17a740d5	484	}
17a740d5	485	}
196918b0	486
	487	# Build up the name of the executable file from the name of
	488	# the command.
	489
	490	if ($Perl !~ /\Q$exe\E$/i) {
	491	$Perl .= $exe;
	492	}
c880be78	493
8db06b02	494	warn "which_perl: cannot find $Perl from $^X" unless -f $Perl;
17a740d5	495
	496	# For subcommands to use.
	497	$ENV{PERLEXE} = $Perl;
85363d30	498	}
17a740d5	499	return $Perl;
b5fe401b	500	}
b5fe401b	501
435e7af6	502	sub unlink_all {
	503	foreach my $file (@_) {
	504	1 while unlink $file;
75385f53	505	print STDERR "# Couldn't unlink '$file': $!\n" if -f $file;
435e7af6	506	}
435e7af6	507	}
eeabcb2d	508
	509
	510	my $tmpfile = "misctmp000";
	511	1 while -f ++$tmpfile;
	512	END { unlink_all $tmpfile }
	513
f5cda331	514	#
	515	# _fresh_perl
	516	#
	517	# The $resolve must be a subref that tests the first argument
	518	# for success, or returns the definition of success (e.g. the
	519	# expected scalar) if given no arguments.
	520	#
	521
	522	sub _fresh_perl {
	523	my($prog, $resolve, $runperl_args, $name) = @_;
eeabcb2d	524
	525	$runperl_args \|\|= {};
	526	$runperl_args->{progfile} = $tmpfile;
	527	$runperl_args->{stderr} = 1;
	528
	529	open TEST, ">$tmpfile" or die "Cannot open $tmpfile: $!";
	530
	531	# VMS adjustments
	532	if( $^O eq 'VMS' ) {
	533	$prog =~ s#/dev/null#NL:#;
	534
	535	# VMS file locking
	536	$prog =~ s{if \(-e _ and -f _ and -r _\)}
	537	{if (-e _ and -f _)}
	538	}
	539
	540	print TEST $prog, "\n";
	541	close TEST or die "Cannot close $tmpfile: $!";
	542
	543	my $results = runperl(%$runperl_args);
	544	my $status = $?;
	545
	546	# Clean up the results into something a bit more predictable.
	547	$results =~ s/\n+$//;
	548	$results =~ s/at\s+misctmp\d+\s+line/at - line/g;
	549	$results =~ s/of\s+misctmp\d+\s+aborted/of - aborted/g;
	550
	551	# bison says 'parse error' instead of 'syntax error',
	552	# various yaccs may or may not capitalize 'syntax'.
	553	$results =~ s/^(syntax\|parse) error/syntax error/mig;
	554
	555	if ($^O eq 'VMS') {
	556	# some tests will trigger VMS messages that won't be expected
	557	$results =~ s/\n?%[A-Z]+-[SIWEF]-[A-Z]+,.*//;
	558
	559	# pipes double these sometimes
	560	$results =~ s/\n\n/\n/g;
	561	}
	562
f5cda331	563	my $pass = $resolve->($results);
eeabcb2d	564	unless ($pass) {
cf8feb78	565	_diag "# PROG: \n$prog\n";
	566	_diag "# EXPECTED:\n", $resolve->(), "\n";
	567	_diag "# GOT:\n$results\n";
	568	_diag "# STATUS: $status\n";
eeabcb2d	569	}
eeabcb2d	570
e2c38acd	571	# Use the first line of the program as a name if none was given
	572	unless( $name ) {
	573	($first_line, $name) = $prog =~ /^((.{1,50}).*)/;
	574	$name .= '...' if length $first_line > length $name;
	575	}
eeabcb2d	576
f5cda331	577	_ok($pass, _where(), "fresh_perl - $name");
	578	}
	579
	580	#
	581	# run_perl_is
	582	#
	583	# Combination of run_perl() and is().
	584	#
	585
	586	sub fresh_perl_is {
	587	my($prog, $expected, $runperl_args, $name) = @_;
	588	_fresh_perl($prog,
	589	sub { @_ ? $_[0] eq $expected : $expected },
	590	$runperl_args, $name);
	591	}
	592
	593	#
	594	# run_perl_like
	595	#
	596	# Combination of run_perl() and like().
	597	#
	598
	599	sub fresh_perl_like {
	600	my($prog, $expected, $runperl_args, $name) = @_;
	601	_fresh_perl($prog,
	602	sub { @_ ?
	603	$_[0] =~ (ref $expected ? $expected : /$expected/) :
	604	$expected },
	605	$runperl_args, $name);
eeabcb2d	606	}
eeabcb2d	607
69026470	608	1;