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

use strict;
use warnings;
use lib qw(t/lib);
use Test::More;
use DBICTest;

BEGIN {
    eval "use Moose";
    plan $@
        ? ( skip_all => 'needs Moose for testing' )
        : ( tests => 34 );
}

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

## ----------------------------------------------------------------------------
## 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 {
        my $class = shift @_;
        my $schema = DBICTest->init_schema(storage_type=>'::DBI::Replicated');
        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';
    
isa_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->current_replicant
    => 'DBIx::Class::Storage::DBI';
    
ok $replicated->schema->storage->pool->has_replicants
    => 'does have replicants';     

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

isa_ok $replicated_storages[1]
    => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
    
isa_ok $replicated->schema->storage->replicants->{"t/var/DBIxClass_slave1.db"}
    => 'DBIx::Class::Storage::DBI::Replicated::Replicant';

isa_ok $replicated->schema->storage->replicants->{"t/var/DBIxClass_slave2.db"}
    => '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;

## 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"],
    ]);

## Alright, the database 'cluster' is not in a consistent state.  When we do
## a read now we expect bad news

is $replicated->schema->resultset('Artist')->find(5), undef
    => 'read after disconnect fails because it uses a replicant which we have neglected to "replicate" yet';

## 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->{"t/var/DBIxClass_slave1.db"}->disconnect;
$replicated->schema->storage->replicants->{"t/var/DBIxClass_slave2.db"}->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.';

## 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;
857d66ca	5	use DBICTest;
8f7986d6	6
86583fa7	7	BEGIN {
2bf79155	8	eval "use Moose";
86583fa7	9	plan $@
2bf79155	10	? ( skip_all => 'needs Moose for testing' )
6f6fb437	11	: ( tests => 34 );
26ab719a	12	}
	13
	14	use_ok 'DBIx::Class::Storage::DBI::Replicated::Pool';
	15	use_ok 'DBIx::Class::Storage::DBI::Replicated::Balancer';
	16	use_ok 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	17	use_ok 'DBIx::Class::Storage::DBI::Replicated';
0f83441a	18
	19	## ----------------------------------------------------------------------------
	20	## Build a class to hold all our required testing data and methods.
	21	## ----------------------------------------------------------------------------
	22
