use strict;
use warnings;
-use DBICTest::RunMode;
+
+use DBICTest::Util 'local_umask';
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;
=head1 NAME
-DBICTest - Library to be used by DBIx::Class test scripts.
+DBICTest - Library to be used by DBIx::Class test scripts
=head1 SYNOPSIS
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<use SQL::Abstract::Test
+qw(L<is_same_sql_bind|SQL::Abstract::Test/is_same_sql_bind>
+L<is_same_sql|SQL::Abstract::Test/is_same_sql>
+L<is_same_bind|SQL::Abstract::Test/is_same_bind>)>
+
+=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<DBICTest> 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
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<deploy_schema()|/deploy_schema> by default, unless the
+C<no_deploy> 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<populate_schema()|/populate_schema>
+by default, unless the C<no_deploy> or C<no_populate> flags are set.
=cut
-sub has_custom_dsn {
- return $ENV{"DBICTEST_DSN"} ? 1:0;
+# see L</:GlobalLock>
+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
+ }
}
-sub _sqlite_dbfilename {
+{
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 };
+
+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 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:";
}
# 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)
$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') },
};
}
},
}
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;
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
+ ;
}
}
}
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
my $schema = shift;
my $args = shift || {};
+ local $schema->storage->{debug}
+ if ($ENV{TRAVIS}||'') eq 'true';
+
if ($ENV{"DBICTEST_SQLT_DEPLOY"}) {
$schema->deploy($args);
} else {
my $self = shift;
my $schema = shift;
+ local $schema->storage->{debug}
+ if ($ENV{TRAVIS}||'') eq 'true';
+
$schema->populate('Genre', [
[qw/genreid name/],
[qw/1 emo /],