Blame t/blessed.t

Packit 14c646
#!./perl
Packit 14c646
#
Packit 14c646
#  Copyright (c) 1995-2000, Raphael Manfredi
Packit 14c646
#  
Packit 14c646
#  You may redistribute only under the same terms as Perl 5, as specified
Packit 14c646
#  in the README file that comes with the distribution.
Packit 14c646
#
Packit 14c646
Packit 14c646
BEGIN {
Packit 14c646
    # Do this as the very first thing, in order to avoid problems with the
Packit 14c646
    # PADTMP flag on pre-5.19.3 threaded Perls.  On those Perls, compiling
Packit 14c646
    # code that contains a constant-folded canonical truth value breaks
Packit 14c646
    # the ability to take a reference to that canonical truth value later.
Packit 14c646
    $::false = 0;
Packit 14c646
    %::immortals = (
Packit 14c646
	'u' => \undef,
Packit 14c646
	'y' => \!$::false,
Packit 14c646
	'n' => \!!$::false,
Packit 14c646
    );
Packit 14c646
}
Packit 14c646
Packit 14c646
sub BEGIN {
Packit 14c646
    if ($ENV{PERL_CORE}) {
Packit 14c646
        chdir 'dist/Storable' if -d 'dist/Storable';
Packit 14c646
        @INC = ('../../lib', 't');
Packit 14c646
    } else {
Packit 14c646
        unshift @INC, 't';
Packit 14c646
        unshift @INC, 't/compat' if $] < 5.006002;
Packit 14c646
    }
Packit 14c646
    require Config; import Config;
Packit 14c646
    if ($ENV{PERL_CORE} and $Config{'extensions'} !~ /\bStorable\b/) {
Packit 14c646
        print "1..0 # Skip: Storable was not built\n";
Packit 14c646
        exit 0;
Packit 14c646
    }
Packit 14c646
}
Packit 14c646
Packit 14c646
use Test::More;
Packit 14c646
Packit 14c646
use Storable qw(freeze thaw store retrieve fd_retrieve);
Packit 14c646
Packit 14c646
%::weird_refs = 
Packit 14c646
  (REF            => \(my $aref    = []),
Packit 14c646
   VSTRING        => \(my $vstring = v1.2.3),
Packit 14c646
   'long VSTRING' => \(my $lvstring = eval "v" . 0 x 300),
Packit 14c646
   LVALUE         => \(my $substr  = substr((my $str = "foo"), 0, 3)));