857d66ca	23	TESTSCHEMACLASSES: {
2bf79155	24
857d66ca	25	## --------------------------------------------------------------------- ##
	26	## Create an object to contain your replicated stuff.
	27	## --------------------------------------------------------------------- ##
	28
2bf79155	29	package DBIx::Class::DBI::Replicated::TestReplication;
	30
	31	use DBICTest;
	32	use base qw/Class::Accessor::Fast/;
	33
857d66ca	34	__PACKAGE__->mk_accessors( qw/schema/ );
2bf79155	35
	36	## Initialize the object
	37
	38	sub new {
26ab719a	39	my $class = shift @_;
26ab719a	40	my $self = $class->SUPER::new(@_);
2bf79155	41
2bf79155	42	$self->schema( $self->init_schema );
2bf79155	43	return $self;
	44	}
	45
26ab719a	46	## Get the Schema and set the replication storage type
2bf79155	47
	48	sub init_schema {
	49	my $class = shift @_;
	50	my $schema = DBICTest->init_schema(storage_type=>'::DBI::Replicated');
	51	return $schema;
	52	}
26ab719a	53
857d66ca	54	sub generate_replicant_connect_info {}
	55	sub replicate {}
	56	sub cleanup {}
	57
	58
	59	## --------------------------------------------------------------------- ##
	60	## Subclass for when you are using SQLite for testing, this provides a fake
	61	## replication support.
	62	## --------------------------------------------------------------------- ##
	63
	64	package DBIx::Class::DBI::Replicated::TestReplication::SQLite;
	65
	66	use DBICTest;
	67	use File::Copy;
	68	use base 'DBIx::Class::DBI::Replicated::TestReplication';
	69
	70	__PACKAGE__->mk_accessors( qw/master_path slave_paths/ );
	71
	72	## Set the mastep path from DBICTest
	73
	74	sub new {
	75	my $class = shift @_;
	76	my $self = $class->SUPER::new(@_);
	77
	78	$self->master_path( DBICTest->_sqlite_dbfilename );
	79	$self->slave_paths([
	80	"t/var/DBIxClass_slave1.db",
	81	"t/var/DBIxClass_slave2.db",
	82	]);
	83
	84	return $self;
	85	}
	86
26ab719a	87	## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
	88	## $storage->connect_info to be used for connecting replicants.
	89
	90	sub generate_replicant_connect_info {
857d66ca	91	my $self = shift @_;
26ab719a	92	my @dsn = map {
	93	"dbi:SQLite:${_}";
	94	} @{$self->slave_paths};
	95
857d66ca	96	return map { [$_,'','',{AutoCommit=>1}] } @dsn;
26ab719a	97	}
	98
	99	## Do a 'good enough' replication by copying the master dbfile over each of
50336325	100	## the slave dbfiles. If the master is SQLite we do this, otherwise we
50336325	101	## just do a one second pause to let the slaves catch up.
26ab719a	102
	103	sub replicate {
	104	my $self = shift @_;
	105	foreach my $slave (@{$self->slave_paths}) {
	106	copy($self->master_path, $slave);
	107	}
	108	}
	109
	110	## Cleanup after ourselves. Unlink all gthe slave paths.
	111
	112	sub cleanup {
	113	my $self = shift @_;
	114	foreach my $slave (@{$self->slave_paths}) {
	115	unlink $slave;
	116	}
	117	}
857d66ca	118
	119	## --------------------------------------------------------------------- ##
	120	## Subclass for when you are setting the databases via custom export vars
	121	## This is for when you have a replicating database setup that you are
	122	## going to test against. You'll need to define the correct $ENV and have
	123	## two slave databases to test against, as well as a replication system
	124	## that will replicate in less than 1 second.
	125	## --------------------------------------------------------------------- ##
	126
	127	package DBIx::Class::DBI::Replicated::TestReplication::Custom;
	128	use base 'DBIx::Class::DBI::Replicated::TestReplication';
	129
	130	## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
	131	## $storage->connect_info to be used for connecting replicants.
	132
	133	sub generate_replicant_connect_info {
	134	return (
	135	[$ENV{"DBICTEST_SLAVE0_DSN"}, $ENV{"DBICTEST_SLAVE0_DBUSER"}, $ENV{"DBICTEST_SLAVE0_DBPASS"}, {AutoCommit => 1}],
	136	[$ENV{"DBICTEST_SLAVE1_DSN"}, $ENV{"DBICTEST_SLAVE1_DBUSER"}, $ENV{"DBICTEST_SLAVE1_DBPASS"}, {AutoCommit => 1}],
	137	);
	138	}
	139
	140	## pause a bit to let the replication catch up
	141
	142	sub replicate {
	143	sleep 1;
	144	}
2bf79155	145	}
	146
	147	## ----------------------------------------------------------------------------
	148	## Create an object and run some tests
	149	## ----------------------------------------------------------------------------
	150
26ab719a	151	## Thi first bunch of tests are basic, just make sure all the bits are behaving
2bf79155	152
857d66ca	153	my $replicated_class = DBICTest->has_custom_dsn ?
	154	'DBIx::Class::DBI::Replicated::TestReplication::Custom' :
	155	'DBIx::Class::DBI::Replicated::TestReplication::SQLite';
	156
	157	ok my $replicated = $replicated_class->new
	158	=> 'Created a replication object';
2bf79155	159
26ab719a	160	isa_ok $replicated->schema
2bf79155	161	=> 'DBIx::Class::Schema';
2bf79155	162
26ab719a	163	isa_ok $replicated->schema->storage
	164	=> 'DBIx::Class::Storage::DBI::Replicated';
	165
	166	ok $replicated->schema->storage->meta
	167	=> 'has a meta object';
	168
	169	isa_ok $replicated->schema->storage->master
	170	=> 'DBIx::Class::Storage::DBI';
	171
	172	isa_ok $replicated->schema->storage->pool
	173	=> 'DBIx::Class::Storage::DBI::Replicated::Pool';
	174
	175	isa_ok $replicated->schema->storage->balancer
	176	=> 'DBIx::Class::Storage::DBI::Replicated::Balancer';
	177
	178	ok my @replicant_connects = $replicated->generate_replicant_connect_info
	179	=> 'got replication connect information';
	180
