+# work around brain damage in PPerl (yes, it has to be a global)
+$SIG{__WARN__} = sub {
+ warn @_ unless $_[0] =~ /\QUse of "goto" to jump into a construct is deprecated/
+} if ($ENV{DBICTEST_IN_PERSISTENT_ENV});
+
+# the persistent environments run with this flag first to see if
+# we will run at all (e.g. it will fail if $^X doesn't match)
+exit 0 if $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY};
+
+# Do the override as early as possible so that CORE::bless doesn't get compiled away
+# We will replace $bless_override only if we are in author mode
+my $bless_override;
+BEGIN {
+ $bless_override = sub {
+ CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() );
+ };
+ *CORE::GLOBAL::bless = sub { goto $bless_override };
+}
+
use strict;
use warnings;
-
use Test::More;
-use Scalar::Util qw/refaddr reftype weaken/;
-use Carp qw/longmess/;
-use Try::Tiny;
+
+my $TB = Test::More->builder;
+if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
+ # without this explicit close older TBs warn in END after a ->reset
+ if ($TB->VERSION < 1.005) {
+ close ($TB->$_) for (qw/output failure_output todo_output/);
+ }
+
+ # if I do not do this, I get happy sigpipes on new TB, no idea why
+ # (the above close-and-forget doesn't work - new TB does *not* reopen
+ # its handles automatically anymore)
+ else {
+ for (qw/failure_output todo_output/) {
+ close $TB->$_;
+ open ($TB->$_, '>&', *STDERR);
+ }
+
+ close $TB->output;
+ open ($TB->output, '>&', *STDOUT);
+ }
+
+ # so done_testing can work on every persistent pass
+ $TB->reset;
+}
use lib qw(t/lib);
use DBICTest::RunMode;
-
-my $have_test_cycle;
+use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/;
+use Scalar::Util 'refaddr';
+use DBIx::Class;
+use B 'svref_2object';
BEGIN {
- require DBIx::Class::Optional::Dependencies;
- $have_test_cycle = DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks')
- and import Test::Memory::Cycle;
+ plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
+ if DBIx::Class::_ENV_::PEEPEENESS;
}
-# preload stuff so that we don't trap globals
-use DBI;
-use Errno;
-use Class::Struct;
-use DBD::SQLite;
-use FileHandle;
-
# this is what holds all weakened refs to be checked for leakage
my $weak_registry = {};
+# whether or to invoke IC::DT
+my $has_dt;
+
# Skip the heavy-duty leak tracing when just doing an install
unless (DBICTest::RunMode->is_plain) {
+
+ # redefine the bless override so that we can catch each and every object created
no warnings qw/redefine once/;
no strict qw/refs/;
- # override bless so that we can catch each and every object created
- *CORE::GLOBAL::bless = sub {
+ $bless_override = sub {
+
my $obj = CORE::bless(
$_[0], (@_ > 1) ? $_[1] : do {
my ($class, $fn, $line) = caller();
}
);
- my $slot = (sprintf '%s=%s(0x%x)', # so we don't trigger stringification
- ref $obj,
- reftype $obj,
- refaddr $obj,
- );
+ # unicode is tricky, and now we happen to invoke it early via a
+ # regex in connection()
+ return $obj if (ref $obj) =~ /^utf8/;
- # weaken immediately to avoid weird side effects
- $weak_registry->{$slot} = { weakref => $obj, strace => longmess() };
- weaken $weak_registry->{$slot}{weakref};
+ # Test Builder is now making a new object for every pass/fail (que bloat?)
+ # and as such we can't really store any of its objects (since it will
+ # re-populate the registry while checking it, ewwww!)
+ return $obj if (ref $obj) =~ /^TB2::/;
- return $obj;
+ # weaken immediately to avoid weird side effects
+ return populate_weakregistry ($weak_registry, $obj );
};
+ require Try::Tiny;
for my $func (qw/try catch finally/) {
my $orig = \&{"Try::Tiny::$func"};
*{"Try::Tiny::$func"} = sub (&;@) {
-
- my $slot = sprintf ('CODE(0x%x)', refaddr $_[0]);
-
- $weak_registry->{$slot} = { weakref => $_[0], strace => longmess() };
- weaken $weak_registry->{$slot}{weakref};
-
+ populate_weakregistry( $weak_registry, $_[0] );
goto $orig;
}
}
+
+ # Some modules are known to install singletons on-load
+ # Load them and empty the registry
+
+ # this loads the DT armada
+ $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for('test_dt_sqlite');
+
+ require Errno;
+ require DBI;
+ require DBD::SQLite;
+ require FileHandle;
+ require Moo;
+
+ %$weak_registry = ();
}
+my @compose_ns_classes;
{
- require DBICTest;
+ use_ok ('DBICTest');
my $schema = DBICTest->init_schema;
my $rs = $schema->resultset ('Artist');
my $storage = $schema->storage;
+ @compose_ns_classes = map { "DBICTest::${_}" } keys %{$schema->source_registrations};
+
ok ($storage->connected, 'we are connected');
- my $row_obj = $rs->next;
+ my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
ok ($row_obj, 'row from db');
+ # txn_do to invoke more codepaths
my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
- my $artist = $rs->create ({
+ my $artist = $schema->resultset('Artist')->create ({
name => 'foo artist',
cds => [{
title => 'foo cd',
year => 1984,
+ tracks => [
+ { title => 't1' },
+ { title => 't2' },
+ ],
+ genre => { name => 'mauve' },
}],
});
return ($artist, $pg, $pg_wcount);
});
+ # more codepaths - error handling in txn_do
+ {
+ eval { $schema->txn_do ( sub {
+ $storage->_dbh->begin_work;
+ fail ('how did we get so far?!');
+ } ) };
+
+ eval { $schema->txn_do ( sub {
+ $schema->txn_do ( sub {
+ die "It's called EXCEPTION";
+ fail ('how did we get so far?!');
+ } );
+ fail ('how did we get so far?!');
+ } ) };
+ like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
+ }
+
+ # dbh_do codepath
+ my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
+ my $row = $_[0]->schema->resultset('Artist')->new({});
+ my $rs = $_[0]->schema->resultset('Artist')->search({
+ name => $row, # this is deliberately bogus, see FIXME below!
+ });
+ return ($rs, $row);
+ });
+
is ($pager->next_page, 3, 'There is one more page available');
# based on 66 per 10 pages
is ($pager_explicit_count->last_page, 7, 'Correct last page');
- my $base_collection = {
- schema => $schema,
- storage => $storage,
+ # do some population (invokes some extra codepaths)
+ # also exercise the guard code and the manual txn control
+ {
+ my $guard = $schema->txn_scope_guard;
+ # populate with bindvars
+ $rs->populate([{ name => 'James Bound' }]);
+ $guard->commit;
+
+ $schema->txn_begin;
+ # populate mixed
+ $rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
+ $schema->txn_commit;
+
+ $schema->txn_begin;
+ # and without bindvars
+ $rs->populate([{ name => \ '"James Unbound"' }]);
+ $schema->txn_rollback;
+ }
+
+ # prefetching
+ my $cds_rs = $schema->resultset('CD');
+ my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
+ my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
+ my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
+
+ # implicit pref
+ my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
+
+ # get_column
+ my $getcol_rs = $cds_rs->get_column('me.cdid');
+ my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
+
+ # fire the column getters
+ my @throwaway = $pref_getcol_rs->all;
+ my $base_collection = {
resultset => $rs,
+
+ pref_precursor => $cds_rs,
+
+ pref_rs_single => $cds_with_artist,
+ pref_rs_multi => $cds_with_tracks,
+ pref_rs_nested => $cds_with_stuff,
+
+ pref_rs_implicit => $cds_with_impl_artist,
+
+ pref_row_single => $cds_with_artist->next,
+ pref_row_multi => $cds_with_tracks->next,
+ pref_row_nested => $cds_with_stuff->next,
+
+ # even though this does not leak Storable croaks on it :(((
+ #pref_row_implicit => $cds_with_impl_artist->next,
+
+ get_column_rs_plain => $getcol_rs,
+ get_column_rs_pref => $pref_getcol_rs,
+
+ # twice so that we make sure only one H::M object spawned
+ chained_resultset => $rs->search_rs ({}, { '+columns' => [ 'foo' ] } ),
+ chained_resultset2 => $rs->search_rs ({}, { '+columns' => [ 'bar' ] } ),
+
row_object => $row_obj,
+ mc_row_object => $mc_row_obj,
+
result_source => $rs->result_source,
- fresh_pager => $rs->page(5)->pager,
- pager => $pager,
+ result_source_handle => $rs->result_source->handle,
+
pager_explicit_count => $pager_explicit_count,
- sql_maker => $storage->sql_maker,
- dbh => $storage->_dbh
+ leaky_resultset => $rs_bind_circref,
+ leaky_resultset_cond => $cond_rowobj,
};
- memory_cycle_ok ($base_collection, 'No cycles in the object collection')
- if $have_test_cycle;
+ # this needs to fire, even if it can't find anything
+ # see FIXME below
+ # we run this only on smokers - trying to establish a pattern
+ $rs_bind_circref->next
+ if ( ($ENV{TRAVIS}||'') ne 'true' and DBICTest::RunMode->is_smoker);
+
+ require Storable;
+ %$base_collection = (
+ %$base_collection,
+ refrozen => Storable::dclone( $base_collection ),
+ rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
+ pref_row_implicit => $cds_with_impl_artist->next,
+ schema => $schema,
+ storage => $storage,
+ sql_maker => $storage->sql_maker,
+ dbh => $storage->_dbh,
+ fresh_pager => $rs->page(5)->pager,
+ pager => $pager,
+ );
+
+ if ($has_dt) {
+ my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
- for (keys %$base_collection) {
- $weak_registry->{"basic $_"} = { weakref => $base_collection->{$_} };
- weaken $weak_registry->{"basic $_"}{weakref};
+ my $now = DateTime->now;
+ for (1..5) {
+ $base_collection->{"icdt_row_$_"} = $rs->create({
+ created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
+ starts_at => $now->clone->add(days => $_),
+ });
+ }
+
+ # re-search
+ my @dummy = $rs->all;
+ }
+
+ # dbh's are created in XS space, so pull them separately
+ for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
+ $base_collection->{"DBI handle $_"} = $_;
}
+ SKIP: {
+ if ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks') ) {
+ Test::Memory::Cycle::memory_cycle_ok ($base_collection, 'No cycles in the object collection')
+ }
+ else {
+ skip 'Circular ref test needs ' . DBIx::Class::Optional::Dependencies->req_missing_for ('test_leaks'), 1;
+ }
+ }
+
+ populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
+ for keys %$base_collection;
}
-memory_cycle_ok($weak_registry, 'No cycles in the weakened object collection')
- if $have_test_cycle;
+# check that "phantom-chaining" works - we never lose track of the original $schema
+# and have access to the entire tree without leaking anything
+{
+ my $phantom;
+ for (
+ sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
+ sub { shift->source('Artist') },
+ sub { shift->resultset },
+ sub { shift->result_source },
+ sub { shift->schema },
+ sub { shift->resultset('Artist') },
+ sub { shift->find_or_create({ name => 'detachable' }) },
+ sub { shift->result_source },
+ sub { shift->schema },
+ sub { shift->clone },
+ sub { shift->resultset('CD') },
+ sub { shift->next },
+ sub { shift->artist },
+ sub { shift->search_related('cds') },
+ sub { shift->next },
+ sub { shift->search_related('artist') },
+ sub { shift->result_source },
+ sub { shift->resultset },
+ sub { shift->create({ name => 'detached' }) },
+ sub { shift->update({ name => 'reattached' }) },
+ sub { shift->discard_changes },
+ sub { shift->delete },
+ sub { shift->insert },
+ ) {
+ $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
+ }
+
+ ok( $phantom->in_storage, 'Properly deleted/reinserted' );
+ is( $phantom->name, 'reattached', 'Still correct name' );
+}
+
+# Naturally we have some exceptions
+my $cleared;
+for my $slot (keys %$weak_registry) {
+ if ($slot =~ /^Test::Builder/) {
+ # T::B 2.0 has result objects and other fancyness
+ delete $weak_registry->{$slot};
+ }
+ elsif ($slot =~ /^Method::Generate::(?:Accessor|Constructor)/) {
+ # Moo keeps globals around, this is normal
+ delete $weak_registry->{$slot};
+ }
+ elsif ($slot =~ /^SQL::Translator::Generator::DDL::SQLite/) {
+ # SQLT::Producer::SQLite keeps global generators around for quoted
+ # and non-quoted DDL, allow one for each quoting style
+ delete $weak_registry->{$slot}
+ unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$slot}{weakref}->quote_chars}}++;
+ }
+ elsif ($slot =~ /^Hash::Merge/) {
+ # only clear one object of a specific behavior - more would indicate trouble
+ delete $weak_registry->{$slot}
+ unless $cleared->{hash_merge_singleton}{$weak_registry->{$slot}{weakref}{behavior}}++;
+ }
+ elsif ($slot =~ /^DateTime::TimeZone/) {
+ # DT is going through a refactor it seems - let it leak zones for now
+ delete $weak_registry->{$slot};
+ }
+}
-# FIXME
-# For reasons I can not yet fully understand the table() god-method (located in
-# ::ResultSourceProxy::Table) attaches an actual source instance to each class
-# as virtually *immortal* class-data.
-# For now just blow away these instances manually but there got to be a saner way
-$_->result_source_instance(undef) for (
+# every result class has a result source instance as classdata
+# make sure these are all present and distinct before ignoring
+# (distinct means only 1 reference)
+for my $rs_class (
'DBICTest::BaseResult',
+ @compose_ns_classes,
map { DBICTest::Schema->class ($_) } DBICTest::Schema->sources
-);
+) {
+ # need to store the SVref and examine it separately, to push the rsrc instance off the pad
+ my $SV = svref_2object($rs_class->result_source_instance);
+ is( $SV->REFCNT, 1, "Source instance of $rs_class referenced exactly once" );
-# FIXME
-# same problem goes for the schema - its classdata contains live result source
-# objects, which to add insult to the injury are *different* instances from the
-# ones we destroyed above
-DBICTest::Schema->source_registrations(undef);
+ # ignore it
+ delete $weak_registry->{$rs_class->result_source_instance};
+}
-my $tb = Test::More->builder;
-for my $slot (keys %$weak_registry) {
- # SQLT is a piece of shit, leaks all over
- next if $slot =~ /^SQL\:\:Translator/;
+# Schema classes also hold sources, but these are clones, since
+# each source contains the schema (or schema class name in this case)
+# Hence the clone so that the same source can be registered with
+# multiple schemas
+for my $moniker ( keys %{DBICTest::Schema->source_registrations || {}} ) {
+
+ my $SV = svref_2object(DBICTest::Schema->source($moniker));
+ is( $SV->REFCNT, 1, "Source instance registered under DBICTest::Schema as $moniker referenced exactly once" );
+
+ delete $weak_registry->{DBICTest::Schema->source($moniker)};
+}
+
+# FIXME !!!
+# There is an actual strong circular reference taking place here, but because
+# half of it is in XS no leaktracer sees it, and Devel::FindRef is equally
+# stumped when trying to trace the origin. The problem is:
+#
+# $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
+# ^ /
+# \-------- bound value on prepared/cached STH <-----------/
+#
+{
+ local $TODO = 'This fails intermittently - see RT#82942';
+ if ( my $r = $weak_registry->{'basic leaky_resultset_cond'}{weakref} ) {
+ ok(! defined $r, 'Self-referential RS conditions no longer leak!')
+ or $r->result_source(undef);
+ }
+}
+
+assert_empty_weakregistry ($weak_registry);
+
+# we got so far without a failure - this is a good thing
+# now let's try to rerun this script under a "persistent" environment
+# this is ugly and dirty but we do not yet have a Test::Embedded or
+# similar
+
+# set up -I
+require Config;
+$ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
+($ENV{PATH}) = $ENV{PATH} =~ /(.+)/;
+
+
+my $persistence_tests = {
+ PPerl => {
+ cmd => [qw/pperl --prefork=1/, __FILE__],
+ },
+ 'CGI::SpeedyCGI' => {
+ cmd => [qw/speedy -- -t5/, __FILE__],
+ },
+};
- ok (! defined $weak_registry->{$slot}{weakref}, "No leaks of $slot") or do {
- my $diag = '';
+# scgi is smart and will auto-reap after -t amount of seconds
+# pperl needs an actual killer :(
+$persistence_tests->{PPerl}{termcmd} = [
+ $persistence_tests->{PPerl}{cmd}[0],
+ '--kill',
+ @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
+];
- $diag .= Devel::FindRef::track ($weak_registry->{$slot}{weakref}, 20) . "\n"
- if ( $ENV{TEST_VERBOSE} && try { require Devel::FindRef });
+SKIP: {
+ skip 'Test already in a persistent loop', 1
+ if $ENV{DBICTEST_IN_PERSISTENT_ENV};
- if (my $stack = $weak_registry->{$slot}{strace}) {
- $diag .= " Reference first seen$stack";
+ skip 'Main test failed - skipping persistent env tests', 1
+ unless $TB->is_passing;
+
+ local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
+
+ require IPC::Open2;
+
+ for my $type (keys %$persistence_tests) { SKIP: {
+ skip "$type module not found", 1
+ unless eval "require $type";
+
+ my @cmd = @{$persistence_tests->{$type}{cmd}};
+
+ # since PPerl is racy and sucks - just prime the "server"
+ {
+ local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
+ system(@cmd);
+ sleep 1;
+
+ # see if the thing actually runs, if not - might as well bail now
+ skip "Something is wrong with $type ($!)", 1
+ if system(@cmd);
}
- diag $diag if $diag;
- };
+ for (1,2,3) {
+ note ("Starting run in persistent env ($type pass $_)");
+ IPC::Open2::open2(my $out, undef, @cmd);
+ my @out_lines;
+ while (my $ln = <$out>) {
+ next if $ln =~ /^\s*$/;
+ push @out_lines, " $ln";
+ last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
+ }
+ print $_ for @out_lines;
+ close $out;
+ wait;
+ ok (!$?, "Run in persistent env ($type pass $_): exit $?");
+ ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
+ }
+
+ ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
+ if $persistence_tests->{$type}{termcmd};
+ }}
}
done_testing;
+
+# just an extra precaution in case we blew away from the SKIP - since there are no
+# PID files to go by (man does pperl really suck :(
+END {
+ unless ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
+ close $_ for (*STDIN, *STDOUT, *STDERR);
+ local $?; # otherwise test will inherit $? of the system()
+ system (@{$persistence_tests->{PPerl}{termcmd}});
+ }
+}
projects / dbsrgits/DBIx-Class.git / blobdiff