Packit 14c646
Packit 14c646
my $test = 13;
Packit 14c646
my $tests = $test + 41 + (2 * 6 * keys %::immortals) + (3 * keys %::weird_refs);
Packit 14c646
plan(tests => $tests);
Packit 14c646
Packit 14c646
package SHORT_NAME;
Packit 14c646
Packit 14c646
sub make { bless [], shift }
Packit 14c646
Packit 14c646
package SHORT_NAME_WITH_HOOK;
Packit 14c646
Packit 14c646
sub make { bless [], shift }
Packit 14c646
Packit 14c646
sub STORABLE_freeze {
Packit 14c646
	my $self = shift;
Packit 14c646
	return ("", $self);
Packit 14c646
}
Packit 14c646
Packit 14c646
sub STORABLE_thaw {
Packit 14c646
	my $self = shift;
Packit 14c646
	my $cloning = shift;
Packit 14c646
	my ($x, $obj) = @_;
Packit 14c646
	die "STORABLE_thaw" unless $obj eq $self;
Packit 14c646
}
Packit 14c646
Packit 14c646
package main;
Packit 14c646
Packit 14c646
# Still less than 256 bytes, so long classname logic not fully exercised
Packit 14c646
#   Identifier too long - 5.004
Packit 14c646
#   parser.h: char	tokenbuf[256]: cperl5.24 => 1024
Packit 14c646
my $m = ($Config{usecperl} and $] >= 5.024) ? 56 : 14;
Packit 14c646
my $longname = "LONG_NAME_" . ('xxxxxxxxxxxxx::' x $m) . "final";
Packit 14c646
Packit 14c646
eval <
Packit 14c646
package $longname;
Packit 14c646
Packit 14c646
\@ISA = ("SHORT_NAME");
Packit 14c646
EOC
Packit 14c646
is($@, '');
Packit 14c646
Packit 14c646
eval <
Packit 14c646
package ${longname}_WITH_HOOK;
Packit 14c646
Packit 14c646
\@ISA = ("SHORT_NAME_WITH_HOOK");
Packit 14c646
EOC
Packit 14c646
is($@, '');
Packit 14c646
Packit 14c646
# Construct a pool of objects
Packit 14c646
my @pool;
Packit 14c646
for (my $i = 0; $i < 10; $i++) {
Packit 14c646
    push(@pool, SHORT_NAME->make);
Packit 14c646
    push(@pool, SHORT_NAME_WITH_HOOK->make);
Packit 14c646
    push(@pool, $longname->make);
Packit 14c646
    push(@pool, "${longname}_WITH_HOOK"->make);
Packit 14c646
}
Packit 14c646
Packit 14c646
my $x = freeze \@pool;
Packit 14c646
pass("Freeze didn't crash");
Packit 14c646
Packit 14c646
my $y = thaw $x;
Packit 14c646
is(ref $y, 'ARRAY');
Packit 14c646
is(scalar @{$y}, @pool);
Packit 14c646
Packit 14c646
is(ref $y->[0], 'SHORT_NAME');
Packit 14c646
is(ref $y->[1], 'SHORT_NAME_WITH_HOOK');
Packit 14c646
is(ref $y->[2], $longname);
Packit 14c646
is(ref $y->[3], "${longname}_WITH_HOOK");
Packit 14c646
Packit 14c646
my $good = 1;
Packit 14c646
for (my $i = 0; $i < 10; $i++) {
Packit 14c646
    do { $good = 0; last } unless ref $y->[4*$i]   eq 'SHORT_NAME';
Packit 14c646
    do { $good = 0; last } unless ref $y->[4*$i+1] eq 'SHORT_NAME_WITH_HOOK';
Packit 14c646
    do { $good = 0; last } unless ref $y->[4*$i+2] eq $longname;
Packit 14c646
    do { $good = 0; last } unless ref $y->[4*$i+3] eq "${longname}_WITH_HOOK";
Packit 14c646
}
Packit 14c646
is($good, 1);
Packit 14c646
Packit 14c646
{
Packit 14c646
    my $blessed_ref = bless \\[1,2,3], 'Foobar';
Packit 14c646
    my $x = freeze $blessed_ref;
Packit 14c646
    my $y = thaw $x;
Packit 14c646
    is(ref $y, 'Foobar');
Packit 14c646
    is($$$y->[0], 1);
Packit 14c646
}
Packit 14c646
Packit 14c646
package RETURNS_IMMORTALS;
Packit 14c646
Packit 14c646
sub make { my $self = shift; bless [@_], $self }
Packit 14c646
Packit 14c646
sub STORABLE_freeze {
Packit 14c646
    # Some reference some number of times.
Packit 14c646
    my $self = shift;
Packit 14c646
    my ($what, $times) = @$self;
Packit 14c646
    return ("$what$times", ($::immortals{$what}) x $times);
Packit 14c646
}
Packit 14c646
Packit 14c646
sub STORABLE_thaw {
Packit 14c646
    my $self = shift;
Packit 14c646
    my $cloning = shift;
Packit 14c646
    my ($x, @refs) = @_;
Packit 14c646
    my ($what, $times) = $x =~ /(.)(\d+)/;
Packit 14c646
    die "'$x' didn't match" unless defined $times;
Packit 14c646
    main::is(scalar @refs, $times);
Packit 14c646
    my $expect = $::immortals{$what};
Packit 14c646
    die "'$x' did not give a reference" unless ref $expect;
Packit 14c646
    my $fail;
Packit 14c646
    foreach (@refs) {
Packit 14c646
        $fail++ if $_ != $expect;
Packit 14c646
    }
Packit 14c646
    main::is($fail, undef);
Packit 14c646
}
Packit 14c646
Packit 14c646
package main;
Packit 14c646
Packit 14c646
# XXX Failed tests:  15, 27, 39 with 5.12 and 5.10 threaded.
Packit 14c646
# 15: 1 fail (y x 1), 27: 2 fail (y x 2), 39: 3 fail (y x 3)
Packit 14c646
# $Storable::DEBUGME = 1;
Packit 14c646
my $count;
Packit 14c646
foreach $count (1..3) {
Packit 14c646
  my $immortal;
Packit 14c646
  foreach $immortal (keys %::immortals) {
Packit 14c646
    print "# $immortal x $count\n";
Packit 14c646
    my $i =  RETURNS_IMMORTALS->make ($immortal, $count);
Packit 14c646
Packit 14c646
    my $f = freeze ($i);
Packit 14c646
  TODO: {
Packit 14c646
      # ref sv_true is not always sv_true, at least in older threaded perls.
Packit 14c646
      local $TODO = "Some 5.10/12 do not preserve ref identity with freeze \\(1 == 1)"
Packit 14c646
        if !defined($f) and $] < 5.013 and $] > 5.009 and $immortal eq 'y';
Packit 14c646
      isnt($f, undef);
Packit 14c646
    }
