1 # work around brain damage in PPerl (yes, it has to be a global)
3 warn @_ unless $_[0] =~ /\QUse of "goto" to jump into a construct is deprecated/
4 } if ($ENV{DBICTEST_IN_PERSISTENT_ENV});
6 # the persistent environments run with this flag first to see if
7 # we will run at all (e.g. it will fail if $^X doesn't match)
8 exit 0 if $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY};
10 # Do the override as early as possible so that CORE::bless doesn't get compiled away
11 # We will replace $bless_override only if we are in author mode
14 $bless_override = sub {
15 CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() );
17 *CORE::GLOBAL::bless = sub { goto $bless_override };
25 use DBICTest::RunMode;
27 plan skip_all => "Temporarily no smoke testing of Test::More 1.3xx alphas" if (
28 DBICTest::RunMode->is_smoker
30 eval { Test::More->VERSION("1.300") }
32 require ExtUtils::MakeMaker
34 MM->parse_version($INC{"Test/Builder.pm"}) =~ / ^ 1 \. 3.. ... \_ /x
37 my $TB = Test::More->builder;
38 if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
39 # without this explicit close older TBs warn in END after a ->reset
40 if ($TB->VERSION < 1.005) {
41 close ($TB->$_) for (qw/output failure_output todo_output/);
44 # if I do not do this, I get happy sigpipes on new TB, no idea why
45 # (the above close-and-forget doesn't work - new TB does *not* reopen
46 # its handles automatically anymore)
48 for (qw/failure_output todo_output/) {
50 open ($TB->$_, '>&', *STDERR);
54 open ($TB->output, '>&', *STDOUT);
57 # so done_testing can work on every persistent pass
61 use DBICTest::Util::LeakTracer qw(populate_weakregistry assert_empty_weakregistry visit_refs);
62 use Scalar::Util qw(weaken blessed reftype);
64 use DBIx::Class::_Util qw(hrefaddr sigwarn_silencer);
66 plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
67 if DBIx::Class::_ENV_::PEEPEENESS;
70 # this is what holds all weakened refs to be checked for leakage
71 my $weak_registry = {};
73 # whether or to invoke IC::DT
76 # Skip the heavy-duty leak tracing when just doing an install
77 unless (DBICTest::RunMode->is_plain) {
79 # redefine the bless override so that we can catch each and every object created
80 no warnings qw/redefine once/;
83 $bless_override = sub {
85 my $obj = CORE::bless(
86 $_[0], (@_ > 1) ? $_[1] : do {
87 my ($class, $fn, $line) = caller();
88 fail ("bless() of $_[0] into $class without explicit class specification at $fn line $line")
89 if $class =~ /^ (?: DBIx\:\:Class | DBICTest ) /x;
94 # unicode is tricky, and now we happen to invoke it early via a
95 # regex in connection()
96 return $obj if (ref $obj) =~ /^utf8/;
98 # Test Builder is now making a new object for every pass/fail (que bloat?)
99 # and as such we can't really store any of its objects (since it will
100 # re-populate the registry while checking it, ewwww!)
101 return $obj if (ref $obj) =~ /^TB2::/;
103 # populate immediately to avoid weird side effects
104 return populate_weakregistry ($weak_registry, $obj );
108 for my $func (qw/try catch finally/) {
109 my $orig = \&{"Try::Tiny::$func"};
110 *{"Try::Tiny::$func"} = sub (&;@) {
111 populate_weakregistry( $weak_registry, $_[0] );
116 # Some modules are known to install singletons on-load
117 # Load them and empty the registry
119 # this loads the DT armada
120 $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for('test_dt_sqlite');
128 %$weak_registry = ();
134 my $schema = DBICTest->init_schema;
135 my $rs = $schema->resultset ('Artist');
136 my $storage = $schema->storage;
138 ok ($storage->connected, 'we are connected');
140 my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
141 ok ($row_obj, 'row from db');
143 # txn_do to invoke more codepaths
144 my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
146 my $artist = $schema->resultset('Artist')->create ({
147 name => 'foo artist',
155 genre => { name => 'mauve' },
159 my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
161 my $pg_wcount = $rs->page(4)->pager->total_entries (66);
163 return ($artist, $pg, $pg_wcount);
166 # more codepaths - error handling in txn_do
168 eval { $schema->txn_do ( sub {
169 $storage->_dbh->begin_work;
170 fail ('how did we get so far?!');
173 eval { $schema->txn_do ( sub {
174 $schema->txn_do ( sub {
175 die "It's called EXCEPTION";
176 fail ('how did we get so far?!');
178 fail ('how did we get so far?!');
180 like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
184 my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
185 my $row = $_[0]->schema->resultset('Artist')->new({});
186 my $rs = $_[0]->schema->resultset('Artist')->search({
187 name => $row, # this is deliberately bogus, see FIXME below!
192 is ($pager->next_page, 3, 'There is one more page available');
194 # based on 66 per 10 pages
195 is ($pager_explicit_count->last_page, 7, 'Correct last page');
197 # do some population (invokes some extra codepaths)
198 # also exercise the guard code and the manual txn control
200 my $guard = $schema->txn_scope_guard;
201 # populate with bindvars
202 $rs->populate([{ name => 'James Bound' }]);
207 $rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
211 # and without bindvars
212 $rs->populate([{ name => \ '"James Unbound"' }]);
213 $schema->txn_rollback;
217 my $cds_rs = $schema->resultset('CD');
218 my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
219 my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
220 my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
223 my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
226 my $getcol_rs = $cds_rs->get_column('me.cdid');
227 my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
229 my $base_collection = {
232 pref_precursor => $cds_rs,
234 pref_rs_single => $cds_with_artist,
235 pref_rs_multi => $cds_with_tracks,
236 pref_rs_nested => $cds_with_stuff,
238 pref_rs_implicit => $cds_with_impl_artist,
240 pref_row_single => $cds_with_artist->next,
241 pref_row_multi => $cds_with_tracks->next,
242 pref_row_nested => $cds_with_stuff->next,
244 # even though this does not leak Storable croaks on it :(((
245 #pref_row_implicit => $cds_with_impl_artist->next,
247 get_column_rs_plain => $getcol_rs,
248 get_column_rs_pref => $pref_getcol_rs,
250 # twice so that we make sure only one H::M object spawned
251 chained_resultset => $rs->search_rs ({}, { '+columns' => { foo => 'artistid' } } ),
252 chained_resultset2 => $rs->search_rs ({}, { '+columns' => { bar => 'artistid' } } ),
254 row_object => $row_obj,
256 mc_row_object => $mc_row_obj,
258 result_source => $rs->result_source,
260 result_source_handle => $rs->result_source->handle,
262 pager_explicit_count => $pager_explicit_count,
264 leaky_resultset => $rs_bind_circref,
265 leaky_resultset_cond => $cond_rowobj,
268 # fire all resultsets multiple times, once here, more below
269 # some of these can't find anything (notably leaky_resultset)
274 $_->isa('DBIx::Class::ResultSet')
276 $_->isa('DBIx::Class::ResultSetColumn')
278 } values %$base_collection;
281 my $fire_resultsets = sub {
282 local $ENV{DBIC_COLUMNS_INCLUDE_FILTER_RELS} = 1;
283 local $SIG{__WARN__} = sigwarn_silencer(
284 qr/Unable to deflate 'filter'-type relationship 'artist'.+related object primary key not retrieved/
288 { $_, (blessed($_) ? { $_->get_columns } : ()) }
295 push @{$base_collection->{random_results}}, $fire_resultsets->();
297 # FIXME - something throws a Storable for a spin if we keep
298 # the results in-collection. The same problem is seen above,
299 # swept under the rug back in 0a03206a, damned lazy ribantainer
301 local $base_collection->{random_results};
304 %$base_collection = (
306 refrozen => Storable::dclone( $base_collection ),
307 rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
308 pref_row_implicit => $cds_with_impl_artist->next,
311 sql_maker => $storage->sql_maker,
312 dbh => $storage->_dbh,
313 fresh_pager => $rs->page(5)->pager,
318 # FIXME - ideally this kind of collector ought to be global, but attempts
319 # with an invasive debugger-based tracer did not quite work out... yet
320 # Manually scan the innards of everything we have in the base collection
321 # we assembled so far (skip the DT madness below) *recursively*
323 # Only do this when we do have the bits to look inside CVs properly,
324 # without it we are liable to pick up object defaults that are locked
326 if (DBICTest::Util::LeakTracer::CV_TRACING) {
328 refs => [ $base_collection ],
330 populate_weakregistry ($weak_registry, $_[0]);
331 1; # true means "keep descending"
335 # do a heavy-duty fire-and-compare loop on all resultsets
336 # this is expensive - not running on install
339 ! DBICTest::RunMode->is_plain
341 ! $ENV{DBICTEST_IN_PERSISTENT_ENV}
343 # FIXME - investigate wtf is going on with 5.18
344 ! ( $] > 5.017 and $ENV{DBIC_TRACE_PROFILE} )
347 # FIXME - ideally we should be able to just populate an alternative
348 # registry, subtract everything from the main one, and arrive at
349 # an "empty" resulting hash
350 # However due to gross inefficiencies in the ::ResultSet code we
351 # end up recalculating a new set of aliasmaps which could have very
352 # well been cached if it wasn't for... anyhow
353 # What we do here for the time being is similar to the lazy approach
354 # of Devel::LeakTrace - we just make sure we do not end up with more
355 # reftypes than when we started. At least we are not blanket-counting
356 # SVs like D::LT does, but going by reftype... sigh...
358 for (values %$weak_registry) {
359 if ( my $r = reftype($_->{weakref}) ) {
364 # For now we can only reuse the same registry, see FIXME above/below
365 #for my $interim_wr ({}, {}) {
366 for my $interim_wr ( ($weak_registry) x 4 ) {
369 refs => [ $fire_resultsets->(), @rsets ],
371 populate_weakregistry ($interim_wr, $_[0]);
372 1; # true means "keep descending"
376 # FIXME - this is what *should* be here
378 ## anything we have seen so far is cool
379 #delete @{$interim_wr}{keys %$weak_registry};
381 ## moment of truth - the rest ought to be gone
382 #assert_empty_weakregistry($interim_wr);
385 for (values %$weak_registry) {
386 if ( my $r = reftype($_->{weakref}) ) {
392 for (keys %$typecounts) {
393 fail ("Amount of $_ refs changed by $typecounts->{$_} during resultset mass-execution")
394 if ( abs ($typecounts->{$_}) > 1 ); # there is a pad caught somewhere, the +1/-1 can be ignored
399 my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
401 my $now = DateTime->now;
403 $base_collection->{"icdt_row_$_"} = $rs->create({
404 created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
405 starts_at => $now->clone->add(days => $_),
410 my @dummy = $rs->all;
413 # dbh's are created in XS space, so pull them separately
414 for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
415 $base_collection->{"DBI handle $_"} = $_;
418 populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
419 for keys %$base_collection;
422 # check that "phantom-chaining" works - we never lose track of the original $schema
423 # and have access to the entire tree without leaking anything
427 sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
428 sub { shift->source('Artist') },
429 sub { shift->resultset },
430 sub { shift->result_source },
431 sub { shift->schema },
432 sub { shift->resultset('Artist') },
433 sub { shift->find_or_create({ name => 'detachable' }) },
434 sub { shift->result_source },
435 sub { shift->schema },
436 sub { shift->clone },
437 sub { shift->resultset('CD') },
439 sub { shift->artist },
440 sub { shift->search_related('cds') },
442 sub { shift->search_related('artist') },
443 sub { shift->result_source },
444 sub { shift->resultset },
445 sub { shift->create({ name => 'detached' }) },
446 sub { shift->update({ name => 'reattached' }) },
447 sub { shift->discard_changes },
448 sub { shift->delete },
449 sub { shift->insert },
451 $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
454 ok( $phantom->in_storage, 'Properly deleted/reinserted' );
455 is( $phantom->name, 'reattached', 'Still correct name' );
458 # Naturally we have some exceptions
460 for my $addr (keys %$weak_registry) {
461 my $names = join "\n", keys %{$weak_registry->{$addr}{slot_names}};
463 if ($names =~ /^Test::Builder/m) {
464 # T::B 2.0 has result objects and other fancyness
465 delete $weak_registry->{$addr};
467 elsif ($names =~ /^Hash::Merge/m) {
468 # only clear one object of a specific behavior - more would indicate trouble
469 delete $weak_registry->{$addr}
470 unless $cleared->{hash_merge_singleton}{$weak_registry->{$addr}{weakref}{behavior}}++;
473 # # if we can look at closed over pieces - we will register it as a global
474 # !DBICTest::Util::LeakTracer::CV_TRACING
476 $names =~ /^SQL::Translator::Generator::DDL::SQLite/m
478 # SQLT::Producer::SQLite keeps global generators around for quoted
479 # and non-quoted DDL, allow one for each quoting style
480 delete $weak_registry->{$addr}
481 unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$addr}{weakref}->quote_chars}}++;
486 # There is an actual strong circular reference taking place here, but because
487 # half of it is in XS, so it is a bit harder to track down (it stumps D::FR)
488 # (our tracker does not yet do it, but it'd be nice)
491 # $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
493 # \-------- bound value on prepared/cached STH <-----------/
501 { $_->{slot_names}{'basic leaky_resultset_cond'} }
502 values %$weak_registry
504 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
505 ok(! defined $r, 'Self-referential RS conditions no longer leak!')
506 or push @circreffed, $r;
510 is (scalar @circreffed, 1, 'One resultset expected to leak');
512 # this is useless on its own, it is to showcase the circref-diag
513 # and eventually test it when it is operational
514 local $TODO = 'Needs Data::Entangled or somesuch - see RT#82942';
515 while (@circreffed) {
516 weaken (my $r = shift @circreffed);
518 populate_weakregistry( (my $mini_registry = {}), $r );
519 assert_empty_weakregistry( $mini_registry );
521 $r->result_source(undef);
526 assert_empty_weakregistry ($weak_registry);
528 # we got so far without a failure - this is a good thing
529 # now let's try to rerun this script under a "persistent" environment
530 # this is ugly and dirty but we do not yet have a Test::Embedded or
535 $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
536 ($ENV{PATH}) = $ENV{PATH} =~ /(.+)/;
539 my $persistence_tests = {
541 cmd => [qw/pperl --prefork=1/, __FILE__],
543 'CGI::SpeedyCGI' => {
544 cmd => [qw/speedy -- -t5/, __FILE__],
548 # scgi is smart and will auto-reap after -t amount of seconds
549 # pperl needs an actual killer :(
550 $persistence_tests->{PPerl}{termcmd} = [
551 $persistence_tests->{PPerl}{cmd}[0],
553 @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
557 skip 'Test already in a persistent loop', 1
558 if $ENV{DBICTEST_IN_PERSISTENT_ENV};
560 skip 'Main test failed - skipping persistent env tests', 1
561 unless $TB->is_passing;
563 local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
567 for my $type (keys %$persistence_tests) { SKIP: {
568 unless (eval "require $type") {
569 # Don't terminate what we didn't start
570 delete $persistence_tests->{$type}{termcmd};
571 skip "$type module not found", 1;
574 my @cmd = @{$persistence_tests->{$type}{cmd}};
576 # since PPerl is racy and sucks - just prime the "server"
578 local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
582 # see if the thing actually runs, if not - might as well bail now
583 skip "Something is wrong with $type ($!)", 1
588 note ("Starting run in persistent env ($type pass $_)");
589 IPC::Open2::open2(my $out, undef, @cmd);
591 while (my $ln = <$out>) {
592 next if $ln =~ /^\s*$/;
593 push @out_lines, " $ln";
594 last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
596 print $_ for @out_lines;
599 ok (!$?, "Run in persistent env ($type pass $_): exit $?");
600 ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
603 ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
604 if $persistence_tests->{$type}{termcmd};
610 # just an extra precaution in case we blew away from the SKIP - since there are no
611 # PID files to go by (man does pperl really suck :(
613 unless ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
614 close $_ for (*STDIN, *STDOUT, *STDERR);
615 local $?; # otherwise test will inherit $? of the system()
616 system (@{$persistence_tests->{PPerl}{termcmd}})
617 if $persistence_tests->{PPerl}{termcmd};