X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=t%2Flib%2FDBICTest.pm;h=6da2f7e5c9d63346d17540dd63f1a09e7e3455a5;hb=69016f65;hp=df3587eb89c1e6fab873d4dd275e5096edad4296;hpb=65d351219882184861384aedac6f251b6797d0d7;p=dbsrgits%2FDBIx-Class.git diff --git a/t/lib/DBICTest.pm b/t/lib/DBICTest.pm index df3587e..6da2f7e 100644 --- a/t/lib/DBICTest.pm +++ b/t/lib/DBICTest.pm @@ -3,15 +3,21 @@ package # hide from PAUSE use strict; use warnings; -use DBICTest::RunMode; + +use DBICTest::Util qw( local_umask dbg DEBUG_TEST_CONCURRENCY_LOCKS ); use DBICTest::Schema; -use DBICTest::Util qw/populate_weakregistry assert_empty_weakregistry/; +use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/; +use DBIx::Class::_Util 'detected_reinvoked_destructor'; use Carp; use Path::Class::File (); +use File::Spec; +use Fcntl qw/:DEFAULT :flock/; +use Config; +use Scope::Guard (); =head1 NAME -DBICTest - Library to be used by DBIx::Class test scripts. +DBICTest - Library to be used by DBIx::Class test scripts =head1 SYNOPSIS @@ -26,6 +32,26 @@ DBICTest - Library to be used by DBIx::Class test scripts. This module provides the basic utilities to write tests against DBIx::Class. +=head1 EXPORTS + +The module does not export anything by default, nor provides individual +function exports in the conventional sense. Instead the following tags are +recognized: + +=head2 :DiffSQL + +Same as C +L +L)> + +=head2 :GlobalLock + +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 C grabs a shared lock, and the few tests that request a +C<:GlobalLock> will ask for an exclusive one and block until they can get it. + =head1 METHODS =head2 init_schema @@ -42,28 +68,127 @@ DBIx::Class. 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. +This method will call L by default, unless the +C flag is set. -Also, by default, this method will call populate_schema() by -default, unless the no_deploy or no_populate flags are set. +Also, by default, this method will call L +by default, unless the C or C flags are set. =cut -sub has_custom_dsn { - return $ENV{"DBICTEST_DSN"} ? 1:0; +# see L +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 + sysopen ($global_lock_fh, $lockpath, O_RDWR|O_CREAT) + or die "Unable to open $lockpath: $!"; + } + + for my $exp (@_) { + if ($exp eq ':GlobalLock') { + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Waiting for EXCLUSIVE global lock..."; + + flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!"; + + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Got EXCLUSIVE global lock"; + + $global_exclusive_lock = 1; + } + elsif ($exp eq ':DiffSQL') { + require SQL::Abstract::Test; + my $into = caller(0); + for (qw(is_same_sql_bind is_same_sql is_same_bind)) { + no strict 'refs'; + *{"${into}::$_"} = \&{"SQL::Abstract::Test::$_"}; + } + } + else { + croak "Unknown export $exp requested from $self"; + } + } + + unless ($global_exclusive_lock) { + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Waiting for SHARED global lock..."; + + flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!"; + + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Got SHARED global lock"; + } } -sub _sqlite_dbfilename { +END { + # referencing here delays destruction even more + if ($global_lock_fh) { + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Release @{[ $global_exclusive_lock ? 'EXCLUSIVE' : 'SHARED' ]} global lock (END)"; + 1; + } +} + +{ my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var'); $dir->mkpath unless -d "$dir"; - return $dir->file('DBIxClass.db')->stringify; + $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 }; + +my $need_global_cleanup; +sub _cleanup_dbfile { + # cleanup if this is us + if ( + ! $ENV{DBICTEST_LOCK_HOLDER} + or + $ENV{DBICTEST_LOCK_HOLDER} == -1 + or + $ENV{DBICTEST_LOCK_HOLDER} == $$ + ) { + if ($need_global_cleanup and my $dbh = DBICTest->schema->storage->_dbh) { + $dbh->disconnect; + } + + 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 $args{sqlite_use_file} or $ENV{"DBICTEST_SQLITE_USE_FILE"}; + return $self->_sqlite_dbfilename if ( + defined $args{sqlite_use_file} ? $args{sqlite_use_file} : $ENV{'DBICTEST_SQLITE_USE_FILE'} + ); return ":memory:"; } @@ -92,20 +217,30 @@ sub _database { # 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'); + if ( + $ENV{DBICTEST_SQLITE_REVERSE_DEFAULT_ORDER} + and + # the pragma does not work correctly before libsqlite 3.7.9 + $storage->_server_info->{normalized_dbms_version} >= 3.007009 + ) { + $dbh->do ('PRAGMA reverse_unordered_selects = ON'); + } + # 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)) { + if (! $storage->{master} and 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') }, + DESTROY => sub { &detected_reinvoked_destructor; $guard_cb->('DESTROY') }, }; } }, @@ -114,10 +249,16 @@ sub _database { } 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; + + return if ( + # this perl leaks handles, delaying DESTROY, can't work right + DBIx::Class::_ENV_::PEEPEENESS + or + ! -f $db_file + ); + my $orig_inode = (stat($db_file))[1] or return; @@ -157,10 +298,16 @@ sub __mk_disconnect_guard { 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 ) - ); + my @inodes = ($orig_inode, $cur_inode); + # unless this is a fixed perl (P5RT#84590) pack/unpack before display + # to match the unsigned longs returned by `stat` + @inodes = map { unpack ('L', pack ('l', $_) ) } @inodes + unless $Config{st_ino_size}; + + $fail_reason = sprintf + 'was recreated (initially inode %s, now %s)', + @inodes + ; } } @@ -190,9 +337,20 @@ sub init_schema { my $schema; + if ( + $ENV{DBICTEST_VIA_REPLICATED} &&= + ( !$args{storage_type} && !defined $args{sqlite_use_file} ) + ) { + $args{storage_type} = ['::DBI::Replicated', { balancer_type => '::Random' }]; + $args{sqlite_use_file} = 1; + } + + my @dsn = $self->_database(%args); + if ($args{compose_connection}) { + $need_global_cleanup = 1; $schema = DBICTest::Schema->compose_connection( - 'DBICTest', $self->_database(%args) + 'DBICTest', @dsn ); } else { $schema = DBICTest::Schema->compose_namespace('DBICTest'); @@ -203,7 +361,10 @@ sub init_schema { } if ( !$args{no_connect} ) { - $schema = $schema->connect($self->_database(%args)); + $schema->connection(@dsn); + + $schema->storage->connect_replicants(\@dsn) + if $ENV{DBICTEST_VIA_REPLICATED}; } if ( !$args{no_deploy} ) { @@ -219,7 +380,10 @@ sub init_schema { } END { + # Make sure we run after any cleanup in other END blocks + push @{ B::end_av()->object_2svref }, sub { assert_empty_weakregistry($weak_registry, 'quiet'); + }; } =head2 deploy_schema @@ -239,6 +403,12 @@ sub deploy_schema { my $schema = shift; my $args = shift || {}; + my $guard; + if ( ($ENV{TRAVIS}||'') eq 'true' and my $old_dbg = $schema->storage->debug ) { + $guard = Scope::Guard->new(sub { $schema->storage->debug($old_dbg) }); + $schema->storage->debug(0); + } + if ($ENV{"DBICTEST_SQLT_DEPLOY"}) { $schema->deploy($args); } else { @@ -267,6 +437,12 @@ sub populate_schema { my $self = shift; my $schema = shift; + my $guard; + if ( ($ENV{TRAVIS}||'') eq 'true' and my $old_dbg = $schema->storage->debug ) { + $guard = Scope::Guard->new(sub { $schema->storage->debug($old_dbg) }); + $schema->storage->debug(0); + } + $schema->populate('Genre', [ [qw/genreid name/], [qw/1 emo /],