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( dbic_internal_try dbic_internal_catch )) {
95 my $orig = \&{"DBIx::Class::_Util::$func"};
96 *{"DBIx::Class::_Util"} = sub (&;@) {
97 populate_weakregistry( $weak_registry, $_[0] );
102 if ( eval { require Try::Tiny } ) {
103 for my $func (qw( try catch finally )) {
104 my $orig = \&{"Try::Tiny::$func"};
105 *{"Try::Tiny::$func"} = sub (&;@) {
106 populate_weakregistry( $weak_registry, $_[0] );
113 # Some modules are known to install singletons on-load
114 # Load them and empty the registry
116 # this loads the DT armada
117 $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for([qw( test_rdbms_sqlite ic_dt )]);
122 require Math::BigInt;
124 %$weak_registry = ();
130 my $schema = DBICTest->init_schema;
131 my $rs = $schema->resultset ('Artist');
132 my $storage = $schema->storage;
134 my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
135 ok ($row_obj, 'row from db');
137 # txn_do to invoke more codepaths
138 my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
140 my $artist = $schema->resultset('Artist')->create ({
141 name => 'foo artist',
149 genre => { name => 'mauve' },
153 my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
155 my $pg_wcount = $rs->page(4)->pager->total_entries (66);
157 return ($artist, $pg, $pg_wcount);
160 # more codepaths - error handling in txn_do
162 eval { $schema->txn_do ( sub {
163 $storage->_dbh->begin_work;
164 fail ('how did we get so far?!');
167 eval { $schema->txn_do ( sub {
168 $schema->txn_do ( sub {
169 die "It's called EXCEPTION";
170 fail ('how did we get so far?!');
172 fail ('how did we get so far?!');
174 like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
178 my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
179 my $row = $_[0]->schema->resultset('Artist')->new({});
180 my $rs = $_[0]->schema->resultset('Artist')->search({
181 name => $row, # this is deliberately bogus, see FIXME below!
186 is ($pager->next_page, 3, 'There is one more page available');
188 # based on 66 per 10 pages
189 is ($pager_explicit_count->last_page, 7, 'Correct last page');
191 # do some population (invokes some extra codepaths)
192 # also exercise the guard code and the manual txn control
194 my $guard = $schema->txn_scope_guard;
195 # populate with bindvars
196 $rs->populate([{ name => 'James Bound' }]);
201 $rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
205 # and without bindvars
206 $rs->populate([{ name => \ '"James Unbound"' }]);
207 $schema->txn_rollback;
211 my $cds_rs = $schema->resultset('CD');
212 my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
213 my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
214 my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
217 my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
220 my $getcol_rs = $cds_rs->get_column('me.cdid');
221 my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
223 my $base_collection = {
226 pref_precursor => $cds_rs,
228 pref_rs_single => $cds_with_artist,
229 pref_rs_multi => $cds_with_tracks,
230 pref_rs_nested => $cds_with_stuff,
232 pref_rs_implicit => $cds_with_impl_artist,
234 pref_row_single => $cds_with_artist->next,
235 pref_row_multi => $cds_with_tracks->next,
236 pref_row_nested => $cds_with_stuff->next,
238 # even though this does not leak Storable croaks on it :(((
239 #pref_row_implicit => $cds_with_impl_artist->next,
241 get_column_rs_plain => $getcol_rs,
242 get_column_rs_pref => $pref_getcol_rs,
244 # twice so that we make sure only one H::M object spawned
245 chained_resultset => $rs->search_rs ({}, { '+columns' => { foo => 'artistid' } } ),
246 chained_resultset2 => $rs->search_rs ({}, { '+columns' => { bar => 'artistid' } } ),
248 row_object => $row_obj,
250 mc_row_object => $mc_row_obj,
252 result_source => $rs->result_source,
254 result_source_handle => $rs->result_source->handle,
256 pager_explicit_count => $pager_explicit_count,
258 leaky_resultset => $rs_bind_circref,
259 leaky_resultset_cond => $cond_rowobj,
262 # fire all resultsets multiple times, once here, more below
263 # some of these can't find anything (notably leaky_resultset)
268 $_->isa('DBIx::Class::ResultSet')
270 $_->isa('DBIx::Class::ResultSetColumn')
272 } values %$base_collection;
275 my $fire_resultsets = sub {
276 local $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS} = 1;
277 local $SIG{__WARN__} = sigwarn_silencer(
278 qr/Unable to deflate 'filter'-type relationship 'artist'.+related object primary key not retrieved/
282 { $_, (blessed($_) ? { $_->get_columns } : ()) }
289 push @{$base_collection->{random_results}}, $fire_resultsets->();
291 # FIXME - something throws a Storable for a spin if we keep
292 # the results in-collection. The same problem is seen above,
293 # swept under the rug back in 0a03206a, damned lazy ribantainer
295 local $base_collection->{random_results};
298 %$base_collection = (
300 refrozen => Storable::dclone( $base_collection ),
301 rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
302 pref_row_implicit => $cds_with_impl_artist->next,
305 sql_maker => $storage->sql_maker,
306 dbh => $storage->_dbh,
307 fresh_pager => $rs->page(5)->pager,
312 # FIXME - ideally this kind of collector ought to be global, but attempts
313 # with an invasive debugger-based tracer did not quite work out... yet
314 # Manually scan the innards of everything we have in the base collection
315 # we assembled so far (skip the DT madness below) *recursively*
317 # Only do this when we do have the bits to look inside CVs properly,
318 # without it we are liable to pick up object defaults that are locked
320 if (DBICTest::Util::LeakTracer::CV_TRACING) {
322 refs => [ $base_collection ],
324 populate_weakregistry ($weak_registry, $_[0]);
325 1; # true means "keep descending"
329 # do a heavy-duty fire-and-compare loop on all resultsets
330 # this is expensive - not running on install
333 ! DBICTest::RunMode->is_plain
335 ! $ENV{DBICTEST_IN_PERSISTENT_ENV}
338 # FIXME - ideally we should be able to just populate an alternative
339 # registry, subtract everything from the main one, and arrive at
340 # an "empty" resulting hash
341 # However due to gross inefficiencies in the ::ResultSet code we
342 # end up recalculating a new set of aliasmaps which could have very
343 # well been cached if it wasn't for... anyhow
344 # What we do here for the time being is similar to the lazy approach
345 # of Devel::LeakTrace - we just make sure we do not end up with more
346 # reftypes than when we started. At least we are not blanket-counting
347 # SVs like D::LT does, but going by reftype... sigh...
349 for (values %$weak_registry) {
350 if ( my $r = reftype($_->{weakref}) ) {
355 # For now we can only reuse the same registry, see FIXME above/below
356 #for my $interim_wr ({}, {}) {
357 for my $interim_wr ( ($weak_registry) x 4 ) {
360 refs => [ $fire_resultsets->(), @rsets ],
362 populate_weakregistry ($interim_wr, $_[0]);
363 1; # true means "keep descending"
367 # FIXME - this is what *should* be here
369 ## anything we have seen so far is cool
370 #delete @{$interim_wr}{keys %$weak_registry};
372 ## moment of truth - the rest ought to be gone
373 #assert_empty_weakregistry($interim_wr);
376 for (values %$weak_registry) {
377 if ( my $r = reftype($_->{weakref}) ) {
383 for (keys %$typecounts) {
384 fail ("Amount of $_ refs changed by $typecounts->{$_} during resultset mass-execution")
385 if ( abs ($typecounts->{$_}) > 1 ); # there is a pad caught somewhere, the +1/-1 can be ignored
390 my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
392 my $now = DateTime->now;
394 $base_collection->{"icdt_row_$_"} = $rs->create({
395 created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
396 starts_at => $now->clone->add(days => $_),
401 my @dummy = $rs->all;
404 # dbh's are created in XS space, so pull them separately
405 for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
406 $base_collection->{"DBI handle $_"} = $_;
409 populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
410 for keys %$base_collection;
413 # check that "phantom-chaining" works - we never lose track of the original $schema
414 # and have access to the entire tree without leaking anything
418 sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
419 sub { shift->source('Artist') },
420 sub { shift->resultset },
421 sub { shift->result_source },
422 sub { shift->schema },
423 sub { shift->resultset('Artist') },
424 sub { shift->find_or_create({ name => 'detachable' }) },
425 sub { shift->result_source },
426 sub { shift->schema },
427 sub { shift->clone },
428 sub { shift->resultset('CD') },
430 sub { shift->artist },
431 sub { shift->search_related('cds') },
433 sub { shift->search_related('artist') },
434 sub { shift->result_source },
435 sub { shift->resultset },
436 sub { shift->create({ name => 'detached' }) },
437 sub { shift->update({ name => 'reattached' }) },
438 sub { shift->discard_changes },
439 sub { shift->delete },
440 sub { shift->insert },
442 $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
445 ok( $phantom->in_storage, 'Properly deleted/reinserted' );
446 is( $phantom->name, 'reattached', 'Still correct name' );
449 # Naturally we have some exceptions
451 for my $addr (keys %$weak_registry) {
452 my $names = join "\n", keys %{$weak_registry->{$addr}{slot_names}};
454 if ($names =~ /^Test::Builder/m) {
455 # T::B 2.0 has result objects and other fancyness
456 delete $weak_registry->{$addr};
458 # remove this when IO::Dir is gone from SQLT
459 elsif ($INC{"IO/Dir.pm"} and $names =~ /^Class::Struct::Tie_ISA/m) {
460 delete $weak_registry->{$addr};
462 elsif ($names =~ /^Hash::Merge/m) {
463 # only clear one object of a specific behavior - more would indicate trouble
464 delete $weak_registry->{$addr}
465 unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++;
467 elsif ($names =~ /^B::Hooks::EndOfScope::PP::_TieHintHashFieldHash/m) {
468 # there is one tied lexical which stays alive until GC time
469 # https://metacpan.org/source/ETHER/B-Hooks-EndOfScope-0.15/lib/B/Hooks/EndOfScope/PP/FieldHash.pm#L24
470 # simply ignore it here, instead of teaching the leaktracer to examine ties
471 # the latter is possible yet terrible: https://github.com/dbsrgits/dbix-class/blob/v0.082820/t/lib/DBICTest/Util/LeakTracer.pm#L113-L117
472 delete $weak_registry->{$addr}
473 unless $cleared->{bheos_pptiehinthashfieldhash}++;
476 $names =~ /^Data::Dumper/m
478 $weak_registry->{$addr}{stacktrace} =~ /\bDBIx::Class::SQLMaker::Util::lax_serialize\b/
480 # only clear one object of a specific behavior - more would indicate trouble
481 delete $weak_registry->{$addr}
482 unless $cleared->{dd_lax_serializer}++;
484 elsif ($names =~ /^DateTime::TimeZone::UTC/m) {
485 # DT is going through a refactor it seems - let it leak zones for now
486 delete $weak_registry->{$addr};
489 # # if we can look at closed over pieces - we will register it as a global
490 # !DBICTest::Util::LeakTracer::CV_TRACING
492 $names =~ /^SQL::Translator::Generator::DDL::SQLite/m
494 # SQLT::Producer::SQLite keeps global generators around for quoted
495 # and non-quoted DDL, allow one for each quoting style
496 delete $weak_registry->{$addr}
497 unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$addr}{weakref}->quote_chars}}++;
502 # There is an actual strong circular reference taking place here, but because
503 # half of it is in XS, so it is a bit harder to track down (it stumps D::FR)
504 # (our tracker does not yet do it, but it'd be nice)
507 # $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
509 # \-------- bound value on prepared/cached STH <-----------/
517 { $_->{slot_names}{'basic leaky_resultset_cond'} }
518 values %$weak_registry
520 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
521 ok(! defined $r, 'Self-referential RS conditions no longer leak!')
522 or push @circreffed, $r;
526 is (scalar @circreffed, 1, 'One resultset expected to leak');
528 # this is useless on its own, it is to showcase the circref-diag
529 # and eventually test it when it is operational
530 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
531 while (@circreffed) {
532 weaken (my $r = shift @circreffed);
534 populate_weakregistry( (my $mini_registry = {}), $r );
535 assert_empty_weakregistry( $mini_registry );
537 $r->result_source(undef);
542 assert_empty_weakregistry ($weak_registry);
544 # we got so far without a failure - this is a good thing
545 # now let's try to rerun this script under a "persistent" environment
546 # this is ugly and dirty but we do not yet have a Test::Embedded or
549 my $persistence_tests;
551 skip 'Test already in a persistent loop', 1
552 if $ENV{DBICTEST_IN_PERSISTENT_ENV};
554 skip 'Main test failed - skipping persistent env tests', 1
555 unless $TB->is_passing;
557 skip "Test::Builder\@@{[ Test::Builder->VERSION ]} known to break persistence tests", 1
558 if modver_gt_or_eq_and_lt( 'Test::More', '1.200', '1.301001_099' );
560 local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
561 local $ENV{DBICTEST_ANFANG_DEFANG} = 1;
565 $persistence_tests = {
567 cmd => [qw/pperl --prefork=1/, __FILE__],
569 'CGI::SpeedyCGI' => {
570 cmd => [qw/speedy -- -t5/, __FILE__],
574 # scgi is smart and will auto-reap after -t amount of seconds
575 # pperl needs an actual killer :(
576 $persistence_tests->{PPerl}{termcmd} = [
577 $persistence_tests->{PPerl}{cmd}[0],
579 @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
584 $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
587 if (length $ENV{PATH}) {
588 ( $ENV{PATH} ) = join ( $Config::Config{path_sep},
589 map { length($_) ? File::Spec->rel2abs($_) : () }
590 split /\Q$Config::Config{path_sep}/, $ENV{PATH}
594 for my $type (keys %$persistence_tests) { SKIP: {
595 unless (eval "require $type") {
596 # Don't terminate what we didn't start
597 delete $persistence_tests->{$type}{termcmd};
598 skip "$type module not found", 1;
601 my @cmd = @{$persistence_tests->{$type}{cmd}};
603 # since PPerl is racy and sucks - just prime the "server"
605 local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
609 # see if the thing actually runs, if not - might as well bail now
610 skip "Something is wrong with $type ($!)", 1
617 note ("Starting run in persistent env ($type pass $_)");
618 IPC::Open2::open2(my $out, undef, @cmd);
620 while (my $ln = <$out>) {
621 next if $ln =~ /^\s*$/;
622 push @out_lines, " $ln";
623 last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
625 print $_ for @out_lines;
628 ok (!$?, "Run in persistent env ($type pass $_): exit $?");
629 ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
632 ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
633 if $persistence_tests->{$type}{termcmd};
639 # just an extra precaution in case we blew away from the SKIP - since there are no
640 # PID files to go by (man does pperl really suck :(
642 if ($persistence_tests->{PPerl}{termcmd}) {
643 local $?; # otherwise test will inherit $? of the system()
645 open my $null, ">", File::Spec->devnull;
647 IPC::Open3::open3(undef, $null, $null, @{$persistence_tests->{PPerl}{termcmd}}),