[dbsrgits/DBIx-Class.git] / t / 93storage_replication.t

use strict;
use warnings;
use lib qw(t/lib);
use Test::More;
use Test::Exception;
use DBICTest;
use List::Util 'first';

BEGIN {
    eval "use DBIx::Class::Storage::DBI::Replicated; use Test::Moose";
    plan $@
        ? ( skip_all => "Deps not installed: $@" )
        : ( tests => 79 );
}

use_ok 'DBIx::Class::Storage::DBI::Replicated::Pool';
use_ok 'DBIx::Class::Storage::DBI::Replicated::Balancer';
use_ok 'DBIx::Class::Storage::DBI::Replicated::Replicant';
use_ok 'DBIx::Class::Storage::DBI::Replicated';

=head1 HOW TO USE

    This is a test of the replicated storage system.  This will work in one of
    two ways, either it was try to fake replication with a couple of SQLite DBs
    and creative use of copy, or if you define a couple of %ENV vars correctly
    will try to test those.  If you do that, it will assume the setup is properly
    replicating.  Your results may vary, but I have demonstrated this to work with
    mysql native replication.
    
=cut


## ----------------------------------------------------------------------------
## Build a class to hold all our required testing data and methods.
## ----------------------------------------------------------------------------

TESTSCHEMACLASSES: {

    ## --------------------------------------------------------------------- ##
    ## Create an object to contain your replicated stuff.
    ## --------------------------------------------------------------------- ##
    
    package DBIx::Class::DBI::Replicated::TestReplication;
   
    use DBICTest;
    use base qw/Class::Accessor::Fast/;
    
    __PACKAGE__->mk_accessors( qw/schema/ );

    ## Initialize the object
    
	sub new {
	    my $class = shift @_;
	    my $self = $class->SUPER::new(@_);
	
	    $self->schema( $self->init_schema );
	    return $self;
	}
    
    ## Get the Schema and set the replication storage type
    
    sub init_schema {
        # current SQLT SQLite producer does not handle DROP TABLE IF EXISTS, trap warnings here
        local $SIG{__WARN__} = sub { warn @_ unless $_[0] =~ /no such table.+DROP TABLE/ };

        my $class = shift @_;

        my $schema = DBICTest->init_schema(
            sqlite_use_file => 1,
            storage_type=>{
            	'::DBI::Replicated' => {
            		balancer_type=>'::Random',
                    balancer_args=>{
                    	auto_validate_every=>100,
                    },
            	}
            },
            deploy_args=>{
                   add_drop_table => 1,
            },
        );

        return $schema;
    }
    
    sub generate_replicant_connect_info {}
    sub replicate {}
    sub cleanup {}

  
    ## --------------------------------------------------------------------- ##
    ## Subclass for when you are using SQLite for testing, this provides a fake
    ## replication support.
    ## --------------------------------------------------------------------- ##
        
    package DBIx::Class::DBI::Replicated::TestReplication::SQLite;

    use DBICTest;
    use File::Copy;    
    use base 'DBIx::Class::DBI::Replicated::TestReplication';
    
    __PACKAGE__->mk_accessors( qw/master_path slave_paths/ );
    
    ## Set the mastep path from DBICTest
    
	sub new {
	    my $class = shift @_;
	    my $self = $class->SUPER::new(@_);
	
	    $self->master_path( DBICTest->_sqlite_dbfilename );
	    $self->slave_paths([
            "t/var/DBIxClass_slave1.db",
            "t/var/DBIxClass_slave2.db",    
        ]);
        
	    return $self;
	}    
	
    ## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
    ## $storage->connect_info to be used for connecting replicants.
    
    sub generate_replicant_connect_info {
        my $self = shift @_;
        my @dsn = map {
            "dbi:SQLite:${_}";
        } @{$self->slave_paths};
        
        my @connect_infos = map { [$_,'','',{AutoCommit=>1}] } @dsn;

    # try a hashref too
        my $c = $connect_infos[0];
        $connect_infos[0] = {
          dsn => $c->[0],
          user => $c->[1],
          password => $c->[2],
          %{ $c->[3] }
        };

        @connect_infos
    }

    ## Do a 'good enough' replication by copying the master dbfile over each of
    ## the slave dbfiles.  If the master is SQLite we do this, otherwise we
    ## just do a one second pause to let the slaves catch up.
    
    sub replicate {
        my $self = shift @_;
        foreach my $slave (@{$self->slave_paths}) {
            copy($self->master_path, $slave);
        }
    }
    
    ## Cleanup after ourselves.  Unlink all gthe slave paths.
    
    sub cleanup {
        my $self = shift @_;
        foreach my $slave (@{$self->slave_paths}) {
            unlink $slave;
        }     
    }
    
    ## --------------------------------------------------------------------- ##
    ## Subclass for when you are setting the databases via custom export vars
    ## This is for when you have a replicating database setup that you are
    ## going to test against.  You'll need to define the correct $ENV and have
    ## two slave databases to test against, as well as a replication system
    ## that will replicate in less than 1 second.
    ## --------------------------------------------------------------------- ##
        
    package DBIx::Class::DBI::Replicated::TestReplication::Custom; 
    use base 'DBIx::Class::DBI::Replicated::TestReplication';
    
    ## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
    ## $storage->connect_info to be used for connecting replicants.
    
    sub generate_replicant_connect_info { 
        return (
            [$ENV{"DBICTEST_SLAVE0_DSN"}, $ENV{"DBICTEST_SLAVE0_DBUSER"}, $ENV{"DBICTEST_SLAVE0_DBPASS"}, {AutoCommit => 1}],
            [$ENV{"DBICTEST_SLAVE1_DSN"}, $ENV{"DBICTEST_SLAVE1_DBUSER"}, $ENV{"DBICTEST_SLAVE1_DBPASS"}, {AutoCommit => 1}],           
        );
    }
    
    ## pause a bit to let the replication catch up 
    
    sub replicate {
    	sleep 1;
    } 
}

