::DBI:Replicated - merge connect_info from master to replicants
[dbsrgits/DBIx-Class.git] / t / 93storage_replication.t
index 2d1e58b..0f4b352 100644 (file)
@@ -2,13 +2,16 @@ use strict;
 use warnings;
 use lib qw(t/lib);
 use Test::More;
+use Test::Exception;
 use DBICTest;
+use List::Util 'first';
+use Scalar::Util 'reftype';
 
 BEGIN {
-    eval "use Moose";
+    eval "use DBIx::Class::Storage::DBI::Replicated; use Test::Moose";
     plan $@
-        ? ( skip_all => 'needs Moose for testing' )
-        : ( tests => 40 );
+        ? ( skip_all => "Deps not installed: $@" )
+        : ( tests => 83 );
 }
 
 use_ok 'DBIx::Class::Storage::DBI::Replicated::Pool';
@@ -16,6 +19,18 @@ 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.
 ## ----------------------------------------------------------------------------
@@ -46,13 +61,25 @@ TESTSCHEMACLASSES: {
     ## 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(
-            storage_type=>[
+            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;
     }
@@ -61,6 +88,26 @@ TESTSCHEMACLASSES: {
     sub replicate {}
     sub cleanup {}
 
+    ## --------------------------------------------------------------------- ##
+    ## Add a connect_info option to test option merging.
+    ## --------------------------------------------------------------------- ##
+    {
+    package DBIx::Class::Storage::DBI::Replicated;
+
+    use Moose;
+
+    __PACKAGE__->meta->make_mutable;
+
+    around connect_info => sub {
+      my ($next, $self, $info) = @_;
+      $info->[3]{master_option} = 1;
+      $self->$next($info);
+    };
+
+    __PACKAGE__->meta->make_immutable;
+
+    no Moose;
+    }
   
     ## --------------------------------------------------------------------- ##
     ## Subclass for when you are using SQLite for testing, this provides a fake
@@ -99,9 +146,20 @@ TESTSCHEMACLASSES: {
             "dbi:SQLite:${_}";
         } @{$self->slave_paths};
         
-        return map { [$_,'','',{AutoCommit=>1}] } @dsn;
+        my @connect_infos = map { [$_,'','',{AutoCommit=>1}] } @dsn;
+
+    # try a hashref too
+        my $c = $connect_infos[0];
+        $connect_infos[0] = {
+          dsn => $c->[0],
+          user => $c->[1],
+          password => $c->[2],
+          %{ $c->[3] }
+        };
+
+        @connect_infos
     }
-    
+
     ## Do a 'good enough' replication by copying the master dbfile over each of
     ## the slave dbfiles.  If the master is SQLite we do this, otherwise we
     ## just do a one second pause to let the slaves catch up.
@@ -178,7 +236,7 @@ isa_ok $replicated->schema->storage->master
 isa_ok $replicated->schema->storage->pool
     => 'DBIx::Class::Storage::DBI::Replicated::Pool';
     
-isa_ok $replicated->schema->storage->balancer
+does_ok $replicated->schema->storage->balancer
     => 'DBIx::Class::Storage::DBI::Replicated::Balancer'; 
 
 ok my @replicant_connects = $replicated->generate_replicant_connect_info
@@ -186,26 +244,52 @@ ok my @replicant_connects = $replicated->generate_replicant_connect_info
 
 ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
     => 'Created some storages suitable for replicants';
-    
+
+ok my @all_storages = $replicated->schema->storage->all_storages
+    => '->all_storages';
+
+is scalar @all_storages
+    ,3
+    => 'correct number of ->all_storages';
+
+is ((grep $_->isa('DBIx::Class::Storage::DBI'), @all_storages)
+    ,3
+    => '->all_storages are correct type');
+
+is ((grep $_->{master_option},
+      grep { (reftype($_)||'') eq 'HASH' }
+        map @{ $_->_connect_info }, @all_storages)
+    ,3
+    => 'connect_info was merged from master to replicants');
+my @replicant_names = keys %{ $replicated->schema->storage->replicants };
+
+## Silence warning about not supporting the is_replicating method if using the
+## sqlite dbs.
+$replicated->schema->storage->debugobj->silence(1)
+  if first { m{^t/} } @replicant_names;
+   
 isa_ok $replicated->schema->storage->balancer->current_replicant
-    => 'DBIx::Class::Storage::DBI';
-    
+    => 'DBIx::Class::Storage::DBI'; 
+
+$replicated->schema->storage->debugobj->silence(0);
+
 ok $replicated->schema->storage->pool->has_replicants
     => 'does have replicants';     
 
-is $replicated->schema->storage->num_replicants => 2
+is $replicated->schema->storage->pool->num_replicants => 2
     => 'has two replicants';
        
-isa_ok $replicated_storages[0]
+does_ok $replicated_storages[0]
     => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
 
-isa_ok $replicated_storages[1]
+does_ok $replicated_storages[1]
     => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
     
-isa_ok $replicated->schema->storage->replicants->{"t/var/DBIxClass_slave1.db"}
+does_ok $replicated->schema->storage->replicants->{$replicant_names[0]}
     => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
 
-isa_ok $replicated->schema->storage->replicants->{"t/var/DBIxClass_slave2.db"}
+does_ok $replicated->schema->storage->replicants->{$replicant_names[1]}
     => 'DBIx::Class::Storage::DBI::Replicated::Replicant';  
 
 ## Add some info to the database
@@ -220,6 +304,17 @@ $replicated
 ## Make sure all the slaves have the table definitions
 
 $replicated->replicate;
+$replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
+$replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
+
+## Silence warning about not supporting the is_replicating method if using the
+## sqlite dbs.
+$replicated->schema->storage->debugobj->silence(1)
+  if first { m{^t/} } @replicant_names;
+$replicated->schema->storage->pool->validate_replicants;
+
+$replicated->schema->storage->debugobj->silence(0);
 
 ## Make sure we can read the data.
 
@@ -245,12 +340,6 @@ $replicated
         [ 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;
 
@@ -270,8 +359,8 @@ is $artist2->name, "Doom's Children"
 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;
+$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";
@@ -288,7 +377,7 @@ 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";
+    => "At Least One replicant reconnected to handle the job";
     
 ## What happens when we try to select something that doesn't exist?
 
@@ -324,17 +413,245 @@ ok $replicated->schema->resultset('Artist')->find(2)
 ## set all the replicants to inactive, and make sure the balancer falls back to
 ## the master.
 
-$replicated->schema->storage->replicants->{"t/var/DBIxClass_slave1.db"}->active(0);
-$replicated->schema->storage->replicants->{"t/var/DBIxClass_slave2.db"}->active(0);
-    
+$replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
+$replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
+
+## Silence warning about falling back to master.
+$replicated->schema->storage->debugobj->silence(1);
 ok $replicated->schema->resultset('Artist')->find(2)
-    => 'Fallback to master'; 
-       
-## Delete the old database files
-$replicated->cleanup;
+    => 'Fallback to master';
 
+$replicated->schema->storage->debugobj->silence(0);
 
+$replicated->schema->storage->replicants->{$replicant_names[0]}->active(1);
+$replicated->schema->storage->replicants->{$replicant_names[1]}->active(1);
 
+## Silence warning about not supporting the is_replicating method if using the
+## sqlite dbs.
+$replicated->schema->storage->debugobj->silence(1)
+  if first { m{^t/} } @replicant_names;
+$replicated->schema->storage->pool->validate_replicants;
 
+$replicated->schema->storage->debugobj->silence(0);
 
+ok $replicated->schema->resultset('Artist')->find(2)
+    => 'Returned to replicates';
+    
+## Getting slave status tests
+
+SKIP: {
+    ## We skip this tests unless you have a custom replicants, since the default
+    ## sqlite based replication tests don't support these functions.
+    
+    skip 'Cannot Test Replicant Status on Non Replicating Database', 9
+     unless DBICTest->has_custom_dsn && $ENV{"DBICTEST_SLAVE0_DSN"};
+
+    $replicated->replicate; ## Give the slaves a chance to catchup.
 
+       ok $replicated->schema->storage->replicants->{$replicant_names[0]}->is_replicating
+           => 'Replicants are replicating';
+           
+       is $replicated->schema->storage->replicants->{$replicant_names[0]}->lag_behind_master, 0
+           => 'Replicant is zero seconds behind master';
+           
+       ## Test the validate replicants
+       
+       $replicated->schema->storage->pool->validate_replicants;
+       
+       is $replicated->schema->storage->pool->active_replicants, 2
+           => 'Still have 2 replicants after validation';
+           
+       ## Force the replicants to fail the validate test by required their lag to
+       ## be negative (ie ahead of the master!)
+       
+    $replicated->schema->storage->pool->maximum_lag(-10);
+    $replicated->schema->storage->pool->validate_replicants;
+    
+    is $replicated->schema->storage->pool->active_replicants, 0
+        => 'No way a replicant be be ahead of the master';
+        
+    ## Let's be fair to the replicants again.  Let them lag up to 5
+       
+    $replicated->schema->storage->pool->maximum_lag(5);
+    $replicated->schema->storage->pool->validate_replicants;
+    
+    is $replicated->schema->storage->pool->active_replicants, 2
+        => 'Both replicants in good standing again';   
+        
+       ## Check auto validate
+       
+       is $replicated->schema->storage->balancer->auto_validate_every, 100
+           => "Got the expected value for auto validate";
+           
+               ## This will make sure we auto validatge everytime
+               $replicated->schema->storage->balancer->auto_validate_every(0);
+               
+               ## set all the replicants to inactive, and make sure the balancer falls back to
+               ## the master.
+               
+               $replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
+               $replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
+               
+               ## Ok, now when we go to run a query, autovalidate SHOULD reconnect
+       
+       is $replicated->schema->storage->pool->active_replicants => 0
+           => "both replicants turned off";
+               
+       ok $replicated->schema->resultset('Artist')->find(5)
+           => 'replicant reactivated';
+           
+       is $replicated->schema->storage->pool->active_replicants => 2
+           => "both replicants reactivated";        
+}
+
+## Test the reliably callback
+
+ok my $reliably = sub {
+       
+    ok $replicated->schema->resultset('Artist')->find(5)
+        => 'replicant reactivated';    
+       
+} => 'created coderef properly';
+
+$replicated->schema->storage->execute_reliably($reliably);
+
+## Try something with an error
+
+ok my $unreliably = sub {
+    
+    ok $replicated->schema->resultset('ArtistXX')->find(5)
+        => 'replicant reactivated'; 
+    
+} => 'created coderef properly';
+
+throws_ok {$replicated->schema->storage->execute_reliably($unreliably)} 
+    qr/Can't find source for ArtistXX/
+    => 'Bad coderef throws proper error';
+    
+## Make sure replication came back
+
+ok $replicated->schema->resultset('Artist')->find(3)
+    => 'replicant reactivated';
+    
+## make sure transactions are set to execute_reliably
+
+ok my $transaction = sub {
+       
+       my $id = shift @_;
+       
+       $replicated
+           ->schema
+           ->populate('Artist', [
+               [ qw/artistid name/ ],
+               [ $id, "Children of the Grave"],
+           ]);
+           
+    ok my $result = $replicated->schema->resultset('Artist')->find($id)
+        => 'Found expected artist';
+        
+    ok my $more = $replicated->schema->resultset('Artist')->find(1)
+        => 'Found expected artist again';
+        
+   return ($result, $more);
+   
+} => 'Created a coderef properly';
+
+## Test the transaction with multi return
+{
+       ok my @return = $replicated->schema->txn_do($transaction, 666)
+           => 'did transaction';
+           
+           is $return[0]->id, 666
+               => 'first returned value is correct';
+               
+           is $return[1]->id, 1
+               => 'second returned value is correct';
+}
+
+## Test that asking for single return works
+{
+       ok my $return = $replicated->schema->txn_do($transaction, 777)
+           => 'did transaction';
+           
+           is $return->id, 777
+               => 'first returned value is correct';
+}
+
+## Test transaction returning a single value
+
+{
+       ok my $result = $replicated->schema->txn_do(sub {
+               ok my $more = $replicated->schema->resultset('Artist')->find(1)
+               => 'found inside a transaction';
+               return $more;
+       }) => 'successfully processed transaction';
+       
+       is $result->id, 1
+          => 'Got expected single result from transaction';
+}
+
+## Make sure replication came back
+
+ok $replicated->schema->resultset('Artist')->find(1)
+    => 'replicant reactivated';
+    
+## Test Discard changes
+
+{
+       ok my $artist = $replicated->schema->resultset('Artist')->find(2)
+           => 'got an artist to test discard changes';
+           
+       ok $artist->discard_changes
+          => 'properly discard changes';
+}
+
+## Test some edge cases, like trying to do a transaction inside a transaction, etc
+
+{
+    ok my $result = $replicated->schema->txn_do(sub {
+       return $replicated->schema->txn_do(sub {
+               ok my $more = $replicated->schema->resultset('Artist')->find(1)
+               => 'found inside a transaction inside a transaction';
+               return $more;                   
+       });
+    }) => 'successfully processed transaction';
+    
+    is $result->id, 1
+       => 'Got expected single result from transaction';         
+}
+
+{
+    ok my $result = $replicated->schema->txn_do(sub {
+       return $replicated->schema->storage->execute_reliably(sub {
+               return $replicated->schema->txn_do(sub {
+                       return $replicated->schema->storage->execute_reliably(sub {
+                               ok my $more = $replicated->schema->resultset('Artist')->find(1)
+                               => 'found inside crazy deep transactions and execute_reliably';
+                               return $more;                           
+                       });
+               });     
+       });
+    }) => 'successfully processed transaction';
+    
+    is $result->id, 1
+       => 'Got expected single result from transaction';         
+}     
+
+## Test the force_pool resultset attribute.
+
+{
+       ok my $artist_rs = $replicated->schema->resultset('Artist')
+        => 'got artist resultset';
+          
+       ## Turn on Forced Pool Storage
+       ok my $reliable_artist_rs = $artist_rs->search(undef, {force_pool=>'master'})
+        => 'Created a resultset using force_pool storage';
+          
+    ok my $artist = $reliable_artist_rs->find(2) 
+        => 'got an artist result via force_pool storage';
+}
+
+## Delete the old database files
+$replicated->cleanup;