[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;

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};
        
        return map { [$_,'','',{AutoCommit=>1}] } @dsn;
    }
    
    ## 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';
    
isa_ok $replicated->schema->storage->balancer->current_replicant
    => 'DBIx::Class::Storage::DBI';
    
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';
    
my @replicant_names = keys %{$replicated->schema->storage->replicants};

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);
$replicated->schema->storage->pool->validate_replicants;

## 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
    => "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);
    
ok $replicated->schema->resultset('Artist')->find(2)
    => 'Fallback to master';

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

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