9 eval "use DBIx::Class::Storage::DBI::Replicated; use Test::Moose";
11 ? ( skip_all => "Deps not installed: $@" )
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';
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.
32 ## ----------------------------------------------------------------------------
33 ## Build a class to hold all our required testing data and methods.
34 ## ----------------------------------------------------------------------------
38 ## --------------------------------------------------------------------- ##
39 ## Create an object to contain your replicated stuff.
40 ## --------------------------------------------------------------------- ##
42 package DBIx::Class::DBI::Replicated::TestReplication;
45 use base qw/Class::Accessor::Fast/;
47 __PACKAGE__->mk_accessors( qw/schema/ );
49 ## Initialize the object
53 my $self = $class->SUPER::new(@_);
55 $self->schema( $self->init_schema );
59 ## Get the Schema and set the replication storage type
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/ };
67 my $schema = DBICTest->init_schema(
70 '::DBI::Replicated' => {
71 balancer_type=>'::Random',
73 auto_validate_every=>100,
85 sub generate_replicant_connect_info {}
90 ## --------------------------------------------------------------------- ##
91 ## Subclass for when you are using SQLite for testing, this provides a fake
92 ## replication support.
93 ## --------------------------------------------------------------------- ##
95 package DBIx::Class::DBI::Replicated::TestReplication::SQLite;
99 use base 'DBIx::Class::DBI::Replicated::TestReplication';
101 __PACKAGE__->mk_accessors( qw/master_path slave_paths/ );
103 ## Set the mastep path from DBICTest
106 my $class = shift @_;
107 my $self = $class->SUPER::new(@_);
109 $self->master_path( DBICTest->_sqlite_dbfilename );
111 "t/var/DBIxClass_slave1.db",
112 "t/var/DBIxClass_slave2.db",
118 ## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
119 ## $storage->connect_info to be used for connecting replicants.
121 sub generate_replicant_connect_info {
125 } @{$self->slave_paths};
127 return map { [$_,'','',{AutoCommit=>1}] } @dsn;
130 ## Do a 'good enough' replication by copying the master dbfile over each of
131 ## the slave dbfiles. If the master is SQLite we do this, otherwise we
132 ## just do a one second pause to let the slaves catch up.
136 foreach my $slave (@{$self->slave_paths}) {
137 copy($self->master_path, $slave);
141 ## Cleanup after ourselves. Unlink all gthe slave paths.
145 foreach my $slave (@{$self->slave_paths}) {
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 ## --------------------------------------------------------------------- ##
158 package DBIx::Class::DBI::Replicated::TestReplication::Custom;
159 use base 'DBIx::Class::DBI::Replicated::TestReplication';
161 ## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
162 ## $storage->connect_info to be used for connecting replicants.
164 sub generate_replicant_connect_info {
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}],
171 ## pause a bit to let the replication catch up
178 ## ----------------------------------------------------------------------------
179 ## Create an object and run some tests
180 ## ----------------------------------------------------------------------------
182 ## Thi first bunch of tests are basic, just make sure all the bits are behaving
184 my $replicated_class = DBICTest->has_custom_dsn ?
185 'DBIx::Class::DBI::Replicated::TestReplication::Custom' :
186 'DBIx::Class::DBI::Replicated::TestReplication::SQLite';
188 ok my $replicated = $replicated_class->new
189 => 'Created a replication object';
191 isa_ok $replicated->schema
192 => 'DBIx::Class::Schema';
194 isa_ok $replicated->schema->storage
195 => 'DBIx::Class::Storage::DBI::Replicated';
197 ok $replicated->schema->storage->meta
198 => 'has a meta object';
200 isa_ok $replicated->schema->storage->master
201 => 'DBIx::Class::Storage::DBI';
203 isa_ok $replicated->schema->storage->pool
204 => 'DBIx::Class::Storage::DBI::Replicated::Pool';
206 does_ok $replicated->schema->storage->balancer
207 => 'DBIx::Class::Storage::DBI::Replicated::Balancer';
209 ok my @replicant_connects = $replicated->generate_replicant_connect_info
210 => 'got replication connect information';
212 ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
213 => 'Created some storages suitable for replicants';
215 isa_ok $replicated->schema->storage->balancer->current_replicant
216 => 'DBIx::Class::Storage::DBI';
218 ok $replicated->schema->storage->pool->has_replicants
219 => 'does have replicants';
221 is $replicated->schema->storage->pool->num_replicants => 2
222 => 'has two replicants';
224 does_ok $replicated_storages[0]
225 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
227 does_ok $replicated_storages[1]
228 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
230 my @replicant_names = keys %{$replicated->schema->storage->replicants};
232 does_ok $replicated->schema->storage->replicants->{$replicant_names[0]}
233 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
235 does_ok $replicated->schema->storage->replicants->{$replicant_names[1]}
236 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
238 ## Add some info to the database
242 ->populate('Artist', [
243 [ qw/artistid name/ ],
244 [ 4, "Ozric Tentacles"],
247 ## Make sure all the slaves have the table definitions
249 $replicated->replicate;
250 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
251 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
253 ## Make sure we can read the data.
255 ok my $artist1 = $replicated->schema->resultset('Artist')->find(4)
259 => 'DBICTest::Artist';
261 is $artist1->name, 'Ozric Tentacles'
262 => 'Found expected name for first result';
264 ## Add some new rows that only the master will have This is because
265 ## we overload any type of write operation so that is must hit the master
270 ->populate('Artist', [
271 [ qw/artistid name/ ],
272 [ 5, "Doom's Children"],
273 [ 6, "Dead On Arrival"],
277 ## Make sure all the slaves have the table definitions
278 $replicated->replicate;
280 ## Should find some data now
282 ok my $artist2 = $replicated->schema->resultset('Artist')->find(5)
286 => 'DBICTest::Artist';
288 is $artist2->name, "Doom's Children"
289 => 'Found expected name for first result';
291 ## What happens when we disconnect all the replicants?
293 is $replicated->schema->storage->pool->connected_replicants => 2
294 => "both replicants are connected";
296 $replicated->schema->storage->replicants->{$replicant_names[0]}->disconnect;
297 $replicated->schema->storage->replicants->{$replicant_names[1]}->disconnect;
299 is $replicated->schema->storage->pool->connected_replicants => 0
300 => "both replicants are now disconnected";
302 ## All these should pass, since the database should automatically reconnect
304 ok my $artist3 = $replicated->schema->resultset('Artist')->find(6)
305 => 'Still finding stuff.';
308 => 'DBICTest::Artist';
310 is $artist3->name, "Dead On Arrival"
311 => 'Found expected name for first result';
313 is $replicated->schema->storage->pool->connected_replicants => 1
314 => "One replicant reconnected to handle the job";
316 ## What happens when we try to select something that doesn't exist?
318 ok ! $replicated->schema->resultset('Artist')->find(666)
319 => 'Correctly failed to find something.';
321 ## test the reliable option
325 $replicated->schema->storage->set_reliable_storage;
327 ok $replicated->schema->resultset('Artist')->find(2)
328 => 'Read from master 1';
330 ok $replicated->schema->resultset('Artist')->find(5)
331 => 'Read from master 2';
333 $replicated->schema->storage->set_balanced_storage;
335 ok $replicated->schema->resultset('Artist')->find(3)
336 => 'Read from replicant';
339 ## Make sure when reliable goes out of scope, we are using replicants again
341 ok $replicated->schema->resultset('Artist')->find(1)
342 => 'back to replicant 1.';
344 ok $replicated->schema->resultset('Artist')->find(2)
345 => 'back to replicant 2.';
347 ## set all the replicants to inactive, and make sure the balancer falls back to
350 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
351 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
353 ok $replicated->schema->resultset('Artist')->find(2)
354 => 'Fallback to master';
356 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
357 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
359 ok $replicated->schema->resultset('Artist')->find(2)
360 => 'Returned to replicates';
362 ## Getting slave status tests
365 ## We skip this tests unless you have a custom replicants, since the default
366 ## sqlite based replication tests don't support these functions.
368 skip 'Cannot Test Replicant Status on Non Replicating Database', 9
369 unless DBICTest->has_custom_dsn && $ENV{"DBICTEST_SLAVE0_DSN"};
371 $replicated->replicate; ## Give the slaves a chance to catchup.
373 ok $replicated->schema->storage->replicants->{$replicant_names[0]}->is_replicating
374 => 'Replicants are replicating';
376 is $replicated->schema->storage->replicants->{$replicant_names[0]}->lag_behind_master, 0
377 => 'Replicant is zero seconds behind master';
379 ## Test the validate replicants
381 $replicated->schema->storage->pool->validate_replicants;
383 is $replicated->schema->storage->pool->active_replicants, 2
384 => 'Still have 2 replicants after validation';
386 ## Force the replicants to fail the validate test by required their lag to
387 ## be negative (ie ahead of the master!)
389 $replicated->schema->storage->pool->maximum_lag(-10);
390 $replicated->schema->storage->pool->validate_replicants;
392 is $replicated->schema->storage->pool->active_replicants, 0
393 => 'No way a replicant be be ahead of the master';
395 ## Let's be fair to the replicants again. Let them lag up to 5
397 $replicated->schema->storage->pool->maximum_lag(5);
398 $replicated->schema->storage->pool->validate_replicants;
400 is $replicated->schema->storage->pool->active_replicants, 2
401 => 'Both replicants in good standing again';
403 ## Check auto validate
405 is $replicated->schema->storage->balancer->auto_validate_every, 100
406 => "Got the expected value for auto validate";
408 ## This will make sure we auto validatge everytime
409 $replicated->schema->storage->balancer->auto_validate_every(0);
411 ## set all the replicants to inactive, and make sure the balancer falls back to
414 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
415 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
417 ## Ok, now when we go to run a query, autovalidate SHOULD reconnect
419 is $replicated->schema->storage->pool->active_replicants => 0
420 => "both replicants turned off";
422 ok $replicated->schema->resultset('Artist')->find(5)
423 => 'replicant reactivated';
425 is $replicated->schema->storage->pool->active_replicants => 2
426 => "both replicants reactivated";
429 ## Test the reliably callback
431 ok my $reliably = sub {
433 ok $replicated->schema->resultset('Artist')->find(5)
434 => 'replicant reactivated';
436 } => 'created coderef properly';
438 $replicated->schema->storage->execute_reliably($reliably);
440 ## Try something with an error
442 ok my $unreliably = sub {
444 ok $replicated->schema->resultset('ArtistXX')->find(5)
445 => 'replicant reactivated';
447 } => 'created coderef properly';
449 throws_ok {$replicated->schema->storage->execute_reliably($unreliably)}
450 qr/Can't find source for ArtistXX/
451 => 'Bad coderef throws proper error';
453 ## Make sure replication came back
455 ok $replicated->schema->resultset('Artist')->find(3)
456 => 'replicant reactivated';
458 ## make sure transactions are set to execute_reliably
460 ok my $transaction = sub {
466 ->populate('Artist', [
467 [ qw/artistid name/ ],
468 [ $id, "Children of the Grave"],
471 ok my $result = $replicated->schema->resultset('Artist')->find($id)
472 => 'Found expected artist';
474 ok my $more = $replicated->schema->resultset('Artist')->find(1)
475 => 'Found expected artist again';
477 return ($result, $more);
479 } => 'Created a coderef properly';
481 ## Test the transaction with multi return
483 ok my @return = $replicated->schema->txn_do($transaction, 666)
484 => 'did transaction';
486 is $return[0]->id, 666
487 => 'first returned value is correct';
490 => 'second returned value is correct';
493 ## Test that asking for single return works
495 ok my $return = $replicated->schema->txn_do($transaction, 777)
496 => 'did transaction';
499 => 'first returned value is correct';
502 ## Test transaction returning a single value
505 ok my $result = $replicated->schema->txn_do(sub {
506 ok my $more = $replicated->schema->resultset('Artist')->find(1)
507 => 'found inside a transaction';
509 }) => 'successfully processed transaction';
512 => 'Got expected single result from transaction';
515 ## Make sure replication came back
517 ok $replicated->schema->resultset('Artist')->find(1)
518 => 'replicant reactivated';
520 ## Test Discard changes
523 ok my $artist = $replicated->schema->resultset('Artist')->find(2)
524 => 'got an artist to test discard changes';
526 ok $artist->discard_changes
527 => 'properly discard changes';
530 ## Test some edge cases, like trying to do a transaction inside a transaction, etc
533 ok my $result = $replicated->schema->txn_do(sub {
534 return $replicated->schema->txn_do(sub {
535 ok my $more = $replicated->schema->resultset('Artist')->find(1)
536 => 'found inside a transaction inside a transaction';
539 }) => 'successfully processed transaction';
542 => 'Got expected single result from transaction';
546 ok my $result = $replicated->schema->txn_do(sub {
547 return $replicated->schema->storage->execute_reliably(sub {
548 return $replicated->schema->txn_do(sub {
549 return $replicated->schema->storage->execute_reliably(sub {
550 ok my $more = $replicated->schema->resultset('Artist')->find(1)
551 => 'found inside crazy deep transactions and execute_reliably';
556 }) => 'successfully processed transaction';
559 => 'Got expected single result from transaction';
562 ## Test the force_pool resultset attribute.
565 ok my $artist_rs = $replicated->schema->resultset('Artist')
566 => 'got artist resultset';
568 ## Turn on Forced Pool Storage
569 ok my $reliable_artist_rs = $artist_rs->search(undef, {force_pool=>'master'})
570 => 'Created a resultset using force_pool storage';
572 ok my $artist = $reliable_artist_rs->find(2)
573 => 'got an artist result via force_pool storage';
576 ## Delete the old database files
577 $replicated->cleanup;