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.assertSame;
6 import static org.junit.Assert.assertTrue;
7 import static org.mockito.Mockito.mock;
8 import static org.mockito.Mockito.never;
9 import static org.mockito.Mockito.times;
10 import static org.mockito.Mockito.verify;
11 import static org.mockito.Mockito.when;
12 import akka.actor.ActorRef;
13 import akka.actor.ActorSystem;
14 import akka.actor.AddressFromURIString;
15 import akka.actor.Props;
16 import akka.cluster.Cluster;
17 import akka.cluster.ClusterEvent;
18 import akka.dispatch.Dispatchers;
19 import akka.japi.Creator;
20 import akka.pattern.Patterns;
21 import akka.persistence.RecoveryCompleted;
22 import akka.testkit.JavaTestKit;
23 import akka.testkit.TestActorRef;
24 import akka.util.Timeout;
25 import com.google.common.base.Optional;
26 import com.google.common.collect.ImmutableMap;
27 import com.google.common.collect.ImmutableSet;
28 import com.google.common.collect.Sets;
29 import com.google.common.util.concurrent.Uninterruptibles;
30 import com.typesafe.config.ConfigFactory;
32 import java.util.Arrays;
33 import java.util.Collection;
34 import java.util.HashSet;
35 import java.util.List;
38 import java.util.concurrent.CountDownLatch;
39 import java.util.concurrent.TimeUnit;
40 import org.junit.After;
41 import org.junit.Before;
42 import org.junit.Test;
43 import org.mockito.Mock;
44 import org.mockito.MockitoAnnotations;
45 import org.opendaylight.controller.cluster.DataPersistenceProvider;
46 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
47 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
48 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
49 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
50 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
51 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
52 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
53 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
54 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
55 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
56 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
57 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
58 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
59 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
60 import org.opendaylight.controller.cluster.datastore.utils.MessageCollectorActor;
61 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
62 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
63 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
64 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
65 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
66 import org.opendaylight.controller.cluster.raft.RaftState;
67 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
68 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
69 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
70 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
71 import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
72 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
73 import scala.concurrent.Await;
74 import scala.concurrent.Future;
75 import scala.concurrent.duration.FiniteDuration;
77 public class ShardManagerTest extends AbstractActorTest {
78 private static int ID_COUNTER = 1;
80 private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
81 private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix;
84 private static CountDownLatch ready;
86 private static TestActorRef<MessageCollectorActor> mockShardActor;
88 private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
89 dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS);
91 private static ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
92 String name = new ShardIdentifier(shardName, memberName,"config").toString();
93 return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
98 MockitoAnnotations.initMocks(this);
100 InMemoryJournal.clear();
102 if(mockShardActor == null) {
103 String name = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
104 mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), name);
107 mockShardActor.underlyingActor().clear();
111 public void tearDown() {
112 InMemoryJournal.clear();
115 private Props newShardMgrProps() {
116 return ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
117 datastoreContextBuilder.build(), ready);
120 private Props newPropsShardMgrWithMockShardActor() {
121 return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
122 new MockConfiguration());
125 private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
126 final ClusterWrapper clusterWrapper, final Configuration config) {
127 Creator<ShardManager> creator = new Creator<ShardManager>() {
128 private static final long serialVersionUID = 1L;
130 public ShardManager create() throws Exception {
131 return new ForwardingShardManager(clusterWrapper, config, datastoreContextBuilder.build(),
132 ready, name, shardActor);
136 return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
140 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
141 new JavaTestKit(getSystem()) {{
142 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
144 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
146 shardManager.tell(new FindPrimary("non-existent", false), getRef());
148 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
153 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
154 new JavaTestKit(getSystem()) {{
155 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
157 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
159 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
160 shardManager.tell(new ActorInitialized(), mockShardActor);
162 DataTree mockDataTree = mock(DataTree.class);
163 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree)), getRef());
165 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
166 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
167 RaftState.Leader.name())), mockShardActor);
169 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
171 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
172 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
173 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
174 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
179 public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
180 new JavaTestKit(getSystem()) {{
181 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
183 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
184 shardManager.tell(new ActorInitialized(), mockShardActor);
186 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
187 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
188 shardManager.tell(new RoleChangeNotification(memberId1,
189 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
190 shardManager.tell(new LeaderStateChanged(memberId1, memberId2), mockShardActor);
192 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
194 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
199 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
200 new JavaTestKit(getSystem()) {{
201 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
203 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
204 shardManager.tell(new ActorInitialized(), mockShardActor);
206 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
207 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
209 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
210 shardManager.tell(new RoleChangeNotification(memberId1,
211 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
212 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent()), mockShardActor);
214 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
216 RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
217 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
218 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
223 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
224 new JavaTestKit(getSystem()) {{
225 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
227 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
229 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
234 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
235 new JavaTestKit(getSystem()) {{
236 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
238 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
239 shardManager.tell(new ActorInitialized(), mockShardActor);
241 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
243 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
248 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
249 new JavaTestKit(getSystem()) {{
250 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
252 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
253 shardManager.tell(new ActorInitialized(), mockShardActor);
255 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
256 shardManager.tell(new RoleChangeNotification(memberId,
257 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
259 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
261 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
263 DataTree mockDataTree = mock(DataTree.class);
264 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree)), mockShardActor);
266 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
268 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
269 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
270 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
271 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
276 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
277 new JavaTestKit(getSystem()) {{
278 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
280 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
282 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
283 // delayed until we send ActorInitialized and RoleChangeNotification.
284 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
286 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
288 shardManager.tell(new ActorInitialized(), mockShardActor);
290 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
292 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
293 shardManager.tell(new RoleChangeNotification(memberId,
294 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
296 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
298 DataTree mockDataTree = mock(DataTree.class);
299 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree)), mockShardActor);
301 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
302 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
303 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
304 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
306 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
311 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
312 new JavaTestKit(getSystem()) {{
313 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
315 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
317 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
319 expectMsgClass(duration("2 seconds"), NotInitializedException.class);
321 shardManager.tell(new ActorInitialized(), mockShardActor);
323 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
328 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() 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);
334 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
335 null, RaftState.Candidate.name()), mockShardActor);
337 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
339 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
344 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
345 new JavaTestKit(getSystem()) {{
346 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
348 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
349 shardManager.tell(new ActorInitialized(), mockShardActor);
351 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
353 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
358 public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
359 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
361 // Create an ActorSystem ShardManager actor for member-1.
363 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
364 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
366 ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
368 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
369 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
370 new MockConfiguration()), shardManagerID);
372 // Create an ActorSystem ShardManager actor for member-2.
374 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
376 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
378 final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
380 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
381 put("default", Arrays.asList("member-1", "member-2")).
382 put("astronauts", Arrays.asList("member-2")).build());
384 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
385 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
386 mockConfig2), shardManagerID);
388 new JavaTestKit(system1) {{
390 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
391 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
393 shardManager2.tell(new ActorInitialized(), mockShardActor2);
395 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
396 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
397 Optional.of(mock(DataTree.class))), mockShardActor2);
398 shardManager2.tell(new RoleChangeNotification(memberId2,
399 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
401 shardManager1.underlyingActor().waitForMemberUp();
403 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
405 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
406 String path = found.getPrimaryPath();
407 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
409 shardManager2.underlyingActor().verifyFindPrimary();
411 Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
413 shardManager1.underlyingActor().waitForMemberRemoved();
415 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
417 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
420 JavaTestKit.shutdownActorSystem(system1);
421 JavaTestKit.shutdownActorSystem(system2);
425 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
426 new JavaTestKit(getSystem()) {{
427 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
429 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
431 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
433 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
435 assertEquals("getShardName", "non-existent", notFound.getShardName());
440 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
441 new JavaTestKit(getSystem()) {{
442 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
444 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
445 shardManager.tell(new ActorInitialized(), mockShardActor);
447 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
449 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
451 assertTrue("Found path contains " + found.getPath().path().toString(),
452 found.getPath().path().toString().contains("member-1-shard-default-config"));
457 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
458 new JavaTestKit(getSystem()) {{
459 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
461 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
463 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
468 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
469 new JavaTestKit(getSystem()) {{
470 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
472 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
474 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
475 // delayed until we send ActorInitialized.
476 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
477 new Timeout(5, TimeUnit.SECONDS));
479 shardManager.tell(new ActorInitialized(), mockShardActor);
481 Object resp = Await.result(future, duration("5 seconds"));
482 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
487 public void testOnRecoveryJournalIsCleaned() {
488 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
489 ImmutableSet.of("foo")));
490 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
491 ImmutableSet.of("bar")));
492 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
494 new JavaTestKit(getSystem()) {{
495 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
496 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
498 shardManager.underlyingActor().waitForRecoveryComplete();
499 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
501 // Journal entries up to the last one should've been deleted
502 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
503 synchronized (journal) {
504 assertEquals("Journal size", 1, journal.size());
505 assertEquals("Journal entry seq #", Long.valueOf(2), journal.keySet().iterator().next());
511 public void testOnRecoveryPreviouslyKnownModulesAreDiscovered() throws Exception {
512 final ImmutableSet<String> persistedModules = ImmutableSet.of("foo", "bar");
513 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
515 new JavaTestKit(getSystem()) {{
516 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
517 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
519 shardManager.underlyingActor().waitForRecoveryComplete();
521 Collection<String> knownModules = shardManager.underlyingActor().getKnownModules();
523 assertEquals("getKnownModules", persistedModules, Sets.newHashSet(knownModules));
528 public void testOnUpdateSchemaContextUpdateKnownModulesIfTheyContainASuperSetOfTheKnownModules()
530 new JavaTestKit(getSystem()) {{
531 final TestActorRef<ShardManager> shardManager =
532 TestActorRef.create(getSystem(), newShardMgrProps());
534 assertEquals("getKnownModules size", 0, shardManager.underlyingActor().getKnownModules().size());
536 ModuleIdentifier foo = mock(ModuleIdentifier.class);
537 when(foo.getNamespace()).thenReturn(new URI("foo"));
539 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
540 moduleIdentifierSet.add(foo);
542 SchemaContext schemaContext = mock(SchemaContext.class);
543 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
545 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
547 assertEquals("getKnownModules", Sets.newHashSet("foo"),
548 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
550 ModuleIdentifier bar = mock(ModuleIdentifier.class);
551 when(bar.getNamespace()).thenReturn(new URI("bar"));
553 moduleIdentifierSet.add(bar);
555 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
557 assertEquals("getKnownModules", Sets.newHashSet("foo", "bar"),
558 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
563 public void testOnUpdateSchemaContextDoNotUpdateKnownModulesIfTheyDoNotContainASuperSetOfKnownModules()
565 new JavaTestKit(getSystem()) {{
566 final TestActorRef<ShardManager> shardManager =
567 TestActorRef.create(getSystem(), newShardMgrProps());
569 SchemaContext schemaContext = mock(SchemaContext.class);
570 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
572 ModuleIdentifier foo = mock(ModuleIdentifier.class);
573 when(foo.getNamespace()).thenReturn(new URI("foo"));
575 moduleIdentifierSet.add(foo);
577 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
579 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
581 assertEquals("getKnownModules", Sets.newHashSet("foo"),
582 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
584 //Create a completely different SchemaContext with only the bar module in it
585 //schemaContext = mock(SchemaContext.class);
586 moduleIdentifierSet.clear();
587 ModuleIdentifier bar = mock(ModuleIdentifier.class);
588 when(bar.getNamespace()).thenReturn(new URI("bar"));
590 moduleIdentifierSet.add(bar);
592 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
594 assertEquals("getKnownModules", Sets.newHashSet("foo"),
595 Sets.newHashSet(shardManager.underlyingActor().getKnownModules()));
601 public void testRecoveryApplicable(){
602 new JavaTestKit(getSystem()) {
604 final Props persistentProps = ShardManager.props(
605 new MockClusterWrapper(),
606 new MockConfiguration(),
607 DatastoreContext.newBuilder().persistent(true).build(), ready);
608 final TestActorRef<ShardManager> persistentShardManager =
609 TestActorRef.create(getSystem(), persistentProps);
611 DataPersistenceProvider dataPersistenceProvider1 = persistentShardManager.underlyingActor().getDataPersistenceProvider();
613 assertTrue("Recovery Applicable", dataPersistenceProvider1.isRecoveryApplicable());
615 final Props nonPersistentProps = ShardManager.props(
616 new MockClusterWrapper(),
617 new MockConfiguration(),
618 DatastoreContext.newBuilder().persistent(false).build(), ready);
619 final TestActorRef<ShardManager> nonPersistentShardManager =
620 TestActorRef.create(getSystem(), nonPersistentProps);
622 DataPersistenceProvider dataPersistenceProvider2 = nonPersistentShardManager.underlyingActor().getDataPersistenceProvider();
624 assertFalse("Recovery Not Applicable", dataPersistenceProvider2.isRecoveryApplicable());
632 public void testOnUpdateSchemaContextUpdateKnownModulesCallsDataPersistenceProvider()
634 final CountDownLatch persistLatch = new CountDownLatch(1);
635 final Creator<ShardManager> creator = new Creator<ShardManager>() {
636 private static final long serialVersionUID = 1L;
638 public ShardManager create() throws Exception {
639 return new ShardManager(new MockClusterWrapper(), new MockConfiguration(), DatastoreContext.newBuilder().build(), ready) {
641 protected DataPersistenceProvider createDataPersistenceProvider(boolean persistent) {
642 DataPersistenceProviderMonitor dataPersistenceProviderMonitor
643 = new DataPersistenceProviderMonitor();
644 dataPersistenceProviderMonitor.setPersistLatch(persistLatch);
645 return dataPersistenceProviderMonitor;
651 new JavaTestKit(getSystem()) {{
653 final TestActorRef<ShardManager> shardManager =
654 TestActorRef.create(getSystem(), Props.create(new DelegatingShardManagerCreator(creator)));
656 ModuleIdentifier foo = mock(ModuleIdentifier.class);
657 when(foo.getNamespace()).thenReturn(new URI("foo"));
659 Set<ModuleIdentifier> moduleIdentifierSet = new HashSet<>();
660 moduleIdentifierSet.add(foo);
662 SchemaContext schemaContext = mock(SchemaContext.class);
663 when(schemaContext.getAllModuleIdentifiers()).thenReturn(moduleIdentifierSet);
665 shardManager.underlyingActor().onReceiveCommand(new UpdateSchemaContext(schemaContext));
667 assertEquals("Persisted", true,
668 Uninterruptibles.awaitUninterruptibly(persistLatch, 5, TimeUnit.SECONDS));
674 public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
675 new JavaTestKit(getSystem()) {
677 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
679 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
680 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
681 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
683 verify(ready, never()).countDown();
685 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
686 Optional.of(mock(DataTree.class))));
688 verify(ready, times(1)).countDown();
694 public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
695 new JavaTestKit(getSystem()) {
697 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
699 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
700 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
701 memberId, null, RaftState.Follower.name()));
703 verify(ready, never()).countDown();
705 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
707 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
708 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class))));
710 verify(ready, times(1)).countDown();
716 public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
717 new JavaTestKit(getSystem()) {
719 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
721 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
722 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
723 memberId, null, RaftState.Follower.name()));
725 verify(ready, never()).countDown();
727 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
728 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class))));
730 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
732 verify(ready, times(1)).countDown();
738 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
739 new JavaTestKit(getSystem()) {
741 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
743 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
744 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
746 verify(ready, never()).countDown();
753 public void testByDefaultSyncStatusIsFalse() throws Exception{
754 final Props persistentProps = ShardManager.props(
755 new MockClusterWrapper(),
756 new MockConfiguration(),
757 DatastoreContext.newBuilder().persistent(true).build(), ready);
758 final TestActorRef<ShardManager> shardManager =
759 TestActorRef.create(getSystem(), persistentProps);
761 ShardManager shardManagerActor = shardManager.underlyingActor();
763 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
767 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
768 final Props persistentProps = ShardManager.props(
769 new MockClusterWrapper(),
770 new MockConfiguration(),
771 DatastoreContext.newBuilder().persistent(true).build(), ready);
772 final TestActorRef<ShardManager> shardManager =
773 TestActorRef.create(getSystem(), persistentProps);
775 ShardManager shardManagerActor = shardManager.underlyingActor();
776 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
777 RaftState.Follower.name(), RaftState.Leader.name()));
779 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
783 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
784 final Props persistentProps = ShardManager.props(
785 new MockClusterWrapper(),
786 new MockConfiguration(),
787 DatastoreContext.newBuilder().persistent(true).build(), ready);
788 final TestActorRef<ShardManager> shardManager =
789 TestActorRef.create(getSystem(), persistentProps);
791 ShardManager shardManagerActor = shardManager.underlyingActor();
792 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
793 RaftState.Follower.name(), RaftState.Candidate.name()));
795 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
797 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
798 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
800 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
804 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
805 final Props persistentProps = ShardManager.props(
806 new MockClusterWrapper(),
807 new MockConfiguration(),
808 DatastoreContext.newBuilder().persistent(true).build(), ready);
809 final TestActorRef<ShardManager> shardManager =
810 TestActorRef.create(getSystem(), persistentProps);
812 ShardManager shardManagerActor = shardManager.underlyingActor();
813 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
814 RaftState.Candidate.name(), RaftState.Follower.name()));
816 // Initially will be false
817 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
819 // Send status true will make sync status true
820 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
822 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
824 // Send status false will make sync status false
825 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
827 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
832 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
833 final Props persistentProps = ShardManager.props(
834 new MockClusterWrapper(),
835 new MockConfiguration() {
837 public List<String> getMemberShardNames(String memberName) {
838 return Arrays.asList("default", "astronauts");
841 DatastoreContext.newBuilder().persistent(true).build(), ready);
842 final TestActorRef<ShardManager> shardManager =
843 TestActorRef.create(getSystem(), persistentProps);
845 ShardManager shardManagerActor = shardManager.underlyingActor();
847 // Initially will be false
848 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
850 // Make default shard leader
851 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
852 RaftState.Follower.name(), RaftState.Leader.name()));
854 // default = Leader, astronauts is unknown so sync status remains false
855 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
857 // Make astronauts shard leader as well
858 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
859 RaftState.Follower.name(), RaftState.Leader.name()));
861 // Now sync status should be true
862 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
864 // Make astronauts a Follower
865 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
866 RaftState.Leader.name(), RaftState.Follower.name()));
868 // Sync status is not true
869 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
871 // Make the astronauts follower sync status true
872 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
874 // Sync status is now true
875 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
879 private static class TestShardManager extends ShardManager {
880 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
882 TestShardManager(String shardMrgIDSuffix) {
883 super(new MockClusterWrapper(), new MockConfiguration(),
884 DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build(), ready);
888 public void handleRecover(Object message) throws Exception {
890 super.handleRecover(message);
892 if(message instanceof RecoveryCompleted) {
893 recoveryComplete.countDown();
898 void waitForRecoveryComplete() {
899 assertEquals("Recovery complete", true,
900 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
904 @SuppressWarnings("serial")
905 static class TestShardManagerCreator implements Creator<TestShardManager> {
906 String shardMrgIDSuffix;
908 TestShardManagerCreator(String shardMrgIDSuffix) {
909 this.shardMrgIDSuffix = shardMrgIDSuffix;
913 public TestShardManager create() throws Exception {
914 return new TestShardManager(shardMrgIDSuffix);
919 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
920 private static final long serialVersionUID = 1L;
921 private final Creator<ShardManager> delegate;
923 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
924 this.delegate = delegate;
928 public ShardManager create() throws Exception {
929 return delegate.create();
933 private static class ForwardingShardManager extends ShardManager {
934 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
935 private CountDownLatch memberUpReceived = new CountDownLatch(1);
936 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
937 private final ActorRef shardActor;
938 private final String name;
940 protected ForwardingShardManager(ClusterWrapper cluster, Configuration configuration,
941 DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch, String name,
942 ActorRef shardActor) {
943 super(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch);
944 this.shardActor = shardActor;
949 public void handleCommand(Object message) throws Exception {
951 super.handleCommand(message);
953 if(message instanceof FindPrimary) {
954 findPrimaryMessageReceived.countDown();
955 } else if(message instanceof ClusterEvent.MemberUp) {
956 String role = ((ClusterEvent.MemberUp)message).member().roles().head();
957 if(!getCluster().getCurrentMemberName().equals(role)) {
958 memberUpReceived.countDown();
960 } else if(message instanceof ClusterEvent.MemberRemoved) {
961 String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
962 if(!getCluster().getCurrentMemberName().equals(role)) {
963 memberRemovedReceived.countDown();
970 public String persistenceId() {
975 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
979 void waitForMemberUp() {
980 assertEquals("MemberUp received", true,
981 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
982 memberUpReceived = new CountDownLatch(1);
985 void waitForMemberRemoved() {
986 assertEquals("MemberRemoved received", true,
987 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
988 memberRemovedReceived = new CountDownLatch(1);
991 void verifyFindPrimary() {
992 assertEquals("FindPrimary received", true,
993 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
994 findPrimaryMessageReceived = new CountDownLatch(1);