## ----------------------------------------------------------------------------
## Create an object and run some tests
## ----------------------------------------------------------------------------

## Thi first bunch of tests are basic, just make sure all the bits are behaving

my $replicated_class = DBICTest->has_custom_dsn ?
    'DBIx::Class::DBI::Replicated::TestReplication::Custom' :
    'DBIx::Class::DBI::Replicated::TestReplication::SQLite';

ok my $replicated = $replicated_class->new
    => 'Created a replication object';
    
isa_ok $replicated->schema
    => 'DBIx::Class::Schema';
    
isa_ok $replicated->schema->storage
    => 'DBIx::Class::Storage::DBI::Replicated';

ok $replicated->schema->storage->meta
    => 'has a meta object';
    
isa_ok $replicated->schema->storage->master
    => 'DBIx::Class::Storage::DBI';
    
isa_ok $replicated->schema->storage->pool
    => 'DBIx::Class::Storage::DBI::Replicated::Pool';
    
does_ok $replicated->schema->storage->balancer
    => 'DBIx::Class::Storage::DBI::Replicated::Balancer'; 

ok my @replicant_connects = $replicated->generate_replicant_connect_info
    => 'got replication connect information';

ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
    => 'Created some storages suitable for replicants';
 
my @replicant_names = keys %{ $replicated->schema->storage->replicants };

## Silence warning about not supporting the is_replicating method if using the
## sqlite dbs.
$replicated->schema->storage->debugobj->silence(1)
  if first { m{^t/} } @replicant_names;
   
isa_ok $replicated->schema->storage->balancer->current_replicant
    => 'DBIx::Class::Storage::DBI'; 

$replicated->schema->storage->debugobj->silence(0);

ok $replicated->schema->storage->pool->has_replicants
    => 'does have replicants';     

is $replicated->schema->storage->pool->num_replicants => 2
    => 'has two replicants';
       
does_ok $replicated_storages[0]
    => 'DBIx::Class::Storage::DBI::Replicated::Replicant';

does_ok $replicated_storages[1]
    => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
    
does_ok $replicated->schema->storage->replicants->{$replicant_names[0]}
    => 'DBIx::Class::Storage::DBI::Replicated::Replicant';

does_ok $replicated->schema->storage->replicants->{$replicant_names[1]}
    => 'DBIx::Class::Storage::DBI::Replicated::Replicant';  

## Add some info to the database

$replicated
    ->schema
    ->populate('Artist', [
        [ qw/artistid name/ ],
        [ 4, "Ozric Tentacles"],
    ]);
                
## Make sure all the slaves have the table definitions

$replicated->replicate;
$replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
$replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);

## Silence warning about not supporting the is_replicating method if using the
## sqlite dbs.
$replicated->schema->storage->debugobj->silence(1)
  if first { m{^t/} } @replicant_names;
 
$replicated->schema->storage->pool->validate_replicants;

$replicated->schema->storage->debugobj->silence(0);

## Make sure we can read the data.

ok my $artist1 = $replicated->schema->resultset('Artist')->find(4)
    => 'Created Result';

isa_ok $artist1
    => 'DBICTest::Artist';
    
is $artist1->name, 'Ozric Tentacles'
    => 'Found expected name for first result';

## Add some new rows that only the master will have  This is because
## we overload any type of write operation so that is must hit the master
## database.

$replicated
    ->schema
    ->populate('Artist', [
        [ qw/artistid name/ ],
        [ 5, "Doom's Children"],
        [ 6, "Dead On Arrival"],
        [ 7, "Watergate"],
    ]);

## Make sure all the slaves have the table definitions
$replicated->replicate;

## Should find some data now

ok my $artist2 = $replicated->schema->resultset('Artist')->find(5)
    => 'Sync succeed';
    
isa_ok $artist2
    => 'DBICTest::Artist';
    
is $artist2->name, "Doom's Children"
    => 'Found expected name for first result';

## What happens when we disconnect all the replicants?

is $replicated->schema->storage->pool->connected_replicants => 2
    => "both replicants are connected";
    
$replicated->schema->storage->replicants->{$replicant_names[0]}->disconnect;
$replicated->schema->storage->replicants->{$replicant_names[1]}->disconnect;

is $replicated->schema->storage->pool->connected_replicants => 0
    => "both replicants are now disconnected";

## All these should pass, since the database should automatically reconnect

ok my $artist3 = $replicated->schema->resultset('Artist')->find(6)
    => 'Still finding stuff.';
    
isa_ok $artist3
    => 'DBICTest::Artist';
    
is $artist3->name, "Dead On Arrival"
    => 'Found expected name for first result';

is $replicated->schema->storage->pool->connected_replicants => 1
    => "At Least One replicant reconnected to handle the job";
    