955a6df6	181	ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
26ab719a	182	=> 'Created some storages suitable for replicants';
	183
	184	isa_ok $replicated->schema->storage->current_replicant
	185	=> 'DBIx::Class::Storage::DBI';
	186
	187	ok $replicated->schema->storage->pool->has_replicants
	188	=> 'does have replicants';
	189
	190	is $replicated->schema->storage->num_replicants => 2
	191	=> 'has two replicants';
	192
	193	isa_ok $replicated_storages[0]
	194	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	195
	196	isa_ok $replicated_storages[1]
	197	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	198
	199	isa_ok $replicated->schema->storage->replicants->{"t/var/DBIxClass_slave1.db"}
	200	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	201
	202	isa_ok $replicated->schema->storage->replicants->{"t/var/DBIxClass_slave2.db"}
	203	=> 'DBIx::Class::Storage::DBI::Replicated::Replicant';
	204
	205	## Add some info to the database
	206
	207	$replicated
	208	->schema
	209	->populate('Artist', [
	210	[ qw/artistid name/ ],
	211	[ 4, "Ozric Tentacles"],
	212	]);
	213
	214	## Make sure all the slaves have the table definitions
	215
	216	$replicated->replicate;
	217
	218	## Make sure we can read the data.
	219
	220	ok my $artist1 = $replicated->schema->resultset('Artist')->find(4)
	221	=> 'Created Result';
	222
	223	isa_ok $artist1
	224	=> 'DBICTest::Artist';
	225
	226	is $artist1->name, 'Ozric Tentacles'
	227	=> 'Found expected name for first result';
	228
	229	## Add some new rows that only the master will have This is because
	230	## we overload any type of write operation so that is must hit the master
	231	## database.
	232
	233	$replicated
	234	->schema
	235	->populate('Artist', [
	236	[ qw/artistid name/ ],
	237	[ 5, "Doom's Children"],
	238	[ 6, "Dead On Arrival"],
	239	[ 7, "Watergate"],
	240	]);
	241
	242	## Alright, the database 'cluster' is not in a consistent state. When we do
	243	## a read now we expect bad news
	244
	245	is $replicated->schema->resultset('Artist')->find(5), undef
246	=> 'read after disconnect fails because it uses a replicant which we have neglected to "replicate" yet';
247
248	## Make sure all the slaves have the table definitions
249	$replicated->replicate;
250
251	## Should find some data now
252
253	ok my $artist2 = $replicated->schema->resultset('Artist')->find(5)
254	=> 'Sync succeed';
255
256	isa_ok $artist2
257	=> 'DBICTest::Artist';
258
259	is $artist2->name, "Doom's Children"
260	=> 'Found expected name for first result';
261
262	## What happens when we disconnect all the replicants?
263
50336325	264	is $replicated->schema->storage->pool->connected_replicants => 2
	265	=> "both replicants are connected";
	266
26ab719a	267	$replicated->schema->storage->replicants->{"t/var/DBIxClass_slave1.db"}->disconnect;
	268	$replicated->schema->storage->replicants->{"t/var/DBIxClass_slave2.db"}->disconnect;
	269
50336325	270	is $replicated->schema->storage->pool->connected_replicants => 0
	271	=> "both replicants are now disconnected";
	272
	273	## All these should pass, since the database should automatically reconnect
	274
26ab719a	275	ok my $artist3 = $replicated->schema->resultset('Artist')->find(6)
26ab719a	276	=> 'Still finding stuff.';
2bf79155	277
26ab719a	278	isa_ok $artist3
26ab719a	279	=> 'DBICTest::Artist';
2bf79155	280
26ab719a	281	is $artist3->name, "Dead On Arrival"
26ab719a	282	=> 'Found expected name for first result';
2bf79155	283
50336325	284	is $replicated->schema->storage->pool->connected_replicants => 1
50336325	285	=> "One replicant reconnected to handle the job";
6f6fb437	286
	287	## What happens when we try to select something that doesn't exist?
	288
	289	ok ! $replicated->schema->resultset('Artist')->find(666)
	290	=> 'Correctly failed to find something.';
2156bbdd	291
0f83441a	292	## Delete the old database files
50336325	293	$replicated->cleanup;
0f83441a	294
	295
	296
	297
	298
	299