Packit 14c646
    my $t = thaw $f;
Packit 14c646
    pass("thaw didn't crash");
Packit 14c646
  }
Packit 14c646
}
Packit 14c646
Packit 14c646
# Test automatic require of packages to find thaw hook.
Packit 14c646
Packit 14c646
package HAS_HOOK;
Packit 14c646
Packit 14c646
$loaded_count = 0;
Packit 14c646
$thawed_count = 0;
Packit 14c646
Packit 14c646
sub make {
Packit 14c646
  bless [];
Packit 14c646
}
Packit 14c646
Packit 14c646
sub STORABLE_freeze {
Packit 14c646
  my $self = shift;
Packit 14c646
  return '';
Packit 14c646
}
Packit 14c646
Packit 14c646
package main;
Packit 14c646
Packit 14c646
my $f = freeze (HAS_HOOK->make);
Packit 14c646
Packit 14c646
is($HAS_HOOK::loaded_count, 0);
Packit 14c646
is($HAS_HOOK::thawed_count, 0);
Packit 14c646
Packit 14c646
my $t = thaw $f;
Packit 14c646
is($HAS_HOOK::loaded_count, 1);
Packit 14c646
is($HAS_HOOK::thawed_count, 1);
Packit 14c646
isnt($t, undef);
Packit 14c646
is(ref $t, 'HAS_HOOK');
Packit 14c646
Packit 14c646
delete $INC{"HAS_HOOK.pm"};
Packit 14c646
delete $HAS_HOOK::{STORABLE_thaw};
Packit 14c646
Packit 14c646
$t = thaw $f;
Packit 14c646
is($HAS_HOOK::loaded_count, 2);
Packit 14c646
is($HAS_HOOK::thawed_count, 2);
Packit 14c646
isnt($t, undef);
Packit 14c646
is(ref $t, 'HAS_HOOK');
Packit 14c646
Packit 14c646
{
Packit 14c646
    package STRESS_THE_STACK;
Packit 14c646
Packit 14c646
    my $stress;
Packit 14c646
    sub make {
Packit 14c646
	bless [];
Packit 14c646
    }
Packit 14c646
Packit 14c646
    sub no_op {
Packit 14c646
	0;
Packit 14c646
    }
Packit 14c646
Packit 14c646
    sub STORABLE_freeze {
Packit 14c646
	my $self = shift;
Packit 14c646
	++$freeze_count;
Packit 14c646
	return no_op(1..(++$stress * 2000)) ? die "can't happen" : '';
Packit 14c646
    }
Packit 14c646
Packit 14c646
    sub STORABLE_thaw {
Packit 14c646
	my $self = shift;
Packit 14c646
	++$thaw_count;
Packit 14c646
	no_op(1..(++$stress * 2000)) && die "can't happen";
Packit 14c646
	return;
Packit 14c646
    }
Packit 14c646
}
Packit 14c646
Packit 14c646
$STRESS_THE_STACK::freeze_count = 0;
Packit 14c646
$STRESS_THE_STACK::thaw_count = 0;
Packit 14c646
Packit 14c646
$f = freeze (STRESS_THE_STACK->make);
Packit 14c646
Packit 14c646
is($STRESS_THE_STACK::freeze_count, 1);
Packit 14c646
is($STRESS_THE_STACK::thaw_count, 0);
Packit 14c646
Packit 14c646
$t = thaw $f;
Packit 14c646
is($STRESS_THE_STACK::freeze_count, 1);
Packit 14c646
is($STRESS_THE_STACK::thaw_count, 1);
Packit 14c646
isnt($t, undef);
Packit 14c646
is(ref $t, 'STRESS_THE_STACK');
Packit 14c646
Packit 14c646
my $file = "storable-testfile.$$";
Packit 14c646
die "Temporary file '$file' already exists" if -e $file;
Packit 14c646
Packit 14c646
END { while (-f $file) {unlink $file or die "Can't unlink '$file': $!" }}
Packit 14c646
Packit 14c646
$STRESS_THE_STACK::freeze_count = 0;
Packit 14c646
$STRESS_THE_STACK::thaw_count = 0;
Packit 14c646
Packit 14c646
store (STRESS_THE_STACK->make, $file);
Packit 14c646
Packit 14c646
is($STRESS_THE_STACK::freeze_count, 1);
Packit 14c646
is($STRESS_THE_STACK::thaw_count, 0);
Packit 14c646
Packit 14c646
$t = retrieve ($file);
Packit 14c646
is($STRESS_THE_STACK::freeze_count, 1);
Packit 14c646
is($STRESS_THE_STACK::thaw_count, 1);
Packit 14c646
isnt($t, undef);
Packit 14c646
is(ref $t, 'STRESS_THE_STACK');
Packit 14c646
Packit 14c646
{
Packit 14c646
    package ModifyARG112358;
Packit 14c646
    sub STORABLE_freeze { $_[0] = "foo"; }
Packit 14c646
    my $o= {str=>bless {}};
Packit 14c646
    my $f= ::freeze($o);
Packit 14c646
    ::is ref $o->{str}, __PACKAGE__,
Packit 14c646
	'assignment to $_[0] in STORABLE_freeze does not corrupt things';
Packit 14c646
}
Packit 14c646
Packit 14c646
# [perl #113880]
Packit 14c646
{
Packit 14c646
    {
Packit 14c646
        package WeirdRefHook;
Packit 14c646
        sub STORABLE_freeze { () }
Packit 14c646
        $INC{'WeirdRefHook.pm'} = __FILE__;
Packit 14c646
    }
Packit 14c646
Packit 14c646
    for my $weird (keys %weird_refs) {
Packit 14c646
        my $obj = $weird_refs{$weird};
Packit 14c646
        bless $obj, 'WeirdRefHook';
Packit 14c646
        my $frozen;
Packit 14c646
        my $success = eval { $frozen = freeze($obj); 1 };
Packit 14c646
        ok($success, "can freeze $weird objects")
Packit 14c646
            || diag("freezing failed: $@");
Packit 14c646
        my $thawn = thaw($frozen);
Packit 14c646
        # is_deeply ignores blessings
Packit 14c646
        is ref $thawn, ref $obj, "get the right blessing back for $weird";
Packit 14c646
        if ($weird =~ 'VSTRING') {
Packit 14c646
            # It is not just Storable that did not support vstrings. :-)
Packit 14c646
            # See https://rt.cpan.org/Ticket/Display.html?id=78678
Packit 14c646
            my $newver = "version"->can("new")
Packit 14c646
                           ? sub { "version"->new(shift) }
Packit 14c646
                           : sub { "" };
Packit 14c646
            if (!ok
Packit 14c646
                  $$thawn eq $$obj && &$newver($$thawn) eq &$newver($$obj),
Packit 14c646
                 "get the right value back"
Packit 14c646
            ) {
Packit 14c646
                diag "$$thawn vs $$obj";
Packit 14c646
                diag &$newver($$thawn) eq &$newver($$obj) if &$newver(1);
Packit 14c646
             }
Packit 14c646
        }
Packit 14c646
        else {
Packit 14c646
            is_deeply($thawn, $obj, "get the right value back");
Packit 14c646
        }
Packit 14c646
    }
Packit 14c646
}
Packit 14c646
Packit 14c646
{
Packit 14c646
    # [perl #118551]
Packit 14c646
    {
Packit 14c646
        package RT118551;
Packit 14c646
Packit 14c646
        sub new {
Packit 14c646
            my $class = shift;
Packit 14c646
            my $string = shift;
Packit 14c646
            die 'Bad data' unless defined $string;
Packit 14c646
            my $self = { string => $string };
Packit 14c646
            return bless $self, $class;
Packit 14c646
        }
Packit 14c646
Packit 14c646
        sub STORABLE_freeze {
Packit 14c646
            my $self = shift;
Packit 14c646
            my $cloning = shift;
Packit 14c646
            return if $cloning;
Packit 14c646
            return ($self->{string});
Packit 14c646
        }
Packit 14c646
Packit 14c646
        sub STORABLE_attach {
Packit 14c646
            my $class = shift;
Packit 14c646
            my $cloning = shift;
Packit 14c646
            my $string = shift;
Packit 14c646
            return $class->new($string);
Packit 14c646
        }
Packit 14c646
    }
Packit 14c646
Packit 14c646
    my $x = [ RT118551->new('a'), RT118551->new('') ];
Packit 14c646
Packit 14c646
    $y = freeze($x);
Packit 14c646
Packit 14c646
    ok(eval {thaw($y)}, "empty serialized") or diag $@; # <-- dies here with "Bad data"
Packit 14c646
}
Packit 14c646
Packit 14c646
{
Packit 14c646
    {
Packit 14c646
        package FreezeHookDies;
Packit 14c646
        sub STORABLE_freeze {
Packit 14c646
            die ${$_[0]}
Packit 14c646
        }
Packit 14c646
Packit 14c646
	package ThawHookDies;
Packit 14c646
	sub STORABLE_freeze {
Packit 14c646
	    my ($self, $cloning) = @_;
Packit 14c646
	    my $tmp = $$self;
Packit 14c646
	    return "a", \$tmp;
Packit 14c646
	}
Packit 14c646
	sub STORABLE_thaw {
Packit 14c646
	    my ($self, $cloning, $str, $obj) = @_;
Packit 14c646
	    die $$obj;
Packit 14c646
	}
Packit 14c646
    }
Packit 14c646
    my $x = bless \(my $tmpx = "Foo"), "FreezeHookDies";
Packit 14c646
    my $y = bless \(my $tmpy = []), "FreezeHookDies";
Packit 14c646
Packit 14c646
    ok(!eval { store($x, "store$$"); 1 }, "store of hook which throws no NL died");
Packit 14c646
    ok(!eval { store($y, "store$$"); 1 }, "store of hook which throws ref died");
Packit 14c646
Packit 14c646
    ok(!eval { freeze($x); 1 }, "freeze of hook which throws no NL died");
Packit 14c646
    ok(!eval { freeze($y); 1 }, "freeze of hook which throws ref died");
Packit 14c646
Packit 14c646
    ok(!eval { dclone($x); 1 }, "dclone of hook which throws no NL died");
Packit 14c646
    ok(!eval { dclone($y); 1 }, "dclone of hook which throws ref died");
Packit 14c646
Packit 14c646
    my $ostr = bless \(my $tmpstr = "Foo"), "ThawHookDies";
Packit 14c646
    my $oref = bless \(my $tmpref = []), "ThawHookDies";
Packit 14c646
    ok(store($ostr, "store$$"), "save throw Foo on thaw");
Packit 14c646
    ok(!eval { retrieve("store$$"); 1 }, "retrieve of throw Foo on thaw died");
Packit 14c646
    open FH, "<", "store$$" or die;
Packit 14c646
    binmode FH;
Packit 14c646
    ok(!eval { fd_retrieve(*FH); 1 }, "fd_retrieve of throw Foo on thaw died");
Packit 14c646
    ok(!ref $@, "right thing thrown");
Packit 14c646
    close FH;
Packit 14c646
    ok(store($oref, "store$$"), "save throw ref on thaw");
Packit 14c646
    ok(!eval { retrieve("store$$"); 1 }, "retrieve of throw ref on thaw died");
Packit 14c646
    open FH, "<", "store$$" or die;
Packit 14c646
    binmode FH;
Packit 14c646
    ok(!eval { fd_retrieve(*FH); 1 }, "fd_retrieve of throw [] on thaw died");
Packit 14c646
    ok(ref $@, "right thing thrown");
Packit 14c646
    close FH;
Packit 14c646
Packit 14c646
    my $strdata = freeze($ostr);
Packit 14c646
    ok(!eval { thaw($strdata); 1 }, "thaw of throw Foo on thaw died");
Packit 14c646
    ok(!ref $@, "and a string thrown");
Packit 14c646
    my $refdata = freeze($oref);
Packit 14c646
    ok(!eval { thaw($refdata); 1 }, "thaw of throw [] on thaw died");
Packit 14c646
    ok(ref $@, "and a ref thrown");
Packit 14c646
Packit 14c646
    unlink("store$$");
Packit 14c646
}