## What happens when we try to select something that doesn't exist?

ok ! $replicated->schema->resultset('Artist')->find(666)
    => 'Correctly failed to find something.';
    
## test the reliable option

TESTRELIABLE: {
	
	$replicated->schema->storage->set_reliable_storage;
	
	ok $replicated->schema->resultset('Artist')->find(2)
	    => 'Read from master 1';
	
	ok $replicated->schema->resultset('Artist')->find(5)
	    => 'Read from master 2';
	    
    $replicated->schema->storage->set_balanced_storage;	    
	    
	ok $replicated->schema->resultset('Artist')->find(3)
        => 'Read from replicant';
}

## Make sure when reliable goes out of scope, we are using replicants again

ok $replicated->schema->resultset('Artist')->find(1)
    => 'back to replicant 1.';
    
ok $replicated->schema->resultset('Artist')->find(2)
    => 'back to replicant 2.';

## set all the replicants to inactive, and make sure the balancer falls back to
## the master.

$replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
$replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);

## Silence warning about falling back to master.
$replicated->schema->storage->debugobj->silence(1);
 
ok $replicated->schema->resultset('Artist')->find(2)
    => 'Fallback to master';

$replicated->schema->storage->debugobj->silence(0);

$replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
$replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);

## Silence warning about not supporting the is_replicating method if using the
## sqlite dbs.
$replicated->schema->storage->debugobj->silence(1)
  if first { m{^t/} } @replicant_names;
 
$replicated->schema->storage->pool->validate_replicants;

$replicated->schema->storage->debugobj->silence(0);

ok $replicated->schema->resultset('Artist')->find(2)
    => 'Returned to replicates';
    
## Getting slave status tests

SKIP: {
    ## We skip this tests unless you have a custom replicants, since the default
    ## sqlite based replication tests don't support these functions.
    
    skip 'Cannot Test Replicant Status on Non Replicating Database', 9
     unless DBICTest->has_custom_dsn && $ENV{"DBICTEST_SLAVE0_DSN"};

    $replicated->replicate; ## Give the slaves a chance to catchup.

	ok $replicated->schema->storage->replicants->{$replicant_names[0]}->is_replicating
	    => 'Replicants are replicating';
	    
	is $replicated->schema->storage->replicants->{$replicant_names[0]}->lag_behind_master, 0
	    => 'Replicant is zero seconds behind master';
	    
	## Test the validate replicants
	
	$replicated->schema->storage->pool->validate_replicants;
	
	is $replicated->schema->storage->pool->active_replicants, 2
	    => 'Still have 2 replicants after validation';
	    
	## Force the replicants to fail the validate test by required their lag to
	## be negative (ie ahead of the master!)
	
    $replicated->schema->storage->pool->maximum_lag(-10);
    $replicated->schema->storage->pool->validate_replicants;
    
    is $replicated->schema->storage->pool->active_replicants, 0
        => 'No way a replicant be be ahead of the master';
        
    ## Let's be fair to the replicants again.  Let them lag up to 5
	
    $replicated->schema->storage->pool->maximum_lag(5);
    $replicated->schema->storage->pool->validate_replicants;
    
    is $replicated->schema->storage->pool->active_replicants, 2
        => 'Both replicants in good standing again';	
        
	## Check auto validate
	
	is $replicated->schema->storage->balancer->auto_validate_every, 100
	    => "Got the expected value for auto validate";
	    
		## This will make sure we auto validatge everytime
		$replicated->schema->storage->balancer->auto_validate_every(0);
		
		## set all the replicants to inactive, and make sure the balancer falls back to
		## the master.
		
		$replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
		$replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
		
		## Ok, now when we go to run a query, autovalidate SHOULD reconnect
	
	is $replicated->schema->storage->pool->active_replicants => 0
	    => "both replicants turned off";
	    	
	ok $replicated->schema->resultset('Artist')->find(5)
	    => 'replicant reactivated';
	    
	is $replicated->schema->storage->pool->active_replicants => 2
	    => "both replicants reactivated";        
}

## Test the reliably callback

ok my $reliably = sub {
	
    ok $replicated->schema->resultset('Artist')->find(5)
        => 'replicant reactivated';	
	
} => 'created coderef properly';

$replicated->schema->storage->execute_reliably($reliably);

## Try something with an error

ok my $unreliably = sub {
    
    ok $replicated->schema->resultset('ArtistXX')->find(5)
        => 'replicant reactivated'; 
    
} => 'created coderef properly';

throws_ok {$replicated->schema->storage->execute_reliably($unreliably)} 
    qr/Can't find source for ArtistXX/
    => 'Bad coderef throws proper error';
    
## Make sure replication came back

ok $replicated->schema->resultset('Artist')->find(3)
    => 'replicant reactivated';
    
## make sure transactions are set to execute_reliably

ok my $transaction = sub {
	
	my $id = shift @_;
	
	$replicated
	    ->schema
	    ->populate('Artist', [
	        [ qw/artistid name/ ],
	        [ $id, "Children of the Grave"],
	    ]);
	    
    ok my $result = $replicated->schema->resultset('Artist')->find($id)
        => 'Found expected artist';
        
    ok my $more = $replicated->schema->resultset('Artist')->find(1)
        => 'Found expected artist again';
        
   return ($result, $more);
   
} => 'Created a coderef properly';

