1 package org.opendaylight.controller.cluster.datastore;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertFalse;
5 import static org.junit.Assert.assertTrue;
6 import static org.mockito.Mockito.mock;
7 import static org.mockito.Mockito.never;
8 import static org.mockito.Mockito.times;
9 import static org.mockito.Mockito.verify;
10 import static org.mockito.Mockito.when;
11 import akka.actor.ActorRef;
12 import akka.actor.Props;
13 import akka.japi.Creator;
14 import akka.pattern.Patterns;
15 import akka.persistence.RecoveryCompleted;
16 import akka.testkit.JavaTestKit;
17 import akka.testkit.TestActorRef;
18 import akka.util.Timeout;
19 import com.google.common.collect.ImmutableSet;
20 import com.google.common.collect.Sets;
21 import com.google.common.util.concurrent.Uninterruptibles;
23 import java.util.Arrays;
24 import java.util.Collection;
25 import java.util.HashSet;
26 import java.util.List;
29 import java.util.concurrent.CountDownLatch;
30 import java.util.concurrent.TimeUnit;
31 import org.junit.After;
32 import org.junit.Before;
33 import org.junit.Test;
34 import org.mockito.Mock;
35 import org.mockito.MockitoAnnotations;
36 import org.opendaylight.controller.cluster.DataPersistenceProvider;
37 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
38 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
39 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
40 import org.opendaylight.controller.cluster.datastore.messages.ActorNotInitialized;
41 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
42 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
43 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
44 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
45 import org.opendaylight.controller.cluster.datastore.messages.PrimaryFound;
46 import org.opendaylight.controller.cluster.datastore.messages.PrimaryNotFound;
47 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
48 import org.opendaylight.controller.cluster.datastore.utils.MessageCollectorActor;
49 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
50 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
51 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
52 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
53 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
54 import org.opendaylight.controller.cluster.raft.RaftState;
55 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
56 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
57 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
58 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
59 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
60 import scala.concurrent.Await;
61 import scala.concurrent.Future;
62 import scala.concurrent.duration.FiniteDuration;
64 public class ShardManagerTest extends AbstractActorTest {
65 private static int ID_COUNTER = 1;
67 private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
68 private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix;
71 private static CountDownLatch ready;
73 private static TestActorRef<MessageCollectorActor> mockShardActor;
75 private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
76 dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS);
80 MockitoAnnotations.initMocks(this);
82 InMemoryJournal.clear();
84 if(mockShardActor == null) {
85 String name = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
86 mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), name);
89 mockShardActor.underlyingActor().clear();
93 public void tearDown() {
94 InMemoryJournal.clear();
97 private Props newShardMgrProps() {
98 return ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
99 datastoreContextBuilder.build(), ready);
102 private Props newPropsShardMgrWithMockShardActor() {
103 Creator<ShardManager> creator = new Creator<ShardManager>() {
104 private static final long serialVersionUID = 1L;
106 public ShardManager create() throws Exception {
107 return new ShardManager(new MockClusterWrapper(), new MockConfiguration(),
108 datastoreContextBuilder.build(), ready) {
110 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
111 return mockShardActor;
117 return Props.create(new DelegatingShardManagerCreator(creator));
121 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
122 new JavaTestKit(getSystem()) {{
123 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
125 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
127 shardManager.tell(new FindPrimary("non-existent", false).toSerializable(), getRef());
129 expectMsgEquals(duration("5 seconds"), new PrimaryNotFound("non-existent").toSerializable());
134 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
135 new JavaTestKit(getSystem()) {{
136 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
138 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
140 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
141 shardManager.tell(new ActorInitialized(), mockShardActor);
143 shardManager.tell(new LeaderStateChanged(memberId, memberId), getRef());
145 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
146 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
147 RaftState.Leader.name())), mockShardActor);
149 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef());
151 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS);
152 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
153 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
158 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
159 new JavaTestKit(getSystem()) {{
160 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
162 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
163 shardManager.tell(new ActorInitialized(), mockShardActor);
165 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
166 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
168 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
169 shardManager.tell(new RoleChangeNotification(memberId1,
170 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
171 shardManager.tell(new LeaderStateChanged(memberId1, memberId2), mockShardActor);
173 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef());
175 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS);
176 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
177 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
182 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
183 new JavaTestKit(getSystem()) {{
184 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
186 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef());
188 expectMsgClass(duration("5 seconds"), ActorNotInitialized.class);
193 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
194 new JavaTestKit(getSystem()) {{
195 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
197 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
198 shardManager.tell(new ActorInitialized(), mockShardActor);
200 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef());
202 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
207 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
208 new JavaTestKit(getSystem()) {{
209 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
211 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
212 shardManager.tell(new ActorInitialized(), mockShardActor);
214 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
215 shardManager.tell(new RoleChangeNotification(memberId,
216 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
218 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef());
220 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
222 shardManager.tell(new LeaderStateChanged(memberId, memberId), mockShardActor);
224 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false).toSerializable(), getRef());
226 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS);
227 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
228 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
233 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
234 new JavaTestKit(getSystem()) {{
235 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
237 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
239 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
240 // delayed until we send ActorInitialized and RoleChangeNotification.
241 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true).toSerializable(), getRef());
243 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
245 shardManager.tell(new ActorInitialized(), mockShardActor);
247 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
249 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
250 shardManager.tell(new RoleChangeNotification(memberId,
251 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
253 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
255 shardManager.tell(new LeaderStateChanged(memberId, memberId), mockShardActor);
257 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS);
258 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
259 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
261 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
266 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
267 new JavaTestKit(getSystem()) {{
268 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
270 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
272 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true).toSerializable(), getRef());
274 expectMsgClass(duration("2 seconds"), ActorNotInitialized.class);
276 shardManager.tell(new ActorInitialized(), mockShardActor);
278 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
283 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
284 new JavaTestKit(getSystem()) {{
285 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
287 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
288 shardManager.tell(new ActorInitialized(), mockShardActor);
289 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
290 null, RaftState.Candidate.name()), mockShardActor);
292 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true).toSerializable(), getRef());
294 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
299 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
300 new JavaTestKit(getSystem()) {{
301 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
303 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
304 shardManager.tell(new ActorInitialized(), mockShardActor);
306 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true).toSerializable(), getRef());
308 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
313 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
314 new JavaTestKit(getSystem()) {{
315 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
317 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
319 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
321 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
323 assertEquals("getShardName", "non-existent", notFound.getShardName());
328 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
329 new JavaTestKit(getSystem()) {{
330 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
332 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
333 shardManager.tell(new ActorInitialized(), mockShardActor);
335 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
337 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
339 assertTrue("Found path contains " + found.getPath().path().toString(),
340 found.getPath().path().toString().contains("member-1-shard-default-config"));
345 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
346 new JavaTestKit(getSystem()) {{
347 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
349 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
351 expectMsgClass(duration("5 seconds"), ActorNotInitialized.class);
356 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
357 new JavaTestKit(getSystem()) {{
358 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
360 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
362 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
363 // delayed until we send ActorInitialized.
364 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
365 new Timeout(5, TimeUnit.SECONDS));
367 shardManager.tell(new ActorInitialized(), mockShardActor);
369 Object resp = Await.result(future, duration("5 seconds"));
370 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
375 public void testOnReceiveMemberUp() throws Exception {
376 new JavaTestKit(getSystem()) {{
377 final ActorRef shardManager = getSystem().actorOf(newShardMgrProps());
379 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
381 shardManager.tell(new FindPrimary("astronauts", false).toSerializable(), getRef());
383 PrimaryFound found = PrimaryFound.fromSerializable(expectMsgClass(duration("5 seconds"),
384 PrimaryFound.SERIALIZABLE_CLASS));
385 String path = found.getPrimaryPath();
386 assertTrue("Found path contains " + path, path.contains("member-2-shard-astronauts-config"));
391 public void testOnReceiveMemberDown() throws Exception {
393 new JavaTestKit(getSystem()) {{
394 final ActorRef shardManager = getSystem().actorOf(newShardMgrProps());
396 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
398 shardManager.tell(new FindPrimary("astronauts", false).toSerializable(), getRef());
400 expectMsgClass(duration("5 seconds"), PrimaryFound.SERIALIZABLE_CLASS);
402 MockClusterWrapper.sendMemberRemoved(shardManager, "member-2", getRef().path().toString());
404 shardManager.tell(new FindPrimary("astronauts", false).toSerializable(), getRef());
406 expectMsgClass(duration("5 seconds"), PrimaryNotFound.SERIALIZABLE_CLASS);
411 public void testOnRecoveryJournalIsCleaned() {
412 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
413 ImmutableSet.of("foo")));
414 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
415 ImmutableSet.of("bar")));
416 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
418 new JavaTestKit(getSystem()) {{
419 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
420 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
422 shardManager.underlyingActor().waitForRecoveryComplete();
423 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
425 // Journal entries up to the last one should've been deleted
426 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
427 synchronized (journal) {
428 assertEquals("Journal size", 1, journal.size());
429 assertEquals("Journal entry seq #", Long.valueOf(2), journal.keySet().iterator().next());
435 public void testOnRecoveryPreviouslyKnownModulesAreDiscovered() throws Exception {
436 final ImmutableSet<String> persistedModules = ImmutableSet.of("foo", "bar");
437 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
439 new JavaTestKit(getSystem()) {{
440 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
441 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
443 shardManager.underlyingActor().waitForRecoveryComplete();
445 Collection<String> knownModules = shardManager.underlyingActor().getKnownModules();
447 assertEquals("getKnownModules", persistedModules, Sets.newHashSet(knownModules));
452 public void testOnUpdateSchemaContextUpdateKnownModulesIfTheyContainASuperSetOfTheKnownModules()
454 new JavaTestKit(getSystem()) {{
455 final TestActorRef<ShardManager> shardManager =
456 TestActorRef.create(getSystem(), newShardMgrProps());
458 assertEquals("getKnownModules size", 0, shardManager.underlyingActor().getKnownModules().size());
460 ModuleIdentifier foo = mock(ModuleIdentifier.class);
461 when(foo.getNamespace()).thenReturn(new URI("foo"));
463 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
464 moduleIdentifierSet.add(foo);
466 SchemaContext schemaContext = mock(SchemaContext.class);
467 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
469 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
471 assertEquals("getKnownModules", Sets.newHashSet("foo"),
472 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
474 ModuleIdentifier bar = mock(ModuleIdentifier.class);
475 when(bar.getNamespace()).thenReturn(new URI("bar"));
477 moduleIdentifierSet.add(bar);
479 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
481 assertEquals("getKnownModules", Sets.newHashSet("foo", "bar"),
482 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
487 public void testOnUpdateSchemaContextDoNotUpdateKnownModulesIfTheyDoNotContainASuperSetOfKnownModules()
489 new JavaTestKit(getSystem()) {{
490 final TestActorRef<ShardManager> shardManager =
491 TestActorRef.create(getSystem(), newShardMgrProps());
493 SchemaContext schemaContext = mock(SchemaContext.class);
494 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
496 ModuleIdentifier foo = mock(ModuleIdentifier.class);
497 when(foo.getNamespace()).thenReturn(new URI("foo"));
499 moduleIdentifierSet.add(foo);
501 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
503 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
505 assertEquals("getKnownModules", Sets.newHashSet("foo"),
506 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
508 //Create a completely different SchemaContext with only the bar module in it
509 //schemaContext = mock(SchemaContext.class);
510 moduleIdentifierSet.clear();
511 ModuleIdentifier bar = mock(ModuleIdentifier.class);
512 when(bar.getNamespace()).thenReturn(new URI("bar"));
514 moduleIdentifierSet.add(bar);
516 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
518 assertEquals("getKnownModules", Sets.newHashSet("foo"),
519 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
525 public void testRecoveryApplicable(){
526 new JavaTestKit(getSystem()) {
528 final Props persistentProps = ShardManager.props(
529 new MockClusterWrapper(),
530 new MockConfiguration(),
531 DatastoreContext.newBuilder().persistent(true).build(), ready);
532 final TestActorRef<ShardManager> persistentShardManager =
533 TestActorRef.create(getSystem(), persistentProps);
535 DataPersistenceProvider dataPersistenceProvider1 = persistentShardManager.underlyingActor().getDataPersistenceProvider();
537 assertTrue("Recovery Applicable", dataPersistenceProvider1.isRecoveryApplicable());
539 final Props nonPersistentProps = ShardManager.props(
540 new MockClusterWrapper(),
541 new MockConfiguration(),
542 DatastoreContext.newBuilder().persistent(false).build(), ready);
543 final TestActorRef<ShardManager> nonPersistentShardManager =
544 TestActorRef.create(getSystem(), nonPersistentProps);
546 DataPersistenceProvider dataPersistenceProvider2 = nonPersistentShardManager.underlyingActor().getDataPersistenceProvider();
548 assertFalse("Recovery Not Applicable", dataPersistenceProvider2.isRecoveryApplicable());
556 public void testOnUpdateSchemaContextUpdateKnownModulesCallsDataPersistenceProvider()
558 final CountDownLatch persistLatch = new CountDownLatch(1);
559 final Creator<ShardManager> creator = new Creator<ShardManager>() {
560 private static final long serialVersionUID = 1L;
562 public ShardManager create() throws Exception {
563 return new ShardManager(new MockClusterWrapper(), new MockConfiguration(), DatastoreContext.newBuilder().build(), ready) {
565 protected DataPersistenceProvider createDataPersistenceProvider(boolean persistent) {
566 DataPersistenceProviderMonitor dataPersistenceProviderMonitor
567 = new DataPersistenceProviderMonitor();
568 dataPersistenceProviderMonitor.setPersistLatch(persistLatch);
569 return dataPersistenceProviderMonitor;
575 new JavaTestKit(getSystem()) {{
577 final TestActorRef<ShardManager> shardManager =
578 TestActorRef.create(getSystem(), Props.create(new DelegatingShardManagerCreator(creator)));
580 ModuleIdentifier foo = mock(ModuleIdentifier.class);
581 when(foo.getNamespace()).thenReturn(new URI("foo"));
583 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
584 moduleIdentifierSet.add(foo);
586 SchemaContext schemaContext = mock(SchemaContext.class);
587 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
589 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
591 assertEquals("Persisted", true,
592 Uninterruptibles.awaitUninterruptibly(persistLatch, 5, TimeUnit.SECONDS));
598 public void testRoleChangeNotificationAndLeaderStateChangedReleaseReady() throws Exception {
599 new JavaTestKit(getSystem()) {
601 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
603 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
604 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
605 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
607 verify(ready, never()).countDown();
609 shardManager.underlyingActor().onReceiveCommand(new LeaderStateChanged(memberId, memberId));
611 verify(ready, times(1)).countDown();
617 public void testRoleChangeNotificationToFollowerWithLeaderStateChangedReleaseReady() throws Exception {
618 new JavaTestKit(getSystem()) {
620 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
622 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
623 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
624 memberId, null, RaftState.Follower.name()));
626 verify(ready, never()).countDown();
628 shardManager.underlyingActor().onReceiveCommand(new LeaderStateChanged(memberId, "member-2-shard-default-" + shardMrgIDSuffix));
630 verify(ready, times(1)).countDown();
637 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
638 new JavaTestKit(getSystem()) {
640 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
642 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
643 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
645 verify(ready, never()).countDown();
652 public void testByDefaultSyncStatusIsFalse() throws Exception{
653 final Props persistentProps = ShardManager.props(
654 new MockClusterWrapper(),
655 new MockConfiguration(),
656 DatastoreContext.newBuilder().persistent(true).build(), ready);
657 final TestActorRef<ShardManager> shardManager =
658 TestActorRef.create(getSystem(), persistentProps);
660 ShardManager shardManagerActor = shardManager.underlyingActor();
662 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
666 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
667 final Props persistentProps = ShardManager.props(
668 new MockClusterWrapper(),
669 new MockConfiguration(),
670 DatastoreContext.newBuilder().persistent(true).build(), ready);
671 final TestActorRef<ShardManager> shardManager =
672 TestActorRef.create(getSystem(), persistentProps);
674 ShardManager shardManagerActor = shardManager.underlyingActor();
675 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
676 RaftState.Follower.name(), RaftState.Leader.name()));
678 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
682 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
683 final Props persistentProps = ShardManager.props(
684 new MockClusterWrapper(),
685 new MockConfiguration(),
686 DatastoreContext.newBuilder().persistent(true).build(), ready);
687 final TestActorRef<ShardManager> shardManager =
688 TestActorRef.create(getSystem(), persistentProps);
690 ShardManager shardManagerActor = shardManager.underlyingActor();
691 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
692 RaftState.Follower.name(), RaftState.Candidate.name()));
694 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
696 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
697 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
699 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
703 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
704 final Props persistentProps = ShardManager.props(
705 new MockClusterWrapper(),
706 new MockConfiguration(),
707 DatastoreContext.newBuilder().persistent(true).build(), ready);
708 final TestActorRef<ShardManager> shardManager =
709 TestActorRef.create(getSystem(), persistentProps);
711 ShardManager shardManagerActor = shardManager.underlyingActor();
712 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
713 RaftState.Candidate.name(), RaftState.Follower.name()));
715 // Initially will be false
716 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
718 // Send status true will make sync status true
719 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
721 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
723 // Send status false will make sync status false
724 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
726 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
731 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
732 final Props persistentProps = ShardManager.props(
733 new MockClusterWrapper(),
734 new MockConfiguration() {
736 public List<String> getMemberShardNames(String memberName) {
737 return Arrays.asList("default", "astronauts");
740 DatastoreContext.newBuilder().persistent(true).build(), ready);
741 final TestActorRef<ShardManager> shardManager =
742 TestActorRef.create(getSystem(), persistentProps);
744 ShardManager shardManagerActor = shardManager.underlyingActor();
746 // Initially will be false
747 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
749 // Make default shard leader
750 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
751 RaftState.Follower.name(), RaftState.Leader.name()));
753 // default = Leader, astronauts is unknown so sync status remains false
754 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
756 // Make astronauts shard leader as well
757 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
758 RaftState.Follower.name(), RaftState.Leader.name()));
760 // Now sync status should be true
761 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
763 // Make astronauts a Follower
764 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
765 RaftState.Leader.name(), RaftState.Follower.name()));
767 // Sync status is not true
768 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
770 // Make the astronauts follower sync status true
771 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
773 // Sync status is now true
774 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
778 private static class TestShardManager extends ShardManager {
779 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
781 TestShardManager(String shardMrgIDSuffix) {
782 super(new MockClusterWrapper(), new MockConfiguration(),
783 DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build(), ready);
787 public void handleRecover(Object message) throws Exception {
789 super.handleRecover(message);
791 if(message instanceof RecoveryCompleted) {
792 recoveryComplete.countDown();
797 void waitForRecoveryComplete() {
798 assertEquals("Recovery complete", true,
799 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
803 @SuppressWarnings("serial")
804 static class TestShardManagerCreator implements Creator<TestShardManager> {
805 String shardMrgIDSuffix;
807 TestShardManagerCreator(String shardMrgIDSuffix) {
808 this.shardMrgIDSuffix = shardMrgIDSuffix;
812 public TestShardManager create() throws Exception {
813 return new TestShardManager(shardMrgIDSuffix);
818 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
819 private static final long serialVersionUID = 1L;
820 private final Creator<ShardManager> delegate;
822 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
823 this.delegate = delegate;
827 public ShardManager create() throws Exception {
828 return delegate.create();