7 use List::Util 'first';
8 use Scalar::Util 'reftype';
13 eval "use DBIx::Class::Storage::DBI::Replicated; use Test::Moose";
15 ? ( skip_all => "Deps not installed: $@" )
19 use_ok 'DBIx::Class::Storage::DBI::Replicated::Pool';
20 use_ok 'DBIx::Class::Storage::DBI::Replicated::Balancer';
21 use_ok 'DBIx::Class::Storage::DBI::Replicated::Replicant';
22 use_ok 'DBIx::Class::Storage::DBI::Replicated';
26 diag "Using Moose version $Moose::VERSION and MooseX::Types version $MooseX::Types::VERSION";
30 This is a test of the replicated storage system. This will work in one of
31 two ways, either it was try to fake replication with a couple of SQLite DBs
32 and creative use of copy, or if you define a couple of %ENV vars correctly
33 will try to test those. If you do that, it will assume the setup is properly
34 replicating. Your results may vary, but I have demonstrated this to work with
35 mysql native replication.
40 ## ----------------------------------------------------------------------------
41 ## Build a class to hold all our required testing data and methods.
42 ## ----------------------------------------------------------------------------
46 ## --------------------------------------------------------------------- ##
47 ## Create an object to contain your replicated stuff.
48 ## --------------------------------------------------------------------- ##
50 package DBIx::Class::DBI::Replicated::TestReplication;
53 use base qw/Class::Accessor::Fast/;
55 __PACKAGE__->mk_accessors( qw/schema/ );
57 ## Initialize the object
60 my ($class, $schema_method) = (shift, shift);
61 my $self = $class->SUPER::new(@_);
63 $self->schema( $self->init_schema($schema_method) );
67 ## Get the Schema and set the replication storage type
70 # current SQLT SQLite producer does not handle DROP TABLE IF EXISTS, trap warnings here
71 local $SIG{__WARN__} = sub { warn @_ unless $_[0] =~ /no such table.+DROP TABLE/ };
73 my ($class, $schema_method) = @_;
75 my $method = "get_schema_$schema_method";
76 my $schema = $class->$method;
81 sub get_schema_by_storage_type {
82 DBICTest->init_schema(
85 '::DBI::Replicated' => {
86 balancer_type=>'::Random',
88 auto_validate_every=>100,
89 master_read_weight => 1
99 sub get_schema_by_connect_info {
100 DBICTest->init_schema(
101 sqlite_use_file => 1,
102 storage_type=> '::DBI::Replicated',
103 balancer_type=>'::Random',
105 auto_validate_every=>100,
106 master_read_weight => 1
114 sub generate_replicant_connect_info {}
118 ## --------------------------------------------------------------------- ##
119 ## Add a connect_info option to test option merging.
120 ## --------------------------------------------------------------------- ##
122 package DBIx::Class::Storage::DBI::Replicated;
126 __PACKAGE__->meta->make_mutable;
128 around connect_info => sub {
129 my ($next, $self, $info) = @_;
130 $info->[3]{master_option} = 1;
134 __PACKAGE__->meta->make_immutable;
139 ## --------------------------------------------------------------------- ##
140 ## Subclass for when you are using SQLite for testing, this provides a fake
141 ## replication support.
142 ## --------------------------------------------------------------------- ##
144 package DBIx::Class::DBI::Replicated::TestReplication::SQLite;
148 use base 'DBIx::Class::DBI::Replicated::TestReplication';
150 __PACKAGE__->mk_accessors(qw/master_path slave_paths/);
152 ## Set the master path from DBICTest
155 my $class = shift @_;
156 my $self = $class->SUPER::new(@_);
158 $self->master_path( DBICTest->_sqlite_dbfilename );
160 File::Spec->catfile(qw/t var DBIxClass_slave1.db/),
161 File::Spec->catfile(qw/t var DBIxClass_slave2.db/),
167 ## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
168 ## $storage->connect_info to be used for connecting replicants.
170 sub generate_replicant_connect_info {
174 } @{$self->slave_paths};
176 my @connect_infos = map { [$_,'','',{AutoCommit=>1}] } @dsn;
178 ## Make sure nothing is left over from a failed test
182 my $c = $connect_infos[0];
183 $connect_infos[0] = {
193 ## Do a 'good enough' replication by copying the master dbfile over each of
194 ## the slave dbfiles. If the master is SQLite we do this, otherwise we
195 ## just do a one second pause to let the slaves catch up.
199 foreach my $slave (@{$self->slave_paths}) {
200 copy($self->master_path, $slave);
204 ## Cleanup after ourselves. Unlink all gthe slave paths.
208 foreach my $slave (@{$self->slave_paths}) {
215 ## --------------------------------------------------------------------- ##
216 ## Subclass for when you are setting the databases via custom export vars
217 ## This is for when you have a replicating database setup that you are
218 ## going to test against. You'll need to define the correct $ENV and have
219 ## two slave databases to test against, as well as a replication system
220 ## that will replicate in less than 1 second.
221 ## --------------------------------------------------------------------- ##
223 package DBIx::Class::DBI::Replicated::TestReplication::Custom;
224 use base 'DBIx::Class::DBI::Replicated::TestReplication';
226 ## Return an Array of ArrayRefs where each ArrayRef is suitable to use for
227 ## $storage->connect_info to be used for connecting replicants.
229 sub generate_replicant_connect_info {
231 [$ENV{"DBICTEST_SLAVE0_DSN"}, $ENV{"DBICTEST_SLAVE0_DBUSER"}, $ENV{"DBICTEST_SLAVE0_DBPASS"}, {AutoCommit => 1}],
232 [$ENV{"DBICTEST_SLAVE1_DSN"}, $ENV{"DBICTEST_SLAVE1_DBUSER"}, $ENV{"DBICTEST_SLAVE1_DBPASS"}, {AutoCommit => 1}],
236 ## pause a bit to let the replication catch up
243 ## ----------------------------------------------------------------------------
244 ## Create an object and run some tests
245 ## ----------------------------------------------------------------------------
247 ## Thi first bunch of tests are basic, just make sure all the bits are behaving
249 my $replicated_class = DBICTest->has_custom_dsn ?
250 'DBIx::Class::DBI::Replicated::TestReplication::Custom' :
251 'DBIx::Class::DBI::Replicated::TestReplication::SQLite';
255 for my $method (qw/by_connect_info by_storage_type/) {
257 ok $replicated = $replicated_class->new($method)
258 => "Created a replication object $method";
260 isa_ok $replicated->schema
261 => 'DBIx::Class::Schema';
263 isa_ok $replicated->schema->storage
264 => 'DBIx::Class::Storage::DBI::Replicated';
266 isa_ok $replicated->schema->storage->balancer
267 => 'DBIx::Class::Storage::DBI::Replicated::Balancer::Random'
268 => 'configured balancer_type';
271 ok $replicated->schema->storage->meta
272 => 'has a meta object';
274 isa_ok $replicated->schema->storage->master
275 => 'DBIx::Class::Storage::DBI';
277 isa_ok $replicated->schema->storage->pool
278 => 'DBIx::Class::Storage::DBI::Replicated::Pool';
280 does_ok $replicated->schema->storage->balancer
281 => 'DBIx::Class::Storage::DBI::Replicated::Balancer';
283 ok my @replicant_connects = $replicated->generate_replicant_connect_info
284 => 'got replication connect information';
286 ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
287 => 'Created some storages suitable for replicants';
290 $replicated->schema->storage->debug(1);
291 $replicated->schema->storage->debugcb(sub {
292 my ($op, $info) = @_;
293 ##warn "\n$op, $info\n";
297 dsn => ($info=~m/\[(.+)\]/)[0],
298 storage_type => $info=~m/REPLICANT/ ? 'REPLICANT' : 'MASTER',
302 ok my @all_storages = $replicated->schema->storage->all_storages
305 is scalar @all_storages,
307 => 'correct number of ->all_storages';
309 is ((grep $_->isa('DBIx::Class::Storage::DBI'), @all_storages),
311 => '->all_storages are correct type');
313 my @all_storage_opts =
314 grep { (reftype($_)||'') eq 'HASH' }
315 map @{ $_->_connect_info }, @all_storages;
317 is ((grep $_->{master_option}, @all_storage_opts),
319 => 'connect_info was merged from master to replicants');
321 my @replicant_names = keys %{ $replicated->schema->storage->replicants };
323 ok @replicant_names, "found replicant names @replicant_names";
325 ## Silence warning about not supporting the is_replicating method if using the
327 $replicated->schema->storage->debugobj->silence(1)
328 if first { m{^t/} } @replicant_names;
330 isa_ok $replicated->schema->storage->balancer->current_replicant
331 => 'DBIx::Class::Storage::DBI';
333 $replicated->schema->storage->debugobj->silence(0);
335 ok $replicated->schema->storage->pool->has_replicants
336 => 'does have replicants';
338 is $replicated->schema->storage->pool->num_replicants => 2
339 => 'has two replicants';
341 does_ok $replicated_storages[0]
342 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
344 does_ok $replicated_storages[1]
345 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
347 does_ok $replicated->schema->storage->replicants->{$replicant_names[0]}
348 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
350 does_ok $replicated->schema->storage->replicants->{$replicant_names[1]}
351 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
353 ## Add some info to the database
357 ->populate('Artist', [
358 [ qw/artistid name/ ],
359 [ 4, "Ozric Tentacles"],
362 is $debug{storage_type}, 'MASTER',
363 "got last query from a master: $debug{dsn}";
365 like $debug{info}, qr/INSERT/, 'Last was an insert';
367 ## Make sure all the slaves have the table definitions
369 $replicated->replicate;
370 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
371 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
373 ## Silence warning about not supporting the is_replicating method if using the
375 $replicated->schema->storage->debugobj->silence(1)
376 if first { m{^t/} } @replicant_names;
378 $replicated->schema->storage->pool->validate_replicants;
380 $replicated->schema->storage->debugobj->silence(0);
382 ## Make sure we can read the data.
384 ok my $artist1 = $replicated->schema->resultset('Artist')->find(4)
387 ## We removed testing here since master read weight is on, so we can't tell in
388 ## advance what storage to expect. We turn master read weight off a bit lower
389 ## is $debug{storage_type}, 'REPLICANT'
390 ## => "got last query from a replicant: $debug{dsn}, $debug{info}";
393 => 'DBICTest::Artist';
395 is $artist1->name, 'Ozric Tentacles'
396 => 'Found expected name for first result';
398 ## Check that master_read_weight is honored
400 no warnings qw/once redefine/;
403 *DBIx::Class::Storage::DBI::Replicated::Balancer::Random::_random_number =
406 $replicated->schema->storage->balancer->increment_storage;
408 is $replicated->schema->storage->balancer->current_replicant,
409 $replicated->schema->storage->master
410 => 'master_read_weight is honored';
412 ## turn it off for the duration of the test
413 $replicated->schema->storage->balancer->master_read_weight(0);
414 $replicated->schema->storage->balancer->increment_storage;
417 ## Add some new rows that only the master will have This is because
418 ## we overload any type of write operation so that is must hit the master
423 ->populate('Artist', [
424 [ qw/artistid name/ ],
425 [ 5, "Doom's Children"],
426 [ 6, "Dead On Arrival"],
430 is $debug{storage_type}, 'MASTER',
431 "got last query from a master: $debug{dsn}";
433 like $debug{info}, qr/INSERT/, 'Last was an insert';
435 ## Make sure all the slaves have the table definitions
436 $replicated->replicate;
438 ## Should find some data now
440 ok my $artist2 = $replicated->schema->resultset('Artist')->find(5)
443 is $debug{storage_type}, 'REPLICANT'
444 => "got last query from a replicant: $debug{dsn}";
447 => 'DBICTest::Artist';
449 is $artist2->name, "Doom's Children"
450 => 'Found expected name for first result';
452 ## What happens when we disconnect all the replicants?
454 is $replicated->schema->storage->pool->connected_replicants => 2
455 => "both replicants are connected";
457 $replicated->schema->storage->replicants->{$replicant_names[0]}->disconnect;
458 $replicated->schema->storage->replicants->{$replicant_names[1]}->disconnect;
460 is $replicated->schema->storage->pool->connected_replicants => 0
461 => "both replicants are now disconnected";
463 ## All these should pass, since the database should automatically reconnect
465 ok my $artist3 = $replicated->schema->resultset('Artist')->find(6)
466 => 'Still finding stuff.';
468 is $debug{storage_type}, 'REPLICANT'
469 => "got last query from a replicant: $debug{dsn}";
472 => 'DBICTest::Artist';
474 is $artist3->name, "Dead On Arrival"
475 => 'Found expected name for first result';
477 is $replicated->schema->storage->pool->connected_replicants => 1
478 => "At Least One replicant reconnected to handle the job";
480 ## What happens when we try to select something that doesn't exist?
482 ok ! $replicated->schema->resultset('Artist')->find(666)
483 => 'Correctly failed to find something.';
485 is $debug{storage_type}, 'REPLICANT'
486 => "got last query from a replicant: $debug{dsn}";
488 ## test the reliable option
492 $replicated->schema->storage->set_reliable_storage;
494 ok $replicated->schema->resultset('Artist')->find(2)
495 => 'Read from master 1';
497 is $debug{storage_type}, 'MASTER',
498 "got last query from a master: $debug{dsn}";
500 ok $replicated->schema->resultset('Artist')->find(5)
501 => 'Read from master 2';
503 is $debug{storage_type}, 'MASTER',
504 "got last query from a master: $debug{dsn}";
506 $replicated->schema->storage->set_balanced_storage;
508 ok $replicated->schema->resultset('Artist')->find(3)
509 => 'Read from replicant';
511 is $debug{storage_type}, 'REPLICANT',
512 "got last query from a replicant: $debug{dsn}";
515 ## Make sure when reliable goes out of scope, we are using replicants again
517 ok $replicated->schema->resultset('Artist')->find(1)
518 => 'back to replicant 1.';
520 is $debug{storage_type}, 'REPLICANT',
521 "got last query from a replicant: $debug{dsn}";
523 ok $replicated->schema->resultset('Artist')->find(2)
524 => 'back to replicant 2.';
526 is $debug{storage_type}, 'REPLICANT',
527 "got last query from a replicant: $debug{dsn}";
529 ## set all the replicants to inactive, and make sure the balancer falls back to
532 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
533 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
536 ## catch the fallback to master warning
537 open my $debugfh, '>', \my $fallback_warning;
538 my $oldfh = $replicated->schema->storage->debugfh;
539 $replicated->schema->storage->debugfh($debugfh);
541 ok $replicated->schema->resultset('Artist')->find(2)
542 => 'Fallback to master';
544 is $debug{storage_type}, 'MASTER',
545 "got last query from a master: $debug{dsn}";
547 like $fallback_warning, qr/falling back to master/
548 => 'emits falling back to master warning';
550 $replicated->schema->storage->debugfh($oldfh);
553 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
554 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
556 ## Silence warning about not supporting the is_replicating method if using the
558 $replicated->schema->storage->debugobj->silence(1)
559 if first { m{^t/} } @replicant_names;
561 $replicated->schema->storage->pool->validate_replicants;
563 $replicated->schema->storage->debugobj->silence(0);
565 ok $replicated->schema->resultset('Artist')->find(2)
566 => 'Returned to replicates';
568 is $debug{storage_type}, 'REPLICANT',
569 "got last query from a replicant: $debug{dsn}";
571 ## Getting slave status tests
574 ## We skip this tests unless you have a custom replicants, since the default
575 ## sqlite based replication tests don't support these functions.
577 skip 'Cannot Test Replicant Status on Non Replicating Database', 10
578 unless DBICTest->has_custom_dsn && $ENV{"DBICTEST_SLAVE0_DSN"};
580 $replicated->replicate; ## Give the slaves a chance to catchup.
582 ok $replicated->schema->storage->replicants->{$replicant_names[0]}->is_replicating
583 => 'Replicants are replicating';
585 is $replicated->schema->storage->replicants->{$replicant_names[0]}->lag_behind_master, 0
586 => 'Replicant is zero seconds behind master';
588 ## Test the validate replicants
590 $replicated->schema->storage->pool->validate_replicants;
592 is $replicated->schema->storage->pool->active_replicants, 2
593 => 'Still have 2 replicants after validation';
595 ## Force the replicants to fail the validate test by required their lag to
596 ## be negative (ie ahead of the master!)
598 $replicated->schema->storage->pool->maximum_lag(-10);
599 $replicated->schema->storage->pool->validate_replicants;
601 is $replicated->schema->storage->pool->active_replicants, 0
602 => 'No way a replicant be be ahead of the master';
604 ## Let's be fair to the replicants again. Let them lag up to 5
606 $replicated->schema->storage->pool->maximum_lag(5);
607 $replicated->schema->storage->pool->validate_replicants;
609 is $replicated->schema->storage->pool->active_replicants, 2
610 => 'Both replicants in good standing again';
612 ## Check auto validate
614 is $replicated->schema->storage->balancer->auto_validate_every, 100
615 => "Got the expected value for auto validate";
617 ## This will make sure we auto validatge everytime
618 $replicated->schema->storage->balancer->auto_validate_every(0);
620 ## set all the replicants to inactive, and make sure the balancer falls back to
623 $replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
624 $replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
626 ## Ok, now when we go to run a query, autovalidate SHOULD reconnect
628 is $replicated->schema->storage->pool->active_replicants => 0
629 => "both replicants turned off";
631 ok $replicated->schema->resultset('Artist')->find(5)
632 => 'replicant reactivated';
634 is $debug{storage_type}, 'REPLICANT',
635 "got last query from a replicant: $debug{dsn}";
637 is $replicated->schema->storage->pool->active_replicants => 2
638 => "both replicants reactivated";
641 ## Test the reliably callback
643 ok my $reliably = sub {
645 ok $replicated->schema->resultset('Artist')->find(5)
646 => 'replicant reactivated';
648 is $debug{storage_type}, 'MASTER',
649 "got last query from a master: $debug{dsn}";
651 } => 'created coderef properly';
653 $replicated->schema->storage->execute_reliably($reliably);
655 ## Try something with an error
657 ok my $unreliably = sub {
659 ok $replicated->schema->resultset('ArtistXX')->find(5)
660 => 'replicant reactivated';
662 } => 'created coderef properly';
664 throws_ok {$replicated->schema->storage->execute_reliably($unreliably)}
665 qr/Can't find source for ArtistXX/
666 => 'Bad coderef throws proper error';
668 ## Make sure replication came back
670 ok $replicated->schema->resultset('Artist')->find(3)
671 => 'replicant reactivated';
673 is $debug{storage_type}, 'REPLICANT', "got last query from a replicant: $debug{dsn}";
675 ## make sure transactions are set to execute_reliably
677 ok my $transaction = sub {
683 ->populate('Artist', [
684 [ qw/artistid name/ ],
685 [ $id, "Children of the Grave"],
688 ok my $result = $replicated->schema->resultset('Artist')->find($id)
689 => "Found expected artist for $id";
691 is $debug{storage_type}, 'MASTER',
692 "got last query from a master: $debug{dsn}";
694 ok my $more = $replicated->schema->resultset('Artist')->find(1)
695 => 'Found expected artist again for 1';
697 is $debug{storage_type}, 'MASTER',
698 "got last query from a master: $debug{dsn}";
700 return ($result, $more);
702 } => 'Created a coderef properly';
704 ## Test the transaction with multi return
706 ok my @return = $replicated->schema->txn_do($transaction, 666)
707 => 'did transaction';
709 is $return[0]->id, 666
710 => 'first returned value is correct';
712 is $debug{storage_type}, 'MASTER',
713 "got last query from a master: $debug{dsn}";
716 => 'second returned value is correct';
718 is $debug{storage_type}, 'MASTER',
719 "got last query from a master: $debug{dsn}";
723 ## Test that asking for single return works
725 ok my @return = $replicated->schema->txn_do($transaction, 777)
726 => 'did transaction';
728 is $return[0]->id, 777
729 => 'first returned value is correct';
732 => 'second returned value is correct';
735 ## Test transaction returning a single value
738 ok my $result = $replicated->schema->txn_do(sub {
739 ok my $more = $replicated->schema->resultset('Artist')->find(1)
740 => 'found inside a transaction';
741 is $debug{storage_type}, 'MASTER', "got last query from a master: $debug{dsn}";
743 }) => 'successfully processed transaction';
746 => 'Got expected single result from transaction';
749 ## Make sure replication came back
751 ok $replicated->schema->resultset('Artist')->find(1)
752 => 'replicant reactivated';
754 is $debug{storage_type}, 'REPLICANT', "got last query from a replicant: $debug{dsn}";
756 ## Test Discard changes
759 ok my $artist = $replicated->schema->resultset('Artist')->find(2)
760 => 'got an artist to test discard changes';
762 is $debug{storage_type}, 'REPLICANT', "got last query from a replicant: $debug{dsn}";
764 ok $artist->get_from_storage({force_pool=>'master'})
765 => 'properly discard changes';
767 is $debug{storage_type}, 'MASTER', "got last query from a master: $debug{dsn}";
771 ## Test some edge cases, like trying to do a transaction inside a transaction, etc
774 ok my $result = $replicated->schema->txn_do(sub {
775 return $replicated->schema->txn_do(sub {
776 ok my $more = $replicated->schema->resultset('Artist')->find(1)
777 => 'found inside a transaction inside a transaction';
778 is $debug{storage_type}, 'MASTER', "got last query from a master: $debug{dsn}";
781 }) => 'successfully processed transaction';
784 => 'Got expected single result from transaction';
788 ok my $result = $replicated->schema->txn_do(sub {
789 return $replicated->schema->storage->execute_reliably(sub {
790 return $replicated->schema->txn_do(sub {
791 return $replicated->schema->storage->execute_reliably(sub {
792 ok my $more = $replicated->schema->resultset('Artist')->find(1)
793 => 'found inside crazy deep transactions and execute_reliably';
794 is $debug{storage_type}, 'MASTER', "got last query from a master: $debug{dsn}";
799 }) => 'successfully processed transaction';
802 => 'Got expected single result from transaction';
805 ## Test the force_pool resultset attribute.
808 ok my $artist_rs = $replicated->schema->resultset('Artist')
809 => 'got artist resultset';
811 ## Turn on Forced Pool Storage
812 ok my $reliable_artist_rs = $artist_rs->search(undef, {force_pool=>'master'})
813 => 'Created a resultset using force_pool storage';
815 ok my $artist = $reliable_artist_rs->find(2)
816 => 'got an artist result via force_pool storage';
818 is $debug{storage_type}, 'MASTER', "got last query from a master: $debug{dsn}";
821 ## Test the force_pool resultset attribute part two.
824 ok my $artist_rs = $replicated->schema->resultset('Artist')
825 => 'got artist resultset';
827 ## Turn on Forced Pool Storage
828 ok my $reliable_artist_rs = $artist_rs->search(undef, {force_pool=>$replicant_names[0]})
829 => 'Created a resultset using force_pool storage';
831 ok my $artist = $reliable_artist_rs->find(2)
832 => 'got an artist result via force_pool storage';
834 is $debug{storage_type}, 'REPLICANT', "got last query from a replicant: $debug{dsn}";
836 ## Delete the old database files
837 $replicated->cleanup;