2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.datastore;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertNull;
14 import static org.junit.Assert.assertSame;
15 import static org.junit.Assert.assertTrue;
16 import static org.mockito.Mockito.mock;
17 import static org.mockito.Mockito.never;
18 import static org.mockito.Mockito.times;
19 import static org.mockito.Mockito.verify;
20 import akka.actor.ActorRef;
21 import akka.actor.ActorSystem;
22 import akka.actor.AddressFromURIString;
23 import akka.actor.PoisonPill;
24 import akka.actor.Props;
25 import akka.actor.Status;
26 import akka.actor.Status.Failure;
27 import akka.cluster.Cluster;
28 import akka.cluster.ClusterEvent;
29 import akka.dispatch.Dispatchers;
30 import akka.japi.Creator;
31 import akka.pattern.Patterns;
32 import akka.persistence.RecoveryCompleted;
33 import akka.testkit.JavaTestKit;
34 import akka.testkit.TestActorRef;
35 import akka.util.Timeout;
36 import com.google.common.base.Optional;
37 import com.google.common.collect.ImmutableMap;
38 import com.google.common.collect.ImmutableSet;
39 import com.google.common.collect.Sets;
40 import com.google.common.util.concurrent.Uninterruptibles;
41 import com.typesafe.config.ConfigFactory;
43 import java.util.AbstractMap;
44 import java.util.Arrays;
45 import java.util.Collection;
46 import java.util.Collections;
47 import java.util.HashMap;
48 import java.util.HashSet;
49 import java.util.List;
51 import java.util.Map.Entry;
53 import java.util.concurrent.CountDownLatch;
54 import java.util.concurrent.TimeUnit;
55 import org.junit.After;
56 import org.junit.Before;
57 import org.junit.Test;
58 import org.mockito.Mock;
59 import org.mockito.Mockito;
60 import org.mockito.MockitoAnnotations;
61 import org.opendaylight.controller.cluster.datastore.config.Configuration;
62 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
63 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
64 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
65 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
66 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
67 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
68 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
69 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
70 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
71 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
72 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
73 import org.opendaylight.controller.cluster.datastore.messages.CreateShardReply;
74 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot;
75 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot.ShardSnapshot;
76 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
77 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
78 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
79 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
80 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
81 import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
82 import org.opendaylight.controller.cluster.datastore.messages.PeerUp;
83 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
84 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
85 import org.opendaylight.controller.cluster.datastore.messages.RemoveShardReplica;
86 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
87 import org.opendaylight.controller.cluster.datastore.messages.SwitchShardBehavior;
88 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
89 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
90 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
91 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
92 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
93 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
94 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
95 import org.opendaylight.controller.cluster.raft.RaftState;
96 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
97 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
98 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
99 import org.opendaylight.controller.cluster.raft.messages.AddServer;
100 import org.opendaylight.controller.cluster.raft.messages.AddServerReply;
101 import org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus;
102 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
103 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
104 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
105 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
106 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
107 import scala.concurrent.Await;
108 import scala.concurrent.Future;
109 import scala.concurrent.duration.FiniteDuration;
111 public class ShardManagerTest extends AbstractActorTest {
112 private static int ID_COUNTER = 1;
114 private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
115 private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix;
118 private static CountDownLatch ready;
120 private static TestActorRef<MessageCollectorActor> mockShardActor;
122 private static String mockShardName;
124 private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
125 dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS)
126 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(6);
128 private static ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
129 String name = new ShardIdentifier(shardName, memberName,"config").toString();
130 return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
133 private final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
136 public void setUp() {
137 MockitoAnnotations.initMocks(this);
139 InMemoryJournal.clear();
141 if(mockShardActor == null) {
142 mockShardName = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
143 mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), mockShardName);
146 mockShardActor.underlyingActor().clear();
150 public void tearDown() {
151 InMemoryJournal.clear();
154 private Props newShardMgrProps() {
155 return newShardMgrProps(new MockConfiguration());
158 private static DatastoreContextFactory newDatastoreContextFactory(DatastoreContext datastoreContext) {
159 DatastoreContextFactory mockFactory = mock(DatastoreContextFactory.class);
160 Mockito.doReturn(datastoreContext).when(mockFactory).getBaseDatastoreContext();
161 Mockito.doReturn(datastoreContext).when(mockFactory).getShardDatastoreContext(Mockito.anyString());
165 private Props newShardMgrProps(Configuration config) {
166 return ShardManager.props(new MockClusterWrapper(), config,
167 newDatastoreContextFactory(datastoreContextBuilder.build()), ready, primaryShardInfoCache);
170 private Props newPropsShardMgrWithMockShardActor() {
171 return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
172 new MockConfiguration());
175 private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
176 final ClusterWrapper clusterWrapper, final Configuration config) {
177 Creator<ShardManager> creator = new Creator<ShardManager>() {
178 private static final long serialVersionUID = 1L;
180 public ShardManager create() throws Exception {
181 return new ForwardingShardManager(clusterWrapper, config, newDatastoreContextFactory(
182 datastoreContextBuilder.build()), ready, name, shardActor, primaryShardInfoCache);
186 return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
190 public void testPerShardDatastoreContext() throws Exception {
191 final DatastoreContextFactory mockFactory = newDatastoreContextFactory(
192 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
194 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
195 shardElectionTimeoutFactor(6).build()).when(mockFactory).getShardDatastoreContext("default");
197 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
198 shardElectionTimeoutFactor(7).build()).when(mockFactory).getShardDatastoreContext("topology");
200 final MockConfiguration mockConfig = new MockConfiguration() {
202 public Collection<String> getMemberShardNames(String memberName) {
203 return Arrays.asList("default", "topology");
207 public Collection<String> getMembersFromShardName(String shardName) {
208 return Arrays.asList("member-1");
212 final TestActorRef<MessageCollectorActor> defaultShardActor = TestActorRef.create(getSystem(),
213 Props.create(MessageCollectorActor.class), "default");
214 final TestActorRef<MessageCollectorActor> topologyShardActor = TestActorRef.create(getSystem(),
215 Props.create(MessageCollectorActor.class), "topology");
217 final Map<String, Entry<ActorRef, DatastoreContext>> shardInfoMap = Collections.synchronizedMap(
218 new HashMap<String, Entry<ActorRef, DatastoreContext>>());
219 shardInfoMap.put("default", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(defaultShardActor, null));
220 shardInfoMap.put("topology", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(topologyShardActor, null));
222 final CountDownLatch newShardActorLatch = new CountDownLatch(2);
223 final Creator<ShardManager> creator = new Creator<ShardManager>() {
224 private static final long serialVersionUID = 1L;
226 public ShardManager create() throws Exception {
227 return new ShardManager(new MockClusterWrapper(), mockConfig, mockFactory, ready, primaryShardInfoCache) {
229 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
230 Entry<ActorRef, DatastoreContext> entry = shardInfoMap.get(info.getShardName());
233 ref = entry.getKey();
234 entry.setValue(info.getDatastoreContext());
237 newShardActorLatch.countDown();
244 JavaTestKit kit = new JavaTestKit(getSystem());
246 final ActorRef shardManager = getSystem().actorOf(Props.create(new DelegatingShardManagerCreator(creator)).
247 withDispatcher(Dispatchers.DefaultDispatcherId()));
249 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), kit.getRef());
251 assertEquals("Shard actors created", true, newShardActorLatch.await(5, TimeUnit.SECONDS));
252 assertEquals("getShardElectionTimeoutFactor", 6, shardInfoMap.get("default").getValue().
253 getShardElectionTimeoutFactor());
254 assertEquals("getShardElectionTimeoutFactor", 7, shardInfoMap.get("topology").getValue().
255 getShardElectionTimeoutFactor());
257 DatastoreContextFactory newMockFactory = newDatastoreContextFactory(
258 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
259 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
260 shardElectionTimeoutFactor(66).build()).when(newMockFactory).getShardDatastoreContext("default");
262 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
263 shardElectionTimeoutFactor(77).build()).when(newMockFactory).getShardDatastoreContext("topology");
265 shardManager.tell(newMockFactory, kit.getRef());
267 DatastoreContext newContext = MessageCollectorActor.expectFirstMatching(defaultShardActor, DatastoreContext.class);
268 assertEquals("getShardElectionTimeoutFactor", 66, newContext.getShardElectionTimeoutFactor());
270 newContext = MessageCollectorActor.expectFirstMatching(topologyShardActor, DatastoreContext.class);
271 assertEquals("getShardElectionTimeoutFactor", 77, newContext.getShardElectionTimeoutFactor());
273 defaultShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
274 topologyShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
278 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
279 new JavaTestKit(getSystem()) {{
280 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
282 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
284 shardManager.tell(new FindPrimary("non-existent", false), getRef());
286 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
291 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
292 new JavaTestKit(getSystem()) {{
293 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
295 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
297 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
298 shardManager.tell(new ActorInitialized(), mockShardActor);
300 DataTree mockDataTree = mock(DataTree.class);
301 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
302 DataStoreVersions.CURRENT_VERSION), getRef());
304 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
305 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
306 RaftState.Leader.name())), mockShardActor);
308 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
310 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
311 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
312 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
313 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
318 public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
319 new JavaTestKit(getSystem()) {{
320 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
322 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
323 shardManager.tell(new ActorInitialized(), mockShardActor);
325 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
326 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
327 shardManager.tell(new RoleChangeNotification(memberId1,
328 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
329 shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
331 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
333 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
338 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
339 new JavaTestKit(getSystem()) {{
340 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
342 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
343 shardManager.tell(new ActorInitialized(), mockShardActor);
345 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
346 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
348 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
349 shardManager.tell(new RoleChangeNotification(memberId1,
350 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
351 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
352 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
353 leaderVersion), mockShardActor);
355 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
357 RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
358 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
359 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
360 assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
365 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
366 new JavaTestKit(getSystem()) {{
367 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
369 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
371 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
376 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
377 new JavaTestKit(getSystem()) {{
378 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
380 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
381 shardManager.tell(new ActorInitialized(), mockShardActor);
383 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
385 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
390 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
391 new JavaTestKit(getSystem()) {{
392 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
394 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
395 shardManager.tell(new ActorInitialized(), mockShardActor);
397 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
398 shardManager.tell(new RoleChangeNotification(memberId,
399 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
401 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
403 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
405 DataTree mockDataTree = mock(DataTree.class);
406 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
407 DataStoreVersions.CURRENT_VERSION), mockShardActor);
409 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
411 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
412 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
413 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
414 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
419 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
420 new JavaTestKit(getSystem()) {{
421 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
423 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
425 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
426 // delayed until we send ActorInitialized and RoleChangeNotification.
427 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
429 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
431 shardManager.tell(new ActorInitialized(), mockShardActor);
433 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
435 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
436 shardManager.tell(new RoleChangeNotification(memberId,
437 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
439 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
441 DataTree mockDataTree = mock(DataTree.class);
442 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
443 DataStoreVersions.CURRENT_VERSION), mockShardActor);
445 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
446 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
447 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
448 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
450 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
455 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
456 new JavaTestKit(getSystem()) {{
457 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
459 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
461 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
463 expectMsgClass(duration("2 seconds"), NotInitializedException.class);
465 shardManager.tell(new ActorInitialized(), mockShardActor);
467 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
472 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
473 new JavaTestKit(getSystem()) {{
474 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
476 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
477 shardManager.tell(new ActorInitialized(), mockShardActor);
478 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
479 null, RaftState.Candidate.name()), mockShardActor);
481 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
483 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
488 public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
489 new JavaTestKit(getSystem()) {{
490 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
492 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
493 shardManager.tell(new ActorInitialized(), mockShardActor);
494 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
495 null, RaftState.IsolatedLeader.name()), mockShardActor);
497 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
499 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
504 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
505 new JavaTestKit(getSystem()) {{
506 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
508 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
509 shardManager.tell(new ActorInitialized(), mockShardActor);
511 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
513 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
518 public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
519 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
521 // Create an ActorSystem ShardManager actor for member-1.
523 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
524 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
526 ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
528 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
529 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
530 new MockConfiguration()), shardManagerID);
532 // Create an ActorSystem ShardManager actor for member-2.
534 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
536 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
538 final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
540 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
541 put("default", Arrays.asList("member-1", "member-2")).
542 put("astronauts", Arrays.asList("member-2")).build());
544 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
545 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
546 mockConfig2), shardManagerID);
548 new JavaTestKit(system1) {{
550 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
551 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
553 shardManager2.tell(new ActorInitialized(), mockShardActor2);
555 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
556 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
557 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
558 Optional.of(mock(DataTree.class)), leaderVersion), mockShardActor2);
559 shardManager2.tell(new RoleChangeNotification(memberId2,
560 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
562 shardManager1.underlyingActor().waitForMemberUp();
564 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
566 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
567 String path = found.getPrimaryPath();
568 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
569 assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
571 shardManager2.underlyingActor().verifyFindPrimary();
573 Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
575 shardManager1.underlyingActor().waitForMemberRemoved();
577 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
579 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
582 JavaTestKit.shutdownActorSystem(system1);
583 JavaTestKit.shutdownActorSystem(system2);
587 public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
588 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
590 // Create an ActorSystem ShardManager actor for member-1.
592 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
593 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
595 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
597 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
598 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
599 new MockConfiguration()), shardManagerID);
601 // Create an ActorSystem ShardManager actor for member-2.
603 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
605 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
607 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
609 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
610 put("default", Arrays.asList("member-1", "member-2")).build());
612 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
613 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
614 mockConfig2), shardManagerID);
616 new JavaTestKit(system1) {{
618 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
619 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
620 shardManager1.tell(new ActorInitialized(), mockShardActor1);
621 shardManager2.tell(new ActorInitialized(), mockShardActor2);
623 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
624 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
625 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
626 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
627 shardManager1.tell(new RoleChangeNotification(memberId1,
628 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
629 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
630 DataStoreVersions.CURRENT_VERSION),
632 shardManager2.tell(new RoleChangeNotification(memberId2,
633 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
634 shardManager1.underlyingActor().waitForMemberUp();
636 shardManager1.tell(new FindPrimary("default", true), getRef());
638 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
639 String path = found.getPrimaryPath();
640 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
642 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
643 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
645 shardManager1.underlyingActor().waitForUnreachableMember();
647 PeerDown peerDown = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
648 assertEquals("getMemberName", "member-2", peerDown.getMemberName());
649 MessageCollectorActor.clearMessages(mockShardActor1);
651 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
652 createMemberRemoved("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
654 MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
656 shardManager1.tell(new FindPrimary("default", true), getRef());
658 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
660 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
661 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
663 shardManager1.underlyingActor().waitForReachableMember();
665 PeerUp peerUp = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
666 assertEquals("getMemberName", "member-2", peerUp.getMemberName());
667 MessageCollectorActor.clearMessages(mockShardActor1);
669 shardManager1.tell(new FindPrimary("default", true), getRef());
671 RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
672 String path1 = found1.getPrimaryPath();
673 assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
675 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
676 createMemberUp("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
678 MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
682 JavaTestKit.shutdownActorSystem(system1);
683 JavaTestKit.shutdownActorSystem(system2);
687 public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
688 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
690 // Create an ActorSystem ShardManager actor for member-1.
692 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
693 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
695 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
697 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
698 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
699 new MockConfiguration()), shardManagerID);
701 // Create an ActorSystem ShardManager actor for member-2.
703 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
705 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
707 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
709 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
710 put("default", Arrays.asList("member-1", "member-2")).build());
712 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
713 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
714 mockConfig2), shardManagerID);
716 new JavaTestKit(system1) {{
718 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
719 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
720 shardManager1.tell(new ActorInitialized(), mockShardActor1);
721 shardManager2.tell(new ActorInitialized(), mockShardActor2);
723 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
724 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
725 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
726 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
727 shardManager1.tell(new RoleChangeNotification(memberId1,
728 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
729 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
730 DataStoreVersions.CURRENT_VERSION),
732 shardManager2.tell(new RoleChangeNotification(memberId2,
733 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
734 shardManager1.underlyingActor().waitForMemberUp();
736 shardManager1.tell(new FindPrimary("default", true), getRef());
738 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
739 String path = found.getPrimaryPath();
740 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
742 primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
743 mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION, Optional.<DataTree>absent()));
745 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
746 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
748 shardManager1.underlyingActor().waitForUnreachableMember();
750 shardManager1.tell(new FindPrimary("default", true), getRef());
752 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
754 assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
756 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
757 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
758 shardManager1.tell(new RoleChangeNotification(memberId1,
759 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
761 shardManager1.tell(new FindPrimary("default", true), getRef());
763 LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
764 String path1 = found1.getPrimaryPath();
765 assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
769 JavaTestKit.shutdownActorSystem(system1);
770 JavaTestKit.shutdownActorSystem(system2);
775 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
776 new JavaTestKit(getSystem()) {{
777 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
779 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
781 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
783 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
785 assertEquals("getShardName", "non-existent", notFound.getShardName());
790 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
791 new JavaTestKit(getSystem()) {{
792 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
794 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
795 shardManager.tell(new ActorInitialized(), mockShardActor);
797 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
799 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
801 assertTrue("Found path contains " + found.getPath().path().toString(),
802 found.getPath().path().toString().contains("member-1-shard-default-config"));
807 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
808 new JavaTestKit(getSystem()) {{
809 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
811 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
813 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
818 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
819 new JavaTestKit(getSystem()) {{
820 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
822 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
824 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
825 // delayed until we send ActorInitialized.
826 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
827 new Timeout(5, TimeUnit.SECONDS));
829 shardManager.tell(new ActorInitialized(), mockShardActor);
831 Object resp = Await.result(future, duration("5 seconds"));
832 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
837 public void testOnRecoveryJournalIsCleaned() {
838 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
839 ImmutableSet.of("foo")));
840 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
841 ImmutableSet.of("bar")));
842 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
844 new JavaTestKit(getSystem()) {{
845 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
846 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
848 shardManager.underlyingActor().waitForRecoveryComplete();
849 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
851 // Journal entries up to the last one should've been deleted
852 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
853 synchronized (journal) {
854 assertEquals("Journal size", 0, journal.size());
860 public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
861 new JavaTestKit(getSystem()) {
863 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
865 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
866 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
867 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
869 verify(ready, never()).countDown();
871 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
872 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
874 verify(ready, times(1)).countDown();
880 public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
881 new JavaTestKit(getSystem()) {
883 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
885 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
886 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
887 memberId, null, RaftState.Follower.name()));
889 verify(ready, never()).countDown();
891 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
893 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
894 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
895 DataStoreVersions.CURRENT_VERSION));
897 verify(ready, times(1)).countDown();
903 public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
904 new JavaTestKit(getSystem()) {
906 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
908 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
909 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
910 memberId, null, RaftState.Follower.name()));
912 verify(ready, never()).countDown();
914 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
915 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
916 DataStoreVersions.CURRENT_VERSION));
918 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
920 verify(ready, times(1)).countDown();
926 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
927 new JavaTestKit(getSystem()) {
929 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
931 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
932 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
934 verify(ready, never()).countDown();
941 public void testByDefaultSyncStatusIsFalse() throws Exception{
942 final Props persistentProps = newShardMgrProps();
943 final TestActorRef<ShardManager> shardManager =
944 TestActorRef.create(getSystem(), persistentProps);
946 ShardManager shardManagerActor = shardManager.underlyingActor();
948 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
952 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
953 final Props persistentProps = ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
954 newDatastoreContextFactory(DatastoreContext.newBuilder().persistent(true).build()), ready,
955 primaryShardInfoCache);
956 final TestActorRef<ShardManager> shardManager =
957 TestActorRef.create(getSystem(), persistentProps);
959 ShardManager shardManagerActor = shardManager.underlyingActor();
960 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
961 RaftState.Follower.name(), RaftState.Leader.name()));
963 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
967 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
968 final Props persistentProps = newShardMgrProps();
969 final TestActorRef<ShardManager> shardManager =
970 TestActorRef.create(getSystem(), persistentProps);
972 ShardManager shardManagerActor = shardManager.underlyingActor();
973 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
974 RaftState.Follower.name(), RaftState.Candidate.name()));
976 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
978 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
979 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
981 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
985 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
986 final Props persistentProps = ShardManager.props(new MockClusterWrapper(), new MockConfiguration(),
987 newDatastoreContextFactory(DatastoreContext.newBuilder().persistent(true).build()), ready,
988 primaryShardInfoCache);
989 final TestActorRef<ShardManager> shardManager =
990 TestActorRef.create(getSystem(), persistentProps);
992 ShardManager shardManagerActor = shardManager.underlyingActor();
993 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
994 RaftState.Candidate.name(), RaftState.Follower.name()));
996 // Initially will be false
997 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
999 // Send status true will make sync status true
1000 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
1002 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
1004 // Send status false will make sync status false
1005 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
1007 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1012 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
1013 final Props persistentProps = ShardManager.props(new MockClusterWrapper(),
1014 new MockConfiguration() {
1016 public List<String> getMemberShardNames(String memberName) {
1017 return Arrays.asList("default", "astronauts");
1020 newDatastoreContextFactory(DatastoreContext.newBuilder().persistent(true).build()), ready,
1021 primaryShardInfoCache);
1022 final TestActorRef<ShardManager> shardManager =
1023 TestActorRef.create(getSystem(), persistentProps);
1025 ShardManager shardManagerActor = shardManager.underlyingActor();
1027 // Initially will be false
1028 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1030 // Make default shard leader
1031 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
1032 RaftState.Follower.name(), RaftState.Leader.name()));
1034 // default = Leader, astronauts is unknown so sync status remains false
1035 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1037 // Make astronauts shard leader as well
1038 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
1039 RaftState.Follower.name(), RaftState.Leader.name()));
1041 // Now sync status should be true
1042 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
1044 // Make astronauts a Follower
1045 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
1046 RaftState.Leader.name(), RaftState.Follower.name()));
1048 // Sync status is not true
1049 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1051 // Make the astronauts follower sync status true
1052 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
1054 // Sync status is now true
1055 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
1060 public void testOnReceiveSwitchShardBehavior() throws Exception {
1061 new JavaTestKit(getSystem()) {{
1062 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
1064 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1065 shardManager.tell(new ActorInitialized(), mockShardActor);
1067 shardManager.tell(new SwitchShardBehavior(mockShardName, "Leader", 1000), getRef());
1069 SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor, SwitchBehavior.class);
1071 assertEquals(RaftState.Leader, switchBehavior.getNewState());
1072 assertEquals(1000, switchBehavior.getNewTerm());
1077 public void testOnReceiveCreateShard() {
1078 new JavaTestKit(getSystem()) {{
1079 datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1081 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1082 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1084 SchemaContext schemaContext = TestModel.createTestContext();
1085 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1087 DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100).
1088 persistent(false).build();
1089 Shard.Builder shardBuilder = Shard.builder();
1091 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1092 "foo", null, Arrays.asList("member-1", "member-5", "member-6"));
1093 shardManager.tell(new CreateShard(config, shardBuilder, datastoreContext), getRef());
1095 expectMsgClass(duration("5 seconds"), CreateShardReply.class);
1097 shardManager.tell(new FindLocalShard("foo", true), getRef());
1099 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1101 assertEquals("isRecoveryApplicable", false, shardBuilder.getDatastoreContext().isPersistent());
1102 assertTrue("Epxected ShardPeerAddressResolver", shardBuilder.getDatastoreContext().getShardRaftConfig().
1103 getPeerAddressResolver() instanceof ShardPeerAddressResolver);
1104 assertEquals("peerMembers", Sets.newHashSet(new ShardIdentifier("foo", "member-5", shardMrgIDSuffix).toString(),
1105 new ShardIdentifier("foo", "member-6", shardMrgIDSuffix).toString()),
1106 shardBuilder.getPeerAddresses().keySet());
1107 assertEquals("ShardIdentifier", new ShardIdentifier("foo", "member-1", shardMrgIDSuffix),
1108 shardBuilder.getId());
1109 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1111 // Send CreateShard with same name - should fail.
1113 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1115 expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
1120 public void testOnReceiveCreateShardWithNoInitialSchemaContext() {
1121 new JavaTestKit(getSystem()) {{
1122 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1123 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1125 Shard.Builder shardBuilder = Shard.builder();
1127 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1128 "foo", null, Arrays.asList("member-1"));
1129 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1131 expectMsgClass(duration("5 seconds"), CreateShardReply.class);
1133 SchemaContext schemaContext = TestModel.createTestContext();
1134 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1136 shardManager.tell(new FindLocalShard("foo", true), getRef());
1138 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1140 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1141 assertNotNull("schemaContext is null", shardBuilder.getDatastoreContext());
1146 public void testGetSnapshot() throws Throwable {
1147 JavaTestKit kit = new JavaTestKit(getSystem());
1149 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1150 put("shard1", Arrays.asList("member-1")).
1151 put("shard2", Arrays.asList("member-1")).build());
1153 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(mockConfig).withDispatcher(
1154 Dispatchers.DefaultDispatcherId()));
1156 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1157 Failure failure = kit.expectMsgClass(Failure.class);
1158 assertEquals("Failure cause type", IllegalStateException.class, failure.cause().getClass());
1160 kit = new JavaTestKit(getSystem());
1162 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1164 shardManager.tell(new FindLocalShard("shard1", true), kit.getRef());
1165 kit.expectMsgClass(LocalShardFound.class);
1166 shardManager.tell(new FindLocalShard("shard2", true), kit.getRef());
1167 kit.expectMsgClass(LocalShardFound.class);
1169 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1171 DatastoreSnapshot datastoreSnapshot = kit.expectMsgClass(DatastoreSnapshot.class);
1173 assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1174 List<ShardSnapshot> shardSnapshots = datastoreSnapshot.getShardSnapshots();
1175 Set<String> actualShardNames = new HashSet<>();
1176 for(ShardSnapshot s: shardSnapshots) {
1177 actualShardNames.add(s.getName());
1180 assertEquals("Shard names", Sets.newHashSet("shard1", "shard2"), actualShardNames);
1182 shardManager.tell(PoisonPill.getInstance(), ActorRef.noSender());
1186 public void testAddShardReplicaForNonExistentShard() throws Exception {
1187 new JavaTestKit(getSystem()) {{
1188 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1189 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1191 shardManager.tell(new AddShardReplica("model-inventory"), getRef());
1192 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1194 assertEquals("Failure obtained", true,
1195 (resp.cause() instanceof IllegalArgumentException));
1200 public void testAddShardReplicaForAlreadyCreatedShard() throws Exception {
1201 new JavaTestKit(getSystem()) {{
1202 ActorRef shardManager = getSystem().actorOf(newShardMgrProps());
1203 shardManager.tell(new AddShardReplica("default"), getRef());
1204 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1205 assertEquals("Failure obtained", true,
1206 (resp.cause() instanceof IllegalArgumentException));
1211 public void testAddShardReplica() throws Exception {
1212 MockConfiguration mockConfig =
1213 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1214 put("default", Arrays.asList("member-1", "member-2")).
1215 put("astronauts", Arrays.asList("member-2")).build());
1217 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1219 // Create an ActorSystem ShardManager actor for member-1.
1220 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
1221 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1222 ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1223 final TestActorRef<ForwardingShardManager> newReplicaShardManager = TestActorRef.create(system1,
1224 newPropsShardMgrWithMockShardActor("shardManager1", mockDefaultShardActor,
1225 new ClusterWrapperImpl(system1), mockConfig), shardManagerID);
1227 // Create an ActorSystem ShardManager actor for member-2.
1228 final ActorSystem system2 = ActorSystem.create("cluster-test",
1229 ConfigFactory.load().getConfig("Member2"));
1230 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1232 String name = new ShardIdentifier("astronauts", "member-2", "config").toString();
1233 final TestActorRef<MockRespondActor> mockShardLeaderActor =
1234 TestActorRef.create(system2, Props.create(MockRespondActor.class), name);
1235 final TestActorRef<ForwardingShardManager> leaderShardManager = TestActorRef.create(system2,
1236 newPropsShardMgrWithMockShardActor("shardManager2", mockShardLeaderActor,
1237 new ClusterWrapperImpl(system2), mockConfig), shardManagerID);
1239 new JavaTestKit(system1) {{
1241 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1242 leaderShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1244 leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1246 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
1247 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1248 leaderShardManager.tell(new ShardLeaderStateChanged(memberId2, memberId2,
1249 Optional.of(mock(DataTree.class)), leaderVersion), mockShardLeaderActor);
1250 leaderShardManager.tell(new RoleChangeNotification(memberId2,
1251 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardLeaderActor);
1253 newReplicaShardManager.underlyingActor().waitForMemberUp();
1254 leaderShardManager.underlyingActor().waitForMemberUp();
1256 //construct a mock response message
1257 AddServerReply response = new AddServerReply(ServerChangeStatus.OK, memberId2);
1258 mockShardLeaderActor.underlyingActor().updateResponse(response);
1259 newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1260 AddServer addServerMsg = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1262 String addServerId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1263 assertEquals("AddServer serverId", addServerId, addServerMsg.getNewServerId());
1265 expectMsgClass(duration("5 seconds"), Status.Success.class);
1268 JavaTestKit.shutdownActorSystem(system1);
1269 JavaTestKit.shutdownActorSystem(system2);
1273 public void testAddShardReplicaWithFindPrimaryTimeout() throws Exception {
1274 MockConfiguration mockConfig =
1275 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1276 put("default", Arrays.asList("member-1", "member-2")).
1277 put("astronauts", Arrays.asList("member-2")).build());
1279 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1281 // Create an ActorSystem ShardManager actor for member-1.
1282 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
1283 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1284 ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1285 final TestActorRef<ForwardingShardManager> newReplicaShardManager = TestActorRef.create(system1,
1286 newPropsShardMgrWithMockShardActor("shardManager1", mockDefaultShardActor,
1287 new ClusterWrapperImpl(system1), mockConfig), shardManagerID);
1289 new JavaTestKit(system1) {{
1291 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1292 MockClusterWrapper.sendMemberUp(newReplicaShardManager, "member-2", getRef().path().toString());
1293 newReplicaShardManager.underlyingActor().waitForMemberUp();
1295 newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1296 Status.Failure resp = expectMsgClass(duration("5 seconds"), Status.Failure.class);
1297 assertEquals("Failure obtained", true,
1298 (resp.cause() instanceof RuntimeException));
1301 JavaTestKit.shutdownActorSystem(system1);
1305 public void testRemoveShardReplicaForNonExistentShard() throws Exception {
1306 new JavaTestKit(getSystem()) {{
1307 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1308 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1310 shardManager.tell(new RemoveShardReplica("model-inventory"), getRef());
1311 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1312 assertEquals("Failure obtained", true,
1313 (resp.cause() instanceof IllegalArgumentException));
1318 private static class TestShardManager extends ShardManager {
1319 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
1321 TestShardManager(String shardMrgIDSuffix) {
1322 super(new MockClusterWrapper(), new MockConfiguration(),
1323 newDatastoreContextFactory(DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build()),
1324 ready, new PrimaryShardInfoFutureCache());
1328 public void handleRecover(Object message) throws Exception {
1330 super.handleRecover(message);
1332 if(message instanceof RecoveryCompleted) {
1333 recoveryComplete.countDown();
1338 void waitForRecoveryComplete() {
1339 assertEquals("Recovery complete", true,
1340 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
1344 @SuppressWarnings("serial")
1345 static class TestShardManagerCreator implements Creator<TestShardManager> {
1346 String shardMrgIDSuffix;
1348 TestShardManagerCreator(String shardMrgIDSuffix) {
1349 this.shardMrgIDSuffix = shardMrgIDSuffix;
1353 public TestShardManager create() throws Exception {
1354 return new TestShardManager(shardMrgIDSuffix);
1359 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
1360 private static final long serialVersionUID = 1L;
1361 private final Creator<ShardManager> delegate;
1363 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
1364 this.delegate = delegate;
1368 public ShardManager create() throws Exception {
1369 return delegate.create();
1373 private static class ForwardingShardManager extends ShardManager {
1374 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
1375 private CountDownLatch memberUpReceived = new CountDownLatch(1);
1376 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
1377 private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
1378 private CountDownLatch memberReachableReceived = new CountDownLatch(1);
1379 private final ActorRef shardActor;
1380 private final String name;
1382 protected ForwardingShardManager(ClusterWrapper cluster, Configuration configuration,
1383 DatastoreContextFactory factory, CountDownLatch waitTillReadyCountdownLatch, String name,
1384 ActorRef shardActor, PrimaryShardInfoFutureCache primaryShardInfoCache) {
1385 super(cluster, configuration, factory, waitTillReadyCountdownLatch, primaryShardInfoCache);
1386 this.shardActor = shardActor;
1391 public void handleCommand(Object message) throws Exception {
1393 super.handleCommand(message);
1395 if(message instanceof FindPrimary) {
1396 findPrimaryMessageReceived.countDown();
1397 } else if(message instanceof ClusterEvent.MemberUp) {
1398 String role = ((ClusterEvent.MemberUp)message).member().roles().head();
1399 if(!getCluster().getCurrentMemberName().equals(role)) {
1400 memberUpReceived.countDown();
1402 } else if(message instanceof ClusterEvent.MemberRemoved) {
1403 String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
1404 if(!getCluster().getCurrentMemberName().equals(role)) {
1405 memberRemovedReceived.countDown();
1407 } else if(message instanceof ClusterEvent.UnreachableMember) {
1408 String role = ((ClusterEvent.UnreachableMember)message).member().roles().head();
1409 if(!getCluster().getCurrentMemberName().equals(role)) {
1410 memberUnreachableReceived.countDown();
1412 } else if(message instanceof ClusterEvent.ReachableMember) {
1413 String role = ((ClusterEvent.ReachableMember)message).member().roles().head();
1414 if(!getCluster().getCurrentMemberName().equals(role)) {
1415 memberReachableReceived.countDown();
1422 public String persistenceId() {
1427 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
1431 void waitForMemberUp() {
1432 assertEquals("MemberUp received", true,
1433 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
1434 memberUpReceived = new CountDownLatch(1);
1437 void waitForMemberRemoved() {
1438 assertEquals("MemberRemoved received", true,
1439 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
1440 memberRemovedReceived = new CountDownLatch(1);
1443 void waitForUnreachableMember() {
1444 assertEquals("UnreachableMember received", true,
1445 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
1447 memberUnreachableReceived = new CountDownLatch(1);
1450 void waitForReachableMember() {
1451 assertEquals("ReachableMember received", true,
1452 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
1453 memberReachableReceived = new CountDownLatch(1);
1456 void verifyFindPrimary() {
1457 assertEquals("FindPrimary received", true,
1458 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
1459 findPrimaryMessageReceived = new CountDownLatch(1);
1463 private static class MockRespondActor extends MessageCollectorActor {
1465 private volatile Object responseMsg;
1467 public void updateResponse(Object response) {
1468 responseMsg = response;
1472 public void onReceive(Object message) throws Exception {
1473 super.onReceive(message);
1474 if (message instanceof AddServer) {
1475 if (responseMsg != null) {
1476 getSender().tell(responseMsg, getSelf());