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 };
24 local $TODO = 'Temporarily todo-ed for dq2eb';
26 my $TB = Test::More->builder;
27 if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
28 # without this explicit close older TBs warn in END after a ->reset
29 if ($TB->VERSION < 1.005) {
30 close ($TB->$_) for (qw/output failure_output todo_output/);
33 # if I do not do this, I get happy sigpipes on new TB, no idea why
34 # (the above close-and-forget doesn't work - new TB does *not* reopen
35 # its handles automatically anymore)
37 for (qw/failure_output todo_output/) {
39 open ($TB->$_, '>&', *STDERR);
43 open ($TB->output, '>&', *STDOUT);
46 # so done_testing can work on every persistent pass
51 use DBICTest::RunMode;
52 use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/;
53 use Scalar::Util 'refaddr';
56 plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
57 if DBIx::Class::_ENV_::PEEPEENESS;
60 # this is what holds all weakened refs to be checked for leakage
61 my $weak_registry = {};
63 # whether or to invoke IC::DT
66 # Skip the heavy-duty leak tracing when just doing an install
67 unless (DBICTest::RunMode->is_plain) {
69 # redefine the bless override so that we can catch each and every object created
70 no warnings qw/redefine once/;
73 $bless_override = sub {
75 my $obj = CORE::bless(
76 $_[0], (@_ > 1) ? $_[1] : do {
77 my ($class, $fn, $line) = caller();
78 fail ("bless() of $_[0] into $class without explicit class specification at $fn line $line")
79 if $class =~ /^ (?: DBIx\:\:Class | DBICTest ) /x;
84 # unicode is tricky, and now we happen to invoke it early via a
85 # regex in connection()
86 return $obj if (ref $obj) =~ /^utf8/;
88 # Test Builder is now making a new object for every pass/fail (que bloat?)
89 # and as such we can't really store any of its objects (since it will
90 # re-populate the registry while checking it, ewwww!)
91 return $obj if (ref $obj) =~ /^TB2::/;
93 # weaken immediately to avoid weird side effects
94 return populate_weakregistry ($weak_registry, $obj );
98 for my $func (qw/try catch finally/) {
99 my $orig = \&{"Try::Tiny::$func"};
100 *{"Try::Tiny::$func"} = sub (&;@) {
101 populate_weakregistry( $weak_registry, $_[0] );
106 # Some modules are known to install singletons on-load
107 # Load them and empty the registry
109 # this loads the DT armada
110 $has_dt = DBIx::Class::Optional::Dependencies->req_ok_for('test_dt_sqlite');
118 %$weak_registry = ();
124 my $schema = DBICTest->init_schema;
125 my $rs = $schema->resultset ('Artist');
126 my $storage = $schema->storage;
128 ok ($storage->connected, 'we are connected');
130 my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
131 ok ($row_obj, 'row from db');
133 # txn_do to invoke more codepaths
134 my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
136 my $artist = $schema->resultset('Artist')->create ({
137 name => 'foo artist',
145 genre => { name => 'mauve' },
149 my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
151 my $pg_wcount = $rs->page(4)->pager->total_entries (66);
153 return ($artist, $pg, $pg_wcount);
156 # more codepaths - error handling in txn_do
158 eval { $schema->txn_do ( sub {
159 $storage->_dbh->begin_work;
160 fail ('how did we get so far?!');
163 eval { $schema->txn_do ( sub {
164 $schema->txn_do ( sub {
165 die "It's called EXCEPTION";
166 fail ('how did we get so far?!');
168 fail ('how did we get so far?!');
170 like( $@, qr/It\'s called EXCEPTION/, 'Exception correctly propagated in nested txn_do' );
174 my ($rs_bind_circref, $cond_rowobj) = $schema->storage->dbh_do ( sub {
175 my $row = $_[0]->schema->resultset('Artist')->new({});
176 my $rs = $_[0]->schema->resultset('Artist')->search({
177 name => $row, # this is deliberately bogus, see FIXME below!
182 is ($pager->next_page, 3, 'There is one more page available');
184 # based on 66 per 10 pages
185 is ($pager_explicit_count->last_page, 7, 'Correct last page');
187 # do some population (invokes some extra codepaths)
188 # also exercise the guard code and the manual txn control
190 my $guard = $schema->txn_scope_guard;
191 # populate with bindvars
192 $rs->populate([{ name => 'James Bound' }]);
197 $rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
201 # and without bindvars
202 $rs->populate([{ name => \ '"James Unbound"' }]);
203 $schema->txn_rollback;
207 my $cds_rs = $schema->resultset('CD');
208 my $cds_with_artist = $cds_rs->search({}, { prefetch => 'artist' });
209 my $cds_with_tracks = $cds_rs->search({}, { prefetch => 'tracks' });
210 my $cds_with_stuff = $cds_rs->search({}, { prefetch => [ 'genre', { artist => { cds => { tracks => 'cd_single' } } } ] });
213 my $cds_with_impl_artist = $cds_rs->search({}, { columns => [qw/me.title artist.name/], join => 'artist' });
216 my $getcol_rs = $cds_rs->get_column('me.cdid');
217 my $pref_getcol_rs = $cds_with_stuff->get_column('me.cdid');
219 # fire the column getters
220 my @throwaway = $pref_getcol_rs->all;
222 my $base_collection = {
225 pref_precursor => $cds_rs,
227 pref_rs_single => $cds_with_artist,
228 pref_rs_multi => $cds_with_tracks,
229 pref_rs_nested => $cds_with_stuff,
231 pref_rs_implicit => $cds_with_impl_artist,
233 pref_row_single => $cds_with_artist->next,
234 pref_row_multi => $cds_with_tracks->next,
235 pref_row_nested => $cds_with_stuff->next,
237 # even though this does not leak Storable croaks on it :(((
238 #pref_row_implicit => $cds_with_impl_artist->next,
240 get_column_rs_plain => $getcol_rs,
241 get_column_rs_pref => $pref_getcol_rs,
243 # twice so that we make sure only one H::M object spawned
244 chained_resultset => $rs->search_rs ({}, { '+columns' => [ 'foo' ] } ),
245 chained_resultset2 => $rs->search_rs ({}, { '+columns' => [ 'bar' ] } ),
247 row_object => $row_obj,
249 mc_row_object => $mc_row_obj,
251 result_source => $rs->result_source,
253 result_source_handle => $rs->result_source->handle,
255 pager_explicit_count => $pager_explicit_count,
257 leaky_resultset => $rs_bind_circref,
258 leaky_resultset_cond => $cond_rowobj,
261 # this needs to fire, even if it can't find anything
263 # we run this only on smokers - trying to establish a pattern
264 $rs_bind_circref->next
265 if ( ($ENV{TRAVIS}||'') ne 'true' and DBICTest::RunMode->is_smoker);
268 %$base_collection = (
270 refrozen => Storable::dclone( $base_collection ),
271 rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
272 pref_row_implicit => $cds_with_impl_artist->next,
275 sql_maker => $storage->sql_maker,
276 dbh => $storage->_dbh,
277 fresh_pager => $rs->page(5)->pager,
282 my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
284 my $now = DateTime->now;
286 $base_collection->{"icdt_row_$_"} = $rs->create({
287 created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
288 starts_at => $now->clone->add(days => $_),
293 my @dummy = $rs->all;
296 # dbh's are created in XS space, so pull them separately
297 for ( grep { defined } map { @{$_->{ChildHandles}} } values %{ {DBI->installed_drivers()} } ) {
298 $base_collection->{"DBI handle $_"} = $_;
302 if ( DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks') ) {
304 local $SIG{__WARN__} = sub { $_[0] =~ /\QUnhandled type: REGEXP/ ? push @w, @_ : warn @_ };
306 Test::Memory::Cycle::memory_cycle_ok ($base_collection, 'No cycles in the object collection');
309 local $TODO = 'Silence warning due to RT56681';
310 is (@w, 0, 'No Devel::Cycle emitted warnings');
314 skip 'Circular ref test needs ' . DBIx::Class::Optional::Dependencies->req_missing_for ('test_leaks'), 1;
318 populate_weakregistry ($weak_registry, $base_collection->{$_}, "basic $_")
319 for keys %$base_collection;
322 # check that "phantom-chaining" works - we never lose track of the original $schema
323 # and have access to the entire tree without leaking anything
327 sub { DBICTest->init_schema( sqlite_use_file => 0 ) },
328 sub { shift->source('Artist') },
329 sub { shift->resultset },
330 sub { shift->result_source },
331 sub { shift->schema },
332 sub { shift->resultset('Artist') },
333 sub { shift->find_or_create({ name => 'detachable' }) },
334 sub { shift->result_source },
335 sub { shift->schema },
336 sub { shift->clone },
337 sub { shift->resultset('CD') },
339 sub { shift->artist },
340 sub { shift->search_related('cds') },
342 sub { shift->search_related('artist') },
343 sub { shift->result_source },
344 sub { shift->resultset },
345 sub { shift->create({ name => 'detached' }) },
346 sub { shift->update({ name => 'reattached' }) },
347 sub { shift->discard_changes },
348 sub { shift->delete },
349 sub { shift->insert },
351 $phantom = populate_weakregistry ( $weak_registry, scalar $_->($phantom) );
354 ok( $phantom->in_storage, 'Properly deleted/reinserted' );
355 is( $phantom->name, 'reattached', 'Still correct name' );
358 # Naturally we have some exceptions
360 for my $slot (keys %$weak_registry) {
361 if ($slot =~ /^Test::Builder/) {
362 # T::B 2.0 has result objects and other fancyness
363 delete $weak_registry->{$slot};
365 elsif ($slot =~ /^Method::Generate::(?:Accessor|Constructor)/) {
366 # Moo keeps globals around, this is normal
367 delete $weak_registry->{$slot};
369 elsif ($slot =~ /^SQL::Translator::Generator::DDL::SQLite/) {
370 # SQLT::Producer::SQLite keeps global generators around for quoted
371 # and non-quoted DDL, allow one for each quoting style
372 delete $weak_registry->{$slot}
373 unless $cleared->{sqlt_ddl_sqlite}->{@{$weak_registry->{$slot}{weakref}->quote_chars}}++;
375 elsif ($slot =~ /^Hash::Merge/) {
376 # only clear one object of a specific behavior - more would indicate trouble
377 delete $weak_registry->{$slot}
378 unless $cleared->{hash_merge_singleton}{$weak_registry->{$slot}{weakref}{behavior}}++;
380 elsif ($slot =~ /^DateTime::TimeZone/) {
381 # DT is going through a refactor it seems - let it leak zones for now
382 delete $weak_registry->{$slot};
387 # There is an actual strong circular reference taking place here, but because
388 # half of it is in XS no leaktracer sees it, and Devel::FindRef is equally
389 # stumped when trying to trace the origin. The problem is:
391 # $cond_object --> result_source --> schema --> storage --> $dbh --> {CachedKids}
393 # \-------- bound value on prepared/cached STH <-----------/
396 local $TODO = 'This fails intermittently - see RT#82942';
397 if ( my $r = $weak_registry->{'basic leaky_resultset_cond'}{weakref} ) {
398 ok(! defined $r, 'Self-referential RS conditions no longer leak!')
399 or $r->result_source(undef);
403 assert_empty_weakregistry ($weak_registry);
405 # we got so far without a failure - this is a good thing
406 # now let's try to rerun this script under a "persistent" environment
407 # this is ugly and dirty but we do not yet have a Test::Embedded or
412 $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
413 ($ENV{PATH}) = $ENV{PATH} =~ /(.+)/;
416 my $persistence_tests = {
418 cmd => [qw/pperl --prefork=1/, __FILE__],
420 'CGI::SpeedyCGI' => {
421 cmd => [qw/speedy -- -t5/, __FILE__],
425 # scgi is smart and will auto-reap after -t amount of seconds
426 # pperl needs an actual killer :(
427 $persistence_tests->{PPerl}{termcmd} = [
428 $persistence_tests->{PPerl}{cmd}[0],
430 @{$persistence_tests->{PPerl}{cmd}}[ 1 .. $#{$persistence_tests->{PPerl}{cmd}} ],
434 skip 'Test already in a persistent loop', 1
435 if $ENV{DBICTEST_IN_PERSISTENT_ENV};
437 skip 'Main test failed - skipping persistent env tests', 1
438 unless $TB->is_passing;
440 local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
444 for my $type (keys %$persistence_tests) { SKIP: {
445 unless (eval "require $type") {
446 # Don't terminate what we didn't start
447 delete $persistence_tests->{$type}{termcmd};
448 skip "$type module not found", 1;
451 my @cmd = @{$persistence_tests->{$type}{cmd}};
453 # since PPerl is racy and sucks - just prime the "server"
455 local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
459 # see if the thing actually runs, if not - might as well bail now
460 skip "Something is wrong with $type ($!)", 1
465 note ("Starting run in persistent env ($type pass $_)");
466 IPC::Open2::open2(my $out, undef, @cmd);
468 while (my $ln = <$out>) {
469 next if $ln =~ /^\s*$/;
470 push @out_lines, " $ln";
471 last if $ln =~ /^\d+\.\.\d+$/; # this is persistence, we need to terminate reading on our end
473 print $_ for @out_lines;
476 ok (!$?, "Run in persistent env ($type pass $_): exit $?");
477 ok (scalar @out_lines, "Run in persistent env ($type pass $_): got output");
480 ok (! system (@{$persistence_tests->{$type}{termcmd}}), "killed $type server instance")
481 if $persistence_tests->{$type}{termcmd};
487 # just an extra precaution in case we blew away from the SKIP - since there are no
488 # PID files to go by (man does pperl really suck :(
490 unless ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
491 close $_ for (*STDIN, *STDOUT, *STDERR);
492 local $?; # otherwise test will inherit $? of the system()
493 system (@{$persistence_tests->{PPerl}{termcmd}})
494 if $persistence_tests->{PPerl}{termcmd};