## Test the transaction with multi return
{
	ok my @return = $replicated->schema->txn_do($transaction, 666)
	    => 'did transaction';
	    
	    is $return[0]->id, 666
	        => 'first returned value is correct';
	        
	    is $return[1]->id, 1
	        => 'second returned value is correct';
}

## Test that asking for single return works
{
	ok my $return = $replicated->schema->txn_do($transaction, 777)
	    => 'did transaction';
	    
	    is $return->id, 777
	        => 'first returned value is correct';
}

## Test transaction returning a single value

{
	ok my $result = $replicated->schema->txn_do(sub {
		ok my $more = $replicated->schema->resultset('Artist')->find(1)
		=> 'found inside a transaction';
		return $more;
	}) => 'successfully processed transaction';
	
	is $result->id, 1
	   => 'Got expected single result from transaction';
}

## Make sure replication came back

ok $replicated->schema->resultset('Artist')->find(1)
    => 'replicant reactivated';
    
## Test Discard changes

{
	ok my $artist = $replicated->schema->resultset('Artist')->find(2)
	    => 'got an artist to test discard changes';
	    
	ok $artist->discard_changes
	   => 'properly discard changes';
}

## Test some edge cases, like trying to do a transaction inside a transaction, etc

{
    ok my $result = $replicated->schema->txn_do(sub {
    	return $replicated->schema->txn_do(sub {
	        ok my $more = $replicated->schema->resultset('Artist')->find(1)
	        => 'found inside a transaction inside a transaction';
	        return $more;    		
    	});
    }) => 'successfully processed transaction';
    
    is $result->id, 1
       => 'Got expected single result from transaction';	  
}

{
    ok my $result = $replicated->schema->txn_do(sub {
    	return $replicated->schema->storage->execute_reliably(sub {
	    	return $replicated->schema->txn_do(sub {
	    		return $replicated->schema->storage->execute_reliably(sub {
			        ok my $more = $replicated->schema->resultset('Artist')->find(1)
			        => 'found inside crazy deep transactions and execute_reliably';
			        return $more; 	    			
	    		});
	    	});    	
    	});
    }) => 'successfully processed transaction';
    
    is $result->id, 1
       => 'Got expected single result from transaction';	  
}     

## Test the force_pool resultset attribute.

{
	ok my $artist_rs = $replicated->schema->resultset('Artist')
        => 'got artist resultset';
	   
	## Turn on Forced Pool Storage
	ok my $reliable_artist_rs = $artist_rs->search(undef, {force_pool=>'master'})
        => 'Created a resultset using force_pool storage';
	   
    ok my $artist = $reliable_artist_rs->find(2) 
        => 'got an artist result via force_pool storage';
}

## Delete the old database files
$replicated->cleanup;
Commit	Line	Data
e4dc89b3	1	use strict;
	2	use warnings;
	3	use lib qw(t/lib);
e4dc89b3	4	use Test::More;
c4d3fae2	5	use Test::Exception;
857d66ca	6	use DBICTest;
9901aad7	7	use List::Util 'first';
8f7986d6	8
86583fa7	9	BEGIN {
650c0574	10	eval "use DBIx::Class::Storage::DBI::Replicated; use Test::Moose";
86583fa7	11	plan $@
467799e8	12	? ( skip_all => "Deps not installed: $@" )
c354902c	13	: ( tests => 79 );
26ab719a	14	}
	15
	16	use_ok 'DBIx::Class::Storage::DBI::Replicated::Pool';
	17	use_ok 'DBIx::Class::Storage::DBI::Replicated::Balancer';
	18	use_ok 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	19	use_ok 'DBIx::Class::Storage::DBI::Replicated';
0f83441a	20
89cf6a70	21	=head1 HOW TO USE
	22
	23	This is a test of the replicated storage system. This will work in one of
	24	two ways, either it was try to fake replication with a couple of SQLite DBs
	25	and creative use of copy, or if you define a couple of %ENV vars correctly
	26	will try to test those. If you do that, it will assume the setup is properly
	27	replicating. Your results may vary, but I have demonstrated this to work with
	28	mysql native replication.
	29
	30	=cut
	31
	32
0f83441a	33	## ----------------------------------------------------------------------------
	34	## Build a class to hold all our required testing data and methods.
	35	## ----------------------------------------------------------------------------
	36
