-
Notifications
You must be signed in to change notification settings - Fork 151
/
52leaks.t
407 lines (326 loc) · 11.3 KB
/
52leaks.t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# work around brain damage in PPerl (yes, it has to be a global)
$SIG{__WARN__} = sub {
warn @_ unless $_[0] =~ /\QUse of "goto" to jump into a construct is deprecated/
} if ($ENV{DBICTEST_IN_PERSISTENT_ENV});
# the persistent environments run with this flag first to see if
# we will run at all (e.g. it will fail if $^X doesn't match)
exit 0 if $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY};
# Do the override as early as possible so that CORE::bless doesn't get compiled away
# We will replace $bless_override only if we are in author mode
my $bless_override;
BEGIN {
$bless_override = sub {
CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() );
};
*CORE::GLOBAL::bless = sub { goto $bless_override };
}
use strict;
use warnings;
use Test::More;
my $TB = Test::More->builder;
if ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
# without this explicit close ->reset below warns
close ($TB->$_) for qw/output failure_output/;
# so done_testing can work
$TB->reset;
# this simulates a subtest
$TB->_indent(' ' x 4);
}
use lib qw(t/lib);
use DBICTest::RunMode;
use DBIx::Class;
BEGIN {
plan skip_all => "Your perl version $] appears to leak like a sieve - skipping test"
if DBIx::Class::_ENV_::PEEPEENESS();
}
use Scalar::Util qw/refaddr reftype weaken/;
use Carp qw/longmess/;
use Try::Tiny;
my $have_test_cycle;
BEGIN {
require DBIx::Class::Optional::Dependencies;
$have_test_cycle = DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks')
and import Test::Memory::Cycle;
}
# this is what holds all weakened refs to be checked for leakage
my $weak_registry = {};
# whether or to invoke IC::DT
my $has_dt;
# Skip the heavy-duty leak tracing when just doing an install
unless (DBICTest::RunMode->is_plain) {
# Some modules are known to install singletons on-load
# Load them before we swap out $bless_override
require DBI;
require DBD::SQLite;
require Errno;
require Class::Struct;
require FileHandle;
require Hash::Merge;
require Storable;
# this loads the DT armada as well
$has_dt = DBIx::Class::Optional::Dependencies->req_ok_for('test_dt_sqlite');
no warnings qw/redefine once/;
no strict qw/refs/;
# redefine the bless override so that we can catch each and every object created
$bless_override = sub {
my $obj = CORE::bless(
$_[0], (@_ > 1) ? $_[1] : do {
my ($class, $fn, $line) = caller();
fail ("bless() of $_[0] into $class without explicit class specification at $fn line $line")
if $class =~ /^ (?: DBIx\:\:Class | DBICTest ) /x;
$class;
}
);
my $slot = (sprintf '%s=%s(0x%x)', # so we don't trigger stringification
ref $obj,
reftype $obj,
refaddr $obj,
);
# weaken immediately to avoid weird side effects
$weak_registry->{$slot} = { weakref => $obj, strace => longmess() };
weaken $weak_registry->{$slot}{weakref};
return $obj;
};
for my $func (qw/try catch finally/) {
my $orig = \&{"Try::Tiny::$func"};
*{"Try::Tiny::$func"} = sub (&;@) {
my $slot = sprintf ('CODE(0x%x)', refaddr $_[0]);
$weak_registry->{$slot} = { weakref => $_[0], strace => longmess() };
weaken $weak_registry->{$slot}{weakref};
goto $orig;
}
}
}
{
use_ok ('DBICTest');
my $schema = DBICTest->init_schema;
my $rs = $schema->resultset ('Artist');
my $storage = $schema->storage;
ok ($storage->connected, 'we are connected');
my $row_obj = $rs->search({}, { rows => 1})->next; # so that commits/rollbacks work
ok ($row_obj, 'row from db');
# txn_do to invoke more codepaths
my ($mc_row_obj, $pager, $pager_explicit_count) = $schema->txn_do (sub {
my $artist = $rs->create ({
name => 'foo artist',
cds => [{
title => 'foo cd',
year => 1984,
}],
});
my $pg = $rs->search({}, { rows => 1})->page(2)->pager;
my $pg_wcount = $rs->page(4)->pager->total_entries (66);
return ($artist, $pg, $pg_wcount);
});
is ($pager->next_page, 3, 'There is one more page available');
# based on 66 per 10 pages
is ($pager_explicit_count->last_page, 7, 'Correct last page');
# do some population (invokes some extra codepaths)
# also exercise the guard code and the manual txn control
{
my $guard = $schema->txn_scope_guard;
# populate with bindvars
$rs->populate([{ name => 'James Bound' }]);
$guard->commit;
$schema->txn_begin;
# populate mixed
$rs->populate([{ name => 'James Rebound', rank => \ '11' }]);
$schema->txn_commit;
$schema->txn_begin;
# and without bindvars
$rs->populate([{ name => \ '"James Unbound"' }]);
$schema->txn_rollback;
}
my $base_collection = {
resultset => $rs,
# twice so that we make sure only one H::M object spawned
chained_resultset => $rs->search_rs ({}, { '+columns' => [ 'foo' ] } ),
chained_resultset2 => $rs->search_rs ({}, { '+columns' => [ 'bar' ] } ),
row_object => $row_obj,
result_source => $rs->result_source,
result_source_handle => $rs->result_source->handle,
fresh_pager => $rs->page(5)->pager,
pager => $pager,
pager_explicit_count => $pager_explicit_count,
};
%$base_collection = (
%$base_collection,
refrozen => Storable::dclone( $base_collection ),
rerefrozen => Storable::dclone( Storable::dclone( $base_collection ) ),
schema => $schema,
storage => $storage,
sql_maker => $storage->sql_maker,
dbh => $storage->_dbh,
);
if ($has_dt) {
my $rs = $base_collection->{icdt_rs} = $schema->resultset('Event');
my $now = DateTime->now;
for (1..5) {
$base_collection->{"icdt_row_$_"} = $rs->create({
created_on => DateTime->new(year => 2011, month => 1, day => $_, time_zone => "-0${_}00" ),
starts_at => $now->clone->add(days => $_),
});
}
# re-search
my @dummy = $rs->all;
}
memory_cycle_ok ($base_collection, 'No cycles in the object collection')
if $have_test_cycle;
for (keys %$base_collection) {
$weak_registry->{"basic $_"} = { weakref => $base_collection->{$_} };
weaken $weak_registry->{"basic $_"}{weakref};
}
}
# check that "phantom-chaining" works - we never lose track of the original $schema
# and have access to the entire tree without leaking anything
{
my $phantom;
for (
sub { DBICTest->init_schema },
sub { shift->source('Artist') },
sub { shift->resultset },
sub { shift->result_source },
sub { shift->schema },
sub { shift->resultset('Artist') },
sub { shift->find_or_create({ name => 'detachable' }) },
sub { shift->result_source },
sub { shift->schema },
sub { shift->clone },
sub { shift->resultset('Artist') },
sub { shift->next },
sub { shift->result_source },
sub { shift->resultset },
sub { shift->create({ name => 'detached' }) },
sub { shift->update({ name => 'reattached' }) },
sub { shift->discard_changes },
sub { shift->delete },
sub { shift->insert },
) {
$phantom = $_->($phantom);
my $slot = (sprintf 'phantom %s=%s(0x%x)', # so we don't trigger stringification
ref $phantom,
reftype $phantom,
refaddr $phantom,
);
$weak_registry->{$slot} = $phantom;
weaken $weak_registry->{$slot};
}
ok( $phantom->in_storage, 'Properly deleted/reinserted' );
is( $phantom->name, 'reattached', 'Still correct name' );
}
# Naturally we have some exceptions
my $cleared;
for my $slot (keys %$weak_registry) {
if ($slot =~ /^Test::Builder/) {
# T::B 2.0 has result objects and other fancyness
delete $weak_registry->{$slot};
}
elsif ($slot =~ /^SQL::Translator/) {
# SQLT is a piece of shit, leaks all over
delete $weak_registry->{$slot};
}
elsif ($slot =~ /^Hash::Merge/) {
# only clear one object of a specific behavior - more would indicate trouble
delete $weak_registry->{$slot}
unless $cleared->{hash_merge_singleton}{$weak_registry->{$slot}{weakref}{behavior}}++;
}
elsif ($slot =~ /^__TxnScopeGuard__FIXUP__/) {
delete $weak_registry->{$slot}
if $] > 5.013001 and $] < 5.013008;
}
}
# FIXME
# For reasons I can not yet fully understand the table() god-method (located in
# ::ResultSourceProxy::Table) attaches an actual source instance to each class
# as virtually *immortal* class-data.
# For now just ignore these instances manually but there got to be a saner way
for ( map { $_->result_source_instance } (
'DBICTest::BaseResult',
map { DBICTest::Schema->class ($_) } DBICTest::Schema->sources
)) {
delete $weak_registry->{$_};
}
# FIXME
# same problem goes for the schema - its classdata contains live result source
# objects, which to add insult to the injury are *different* instances from the
# ones we ignored above
for ( values %{DBICTest::Schema->source_registrations || {}} ) {
delete $weak_registry->{$_};
}
for my $slot (sort keys %$weak_registry) {
ok (! defined $weak_registry->{$slot}{weakref}, "No leaks of $slot") or do {
my $diag = '';
$diag .= Devel::FindRef::track ($weak_registry->{$slot}{weakref}, 20) . "\n"
if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
if (my $stack = $weak_registry->{$slot}{strace}) {
$diag .= " Reference first seen$stack";
}
diag $diag if $diag;
};
}
# we got so far without a failure - this is a good thing
# now let's try to rerun this script under a "persistent" environment
# this is ugly and dirty but we do not yet have a Test::Embedded or
# similar
my @pperl_cmd = (qw/pperl --prefork=1/, __FILE__);
my @pperl_term_cmd = @pperl_cmd;
splice @pperl_term_cmd, 1, 0, '--kill';
# scgi is smart and will auto-reap after -t amount of seconds
my @scgi_cmd = (qw/speedy -- -t5/, __FILE__);
SKIP: {
skip 'Test already in a persistent loop', 1
if $ENV{DBICTEST_IN_PERSISTENT_ENV};
skip 'Persistence test disabled on regular installs', 1
if DBICTest::RunMode->is_plain;
skip 'Main test failed - skipping persistent env tests', 1
unless $TB->is_passing;
# set up -I
require Config;
local $ENV{PERL5LIB} = join ($Config::Config{path_sep}, @INC);
local $ENV{DBICTEST_IN_PERSISTENT_ENV} = 1;
# try with pperl
SKIP: {
skip 'PPerl persistent environment tests require PPerl', 1
unless eval { require PPerl };
# since PPerl is racy and sucks - just prime the "server"
{
local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
system(@pperl_cmd);
sleep 1;
# see if it actually runs - if not might as well bail now
skip "Something is wrong with pperl ($!)", 1
if system(@pperl_cmd);
}
for (1,2,3) {
system(@pperl_cmd);
ok (!$?, "Run in persistent env (PPerl pass $_): exit $?");
}
ok (! system (@pperl_term_cmd), 'killed pperl instance');
}
# try with speedy-cgi
SKIP: {
skip 'SPeedyCGI persistent environment tests require CGI::SpeedyCGI', 1
unless eval { require CGI::SpeedyCGI };
{
local $ENV{DBICTEST_PERSISTENT_ENV_BAIL_EARLY} = 1;
skip "Something is wrong with speedy ($!)", 1
if system(@scgi_cmd);
sleep 1;
}
for (1,2,3) {
system(@scgi_cmd);
ok (!$?, "Run in persistent env (SpeedyCGI pass $_): exit $?");
}
}
}
done_testing;
# just an extra precaution in case we blew away from the SKIP - since there are no
# PID files to go by (man does pperl really suck :(
END {
unless ($ENV{DBICTEST_IN_PERSISTENT_ENV}) {
close STDOUT;
close STDERR;
local $?; # otherwise test will inherit $? of the system()
system (@pperl_term_cmd);
}
}