created storage method to execute a coderef using master storage only, changed tnx_do...
[dbsrgits/DBIx-Class.git] / t / 93storage_replication.t
CommitLineData
e4dc89b3 1use strict;
2use warnings;
3use lib qw(t/lib);
e4dc89b3 4use Test::More;
c4d3fae2 5use Test::Exception;
857d66ca 6use DBICTest;
8f7986d6 7
86583fa7 8BEGIN {
de5dc9ef 9 eval "use Moose; use Test::Moose";
86583fa7 10 plan $@
2bf79155 11 ? ( skip_all => 'needs Moose for testing' )
c4d3fae2 12 : ( tests => 57 );
26ab719a 13}
14
15use_ok 'DBIx::Class::Storage::DBI::Replicated::Pool';
16use_ok 'DBIx::Class::Storage::DBI::Replicated::Balancer';
17use_ok 'DBIx::Class::Storage::DBI::Replicated::Replicant';
18use_ok 'DBIx::Class::Storage::DBI::Replicated';
0f83441a 19
89cf6a70 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
0f83441a 32## ----------------------------------------------------------------------------
33## Build a class to hold all our required testing data and methods.
34## ----------------------------------------------------------------------------
35
857d66ca 36TESTSCHEMACLASSES: {
2bf79155 37
857d66ca 38 ## --------------------------------------------------------------------- ##
39 ## Create an object to contain your replicated stuff.
40 ## --------------------------------------------------------------------- ##
41
2bf79155 42 package DBIx::Class::DBI::Replicated::TestReplication;
43
44 use DBICTest;
45 use base qw/Class::Accessor::Fast/;
46
857d66ca 47 __PACKAGE__->mk_accessors( qw/schema/ );
2bf79155 48
49 ## Initialize the object
50
51 sub new {
26ab719a 52 my $class = shift @_;
53 my $self = $class->SUPER::new(@_);
2bf79155 54
55 $self->schema( $self->init_schema );
2bf79155 56 return $self;
57 }
58
26ab719a 59 ## Get the Schema and set the replication storage type
2bf79155 60
61 sub init_schema {
62 my $class = shift @_;
89cf6a70 63
cb6ec758 64 my $schema = DBICTest->init_schema(
161fb223 65 storage_type=>{
106d5f3b 66 '::DBI::Replicated' => {
67 balancer_type=>'::Random',
17b05c13 68 balancer_args=>{
69 auto_validate_every=>100,
70 },
89cf6a70 71 }
161fb223 72 },
89cf6a70 73 deploy_args=>{
74 add_drop_table => 1,
75 },
76 );
cb6ec758 77
2bf79155 78 return $schema;
79 }
26ab719a 80
857d66ca 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
26ab719a 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 {
857d66ca 118 my $self = shift @_;
26ab719a 119 my @dsn = map {
120 "dbi:SQLite:${_}";
121 } @{$self->slave_paths};
122
857d66ca 123 return map { [$_,'','',{AutoCommit=>1}] } @dsn;
26ab719a 124 }
125
126 ## Do a 'good enough' replication by copying the master dbfile over each of
50336325 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.
26ab719a 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 }
857d66ca 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 }
2bf79155 172}
173
174## ----------------------------------------------------------------------------
175## Create an object and run some tests
176## ----------------------------------------------------------------------------
177
26ab719a 178## Thi first bunch of tests are basic, just make sure all the bits are behaving
2bf79155 179
857d66ca 180my $replicated_class = DBICTest->has_custom_dsn ?
181 'DBIx::Class::DBI::Replicated::TestReplication::Custom' :
182 'DBIx::Class::DBI::Replicated::TestReplication::SQLite';
183
184ok my $replicated = $replicated_class->new
185 => 'Created a replication object';
2bf79155 186
26ab719a 187isa_ok $replicated->schema
2bf79155 188 => 'DBIx::Class::Schema';
189
26ab719a 190isa_ok $replicated->schema->storage
191 => 'DBIx::Class::Storage::DBI::Replicated';
192
193ok $replicated->schema->storage->meta
194 => 'has a meta object';
195
196isa_ok $replicated->schema->storage->master
197 => 'DBIx::Class::Storage::DBI';
198
199isa_ok $replicated->schema->storage->pool
200 => 'DBIx::Class::Storage::DBI::Replicated::Pool';
201
17b05c13 202does_ok $replicated->schema->storage->balancer
26ab719a 203 => 'DBIx::Class::Storage::DBI::Replicated::Balancer';
204
205ok my @replicant_connects = $replicated->generate_replicant_connect_info
206 => 'got replication connect information';
207
955a6df6 208ok my @replicated_storages = $replicated->schema->storage->connect_replicants(@replicant_connects)
26ab719a 209 => 'Created some storages suitable for replicants';
210
cb6ec758 211isa_ok $replicated->schema->storage->balancer->current_replicant
26ab719a 212 => 'DBIx::Class::Storage::DBI';
213
214ok $replicated->schema->storage->pool->has_replicants
215 => 'does have replicants';
216
17b05c13 217is $replicated->schema->storage->pool->num_replicants => 2
26ab719a 218 => 'has two replicants';
219
de5dc9ef 220does_ok $replicated_storages[0]
26ab719a 221 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
222
de5dc9ef 223does_ok $replicated_storages[1]
26ab719a 224 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
225
89cf6a70 226my @replicant_names = keys %{$replicated->schema->storage->replicants};
de5dc9ef 227
228does_ok $replicated->schema->storage->replicants->{$replicant_names[0]}
26ab719a 229 => 'DBIx::Class::Storage::DBI::Replicated::Replicant';
230
de5dc9ef 231does_ok $replicated->schema->storage->replicants->{$replicant_names[1]}
26ab719a 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
249ok my $artist1 = $replicated->schema->resultset('Artist')->find(4)
250 => 'Created Result';
251
252isa_ok $artist1
253 => 'DBICTest::Artist';
254
255is $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
89cf6a70 271SKIP: {
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}
26ab719a 284
285## Make sure all the slaves have the table definitions
286$replicated->replicate;
287
288## Should find some data now
289
290ok my $artist2 = $replicated->schema->resultset('Artist')->find(5)
291 => 'Sync succeed';
292
293isa_ok $artist2
294 => 'DBICTest::Artist';
295
296is $artist2->name, "Doom's Children"
297 => 'Found expected name for first result';
298
299## What happens when we disconnect all the replicants?
300
50336325 301is $replicated->schema->storage->pool->connected_replicants => 2
302 => "both replicants are connected";
303
89cf6a70 304$replicated->schema->storage->replicants->{$replicant_names[0]}->disconnect;
305$replicated->schema->storage->replicants->{$replicant_names[1]}->disconnect;
26ab719a 306
50336325 307is $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
26ab719a 312ok my $artist3 = $replicated->schema->resultset('Artist')->find(6)
313 => 'Still finding stuff.';
2bf79155 314
26ab719a 315isa_ok $artist3
316 => 'DBICTest::Artist';
2bf79155 317
26ab719a 318is $artist3->name, "Dead On Arrival"
319 => 'Found expected name for first result';
2bf79155 320
50336325 321is $replicated->schema->storage->pool->connected_replicants => 1
322 => "One replicant reconnected to handle the job";
6f6fb437 323
324## What happens when we try to select something that doesn't exist?
325
326ok ! $replicated->schema->resultset('Artist')->find(666)
327 => 'Correctly failed to find something.';
cb6ec758 328
329## test the reliable option
330
331TESTRELIABLE: {
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)
9c748388 344 => 'Read from replicant';
cb6ec758 345}
346
9c748388 347## Make sure when reliable goes out of scope, we are using replicants again
cb6ec758 348
349ok $replicated->schema->resultset('Artist')->find(1)
350 => 'back to replicant 1.';
351
352ok $replicated->schema->resultset('Artist')->find(2)
353 => 'back to replicant 2.';
2156bbdd 354
106d5f3b 355## set all the replicants to inactive, and make sure the balancer falls back to
356## the master.
357
89cf6a70 358$replicated->schema->storage->replicants->{$replicant_names[0]}->active(0);
359$replicated->schema->storage->replicants->{$replicant_names[1]}->active(0);
106d5f3b 360
361ok $replicated->schema->resultset('Artist')->find(2)
de5dc9ef 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
367ok $replicated->schema->resultset('Artist')->find(2)
368 => 'Returned to replicates';
369
370## Getting slave status tests
371
f797e89e 372SKIP: {
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
17b05c13 376 skip 'Cannot Test Replicant Status on Non Replicating Database', 9
f797e89e 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';
7edf5f1c 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';
17b05c13 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";
f797e89e 435}
436
c4d3fae2 437## Test the reliably callback
438
439ok 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
450ok my $unreliably = sub {
451
452 ok $replicated->schema->resultset('ArtistXX')->find(5)
453 => 'replicant reactivated';
454
455} => 'created coderef properly';
456
457throws_ok {$replicated->schema->storage->execute_reliably($unreliably)}
458 qr/coderef returned an error: Can't find source for ArtistXX/
459 => 'Bad coderef throws proper error';
460
461## make sure transactions are set to execute_reliably
462
463ok my $transaction = sub {
464
465 $replicated
466 ->schema
467 ->populate('Artist', [
468 [ qw/artistid name/ ],
469 [ 666, "Children of the Grave"],
470 ]);
471
472 ok my $result = $replicated->schema->resultset('Artist')->find(666);
473
474};
475
476$replicated->schema->txn_do($transaction);
477
478## Make sure replication came back
479
480ok $replicated->schema->resultset('Artist')->find(5)
481 => 'replicant reactivated';
482
0f83441a 483## Delete the old database files
50336325 484$replicated->cleanup;
0f83441a 485
486
487
488
489
490