1 package # hide from PAUSE
8 use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/;
9 use DBICTest::Util 'local_umask';
11 use Path::Class::File ();
13 use Fcntl qw/:DEFAULT :flock/;
17 DBICTest - Library to be used by DBIx::Class test scripts.
25 my $schema = DBICTest->init_schema();
29 This module provides the basic utilities to write tests against
36 my $schema = DBICTest->init_schema(
39 storage_type=>'::DBI::Replicated',
41 balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
45 This method removes the test SQLite database in t/var/DBIxClass.db
46 and then creates a new, empty database.
48 This method will call deploy_schema() by default, unless the
49 no_deploy flag is set.
51 Also, by default, this method will call populate_schema() by
52 default, unless the no_deploy or no_populate flags are set.
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);
64 my $tmpdir = DBICTest::RunMode->tmpdir;
65 my $lockpath = $tmpdir->file('.dbictest_global.lock');
68 my $u = local_umask(0); # so that the file opens as 666, and any user can lock
69 sysopen ($global_lock_fh, $lockpath, O_RDWR|O_CREAT) or do {
72 my @x_tests = map { (defined $_) ? ( $_ ? 1 : 0 ) : 'U' } map {(-e, -d, -f, -r, -w, -x, -o)} ($tmpdir, $lockpath);
74 die sprintf <<"EOE", $lockpath, $err, scalar $>, scalar $), (stat($tmpdir))[4,5,2], @x_tests;
76 Process EUID/EGID: %s / %s
77 TmpDir UID/GID: %s / %s
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
86 if ($_ eq ':GlobalLock') {
87 flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!";
88 $global_exclusive_lock = 1;
91 croak "Unknown export $_ requested from $self";
95 unless ($global_exclusive_lock) {
96 flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!";
101 if ($global_lock_fh) {
102 # delay destruction even more
107 my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var');
108 $dir->mkpath unless -d "$dir";
111 sub _sqlite_dbfilename {
112 my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$;
113 $holder = $$ if $holder == -1;
115 # useful for missing cleanup debugging
116 #if ( $holder == $$) {
122 return "$dir/DBIxClass-$holder.db";
130 $SIG{INT} = sub { _cleanup_dbfile(); exit 1 };
132 sub _cleanup_dbfile {
133 # cleanup if this is us
135 ! $ENV{DBICTEST_LOCK_HOLDER}
137 $ENV{DBICTEST_LOCK_HOLDER} == -1
139 $ENV{DBICTEST_LOCK_HOLDER} == $$
141 my $db_file = _sqlite_dbfilename();
142 unlink $_ for ($db_file, "${db_file}-journal");
147 return $ENV{"DBICTEST_DSN"} ? 1:0;
153 return $self->_sqlite_dbfilename if (
154 defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'}
163 if ($ENV{DBICTEST_DSN}) {
165 (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
166 { AutoCommit => 1, %args },
169 my $db_file = $self->_sqlite_dbname(%args);
171 for ($db_file, "${db_file}-journal") {
173 unlink ($_) or carp (
174 "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!"
178 return ("dbi:SQLite:${db_file}", '', '', {
181 # this is executed on every connect, and thus installs a disconnect/DESTROY
182 # guard for every new $dbh
183 on_connect_do => sub {
185 my $dbh = $storage->_get_dbh;
188 $dbh->do ('PRAGMA synchronous = OFF');
190 if ($ENV{DBICTEST_SQLITE_REVERSE_DEFAULT_ORDER}) {
192 $storage->throw_exception(
193 'PRAGMA reverse_unordered_selects does not work correctly before libsqlite 3.7.9'
194 ) if $storage->_server_info->{normalized_dbms_version} < 3.007009;
196 $dbh->do ('PRAGMA reverse_unordered_selects = ON');
199 # set a *DBI* disconnect callback, to make sure the physical SQLite
200 # file is still there (i.e. the test does not attempt to delete
201 # an open database, which fails on Win32)
202 if (my $guard_cb = __mk_disconnect_guard($db_file)) {
203 $dbh->{Callbacks} = {
204 connect => sub { $guard_cb->('connect') },
205 disconnect => sub { $guard_cb->('disconnect') },
206 DESTROY => sub { $guard_cb->('DESTROY') },
214 sub __mk_disconnect_guard {
215 return if DBIx::Class::_ENV_::PEEPEENESS; # leaks handles, delaying DESTROY, can't work right
218 return unless -f $db_file;
220 my $orig_inode = (stat($db_file))[1]
223 my $clan_connect_caller = '*UNKNOWN*';
225 while ( my ($pack, $file, $line) = caller(++$i) ) {
226 next if $file eq __FILE__;
227 next if $pack =~ /^DBIx::Class|^Try::Tiny/;
228 $clan_connect_caller = "$file line $line";
235 return if $failed_once;
238 if ($event eq 'connect') {
239 # this is necessary in case we are disconnected and connected again, all within the same $dbh object
243 elsif ($event eq 'disconnect') {
246 elsif ($event eq 'DESTROY' and ! $connected ) {
252 $fail_reason = 'is missing';
255 my $cur_inode = (stat($db_file))[1];
257 if ($orig_inode != $cur_inode) {
258 # pack/unpack to match the unsigned longs returned by `stat`
259 $fail_reason = sprintf 'was recreated (initially inode %s, now %s)', (
260 map { unpack ('L', pack ('l', $_) ) } ($orig_inode, $cur_inode )
268 require Test::Builder;
269 my $t = Test::Builder->new;
270 local $Test::Builder::Level = $Test::Builder::Level + 3;
272 "$db_file originally created at $clan_connect_caller $fail_reason before $event "
273 . 'of DBI handle - a strong indicator that the database file was tampered with while '
274 . 'still being open. This action would fail massively if running under Win32, hence '
275 . 'we make sure it fails on any OS :)'
279 return; # this empty return is a DBI requirement
283 my $weak_registry = {};
291 if ($args{compose_connection}) {
292 $schema = DBICTest::Schema->compose_connection(
293 'DBICTest', $self->_database(%args)
296 $schema = DBICTest::Schema->compose_namespace('DBICTest');
299 if( $args{storage_type}) {
300 $schema->storage_type($args{storage_type});
303 if ( !$args{no_connect} ) {
304 $schema = $schema->connect($self->_database(%args));
307 if ( !$args{no_deploy} ) {
308 __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
309 __PACKAGE__->populate_schema( $schema )
310 if( !$args{no_populate} );
313 populate_weakregistry ( $weak_registry, $schema->storage )
314 if $INC{'Test/Builder.pm'} and $schema->storage;
320 assert_empty_weakregistry($weak_registry, 'quiet');
325 DBICTest->deploy_schema( $schema );
327 This method does one of two things to the schema. It can either call
328 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
329 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
330 file and execute the SQL within. Either way you end up with a fresh set
331 of tables for testing.
338 my $args = shift || {};
340 local $schema->storage->{debug}
341 if ($ENV{TRAVIS}||'') eq 'true';
343 if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
344 $schema->deploy($args);
346 my $filename = Path::Class::File->new(__FILE__)->dir
347 ->file('sqlite.sql')->stringify;
348 my $sql = do { local (@ARGV, $/) = $filename ; <> };
349 for my $chunk ( split (/;\s*\n+/, $sql) ) {
350 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
351 $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
358 =head2 populate_schema
360 DBICTest->populate_schema( $schema );
362 After you deploy your schema you can use this method to populate
363 the tables with test data.
367 sub populate_schema {
371 local $schema->storage->{debug}
372 if ($ENV{TRAVIS}||'') eq 'true';
374 $schema->populate('Genre', [
379 $schema->populate('Artist', [
380 [ qw/artistid name/ ],
381 [ 1, 'Caterwauler McCrae' ],
382 [ 2, 'Random Boy Band' ],
383 [ 3, 'We Are Goth' ],
386 $schema->populate('CD', [
387 [ qw/cdid artist title year genreid/ ],
388 [ 1, 1, "Spoonful of bees", 1999, 1 ],
389 [ 2, 1, "Forkful of bees", 2001 ],
390 [ 3, 1, "Caterwaulin' Blues", 1997 ],
391 [ 4, 2, "Generic Manufactured Singles", 2001 ],
392 [ 5, 3, "Come Be Depressed With Us", 1998 ],
395 $schema->populate('LinerNotes', [
396 [ qw/liner_id notes/ ],
397 [ 2, "Buy Whiskey!" ],
399 [ 5, "Kill Yourself!" ],
402 $schema->populate('Tag', [
403 [ qw/tagid cd tag/ ],
415 $schema->populate('TwoKeys', [
422 $schema->populate('FourKeys', [
423 [ qw/foo bar hello goodbye sensors/ ],
424 [ 1, 2, 3, 4, 'online' ],
425 [ 5, 4, 3, 6, 'offline' ],
428 $schema->populate('OneKey', [
429 [ qw/id artist cd/ ],
435 $schema->populate('SelfRef', [
441 $schema->populate('SelfRefAlias', [
442 [ qw/self_ref alias/ ],
446 $schema->populate('ArtistUndirectedMap', [
451 $schema->populate('Producer', [
452 [ qw/producerid name/ ],
453 [ 1, 'Matt S Trout' ],
454 [ 2, 'Bob The Builder' ],
455 [ 3, 'Fred The Phenotype' ],
458 $schema->populate('CD_to_Producer', [
465 $schema->populate('TreeLike', [
466 [ qw/id parent name/ ],
467 [ 1, undef, 'root' ],
476 $schema->populate('Track', [
477 [ qw/trackid cd position title/ ],
478 [ 4, 2, 1, "Stung with Success"],
479 [ 5, 2, 2, "Stripy"],
480 [ 6, 2, 3, "Sticky Honey"],
481 [ 7, 3, 1, "Yowlin"],
482 [ 8, 3, 2, "Howlin"],
483 [ 9, 3, 3, "Fowlin"],
484 [ 10, 4, 1, "Boring Name"],
485 [ 11, 4, 2, "Boring Song"],
486 [ 12, 4, 3, "No More Ideas"],
488 [ 14, 5, 2, "Under The Weather"],
489 [ 15, 5, 3, "Suicidal"],
490 [ 16, 1, 1, "The Bees Knees"],
491 [ 17, 1, 2, "Apiary"],
492 [ 18, 1, 3, "Beehind You"],
495 $schema->populate('Event', [
496 [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
497 [ 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'],
500 $schema->populate('Link', [
501 [ qw/id url title/ ],
505 $schema->populate('Bookmark', [
510 $schema->populate('Collection', [
511 [ qw/collectionid name/ ],
516 $schema->populate('TypedObject', [
517 [ qw/objectid type value/ ],
518 [ 1, "pointy", "Awl" ],
519 [ 2, "round", "Bearing" ],
520 [ 3, "pointy", "Knife" ],
521 [ 4, "pointy", "Tooth" ],
522 [ 5, "round", "Head" ],
524 $schema->populate('CollectionObject', [
525 [ qw/collection object/ ],
533 $schema->populate('Owners', [
539 $schema->populate('BooksInLibrary', [
540 [ qw/id owner title source price/ ],
541 [ 1, 1, "Programming Perl", "Library", 23 ],
542 [ 2, 1, "Dynamical Systems", "Library", 37 ],
543 [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],