1 package org.opendaylight.controller.cluster.datastore;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertNull;
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 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.base.Optional;
25 import com.google.common.collect.ImmutableMap;
26 import com.google.common.collect.ImmutableSet;
27 import com.google.common.util.concurrent.Uninterruptibles;
28 import com.typesafe.config.ConfigFactory;
29 import java.util.Arrays;
30 import java.util.List;
32 import java.util.concurrent.CountDownLatch;
33 import java.util.concurrent.TimeUnit;
34 import org.junit.After;
35 import org.junit.Before;
36 import org.junit.Test;
37 import org.mockito.Mock;
38 import org.mockito.MockitoAnnotations;
39 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
40 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
41 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
42 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
43 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
44 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
45 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
46 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
47 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
48 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
49 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
50 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
51 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
52 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
53 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
54 import org.opendaylight.controller.cluster.datastore.utils.MessageCollectorActor;
55 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
56 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
57 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
58 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
59 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
60 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
61 import org.opendaylight.controller.cluster.raft.RaftState;
62 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
63 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
64 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
65 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
66 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
67 import scala.concurrent.Await;
68 import scala.concurrent.Future;
69 import scala.concurrent.duration.FiniteDuration;
71 public class ShardManagerTest extends AbstractActorTest {
72 private static int ID_COUNTER = 1;
74 private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
75 private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix;
78 private static CountDownLatch ready;
80 private static TestActorRef<MessageCollectorActor> mockShardActor;
82 private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
83 dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS);
85 private static ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
86 String name = new ShardIdentifier(shardName, memberName,"config").toString();
87 return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
90 private final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
94 MockitoAnnotations.initMocks(this);
96 InMemoryJournal.clear();
98 if(mockShardActor == null) {
99 String name = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
100 mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), name);
103 mockShardActor.underlyingActor().clear();
107 public void tearDown() {
108 InMemoryJournal.clear();
111 private Props newShardMgrProps(boolean persistent) {
112 return ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
113 datastoreContextBuilder.persistent(persistent).build(), ready, primaryShardInfoCache);
116 private Props newPropsShardMgrWithMockShardActor() {
117 return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
118 new MockConfiguration());
121 private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
122 final ClusterWrapper clusterWrapper, final Configuration config) {
123 Creator<ShardManager> creator = new Creator<ShardManager>() {
124 private static final long serialVersionUID = 1L;
126 public ShardManager create() throws Exception {
127 return new ForwardingShardManager(clusterWrapper, config, datastoreContextBuilder.build(),
128 ready, name, shardActor, primaryShardInfoCache);
132 return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
136 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
137 new JavaTestKit(getSystem()) {{
138 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
140 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
142 shardManager.tell(new FindPrimary("non-existent", false), getRef());
144 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
149 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
150 new JavaTestKit(getSystem()) {{
151 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
153 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
155 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
156 shardManager.tell(new ActorInitialized(), mockShardActor);
158 DataTree mockDataTree = mock(DataTree.class);
159 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
160 DataStoreVersions.CURRENT_VERSION), getRef());
162 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
163 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
164 RaftState.Leader.name())), mockShardActor);
166 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
168 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
169 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
170 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
171 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
176 public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
177 new JavaTestKit(getSystem()) {{
178 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
180 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
181 shardManager.tell(new ActorInitialized(), mockShardActor);
183 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
184 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
185 shardManager.tell(new RoleChangeNotification(memberId1,
186 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
187 shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
189 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
191 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
196 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
197 new JavaTestKit(getSystem()) {{
198 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
200 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
201 shardManager.tell(new ActorInitialized(), mockShardActor);
203 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
204 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
206 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
207 shardManager.tell(new RoleChangeNotification(memberId1,
208 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
209 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
210 DataStoreVersions.CURRENT_VERSION), mockShardActor);
212 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
214 RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
215 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
216 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
221 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
222 new JavaTestKit(getSystem()) {{
223 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
225 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
227 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
232 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
233 new JavaTestKit(getSystem()) {{
234 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
236 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
237 shardManager.tell(new ActorInitialized(), mockShardActor);
239 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
241 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
246 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
247 new JavaTestKit(getSystem()) {{
248 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
250 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
251 shardManager.tell(new ActorInitialized(), mockShardActor);
253 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
254 shardManager.tell(new RoleChangeNotification(memberId,
255 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
257 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
259 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
261 DataTree mockDataTree = mock(DataTree.class);
262 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
263 DataStoreVersions.CURRENT_VERSION), mockShardActor);
265 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
267 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
268 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
269 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
270 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
275 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
276 new JavaTestKit(getSystem()) {{
277 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
279 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
281 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
282 // delayed until we send ActorInitialized and RoleChangeNotification.
283 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
285 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
287 shardManager.tell(new ActorInitialized(), mockShardActor);
289 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
291 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
292 shardManager.tell(new RoleChangeNotification(memberId,
293 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
295 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
297 DataTree mockDataTree = mock(DataTree.class);
298 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
299 DataStoreVersions.CURRENT_VERSION), 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)), DataStoreVersions.CURRENT_VERSION), 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 testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
426 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
428 // Create an ActorSystem ShardManager actor for member-1.
430 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
431 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
433 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
435 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
436 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
437 new MockConfiguration()), shardManagerID);
439 // Create an ActorSystem ShardManager actor for member-2.
441 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
443 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
445 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
447 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
448 put("default", Arrays.asList("member-1", "member-2")).build());
450 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
451 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
452 mockConfig2), shardManagerID);
454 new JavaTestKit(system1) {{
456 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
457 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
458 shardManager1.tell(new ActorInitialized(), mockShardActor1);
459 shardManager2.tell(new ActorInitialized(), mockShardActor2);
461 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
462 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
463 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
464 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
465 shardManager1.tell(new RoleChangeNotification(memberId1,
466 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
467 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
468 DataStoreVersions.CURRENT_VERSION),
470 shardManager2.tell(new RoleChangeNotification(memberId2,
471 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
472 shardManager1.underlyingActor().waitForMemberUp();
474 shardManager1.tell(new FindPrimary("default", true), getRef());
476 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
477 String path = found.getPrimaryPath();
478 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
480 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
481 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
483 shardManager1.underlyingActor().waitForUnreachableMember();
485 shardManager1.tell(new FindPrimary("default", true), getRef());
487 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
489 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
490 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
492 shardManager1.underlyingActor().waitForReachableMember();
494 shardManager1.tell(new FindPrimary("default", true), getRef());
496 RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
497 String path1 = found1.getPrimaryPath();
498 assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
502 JavaTestKit.shutdownActorSystem(system1);
503 JavaTestKit.shutdownActorSystem(system2);
507 public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
508 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
510 // Create an ActorSystem ShardManager actor for member-1.
512 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
513 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
515 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
517 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
518 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
519 new MockConfiguration()), shardManagerID);
521 // Create an ActorSystem ShardManager actor for member-2.
523 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
525 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
527 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
529 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
530 put("default", Arrays.asList("member-1", "member-2")).build());
532 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
533 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
534 mockConfig2), shardManagerID);
536 new JavaTestKit(system1) {{
538 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
539 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
540 shardManager1.tell(new ActorInitialized(), mockShardActor1);
541 shardManager2.tell(new ActorInitialized(), mockShardActor2);
543 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
544 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
545 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
546 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
547 shardManager1.tell(new RoleChangeNotification(memberId1,
548 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
549 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
550 DataStoreVersions.CURRENT_VERSION),
552 shardManager2.tell(new RoleChangeNotification(memberId2,
553 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
554 shardManager1.underlyingActor().waitForMemberUp();
556 shardManager1.tell(new FindPrimary("default", true), getRef());
558 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
559 String path = found.getPrimaryPath();
560 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
562 primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
563 mockShardActor1.path()), Optional.<DataTree>absent()));
565 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
566 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
568 shardManager1.underlyingActor().waitForUnreachableMember();
570 shardManager1.tell(new FindPrimary("default", true), getRef());
572 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
574 assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
576 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
577 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
578 shardManager1.tell(new RoleChangeNotification(memberId1,
579 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
581 shardManager1.tell(new FindPrimary("default", true), getRef());
583 LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
584 String path1 = found1.getPrimaryPath();
585 assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
589 JavaTestKit.shutdownActorSystem(system1);
590 JavaTestKit.shutdownActorSystem(system2);
595 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
596 new JavaTestKit(getSystem()) {{
597 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
599 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
601 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
603 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
605 assertEquals("getShardName", "non-existent", notFound.getShardName());
610 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
611 new JavaTestKit(getSystem()) {{
612 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
614 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
615 shardManager.tell(new ActorInitialized(), mockShardActor);
617 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
619 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
621 assertTrue("Found path contains " + found.getPath().path().toString(),
622 found.getPath().path().toString().contains("member-1-shard-default-config"));
627 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
628 new JavaTestKit(getSystem()) {{
629 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
631 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
633 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
638 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
639 new JavaTestKit(getSystem()) {{
640 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
642 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
644 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
645 // delayed until we send ActorInitialized.
646 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
647 new Timeout(5, TimeUnit.SECONDS));
649 shardManager.tell(new ActorInitialized(), mockShardActor);
651 Object resp = Await.result(future, duration("5 seconds"));
652 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
657 public void testOnRecoveryJournalIsCleaned() {
658 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
659 ImmutableSet.of("foo")));
660 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
661 ImmutableSet.of("bar")));
662 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
664 new JavaTestKit(getSystem()) {{
665 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
666 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
668 shardManager.underlyingActor().waitForRecoveryComplete();
669 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
671 // Journal entries up to the last one should've been deleted
672 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
673 synchronized (journal) {
674 assertEquals("Journal size", 0, journal.size());
680 public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
681 new JavaTestKit(getSystem()) {
683 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
685 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
686 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
687 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
689 verify(ready, never()).countDown();
691 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
692 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
694 verify(ready, times(1)).countDown();
700 public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
701 new JavaTestKit(getSystem()) {
703 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
705 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
706 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
707 memberId, null, RaftState.Follower.name()));
709 verify(ready, never()).countDown();
711 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
713 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
714 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
715 DataStoreVersions.CURRENT_VERSION));
717 verify(ready, times(1)).countDown();
723 public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
724 new JavaTestKit(getSystem()) {
726 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
728 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
729 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
730 memberId, null, RaftState.Follower.name()));
732 verify(ready, never()).countDown();
734 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
735 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
736 DataStoreVersions.CURRENT_VERSION));
738 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
740 verify(ready, times(1)).countDown();
746 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
747 new JavaTestKit(getSystem()) {
749 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
751 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
752 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
754 verify(ready, never()).countDown();
761 public void testByDefaultSyncStatusIsFalse() throws Exception{
762 final Props persistentProps = newShardMgrProps(true);
763 final TestActorRef<ShardManager> shardManager =
764 TestActorRef.create(getSystem(), persistentProps);
766 ShardManager shardManagerActor = shardManager.underlyingActor();
768 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
772 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
773 final Props persistentProps = ShardManager.props(
774 new MockClusterWrapper(),
775 new MockConfiguration(),
776 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
777 final TestActorRef<ShardManager> shardManager =
778 TestActorRef.create(getSystem(), persistentProps);
780 ShardManager shardManagerActor = shardManager.underlyingActor();
781 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
782 RaftState.Follower.name(), RaftState.Leader.name()));
784 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
788 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
789 final Props persistentProps = newShardMgrProps(true);
790 final TestActorRef<ShardManager> shardManager =
791 TestActorRef.create(getSystem(), persistentProps);
793 ShardManager shardManagerActor = shardManager.underlyingActor();
794 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
795 RaftState.Follower.name(), RaftState.Candidate.name()));
797 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
799 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
800 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
802 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
806 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
807 final Props persistentProps = ShardManager.props(
808 new MockClusterWrapper(),
809 new MockConfiguration(),
810 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
811 final TestActorRef<ShardManager> shardManager =
812 TestActorRef.create(getSystem(), persistentProps);
814 ShardManager shardManagerActor = shardManager.underlyingActor();
815 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
816 RaftState.Candidate.name(), RaftState.Follower.name()));
818 // Initially will be false
819 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
821 // Send status true will make sync status true
822 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
824 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
826 // Send status false will make sync status false
827 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
829 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
834 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
835 final Props persistentProps = ShardManager.props(
836 new MockClusterWrapper(),
837 new MockConfiguration() {
839 public List<String> getMemberShardNames(String memberName) {
840 return Arrays.asList("default", "astronauts");
843 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
844 final TestActorRef<ShardManager> shardManager =
845 TestActorRef.create(getSystem(), persistentProps);
847 ShardManager shardManagerActor = shardManager.underlyingActor();
849 // Initially will be false
850 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
852 // Make default shard leader
853 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
854 RaftState.Follower.name(), RaftState.Leader.name()));
856 // default = Leader, astronauts is unknown so sync status remains false
857 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
859 // Make astronauts shard leader as well
860 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
861 RaftState.Follower.name(), RaftState.Leader.name()));
863 // Now sync status should be true
864 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
866 // Make astronauts a Follower
867 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
868 RaftState.Leader.name(), RaftState.Follower.name()));
870 // Sync status is not true
871 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
873 // Make the astronauts follower sync status true
874 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
876 // Sync status is now true
877 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
881 private static class TestShardManager extends ShardManager {
882 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
884 TestShardManager(String shardMrgIDSuffix) {
885 super(new MockClusterWrapper(), new MockConfiguration(),
886 DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build(), ready,
887 new PrimaryShardInfoFutureCache());
891 public void handleRecover(Object message) throws Exception {
893 super.handleRecover(message);
895 if(message instanceof RecoveryCompleted) {
896 recoveryComplete.countDown();
901 void waitForRecoveryComplete() {
902 assertEquals("Recovery complete", true,
903 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
907 @SuppressWarnings("serial")
908 static class TestShardManagerCreator implements Creator<TestShardManager> {
909 String shardMrgIDSuffix;
911 TestShardManagerCreator(String shardMrgIDSuffix) {
912 this.shardMrgIDSuffix = shardMrgIDSuffix;
916 public TestShardManager create() throws Exception {
917 return new TestShardManager(shardMrgIDSuffix);
922 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
923 private static final long serialVersionUID = 1L;
924 private final Creator<ShardManager> delegate;
926 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
927 this.delegate = delegate;
931 public ShardManager create() throws Exception {
932 return delegate.create();
936 private static class ForwardingShardManager extends ShardManager {
937 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
938 private CountDownLatch memberUpReceived = new CountDownLatch(1);
939 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
940 private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
941 private CountDownLatch memberReachableReceived = new CountDownLatch(1);
942 private final ActorRef shardActor;
943 private final String name;
945 protected ForwardingShardManager(ClusterWrapper cluster, Configuration configuration,
946 DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch, String name,
947 ActorRef shardActor, PrimaryShardInfoFutureCache primaryShardInfoCache) {
948 super(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch, primaryShardInfoCache);
949 this.shardActor = shardActor;
954 public void handleCommand(Object message) throws Exception {
956 super.handleCommand(message);
958 if(message instanceof FindPrimary) {
959 findPrimaryMessageReceived.countDown();
960 } else if(message instanceof ClusterEvent.MemberUp) {
961 String role = ((ClusterEvent.MemberUp)message).member().roles().head();
962 if(!getCluster().getCurrentMemberName().equals(role)) {
963 memberUpReceived.countDown();
965 } else if(message instanceof ClusterEvent.MemberRemoved) {
966 String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
967 if(!getCluster().getCurrentMemberName().equals(role)) {
968 memberRemovedReceived.countDown();
970 } else if(message instanceof ClusterEvent.UnreachableMember) {
971 String role = ((ClusterEvent.UnreachableMember)message).member().roles().head();
972 if(!getCluster().getCurrentMemberName().equals(role)) {
973 memberUnreachableReceived.countDown();
975 } else if(message instanceof ClusterEvent.ReachableMember) {
976 String role = ((ClusterEvent.ReachableMember)message).member().roles().head();
977 if(!getCluster().getCurrentMemberName().equals(role)) {
978 memberReachableReceived.countDown();
985 public String persistenceId() {
990 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
994 void waitForMemberUp() {
995 assertEquals("MemberUp received", true,
996 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
997 memberUpReceived = new CountDownLatch(1);
1000 void waitForMemberRemoved() {
1001 assertEquals("MemberRemoved received", true,
1002 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
1003 memberRemovedReceived = new CountDownLatch(1);
1006 void waitForUnreachableMember() {
1007 assertEquals("UnreachableMember received", true,
1008 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
1010 memberUnreachableReceived = new CountDownLatch(1);
1013 void waitForReachableMember() {
1014 assertEquals("ReachableMember received", true,
1015 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
1016 memberReachableReceived = new CountDownLatch(1);
1019 void verifyFindPrimary() {
1020 assertEquals("FindPrimary received", true,
1021 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
1022 findPrimaryMessageReceived = new CountDownLatch(1);