1 package # hide from PAUSE
7 # Needs to load 1st so that the correct SQLA::Test is picked up
8 use DBIx::Class::_TempExtlib;
10 # this noop trick initializes the STDOUT, so that the TAP::Harness
11 # issued IO::Select->can_read calls (which are blocking wtf wtf wtf)
12 # keep spinning and scheduling jobs
13 # This results in an overall much smoother job-queue drainage, since
14 # the Harness blocks less
15 # (ideally this needs to be addressed in T::H, but a quick patchjob
16 # broke everything so tabling it for now)
18 if ($INC{'Test/Builder.pm'}) {
24 # This is a pretty good candidate for a standalone extraction (Test::AutoSkip?)
27 ! $ENV{RELEASE_TESTING}
29 ! $ENV{AUTHOR_TESTING}
31 $0 =~ /^ (.*) x?t [\/\\] .+ \.t $/x
33 -f ( my $fn = "$1.auto_todo")
37 my $canonical_dollarzero = File::Spec::Unix->catpath(File::Spec->splitpath($0));
40 ( $_ =~ /^ \s* ( [^\#\n]+ ) /x ) ? $1 : ()
41 } do { local @ARGV = $fn; <> } ) {
42 if ( $canonical_dollarzero =~ m! (?: \A | / ) \Q$t\E \z !x ) {
43 require Test::Builder;
44 Test::Builder->new->todo_start("Global todoification of '$t' specified in $fn");
50 use Module::Runtime 'module_notional_filename';
52 for my $mod (qw( DBIC::SqlMakerTest SQL::Abstract )) {
53 if ( $INC{ module_notional_filename($mod) } ) {
54 # FIXME this does not seem to work in BEGIN - why?!
56 #$Carp::Internal{ (__PACKAGE__) }++;
57 #Carp::croak( __PACKAGE__ . " must be loaded before $mod" );
60 while (@frame = caller($fr++)) {
61 last if $frame[1] !~ m|^t/lib/DBICTest|;
64 die __PACKAGE__ . " must be loaded before $mod (or modules using $mod) at $frame[1] line $frame[2]\n";
69 use DBICTest::RunMode;
71 use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/;
72 use DBICTest::Util 'local_umask';
74 use Path::Class::File ();
76 use Fcntl qw/:DEFAULT :flock/;
81 DBICTest - Library to be used by DBIx::Class test scripts.
89 my $schema = DBICTest->init_schema();
93 This module provides the basic utilities to write tests against
100 my $schema = DBICTest->init_schema(
103 storage_type=>'::DBI::Replicated',
105 balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
109 This method removes the test SQLite database in t/var/DBIxClass.db
110 and then creates a new, empty database.
112 This method will call deploy_schema() by default, unless the
113 no_deploy flag is set.
115 Also, by default, this method will call populate_schema() by
116 default, unless the no_deploy or no_populate flags are set.
120 # some tests are very time sensitive and need to run on their own, without
121 # being disturbed by anything else grabbing CPU or disk IO. Hence why everything
122 # using DBICTest grabs a shared lock, and the few tests that request a :GlobalLock
123 # will ask for an exclusive one and block until they can get it
124 our ($global_lock_fh, $global_exclusive_lock);
128 my $lockpath = DBICTest::RunMode->tmpdir->file('_dbictest_global.lock');
131 my $u = local_umask(0); # so that the file opens as 666, and any user can lock
132 sysopen ($global_lock_fh, $lockpath, O_RDWR|O_CREAT)
133 or die "Unable to open $lockpath: $!";
137 if ($_ eq ':GlobalLock') {
138 flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!";
139 $global_exclusive_lock = 1;
142 croak "Unknown export $_ requested from $self";
146 unless ($global_exclusive_lock) {
147 flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!";
152 if ($global_lock_fh) {
153 # delay destruction even more
158 my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var');
159 $dir->mkpath unless -d "$dir";
162 sub _sqlite_dbfilename {
163 my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$;
164 $holder = $$ if $holder == -1;
166 # useful for missing cleanup debugging
167 #if ( $holder == $$) {
173 return "$dir/DBIxClass-$holder.db";
181 $SIG{INT} = sub { _cleanup_dbfile(); exit 1 };
183 sub _cleanup_dbfile {
184 # cleanup if this is us
186 ! $ENV{DBICTEST_LOCK_HOLDER}
188 $ENV{DBICTEST_LOCK_HOLDER} == -1
190 $ENV{DBICTEST_LOCK_HOLDER} == $$
192 my $db_file = _sqlite_dbfilename();
193 unlink $_ for ($db_file, "${db_file}-journal");
198 return $ENV{"DBICTEST_DSN"} ? 1:0;
204 return $self->_sqlite_dbfilename if (
205 defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'}
214 if ($ENV{DBICTEST_DSN}) {
216 (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
217 { AutoCommit => 1, %args },
220 my $db_file = $self->_sqlite_dbname(%args);
222 for ($db_file, "${db_file}-journal") {
224 unlink ($_) or carp (
225 "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!"
229 return ("dbi:SQLite:${db_file}", '', '', {
232 # this is executed on every connect, and thus installs a disconnect/DESTROY
233 # guard for every new $dbh
234 on_connect_do => sub {
237 my $dbh = $storage->_get_dbh;
240 $dbh->do ('PRAGMA synchronous = OFF');
243 $ENV{DBICTEST_SQLITE_REVERSE_DEFAULT_ORDER}
245 # the pragma does not work correctly before libsqlite 3.7.9
246 $storage->_server_info->{normalized_dbms_version} >= 3.007009
248 $dbh->do ('PRAGMA reverse_unordered_selects = ON');
251 # set a *DBI* disconnect callback, to make sure the physical SQLite
252 # file is still there (i.e. the test does not attempt to delete
253 # an open database, which fails on Win32)
254 if (my $guard_cb = __mk_disconnect_guard($db_file)) {
255 $dbh->{Callbacks} = {
256 connect => sub { $guard_cb->('connect') },
257 disconnect => sub { $guard_cb->('disconnect') },
258 DESTROY => sub { $guard_cb->('DESTROY') },
266 sub __mk_disconnect_guard {
267 return if DBIx::Class::_ENV_::PEEPEENESS; # leaks handles, delaying DESTROY, can't work right
270 return unless -f $db_file;
272 my $orig_inode = (stat($db_file))[1]
275 my $clan_connect_caller = '*UNKNOWN*';
277 while ( my ($pack, $file, $line) = caller(++$i) ) {
278 next if $file eq __FILE__;
279 next if $pack =~ /^DBIx::Class|^Try::Tiny/;
280 $clan_connect_caller = "$file line $line";
287 return if $failed_once;
290 if ($event eq 'connect') {
291 # this is necessary in case we are disconnected and connected again, all within the same $dbh object
295 elsif ($event eq 'disconnect') {
298 elsif ($event eq 'DESTROY' and ! $connected ) {
304 $fail_reason = 'is missing';
307 my $cur_inode = (stat($db_file))[1];
309 if ($orig_inode != $cur_inode) {
310 my @inodes = ($orig_inode, $cur_inode);
311 # unless this is a fixed perl (P5RT#84590) pack/unpack before display
312 # to match the unsigned longs returned by `stat`
313 @inodes = map { unpack ('L', pack ('l', $_) ) } @inodes
314 unless $Config{st_ino_size};
316 $fail_reason = sprintf
317 'was recreated (initially inode %s, now %s)',
326 require Test::Builder;
327 my $t = Test::Builder->new;
328 local $Test::Builder::Level = $Test::Builder::Level + 3;
330 "$db_file originally created at $clan_connect_caller $fail_reason before $event "
331 . 'of DBI handle - a strong indicator that the database file was tampered with while '
332 . 'still being open. This action would fail massively if running under Win32, hence '
333 . 'we make sure it fails on any OS :)'
337 return; # this empty return is a DBI requirement
341 my $weak_registry = {};
349 if ($args{compose_connection}) {
350 $schema = DBICTest::Schema->compose_connection(
351 'DBICTest', $self->_database(%args)
354 $schema = DBICTest::Schema->compose_namespace('DBICTest');
357 if( $args{storage_type}) {
358 $schema->storage_type($args{storage_type});
361 if ( !$args{no_connect} ) {
362 $schema = $schema->connect($self->_database(%args));
365 if ( !$args{no_deploy} ) {
366 __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
367 __PACKAGE__->populate_schema( $schema )
368 if( !$args{no_populate} );
371 populate_weakregistry ( $weak_registry, $schema->storage )
372 if $INC{'Test/Builder.pm'} and $schema->storage;
378 assert_empty_weakregistry($weak_registry, 'quiet');
383 DBICTest->deploy_schema( $schema );
385 This method does one of two things to the schema. It can either call
386 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
387 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
388 file and execute the SQL within. Either way you end up with a fresh set
389 of tables for testing.
396 my $args = shift || {};
398 local $schema->storage->{debug}
399 if ($ENV{TRAVIS}||'') eq 'true';
401 if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
402 $schema->deploy($args);
404 my $filename = Path::Class::File->new(__FILE__)->dir
405 ->file('sqlite.sql')->stringify;
406 my $sql = do { local (@ARGV, $/) = $filename ; <> };
407 for my $chunk ( split (/;\s*\n+/, $sql) ) {
408 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
409 $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
416 =head2 populate_schema
418 DBICTest->populate_schema( $schema );
420 After you deploy your schema you can use this method to populate
421 the tables with test data.
425 sub populate_schema {
429 local $schema->storage->{debug}
430 if ($ENV{TRAVIS}||'') eq 'true';
432 $schema->populate('Genre', [
437 $schema->populate('Artist', [
438 [ qw/artistid name/ ],
439 [ 1, 'Caterwauler McCrae' ],
440 [ 2, 'Random Boy Band' ],
441 [ 3, 'We Are Goth' ],
444 $schema->populate('CD', [
445 [ qw/cdid artist title year genreid/ ],
446 [ 1, 1, "Spoonful of bees", 1999, 1 ],
447 [ 2, 1, "Forkful of bees", 2001 ],
448 [ 3, 1, "Caterwaulin' Blues", 1997 ],
449 [ 4, 2, "Generic Manufactured Singles", 2001 ],
450 [ 5, 3, "Come Be Depressed With Us", 1998 ],
453 $schema->populate('LinerNotes', [
454 [ qw/liner_id notes/ ],
455 [ 2, "Buy Whiskey!" ],
457 [ 5, "Kill Yourself!" ],
460 $schema->populate('Tag', [
461 [ qw/tagid cd tag/ ],
473 $schema->populate('TwoKeys', [
480 $schema->populate('FourKeys', [
481 [ qw/foo bar hello goodbye sensors/ ],
482 [ 1, 2, 3, 4, 'online' ],
483 [ 5, 4, 3, 6, 'offline' ],
486 $schema->populate('OneKey', [
487 [ qw/id artist cd/ ],
493 $schema->populate('SelfRef', [
499 $schema->populate('SelfRefAlias', [
500 [ qw/self_ref alias/ ],
504 $schema->populate('ArtistUndirectedMap', [
509 $schema->populate('Producer', [
510 [ qw/producerid name/ ],
511 [ 1, 'Matt S Trout' ],
512 [ 2, 'Bob The Builder' ],
513 [ 3, 'Fred The Phenotype' ],
516 $schema->populate('CD_to_Producer', [
523 $schema->populate('TreeLike', [
524 [ qw/id parent name/ ],
525 [ 1, undef, 'root' ],
534 $schema->populate('Track', [
535 [ qw/trackid cd position title/ ],
536 [ 4, 2, 1, "Stung with Success"],
537 [ 5, 2, 2, "Stripy"],
538 [ 6, 2, 3, "Sticky Honey"],
539 [ 7, 3, 1, "Yowlin"],
540 [ 8, 3, 2, "Howlin"],
541 [ 9, 3, 3, "Fowlin"],
542 [ 10, 4, 1, "Boring Name"],
543 [ 11, 4, 2, "Boring Song"],
544 [ 12, 4, 3, "No More Ideas"],
546 [ 14, 5, 2, "Under The Weather"],
547 [ 15, 5, 3, "Suicidal"],
548 [ 16, 1, 1, "The Bees Knees"],
549 [ 17, 1, 2, "Apiary"],
550 [ 18, 1, 3, "Beehind You"],
553 $schema->populate('Event', [
554 [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
555 [ 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'],
558 $schema->populate('Link', [
559 [ qw/id url title/ ],
563 $schema->populate('Bookmark', [
568 $schema->populate('Collection', [
569 [ qw/collectionid name/ ],
574 $schema->populate('TypedObject', [
575 [ qw/objectid type value/ ],
576 [ 1, "pointy", "Awl" ],
577 [ 2, "round", "Bearing" ],
578 [ 3, "pointy", "Knife" ],
579 [ 4, "pointy", "Tooth" ],
580 [ 5, "round", "Head" ],
582 $schema->populate('CollectionObject', [
583 [ qw/collection object/ ],
591 $schema->populate('Owners', [
597 $schema->populate('BooksInLibrary', [
598 [ qw/id owner title source price/ ],
599 [ 1, 1, "Programming Perl", "Library", 23 ],
600 [ 2, 1, "Dynamical Systems", "Library", 37 ],
601 [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],