1 BEGIN { do "./t/lib/ANFANG.pm" or die ( $@ || $! ) }
3 # work around brain damage in PPerl (yes, it has to be a global)
5 warn @_ unless $_[0] =~ /\QUse of "goto" to jump into a construct is deprecated/
6 } if ($ENV{DBICTEST_IN_PERSISTENT_ENV});
8 # the persistent environments run with this flag first to see if
9 # we will run at all (e.g. it will fail if $^X doesn't match)
10 exit 0 if $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY};
12 # Do the override as early as possible so that CORE::bless doesn't get compiled away
13 # We will replace $bless_override only if we are in author mode
16 $bless_override = sub {
17 CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() );
19 *CORE::GLOBAL::bless = sub { goto $bless_override };
27 require DBICTest::Util;
28 plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
29 if DBICTest::Util::PEEPEENESS();
32 use DBICTest::RunMode;
33 use DBICTest::Util::LeakTracer qw(populate_weakregistry assert_empty_weakregistry visit_refs);
34 use Scalar::Util qw(weaken blessed reftype);
35 use DBIx::Class::_Util qw(hrefaddr sigwarn_silencer modver_gt_or_eq modver_gt_or_eq_and_lt);
36 use DBIx::Class::Optional::Dependencies;
38 my $TB = Test::More->builder;
39 if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
40 # without this explicit close TB warns in END after a ->reset
41 close ($TB->$_) for qw(output failure_output todo_output);
43 # newer TB does not auto-reopen handles
44 if ( modver_gt_or_eq( 'Test::More', '1.200' ) ) {
45 open ($TB->$_, '>&', *STDERR)
46 for qw( failure_output todo_output );
47 open ($TB->output, '>&', *STDOUT);
50 # so done_testing can work on every persistent pass
54 # this is what holds all weakened refs to be checked for leakage
55 my $weak_registry = {};
57 # whether or to invoke IC::DT
60 # Skip the heavy-duty leak tracing when just doing an install
61 # or when having Moose crap all over everything
62 if ( !$ENV{DBICTEST_VIA_REPLICATED} and !DBICTest::RunMode->is_plain ) {
64 # redefine the bless override so that we can catch each and every object created
65 no warnings qw/redefine once/;
68 $bless_override = sub {
70 my $obj = CORE::bless(
71 $_[0], (@_ > 1) ? $_[1] : do {
72 my ($class, $fn, $line) = caller();
73 fail ("bless() of $_[0] into $class without explicit class specification at $fn line $line")
74 if $class =~ /^ (?: DBIx\:\:Class | DBICTest ) /x;
79 # unicode is tricky, and now we happen to invoke it early via a
80 # regex in connection()
81 return $obj if (ref $obj) =~ /^utf8/;
83 # Test Builder is now making a new object for every pass/fail (que bloat?)
84 # and as such we can't really store any of its objects (since it will
85 # re-populate the registry while checking it, ewwww!)
86 return $obj if (ref $obj) =~ /^TB2::|^Test::Stream/;
88 # populate immediately to avoid weird side effects
89 return populate_weakregistry ($weak_registry, $obj );
93 for my $func (qw/try catch finally/) {
94 my $orig = \&{"Try::Tiny::$func"};
95 *{"Try::Tiny::$func"} = sub (&;@) {
96 populate_weakregistry( $weak_registry, $_[0] );
101 # Some modules are known to install singletons on-load
102 # Load them and empty the registry
104 # this loads the DT armada
105 $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for([qw( test_rdbms_sqlite ic_dt )]);
111 %$weak_registry = ();
117 my $schema = DBICTest->init_schema;
118 my $rs = $schema->resultset ('Artist');
119 my $storage = $schema->storage;
121 my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
122 ok ($row_obj, 'row from db');
124 # txn_do to invoke more codepaths
125 my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
127 my $artist = $schema->resultset('Artist')->create ({
128 name => 'foo artist',
136 genre => { name => 'mauve' },
140 my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
142 my $pg_wcount = $rs->page(4)->pager->total_entries (66);
144 return ($artist, $pg, $pg_wcount);
147 # more codepaths - error handling in txn_do
149 eval { $schema->txn_do ( sub {
150 $storage->_dbh->begin_work;
151 fail ('how did we get so far?!');
154 eval { $schema->txn_do ( sub {
155 $schema->txn_do ( sub {
156 die "It's called EXCEPTION";
157 fail ('how did we get so far?!');
159 fail ('how did we get so far?!');
161 like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
165 my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
166 my $row = $_[0]->schema->resultset('Artist')->new({});
167 my $rs = $_[0]->schema->resultset('Artist')->search({
168 name => $row, # this is deliberately bogus, see FIXME below!
173 is ($pager->next_page, 3, 'There is one more page available');
175 # based on 66 per 10 pages
176 is ($pager_explicit_count->last_page, 7, 'Correct last page');
178 # do some population (invokes some extra codepaths)
179 # also exercise the guard code and the manual txn control
181 my $guard = $schema->txn_scope_guard;
182 # populate with bindvars
183 $rs->populate([{ name => 'James Bound' }]);
188 $rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
192 # and without bindvars
193 $rs->populate([{ name => \ '"James Unbound"' }]);
194 $schema->txn_rollback;
198 my $cds_rs = $schema->resultset('CD');
199 my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
200 my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
201 my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
204 my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
207 my $getcol_rs = $cds_rs->get_column('me.cdid');
208 my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
210 my $base_collection = {
213 pref_precursor => $cds_rs,
215 pref_rs_single => $cds_with_artist,
216 pref_rs_multi => $cds_with_tracks,
217 pref_rs_nested => $cds_with_stuff,
219 pref_rs_implicit => $cds_with_impl_artist,
221 pref_row_single => $cds_with_artist->next,
222 pref_row_multi => $cds_with_tracks->next,
223 pref_row_nested => $cds_with_stuff->next,
225 # even though this does not leak Storable croaks on it :(((
226 #pref_row_implicit => $cds_with_impl_artist->next,
228 get_column_rs_plain => $getcol_rs,
229 get_column_rs_pref => $pref_getcol_rs,
231 # twice so that we make sure only one H::M object spawned
232 chained_resultset => $rs->search_rs ({}, { '+columns' => { foo => 'artistid' } } ),
233 chained_resultset2 => $rs->search_rs ({}, { '+columns' => { bar => 'artistid' } } ),
235 row_object => $row_obj,
237 mc_row_object => $mc_row_obj,
239 result_source => $rs->result_source,
241 result_source_handle => $rs->result_source->handle,
243 pager_explicit_count => $pager_explicit_count,
245 leaky_resultset => $rs_bind_circref,
246 leaky_resultset_cond => $cond_rowobj,
249 # fire all resultsets multiple times, once here, more below
250 # some of these can't find anything (notably leaky_resultset)
255 $_->isa('DBIx::Class::ResultSet')
257 $_->isa('DBIx::Class::ResultSetColumn')
259 } values %$base_collection;
262 my $fire_resultsets = sub {
263 local $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS} = 1;
264 local $SIG{__WARN__} = sigwarn_silencer(
265 qr/Unable to deflate 'filter'-type relationship 'artist'.+related object primary key not retrieved/
269 { $_, (blessed($_) ? { $_->get_columns } : ()) }
276 push @{$base_collection->{random_results}}, $fire_resultsets->();
278 # FIXME - something throws a Storable for a spin if we keep
279 # the results in-collection. The same problem is seen above,
280 # swept under the rug back in 0a03206a, damned lazy ribantainer
282 local $base_collection->{random_results};
285 %$base_collection = (
287 refrozen => Storable::dclone( $base_collection ),
288 rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
289 pref_row_implicit => $cds_with_impl_artist->next,
292 sql_maker => $storage->sql_maker,
293 dbh => $storage->_dbh,
294 fresh_pager => $rs->page(5)->pager,
299 # FIXME - ideally this kind of collector ought to be global, but attempts
300 # with an invasive debugger-based tracer did not quite work out... yet
301 # Manually scan the innards of everything we have in the base collection
302 # we assembled so far (skip the DT madness below) *recursively*
304 # Only do this when we do have the bits to look inside CVs properly,
305 # without it we are liable to pick up object defaults that are locked
307 if (DBICTest::Util::LeakTracer::CV_TRACING) {
309 refs => [ $base_collection ],
311 populate_weakregistry ($weak_registry, $_[0]);
312 1; # true means "keep descending"
316 # do a heavy-duty fire-and-compare loop on all resultsets
317 # this is expensive - not running on install
320 ! DBICTest::RunMode->is_plain
322 ! $ENV{DBICTEST_IN_PERSISTENT_ENV}
325 # FIXME - ideally we should be able to just populate an alternative
326 # registry, subtract everything from the main one, and arrive at
327 # an "empty" resulting hash
328 # However due to gross inefficiencies in the ::ResultSet code we
329 # end up recalculating a new set of aliasmaps which could have very
330 # well been cached if it wasn't for... anyhow
331 # What we do here for the time being is similar to the lazy approach
332 # of Devel::LeakTrace - we just make sure we do not end up with more
333 # reftypes than when we started. At least we are not blanket-counting
334 # SVs like D::LT does, but going by reftype... sigh...
336 for (values %$weak_registry) {
337 if ( my $r = reftype($_->{weakref}) ) {
342 # For now we can only reuse the same registry, see FIXME above/below
343 #for my $interim_wr ({}, {}) {
344 for my $interim_wr ( ($weak_registry) x 4 ) {
347 refs => [ $fire_resultsets->(), @rsets ],
349 populate_weakregistry ($interim_wr, $_[0]);
350 1; # true means "keep descending"
354 # FIXME - this is what *should* be here
356 ## anything we have seen so far is cool
357 #delete @{$interim_wr}{keys %$weak_registry};
359 ## moment of truth - the rest ought to be gone
360 #assert_empty_weakregistry($interim_wr);
363 for (values %$weak_registry) {
364 if ( my $r = reftype($_->{weakref}) ) {
370 for (keys %$typecounts) {
371 fail ("Amount of $_ refs changed by $typecounts->{$_} during resultset mass-execution")
372 if ( abs ($typecounts->{$_}) > 1 ); # there is a pad caught somewhere, the +1/-1 can be ignored
377 my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
379 my $now = DateTime->now;
381 $base_collection->{"icdt_row_$_"} = $rs->create({
382 created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
383 starts_at => $now->clone->add(days => $_),
388 my @dummy = $rs->all;
391 # dbh's are created in XS space, so pull them separately
392 for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
393 $base_collection->{"DBI handle $_"} = $_;
396 populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
397 for keys %$base_collection;
400 # check that "phantom-chaining" works - we never lose track of the original $schema
401 # and have access to the entire tree without leaking anything
405 sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
406 sub { shift->source('Artist') },
407 sub { shift->resultset },
408 sub { shift->result_source },
409 sub { shift->schema },
410 sub { shift->resultset('Artist') },
411 sub { shift->find_or_create({ name => 'detachable' }) },
412 sub { shift->result_source },
413 sub { shift->schema },
414 sub { shift->clone },
415 sub { shift->resultset('CD') },
417 sub { shift->artist },
418 sub { shift->search_related('cds') },
420 sub { shift->search_related('artist') },
421 sub { shift->result_source },
422 sub { shift->resultset },
423 sub { shift->create({ name => 'detached' }) },
424 sub { shift->update({ name => 'reattached' }) },
425 sub { shift->discard_changes },
426 sub { shift->delete },
427 sub { shift->insert },
429 $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
432 ok( $phantom->in_storage, 'Properly deleted/reinserted' );
433 is( $phantom->name, 'reattached', 'Still correct name' );
436 # Naturally we have some exceptions
438 for my $addr (keys %$weak_registry) {
439 my $names = join "\n", keys %{$weak_registry->{$addr}{slot_names}};
441 if ($names =~ /^Test::Builder/m) {
442 # T::B 2.0 has result objects and other fancyness
443 delete $weak_registry->{$addr};
445 # remove this when IO::Dir is gone from SQLT
446 elsif ($INC{"IO/Dir.pm"} and $names =~ /^Class::Struct::Tie_ISA/m) {
447 delete $weak_registry->{$addr};
449 elsif ($names =~ /^Hash::Merge/m) {
450 # only clear one object of a specific behavior - more would indicate trouble
451 delete $weak_registry->{$addr}
452 unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++;
454 elsif ($names =~ /^B::Hooks::EndOfScope::PP::_TieHintHashFieldHash/m) {
455 # there is one tied lexical which stays alive until GC time
456 # https://metacpan.org/source/ETHER/B-Hooks-EndOfScope-0.15/lib/B/Hooks/EndOfScope/PP/FieldHash.pm#L24
457 # simply ignore it here, instead of teaching the leaktracer to examine ties
458 # the latter is possible yet terrible: https://github.com/dbsrgits/dbix-class/blob/v0.082820/t/lib/DBICTest/Util/LeakTracer.pm#L113-L117
459 delete $weak_registry->{$addr}
460 unless $cleared->{bheos_pptiehinthashfieldhash}++;
462 elsif ($names =~ /^DateTime::TimeZone::UTC/m) {
463 # DT is going through a refactor it seems - let it leak zones for now
464 delete $weak_registry->{$addr};
467 # # if we can look at closed over pieces - we will register it as a global
468 # !DBICTest::Util::LeakTracer::CV_TRACING
470 $names =~ /^SQL::Translator::Generator::DDL::SQLite/m
472 # SQLT::Producer::SQLite keeps global generators around for quoted
473 # and non-quoted DDL, allow one for each quoting style
474 delete $weak_registry->{$addr}
475 unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$addr}{weakref}->quote_chars}}++;
480 # There is an actual strong circular reference taking place here, but because
481 # half of it is in XS, so it is a bit harder to track down (it stumps D::FR)
482 # (our tracker does not yet do it, but it'd be nice)
485 # $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
487 # \-------- bound value on prepared/cached STH <-----------/
495 { $_->{slot_names}{'basic leaky_resultset_cond'} }
496 values %$weak_registry
498 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
499 ok(! defined $r, 'Self-referential RS conditions no longer leak!')
500 or push @circreffed, $r;
504 is (scalar @circreffed, 1, 'One resultset expected to leak');
506 # this is useless on its own, it is to showcase the circref-diag
507 # and eventually test it when it is operational
508 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
509 while (@circreffed) {
510 weaken (my $r = shift @circreffed);
512 populate_weakregistry( (my $mini_registry = {}), $r );
513 assert_empty_weakregistry( $mini_registry );
515 $r->result_source(undef);
520 assert_empty_weakregistry ($weak_registry);
522 # we got so far without a failure - this is a good thing
523 # now let's try to rerun this script under a "persistent" environment
524 # this is ugly and dirty but we do not yet have a Test::Embedded or
527 my $persistence_tests;
529 skip 'Test already in a persistent loop', 1
530 if $ENV{DBICTEST_IN_PERSISTENT_ENV};
532 skip 'Main test failed - skipping persistent env tests', 1
533 unless $TB->is_passing;
535 skip "Test::Builder\@@{[ Test::Builder->VERSION ]} known to break persistence tests", 1
536 if modver_gt_or_eq_and_lt( 'Test::More', '1.200', '1.301001_099' );
538 local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
542 $persistence_tests = {
544 cmd => [qw/pperl --prefork=1/, __FILE__],
546 'CGI::SpeedyCGI' => {
547 cmd => [qw/speedy -- -t5/, __FILE__],
551 # scgi is smart and will auto-reap after -t amount of seconds
552 # pperl needs an actual killer :(
553 $persistence_tests->{PPerl}{termcmd} = [
554 $persistence_tests->{PPerl}{cmd}[0],
556 @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
561 $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
564 if (length $ENV{PATH}) {
565 ( $ENV{PATH} ) = join ( $Config::Config{path_sep},
566 map { length($_) ? File::Spec->rel2abs($_) : () }
567 split /\Q$Config::Config{path_sep}/, $ENV{PATH}
571 for my $type (keys %$persistence_tests) { SKIP: {
572 unless (eval "require $type") {
573 # Don't terminate what we didn't start
574 delete $persistence_tests->{$type}{termcmd};
575 skip "$type module not found", 1;
578 my @cmd = @{$persistence_tests->{$type}{cmd}};
580 # since PPerl is racy and sucks - just prime the "server"
582 local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
586 # see if the thing actually runs, if not - might as well bail now
587 skip "Something is wrong with $type ($!)", 1
594 note ("Starting run in persistent env ($type pass $_)");
595 IPC::Open2::open2(my $out, undef, @cmd);
597 while (my $ln = <$out>) {
598 next if $ln =~ /^\s*$/;
599 push @out_lines, " $ln";
600 last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
602 print $_ for @out_lines;
605 ok (!$?, "Run in persistent env ($type pass $_): exit $?");
606 ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
609 ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
610 if $persistence_tests->{$type}{termcmd};
616 # just an extra precaution in case we blew away from the SKIP - since there are no
617 # PID files to go by (man does pperl really suck :(
619 if ($persistence_tests->{PPerl}{termcmd}) {
620 local $?; # otherwise test will inherit $? of the system()
622 open my $null, ">", File::Spec->devnull;
624 IPC::Open3::open3(undef, $null, $null, @{$persistence_tests->{PPerl}{termcmd}}),