/
DBICTest.pm
518 lines (425 loc) · 13.1 KB
/
DBICTest.pm
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
package # hide from PAUSE
DBICTest;
use strict;
use warnings;
use DBICTest::RunMode;
use DBICTest::Schema;
use DBICTest::Util qw/populate_weakregistry assert_empty_weakregistry local_umask/;
use Carp;
use Path::Class::File ();
use File::Spec;
use Fcntl qw/:flock/;
=head1 NAME
DBICTest - Library to be used by DBIx::Class test scripts.
=head1 SYNOPSIS
use lib qw(t/lib);
use DBICTest;
use Test::More;
my $schema = DBICTest->init_schema();
=head1 DESCRIPTION
This module provides the basic utilities to write tests against
DBIx::Class.
=head1 METHODS
=head2 init_schema
my $schema = DBICTest->init_schema(
no_deploy=>1,
no_populate=>1,
storage_type=>'::DBI::Replicated',
storage_type_args=>{
balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
},
);
This method removes the test SQLite database in t/var/DBIxClass.db
and then creates a new, empty database.
This method will call deploy_schema() by default, unless the
no_deploy flag is set.
Also, by default, this method will call populate_schema() by
default, unless the no_deploy or no_populate flags are set.
=cut
# some tests are very time sensitive and need to run on their own, without
# being disturbed by anything else grabbing CPU or disk IO. Hence why everything
# using DBICTest grabs a shared lock, and the few tests that request a :GlobalLock
# will ask for an exclusive one and block until they can get it
our ($global_lock_fh, $global_exclusive_lock);
sub import {
my $self = shift;
my $lockpath = DBICTest::RunMode->tmpdir->file('.dbictest_global.lock');
{
my $u = local_umask(0); # so that the file opens as 666, and any user can lock
open ($global_lock_fh, '>', $lockpath)
or die "Unable to open $lockpath: $!";
}
for (@_) {
if ($_ eq ':GlobalLock') {
flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!";
$global_exclusive_lock = 1;
}
else {
croak "Unknown export $_ requested from $self";
}
}
unless ($global_exclusive_lock) {
flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!";
}
}
END {
if ($global_lock_fh) {
# delay destruction even more
}
}
{
my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var');
$dir->mkpath unless -d "$dir";
$dir = "$dir";
sub _sqlite_dbfilename {
my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$;
$holder = $$ if $holder == -1;
# useful for missing cleanup debugging
#if ( $holder == $$) {
# my $x = $0;
# $x =~ s/\//#/g;
# $holder .= "-$x";
#}
return "$dir/DBIxClass-$holder.db";
}
END {
_cleanup_dbfile();
}
}
$SIG{INT} = sub { _cleanup_dbfile(); exit 1 };
sub _cleanup_dbfile {
# cleanup if this is us
if (
! $ENV{DBICTEST_LOCK_HOLDER}
or
$ENV{DBICTEST_LOCK_HOLDER} == -1
or
$ENV{DBICTEST_LOCK_HOLDER} == $$
) {
my $db_file = _sqlite_dbfilename();
unlink $_ for ($db_file, "${db_file}-journal");
}
}
sub has_custom_dsn {
return $ENV{"DBICTEST_DSN"} ? 1:0;
}
sub _sqlite_dbname {
my $self = shift;
my %args = @_;
return $self->_sqlite_dbfilename if (
defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'}
);
return ":memory:";
}
sub _database {
my $self = shift;
my %args = @_;
if ($ENV{DBICTEST_DSN}) {
return (
(map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
{ AutoCommit => 1, %args },
);
}
my $db_file = $self->_sqlite_dbname(%args);
for ($db_file, "${db_file}-journal") {
next unless -e $_;
unlink ($_) or carp (
"Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!"
);
}
return ("dbi:SQLite:${db_file}", '', '', {
AutoCommit => 1,
# this is executed on every connect, and thus installs a disconnect/DESTROY
# guard for every new $dbh
on_connect_do => sub {
my $storage = shift;
my $dbh = $storage->_get_dbh;
# no fsync on commit
$dbh->do ('PRAGMA synchronous = OFF');
# set a *DBI* disconnect callback, to make sure the physical SQLite
# file is still there (i.e. the test does not attempt to delete
# an open database, which fails on Win32)
if (my $guard_cb = __mk_disconnect_guard($db_file)) {
$dbh->{Callbacks} = {
connect => sub { $guard_cb->('connect') },
disconnect => sub { $guard_cb->('disconnect') },
DESTROY => sub { $guard_cb->('DESTROY') },
};
}
},
%args,
});
}
sub __mk_disconnect_guard {
return if DBIx::Class::_ENV_::PEEPEENESS(); # leaks handles, delaying DESTROY, can't work right
my $db_file = shift;
return unless -f $db_file;
my $orig_inode = (stat($db_file))[1]
or return;
my $clan_connect_caller = '*UNKNOWN*';
my $i;
while ( my ($pack, $file, $line) = caller(++$i) ) {
next if $file eq __FILE__;
next if $pack =~ /^DBIx::Class|^Try::Tiny/;
$clan_connect_caller = "$file line $line";
}
my $failed_once = 0;
my $connected = 1;
return sub {
return if $failed_once;
my $event = shift;
if ($event eq 'connect') {
# this is necessary in case we are disconnected and connected again, all within the same $dbh object
$connected = 1;
return;
}
elsif ($event eq 'disconnect') {
$connected = 0;
}
elsif ($event eq 'DESTROY' and ! $connected ) {
return;
}
my $fail_reason;
if (! -e $db_file) {
$fail_reason = 'is missing';
}
else {
my $cur_inode = (stat($db_file))[1];
if ($orig_inode != $cur_inode) {
# pack/unpack to match the unsigned longs returned by `stat`
$fail_reason = sprintf 'was recreated (initially inode %s, now %s)', (
map { unpack ('L', pack ('l', $_) ) } ($orig_inode, $cur_inode )
);
}
}
if ($fail_reason) {
$failed_once++;
require Test::Builder;
my $t = Test::Builder->new;
local $Test::Builder::Level = $Test::Builder::Level + 3;
$t->ok (0,
"$db_file originally created at $clan_connect_caller $fail_reason before $event "
. 'of DBI handle - a strong indicator that the database file was tampered with while '
. 'still being open. This action would fail massively if running under Win32, hence '
. 'we make sure it fails on any OS :)'
);
}
return; # this empty return is a DBI requirement
};
}
my $weak_registry = {};
sub init_schema {
my $self = shift;
my %args = @_;
my $schema;
if ($args{compose_connection}) {
$schema = DBICTest::Schema->compose_connection(
'DBICTest', $self->_database(%args)
);
} else {
$schema = DBICTest::Schema->compose_namespace('DBICTest');
}
if( $args{storage_type}) {
$schema->storage_type($args{storage_type});
}
if ( !$args{no_connect} ) {
$schema = $schema->connect($self->_database(%args));
}
if ( !$args{no_deploy} ) {
__PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
__PACKAGE__->populate_schema( $schema )
if( !$args{no_populate} );
}
populate_weakregistry ( $weak_registry, $schema->storage )
if $INC{'Test/Builder.pm'} and $schema->storage;
return $schema;
}
END {
assert_empty_weakregistry($weak_registry, 'quiet');
}
=head2 deploy_schema
DBICTest->deploy_schema( $schema );
This method does one of two things to the schema. It can either call
the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
variable is set, otherwise the default is to read in the t/lib/sqlite.sql
file and execute the SQL within. Either way you end up with a fresh set
of tables for testing.
=cut
sub deploy_schema {
my $self = shift;
my $schema = shift;
my $args = shift || {};
if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
$schema->deploy($args);
} else {
my $filename = Path::Class::File->new(__FILE__)->dir
->file('sqlite.sql')->stringify;
my $sql = do { local (@ARGV, $/) = $filename ; <> };
for my $chunk ( split (/;\s*\n+/, $sql) ) {
if ( $chunk =~ / ^ (?! --\s* ) \S /xm ) { # there is some real sql in the chunk - a non-space at the start of the string which is not a comment
$schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
}
}
}
return;
}
=head2 populate_schema
DBICTest->populate_schema( $schema );
After you deploy your schema you can use this method to populate
the tables with test data.
=cut
sub populate_schema {
my $self = shift;
my $schema = shift;
$schema->populate('Genre', [
[qw/genreid name/],
[qw/1 emo /],
]);
$schema->populate('Artist', [
[ qw/artistid name/ ],
[ 1, 'Caterwauler McCrae' ],
[ 2, 'Random Boy Band' ],
[ 3, 'We Are Goth' ],
]);
$schema->populate('CD', [
[ qw/cdid artist title year genreid/ ],
[ 1, 1, "Spoonful of bees", 1999, 1 ],
[ 2, 1, "Forkful of bees", 2001 ],
[ 3, 1, "Caterwaulin' Blues", 1997 ],
[ 4, 2, "Generic Manufactured Singles", 2001 ],
[ 5, 3, "Come Be Depressed With Us", 1998 ],
]);
$schema->populate('LinerNotes', [
[ qw/liner_id notes/ ],
[ 2, "Buy Whiskey!" ],
[ 4, "Buy Merch!" ],
[ 5, "Kill Yourself!" ],
]);
$schema->populate('Tag', [
[ qw/tagid cd tag/ ],
[ 1, 1, "Blue" ],
[ 2, 2, "Blue" ],
[ 3, 3, "Blue" ],
[ 4, 5, "Blue" ],
[ 5, 2, "Cheesy" ],
[ 6, 4, "Cheesy" ],
[ 7, 5, "Cheesy" ],
[ 8, 2, "Shiny" ],
[ 9, 4, "Shiny" ],
]);
$schema->populate('TwoKeys', [
[ qw/artist cd/ ],
[ 1, 1 ],
[ 1, 2 ],
[ 2, 2 ],
]);
$schema->populate('FourKeys', [
[ qw/foo bar hello goodbye sensors/ ],
[ 1, 2, 3, 4, 'online' ],
[ 5, 4, 3, 6, 'offline' ],
]);
$schema->populate('OneKey', [
[ qw/id artist cd/ ],
[ 1, 1, 1 ],
[ 2, 1, 2 ],
[ 3, 2, 2 ],
]);
$schema->populate('SelfRef', [
[ qw/id name/ ],
[ 1, 'First' ],
[ 2, 'Second' ],
]);
$schema->populate('SelfRefAlias', [
[ qw/self_ref alias/ ],
[ 1, 2 ]
]);
$schema->populate('ArtistUndirectedMap', [
[ qw/id1 id2/ ],
[ 1, 2 ]
]);
$schema->populate('Producer', [
[ qw/producerid name/ ],
[ 1, 'Matt S Trout' ],
[ 2, 'Bob The Builder' ],
[ 3, 'Fred The Phenotype' ],
]);
$schema->populate('CD_to_Producer', [
[ qw/cd producer/ ],
[ 1, 1 ],
[ 1, 2 ],
[ 1, 3 ],
]);
$schema->populate('TreeLike', [
[ qw/id parent name/ ],
[ 1, undef, 'root' ],
[ 2, 1, 'foo' ],
[ 3, 2, 'bar' ],
[ 6, 2, 'blop' ],
[ 4, 3, 'baz' ],
[ 5, 4, 'quux' ],
[ 7, 3, 'fong' ],
]);
$schema->populate('Track', [
[ qw/trackid cd position title/ ],
[ 4, 2, 1, "Stung with Success"],
[ 5, 2, 2, "Stripy"],
[ 6, 2, 3, "Sticky Honey"],
[ 7, 3, 1, "Yowlin"],
[ 8, 3, 2, "Howlin"],
[ 9, 3, 3, "Fowlin"],
[ 10, 4, 1, "Boring Name"],
[ 11, 4, 2, "Boring Song"],
[ 12, 4, 3, "No More Ideas"],
[ 13, 5, 1, "Sad"],
[ 14, 5, 2, "Under The Weather"],
[ 15, 5, 3, "Suicidal"],
[ 16, 1, 1, "The Bees Knees"],
[ 17, 1, 2, "Apiary"],
[ 18, 1, 3, "Beehind You"],
]);
$schema->populate('Event', [
[ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
[ 1, '2006-04-25 22:24:33', '2006-06-22 21:00:05', '2006-07-23', '2006-05-22 19:05:07', '2006-04-21 18:04:06'],
]);
$schema->populate('Link', [
[ qw/id url title/ ],
[ 1, '', 'aaa' ]
]);
$schema->populate('Bookmark', [
[ qw/id link/ ],
[ 1, 1 ]
]);
$schema->populate('Collection', [
[ qw/collectionid name/ ],
[ 1, "Tools" ],
[ 2, "Body Parts" ],
]);
$schema->populate('TypedObject', [
[ qw/objectid type value/ ],
[ 1, "pointy", "Awl" ],
[ 2, "round", "Bearing" ],
[ 3, "pointy", "Knife" ],
[ 4, "pointy", "Tooth" ],
[ 5, "round", "Head" ],
]);
$schema->populate('CollectionObject', [
[ qw/collection object/ ],
[ 1, 1 ],
[ 1, 2 ],
[ 1, 3 ],
[ 2, 4 ],
[ 2, 5 ],
]);
$schema->populate('Owners', [
[ qw/id name/ ],
[ 1, "Newton" ],
[ 2, "Waltham" ],
]);
$schema->populate('BooksInLibrary', [
[ qw/id owner title source price/ ],
[ 1, 1, "Programming Perl", "Library", 23 ],
[ 2, 1, "Dynamical Systems", "Library", 37 ],
[ 3, 2, "Best Recipe Cookbook", "Library", 65 ],
]);
}
1;