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
-# This results in an overall much smoother job-queue drainage, since
-# the Harness blocks less
-# (ideally this needs to be addressed in T::H, but a quick patchjob
-# broke everything so tabling it for now)
-BEGIN {
- if ($INC{'Test/Builder.pm'}) {
- local $| = 1;
- print "#\n";
- }
-}
-
-use Module::Runtime 'module_notional_filename';
-BEGIN {
- for my $mod (qw( DBIC::SqlMakerTest SQL::Abstract )) {
- if ( $INC{ module_notional_filename($mod) } ) {
- # FIXME this does not seem to work in BEGIN - why?!
- #require Carp;
- #$Carp::Internal{ (__PACKAGE__) }++;
- #Carp::croak( __PACKAGE__ . " must be loaded before $mod" );
-
- my ($fr, @frame) = 1;
- while (@frame = caller($fr++)) {
- last if $frame[1] !~ m|^t/lib/DBICTest|;
- }
-
- die __PACKAGE__ . " must be loaded before $mod (or modules using $mod) at $frame[1] line $frame[2]\n";
- }
- }
-}
-
-use DBICTest::RunMode;
+use DBICTest::Util qw( local_umask dbg DEBUG_TEST_CONCURRENCY_LOCKS );
use DBICTest::Schema;
use DBICTest::Util::LeakTracer qw/populate_weakregistry assert_empty_weakregistry/;
-use DBICTest::Util 'local_umask';
+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
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
-# 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</:GlobalLock>
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 = DBICTest::RunMode->tmpdir->file('_dbictest_global.lock');
{
my $u = local_umask(0); # so that the file opens as 666, and any user can lock
or die "Unable to open $lockpath: $!";
}
- for (@_) {
- if ($_ eq ':GlobalLock') {
+ 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 $_ requested from $self";
+ 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";
}
}
END {
+ # referencing here delays destruction even more
if ($global_lock_fh) {
- # delay destruction even more
+ DEBUG_TEST_CONCURRENCY_LOCKS > 1
+ and dbg "Release @{[ $global_exclusive_lock ? 'EXCLUSIVE' : 'SHARED' ]} global lock (END)";
+ 1;
}
}
$SIG{INT} = sub { _cleanup_dbfile(); exit 1 };
+my $need_global_cleanup;
sub _cleanup_dbfile {
# cleanup if this is us
if (
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");
}
# 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') },
};
}
},
}
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 $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');
}
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} ) {
}
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';
+ 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);
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->new(sub { $schema->storage->debug($old_dbg) });
+ $schema->storage->debug(0);
+ }
$schema->populate('Genre', [
[qw/genreid name/],