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.ActorSystem;
13 import akka.actor.AddressFromURIString;
14 import akka.actor.Props;
15 import akka.cluster.Cluster;
16 import akka.cluster.ClusterEvent;
17 import akka.dispatch.Dispatchers;
18 import akka.japi.Creator;
19 import akka.pattern.Patterns;
20 import akka.persistence.RecoveryCompleted;
21 import akka.testkit.JavaTestKit;
22 import akka.testkit.TestActorRef;
23 import akka.util.Timeout;
24 import com.google.common.collect.ImmutableMap;
25 import com.google.common.collect.ImmutableSet;
26 import com.google.common.collect.Sets;
27 import com.google.common.util.concurrent.Uninterruptibles;
28 import com.typesafe.config.ConfigFactory;
30 import java.util.Arrays;
31 import java.util.Collection;
32 import java.util.HashSet;
33 import java.util.List;
36 import java.util.concurrent.CountDownLatch;
37 import java.util.concurrent.TimeUnit;
38 import org.junit.After;
39 import org.junit.Before;
40 import org.junit.Test;
41 import org.mockito.Mock;
42 import org.mockito.MockitoAnnotations;
43 import org.opendaylight.controller.cluster.DataPersistenceProvider;
44 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
45 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
46 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
47 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
48 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
49 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
50 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
51 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
52 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
53 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
54 import org.opendaylight.controller.cluster.datastore.messages.PrimaryFound;
55 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
56 import org.opendaylight.controller.cluster.datastore.utils.MessageCollectorActor;
57 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
58 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
59 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
60 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
61 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
62 import org.opendaylight.controller.cluster.raft.RaftState;
63 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
64 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
65 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
66 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
67 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
68 import scala.concurrent.Await;
69 import scala.concurrent.Future;
70 import scala.concurrent.duration.FiniteDuration;
72 public class ShardManagerTest extends AbstractActorTest {
73 private static int ID_COUNTER = 1;
75 private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
76 private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix;
79 private static CountDownLatch ready;
81 private static TestActorRef<MessageCollectorActor> mockShardActor;
83 private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
84 dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS);
86 private static ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
87 String name = new ShardIdentifier(shardName, memberName,"config").toString();
88 return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
93 MockitoAnnotations.initMocks(this);
95 InMemoryJournal.clear();
97 if(mockShardActor == null) {
98 String name = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
99 mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), name);
102 mockShardActor.underlyingActor().clear();
106 public void tearDown() {
107 InMemoryJournal.clear();
110 private Props newShardMgrProps() {
111 return ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
112 datastoreContextBuilder.build(), ready);
115 private Props newPropsShardMgrWithMockShardActor() {
116 return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
117 new MockConfiguration());
120 private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
121 final ClusterWrapper clusterWrapper, final Configuration config) {
122 Creator<ShardManager> creator = new Creator<ShardManager>() {
123 private static final long serialVersionUID = 1L;
125 public ShardManager create() throws Exception {
126 return new ForwardingShardManager(clusterWrapper, config, datastoreContextBuilder.build(),
127 ready, name, shardActor);
131 return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
135 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
136 new JavaTestKit(getSystem()) {{
137 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
139 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
141 shardManager.tell(new FindPrimary("non-existent", false), getRef());
143 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
148 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
149 new JavaTestKit(getSystem()) {{
150 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
152 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
154 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
155 shardManager.tell(new ActorInitialized(), mockShardActor);
157 shardManager.tell(new LeaderStateChanged(memberId, memberId), getRef());
159 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
160 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
161 RaftState.Leader.name())), mockShardActor);
163 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
165 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.class);
166 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
167 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
172 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
173 new JavaTestKit(getSystem()) {{
174 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
176 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
177 shardManager.tell(new ActorInitialized(), mockShardActor);
179 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
180 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
182 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
183 shardManager.tell(new RoleChangeNotification(memberId1,
184 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
185 shardManager.tell(new LeaderStateChanged(memberId1, memberId2), mockShardActor);
187 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
189 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.class);
190 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
191 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
196 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
197 new JavaTestKit(getSystem()) {{
198 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
200 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
202 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
207 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() 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 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
216 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
221 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
222 new JavaTestKit(getSystem()) {{
223 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
225 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
226 shardManager.tell(new ActorInitialized(), mockShardActor);
228 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
229 shardManager.tell(new RoleChangeNotification(memberId,
230 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
232 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
234 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
236 shardManager.tell(new LeaderStateChanged(memberId, memberId), mockShardActor);
238 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
240 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.class);
241 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
242 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
247 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
248 new JavaTestKit(getSystem()) {{
249 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
251 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
253 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
254 // delayed until we send ActorInitialized and RoleChangeNotification.
255 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
257 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
259 shardManager.tell(new ActorInitialized(), mockShardActor);
261 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
263 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
264 shardManager.tell(new RoleChangeNotification(memberId,
265 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
267 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
269 shardManager.tell(new LeaderStateChanged(memberId, memberId), mockShardActor);
271 PrimaryFound primaryFound = expectMsgClass(duration("5 seconds"), PrimaryFound.class);
272 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
273 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
275 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
280 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
281 new JavaTestKit(getSystem()) {{
282 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
284 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
286 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
288 expectMsgClass(duration("2 seconds"), NotInitializedException.class);
290 shardManager.tell(new ActorInitialized(), mockShardActor);
292 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
297 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
298 new JavaTestKit(getSystem()) {{
299 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
301 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
302 shardManager.tell(new ActorInitialized(), mockShardActor);
303 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
304 null, RaftState.Candidate.name()), mockShardActor);
306 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
308 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
313 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
314 new JavaTestKit(getSystem()) {{
315 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
317 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
318 shardManager.tell(new ActorInitialized(), mockShardActor);
320 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
322 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
327 public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
328 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
330 // Create an ActorSystem ShardManager actor for member-1.
332 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
333 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
335 ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
337 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
338 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
339 new MockConfiguration()), shardManagerID);
341 // Create an ActorSystem ShardManager actor for member-2.
343 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
345 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
347 final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
349 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
350 put("default", Arrays.asList("member-1", "member-2")).
351 put("astronauts", Arrays.asList("member-2")).build());
353 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
354 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
355 mockConfig2), shardManagerID);
357 new JavaTestKit(system1) {{
359 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
360 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
362 shardManager2.tell(new ActorInitialized(), mockShardActor2);
364 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
365 shardManager2.tell(new LeaderStateChanged(memberId2, memberId2), mockShardActor2);
366 shardManager2.tell(new RoleChangeNotification(memberId2,
367 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
369 shardManager1.underlyingActor().waitForMemberUp();
371 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
373 PrimaryFound found = expectMsgClass(duration("5 seconds"), PrimaryFound.class);
374 String path = found.getPrimaryPath();
375 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
377 shardManager2.underlyingActor().verifyFindPrimary();
379 Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
381 shardManager1.underlyingActor().waitForMemberRemoved();
383 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
385 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
388 JavaTestKit.shutdownActorSystem(system1);
389 JavaTestKit.shutdownActorSystem(system2);
393 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
394 new JavaTestKit(getSystem()) {{
395 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
397 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
399 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
401 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
403 assertEquals("getShardName", "non-existent", notFound.getShardName());
408 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
409 new JavaTestKit(getSystem()) {{
410 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
412 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
413 shardManager.tell(new ActorInitialized(), mockShardActor);
415 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
417 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
419 assertTrue("Found path contains " + found.getPath().path().toString(),
420 found.getPath().path().toString().contains("member-1-shard-default-config"));
425 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
426 new JavaTestKit(getSystem()) {{
427 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
429 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
431 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
436 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
437 new JavaTestKit(getSystem()) {{
438 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
440 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
442 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
443 // delayed until we send ActorInitialized.
444 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
445 new Timeout(5, TimeUnit.SECONDS));
447 shardManager.tell(new ActorInitialized(), mockShardActor);
449 Object resp = Await.result(future, duration("5 seconds"));
450 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
455 public void testOnRecoveryJournalIsCleaned() {
456 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
457 ImmutableSet.of("foo")));
458 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
459 ImmutableSet.of("bar")));
460 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
462 new JavaTestKit(getSystem()) {{
463 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
464 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
466 shardManager.underlyingActor().waitForRecoveryComplete();
467 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
469 // Journal entries up to the last one should've been deleted
470 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
471 synchronized (journal) {
472 assertEquals("Journal size", 1, journal.size());
473 assertEquals("Journal entry seq #", Long.valueOf(2), journal.keySet().iterator().next());
479 public void testOnRecoveryPreviouslyKnownModulesAreDiscovered() throws Exception {
480 final ImmutableSet<String> persistedModules = ImmutableSet.of("foo", "bar");
481 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
483 new JavaTestKit(getSystem()) {{
484 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
485 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
487 shardManager.underlyingActor().waitForRecoveryComplete();
489 Collection<String> knownModules = shardManager.underlyingActor().getKnownModules();
491 assertEquals("getKnownModules", persistedModules, Sets.newHashSet(knownModules));
496 public void testOnUpdateSchemaContextUpdateKnownModulesIfTheyContainASuperSetOfTheKnownModules()
498 new JavaTestKit(getSystem()) {{
499 final TestActorRef<ShardManager> shardManager =
500 TestActorRef.create(getSystem(), newShardMgrProps());
502 assertEquals("getKnownModules size", 0, shardManager.underlyingActor().getKnownModules().size());
504 ModuleIdentifier foo = mock(ModuleIdentifier.class);
505 when(foo.getNamespace()).thenReturn(new URI("foo"));
507 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
508 moduleIdentifierSet.add(foo);
510 SchemaContext schemaContext = mock(SchemaContext.class);
511 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
513 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
515 assertEquals("getKnownModules", Sets.newHashSet("foo"),
516 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
518 ModuleIdentifier bar = mock(ModuleIdentifier.class);
519 when(bar.getNamespace()).thenReturn(new URI("bar"));
521 moduleIdentifierSet.add(bar);
523 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
525 assertEquals("getKnownModules", Sets.newHashSet("foo", "bar"),
526 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
531 public void testOnUpdateSchemaContextDoNotUpdateKnownModulesIfTheyDoNotContainASuperSetOfKnownModules()
533 new JavaTestKit(getSystem()) {{
534 final TestActorRef<ShardManager> shardManager =
535 TestActorRef.create(getSystem(), newShardMgrProps());
537 SchemaContext schemaContext = mock(SchemaContext.class);
538 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
540 ModuleIdentifier foo = mock(ModuleIdentifier.class);
541 when(foo.getNamespace()).thenReturn(new URI("foo"));
543 moduleIdentifierSet.add(foo);
545 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
547 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
549 assertEquals("getKnownModules", Sets.newHashSet("foo"),
550 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
552 //Create a completely different SchemaContext with only the bar module in it
553 //schemaContext = mock(SchemaContext.class);
554 moduleIdentifierSet.clear();
555 ModuleIdentifier bar = mock(ModuleIdentifier.class);
556 when(bar.getNamespace()).thenReturn(new URI("bar"));
558 moduleIdentifierSet.add(bar);
560 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
562 assertEquals("getKnownModules", Sets.newHashSet("foo"),
563 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
569 public void testRecoveryApplicable(){
570 new JavaTestKit(getSystem()) {
572 final Props persistentProps = ShardManager.props(
573 new MockClusterWrapper(),
574 new MockConfiguration(),
575 DatastoreContext.newBuilder().persistent(true).build(), ready);
576 final TestActorRef<ShardManager> persistentShardManager =
577 TestActorRef.create(getSystem(), persistentProps);
579 DataPersistenceProvider dataPersistenceProvider1 = persistentShardManager.underlyingActor().getDataPersistenceProvider();
581 assertTrue("Recovery Applicable", dataPersistenceProvider1.isRecoveryApplicable());
583 final Props nonPersistentProps = ShardManager.props(
584 new MockClusterWrapper(),
585 new MockConfiguration(),
586 DatastoreContext.newBuilder().persistent(false).build(), ready);
587 final TestActorRef<ShardManager> nonPersistentShardManager =
588 TestActorRef.create(getSystem(), nonPersistentProps);
590 DataPersistenceProvider dataPersistenceProvider2 = nonPersistentShardManager.underlyingActor().getDataPersistenceProvider();
592 assertFalse("Recovery Not Applicable", dataPersistenceProvider2.isRecoveryApplicable());
600 public void testOnUpdateSchemaContextUpdateKnownModulesCallsDataPersistenceProvider()
602 final CountDownLatch persistLatch = new CountDownLatch(1);
603 final Creator<ShardManager> creator = new Creator<ShardManager>() {
604 private static final long serialVersionUID = 1L;
606 public ShardManager create() throws Exception {
607 return new ShardManager(new MockClusterWrapper(), new MockConfiguration(), DatastoreContext.newBuilder().build(), ready) {
609 protected DataPersistenceProvider createDataPersistenceProvider(boolean persistent) {
610 DataPersistenceProviderMonitor dataPersistenceProviderMonitor
611 = new DataPersistenceProviderMonitor();
612 dataPersistenceProviderMonitor.setPersistLatch(persistLatch);
613 return dataPersistenceProviderMonitor;
619 new JavaTestKit(getSystem()) {{
621 final TestActorRef<ShardManager> shardManager =
622 TestActorRef.create(getSystem(), Props.create(new DelegatingShardManagerCreator(creator)));
624 ModuleIdentifier foo = mock(ModuleIdentifier.class);
625 when(foo.getNamespace()).thenReturn(new URI("foo"));
627 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
628 moduleIdentifierSet.add(foo);
630 SchemaContext schemaContext = mock(SchemaContext.class);
631 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
633 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
635 assertEquals("Persisted", true,
636 Uninterruptibles.awaitUninterruptibly(persistLatch, 5, TimeUnit.SECONDS));
642 public void testRoleChangeNotificationAndLeaderStateChangedReleaseReady() throws Exception {
643 new JavaTestKit(getSystem()) {
645 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
647 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
648 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
649 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
651 verify(ready, never()).countDown();
653 shardManager.underlyingActor().onReceiveCommand(new LeaderStateChanged(memberId, memberId));
655 verify(ready, times(1)).countDown();
661 public void testRoleChangeNotificationToFollowerWithLeaderStateChangedReleaseReady() throws Exception {
662 new JavaTestKit(getSystem()) {
664 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
666 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
667 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
668 memberId, null, RaftState.Follower.name()));
670 verify(ready, never()).countDown();
672 shardManager.underlyingActor().onReceiveCommand(new LeaderStateChanged(memberId, "member-2-shard-default-" + shardMrgIDSuffix));
674 verify(ready, times(1)).countDown();
681 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
682 new JavaTestKit(getSystem()) {
684 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
686 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
687 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
689 verify(ready, never()).countDown();
696 public void testByDefaultSyncStatusIsFalse() throws Exception{
697 final Props persistentProps = ShardManager.props(
698 new MockClusterWrapper(),
699 new MockConfiguration(),
700 DatastoreContext.newBuilder().persistent(true).build(), ready);
701 final TestActorRef<ShardManager> shardManager =
702 TestActorRef.create(getSystem(), persistentProps);
704 ShardManager shardManagerActor = shardManager.underlyingActor();
706 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
710 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
711 final Props persistentProps = ShardManager.props(
712 new MockClusterWrapper(),
713 new MockConfiguration(),
714 DatastoreContext.newBuilder().persistent(true).build(), ready);
715 final TestActorRef<ShardManager> shardManager =
716 TestActorRef.create(getSystem(), persistentProps);
718 ShardManager shardManagerActor = shardManager.underlyingActor();
719 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
720 RaftState.Follower.name(), RaftState.Leader.name()));
722 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
726 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
727 final Props persistentProps = ShardManager.props(
728 new MockClusterWrapper(),
729 new MockConfiguration(),
730 DatastoreContext.newBuilder().persistent(true).build(), ready);
731 final TestActorRef<ShardManager> shardManager =
732 TestActorRef.create(getSystem(), persistentProps);
734 ShardManager shardManagerActor = shardManager.underlyingActor();
735 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
736 RaftState.Follower.name(), RaftState.Candidate.name()));
738 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
740 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
741 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
743 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
747 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
748 final Props persistentProps = ShardManager.props(
749 new MockClusterWrapper(),
750 new MockConfiguration(),
751 DatastoreContext.newBuilder().persistent(true).build(), ready);
752 final TestActorRef<ShardManager> shardManager =
753 TestActorRef.create(getSystem(), persistentProps);
755 ShardManager shardManagerActor = shardManager.underlyingActor();
756 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
757 RaftState.Candidate.name(), RaftState.Follower.name()));
759 // Initially will be false
760 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
762 // Send status true will make sync status true
763 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
765 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
767 // Send status false will make sync status false
768 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
770 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
775 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
776 final Props persistentProps = ShardManager.props(
777 new MockClusterWrapper(),
778 new MockConfiguration() {
780 public List<String> getMemberShardNames(String memberName) {
781 return Arrays.asList("default", "astronauts");
784 DatastoreContext.newBuilder().persistent(true).build(), ready);
785 final TestActorRef<ShardManager> shardManager =
786 TestActorRef.create(getSystem(), persistentProps);
788 ShardManager shardManagerActor = shardManager.underlyingActor();
790 // Initially will be false
791 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
793 // Make default shard leader
794 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
795 RaftState.Follower.name(), RaftState.Leader.name()));
797 // default = Leader, astronauts is unknown so sync status remains false
798 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
800 // Make astronauts shard leader as well
801 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
802 RaftState.Follower.name(), RaftState.Leader.name()));
804 // Now sync status should be true
805 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
807 // Make astronauts a Follower
808 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
809 RaftState.Leader.name(), RaftState.Follower.name()));
811 // Sync status is not true
812 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
814 // Make the astronauts follower sync status true
815 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
817 // Sync status is now true
818 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
822 private static class TestShardManager extends ShardManager {
823 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
825 TestShardManager(String shardMrgIDSuffix) {
826 super(new MockClusterWrapper(), new MockConfiguration(),
827 DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build(), ready);
831 public void handleRecover(Object message) throws Exception {
833 super.handleRecover(message);
835 if(message instanceof RecoveryCompleted) {
836 recoveryComplete.countDown();
841 void waitForRecoveryComplete() {
842 assertEquals("Recovery complete", true,
843 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
847 @SuppressWarnings("serial")
848 static class TestShardManagerCreator implements Creator<TestShardManager> {
849 String shardMrgIDSuffix;
851 TestShardManagerCreator(String shardMrgIDSuffix) {
852 this.shardMrgIDSuffix = shardMrgIDSuffix;
856 public TestShardManager create() throws Exception {
857 return new TestShardManager(shardMrgIDSuffix);
862 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
863 private static final long serialVersionUID = 1L;
864 private final Creator<ShardManager> delegate;
866 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
867 this.delegate = delegate;
871 public ShardManager create() throws Exception {
872 return delegate.create();
876 private static class ForwardingShardManager extends ShardManager {
877 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
878 private CountDownLatch memberUpReceived = new CountDownLatch(1);
879 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
880 private final ActorRef shardActor;
881 private final String name;
883 protected ForwardingShardManager(ClusterWrapper cluster, Configuration configuration,
884 DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch, String name,
885 ActorRef shardActor) {
886 super(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch);
887 this.shardActor = shardActor;
892 public void handleCommand(Object message) throws Exception {
894 super.handleCommand(message);
896 if(message instanceof FindPrimary) {
897 findPrimaryMessageReceived.countDown();
898 } else if(message instanceof ClusterEvent.MemberUp) {
899 String role = ((ClusterEvent.MemberUp)message).member().roles().head();
900 if(!getCluster().getCurrentMemberName().equals(role)) {
901 memberUpReceived.countDown();
903 } else if(message instanceof ClusterEvent.MemberRemoved) {
904 String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
905 if(!getCluster().getCurrentMemberName().equals(role)) {
906 memberRemovedReceived.countDown();
913 public String persistenceId() {
918 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
922 void waitForMemberUp() {
923 assertEquals("MemberUp received", true,
924 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
925 memberUpReceived = new CountDownLatch(1);
928 void waitForMemberRemoved() {
929 assertEquals("MemberRemoved received", true,
930 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
931 memberRemovedReceived = new CountDownLatch(1);
934 void verifyFindPrimary() {
935 assertEquals("FindPrimary received", true,
936 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
937 findPrimaryMessageReceived = new CountDownLatch(1);