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)
84 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(6);
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);
91 private final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
95 MockitoAnnotations.initMocks(this);
97 InMemoryJournal.clear();
99 if(mockShardActor == null) {
100 String name = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
101 mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), name);
104 mockShardActor.underlyingActor().clear();
108 public void tearDown() {
109 InMemoryJournal.clear();
112 private Props newShardMgrProps(boolean persistent) {
113 return ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
114 datastoreContextBuilder.persistent(persistent).build(), ready, primaryShardInfoCache);
117 private Props newPropsShardMgrWithMockShardActor() {
118 return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
119 new MockConfiguration());
122 private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
123 final ClusterWrapper clusterWrapper, final Configuration config) {
124 Creator<ShardManager> creator = new Creator<ShardManager>() {
125 private static final long serialVersionUID = 1L;
127 public ShardManager create() throws Exception {
128 return new ForwardingShardManager(clusterWrapper, config, datastoreContextBuilder.build(),
129 ready, name, shardActor, primaryShardInfoCache);
133 return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
137 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
138 new JavaTestKit(getSystem()) {{
139 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
141 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
143 shardManager.tell(new FindPrimary("non-existent", false), getRef());
145 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
150 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
151 new JavaTestKit(getSystem()) {{
152 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
154 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
156 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
157 shardManager.tell(new ActorInitialized(), mockShardActor);
159 DataTree mockDataTree = mock(DataTree.class);
160 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
161 DataStoreVersions.CURRENT_VERSION), getRef());
163 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
164 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
165 RaftState.Leader.name())), mockShardActor);
167 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
169 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
170 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
171 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
172 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
177 public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
178 new JavaTestKit(getSystem()) {{
179 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
181 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
182 shardManager.tell(new ActorInitialized(), mockShardActor);
184 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
185 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
186 shardManager.tell(new RoleChangeNotification(memberId1,
187 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
188 shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
190 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
192 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
197 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
198 new JavaTestKit(getSystem()) {{
199 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
201 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
202 shardManager.tell(new ActorInitialized(), mockShardActor);
204 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
205 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
207 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
208 shardManager.tell(new RoleChangeNotification(memberId1,
209 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
210 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
211 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
212 leaderVersion), 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"));
219 assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
224 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
225 new JavaTestKit(getSystem()) {{
226 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
228 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
230 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
235 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
236 new JavaTestKit(getSystem()) {{
237 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
239 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
240 shardManager.tell(new ActorInitialized(), mockShardActor);
242 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
244 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
249 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
250 new JavaTestKit(getSystem()) {{
251 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
253 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
254 shardManager.tell(new ActorInitialized(), mockShardActor);
256 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
257 shardManager.tell(new RoleChangeNotification(memberId,
258 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
260 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
262 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
264 DataTree mockDataTree = mock(DataTree.class);
265 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
266 DataStoreVersions.CURRENT_VERSION), mockShardActor);
268 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
270 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
271 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
272 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
273 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
278 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
279 new JavaTestKit(getSystem()) {{
280 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
282 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
284 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
285 // delayed until we send ActorInitialized and RoleChangeNotification.
286 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
288 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
290 shardManager.tell(new ActorInitialized(), mockShardActor);
292 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
294 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
295 shardManager.tell(new RoleChangeNotification(memberId,
296 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
298 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
300 DataTree mockDataTree = mock(DataTree.class);
301 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
302 DataStoreVersions.CURRENT_VERSION), mockShardActor);
304 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
305 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
306 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
307 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
309 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
314 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
315 new JavaTestKit(getSystem()) {{
316 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
318 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
320 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
322 expectMsgClass(duration("2 seconds"), NotInitializedException.class);
324 shardManager.tell(new ActorInitialized(), mockShardActor);
326 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
331 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
332 new JavaTestKit(getSystem()) {{
333 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
335 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
336 shardManager.tell(new ActorInitialized(), mockShardActor);
337 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
338 null, RaftState.Candidate.name()), mockShardActor);
340 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
342 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
347 public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
348 new JavaTestKit(getSystem()) {{
349 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
351 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
352 shardManager.tell(new ActorInitialized(), mockShardActor);
353 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
354 null, RaftState.IsolatedLeader.name()), mockShardActor);
356 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
358 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
363 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
364 new JavaTestKit(getSystem()) {{
365 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
367 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
368 shardManager.tell(new ActorInitialized(), mockShardActor);
370 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
372 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
377 public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
378 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
380 // Create an ActorSystem ShardManager actor for member-1.
382 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
383 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
385 ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
387 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
388 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
389 new MockConfiguration()), shardManagerID);
391 // Create an ActorSystem ShardManager actor for member-2.
393 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
395 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
397 final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
399 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
400 put("default", Arrays.asList("member-1", "member-2")).
401 put("astronauts", Arrays.asList("member-2")).build());
403 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
404 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
405 mockConfig2), shardManagerID);
407 new JavaTestKit(system1) {{
409 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
410 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
412 shardManager2.tell(new ActorInitialized(), mockShardActor2);
414 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
415 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
416 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
417 Optional.of(mock(DataTree.class)), leaderVersion), mockShardActor2);
418 shardManager2.tell(new RoleChangeNotification(memberId2,
419 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
421 shardManager1.underlyingActor().waitForMemberUp();
423 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
425 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
426 String path = found.getPrimaryPath();
427 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
428 assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
430 shardManager2.underlyingActor().verifyFindPrimary();
432 Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
434 shardManager1.underlyingActor().waitForMemberRemoved();
436 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
438 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
441 JavaTestKit.shutdownActorSystem(system1);
442 JavaTestKit.shutdownActorSystem(system2);
446 public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
447 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
449 // Create an ActorSystem ShardManager actor for member-1.
451 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
452 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
454 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
456 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
457 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
458 new MockConfiguration()), shardManagerID);
460 // Create an ActorSystem ShardManager actor for member-2.
462 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
464 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
466 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
468 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
469 put("default", Arrays.asList("member-1", "member-2")).build());
471 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
472 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
473 mockConfig2), shardManagerID);
475 new JavaTestKit(system1) {{
477 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
478 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
479 shardManager1.tell(new ActorInitialized(), mockShardActor1);
480 shardManager2.tell(new ActorInitialized(), mockShardActor2);
482 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
483 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
484 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
485 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
486 shardManager1.tell(new RoleChangeNotification(memberId1,
487 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
488 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
489 DataStoreVersions.CURRENT_VERSION),
491 shardManager2.tell(new RoleChangeNotification(memberId2,
492 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
493 shardManager1.underlyingActor().waitForMemberUp();
495 shardManager1.tell(new FindPrimary("default", true), getRef());
497 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
498 String path = found.getPrimaryPath();
499 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
501 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
502 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
504 shardManager1.underlyingActor().waitForUnreachableMember();
506 shardManager1.tell(new FindPrimary("default", true), getRef());
508 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
510 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
511 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
513 shardManager1.underlyingActor().waitForReachableMember();
515 shardManager1.tell(new FindPrimary("default", true), getRef());
517 RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
518 String path1 = found1.getPrimaryPath();
519 assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
523 JavaTestKit.shutdownActorSystem(system1);
524 JavaTestKit.shutdownActorSystem(system2);
528 public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
529 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
531 // Create an ActorSystem ShardManager actor for member-1.
533 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
534 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
536 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
538 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
539 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
540 new MockConfiguration()), shardManagerID);
542 // Create an ActorSystem ShardManager actor for member-2.
544 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
546 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
548 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
550 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
551 put("default", Arrays.asList("member-1", "member-2")).build());
553 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
554 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
555 mockConfig2), shardManagerID);
557 new JavaTestKit(system1) {{
559 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
560 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
561 shardManager1.tell(new ActorInitialized(), mockShardActor1);
562 shardManager2.tell(new ActorInitialized(), mockShardActor2);
564 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
565 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
566 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
567 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
568 shardManager1.tell(new RoleChangeNotification(memberId1,
569 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
570 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
571 DataStoreVersions.CURRENT_VERSION),
573 shardManager2.tell(new RoleChangeNotification(memberId2,
574 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
575 shardManager1.underlyingActor().waitForMemberUp();
577 shardManager1.tell(new FindPrimary("default", true), getRef());
579 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
580 String path = found.getPrimaryPath();
581 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
583 primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
584 mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION, Optional.<DataTree>absent()));
586 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
587 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
589 shardManager1.underlyingActor().waitForUnreachableMember();
591 shardManager1.tell(new FindPrimary("default", true), getRef());
593 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
595 assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
597 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
598 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
599 shardManager1.tell(new RoleChangeNotification(memberId1,
600 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
602 shardManager1.tell(new FindPrimary("default", true), getRef());
604 LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
605 String path1 = found1.getPrimaryPath();
606 assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
610 JavaTestKit.shutdownActorSystem(system1);
611 JavaTestKit.shutdownActorSystem(system2);
616 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
617 new JavaTestKit(getSystem()) {{
618 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
620 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
622 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
624 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
626 assertEquals("getShardName", "non-existent", notFound.getShardName());
631 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
632 new JavaTestKit(getSystem()) {{
633 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
635 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
636 shardManager.tell(new ActorInitialized(), mockShardActor);
638 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
640 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
642 assertTrue("Found path contains " + found.getPath().path().toString(),
643 found.getPath().path().toString().contains("member-1-shard-default-config"));
648 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
649 new JavaTestKit(getSystem()) {{
650 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
652 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
654 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
659 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
660 new JavaTestKit(getSystem()) {{
661 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
663 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
665 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
666 // delayed until we send ActorInitialized.
667 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
668 new Timeout(5, TimeUnit.SECONDS));
670 shardManager.tell(new ActorInitialized(), mockShardActor);
672 Object resp = Await.result(future, duration("5 seconds"));
673 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
678 public void testOnRecoveryJournalIsCleaned() {
679 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
680 ImmutableSet.of("foo")));
681 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
682 ImmutableSet.of("bar")));
683 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
685 new JavaTestKit(getSystem()) {{
686 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
687 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
689 shardManager.underlyingActor().waitForRecoveryComplete();
690 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
692 // Journal entries up to the last one should've been deleted
693 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
694 synchronized (journal) {
695 assertEquals("Journal size", 0, journal.size());
701 public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
702 new JavaTestKit(getSystem()) {
704 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
706 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
707 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
708 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
710 verify(ready, never()).countDown();
712 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
713 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
715 verify(ready, times(1)).countDown();
721 public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
722 new JavaTestKit(getSystem()) {
724 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
726 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
727 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
728 memberId, null, RaftState.Follower.name()));
730 verify(ready, never()).countDown();
732 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
734 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
735 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
736 DataStoreVersions.CURRENT_VERSION));
738 verify(ready, times(1)).countDown();
744 public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
745 new JavaTestKit(getSystem()) {
747 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
749 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
750 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
751 memberId, null, RaftState.Follower.name()));
753 verify(ready, never()).countDown();
755 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
756 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
757 DataStoreVersions.CURRENT_VERSION));
759 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
761 verify(ready, times(1)).countDown();
767 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
768 new JavaTestKit(getSystem()) {
770 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps(true));
772 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
773 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
775 verify(ready, never()).countDown();
782 public void testByDefaultSyncStatusIsFalse() throws Exception{
783 final Props persistentProps = newShardMgrProps(true);
784 final TestActorRef<ShardManager> shardManager =
785 TestActorRef.create(getSystem(), persistentProps);
787 ShardManager shardManagerActor = shardManager.underlyingActor();
789 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
793 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
794 final Props persistentProps = ShardManager.props(
795 new MockClusterWrapper(),
796 new MockConfiguration(),
797 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
798 final TestActorRef<ShardManager> shardManager =
799 TestActorRef.create(getSystem(), persistentProps);
801 ShardManager shardManagerActor = shardManager.underlyingActor();
802 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
803 RaftState.Follower.name(), RaftState.Leader.name()));
805 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
809 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
810 final Props persistentProps = newShardMgrProps(true);
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.Follower.name(), RaftState.Candidate.name()));
818 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
820 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
821 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
823 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
827 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
828 final Props persistentProps = ShardManager.props(
829 new MockClusterWrapper(),
830 new MockConfiguration(),
831 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
832 final TestActorRef<ShardManager> shardManager =
833 TestActorRef.create(getSystem(), persistentProps);
835 ShardManager shardManagerActor = shardManager.underlyingActor();
836 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
837 RaftState.Candidate.name(), RaftState.Follower.name()));
839 // Initially will be false
840 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
842 // Send status true will make sync status true
843 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
845 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
847 // Send status false will make sync status false
848 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
850 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
855 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
856 final Props persistentProps = ShardManager.props(
857 new MockClusterWrapper(),
858 new MockConfiguration() {
860 public List<String> getMemberShardNames(String memberName) {
861 return Arrays.asList("default", "astronauts");
864 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
865 final TestActorRef<ShardManager> shardManager =
866 TestActorRef.create(getSystem(), persistentProps);
868 ShardManager shardManagerActor = shardManager.underlyingActor();
870 // Initially will be false
871 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
873 // Make default shard leader
874 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
875 RaftState.Follower.name(), RaftState.Leader.name()));
877 // default = Leader, astronauts is unknown so sync status remains false
878 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
880 // Make astronauts shard leader as well
881 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
882 RaftState.Follower.name(), RaftState.Leader.name()));
884 // Now sync status should be true
885 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
887 // Make astronauts a Follower
888 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
889 RaftState.Leader.name(), RaftState.Follower.name()));
891 // Sync status is not true
892 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
894 // Make the astronauts follower sync status true
895 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
897 // Sync status is now true
898 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
902 private static class TestShardManager extends ShardManager {
903 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
905 TestShardManager(String shardMrgIDSuffix) {
906 super(new MockClusterWrapper(), new MockConfiguration(),
907 DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build(), ready,
908 new PrimaryShardInfoFutureCache());
912 public void handleRecover(Object message) throws Exception {
914 super.handleRecover(message);
916 if(message instanceof RecoveryCompleted) {
917 recoveryComplete.countDown();
922 void waitForRecoveryComplete() {
923 assertEquals("Recovery complete", true,
924 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
928 @SuppressWarnings("serial")
929 static class TestShardManagerCreator implements Creator<TestShardManager> {
930 String shardMrgIDSuffix;
932 TestShardManagerCreator(String shardMrgIDSuffix) {
933 this.shardMrgIDSuffix = shardMrgIDSuffix;
937 public TestShardManager create() throws Exception {
938 return new TestShardManager(shardMrgIDSuffix);
943 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
944 private static final long serialVersionUID = 1L;
945 private final Creator<ShardManager> delegate;
947 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
948 this.delegate = delegate;
952 public ShardManager create() throws Exception {
953 return delegate.create();
957 private static class ForwardingShardManager extends ShardManager {
958 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
959 private CountDownLatch memberUpReceived = new CountDownLatch(1);
960 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
961 private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
962 private CountDownLatch memberReachableReceived = new CountDownLatch(1);
963 private final ActorRef shardActor;
964 private final String name;
966 protected ForwardingShardManager(ClusterWrapper cluster, Configuration configuration,
967 DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch, String name,
968 ActorRef shardActor, PrimaryShardInfoFutureCache primaryShardInfoCache) {
969 super(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch, primaryShardInfoCache);
970 this.shardActor = shardActor;
975 public void handleCommand(Object message) throws Exception {
977 super.handleCommand(message);
979 if(message instanceof FindPrimary) {
980 findPrimaryMessageReceived.countDown();
981 } else if(message instanceof ClusterEvent.MemberUp) {
982 String role = ((ClusterEvent.MemberUp)message).member().roles().head();
983 if(!getCluster().getCurrentMemberName().equals(role)) {
984 memberUpReceived.countDown();
986 } else if(message instanceof ClusterEvent.MemberRemoved) {
987 String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
988 if(!getCluster().getCurrentMemberName().equals(role)) {
989 memberRemovedReceived.countDown();
991 } else if(message instanceof ClusterEvent.UnreachableMember) {
992 String role = ((ClusterEvent.UnreachableMember)message).member().roles().head();
993 if(!getCluster().getCurrentMemberName().equals(role)) {
994 memberUnreachableReceived.countDown();
996 } else if(message instanceof ClusterEvent.ReachableMember) {
997 String role = ((ClusterEvent.ReachableMember)message).member().roles().head();
998 if(!getCluster().getCurrentMemberName().equals(role)) {
999 memberReachableReceived.countDown();
1006 public String persistenceId() {
1011 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
1015 void waitForMemberUp() {
1016 assertEquals("MemberUp received", true,
1017 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
1018 memberUpReceived = new CountDownLatch(1);
1021 void waitForMemberRemoved() {
1022 assertEquals("MemberRemoved received", true,
1023 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
1024 memberRemovedReceived = new CountDownLatch(1);
1027 void waitForUnreachableMember() {
1028 assertEquals("UnreachableMember received", true,
1029 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
1031 memberUnreachableReceived = new CountDownLatch(1);
1034 void waitForReachableMember() {
1035 assertEquals("ReachableMember received", true,
1036 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
1037 memberReachableReceived = new CountDownLatch(1);
1040 void verifyFindPrimary() {
1041 assertEquals("FindPrimary received", true,
1042 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
1043 findPrimaryMessageReceived = new CountDownLatch(1);