857d66ca	37	TESTSCHEMACLASSES: {
2bf79155	38
857d66ca	39	## --------------------------------------------------------------------- ##
	40	## Create an object to contain your replicated stuff.
	41	## --------------------------------------------------------------------- ##
	42
2bf79155	43	package DBIx::Class::DBI::Replicated::TestReplication;
	44
	45	use DBICTest;
	46	use base qw/Class::Accessor::Fast/;
	47
857d66ca	48	__PACKAGE__->mk_accessors( qw/schema/ );
2bf79155	49
	50	## Initialize the object
	51
	52	sub new {
26ab719a	53	my $class = shift @_;
26ab719a	54	my $self = $class->SUPER::new(@_);
2bf79155	55
2bf79155	56	$self->schema( $self->init_schema );
2bf79155	57	return $self;
	58	}
	59
26ab719a	60	## Get the Schema and set the replication storage type
2bf79155	61
2bf79155	62	sub init_schema {
f6ace689	63	# current SQLT SQLite producer does not handle DROP TABLE IF EXISTS, trap warnings here
	64	local $SIG{__WARN__} = sub { warn @_ unless $_[0] =~ /no such table.+DROP TABLE/ };
	65
2bf79155	66	my $class = shift @_;
f6ace689	67
cb6ec758	68	my $schema = DBICTest->init_schema(
bcb3e850	69	sqlite_use_file => 1,
161fb223	70	storage_type=>{
106d5f3b	71	'::DBI::Replicated' => {
106d5f3b	72	balancer_type=>'::Random',
17b05c13	73	balancer_args=>{
	74	auto_validate_every=>100,
	75	},
89cf6a70	76	}
161fb223	77	},
89cf6a70	78	deploy_args=>{
	79	add_drop_table => 1,
	80	},
	81	);
cb6ec758	82
2bf79155	83	return $schema;
2bf79155	84	}
26ab719a	85
857d66ca	86	sub generate_replicant_connect_info {}
	87	sub replicate {}
	88	sub cleanup {}
	89
	90
	91	## --------------------------------------------------------------------- ##
	92	## Subclass for when you are using SQLite for testing, this provides a fake
	93	## replication support.
	94	## --------------------------------------------------------------------- ##
	95
	96	package DBIx::Class::DBI::Replicated::TestReplication::SQLite;
	97
	98	use DBICTest;
	99	use File::Copy;
	100	use base 'DBIx::Class::DBI::Replicated::TestReplication';
	101
	102	__PACKAGE__->mk_accessors( qw/master_path slave_paths/ );
	103
	104	## Set the mastep path from DBICTest
	105
	106	sub new {
	107	my $class = shift @_;
	108	my $self = $class->SUPER::new(@_);
	109
	110	$self->master_path( DBICTest->_sqlite_dbfilename );
	111	$self->slave_paths([
	112	"t/var/DBIxClass_slave1.db",
	113	"t/var/DBIxClass_slave2.db",
	114	]);
	115
	116	return $self;
	117	}
	118
26ab719a	119	## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
	120	## $storage->connect_info to be used for connecting replicants.
	121
	122	sub generate_replicant_connect_info {
857d66ca	123	my $self = shift @_;
26ab719a	124	my @dsn = map {
	125	"dbi:SQLite:${_}";
	126	} @{$self->slave_paths};
	127
9901aad7	128	my @connect_infos = map { [$_,'','',{AutoCommit=>1}] } @dsn;
	129
	130	# try a hashref too
	131	my $c = $connect_infos[0];
	132	$connect_infos[0] = {
	133	dsn => $c->[0],
	134	user => $c->[1],
	135	password => $c->[2],
	136	%{ $c->[3] }
	137	};
	138
	139	@connect_infos
26ab719a	140	}
9901aad7	141
26ab719a	142	## Do a 'good enough' replication by copying the master dbfile over each of
50336325	143	## the slave dbfiles. If the master is SQLite we do this, otherwise we
50336325	144	## just do a one second pause to let the slaves catch up.
26ab719a	145
	146	sub replicate {
	147	my $self = shift @_;
	148	foreach my $slave (@{$self->slave_paths}) {
	149	copy($self->master_path, $slave);
	150	}
	151	}
	152
	153	## Cleanup after ourselves. Unlink all gthe slave paths.
	154
	155	sub cleanup {
	156	my $self = shift @_;
	157	foreach my $slave (@{$self->slave_paths}) {
	158	unlink $slave;
	159	}
	160	}
857d66ca	161
	162	## --------------------------------------------------------------------- ##
	163	## Subclass for when you are setting the databases via custom export vars
	164	## This is for when you have a replicating database setup that you are
	165	## going to test against. You'll need to define the correct $ENV and have
	166	## two slave databases to test against, as well as a replication system
	167	## that will replicate in less than 1 second.
	168	## --------------------------------------------------------------------- ##
	169
	170	package DBIx::Class::DBI::Replicated::TestReplication::Custom;
	171	use base 'DBIx::Class::DBI::Replicated::TestReplication';
	172
	173	## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
	174	## $storage->connect_info to be used for connecting replicants.
	175
	176	sub generate_replicant_connect_info {
	177	return (
	178	[$ENV{"DBICTEST_SLAVE0_DSN"}, $ENV{"DBICTEST_SLAVE0_DBUSER"}, $ENV{"DBICTEST_SLAVE0_DBPASS"}, {AutoCommit => 1}],
	179	[$ENV{"DBICTEST_SLAVE1_DSN"}, $ENV{"DBICTEST_SLAVE1_DBUSER"}, $ENV{"DBICTEST_SLAVE1_DBPASS"}, {AutoCommit => 1}],
	180	);
	181	}
	182
	183	## pause a bit to let the replication catch up
	184
	185	sub replicate {
	186	sleep 1;
	187	}
2bf79155	188	}
	189
	190	## ----------------------------------------------------------------------------
	191	## Create an object and run some tests
	192	## ----------------------------------------------------------------------------
	193
26ab719a	194	## Thi first bunch of tests are basic, just make sure all the bits are behaving
2bf79155	195
857d66ca	196	my $replicated_class = DBICTest->has_custom_dsn ?
	197	'DBIx::Class::DBI::Replicated::TestReplication::Custom' :
	198	'DBIx::Class::DBI::Replicated::TestReplication::SQLite';
	199
	200	ok my $replicated = $replicated_class->new
	201	=> 'Created a replication object';
