Commit | Line | Data |
8273e845 |
1 | package # hide from PAUSE |
c6d74d3e |
2 | DBICTest; |
1c339d71 |
3 | |
4 | use strict; |
5 | use warnings; |
39c9c72d |
6 | use DBICTest::RunMode; |
1c339d71 |
7 | use DBICTest::Schema; |
218b7c12 |
8 | use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/; |
9 | use DBICTest::Util 'local_umask'; |
a258bfc7 |
10 | use Carp; |
de306d4b |
11 | use Path::Class::File (); |
8d6b1478 |
12 | use File::Spec; |
027e3cc6 |
13 | use Fcntl qw/:DEFAULT :flock/; |
17e7d7f0 |
14 | |
15 | =head1 NAME |
16 | |
17 | DBICTest - Library to be used by DBIx::Class test scripts. |
18 | |
19 | =head1 SYNOPSIS |
20 | |
21 | use lib qw(t/lib); |
22 | use DBICTest; |
23 | use Test::More; |
8273e845 |
24 | |
17e7d7f0 |
25 | my $schema = DBICTest->init_schema(); |
26 | |
27 | =head1 DESCRIPTION |
28 | |
8273e845 |
29 | This module provides the basic utilities to write tests against |
17e7d7f0 |
30 | DBIx::Class. |
31 | |
32 | =head1 METHODS |
33 | |
34 | =head2 init_schema |
35 | |
36 | my $schema = DBICTest->init_schema( |
37 | no_deploy=>1, |
38 | no_populate=>1, |
2bf79155 |
39 | storage_type=>'::DBI::Replicated', |
cb6ec758 |
40 | storage_type_args=>{ |
d7a58a29 |
41 | balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random' |
cb6ec758 |
42 | }, |
17e7d7f0 |
43 | ); |
44 | |
8273e845 |
45 | This method removes the test SQLite database in t/var/DBIxClass.db |
17e7d7f0 |
46 | and then creates a new, empty database. |
47 | |
8273e845 |
48 | This method will call deploy_schema() by default, unless the |
17e7d7f0 |
49 | no_deploy flag is set. |
50 | |
8273e845 |
51 | Also, by default, this method will call populate_schema() by |
17e7d7f0 |
52 | default, unless the no_deploy or no_populate flags are set. |
53 | |
54 | =cut |
1c339d71 |
55 | |
8d6b1478 |
56 | # some tests are very time sensitive and need to run on their own, without |
57 | # being disturbed by anything else grabbing CPU or disk IO. Hence why everything |
58 | # using DBICTest grabs a shared lock, and the few tests that request a :GlobalLock |
59 | # will ask for an exclusive one and block until they can get it |
60 | our ($global_lock_fh, $global_exclusive_lock); |
61 | sub import { |
62 | my $self = shift; |
63 | |
7bdb56be |
64 | my $tmpdir = DBICTest::RunMode->tmpdir; |
65 | my $lockpath = $tmpdir->file('.dbictest_global.lock'); |
8d6b1478 |
66 | |
67 | { |
68 | my $u = local_umask(0); # so that the file opens as 666, and any user can lock |
7bdb56be |
69 | sysopen ($global_lock_fh, $lockpath, O_RDWR|O_CREAT) or do { |
70 | my $err = $!; |
71 | |
72 | my @x_tests = map { (defined $_) ? ( $_ ? 1 : 0 ) : 'U' } map {(-e, -d, -f, -r, -w, -x, -o)} ($tmpdir, $lockpath); |
73 | |
74 | die sprintf <<"EOE", $lockpath, $err, scalar $>, scalar $), (stat($tmpdir))[4,5,2], @x_tests; |
75 | Unable to open %s: %s |
76 | Process EUID/EGID: %s / %s |
77 | TmpDir UID/GID: %s / %s |
78 | TmpDir StatMode: %o |
79 | TmpDir X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s |
80 | TmpFile X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s |
81 | EOE |
82 | }; |
8d6b1478 |
83 | } |
84 | |
85 | for (@_) { |
86 | if ($_ eq ':GlobalLock') { |
87 | flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!"; |
88 | $global_exclusive_lock = 1; |
89 | } |
90 | else { |
91 | croak "Unknown export $_ requested from $self"; |
92 | } |
93 | } |
94 | |
95 | unless ($global_exclusive_lock) { |
96 | flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!"; |
97 | } |
98 | } |
99 | |
100 | END { |
101 | if ($global_lock_fh) { |
102 | # delay destruction even more |
103 | } |
857d66ca |
104 | } |
105 | |
8d6b1478 |
106 | { |
de306d4b |
107 | my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var'); |
108 | $dir->mkpath unless -d "$dir"; |
8d6b1478 |
109 | $dir = "$dir"; |
110 | |
111 | sub _sqlite_dbfilename { |
112 | my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$; |
113 | $holder = $$ if $holder == -1; |
114 | |
115 | # useful for missing cleanup debugging |
116 | #if ( $holder == $$) { |
117 | # my $x = $0; |
118 | # $x =~ s/\//#/g; |
119 | # $holder .= "-$x"; |
120 | #} |
121 | |
122 | return "$dir/DBIxClass-$holder.db"; |
123 | } |
124 | |
125 | END { |
126 | _cleanup_dbfile(); |
127 | } |
128 | } |
129 | |
130 | $SIG{INT} = sub { _cleanup_dbfile(); exit 1 }; |
131 | |
132 | sub _cleanup_dbfile { |
133 | # cleanup if this is us |
134 | if ( |
135 | ! $ENV{DBICTEST_LOCK_HOLDER} |
136 | or |
137 | $ENV{DBICTEST_LOCK_HOLDER} == -1 |
138 | or |
139 | $ENV{DBICTEST_LOCK_HOLDER} == $$ |
140 | ) { |
141 | my $db_file = _sqlite_dbfilename(); |
142 | unlink $_ for ($db_file, "${db_file}-journal"); |
143 | } |
144 | } |
145 | |
146 | sub has_custom_dsn { |
147 | return $ENV{"DBICTEST_DSN"} ? 1:0; |
bcb3e850 |
148 | } |
149 | |
150 | sub _sqlite_dbname { |
481df957 |
151 | my $self = shift; |
152 | my %args = @_; |
39b80a73 |
153 | return $self->_sqlite_dbfilename if ( |
154 | defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'} |
155 | ); |
d7a58a29 |
156 | return ":memory:"; |
857d66ca |
157 | } |
158 | |
579ca3f7 |
159 | sub _database { |
17e7d7f0 |
160 | my $self = shift; |
481df957 |
161 | my %args = @_; |
17e7d7f0 |
162 | |
a258bfc7 |
163 | if ($ENV{DBICTEST_DSN}) { |
164 | return ( |
165 | (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/), |
166 | { AutoCommit => 1, %args }, |
167 | ); |
168 | } |
169 | my $db_file = $self->_sqlite_dbname(%args); |
17e7d7f0 |
170 | |
a258bfc7 |
171 | for ($db_file, "${db_file}-journal") { |
172 | next unless -e $_; |
173 | unlink ($_) or carp ( |
70c28808 |
174 | "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!" |
a258bfc7 |
175 | ); |
176 | } |
17e7d7f0 |
177 | |
a258bfc7 |
178 | return ("dbi:SQLite:${db_file}", '', '', { |
179 | AutoCommit => 1, |
180 | |
181 | # this is executed on every connect, and thus installs a disconnect/DESTROY |
182 | # guard for every new $dbh |
183 | on_connect_do => sub { |
184 | my $storage = shift; |
185 | my $dbh = $storage->_get_dbh; |
186 | |
187 | # no fsync on commit |
188 | $dbh->do ('PRAGMA synchronous = OFF'); |
189 | |
190 | # set a *DBI* disconnect callback, to make sure the physical SQLite |
191 | # file is still there (i.e. the test does not attempt to delete |
192 | # an open database, which fails on Win32) |
d9c17594 |
193 | if (my $guard_cb = __mk_disconnect_guard($db_file)) { |
a258bfc7 |
194 | $dbh->{Callbacks} = { |
d9c17594 |
195 | connect => sub { $guard_cb->('connect') }, |
196 | disconnect => sub { $guard_cb->('disconnect') }, |
197 | DESTROY => sub { $guard_cb->('DESTROY') }, |
a258bfc7 |
198 | }; |
199 | } |
200 | }, |
201 | %args, |
202 | }); |
579ca3f7 |
203 | } |
204 | |
d9c17594 |
205 | sub __mk_disconnect_guard { |
0d8817bc |
206 | return if DBIx::Class::_ENV_::PEEPEENESS; # leaks handles, delaying DESTROY, can't work right |
d12d8272 |
207 | |
d9c17594 |
208 | my $db_file = shift; |
209 | return unless -f $db_file; |
210 | |
211 | my $orig_inode = (stat($db_file))[1] |
212 | or return; |
213 | |
214 | my $clan_connect_caller = '*UNKNOWN*'; |
215 | my $i; |
216 | while ( my ($pack, $file, $line) = caller(++$i) ) { |
217 | next if $file eq __FILE__; |
218 | next if $pack =~ /^DBIx::Class|^Try::Tiny/; |
219 | $clan_connect_caller = "$file line $line"; |
220 | } |
221 | |
222 | my $failed_once = 0; |
223 | my $connected = 1; |
224 | |
225 | return sub { |
226 | return if $failed_once; |
227 | |
228 | my $event = shift; |
229 | if ($event eq 'connect') { |
230 | # this is necessary in case we are disconnected and connected again, all within the same $dbh object |
231 | $connected = 1; |
232 | return; |
233 | } |
234 | elsif ($event eq 'disconnect') { |
235 | $connected = 0; |
236 | } |
237 | elsif ($event eq 'DESTROY' and ! $connected ) { |
238 | return; |
239 | } |
240 | |
241 | my $fail_reason; |
242 | if (! -e $db_file) { |
243 | $fail_reason = 'is missing'; |
244 | } |
245 | else { |
246 | my $cur_inode = (stat($db_file))[1]; |
247 | |
248 | if ($orig_inode != $cur_inode) { |
249 | # pack/unpack to match the unsigned longs returned by `stat` |
250 | $fail_reason = sprintf 'was recreated (initially inode %s, now %s)', ( |
251 | map { unpack ('L', pack ('l', $_) ) } ($orig_inode, $cur_inode ) |
252 | ); |
253 | } |
254 | } |
255 | |
256 | if ($fail_reason) { |
257 | $failed_once++; |
258 | |
259 | require Test::Builder; |
260 | my $t = Test::Builder->new; |
261 | local $Test::Builder::Level = $Test::Builder::Level + 3; |
262 | $t->ok (0, |
263 | "$db_file originally created at $clan_connect_caller $fail_reason before $event " |
264 | . 'of DBI handle - a strong indicator that the database file was tampered with while ' |
265 | . 'still being open. This action would fail massively if running under Win32, hence ' |
266 | . 'we make sure it fails on any OS :)' |
267 | ); |
268 | } |
269 | |
270 | return; # this empty return is a DBI requirement |
271 | }; |
272 | } |
273 | |
65d35121 |
274 | my $weak_registry = {}; |
275 | |
579ca3f7 |
276 | sub init_schema { |
277 | my $self = shift; |
278 | my %args = @_; |
279 | |
280 | my $schema; |
d7a58a29 |
281 | |
640ac94c |
282 | if ($args{compose_connection}) { |
283 | $schema = DBICTest::Schema->compose_connection( |
481df957 |
284 | 'DBICTest', $self->_database(%args) |
640ac94c |
285 | ); |
286 | } else { |
287 | $schema = DBICTest::Schema->compose_namespace('DBICTest'); |
288 | } |
a258bfc7 |
289 | |
2bf79155 |
290 | if( $args{storage_type}) { |
d7a58a29 |
291 | $schema->storage_type($args{storage_type}); |
292 | } |
a258bfc7 |
293 | |
579ca3f7 |
294 | if ( !$args{no_connect} ) { |
481df957 |
295 | $schema = $schema->connect($self->_database(%args)); |
3943fd63 |
296 | } |
a258bfc7 |
297 | |
17e7d7f0 |
298 | if ( !$args{no_deploy} ) { |
89cf6a70 |
299 | __PACKAGE__->deploy_schema( $schema, $args{deploy_args} ); |
300 | __PACKAGE__->populate_schema( $schema ) |
301 | if( !$args{no_populate} ); |
17e7d7f0 |
302 | } |
65d35121 |
303 | |
304 | populate_weakregistry ( $weak_registry, $schema->storage ) |
305 | if $INC{'Test/Builder.pm'} and $schema->storage; |
306 | |
17e7d7f0 |
307 | return $schema; |
308 | } |
309 | |
65d35121 |
310 | END { |
311 | assert_empty_weakregistry($weak_registry, 'quiet'); |
312 | } |
313 | |
17e7d7f0 |
314 | =head2 deploy_schema |
315 | |
316 | DBICTest->deploy_schema( $schema ); |
317 | |
8273e845 |
318 | This method does one of two things to the schema. It can either call |
319 | the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment |
320 | variable is set, otherwise the default is to read in the t/lib/sqlite.sql |
321 | file and execute the SQL within. Either way you end up with a fresh set |
17e7d7f0 |
322 | of tables for testing. |
323 | |
324 | =cut |
325 | |
326 | sub deploy_schema { |
327 | my $self = shift; |
89cf6a70 |
328 | my $schema = shift; |
329 | my $args = shift || {}; |
17e7d7f0 |
330 | |
8273e845 |
331 | if ($ENV{"DBICTEST_SQLT_DEPLOY"}) { |
06e15b8e |
332 | $schema->deploy($args); |
17e7d7f0 |
333 | } else { |
de306d4b |
334 | my $filename = Path::Class::File->new(__FILE__)->dir |
335 | ->file('sqlite.sql')->stringify; |
336 | my $sql = do { local (@ARGV, $/) = $filename ; <> }; |
ebf846e8 |
337 | for my $chunk ( split (/;\s*\n+/, $sql) ) { |
338 | 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 |
856e2d17 |
339 | $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n"; |
ebf846e8 |
340 | } |
341 | } |
17e7d7f0 |
342 | } |
89cf6a70 |
343 | return; |
17e7d7f0 |
344 | } |
345 | |
346 | =head2 populate_schema |
347 | |
348 | DBICTest->populate_schema( $schema ); |
349 | |
8273e845 |
350 | After you deploy your schema you can use this method to populate |
17e7d7f0 |
351 | the tables with test data. |
352 | |
353 | =cut |
354 | |
355 | sub populate_schema { |
356 | my $self = shift; |
357 | my $schema = shift; |
358 | |
972015a7 |
359 | $schema->populate('Genre', [ |
360 | [qw/genreid name/], |
361 | [qw/1 emo /], |
362 | ]); |
363 | |
17e7d7f0 |
364 | $schema->populate('Artist', [ |
77211009 |
365 | [ qw/artistid name/ ], |
366 | [ 1, 'Caterwauler McCrae' ], |
367 | [ 2, 'Random Boy Band' ], |
368 | [ 3, 'We Are Goth' ], |
17e7d7f0 |
369 | ]); |
370 | |
371 | $schema->populate('CD', [ |
972015a7 |
372 | [ qw/cdid artist title year genreid/ ], |
373 | [ 1, 1, "Spoonful of bees", 1999, 1 ], |
17e7d7f0 |
374 | [ 2, 1, "Forkful of bees", 2001 ], |
375 | [ 3, 1, "Caterwaulin' Blues", 1997 ], |
376 | [ 4, 2, "Generic Manufactured Singles", 2001 ], |
377 | [ 5, 3, "Come Be Depressed With Us", 1998 ], |
378 | ]); |
379 | |
380 | $schema->populate('LinerNotes', [ |
381 | [ qw/liner_id notes/ ], |
382 | [ 2, "Buy Whiskey!" ], |
383 | [ 4, "Buy Merch!" ], |
384 | [ 5, "Kill Yourself!" ], |
385 | ]); |
386 | |
387 | $schema->populate('Tag', [ |
388 | [ qw/tagid cd tag/ ], |
389 | [ 1, 1, "Blue" ], |
390 | [ 2, 2, "Blue" ], |
391 | [ 3, 3, "Blue" ], |
392 | [ 4, 5, "Blue" ], |
393 | [ 5, 2, "Cheesy" ], |
394 | [ 6, 4, "Cheesy" ], |
395 | [ 7, 5, "Cheesy" ], |
396 | [ 8, 2, "Shiny" ], |
397 | [ 9, 4, "Shiny" ], |
398 | ]); |
399 | |
400 | $schema->populate('TwoKeys', [ |
401 | [ qw/artist cd/ ], |
402 | [ 1, 1 ], |
403 | [ 1, 2 ], |
404 | [ 2, 2 ], |
405 | ]); |
406 | |
407 | $schema->populate('FourKeys', [ |
3bd6e3e0 |
408 | [ qw/foo bar hello goodbye sensors/ ], |
409 | [ 1, 2, 3, 4, 'online' ], |
410 | [ 5, 4, 3, 6, 'offline' ], |
17e7d7f0 |
411 | ]); |
412 | |
413 | $schema->populate('OneKey', [ |
414 | [ qw/id artist cd/ ], |
415 | [ 1, 1, 1 ], |
416 | [ 2, 1, 2 ], |
417 | [ 3, 2, 2 ], |
418 | ]); |
419 | |
420 | $schema->populate('SelfRef', [ |
421 | [ qw/id name/ ], |
422 | [ 1, 'First' ], |
423 | [ 2, 'Second' ], |
424 | ]); |
425 | |
426 | $schema->populate('SelfRefAlias', [ |
427 | [ qw/self_ref alias/ ], |
428 | [ 1, 2 ] |
429 | ]); |
430 | |
431 | $schema->populate('ArtistUndirectedMap', [ |
432 | [ qw/id1 id2/ ], |
433 | [ 1, 2 ] |
434 | ]); |
435 | |
436 | $schema->populate('Producer', [ |
437 | [ qw/producerid name/ ], |
438 | [ 1, 'Matt S Trout' ], |
439 | [ 2, 'Bob The Builder' ], |
440 | [ 3, 'Fred The Phenotype' ], |
441 | ]); |
442 | |
443 | $schema->populate('CD_to_Producer', [ |
444 | [ qw/cd producer/ ], |
445 | [ 1, 1 ], |
446 | [ 1, 2 ], |
447 | [ 1, 3 ], |
448 | ]); |
8273e845 |
449 | |
8871d4ad |
450 | $schema->populate('TreeLike', [ |
61177e44 |
451 | [ qw/id parent name/ ], |
972015a7 |
452 | [ 1, undef, 'root' ], |
8871d4ad |
453 | [ 2, 1, 'foo' ], |
454 | [ 3, 2, 'bar' ], |
455 | [ 6, 2, 'blop' ], |
456 | [ 4, 3, 'baz' ], |
457 | [ 5, 4, 'quux' ], |
458 | [ 7, 3, 'fong' ], |
459 | ]); |
4b8dcc58 |
460 | |
17e7d7f0 |
461 | $schema->populate('Track', [ |
462 | [ qw/trackid cd position title/ ], |
463 | [ 4, 2, 1, "Stung with Success"], |
464 | [ 5, 2, 2, "Stripy"], |
465 | [ 6, 2, 3, "Sticky Honey"], |
466 | [ 7, 3, 1, "Yowlin"], |
467 | [ 8, 3, 2, "Howlin"], |
468 | [ 9, 3, 3, "Fowlin"], |
469 | [ 10, 4, 1, "Boring Name"], |
470 | [ 11, 4, 2, "Boring Song"], |
471 | [ 12, 4, 3, "No More Ideas"], |
472 | [ 13, 5, 1, "Sad"], |
473 | [ 14, 5, 2, "Under The Weather"], |
474 | [ 15, 5, 3, "Suicidal"], |
475 | [ 16, 1, 1, "The Bees Knees"], |
476 | [ 17, 1, 2, "Apiary"], |
477 | [ 18, 1, 3, "Beehind You"], |
478 | ]); |
4b8dcc58 |
479 | |
ae515736 |
480 | $schema->populate('Event', [ |
ff8a6e3b |
481 | [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ], |
482 | [ 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'], |
ae515736 |
483 | ]); |
484 | |
17e7d7f0 |
485 | $schema->populate('Link', [ |
54e0bd06 |
486 | [ qw/id url title/ ], |
487 | [ 1, '', 'aaa' ] |
17e7d7f0 |
488 | ]); |
e673f011 |
489 | |
17e7d7f0 |
490 | $schema->populate('Bookmark', [ |
491 | [ qw/id link/ ], |
492 | [ 1, 1 ] |
493 | ]); |
78060df8 |
494 | |
495 | $schema->populate('Collection', [ |
496 | [ qw/collectionid name/ ], |
497 | [ 1, "Tools" ], |
498 | [ 2, "Body Parts" ], |
499 | ]); |
8273e845 |
500 | |
78060df8 |
501 | $schema->populate('TypedObject', [ |
502 | [ qw/objectid type value/ ], |
503 | [ 1, "pointy", "Awl" ], |
504 | [ 2, "round", "Bearing" ], |
505 | [ 3, "pointy", "Knife" ], |
506 | [ 4, "pointy", "Tooth" ], |
507 | [ 5, "round", "Head" ], |
508 | ]); |
89cf6a70 |
509 | $schema->populate('CollectionObject', [ |
510 | [ qw/collection object/ ], |
511 | [ 1, 1 ], |
512 | [ 1, 2 ], |
513 | [ 1, 3 ], |
514 | [ 2, 4 ], |
515 | [ 2, 5 ], |
516 | ]); |
78060df8 |
517 | |
518 | $schema->populate('Owners', [ |
bed3a173 |
519 | [ qw/id name/ ], |
78060df8 |
520 | [ 1, "Newton" ], |
521 | [ 2, "Waltham" ], |
522 | ]); |
523 | |
524 | $schema->populate('BooksInLibrary', [ |
cda5e082 |
525 | [ qw/id owner title source price/ ], |
526 | [ 1, 1, "Programming Perl", "Library", 23 ], |
527 | [ 2, 1, "Dynamical Systems", "Library", 37 ], |
528 | [ 3, 2, "Best Recipe Cookbook", "Library", 65 ], |
78060df8 |
529 | ]); |
1c339d71 |
530 | } |
4b8dcc58 |
531 | |
510ca912 |
532 | 1; |