X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=t%2F52leaks.t;h=4d029f092625c71b98d23df5fcbf40684a78c820;hb=21aa86aae083ccb5b94ba994dec030627e95e40b;hp=793e0364aacb7e8a3d40cbe552af5650ab95c76b;hpb=65d351219882184861384aedac6f251b6797d0d7;p=dbsrgits%2FDBIx-Class.git diff --git a/t/52leaks.t b/t/52leaks.t index 793e036..4d029f0 100644 --- a/t/52leaks.t +++ b/t/52leaks.t @@ -23,21 +23,32 @@ use Test::More; my $TB = Test::More->builder; if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) { - # without this explicit close ->reset below warns - close ($TB->$_) for qw/output failure_output/; + # 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/); + } - # so done_testing can work - $TB->reset; + # 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); + } - # this simulates a subtest - $TB->_indent(' ' x 4); + 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; -use DBICTest::Util qw/populate_weakregistry assert_empty_weakregistry/; +use DBICTest::Util::LeakTracer qw(populate_weakregistry assert_empty_weakregistry visit_refs); use DBIx::Class; -use B 'svref_2object'; BEGIN { plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test" if DBIx::Class::_ENV_::PEEPEENESS; @@ -67,6 +78,15 @@ unless (DBICTest::RunMode->is_plain) { } ); + # unicode is tricky, and now we happen to invoke it early via a + # regex in connection() + return $obj if (ref $obj) =~ /^utf8/; + + # 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::/; + # weaken immediately to avoid weird side effects return populate_weakregistry ($weak_registry, $obj ); }; @@ -90,11 +110,11 @@ unless (DBICTest::RunMode->is_plain) { require DBI; require DBD::SQLite; require FileHandle; + require Moo; %$weak_registry = (); } -my @compose_ns_classes; { use_ok ('DBICTest'); @@ -102,8 +122,6 @@ my @compose_ns_classes; 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->search({}, { rows => 1})->next; # so that commits/rollbacks work @@ -235,9 +253,14 @@ my @compose_ns_classes; leaky_resultset => $rs_bind_circref, leaky_resultset_cond => $cond_rowobj, - leaky_resultset_member => $rs_bind_circref->next, }; + # 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, @@ -252,6 +275,24 @@ my @compose_ns_classes; pager => $pager, ); + # FIXME - ideally this kind of collector ought to be global, but attempts + # with an invasive debugger-based tracer did not quite work out... yet + # Manually scan the innards of everything we have in the base collection + # we assembled so far (skip the DT madness below) *recursively* + # + # Only do this when we do have the bits to look inside CVs properly, + # without it we are liable to pick up object defaults that are locked + # in method closures + if (DBICTest::Util::LeakTracer::CV_TRACING) { + visit_refs( + refs => [ $base_collection ], + action => sub { + populate_weakregistry ($weak_registry, $_[0]); + 1; # true means "keep descending" + }, + ); + } + if ($has_dt) { my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event'); @@ -272,15 +313,6 @@ my @compose_ns_classes; $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; } @@ -290,7 +322,7 @@ my @compose_ns_classes; { my $phantom; for ( - sub { DBICTest->init_schema }, + sub { DBICTest->init_schema( sqlite_use_file => 0 ) }, sub { shift->source('Artist') }, sub { shift->resultset }, sub { shift->result_source }, @@ -323,75 +355,35 @@ my @compose_ns_classes; # Naturally we have some exceptions my $cleared; -for my $slot (keys %$weak_registry) { - if ($slot =~ /^Test::Builder/) { +for my $addr (keys %$weak_registry) { + my $names = join "\n", keys %{$weak_registry->{$addr}{slot_names}}; + + if ($names =~ /^Test::Builder/m) { # 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}; + delete $weak_registry->{$addr}; } - elsif ($slot =~ /^SQL::Translator/) { - # SQLT is a piece of shit, leaks all over - delete $weak_registry->{$slot}; - } - elsif ($slot =~ /^Hash::Merge/) { + elsif ($names =~ /^Hash::Merge/m) { # 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 (DBIx::Class::_ENV_::INVISIBLE_DOLLAR_AT and $slot =~ /^__TxnScopeGuard__FIXUP__/) { - delete $weak_registry->{$slot} - } - elsif ($slot =~ /^DateTime::TimeZone/) { - # DT is going through a refactor it seems - let it leak zones for now - delete $weak_registry->{$slot}; + delete $weak_registry->{$addr} + unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++; } } -# 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" ); - - # ignore it - delete $weak_registry->{$rs_class->result_source_instance}; -} - -# 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 --> {cached_kids} +# $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids} # ^ / # \-------- bound value on prepared/cached STH <-----------/ # -TODO: { - local $TODO = 'Not sure how to fix this yet, an entanglment could be an option'; - my $r = $weak_registry->{'basic leaky_resultset_cond'}{weakref}; - ok(! defined $r, 'We no longer leak!') - or $r->result_source(undef); +{ + 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); @@ -401,70 +393,79 @@ assert_empty_weakregistry ($weak_registry); # this is ugly and dirty but we do not yet have a Test::Embedded or # similar -my @pperl_cmd = (qw/pperl --prefork=1/, __FILE__); -my @pperl_term_cmd = @pperl_cmd; -splice @pperl_term_cmd, 1, 0, '--kill'; +# 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__], + }, +}; # scgi is smart and will auto-reap after -t amount of seconds -my @scgi_cmd = (qw/speedy -- -t5/, __FILE__); +# pperl needs an actual killer :( +$persistence_tests->{PPerl}{termcmd} = [ + $persistence_tests->{PPerl}{cmd}[0], + '--kill', + @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ], +]; SKIP: { skip 'Test already in a persistent loop', 1 if $ENV{DBICTEST_IN_PERSISTENT_ENV}; - skip 'Persistence test disabled on regular installs', 1 - if DBICTest::RunMode->is_plain; - skip 'Main test failed - skipping persistent env tests', 1 unless $TB->is_passing; - # set up -I - require Config; - local $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC); - local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1; - # try with pperl - SKIP: { - skip 'PPerl persistent environment tests require PPerl', 1 - unless eval { require PPerl }; - - # since PPerl is racy and sucks - just prime the "server" - { - local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1; - system(@pperl_cmd); - sleep 1; - - # see if it actually runs - if not might as well bail now - skip "Something is wrong with pperl ($!)", 1 - if system(@pperl_cmd); - } + require IPC::Open2; - for (1,2,3) { - system(@pperl_cmd); - ok (!$?, "Run in persistent env (PPerl pass $_): exit $?"); + for my $type (keys %$persistence_tests) { SKIP: { + unless (eval "require $type") { + # Don't terminate what we didn't start + delete $persistence_tests->{$type}{termcmd}; + skip "$type module not found", 1; } - ok (! system (@pperl_term_cmd), 'killed pperl instance'); - } - - # try with speedy-cgi - SKIP: { - skip 'SPeedyCGI persistent environment tests require CGI::SpeedyCGI', 1 - unless eval { require CGI::SpeedyCGI }; + my @cmd = @{$persistence_tests->{$type}{cmd}}; + # since PPerl is racy and sucks - just prime the "server" { local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1; - skip "Something is wrong with speedy ($!)", 1 - if system(@scgi_cmd); + 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); } for (1,2,3) { - system(@scgi_cmd); - ok (!$?, "Run in persistent env (SpeedyCGI pass $_): exit $?"); + 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; @@ -473,9 +474,9 @@ done_testing; # PID files to go by (man does pperl really suck :( END { unless ($ENV{DBICTEST_IN_PERSISTENT_ENV}) { - close STDOUT; - close STDERR; + close $_ for (*STDIN, *STDOUT, *STDERR); local $?; # otherwise test will inherit $? of the system() - system (@pperl_term_cmd); + system (@{$persistence_tests->{PPerl}{termcmd}}) + if $persistence_tests->{PPerl}{termcmd}; } }