/
test_conf_change.rs
918 lines (756 loc) · 30.2 KB
/
test_conf_change.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
// Copyright 2016 TiKV Project Authors. Licensed under Apache-2.0.
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::Arc;
use std::thread;
use std::time::*;
use futures::Future;
use kvproto::metapb;
use kvproto::raft_cmdpb::{RaftCmdResponse, RaftResponseHeader};
use kvproto::raft_serverpb::*;
use raft::eraftpb::{ConfChangeType, MessageType};
use engine::*;
use test_raftstore::*;
use tikv::pd::PdClient;
use tikv::raftstore::store::*;
use tikv::raftstore::Result;
use tikv_util::config::ReadableDuration;
use tikv_util::HandyRwLock;
fn test_simple_conf_change<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
// Disable default max peer count check.
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
// Now region 1 only has peer (1, 1);
let (key, value) = (b"k1", b"v1");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
let engine_2 = cluster.get_engine(2);
must_get_none(&engine_2, b"k1");
// add peer (2,2) to region 1.
pd_client.must_add_peer(r1, new_peer(2, 2));
let (key, value) = (b"k2", b"v2");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
// now peer 2 must have v1 and v2;
must_get_equal(&engine_2, b"k1", b"v1");
must_get_equal(&engine_2, b"k2", b"v2");
let epoch = cluster.pd_client.get_region_epoch(r1);
// Conf version must change.
assert!(epoch.get_conf_ver() > 1);
// peer 5 must not exist
let engine_5 = cluster.get_engine(5);
must_get_none(&engine_5, b"k1");
// add peer (3, 3) to region 1.
pd_client.must_add_peer(r1, new_peer(3, 3));
// Remove peer (2, 2) from region 1.
pd_client.must_remove_peer(r1, new_peer(2, 2));
let (key, value) = (b"k3", b"v3");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
// now peer 3 must have v1, v2 and v3
let engine_3 = cluster.get_engine(3);
must_get_equal(&engine_3, b"k1", b"v1");
must_get_equal(&engine_3, b"k2", b"v2");
must_get_equal(&engine_3, b"k3", b"v3");
// peer 2 has nothing
must_get_none(&engine_2, b"k1");
must_get_none(&engine_2, b"k2");
// peer 3 must exist
must_get_equal(&engine_3, b"k3", b"v3");
// add peer 2 then remove it again.
pd_client.must_add_peer(r1, new_peer(2, 2));
// Force update a2 to check whether peer 2 added ok and received the snapshot.
let (key, value) = (b"k2", b"v2");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
let engine_2 = cluster.get_engine(2);
must_get_equal(&engine_2, b"k1", b"v1");
must_get_equal(&engine_2, b"k2", b"v2");
must_get_equal(&engine_2, b"k3", b"v3");
// Make sure peer 2 is not in probe mode.
cluster.must_put(b"k4", b"v4");
assert_eq!(cluster.get(b"k4"), Some(b"v4".to_vec()));
must_get_equal(&engine_2, b"k4", b"v4");
let resp = call_conf_change(cluster, r1, ConfChangeType::AddNode, new_peer(2, 2)).unwrap();
let exec_res = resp
.get_header()
.get_error()
.get_message()
.contains("duplicated");
assert!(
exec_res,
"add duplicated peer should failed, but got {:?}",
resp
);
// Remove peer (2, 2) from region 1.
pd_client.must_remove_peer(r1, new_peer(2, 2));
// add peer (2, 4) to region 1.
pd_client.must_add_peer(r1, new_peer(2, 4));
// Remove peer (3, 3) from region 1.
pd_client.must_remove_peer(r1, new_peer(3, 3));
let (key, value) = (b"k4", b"v4");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
// now peer 4 in store 2 must have v1, v2, v3, v4, we check v1 and v4 here.
let engine_2 = cluster.get_engine(2);
must_get_equal(&engine_2, b"k1", b"v1");
must_get_equal(&engine_2, b"k4", b"v4");
// peer 3 has nothing, we check v1 and v4 here.
must_get_none(&engine_3, b"k1");
must_get_none(&engine_3, b"k4");
// TODO: add more tests.
}
fn new_conf_change_peer(store: &metapb::Store, pd_client: &Arc<TestPdClient>) -> metapb::Peer {
let peer_id = pd_client.alloc_id().unwrap();
new_peer(store.get_id(), peer_id)
}
fn test_pd_conf_change<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
// Disable default max peer count check.
pd_client.disable_default_operator();
cluster.start().unwrap();
let region = &pd_client.get_region(b"").unwrap();
let region_id = region.get_id();
let mut stores = pd_client.get_stores().unwrap();
// Must have only one peer
assert_eq!(region.get_peers().len(), 1);
let peer = ®ion.get_peers()[0];
let i = stores
.iter()
.position(|store| store.get_id() == peer.get_store_id())
.unwrap();
stores.swap(0, i);
// Now the first store has first region. others have none.
let (key, value) = (b"k1", b"v1");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
let peer2 = new_conf_change_peer(&stores[1], &pd_client);
let engine_2 = cluster.get_engine(peer2.get_store_id());
assert!(engine_2
.get_value(&keys::data_key(b"k1"))
.unwrap()
.is_none());
// add new peer to first region.
pd_client.must_add_peer(region_id, peer2.clone());
let (key, value) = (b"k2", b"v2");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
// now peer 2 must have v1 and v2;
must_get_equal(&engine_2, b"k1", b"v1");
must_get_equal(&engine_2, b"k2", b"v2");
// add new peer to first region.
let peer3 = new_conf_change_peer(&stores[2], &pd_client);
pd_client.must_add_peer(region_id, peer3.clone());
// Remove peer2 from first region.
pd_client.must_remove_peer(region_id, peer2.clone());
let (key, value) = (b"k3", b"v3");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
// now peer 3 must have v1, v2 and v3
let engine_3 = cluster.get_engine(peer3.get_store_id());
must_get_equal(&engine_3, b"k1", b"v1");
must_get_equal(&engine_3, b"k2", b"v2");
must_get_equal(&engine_3, b"k3", b"v3");
// peer 2 has nothing
must_get_none(&engine_2, b"k1");
must_get_none(&engine_2, b"k2");
// add peer4 to first region 1.
let peer4 = new_conf_change_peer(&stores[1], &pd_client);
pd_client.must_add_peer(region_id, peer4.clone());
// Remove peer3 from first region.
pd_client.must_remove_peer(region_id, peer3.clone());
let (key, value) = (b"k4", b"v4");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
// now peer4 must have v1, v2, v3, v4, we check v1 and v4 here.
let engine_2 = cluster.get_engine(peer4.get_store_id());
must_get_equal(&engine_2, b"k1", b"v1");
must_get_equal(&engine_2, b"k4", b"v4");
// peer 3 has nothing, we check v1 and v4 here.
must_get_none(&engine_3, b"k1");
must_get_none(&engine_3, b"k4");
// TODO: add more tests.
}
#[test]
fn test_server_simple_conf_change() {
let count = 5;
let mut cluster = new_server_cluster(0, count);
test_simple_conf_change(&mut cluster);
}
#[test]
fn test_node_pd_conf_change() {
let count = 5;
let mut cluster = new_node_cluster(0, count);
test_pd_conf_change(&mut cluster);
}
#[test]
fn test_server_pd_conf_change() {
let count = 5;
let mut cluster = new_server_cluster(0, count);
test_pd_conf_change(&mut cluster);
}
fn wait_till_reach_count(pd_client: Arc<TestPdClient>, region_id: u64, c: usize) {
let mut replica_count = 0;
for _ in 0..1000 {
let region = match pd_client.get_region_by_id(region_id).wait().unwrap() {
Some(r) => r,
None => continue,
};
replica_count = region.get_peers().len();
if replica_count == c {
return;
}
thread::sleep(Duration::from_millis(10));
}
panic!(
"replica count {} still not meet {} after 10 secs",
replica_count, c
);
}
fn test_auto_adjust_replica<T: Simulator>(cluster: &mut Cluster<T>) {
cluster.start().unwrap();
let pd_client = Arc::clone(&cluster.pd_client);
let mut region = pd_client.get_region(b"").unwrap();
let region_id = region.get_id();
let stores = pd_client.get_stores().unwrap();
// default replica is 5.
wait_till_reach_count(Arc::clone(&pd_client), region_id, 5);
let (key, value) = (b"k1", b"v1");
cluster.must_put(key, value);
assert_eq!(cluster.get(key), Some(value.to_vec()));
region = pd_client
.get_region_by_id(region_id)
.wait()
.unwrap()
.unwrap();
let i = stores
.iter()
.position(|s| {
region
.get_peers()
.iter()
.all(|p| s.get_id() != p.get_store_id())
})
.unwrap();
let peer = new_conf_change_peer(&stores[i], &pd_client);
let engine = cluster.get_engine(peer.get_store_id());
must_get_none(&engine, b"k1");
pd_client.must_add_peer(region_id, peer.clone());
wait_till_reach_count(Arc::clone(&pd_client), region_id, 6);
// it should remove extra replica.
pd_client.enable_default_operator();
wait_till_reach_count(Arc::clone(&pd_client), region_id, 5);
region = pd_client
.get_region_by_id(region_id)
.wait()
.unwrap()
.unwrap();
let peer = region.get_peers().get(1).unwrap().clone();
pd_client.must_remove_peer(region_id, peer);
wait_till_reach_count(Arc::clone(&pd_client), region_id, 4);
// it should add missing replica.
pd_client.enable_default_operator();
wait_till_reach_count(Arc::clone(&pd_client), region_id, 5);
}
#[test]
fn test_node_auto_adjust_replica() {
let count = 7;
let mut cluster = new_node_cluster(0, count);
test_auto_adjust_replica(&mut cluster);
}
#[test]
fn test_server_auto_adjust_replica() {
let count = 7;
let mut cluster = new_server_cluster(0, count);
test_auto_adjust_replica(&mut cluster);
}
fn test_after_remove_itself<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
// Disable default max peer count check.
pd_client.disable_default_operator();
// disable auto compact log.
cluster.cfg.raft_store.raft_log_gc_threshold = 10000;
let r1 = cluster.run_conf_change();
pd_client.must_add_peer(r1, new_peer(2, 2));
pd_client.must_add_peer(r1, new_peer(3, 3));
// 1, stop node 2
// 2, add data to guarantee leader has more logs
// 3, stop node 3
// 4, remove leader itself and force compact log
// 5, start node 2 again, so that we can commit log and apply.
// For this scenario, peer 1 will do remove itself and then compact log
// in the same ready result loop.
cluster.stop_node(2);
cluster.must_put(b"k1", b"v1");
let engine1 = cluster.get_engine(1);
let engine3 = cluster.get_engine(3);
must_get_equal(&engine1, b"k1", b"v1");
must_get_equal(&engine3, b"k1", b"v1");
cluster.stop_node(3);
pd_client.remove_peer(1, new_peer(1, 1));
let epoch = cluster
.pd_client
.get_region_by_id(1)
.wait()
.unwrap()
.unwrap()
.take_region_epoch();
let put = new_put_cmd(b"test_key", b"test_val");
let mut req = new_request(1, epoch, vec![put], true);
req.mut_header().set_peer(new_peer(1, 1));
// ignore error, we just want to send this command to peer (1, 1),
// and the command can't be executed because we have only one peer,
// so here will return timeout error, we should ignore it.
let _ = cluster.call_command(req, Duration::from_millis(1));
cluster.run_node(2).unwrap();
cluster.run_node(3).unwrap();
for _ in 0..250 {
let region: RegionLocalState = engine1
.get_msg_cf(CF_RAFT, &keys::region_state_key(r1))
.unwrap()
.unwrap();
if region.get_state() == PeerState::Tombstone {
return;
}
sleep_ms(20);
}
let region: RegionLocalState = engine1
.get_msg_cf(CF_RAFT, &keys::region_state_key(r1))
.unwrap()
.unwrap();
assert_eq!(region.get_state(), PeerState::Tombstone);
// TODO: add split after removing itself test later.
}
#[test]
fn test_node_after_remove_itself() {
let count = 3;
let mut cluster = new_node_cluster(0, count);
test_after_remove_itself(&mut cluster);
}
#[test]
fn test_server_after_remove_itself() {
let count = 3;
let mut cluster = new_server_cluster(0, count);
test_after_remove_itself(&mut cluster);
}
fn test_split_brain<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
// Disable default max peer number check.
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
pd_client.must_add_peer(r1, new_peer(2, 2));
pd_client.must_add_peer(r1, new_peer(3, 3));
// leader isolation
cluster.must_transfer_leader(r1, new_peer(2, 2));
cluster.add_send_filter(IsolationFilterFactory::new(1));
// refresh region info, maybe no need
cluster.must_put(b"k1", b"v1");
// add [4,5,6] and remove [2,3]
pd_client.must_add_peer(r1, new_peer(4, 4));
must_get_equal(&cluster.get_engine(4), b"k1", b"v1");
pd_client.must_add_peer(r1, new_peer(5, 5));
must_get_equal(&cluster.get_engine(5), b"k1", b"v1");
pd_client.must_add_peer(r1, new_peer(6, 6));
must_get_equal(&cluster.get_engine(6), b"k1", b"v1");
cluster.must_transfer_leader(r1, new_peer(6, 6));
pd_client.must_remove_peer(r1, new_peer(2, 2));
pd_client.must_remove_peer(r1, new_peer(3, 3));
cluster.must_put(b"k2", b"v2");
must_get_equal(&cluster.get_engine(6), b"k2", b"v2");
let region_detail = cluster.region_detail(r1, 1);
let region_peers = region_detail.get_region().get_peers();
assert_eq!(region_peers.len(), 3);
for peer in region_peers {
assert!(peer.get_id() < 4);
}
assert!(region_detail.get_leader().get_id() < 4);
// when network recovers, 1 will send request vote to [2,3]
cluster.clear_send_filters();
cluster.partition(vec![1, 2, 3], vec![4, 5, 6]);
// refresh region info, maybe no need
cluster.must_put(b"k3", b"v3");
// check whether a new cluster [1,2,3] is formed
// if so, both [1,2,3] and [4,5,6] think they serve for region r1
// result in split brain
let header0 = find_leader_response_header(cluster, r1, new_peer(2, 2));
assert!(header0.get_error().has_region_not_found());
// at least wait for a round of election timeout and check again
let base_tick = cluster.cfg.raft_store.raft_base_tick_interval.0;
let election_timeout = base_tick * cluster.cfg.raft_store.raft_election_timeout_ticks as u32;
thread::sleep(election_timeout * 2);
let header1 = find_leader_response_header(cluster, r1, new_peer(2, 2));
assert!(header1.get_error().has_region_not_found());
}
fn find_leader_response_header<T: Simulator>(
cluster: &mut Cluster<T>,
region_id: u64,
peer: metapb::Peer,
) -> RaftResponseHeader {
let find_leader = new_status_request(region_id, peer, new_region_leader_cmd());
let resp = cluster.call_command(find_leader, Duration::from_secs(5));
resp.unwrap().take_header()
}
#[test]
fn test_server_split_brain() {
let count = 6;
let mut cluster = new_server_cluster(0, count);
test_split_brain(&mut cluster);
}
#[test]
fn test_node_split_brain() {
let count = 6;
let mut cluster = new_node_cluster(0, count);
test_split_brain(&mut cluster);
}
/// A helper function for testing the conf change is safe.
fn test_conf_change_safe<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
// Disable default max peer count check.
pd_client.disable_default_operator();
let region_id = cluster.run_conf_change();
// Test adding nodes.
// Ensure it works to add one node to a cluster that has only one node.
pd_client.must_add_peer(region_id, new_peer(2, 2));
pd_client.must_add_peer(region_id, new_peer(3, 3));
// Isolate the leader.
cluster.must_transfer_leader(region_id, new_peer(1, 1));
cluster.add_send_filter(IsolationFilterFactory::new(1));
// Ensure new leader is elected and it works.
cluster.must_put(b"k1", b"v1");
// Ensure the conf change is safe:
// The "AddNode" request will be rejected
// if there are only 2 healthy nodes in a cluster of 3 nodes.
pd_client.add_peer(region_id, new_peer(4, 4));
// Put a new kv to ensure the previous "AddNode" is handled.
cluster.must_put(b"k2", b"v2");
pd_client.must_none_peer(region_id, new_peer(4, 4));
// Recover the isolated peer.
cluster.clear_send_filters();
// Then new node could be added.
pd_client.must_add_peer(region_id, new_peer(4, 4));
// Test removing nodes.
// Ensure nodes could be removed.
pd_client.must_remove_peer(region_id, new_peer(4, 4));
// Isolate the leader.
cluster.must_transfer_leader(region_id, new_peer(1, 1));
cluster.add_send_filter(IsolationFilterFactory::new(1));
// Ensure new leader is elected and it works.
cluster.must_put(b"k3", b"v3");
// Ensure the conf change is safe:
// The "RemoveNode" request which asks to remove one healthy node will be rejected
// if there are only 2 healthy nodes in a cluster of 3 nodes.
pd_client.remove_peer(region_id, new_peer(2, 2));
cluster.must_put(b"k4", b"v4");
pd_client.must_have_peer(region_id, new_peer(2, 2));
// In this case, it's fine to remove one unhealthy node.
pd_client.must_remove_peer(region_id, new_peer(1, 1));
// Ensure it works to remove one node from the cluster that has only two healthy nodes.
pd_client.must_remove_peer(region_id, new_peer(2, 2));
}
fn test_transfer_leader_safe<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
// Disable default max peer count check.
pd_client.disable_default_operator();
let region_id = cluster.run_conf_change();
let cfg = cluster.cfg.clone();
// Test adding nodes.
pd_client.must_add_peer(region_id, new_peer(2, 2));
pd_client.must_add_peer(region_id, new_peer(3, 3));
// transfer to all followers
let mut leader_id = cluster.leader_of_region(region_id).unwrap().get_id();
for peer in cluster.get_region(b"").get_peers() {
if peer.get_id() == leader_id {
continue;
}
cluster.transfer_leader(region_id, peer.clone());
cluster.reset_leader_of_region(region_id);
assert_ne!(
cluster.leader_of_region(region_id).unwrap().get_id(),
peer.get_id()
);
}
// Test transfer leader after a safe duration.
thread::sleep(cfg.raft_store.raft_reject_transfer_leader_duration.into());
assert_eq!(
cluster.leader_of_region(region_id).unwrap().get_id(),
leader_id
);
cluster.transfer_leader(region_id, new_peer(3, 3));
// Retry for more stability
for _ in 0..20 {
cluster.reset_leader_of_region(region_id);
if cluster.leader_of_region(region_id) != Some(new_peer(3, 3)) {
continue;
}
break;
}
assert_eq!(cluster.leader_of_region(region_id).unwrap().get_id(), 3);
leader_id = 3;
// Cannot transfer when removed peer
pd_client.must_remove_peer(region_id, new_peer(2, 2));
for peer in cluster.get_region(b"").get_peers() {
if peer.get_id() == leader_id {
continue;
}
cluster.transfer_leader(region_id, peer.clone());
cluster.reset_leader_of_region(region_id);
assert_ne!(
cluster.leader_of_region(region_id).unwrap().get_id(),
peer.get_id()
);
}
}
fn test_learner_conf_change<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
cluster.must_put(b"k1", b"v1");
assert_eq!(cluster.get(b"k1"), Some(b"v1".to_vec()));
// Add voter (2, 2) to region 1.
pd_client.must_add_peer(r1, new_peer(2, 2));
// Add learner (4, 10) to region 1.
let engine_4 = cluster.get_engine(4);
pd_client.must_add_peer(r1, new_learner_peer(4, 10));
cluster.must_put(b"k2", b"v2");
must_get_equal(&engine_4, b"k1", b"v1");
must_get_equal(&engine_4, b"k2", b"v2");
// Can't add duplicate learner.
let resp = call_conf_change(
cluster,
r1,
ConfChangeType::AddLearnerNode,
new_learner_peer(4, 11),
)
.unwrap();
let err_msg = resp.get_header().get_error().get_message();
assert!(err_msg.contains("duplicated"), "{:?}", resp);
// Remove learner (4, 10) from region 1.
pd_client.must_remove_peer(r1, new_learner_peer(4, 10));
must_get_none(&engine_4, b"k2"); // Wait for the region is cleaned.
pd_client.must_add_peer(r1, new_learner_peer(4, 12));
must_get_equal(&engine_4, b"k2", b"v2");
// Can't transfer leader to learner.
pd_client.transfer_leader(r1, new_learner_peer(4, 12));
cluster.must_put(b"k3", b"v3");
must_get_equal(&cluster.get_engine(4), b"k3", b"v3");
pd_client.region_leader_must_be(r1, new_peer(1, 1));
// Promote learner (4, 12) to voter.
pd_client.must_add_peer(r1, new_peer(4, 12));
pd_client.must_none_pending_peer(new_peer(4, 12));
cluster.must_put(b"k3", b"v3");
must_get_equal(&engine_4, b"k3", b"v3");
// Transfer leader to (4, 12) and check pd heartbeats from it to ensure
// that `Peer::peer` has be updated correctly after the peer is promoted.
pd_client.transfer_leader(r1, new_peer(4, 12));
pd_client.region_leader_must_be(r1, new_peer(4, 12));
// Transfer leader to (1, 1) to avoid "region not found".
pd_client.transfer_leader(r1, new_peer(1, 1));
pd_client.region_leader_must_be(r1, new_peer(1, 1));
// To avoid using stale leader.
cluster.reset_leader_of_region(r1);
// Put a new kv to ensure leader has applied to newest log, so that to avoid
// false warning about pending conf change.
cluster.must_put(b"k4", b"v4");
let mut add_peer = |peer: metapb::Peer| {
let conf_type = if peer.get_is_learner() {
ConfChangeType::AddLearnerNode
} else {
ConfChangeType::AddNode
};
call_conf_change(cluster, r1, conf_type, peer).unwrap()
};
// Add learner on store which already has peer.
let resp = add_peer(new_learner_peer(4, 13));
let err_msg = resp.get_header().get_error().get_message();
assert!(err_msg.contains("duplicated"), "{:?}", err_msg);
pd_client.must_have_peer(r1, new_peer(4, 12));
// Add peer with different id on store which already has learner.
pd_client.must_remove_peer(r1, new_peer(4, 12));
pd_client.must_add_peer(r1, new_learner_peer(4, 13));
let resp = add_peer(new_learner_peer(4, 14));
let err_msg = resp.get_header().get_error().get_message();
assert!(err_msg.contains("duplicated"), "{:?}", resp);
pd_client.must_none_peer(r1, new_learner_peer(4, 14));
let resp = add_peer(new_peer(4, 15));
let err_msg = resp.get_header().get_error().get_message();
assert!(err_msg.contains("duplicated"), "{:?}", resp);
pd_client.must_none_peer(r1, new_peer(4, 15));
}
#[test]
fn test_node_conf_change_safe() {
let count = 5;
let mut cluster = new_node_cluster(0, count);
test_conf_change_safe(&mut cluster);
}
#[test]
fn test_server_safe_conf_change() {
let count = 5;
let mut cluster = new_server_cluster(0, count);
test_conf_change_safe(&mut cluster);
}
#[test]
fn test_server_transfer_leader_safe() {
let count = 5;
let mut cluster = new_server_cluster(0, count);
configure_for_transfer_leader(&mut cluster);
test_transfer_leader_safe(&mut cluster);
}
#[test]
fn test_conf_change_remove_leader() {
let mut cluster = new_node_cluster(0, 3);
cluster.cfg.raft_store.allow_remove_leader = false;
let pd_client = Arc::clone(&cluster.pd_client);
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
pd_client.must_add_peer(r1, new_peer(2, 2));
pd_client.must_add_peer(r1, new_peer(3, 3));
// Transfer leader to the first peer.
cluster.must_transfer_leader(r1, new_peer(1, 1));
// Put a new kv to ensure leader has applied to newest log, so that to avoid
// false warning about pending conf change.
cluster.must_put(b"k1", b"v1");
// Try to remove leader, which should be ignored.
let res =
call_conf_change(&mut cluster, r1, ConfChangeType::RemoveNode, new_peer(1, 1)).unwrap();
assert!(
res.get_header()
.get_error()
.get_message()
.contains("ignore remove leader"),
"{:?}",
res
);
}
#[test]
fn test_node_learner_conf_change() {
let count = 5;
let mut cluster = new_node_cluster(0, count);
test_learner_conf_change(&mut cluster);
}
#[test]
fn test_learner_with_slow_snapshot() {
let mut cluster = new_server_cluster(0, 3);
configure_for_snapshot(&mut cluster);
let pd_client = Arc::clone(&cluster.pd_client);
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
(0..10).for_each(|_| cluster.must_put(b"k1", b"v1"));
struct SnapshotFilter {
count: Arc<AtomicUsize>,
filter: Arc<AtomicBool>,
}
impl Filter for SnapshotFilter {
fn before(&self, msgs: &mut Vec<RaftMessage>) -> Result<()> {
let count = msgs
.iter()
.filter(|m| {
// A snapshot stream should have 2 chunks at least,
// the first for metadata and subsequences for data.
m.get_message().get_msg_type() == MessageType::MsgSnapshot
&& m.get_message().get_snapshot().has_metadata()
})
.count();
self.count.fetch_add(count, Ordering::SeqCst);
if self.filter.load(Ordering::SeqCst) {
let old_len = msgs.len();
msgs.retain(|m| m.get_message().get_msg_type() != MessageType::MsgSnapshot);
if msgs.len() < old_len {
return Err(box_err!("send snapshot fail"));
}
}
Ok(())
}
}
let count = Arc::new(AtomicUsize::new(0));
let filter = Arc::new(AtomicBool::new(true));
let snap_filter = Box::new(SnapshotFilter {
count: Arc::clone(&count),
filter: Arc::clone(&filter),
});
// New added learner should keep pending until snapshot is applied.
cluster.sim.wl().add_send_filter(1, snap_filter);
pd_client.must_add_peer(r1, new_learner_peer(2, 2));
for _ in 0..500 {
sleep_ms(10);
if count.load(Ordering::SeqCst) > 0 {
break;
}
}
assert!(count.load(Ordering::SeqCst) > 0);
assert_eq!(pd_client.get_pending_peers()[&2], new_learner_peer(2, 2));
// Clear snapshot filter and promote peer 2 to voter.
filter.store(false, Ordering::SeqCst);
must_get_equal(&cluster.get_engine(2), b"k1", b"v1");
pd_client.must_add_peer(r1, new_peer(2, 2));
// Add a learner peer and test promoting it with snapshot instead of proposal.
pd_client.must_add_peer(r1, new_learner_peer(3, 3));
must_get_equal(&cluster.get_engine(3), b"k1", b"v1");
cluster.stop_node(3);
pd_client.must_add_peer(r1, new_peer(3, 3));
// Ensure raftstore will gc all applied raft logs.
(0..30).for_each(|_| cluster.must_put(b"k2", b"v2"));
// peer 3 will be promoted by snapshot instead of normal proposal.
count.store(0, Ordering::SeqCst);
cluster.run_node(3).unwrap();
must_get_equal(&cluster.get_engine(3), b"k2", b"v2");
// Transfer leader so that peer 3 can report to pd with `Peer` in memory.
pd_client.transfer_leader(r1, new_peer(3, 3));
pd_client.region_leader_must_be(r1, new_peer(3, 3));
assert!(count.load(Ordering::SeqCst) > 0);
}
fn test_stale_peer<T: Simulator>(cluster: &mut Cluster<T>) {
let pd_client = Arc::clone(&cluster.pd_client);
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
cluster.must_put(b"k1", b"v1");
pd_client.must_add_peer(r1, new_peer(2, 2));
pd_client.must_add_peer(r1, new_peer(3, 3));
must_get_equal(&cluster.get_engine(3), b"k1", b"v1");
// replace peer 3 with peer 4 while peer 3 is isolated.
cluster.add_send_filter(IsolationFilterFactory::new(3));
pd_client.must_remove_peer(r1, new_peer(3, 3));
pd_client.must_add_peer(r1, new_peer(4, 4));
must_get_equal(&cluster.get_engine(4), b"k1", b"v1");
// After the peer gets back to the cluster, it knows it's removed.
cluster.clear_send_filters();
must_get_none(&cluster.get_engine(3), b"k1");
}
#[test]
fn test_node_stale_peer() {
let mut cluster = new_node_cluster(0, 4);
// To avoid stale peers know they are stale from PD.
cluster.cfg.raft_store.max_leader_missing_duration = ReadableDuration::hours(2);
test_stale_peer(&mut cluster);
}
fn call_conf_change<T>(
cluster: &mut Cluster<T>,
region_id: u64,
conf_change_type: ConfChangeType,
peer: metapb::Peer,
) -> Result<RaftCmdResponse>
where
T: Simulator,
{
let conf_change = new_change_peer_request(conf_change_type, peer);
let epoch = cluster.pd_client.get_region_epoch(region_id);
let admin_req = new_admin_request(region_id, &epoch, conf_change);
cluster.call_command_on_leader(admin_req, Duration::from_secs(3))
}
/// Tests if conf change relies on heartbeat.
#[test]
fn test_conf_change_fast() {
let mut cluster = new_server_cluster(0, 3);
// Sets heartbeat timeout to more than 5 seconds. It also changes the election timeout,
// but it's OK as the cluster starts with only one peer, it will campaigns immediately.
configure_for_lease_read(&mut cluster, Some(5000), None);
let pd_client = Arc::clone(&cluster.pd_client);
pd_client.disable_default_operator();
let r1 = cluster.run_conf_change();
cluster.must_put(b"k1", b"v1");
let timer = Instant::now();
// If conf change relies on heartbeat, it will take more than 5 seconds to finish,
// hence it must timeout.
pd_client.must_add_peer(r1, new_peer(2, 2));
must_get_equal(&cluster.get_engine(2), b"k1", b"v1");
assert!(timer.elapsed() < Duration::from_secs(5));
}