X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=t%2Flib%2FDBICTest.pm;h=49df0605c5d7bc4233b4362ef5e1177f7c42e34c;hb=2c2bc4e58c2146670960fc1a0a2ae802cb650506;hp=7ce94103b07831513b6d8f2c089f860f0de6795e;hpb=d9c17594ab3be0b866c555750cdbd1ad6a1b34e6;p=dbsrgits%2FDBIx-Class.git diff --git a/t/lib/DBICTest.pm b/t/lib/DBICTest.pm index 7ce9410..49df060 100644 --- a/t/lib/DBICTest.pm +++ b/t/lib/DBICTest.pm @@ -1,29 +1,55 @@ -package # hide from PAUSE +package # hide from PAUSE DBICTest; use strict; use warnings; -use DBICTest::AuthorCheck; -use DBICTest::Schema; + +use DBICTest::Util 'local_umask'; +use DBICTest::RunMode; +use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/; 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; use Test::More; - + my $schema = DBICTest->init_schema(); =head1 DESCRIPTION -This module provides the basic utilities to write tests against +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 @@ -37,29 +63,109 @@ DBIx::Class. }, ); -This method removes the test SQLite database in t/var/DBIxClass.db +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') { + flock ($global_lock_fh, LOCK_EX) or die "Unable to lock $lockpath: $!"; + $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) { + flock ($global_lock_fh, LOCK_SH) or die "Unable to lock $lockpath: $!"; + } +} + +END { + if ($global_lock_fh) { + # delay destruction even more + } +} + +{ + my $dir = Path::Class::File->new(__FILE__)->dir->parent->subdir('var'); + $dir->mkpath unless -d "$dir"; + $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 }; + +sub _cleanup_dbfile { + # cleanup if this is us + if ( + ! $ENV{DBICTEST_LOCK_HOLDER} + or + $ENV{DBICTEST_LOCK_HOLDER} == -1 + or + $ENV{DBICTEST_LOCK_HOLDER} == $$ + ) { + my $db_file = _sqlite_dbfilename(); + unlink $_ for ($db_file, "${db_file}-journal"); + } } -sub _sqlite_dbfilename { - return "t/var/DBIxClass.db"; +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:"; } @@ -78,24 +184,32 @@ sub _database { for ($db_file, "${db_file}-journal") { next unless -e $_; unlink ($_) or carp ( - "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!\n" + "Unable to unlink existing test database file $_ ($!), creation of fresh database / further tests may fail!" ); } - mkdir("t/var") unless -d "t/var"; - return ("dbi:SQLite:${db_file}", '', '', { AutoCommit => 1, # 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) @@ -112,8 +226,16 @@ sub _database { } sub __mk_disconnect_guard { + 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; @@ -153,10 +275,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 + ; } } @@ -178,12 +306,16 @@ sub __mk_disconnect_guard { }; } +my $weak_registry = {}; + sub init_schema { my $self = shift; my %args = @_; my $schema; + require DBICTest::Schema; + if ($args{compose_connection}) { $schema = DBICTest::Schema->compose_connection( 'DBICTest', $self->_database(%args) @@ -205,17 +337,29 @@ sub init_schema { __PACKAGE__->populate_schema( $schema ) if( !$args{no_populate} ); } + + populate_weakregistry ( $weak_registry, $schema->storage ) + if $INC{'Test/Builder.pm'} and $schema->storage; + return $schema; } +END { + # Make sure we run after any cleanup in other END blocks + require B; + push @{ B::end_av()->object_2svref }, sub { + assert_empty_weakregistry($weak_registry, 'quiet'); + }; +} + =head2 deploy_schema DBICTest->deploy_schema( $schema ); -This method does one of two things to the schema. It can either call -the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment -variable is set, otherwise the default is to read in the t/lib/sqlite.sql -file and execute the SQL within. Either way you end up with a fresh set +This method does one of two things to the schema. It can either call +the experimental $schema->deploy() if the DBICTEST_SQLT_DEPLOY environment +variable is set, otherwise the default is to read in the t/lib/sqlite.sql +file and execute the SQL within. Either way you end up with a fresh set of tables for testing. =cut @@ -225,13 +369,15 @@ sub deploy_schema { my $schema = shift; my $args = shift || {}; - if ($ENV{"DBICTEST_SQLT_DEPLOY"}) { + local $schema->storage->{debug} + if ($ENV{TRAVIS}||'') eq 'true'; + + if ($ENV{"DBICTEST_SQLT_DEPLOY"}) { $schema->deploy($args); } else { - open IN, "t/lib/sqlite.sql"; - my $sql; - { local $/ = undef; $sql = ; } - close IN; + my $filename = Path::Class::File->new(__FILE__)->dir + ->file('sqlite.sql')->stringify; + my $sql = do { local (@ARGV, $/) = $filename ; <> }; 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"; @@ -245,7 +391,7 @@ sub deploy_schema { DBICTest->populate_schema( $schema ); -After you deploy your schema you can use this method to populate +After you deploy your schema you can use this method to populate the tables with test data. =cut @@ -254,6 +400,9 @@ sub populate_schema { my $self = shift; my $schema = shift; + local $schema->storage->{debug} + if ($ENV{TRAVIS}||'') eq 'true'; + $schema->populate('Genre', [ [qw/genreid name/], [qw/1 emo /], @@ -344,7 +493,7 @@ sub populate_schema { [ 1, 2 ], [ 1, 3 ], ]); - + $schema->populate('TreeLike', [ [ qw/id parent name/ ], [ 1, undef, 'root' ], @@ -395,7 +544,7 @@ sub populate_schema { [ 1, "Tools" ], [ 2, "Body Parts" ], ]); - + $schema->populate('TypedObject', [ [ qw/objectid type value/ ], [ 1, "pointy", "Awl" ], @@ -427,4 +576,10 @@ sub populate_schema { ]); } +sub connect_schema { + my $self = shift; + require DBICTest::Schema; + return DBICTest::Schema->connect(@_); +} + 1;