X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=t%2Flib%2FDBICTest.pm;h=cfc18df9798ab02c2b5d78a87809e737ed96144e;hb=e570488ade8f327f47dd3318db3443a348d561d6;hp=a18576361b7a4e160f0073e738cba94b18a36c02;hpb=39568b8ae8bbe3cf6b6873ce87a8fd925a539d64;p=dbsrgits%2FDBIx-Class-Historic.git diff --git a/t/lib/DBICTest.pm b/t/lib/DBICTest.pm index a185763..cfc18df 100644 --- a/t/lib/DBICTest.pm +++ b/t/lib/DBICTest.pm @@ -1,9 +1,13 @@ package # hide from PAUSE DBICTest; +# load early so that `perl -It/lib -MDBICTest` keeps working +use ANFANG; + use strict; use warnings; + # this noop trick initializes the STDOUT, so that the TAP::Harness # issued IO::Select->can_read calls (which are blocking wtf wtf wtf) # keep spinning and scheduling jobs @@ -12,30 +16,54 @@ use warnings; # (ideally this needs to be addressed in T::H, but a quick patchjob # broke everything so tabling it for now) BEGIN { + # FIXME - there probably is some way to determine a harness run (T::H or + # prove) but I do not know it offhand, especially on older environments + # Go with the safer option if ($INC{'Test/Builder.pm'}) { - local $| = 1; - print "#\n"; + select( ( select(\*STDOUT), $|=1 )[0] ); + print STDOUT "#\n"; } } -use DBICTest::RunMode; -use DBICTest::Schema; + +use DBICTest::Util qw( + local_umask slurp_bytes tmpdir await_flock + dbg DEBUG_TEST_CONCURRENCY_LOCKS PEEPEENESS +); use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/; -use DBICTest::Util 'local_umask'; + +# The actual ASSERT logic is in BaseSchema for pesky load-order reasons +# Hence run this through once, *before* DBICTest::Schema and friends load +BEGIN { + if ( + DBIx::Class::_ENV_::ASSERT_NO_ERRONEOUS_METAINSTANCE_USE + or + DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS + ) { + require DBIx::Class::Row; + require DBICTest::BaseSchema; + DBICTest::BaseSchema->connect( sub {} ); + } +} + +use DBICTest::Schema; +use DBIx::Class::_Util qw( detected_reinvoked_destructor scope_guard modver_gt_or_eq ); use Carp; -use Path::Class::File (); -use File::Spec; use Fcntl qw/:DEFAULT :flock/; +use Config; =head1 NAME -DBICTest - Library to be used by DBIx::Class test scripts. +DBICTest - Library to be used by DBIx::Class test scripts =head1 SYNOPSIS - use lib qw(t/lib); - use DBICTest; + BEGIN { do "./t/lib/ANFANG.pm" or die ( $@ || $! ) } + + use warnings; + use strict; use Test::More; + use DBICTest; my $schema = DBICTest->init_schema(); @@ -44,6 +72,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 @@ -60,90 +108,84 @@ 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 -# 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 DBICTest grabs a shared lock, and the few tests that request a :GlobalLock -# will ask for an exclusive one and block until they can get it +# see L our ($global_lock_fh, $global_exclusive_lock); sub import { my $self = shift; - my $tmpdir = DBICTest::RunMode->tmpdir; - my $lockpath = $tmpdir->file('.dbictest_global.lock'); + my $lockpath = tmpdir . '_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 do { - my $err = $!; - - my @x_tests = map { (defined $_) ? ( $_ ? 1 : 0 ) : 'U' } map {(-e, -d, -f, -r, -w, -x, -o)} ($tmpdir, $lockpath); - - die sprintf <<"EOE", $lockpath, $err, scalar $>, scalar $), (stat($tmpdir))[4,5,2], @x_tests; -Unable to open %s: %s -Process EUID/EGID: %s / %s -TmpDir UID/GID: %s / %s -TmpDir StatMode: %o -TmpDir X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s -TmpFile X-tests: -e:%s -d:%s -f:%s -r:%s -w:%s -x:%s -o:%s -EOE - }; + sysopen ($global_lock_fh, $lockpath, O_RDWR|O_CREAT) + or die "Unable to open $lockpath: $!"; } - for (@_) { - if ($_ eq ':GlobalLock') { - flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!"; + for my $exp (@_) { + if ($exp eq ':GlobalLock') { + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Waiting for EXCLUSIVE global lock..."; + + await_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 $_ requested from $self"; + croak "Unknown export $exp requested from $self"; } } unless ($global_exclusive_lock) { - flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!"; - } -} + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Waiting for SHARED global lock..."; -END { - if ($global_lock_fh) { - # delay destruction even more + await_flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!"; + + DEBUG_TEST_CONCURRENCY_LOCKS > 1 + and dbg "Got SHARED global lock"; } } -{ - my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var'); - $dir->mkpath unless -d "$dir"; - $dir = "$dir"; +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; + } - sub _sqlite_dbfilename { - my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$; - $holder = $$ if $holder == -1; + _cleanup_dbfile(); +} - # useful for missing cleanup debugging - #if ( $holder == $$) { - # my $x = $0; - # $x =~ s/\//#/g; - # $holder .= "-$x"; - #} +sub _sqlite_dbfilename { + my $holder = $ENV{DBICTEST_LOCK_HOLDER} || $$; + $holder = $$ if $holder == -1; - return "$dir/DBIxClass-$holder.db"; - } - - END { - _cleanup_dbfile(); - } + return "t/var/DBIxClass-$holder.db"; } $SIG{INT} = sub { _cleanup_dbfile(); exit 1 }; +my $need_global_cleanup; sub _cleanup_dbfile { # cleanup if this is us if ( @@ -153,6 +195,10 @@ sub _cleanup_dbfile { 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"); } @@ -196,29 +242,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}) { - - $storage->throw_exception( - 'PRAGMA reverse_unordered_selects does not work correctly before libsqlite 3.7.9' - ) if $storage->_server_info->{normalized_dbms_version} < 3.007009; - + 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') }, }; } }, @@ -227,17 +274,23 @@ 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 + PEEPEENESS + or + ! -f $db_file + ); + my $orig_inode = (stat($db_file))[1] or return; my $clan_connect_caller = '*UNKNOWN*'; my $i; - while ( my ($pack, $file, $line) = caller(++$i) ) { + while ( my ($pack, $file, $line) = CORE::caller(++$i) ) { next if $file eq __FILE__; next if $pack =~ /^DBIx::Class|^Try::Tiny/; $clan_connect_caller = "$file line $line"; @@ -256,6 +309,7 @@ sub __mk_disconnect_guard { return; } elsif ($event eq 'disconnect') { + return unless $connected; # we already disconnected earlier $connected = 0; } elsif ($event eq 'DESTROY' and ! $connected ) { @@ -270,10 +324,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 + ; } } @@ -303,9 +363,23 @@ sub init_schema { my $schema; + if ( + $ENV{DBICTEST_VIA_REPLICATED} &&= ( + !$args{storage_type} + && + ( ! defined $args{sqlite_use_file} or $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'); @@ -316,7 +390,21 @@ sub init_schema { } if ( !$args{no_connect} ) { - $schema = $schema->connect($self->_database(%args)); + $schema->connection(@dsn); + + if( $ENV{DBICTEST_VIA_REPLICATED} ) { + + # add explicit ReadOnly=1 if we can support it + $dsn[0] =~ /^dbi:SQLite:/i + and + require DBD::SQLite + and + modver_gt_or_eq('DBD::SQLite', '1.49_05') + and + $dsn[0] =~ s/^dbi:SQLite:/dbi:SQLite(ReadOnly=1):/i; + + $schema->storage->connect_replicants(\@dsn); + } } if ( !$args{no_deploy} ) { @@ -332,7 +420,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 @@ -352,15 +443,16 @@ sub deploy_schema { my $schema = shift; my $args = shift || {}; - local $schema->storage->{debug} - if ($ENV{TRAVIS}||'') eq 'true'; + my $guard; + if ( ($ENV{TRAVIS}||'') eq 'true' and my $old_dbg = $schema->storage->debug ) { + $guard = scope_guard { $schema->storage->debug($old_dbg) }; + $schema->storage->debug(0); + } if ($ENV{"DBICTEST_SQLT_DEPLOY"}) { $schema->deploy($args); } else { - my $filename = Path::Class::File->new(__FILE__)->dir - ->file('sqlite.sql')->stringify; - my $sql = do { local (@ARGV, $/) = $filename ; <> }; + my $sql = slurp_bytes( 't/lib/sqlite.sql' ); for my $chunk ( split (/;\s*\n+/, $sql) ) { 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 $schema->storage->dbh_do(sub { $_[1]->do($chunk) }) or print "Error on SQL: $chunk\n"; @@ -383,8 +475,11 @@ sub populate_schema { my $self = shift; my $schema = shift; - local $schema->storage->{debug} - if ($ENV{TRAVIS}||'') eq 'true'; + my $guard; + if ( ($ENV{TRAVIS}||'') eq 'true' and my $old_dbg = $schema->storage->debug ) { + $guard = scope_guard { $schema->storage->debug($old_dbg) }; + $schema->storage->debug(0); + } $schema->populate('Genre', [ [qw/genreid name/],