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/;
80 DBICTest - Library to be used by DBIx::Class test scripts.
88 my $schema = DBICTest->init_schema();
92 This module provides the basic utilities to write tests against
99 my $schema = DBICTest->init_schema(
102 storage_type=>'::DBI::Replicated',
104 balancer_type=>'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
108 This method removes the test SQLite database in t/var/DBIxClass.db
109 and then creates a new, empty database.
111 This method will call deploy_schema() by default, unless the
112 no_deploy flag is set.
114 Also, by default, this method will call populate_schema() by
115 default, unless the no_deploy or no_populate flags are set.
119 # some tests are very time sensitive and need to run on their own, without
120 # being disturbed by anything else grabbing CPU or disk IO. Hence why everything
121 # using DBICTest grabs a shared lock, and the few tests that request a :GlobalLock
122 # will ask for an exclusive one and block until they can get it
123 our ($global_lock_fh, $global_exclusive_lock);
127 my $tmpdir = DBICTest::RunMode->tmpdir;
128 my $lockpath = $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) or do {
135 my @x_tests = map { (defined $_) ? ( $_ ? 1 : 0 ) : 'U' } map {(-e, -d, -f, -r, -w, -x, -o)} ($tmpdir, $lockpath);
137 die sprintf <<"EOE", $lockpath, $err, scalar $>, scalar $), (stat($tmpdir))[4,5,2], @x_tests;
138 Unable to open %s: %s
139 Process EUID/EGID: %s / %s
140 TmpDir UID/GID: %s / %s
142 TmpDir X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s
143 TmpFile X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s
149 if ($_ eq ':GlobalLock') {
150 flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!";
151 $global_exclusive_lock = 1;
154 croak "Unknown export $_ requested from $self";
158 unless ($global_exclusive_lock) {
159 flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!";
164 if ($global_lock_fh) {
165 # delay destruction even more
170 my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var');
171 $dir->mkpath unless -d "$dir";
174 sub _sqlite_dbfilename {
175 my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$;
176 $holder = $$ if $holder == -1;
178 # useful for missing cleanup debugging
179 #if ( $holder == $$) {
185 return "$dir/DBIxClass-$holder.db";
193 $SIG{INT} = sub { _cleanup_dbfile(); exit 1 };
195 sub _cleanup_dbfile {
196 # cleanup if this is us
198 ! $ENV{DBICTEST_LOCK_HOLDER}
200 $ENV{DBICTEST_LOCK_HOLDER} == -1
202 $ENV{DBICTEST_LOCK_HOLDER} == $$
204 my $db_file = _sqlite_dbfilename();
205 unlink $_ for ($db_file, "${db_file}-journal");
210 return $ENV{"DBICTEST_DSN"} ? 1:0;
216 return $self->_sqlite_dbfilename if (
217 defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'}
226 if ($ENV{DBICTEST_DSN}) {
228 (map { $ENV{"DBICTEST_${_}"} || '' } qw/DSN DBUSER DBPASS/),
229 { AutoCommit => 1, %args },
232 my $db_file = $self->_sqlite_dbname(%args);
234 for ($db_file, "${db_file}-journal") {
236 unlink ($_) or carp (
237 "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!"
241 return ("dbi:SQLite:${db_file}", '', '', {
244 # this is executed on every connect, and thus installs a disconnect/DESTROY
245 # guard for every new $dbh
246 on_connect_do => sub {
248 my $dbh = $storage->_get_dbh;
251 $dbh->do ('PRAGMA synchronous = OFF');
253 if ($ENV{DBICTEST_SQLITE_REVERSE_DEFAULT_ORDER}) {
255 $storage->throw_exception(
256 'PRAGMA reverse_unordered_selects does not work correctly before libsqlite 3.7.9'
257 ) if $storage->_server_info->{normalized_dbms_version} < 3.007009;
259 $dbh->do ('PRAGMA reverse_unordered_selects = ON');
262 # set a *DBI* disconnect callback, to make sure the physical SQLite
263 # file is still there (i.e. the test does not attempt to delete
264 # an open database, which fails on Win32)
265 if (my $guard_cb = __mk_disconnect_guard($db_file)) {
266 $dbh->{Callbacks} = {
267 connect => sub { $guard_cb->('connect') },
268 disconnect => sub { $guard_cb->('disconnect') },
269 DESTROY => sub { $guard_cb->('DESTROY') },
277 sub __mk_disconnect_guard {
278 return if DBIx::Class::_ENV_::PEEPEENESS; # leaks handles, delaying DESTROY, can't work right
281 return unless -f $db_file;
283 my $orig_inode = (stat($db_file))[1]
286 my $clan_connect_caller = '*UNKNOWN*';
288 while ( my ($pack, $file, $line) = caller(++$i) ) {
289 next if $file eq __FILE__;
290 next if $pack =~ /^DBIx::Class|^Try::Tiny/;
291 $clan_connect_caller = "$file line $line";
298 return if $failed_once;
301 if ($event eq 'connect') {
302 # this is necessary in case we are disconnected and connected again, all within the same $dbh object
306 elsif ($event eq 'disconnect') {
309 elsif ($event eq 'DESTROY' and ! $connected ) {
315 $fail_reason = 'is missing';
318 my $cur_inode = (stat($db_file))[1];
320 if ($orig_inode != $cur_inode) {
321 # pack/unpack to match the unsigned longs returned by `stat`
322 $fail_reason = sprintf 'was recreated (initially inode %s, now %s)', (
323 map { unpack ('L', pack ('l', $_) ) } ($orig_inode, $cur_inode )
331 require Test::Builder;
332 my $t = Test::Builder->new;
333 local $Test::Builder::Level = $Test::Builder::Level + 3;
335 "$db_file originally created at $clan_connect_caller $fail_reason before $event "
336 . 'of DBI handle - a strong indicator that the database file was tampered with while '
337 . 'still being open. This action would fail massively if running under Win32, hence '
338 . 'we make sure it fails on any OS :)'
342 return; # this empty return is a DBI requirement
346 my $weak_registry = {};
354 if ($args{compose_connection}) {
355 $schema = DBICTest::Schema->compose_connection(
356 'DBICTest', $self->_database(%args)
359 $schema = DBICTest::Schema->compose_namespace('DBICTest');
362 if( $args{storage_type}) {
363 $schema->storage_type($args{storage_type});
366 if ( !$args{no_connect} ) {
367 $schema = $schema->connect($self->_database(%args));
370 if ( !$args{no_deploy} ) {
371 __PACKAGE__->deploy_schema( $schema, $args{deploy_args} );
372 __PACKAGE__->populate_schema( $schema )
373 if( !$args{no_populate} );
376 populate_weakregistry ( $weak_registry, $schema->storage )
377 if $INC{'Test/Builder.pm'} and $schema->storage;
383 assert_empty_weakregistry($weak_registry, 'quiet');
388 DBICTest->deploy_schema( $schema );
390 This method does one of two things to the schema. It can either call
391 the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment
392 variable is set, otherwise the default is to read in the t/lib/sqlite.sql
393 file and execute the SQL within. Either way you end up with a fresh set
394 of tables for testing.
401 my $args = shift || {};
403 local $schema->storage->{debug}
404 if ($ENV{TRAVIS}||'') eq 'true';
406 if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
407 $schema->deploy($args);
409 my $filename = Path::Class::File->new(__FILE__)->dir
410 ->file('sqlite.sql')->stringify;
411 my $sql = do { local (@ARGV, $/) = $filename ; <> };
412 for my $chunk ( split (/;\s*\n+/, $sql) ) {
413 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
414 $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n";
421 =head2 populate_schema
423 DBICTest->populate_schema( $schema );
425 After you deploy your schema you can use this method to populate
426 the tables with test data.
430 sub populate_schema {
434 local $schema->storage->{debug}
435 if ($ENV{TRAVIS}||'') eq 'true';
437 $schema->populate('Genre', [
442 $schema->populate('Artist', [
443 [ qw/artistid name/ ],
444 [ 1, 'Caterwauler McCrae' ],
445 [ 2, 'Random Boy Band' ],
446 [ 3, 'We Are Goth' ],
449 $schema->populate('CD', [
450 [ qw/cdid artist title year genreid/ ],
451 [ 1, 1, "Spoonful of bees", 1999, 1 ],
452 [ 2, 1, "Forkful of bees", 2001 ],
453 [ 3, 1, "Caterwaulin' Blues", 1997 ],
454 [ 4, 2, "Generic Manufactured Singles", 2001 ],
455 [ 5, 3, "Come Be Depressed With Us", 1998 ],
458 $schema->populate('LinerNotes', [
459 [ qw/liner_id notes/ ],
460 [ 2, "Buy Whiskey!" ],
462 [ 5, "Kill Yourself!" ],
465 $schema->populate('Tag', [
466 [ qw/tagid cd tag/ ],
478 $schema->populate('TwoKeys', [
485 $schema->populate('FourKeys', [
486 [ qw/foo bar hello goodbye sensors/ ],
487 [ 1, 2, 3, 4, 'online' ],
488 [ 5, 4, 3, 6, 'offline' ],
491 $schema->populate('OneKey', [
492 [ qw/id artist cd/ ],
498 $schema->populate('SelfRef', [
504 $schema->populate('SelfRefAlias', [
505 [ qw/self_ref alias/ ],
509 $schema->populate('ArtistUndirectedMap', [
514 $schema->populate('Producer', [
515 [ qw/producerid name/ ],
516 [ 1, 'Matt S Trout' ],
517 [ 2, 'Bob The Builder' ],
518 [ 3, 'Fred The Phenotype' ],
521 $schema->populate('CD_to_Producer', [
528 $schema->populate('TreeLike', [
529 [ qw/id parent name/ ],
530 [ 1, undef, 'root' ],
539 $schema->populate('Track', [
540 [ qw/trackid cd position title/ ],
541 [ 4, 2, 1, "Stung with Success"],
542 [ 5, 2, 2, "Stripy"],
543 [ 6, 2, 3, "Sticky Honey"],
544 [ 7, 3, 1, "Yowlin"],
545 [ 8, 3, 2, "Howlin"],
546 [ 9, 3, 3, "Fowlin"],
547 [ 10, 4, 1, "Boring Name"],
548 [ 11, 4, 2, "Boring Song"],
549 [ 12, 4, 3, "No More Ideas"],
551 [ 14, 5, 2, "Under The Weather"],
552 [ 15, 5, 3, "Suicidal"],
553 [ 16, 1, 1, "The Bees Knees"],
554 [ 17, 1, 2, "Apiary"],
555 [ 18, 1, 3, "Beehind You"],
558 $schema->populate('Event', [
559 [ qw/id starts_at created_on varchar_date varchar_datetime skip_inflation/ ],
560 [ 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'],
563 $schema->populate('Link', [
564 [ qw/id url title/ ],
568 $schema->populate('Bookmark', [
573 $schema->populate('Collection', [
574 [ qw/collectionid name/ ],
579 $schema->populate('TypedObject', [
580 [ qw/objectid type value/ ],
581 [ 1, "pointy", "Awl" ],
582 [ 2, "round", "Bearing" ],
583 [ 3, "pointy", "Knife" ],
584 [ 4, "pointy", "Tooth" ],
585 [ 5, "round", "Head" ],
587 $schema->populate('CollectionObject', [
588 [ qw/collection object/ ],
596 $schema->populate('Owners', [
602 $schema->populate('BooksInLibrary', [
603 [ qw/id owner title source price/ ],
604 [ 1, 1, "Programming Perl", "Library", 23 ],
605 [ 2, 1, "Dynamical Systems", "Library", 37 ],
606 [ 3, 2, "Best Recipe Cookbook", "Library", 65 ],