2bf79155	202
26ab719a	203	isa_ok $replicated->schema
2bf79155	204	=> 'DBIx::Class::Schema';
2bf79155	205
26ab719a	206	isa_ok $replicated->schema->storage
	207	=> 'DBIx::Class::Storage::DBI::Replicated';
	208
	209	ok $replicated->schema->storage->meta
	210	=> 'has a meta object';
	211
	212	isa_ok $replicated->schema->storage->master
	213	=> 'DBIx::Class::Storage::DBI';
	214
	215	isa_ok $replicated->schema->storage->pool
	216	=> 'DBIx::Class::Storage::DBI::Replicated::Pool';
	217
17b05c13	218	does_ok $replicated->schema->storage->balancer
26ab719a	219	=> 'DBIx::Class::Storage::DBI::Replicated::Balancer';
	220
	221	ok my @replicant_connects = $replicated->generate_replicant_connect_info
	222	=> 'got replication connect information';
	223
955a6df6	224	ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
26ab719a	225	=> 'Created some storages suitable for replicants';
9901aad7	226
	227	my @replicant_names = keys %{ $replicated->schema->storage->replicants };
	228
	229	## Silence warning about not supporting the is_replicating method if using the
	230	## sqlite dbs.
	231	$replicated->schema->storage->debugobj->silence(1)
	232	if first { m{^t/} } @replicant_names;
	233
cb6ec758	234	isa_ok $replicated->schema->storage->balancer->current_replicant
9901aad7	235	=> 'DBIx::Class::Storage::DBI';
	236
	237	$replicated->schema->storage->debugobj->silence(0);
	238
26ab719a	239	ok $replicated->schema->storage->pool->has_replicants
	240	=> 'does have replicants';
	241
17b05c13	242	is $replicated->schema->storage->pool->num_replicants => 2
26ab719a	243	=> 'has two replicants';
26ab719a	244
de5dc9ef	245	does_ok $replicated_storages[0]
26ab719a	246	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
26ab719a	247
de5dc9ef	248	does_ok $replicated_storages[1]
26ab719a	249	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
26ab719a	250
de5dc9ef	251	does_ok $replicated->schema->storage->replicants->{$replicant_names[0]}
26ab719a	252	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
26ab719a	253
de5dc9ef	254	does_ok $replicated->schema->storage->replicants->{$replicant_names[1]}
26ab719a	255	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	256
	257	## Add some info to the database
	258
	259	$replicated
	260	->schema
	261	->populate('Artist', [
	262	[ qw/artistid name/ ],
	263	[ 4, "Ozric Tentacles"],
	264	]);
	265
	266	## Make sure all the slaves have the table definitions
	267
	268	$replicated->replicate;
5c1d82d2	269	$replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
5c1d82d2	270	$replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
9901aad7	271
	272	## Silence warning about not supporting the is_replicating method if using the
	273	## sqlite dbs.
	274	$replicated->schema->storage->debugobj->silence(1)
	275	if first { m{^t/} } @replicant_names;
	276
f15afa13	277	$replicated->schema->storage->pool->validate_replicants;
26ab719a	278
9901aad7	279	$replicated->schema->storage->debugobj->silence(0);
9901aad7	280
26ab719a	281	## Make sure we can read the data.
	282
	283	ok my $artist1 = $replicated->schema->resultset('Artist')->find(4)
	284	=> 'Created Result';
	285
	286	isa_ok $artist1
	287	=> 'DBICTest::Artist';
	288
	289	is $artist1->name, 'Ozric Tentacles'
	290	=> 'Found expected name for first result';
	291
	292	## Add some new rows that only the master will have This is because
	293	## we overload any type of write operation so that is must hit the master
	294	## database.
	295
	296	$replicated
	297	->schema
	298	->populate('Artist', [
	299	[ qw/artistid name/ ],
	300	[ 5, "Doom's Children"],
	301	[ 6, "Dead On Arrival"],
	302	[ 7, "Watergate"],
	303	]);
	304
26ab719a	305	## Make sure all the slaves have the table definitions
	306	$replicated->replicate;
	307
	308	## Should find some data now
	309
	310	ok my $artist2 = $replicated->schema->resultset('Artist')->find(5)
	311	=> 'Sync succeed';
	312
	313	isa_ok $artist2
	314	=> 'DBICTest::Artist';
	315
	316	is $artist2->name, "Doom's Children"
	317	=> 'Found expected name for first result';
	318
	319	## What happens when we disconnect all the replicants?
	320
50336325	321	is $replicated->schema->storage->pool->connected_replicants => 2
	322	=> "both replicants are connected";
	323
89cf6a70	324	$replicated->schema->storage->replicants->{$replicant_names[0]}->disconnect;
89cf6a70	325	$replicated->schema->storage->replicants->{$replicant_names[1]}->disconnect;
26ab719a	326
50336325	327	is $replicated->schema->storage->pool->connected_replicants => 0
	328	=> "both replicants are now disconnected";
	329
	330	## All these should pass, since the database should automatically reconnect
	331
