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 # FIXME - remove when Replicated gets off Moose
63 if ( !$ENV{DBICTEST_VIA_REPLICATED} and !DBICTest::RunMode->is_plain ) {
65 # redefine the bless override so that we can catch each and every object created
66 no warnings qw/redefine once/;
69 $bless_override = sub {
71 my $obj = CORE::bless(
72 $_[0], (@_ > 1) ? $_[1] : do {
73 my ($class, $fn, $line) = caller();
74 fail ("bless() of $_[0] into $class without explicit class specification at $fn line $line")
75 if $class =~ /^ (?: DBIx\:\:Class | DBICTest ) /x;
80 # unicode is tricky, and now we happen to invoke it early via a
81 # regex in connection()
82 return $obj if (ref $obj) =~ /^utf8/;
84 # Test Builder is now making a new object for every pass/fail (que bloat?)
85 # and as such we can't really store any of its objects (since it will
86 # re-populate the registry while checking it, ewwww!)
87 return $obj if (ref $obj) =~ /^TB2::|^Test::Stream/;
89 # populate immediately to avoid weird side effects
90 return populate_weakregistry ($weak_registry, $obj );
94 for my $func (qw/try catch finally/) {
95 my $orig = \&{"Try::Tiny::$func"};
96 *{"Try::Tiny::$func"} = sub (&;@) {
97 populate_weakregistry( $weak_registry, $_[0] );
102 # Some modules are known to install singletons on-load
103 # Load them and empty the registry
105 # this loads the DT armada
106 $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for([qw( test_rdbms_sqlite ic_dt )]);
111 require Math::BigInt;
113 %$weak_registry = ();
119 my $schema = DBICTest->init_schema;
120 my $rs = $schema->resultset ('Artist');
121 my $storage = $schema->storage;
123 my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
124 ok ($row_obj, 'row from db');
126 # txn_do to invoke more codepaths
127 my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
129 my $artist = $schema->resultset('Artist')->create ({
130 name => 'foo artist',
138 genre => { name => 'mauve' },
142 my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
144 my $pg_wcount = $rs->page(4)->pager->total_entries (66);
146 return ($artist, $pg, $pg_wcount);
149 # more codepaths - error handling in txn_do
151 eval { $schema->txn_do ( sub {
152 $storage->_dbh->begin_work;
153 fail ('how did we get so far?!');
156 eval { $schema->txn_do ( sub {
157 $schema->txn_do ( sub {
158 die "It's called EXCEPTION";
159 fail ('how did we get so far?!');
161 fail ('how did we get so far?!');
163 like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
167 my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
168 my $row = $_[0]->schema->resultset('Artist')->new({});
169 my $rs = $_[0]->schema->resultset('Artist')->search({
170 name => $row, # this is deliberately bogus, see FIXME below!
175 is ($pager->next_page, 3, 'There is one more page available');
177 # based on 66 per 10 pages
178 is ($pager_explicit_count->last_page, 7, 'Correct last page');
180 # do some population (invokes some extra codepaths)
181 # also exercise the guard code and the manual txn control
183 my $guard = $schema->txn_scope_guard;
184 # populate with bindvars
185 $rs->populate([{ name => 'James Bound' }]);
190 $rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
194 # and without bindvars
195 $rs->populate([{ name => \ '"James Unbound"' }]);
196 $schema->txn_rollback;
200 my $cds_rs = $schema->resultset('CD');
201 my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
202 my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
203 my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
206 my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
209 my $getcol_rs = $cds_rs->get_column('me.cdid');
210 my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
212 my $base_collection = {
215 pref_precursor => $cds_rs,
217 pref_rs_single => $cds_with_artist,
218 pref_rs_multi => $cds_with_tracks,
219 pref_rs_nested => $cds_with_stuff,
221 pref_rs_implicit => $cds_with_impl_artist,
223 pref_row_single => $cds_with_artist->next,
224 pref_row_multi => $cds_with_tracks->next,
225 pref_row_nested => $cds_with_stuff->next,
227 # even though this does not leak Storable croaks on it :(((
228 #pref_row_implicit => $cds_with_impl_artist->next,
230 get_column_rs_plain => $getcol_rs,
231 get_column_rs_pref => $pref_getcol_rs,
233 # twice so that we make sure only one H::M object spawned
234 chained_resultset => $rs->search_rs ({}, { '+columns' => { foo => 'artistid' } } ),
235 chained_resultset2 => $rs->search_rs ({}, { '+columns' => { bar => 'artistid' } } ),
237 row_object => $row_obj,
239 mc_row_object => $mc_row_obj,
241 result_source => $rs->result_source,
243 result_source_handle => $rs->result_source->handle,
245 pager_explicit_count => $pager_explicit_count,
247 leaky_resultset => $rs_bind_circref,
248 leaky_resultset_cond => $cond_rowobj,
251 # fire all resultsets multiple times, once here, more below
252 # some of these can't find anything (notably leaky_resultset)
257 $_->isa('DBIx::Class::ResultSet')
259 $_->isa('DBIx::Class::ResultSetColumn')
261 } values %$base_collection;
264 my $fire_resultsets = sub {
265 local $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS} = 1;
266 local $SIG{__WARN__} = sigwarn_silencer(
267 qr/Unable to deflate 'filter'-type relationship 'artist'.+related object primary key not retrieved/
271 { $_, (blessed($_) ? { $_->get_columns } : ()) }
278 push @{$base_collection->{random_results}}, $fire_resultsets->();
280 # FIXME - something throws a Storable for a spin if we keep
281 # the results in-collection. The same problem is seen above,
282 # swept under the rug back in 0a03206a, damned lazy ribantainer
284 local $base_collection->{random_results};
287 %$base_collection = (
289 refrozen => Storable::dclone( $base_collection ),
290 rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
291 pref_row_implicit => $cds_with_impl_artist->next,
294 sql_maker => $storage->sql_maker,
295 dbh => $storage->_dbh,
296 fresh_pager => $rs->page(5)->pager,
301 # FIXME - ideally this kind of collector ought to be global, but attempts
302 # with an invasive debugger-based tracer did not quite work out... yet
303 # Manually scan the innards of everything we have in the base collection
304 # we assembled so far (skip the DT madness below) *recursively*
306 # Only do this when we do have the bits to look inside CVs properly,
307 # without it we are liable to pick up object defaults that are locked
309 if (DBICTest::Util::LeakTracer::CV_TRACING) {
311 refs => [ $base_collection ],
313 populate_weakregistry ($weak_registry, $_[0]);
314 1; # true means "keep descending"
318 # do a heavy-duty fire-and-compare loop on all resultsets
319 # this is expensive - not running on install
322 ! DBICTest::RunMode->is_plain
324 ! $ENV{DBICTEST_IN_PERSISTENT_ENV}
327 # FIXME - ideally we should be able to just populate an alternative
328 # registry, subtract everything from the main one, and arrive at
329 # an "empty" resulting hash
330 # However due to gross inefficiencies in the ::ResultSet code we
331 # end up recalculating a new set of aliasmaps which could have very
332 # well been cached if it wasn't for... anyhow
333 # What we do here for the time being is similar to the lazy approach
334 # of Devel::LeakTrace - we just make sure we do not end up with more
335 # reftypes than when we started. At least we are not blanket-counting
336 # SVs like D::LT does, but going by reftype... sigh...
338 for (values %$weak_registry) {
339 if ( my $r = reftype($_->{weakref}) ) {
344 # For now we can only reuse the same registry, see FIXME above/below
345 #for my $interim_wr ({}, {}) {
346 for my $interim_wr ( ($weak_registry) x 4 ) {
349 refs => [ $fire_resultsets->(), @rsets ],
351 populate_weakregistry ($interim_wr, $_[0]);
352 1; # true means "keep descending"
356 # FIXME - this is what *should* be here
358 ## anything we have seen so far is cool
359 #delete @{$interim_wr}{keys %$weak_registry};
361 ## moment of truth - the rest ought to be gone
362 #assert_empty_weakregistry($interim_wr);
365 for (values %$weak_registry) {
366 if ( my $r = reftype($_->{weakref}) ) {
372 for (keys %$typecounts) {
373 fail ("Amount of $_ refs changed by $typecounts->{$_} during resultset mass-execution")
374 if ( abs ($typecounts->{$_}) > 1 ); # there is a pad caught somewhere, the +1/-1 can be ignored
379 my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
381 my $now = DateTime->now;
383 $base_collection->{"icdt_row_$_"} = $rs->create({
384 created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
385 starts_at => $now->clone->add(days => $_),
390 my @dummy = $rs->all;
393 # dbh's are created in XS space, so pull them separately
394 for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
395 $base_collection->{"DBI handle $_"} = $_;
398 populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
399 for keys %$base_collection;
402 # check that "phantom-chaining" works - we never lose track of the original $schema
403 # and have access to the entire tree without leaking anything
407 sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
408 sub { shift->source('Artist') },
409 sub { shift->resultset },
410 sub { shift->result_source },
411 sub { shift->schema },
412 sub { shift->resultset('Artist') },
413 sub { shift->find_or_create({ name => 'detachable' }) },
414 sub { shift->result_source },
415 sub { shift->schema },
416 sub { shift->clone },
417 sub { shift->resultset('CD') },
419 sub { shift->artist },
420 sub { shift->search_related('cds') },
422 sub { shift->search_related('artist') },
423 sub { shift->result_source },
424 sub { shift->resultset },
425 sub { shift->create({ name => 'detached' }) },
426 sub { shift->update({ name => 'reattached' }) },
427 sub { shift->discard_changes },
428 sub { shift->delete },
429 sub { shift->insert },
431 $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
434 ok( $phantom->in_storage, 'Properly deleted/reinserted' );
435 is( $phantom->name, 'reattached', 'Still correct name' );
438 # Naturally we have some exceptions
440 for my $addr (keys %$weak_registry) {
441 my $names = join "\n", keys %{$weak_registry->{$addr}{slot_names}};
443 if ($names =~ /^Test::Builder/m) {
444 # T::B 2.0 has result objects and other fancyness
445 delete $weak_registry->{$addr};
447 # remove this when IO::Dir is gone from SQLT
448 elsif ($INC{"IO/Dir.pm"} and $names =~ /^Class::Struct::Tie_ISA/m) {
449 delete $weak_registry->{$addr};
451 elsif ($names =~ /^Hash::Merge/m) {
452 # only clear one object of a specific behavior - more would indicate trouble
453 delete $weak_registry->{$addr}
454 unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++;
456 elsif ($names =~ /^B::Hooks::EndOfScope::PP::_TieHintHashFieldHash/m) {
457 # there is one tied lexical which stays alive until GC time
458 # https://metacpan.org/source/ETHER/B-Hooks-EndOfScope-0.15/lib/B/Hooks/EndOfScope/PP/FieldHash.pm#L24
459 # simply ignore it here, instead of teaching the leaktracer to examine ties
460 # the latter is possible yet terrible: https://github.com/dbsrgits/dbix-class/blob/v0.082820/t/lib/DBICTest/Util/LeakTracer.pm#L113-L117
461 delete $weak_registry->{$addr}
462 unless $cleared->{bheos_pptiehinthashfieldhash}++;
464 elsif ($names =~ /^DateTime::TimeZone::UTC/m) {
465 # DT is going through a refactor it seems - let it leak zones for now
466 delete $weak_registry->{$addr};
469 # # if we can look at closed over pieces - we will register it as a global
470 # !DBICTest::Util::LeakTracer::CV_TRACING
472 $names =~ /^SQL::Translator::Generator::DDL::SQLite/m
474 # SQLT::Producer::SQLite keeps global generators around for quoted
475 # and non-quoted DDL, allow one for each quoting style
476 delete $weak_registry->{$addr}
477 unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$addr}{weakref}->quote_chars}}++;
482 # There is an actual strong circular reference taking place here, but because
483 # half of it is in XS, so it is a bit harder to track down (it stumps D::FR)
484 # (our tracker does not yet do it, but it'd be nice)
487 # $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
489 # \-------- bound value on prepared/cached STH <-----------/
497 { $_->{slot_names}{'basic leaky_resultset_cond'} }
498 values %$weak_registry
500 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
501 ok(! defined $r, 'Self-referential RS conditions no longer leak!')
502 or push @circreffed, $r;
506 is (scalar @circreffed, 1, 'One resultset expected to leak');
508 # this is useless on its own, it is to showcase the circref-diag
509 # and eventually test it when it is operational
510 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
511 while (@circreffed) {
512 weaken (my $r = shift @circreffed);
514 populate_weakregistry( (my $mini_registry = {}), $r );
515 assert_empty_weakregistry( $mini_registry );
517 $r->result_source(undef);
522 assert_empty_weakregistry ($weak_registry);
524 # we got so far without a failure - this is a good thing
525 # now let's try to rerun this script under a "persistent" environment
526 # this is ugly and dirty but we do not yet have a Test::Embedded or
529 my $persistence_tests;
531 skip 'Test already in a persistent loop', 1
532 if $ENV{DBICTEST_IN_PERSISTENT_ENV};
534 skip 'Main test failed - skipping persistent env tests', 1
535 unless $TB->is_passing;
537 skip "Test::Builder\@@{[ Test::Builder->VERSION ]} known to break persistence tests", 1
538 if modver_gt_or_eq_and_lt( 'Test::More', '1.200', '1.301001_099' );
540 local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
541 local $ENV{DBICTEST_ANFANG_DEFANG} = 1;
545 $persistence_tests = {
547 cmd => [qw/pperl --prefork=1/, __FILE__],
549 'CGI::SpeedyCGI' => {
550 cmd => [qw/speedy -- -t5/, __FILE__],
554 # scgi is smart and will auto-reap after -t amount of seconds
555 # pperl needs an actual killer :(
556 $persistence_tests->{PPerl}{termcmd} = [
557 $persistence_tests->{PPerl}{cmd}[0],
559 @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
564 $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
567 if (length $ENV{PATH}) {
568 ( $ENV{PATH} ) = join ( $Config::Config{path_sep},
569 map { length($_) ? File::Spec->rel2abs($_) : () }
570 split /\Q$Config::Config{path_sep}/, $ENV{PATH}
574 for my $type (keys %$persistence_tests) { SKIP: {
575 unless (eval "require $type") {
576 # Don't terminate what we didn't start
577 delete $persistence_tests->{$type}{termcmd};
578 skip "$type module not found", 1;
581 my @cmd = @{$persistence_tests->{$type}{cmd}};
583 # since PPerl is racy and sucks - just prime the "server"
585 local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
589 # see if the thing actually runs, if not - might as well bail now
590 skip "Something is wrong with $type ($!)", 1
597 note ("Starting run in persistent env ($type pass $_)");
598 IPC::Open2::open2(my $out, undef, @cmd);
600 while (my $ln = <$out>) {
601 next if $ln =~ /^\s*$/;
602 push @out_lines, " $ln";
603 last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
605 print $_ for @out_lines;
608 ok (!$?, "Run in persistent env ($type pass $_): exit $?");
609 ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
612 ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
613 if $persistence_tests->{$type}{termcmd};
619 # just an extra precaution in case we blew away from the SKIP - since there are no
620 # PID files to go by (man does pperl really suck :(
622 if ($persistence_tests->{PPerl}{termcmd}) {
623 local $?; # otherwise test will inherit $? of the system()
625 open my $null, ">", File::Spec->devnull;
627 IPC::Open3::open3(undef, $null, $null, @{$persistence_tests->{PPerl}{termcmd}}),