t/93storage_replication.t

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