26ab719a	332	ok my $artist3 = $replicated->schema->resultset('Artist')->find(6)
26ab719a	333	=> 'Still finding stuff.';
2bf79155	334
26ab719a	335	isa_ok $artist3
26ab719a	336	=> 'DBICTest::Artist';
2bf79155	337
26ab719a	338	is $artist3->name, "Dead On Arrival"
26ab719a	339	=> 'Found expected name for first result';
2bf79155	340
50336325	341	is $replicated->schema->storage->pool->connected_replicants => 1
13b9e828	342	=> "At Least One replicant reconnected to handle the job";
6f6fb437	343
	344	## What happens when we try to select something that doesn't exist?
	345
	346	ok ! $replicated->schema->resultset('Artist')->find(666)
	347	=> 'Correctly failed to find something.';
cb6ec758	348
	349	## test the reliable option
	350
	351	TESTRELIABLE: {
	352
	353	$replicated->schema->storage->set_reliable_storage;
	354
	355	ok $replicated->schema->resultset('Artist')->find(2)
	356	=> 'Read from master 1';
	357
	358	ok $replicated->schema->resultset('Artist')->find(5)
	359	=> 'Read from master 2';
	360
	361	$replicated->schema->storage->set_balanced_storage;
	362
	363	ok $replicated->schema->resultset('Artist')->find(3)
9c748388	364	=> 'Read from replicant';
cb6ec758	365	}
cb6ec758	366
9c748388	367	## Make sure when reliable goes out of scope, we are using replicants again
cb6ec758	368
	369	ok $replicated->schema->resultset('Artist')->find(1)
	370	=> 'back to replicant 1.';
	371
	372	ok $replicated->schema->resultset('Artist')->find(2)
	373	=> 'back to replicant 2.';
2156bbdd	374
106d5f3b	375	## set all the replicants to inactive, and make sure the balancer falls back to
	376	## the master.
	377
89cf6a70	378	$replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
89cf6a70	379	$replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
9901aad7	380
	381	## Silence warning about falling back to master.
	382	$replicated->schema->storage->debugobj->silence(1);
	383
106d5f3b	384	ok $replicated->schema->resultset('Artist')->find(2)
de5dc9ef	385	=> 'Fallback to master';
de5dc9ef	386
9901aad7	387	$replicated->schema->storage->debugobj->silence(0);
9901aad7	388
de5dc9ef	389	$replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
de5dc9ef	390	$replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
9901aad7	391
	392	## Silence warning about not supporting the is_replicating method if using the
	393	## sqlite dbs.
	394	$replicated->schema->storage->debugobj->silence(1)
	395	if first { m{^t/} } @replicant_names;
	396
f15afa13	397	$replicated->schema->storage->pool->validate_replicants;
de5dc9ef	398
9901aad7	399	$replicated->schema->storage->debugobj->silence(0);
9901aad7	400
de5dc9ef	401	ok $replicated->schema->resultset('Artist')->find(2)
	402	=> 'Returned to replicates';
	403
	404	## Getting slave status tests
	405
f797e89e	406	SKIP: {
	407	## We skip this tests unless you have a custom replicants, since the default
	408	## sqlite based replication tests don't support these functions.
	409
17b05c13	410	skip 'Cannot Test Replicant Status on Non Replicating Database', 9
f797e89e	411	unless DBICTest->has_custom_dsn && $ENV{"DBICTEST_SLAVE0_DSN"};
	412
	413	$replicated->replicate; ## Give the slaves a chance to catchup.
	414
	415	ok $replicated->schema->storage->replicants->{$replicant_names[0]}->is_replicating
	416	=> 'Replicants are replicating';
	417
	418	is $replicated->schema->storage->replicants->{$replicant_names[0]}->lag_behind_master, 0
	419	=> 'Replicant is zero seconds behind master';
7edf5f1c	420
	421	## Test the validate replicants
	422
	423	$replicated->schema->storage->pool->validate_replicants;
	424
	425	is $replicated->schema->storage->pool->active_replicants, 2
	426	=> 'Still have 2 replicants after validation';
	427
	428	## Force the replicants to fail the validate test by required their lag to
	429	## be negative (ie ahead of the master!)
	430
	431	$replicated->schema->storage->pool->maximum_lag(-10);
	432	$replicated->schema->storage->pool->validate_replicants;
	433
	434	is $replicated->schema->storage->pool->active_replicants, 0
	435	=> 'No way a replicant be be ahead of the master';
	436
	437	## Let's be fair to the replicants again. Let them lag up to 5
	438
	439	$replicated->schema->storage->pool->maximum_lag(5);
	440	$replicated->schema->storage->pool->validate_replicants;
	441
	442	is $replicated->schema->storage->pool->active_replicants, 2
	443	=> 'Both replicants in good standing again';
17b05c13	444
	445	## Check auto validate
	446
	447	is $replicated->schema->storage->balancer->auto_validate_every, 100
	448	=> "Got the expected value for auto validate";
	449
	450	## This will make sure we auto validatge everytime
	451	$replicated->schema->storage->balancer->auto_validate_every(0);
	452
	453	## set all the replicants to inactive, and make sure the balancer falls back to
	454	## the master.
	455
	456	$replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
	457	$replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
	458
	459	## Ok, now when we go to run a query, autovalidate SHOULD reconnect
	460
	461	is $replicated->schema->storage->pool->active_replicants => 0
	462	=> "both replicants turned off";
	463
	464	ok $replicated->schema->resultset('Artist')->find(5)
	465	=> 'replicant reactivated';
	466
	467	is $replicated->schema->storage->pool->active_replicants => 2
	468	=> "both replicants reactivated";
f797e89e	469	}
f797e89e	470
c4d3fae2	471	## Test the reliably callback
	472
	473	ok my $reliably = sub {
	474
	475	ok $replicated->schema->resultset('Artist')->find(5)
	476	=> 'replicant reactivated';
	477
	478	} => 'created coderef properly';
	479
	480	$replicated->schema->storage->execute_reliably($reliably);
	481
	482	## Try something with an error
	483
	484	ok my $unreliably = sub {
	485
	486	ok $replicated->schema->resultset('ArtistXX')->find(5)
	487	=> 'replicant reactivated';
	488
	489	} => 'created coderef properly';
	490
	491	throws_ok {$replicated->schema->storage->execute_reliably($unreliably)}
ed213e85	492	qr/Can't find source for ArtistXX/
c4d3fae2	493	=> 'Bad coderef throws proper error';
c4d3fae2	494
ed213e85	495	## Make sure replication came back
	496
	497	ok $replicated->schema->resultset('Artist')->find(3)
	498	=> 'replicant reactivated';
	499
c4d3fae2	500	## make sure transactions are set to execute_reliably
	501
	502	ok my $transaction = sub {
	503
ed213e85	504	my $id = shift @_;
ed213e85	505
c4d3fae2	506	$replicated
	507	->schema
	508	->populate('Artist', [
	509	[ qw/artistid name/ ],
ed213e85	510	[ $id, "Children of the Grave"],
c4d3fae2	511	]);
c4d3fae2	512
64cdad22	513	ok my $result = $replicated->schema->resultset('Artist')->find($id)
	514	=> 'Found expected artist';
	515
	516	ok my $more = $replicated->schema->resultset('Artist')->find(1)
	517	=> 'Found expected artist again';
	518
ed213e85	519	return ($result, $more);
c4d3fae2	520
64cdad22	521	} => 'Created a coderef properly';
c4d3fae2	522
ed213e85	523	## Test the transaction with multi return
	524	{
	525	ok my @return = $replicated->schema->txn_do($transaction, 666)
	526	=> 'did transaction';
	527
	528	is $return[0]->id, 666
	529	=> 'first returned value is correct';
	530
	531	is $return[1]->id, 1
	532	=> 'second returned value is correct';
	533	}
	534
	535	## Test that asking for single return works
	536	{
	537	ok my $return = $replicated->schema->txn_do($transaction, 777)
	538	=> 'did transaction';
	539
	540	is $return->id, 777
	541	=> 'first returned value is correct';
	542	}
	543
	544	## Test transaction returning a single value
	545
	546	{
	547	ok my $result = $replicated->schema->txn_do(sub {
64cdad22	548	ok my $more = $replicated->schema->resultset('Artist')->find(1)
64cdad22	549	=> 'found inside a transaction';
ed213e85	550	return $more;
	551	}) => 'successfully processed transaction';
	552
	553	is $result->id, 1
	554	=> 'Got expected single result from transaction';
	555	}
c4d3fae2	556
	557	## Make sure replication came back
	558
ed213e85	559	ok $replicated->schema->resultset('Artist')->find(1)
c4d3fae2	560	=> 'replicant reactivated';
ed213e85	561
	562	## Test Discard changes
	563
	564	{
	565	ok my $artist = $replicated->schema->resultset('Artist')->find(2)
	566	=> 'got an artist to test discard changes';
	567
	568	ok $artist->discard_changes
	569	=> 'properly discard changes';
	570	}
64cdad22	571
	572	## Test some edge cases, like trying to do a transaction inside a transaction, etc
	573
	574	{
	575	ok my $result = $replicated->schema->txn_do(sub {
	576	return $replicated->schema->txn_do(sub {
	577	ok my $more = $replicated->schema->resultset('Artist')->find(1)
	578	=> 'found inside a transaction inside a transaction';
	579	return $more;
	580	});
	581	}) => 'successfully processed transaction';
	582
	583	is $result->id, 1
	584	=> 'Got expected single result from transaction';
	585	}
	586
	587	{
	588	ok my $result = $replicated->schema->txn_do(sub {
	589	return $replicated->schema->storage->execute_reliably(sub {
	590	return $replicated->schema->txn_do(sub {
	591	return $replicated->schema->storage->execute_reliably(sub {
	592	ok my $more = $replicated->schema->resultset('Artist')->find(1)
	593	=> 'found inside crazy deep transactions and execute_reliably';
	594	return $more;
	595	});
	596	});
	597	});
	598	}) => 'successfully processed transaction';
	599
	600	is $result->id, 1
	601	=> 'Got expected single result from transaction';
	602	}
2ce6e9a6	603
7e38d850	604	## Test the force_pool resultset attribute.
bbafcf26	605
	606	{
	607	ok my $artist_rs = $replicated->schema->resultset('Artist')
	608	=> 'got artist resultset';
	609
7e38d850	610	## Turn on Forced Pool Storage
	611	ok my $reliable_artist_rs = $artist_rs->search(undef, {force_pool=>'master'})
	612	=> 'Created a resultset using force_pool storage';
bbafcf26	613
bbafcf26	614	ok my $artist = $reliable_artist_rs->find(2)
7e38d850	615	=> 'got an artist result via force_pool storage';
bbafcf26	616	}
bbafcf26	617
0f83441a	618	## Delete the old database files
50336325	619	$replicated->cleanup;