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.builder().cluster(new MockClusterWrapper()).configuration(config).
167 datastoreContextFactory(newDatastoreContextFactory(datastoreContextBuilder.build())).
168 waitTillReadyCountdownLatch(ready).primaryShardInfoCache(primaryShardInfoCache).props();
171 private Props newPropsShardMgrWithMockShardActor() {
172 return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
173 new MockConfiguration());
176 private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
177 final ClusterWrapper clusterWrapper, final Configuration config) {
178 Creator<ShardManager> creator = new Creator<ShardManager>() {
179 private static final long serialVersionUID = 1L;
181 public ShardManager create() throws Exception {
182 return new ForwardingShardManager(ShardManager.builder().cluster(clusterWrapper).configuration(config).
183 datastoreContextFactory(newDatastoreContextFactory(datastoreContextBuilder.build())).
184 waitTillReadyCountdownLatch(ready).primaryShardInfoCache(primaryShardInfoCache), name, shardActor);
188 return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
192 public void testPerShardDatastoreContext() throws Exception {
193 final DatastoreContextFactory mockFactory = newDatastoreContextFactory(
194 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
196 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
197 shardElectionTimeoutFactor(6).build()).when(mockFactory).getShardDatastoreContext("default");
199 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
200 shardElectionTimeoutFactor(7).build()).when(mockFactory).getShardDatastoreContext("topology");
202 final MockConfiguration mockConfig = new MockConfiguration() {
204 public Collection<String> getMemberShardNames(String memberName) {
205 return Arrays.asList("default", "topology");
209 public Collection<String> getMembersFromShardName(String shardName) {
210 return Arrays.asList("member-1");
214 final TestActorRef<MessageCollectorActor> defaultShardActor = TestActorRef.create(getSystem(),
215 Props.create(MessageCollectorActor.class), "default");
216 final TestActorRef<MessageCollectorActor> topologyShardActor = TestActorRef.create(getSystem(),
217 Props.create(MessageCollectorActor.class), "topology");
219 final Map<String, Entry<ActorRef, DatastoreContext>> shardInfoMap = Collections.synchronizedMap(
220 new HashMap<String, Entry<ActorRef, DatastoreContext>>());
221 shardInfoMap.put("default", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(defaultShardActor, null));
222 shardInfoMap.put("topology", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(topologyShardActor, null));
224 final CountDownLatch newShardActorLatch = new CountDownLatch(2);
225 final Creator<ShardManager> creator = new Creator<ShardManager>() {
226 private static final long serialVersionUID = 1L;
228 public ShardManager create() throws Exception {
229 return new ShardManager(ShardManager.builder().cluster(new MockClusterWrapper()).configuration(mockConfig).
230 datastoreContextFactory(mockFactory).waitTillReadyCountdownLatch(ready).
231 primaryShardInfoCache(primaryShardInfoCache)) {
233 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
234 Entry<ActorRef, DatastoreContext> entry = shardInfoMap.get(info.getShardName());
237 ref = entry.getKey();
238 entry.setValue(info.getDatastoreContext());
241 newShardActorLatch.countDown();
248 JavaTestKit kit = new JavaTestKit(getSystem());
250 final ActorRef shardManager = getSystem().actorOf(Props.create(new DelegatingShardManagerCreator(creator)).
251 withDispatcher(Dispatchers.DefaultDispatcherId()));
253 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), kit.getRef());
255 assertEquals("Shard actors created", true, newShardActorLatch.await(5, TimeUnit.SECONDS));
256 assertEquals("getShardElectionTimeoutFactor", 6, shardInfoMap.get("default").getValue().
257 getShardElectionTimeoutFactor());
258 assertEquals("getShardElectionTimeoutFactor", 7, shardInfoMap.get("topology").getValue().
259 getShardElectionTimeoutFactor());
261 DatastoreContextFactory newMockFactory = newDatastoreContextFactory(
262 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
263 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
264 shardElectionTimeoutFactor(66).build()).when(newMockFactory).getShardDatastoreContext("default");
266 Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
267 shardElectionTimeoutFactor(77).build()).when(newMockFactory).getShardDatastoreContext("topology");
269 shardManager.tell(newMockFactory, kit.getRef());
271 DatastoreContext newContext = MessageCollectorActor.expectFirstMatching(defaultShardActor, DatastoreContext.class);
272 assertEquals("getShardElectionTimeoutFactor", 66, newContext.getShardElectionTimeoutFactor());
274 newContext = MessageCollectorActor.expectFirstMatching(topologyShardActor, DatastoreContext.class);
275 assertEquals("getShardElectionTimeoutFactor", 77, newContext.getShardElectionTimeoutFactor());
277 defaultShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
278 topologyShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
282 public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
283 new JavaTestKit(getSystem()) {{
284 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
286 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
288 shardManager.tell(new FindPrimary("non-existent", false), getRef());
290 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
295 public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
296 new JavaTestKit(getSystem()) {{
297 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
299 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
301 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
302 shardManager.tell(new ActorInitialized(), mockShardActor);
304 DataTree mockDataTree = mock(DataTree.class);
305 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
306 DataStoreVersions.CURRENT_VERSION), getRef());
308 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
309 shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
310 RaftState.Leader.name())), mockShardActor);
312 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
314 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
315 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
316 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
317 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
322 public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
323 new JavaTestKit(getSystem()) {{
324 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
326 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
327 shardManager.tell(new ActorInitialized(), mockShardActor);
329 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
330 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
331 shardManager.tell(new RoleChangeNotification(memberId1,
332 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
333 shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
335 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
337 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
342 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
343 new JavaTestKit(getSystem()) {{
344 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
346 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
347 shardManager.tell(new ActorInitialized(), mockShardActor);
349 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
350 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
352 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
353 shardManager.tell(new RoleChangeNotification(memberId1,
354 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
355 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
356 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
357 leaderVersion), mockShardActor);
359 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
361 RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
362 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
363 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
364 assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
369 public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
370 new JavaTestKit(getSystem()) {{
371 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
373 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
375 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
380 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
381 new JavaTestKit(getSystem()) {{
382 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
384 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
385 shardManager.tell(new ActorInitialized(), mockShardActor);
387 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
389 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
394 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
395 new JavaTestKit(getSystem()) {{
396 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
398 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
399 shardManager.tell(new ActorInitialized(), mockShardActor);
401 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
402 shardManager.tell(new RoleChangeNotification(memberId,
403 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
405 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
407 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
409 DataTree mockDataTree = mock(DataTree.class);
410 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
411 DataStoreVersions.CURRENT_VERSION), mockShardActor);
413 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
415 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
416 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
417 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
418 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
423 public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
424 new JavaTestKit(getSystem()) {{
425 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
427 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
429 // We're passing waitUntilInitialized = true to FindPrimary so the response should be
430 // delayed until we send ActorInitialized and RoleChangeNotification.
431 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
433 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
435 shardManager.tell(new ActorInitialized(), mockShardActor);
437 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
439 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
440 shardManager.tell(new RoleChangeNotification(memberId,
441 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
443 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
445 DataTree mockDataTree = mock(DataTree.class);
446 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
447 DataStoreVersions.CURRENT_VERSION), mockShardActor);
449 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
450 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
451 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
452 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
454 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
459 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
460 new JavaTestKit(getSystem()) {{
461 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
463 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
465 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
467 expectMsgClass(duration("2 seconds"), NotInitializedException.class);
469 shardManager.tell(new ActorInitialized(), mockShardActor);
471 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
476 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
477 new JavaTestKit(getSystem()) {{
478 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
480 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
481 shardManager.tell(new ActorInitialized(), mockShardActor);
482 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
483 null, RaftState.Candidate.name()), mockShardActor);
485 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
487 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
492 public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
493 new JavaTestKit(getSystem()) {{
494 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
496 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
497 shardManager.tell(new ActorInitialized(), mockShardActor);
498 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
499 null, RaftState.IsolatedLeader.name()), mockShardActor);
501 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
503 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
508 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
509 new JavaTestKit(getSystem()) {{
510 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
512 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
513 shardManager.tell(new ActorInitialized(), mockShardActor);
515 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
517 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
522 public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
523 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
525 // Create an ActorSystem ShardManager actor for member-1.
527 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
528 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
530 ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
532 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
533 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
534 new MockConfiguration()), shardManagerID);
536 // Create an ActorSystem ShardManager actor for member-2.
538 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
540 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
542 final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
544 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
545 put("default", Arrays.asList("member-1", "member-2")).
546 put("astronauts", Arrays.asList("member-2")).build());
548 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
549 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
550 mockConfig2), shardManagerID);
552 new JavaTestKit(system1) {{
554 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
555 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
557 shardManager2.tell(new ActorInitialized(), mockShardActor2);
559 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
560 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
561 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
562 Optional.of(mock(DataTree.class)), leaderVersion), mockShardActor2);
563 shardManager2.tell(new RoleChangeNotification(memberId2,
564 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
566 shardManager1.underlyingActor().waitForMemberUp();
568 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
570 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
571 String path = found.getPrimaryPath();
572 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
573 assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
575 shardManager2.underlyingActor().verifyFindPrimary();
577 Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
579 shardManager1.underlyingActor().waitForMemberRemoved();
581 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
583 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
586 JavaTestKit.shutdownActorSystem(system1);
587 JavaTestKit.shutdownActorSystem(system2);
591 public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
592 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
594 // Create an ActorSystem ShardManager actor for member-1.
596 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
597 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
599 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
601 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
602 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
603 new MockConfiguration()), shardManagerID);
605 // Create an ActorSystem ShardManager actor for member-2.
607 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
609 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
611 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
613 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
614 put("default", Arrays.asList("member-1", "member-2")).build());
616 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
617 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
618 mockConfig2), shardManagerID);
620 new JavaTestKit(system1) {{
622 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
623 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
624 shardManager1.tell(new ActorInitialized(), mockShardActor1);
625 shardManager2.tell(new ActorInitialized(), mockShardActor2);
627 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
628 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
629 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
630 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
631 shardManager1.tell(new RoleChangeNotification(memberId1,
632 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
633 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
634 DataStoreVersions.CURRENT_VERSION),
636 shardManager2.tell(new RoleChangeNotification(memberId2,
637 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
638 shardManager1.underlyingActor().waitForMemberUp();
640 shardManager1.tell(new FindPrimary("default", true), getRef());
642 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
643 String path = found.getPrimaryPath();
644 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
646 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
647 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
649 shardManager1.underlyingActor().waitForUnreachableMember();
651 PeerDown peerDown = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
652 assertEquals("getMemberName", "member-2", peerDown.getMemberName());
653 MessageCollectorActor.clearMessages(mockShardActor1);
655 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
656 createMemberRemoved("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
658 MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
660 shardManager1.tell(new FindPrimary("default", true), getRef());
662 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
664 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
665 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
667 shardManager1.underlyingActor().waitForReachableMember();
669 PeerUp peerUp = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
670 assertEquals("getMemberName", "member-2", peerUp.getMemberName());
671 MessageCollectorActor.clearMessages(mockShardActor1);
673 shardManager1.tell(new FindPrimary("default", true), getRef());
675 RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
676 String path1 = found1.getPrimaryPath();
677 assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
679 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
680 createMemberUp("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
682 MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
686 JavaTestKit.shutdownActorSystem(system1);
687 JavaTestKit.shutdownActorSystem(system2);
691 public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
692 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
694 // Create an ActorSystem ShardManager actor for member-1.
696 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
697 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
699 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
701 final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
702 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
703 new MockConfiguration()), shardManagerID);
705 // Create an ActorSystem ShardManager actor for member-2.
707 final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
709 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
711 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
713 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
714 put("default", Arrays.asList("member-1", "member-2")).build());
716 final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
717 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
718 mockConfig2), shardManagerID);
720 new JavaTestKit(system1) {{
722 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
723 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
724 shardManager1.tell(new ActorInitialized(), mockShardActor1);
725 shardManager2.tell(new ActorInitialized(), mockShardActor2);
727 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
728 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
729 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
730 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
731 shardManager1.tell(new RoleChangeNotification(memberId1,
732 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
733 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
734 DataStoreVersions.CURRENT_VERSION),
736 shardManager2.tell(new RoleChangeNotification(memberId2,
737 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
738 shardManager1.underlyingActor().waitForMemberUp();
740 shardManager1.tell(new FindPrimary("default", true), getRef());
742 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
743 String path = found.getPrimaryPath();
744 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
746 primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
747 mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION, Optional.<DataTree>absent()));
749 shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
750 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
752 shardManager1.underlyingActor().waitForUnreachableMember();
754 shardManager1.tell(new FindPrimary("default", true), getRef());
756 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
758 assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
760 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
761 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
762 shardManager1.tell(new RoleChangeNotification(memberId1,
763 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
765 shardManager1.tell(new FindPrimary("default", true), getRef());
767 LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
768 String path1 = found1.getPrimaryPath();
769 assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
773 JavaTestKit.shutdownActorSystem(system1);
774 JavaTestKit.shutdownActorSystem(system2);
779 public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
780 new JavaTestKit(getSystem()) {{
781 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
783 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
785 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
787 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
789 assertEquals("getShardName", "non-existent", notFound.getShardName());
794 public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
795 new JavaTestKit(getSystem()) {{
796 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
798 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
799 shardManager.tell(new ActorInitialized(), mockShardActor);
801 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
803 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
805 assertTrue("Found path contains " + found.getPath().path().toString(),
806 found.getPath().path().toString().contains("member-1-shard-default-config"));
811 public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
812 new JavaTestKit(getSystem()) {{
813 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
815 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
817 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
822 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
823 new JavaTestKit(getSystem()) {{
824 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
826 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
828 // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
829 // delayed until we send ActorInitialized.
830 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
831 new Timeout(5, TimeUnit.SECONDS));
833 shardManager.tell(new ActorInitialized(), mockShardActor);
835 Object resp = Await.result(future, duration("5 seconds"));
836 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
841 public void testOnRecoveryJournalIsCleaned() {
842 InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
843 ImmutableSet.of("foo")));
844 InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
845 ImmutableSet.of("bar")));
846 InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
848 new JavaTestKit(getSystem()) {{
849 TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
850 Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
852 shardManager.underlyingActor().waitForRecoveryComplete();
853 InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
855 // Journal entries up to the last one should've been deleted
856 Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
857 synchronized (journal) {
858 assertEquals("Journal size", 0, journal.size());
864 public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
865 new JavaTestKit(getSystem()) {
867 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
869 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
870 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
871 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
873 verify(ready, never()).countDown();
875 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
876 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
878 verify(ready, times(1)).countDown();
884 public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
885 new JavaTestKit(getSystem()) {
887 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
889 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
890 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
891 memberId, null, RaftState.Follower.name()));
893 verify(ready, never()).countDown();
895 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
897 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
898 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
899 DataStoreVersions.CURRENT_VERSION));
901 verify(ready, times(1)).countDown();
907 public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
908 new JavaTestKit(getSystem()) {
910 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
912 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
913 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
914 memberId, null, RaftState.Follower.name()));
916 verify(ready, never()).countDown();
918 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
919 "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
920 DataStoreVersions.CURRENT_VERSION));
922 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
924 verify(ready, times(1)).countDown();
930 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
931 new JavaTestKit(getSystem()) {
933 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
935 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
936 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
938 verify(ready, never()).countDown();
945 public void testByDefaultSyncStatusIsFalse() throws Exception{
946 final Props persistentProps = newShardMgrProps();
947 final TestActorRef<ShardManager> shardManager =
948 TestActorRef.create(getSystem(), persistentProps);
950 ShardManager shardManagerActor = shardManager.underlyingActor();
952 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
956 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
957 final TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
959 ShardManager shardManagerActor = shardManager.underlyingActor();
960 shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
961 RaftState.Follower.name(), RaftState.Leader.name()));
963 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
967 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
968 final TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
970 ShardManager shardManagerActor = shardManager.underlyingActor();
971 String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
972 shardManagerActor.onReceiveCommand(new RoleChangeNotification(shardId,
973 RaftState.Follower.name(), RaftState.Candidate.name()));
975 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
977 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
978 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(
981 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
985 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
986 final Props persistentProps = newShardMgrProps();
987 final TestActorRef<ShardManager> shardManager =
988 TestActorRef.create(getSystem(), persistentProps);
990 String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
991 ShardManager shardManagerActor = shardManager.underlyingActor();
992 shardManagerActor.onReceiveCommand(new RoleChangeNotification(shardId,
993 RaftState.Candidate.name(), RaftState.Follower.name()));
995 // Initially will be false
996 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
998 // Send status true will make sync status true
999 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, shardId));
1001 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
1003 // Send status false will make sync status false
1004 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, shardId));
1006 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1011 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
1012 final Props persistentProps = newShardMgrProps(new MockConfiguration() {
1014 public List<String> getMemberShardNames(String memberName) {
1015 return Arrays.asList("default", "astronauts");
1019 final TestActorRef<ShardManager> shardManager =
1020 TestActorRef.create(getSystem(), persistentProps);
1022 ShardManager shardManagerActor = shardManager.underlyingActor();
1024 // Initially will be false
1025 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1027 // Make default shard leader
1028 String defaultShardId = "member-1-shard-default-" + shardMrgIDSuffix;
1029 shardManagerActor.onReceiveCommand(new RoleChangeNotification(defaultShardId,
1030 RaftState.Follower.name(), RaftState.Leader.name()));
1032 // default = Leader, astronauts is unknown so sync status remains false
1033 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1035 // Make astronauts shard leader as well
1036 String astronautsShardId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1037 shardManagerActor.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1038 RaftState.Follower.name(), RaftState.Leader.name()));
1040 // Now sync status should be true
1041 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
1043 // Make astronauts a Follower
1044 shardManagerActor.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1045 RaftState.Leader.name(), RaftState.Follower.name()));
1047 // Sync status is not true
1048 assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
1050 // Make the astronauts follower sync status true
1051 shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, astronautsShardId));
1053 // Sync status is now true
1054 assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
1059 public void testOnReceiveSwitchShardBehavior() throws Exception {
1060 new JavaTestKit(getSystem()) {{
1061 final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
1063 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1064 shardManager.tell(new ActorInitialized(), mockShardActor);
1066 shardManager.tell(new SwitchShardBehavior(mockShardName, "Leader", 1000), getRef());
1068 SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor, SwitchBehavior.class);
1070 assertEquals(RaftState.Leader, switchBehavior.getNewState());
1071 assertEquals(1000, switchBehavior.getNewTerm());
1076 public void testOnReceiveCreateShard() {
1077 new JavaTestKit(getSystem()) {{
1078 datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1080 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1081 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1083 SchemaContext schemaContext = TestModel.createTestContext();
1084 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1086 DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100).
1087 persistent(false).build();
1088 Shard.Builder shardBuilder = Shard.builder();
1090 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1091 "foo", null, Arrays.asList("member-1", "member-5", "member-6"));
1092 shardManager.tell(new CreateShard(config, shardBuilder, datastoreContext), getRef());
1094 expectMsgClass(duration("5 seconds"), CreateShardReply.class);
1096 shardManager.tell(new FindLocalShard("foo", true), getRef());
1098 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1100 assertEquals("isRecoveryApplicable", false, shardBuilder.getDatastoreContext().isPersistent());
1101 assertTrue("Epxected ShardPeerAddressResolver", shardBuilder.getDatastoreContext().getShardRaftConfig().
1102 getPeerAddressResolver() instanceof ShardPeerAddressResolver);
1103 assertEquals("peerMembers", Sets.newHashSet(new ShardIdentifier("foo", "member-5", shardMrgIDSuffix).toString(),
1104 new ShardIdentifier("foo", "member-6", shardMrgIDSuffix).toString()),
1105 shardBuilder.getPeerAddresses().keySet());
1106 assertEquals("ShardIdentifier", new ShardIdentifier("foo", "member-1", shardMrgIDSuffix),
1107 shardBuilder.getId());
1108 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1110 // Send CreateShard with same name - should fail.
1112 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1114 expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
1119 public void testOnReceiveCreateShardWithNoInitialSchemaContext() {
1120 new JavaTestKit(getSystem()) {{
1121 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1122 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1124 Shard.Builder shardBuilder = Shard.builder();
1126 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1127 "foo", null, Arrays.asList("member-1"));
1128 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1130 expectMsgClass(duration("5 seconds"), CreateShardReply.class);
1132 SchemaContext schemaContext = TestModel.createTestContext();
1133 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1135 shardManager.tell(new FindLocalShard("foo", true), getRef());
1137 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1139 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1140 assertNotNull("schemaContext is null", shardBuilder.getDatastoreContext());
1145 public void testGetSnapshot() throws Throwable {
1146 JavaTestKit kit = new JavaTestKit(getSystem());
1148 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1149 put("shard1", Arrays.asList("member-1")).
1150 put("shard2", Arrays.asList("member-1")).build());
1152 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(mockConfig).withDispatcher(
1153 Dispatchers.DefaultDispatcherId()));
1155 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1156 Failure failure = kit.expectMsgClass(Failure.class);
1157 assertEquals("Failure cause type", IllegalStateException.class, failure.cause().getClass());
1159 kit = new JavaTestKit(getSystem());
1161 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1163 shardManager.tell(new FindLocalShard("shard1", true), kit.getRef());
1164 kit.expectMsgClass(LocalShardFound.class);
1165 shardManager.tell(new FindLocalShard("shard2", true), kit.getRef());
1166 kit.expectMsgClass(LocalShardFound.class);
1168 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1170 DatastoreSnapshot datastoreSnapshot = kit.expectMsgClass(DatastoreSnapshot.class);
1172 assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1173 List<ShardSnapshot> shardSnapshots = datastoreSnapshot.getShardSnapshots();
1174 Set<String> actualShardNames = new HashSet<>();
1175 for(ShardSnapshot s: shardSnapshots) {
1176 actualShardNames.add(s.getName());
1179 assertEquals("Shard names", Sets.newHashSet("shard1", "shard2"), actualShardNames);
1181 shardManager.tell(PoisonPill.getInstance(), ActorRef.noSender());
1185 public void testAddShardReplicaForNonExistentShard() throws Exception {
1186 new JavaTestKit(getSystem()) {{
1187 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1188 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1190 shardManager.tell(new AddShardReplica("model-inventory"), getRef());
1191 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1193 assertEquals("Failure obtained", true,
1194 (resp.cause() instanceof IllegalArgumentException));
1199 public void testAddShardReplicaForAlreadyCreatedShard() throws Exception {
1200 new JavaTestKit(getSystem()) {{
1201 ActorRef shardManager = getSystem().actorOf(newShardMgrProps());
1202 shardManager.tell(new AddShardReplica("default"), getRef());
1203 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1204 assertEquals("Failure obtained", true,
1205 (resp.cause() instanceof IllegalArgumentException));
1210 public void testAddShardReplica() throws Exception {
1211 MockConfiguration mockConfig =
1212 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1213 put("default", Arrays.asList("member-1", "member-2")).
1214 put("astronauts", Arrays.asList("member-2")).build());
1216 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1218 // Create an ActorSystem ShardManager actor for member-1.
1219 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
1220 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1221 ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1222 final TestActorRef<ForwardingShardManager> newReplicaShardManager = TestActorRef.create(system1,
1223 newPropsShardMgrWithMockShardActor("shardManager1", mockDefaultShardActor,
1224 new ClusterWrapperImpl(system1), mockConfig), shardManagerID);
1226 // Create an ActorSystem ShardManager actor for member-2.
1227 final ActorSystem system2 = ActorSystem.create("cluster-test",
1228 ConfigFactory.load().getConfig("Member2"));
1229 Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1231 String name = new ShardIdentifier("astronauts", "member-2", "config").toString();
1232 final TestActorRef<MockRespondActor> mockShardLeaderActor =
1233 TestActorRef.create(system2, Props.create(MockRespondActor.class), name);
1234 final TestActorRef<ForwardingShardManager> leaderShardManager = TestActorRef.create(system2,
1235 newPropsShardMgrWithMockShardActor("shardManager2", mockShardLeaderActor,
1236 new ClusterWrapperImpl(system2), mockConfig), shardManagerID);
1238 new JavaTestKit(system1) {{
1240 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1241 leaderShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1243 leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1245 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
1246 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1247 leaderShardManager.tell(new ShardLeaderStateChanged(memberId2, memberId2,
1248 Optional.of(mock(DataTree.class)), leaderVersion), mockShardLeaderActor);
1249 leaderShardManager.tell(new RoleChangeNotification(memberId2,
1250 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardLeaderActor);
1252 newReplicaShardManager.underlyingActor().waitForMemberUp();
1253 leaderShardManager.underlyingActor().waitForMemberUp();
1255 //construct a mock response message
1256 AddServerReply response = new AddServerReply(ServerChangeStatus.OK, memberId2);
1257 mockShardLeaderActor.underlyingActor().updateResponse(response);
1258 newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1259 AddServer addServerMsg = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1261 String addServerId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1262 assertEquals("AddServer serverId", addServerId, addServerMsg.getNewServerId());
1264 expectMsgClass(duration("5 seconds"), Status.Success.class);
1267 JavaTestKit.shutdownActorSystem(system1);
1268 JavaTestKit.shutdownActorSystem(system2);
1272 public void testAddShardReplicaWithFindPrimaryTimeout() throws Exception {
1273 MockConfiguration mockConfig =
1274 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1275 put("default", Arrays.asList("member-1", "member-2")).
1276 put("astronauts", Arrays.asList("member-2")).build());
1278 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1280 // Create an ActorSystem ShardManager actor for member-1.
1281 final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
1282 Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1283 ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1284 final TestActorRef<ForwardingShardManager> newReplicaShardManager = TestActorRef.create(system1,
1285 newPropsShardMgrWithMockShardActor("shardManager1", mockDefaultShardActor,
1286 new ClusterWrapperImpl(system1), mockConfig), shardManagerID);
1288 new JavaTestKit(system1) {{
1290 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1291 MockClusterWrapper.sendMemberUp(newReplicaShardManager, "member-2", getRef().path().toString());
1292 newReplicaShardManager.underlyingActor().waitForMemberUp();
1294 newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1295 Status.Failure resp = expectMsgClass(duration("5 seconds"), Status.Failure.class);
1296 assertEquals("Failure obtained", true,
1297 (resp.cause() instanceof RuntimeException));
1300 JavaTestKit.shutdownActorSystem(system1);
1304 public void testRemoveShardReplicaForNonExistentShard() throws Exception {
1305 new JavaTestKit(getSystem()) {{
1306 ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1307 new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1309 shardManager.tell(new RemoveShardReplica("model-inventory"), getRef());
1310 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1311 assertEquals("Failure obtained", true,
1312 (resp.cause() instanceof IllegalArgumentException));
1317 private static class TestShardManager extends ShardManager {
1318 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
1320 TestShardManager(String shardMrgIDSuffix) {
1321 super(ShardManager.builder().cluster(new MockClusterWrapper()).configuration(new MockConfiguration()).
1322 datastoreContextFactory(newDatastoreContextFactory(DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build())).
1323 waitTillReadyCountdownLatch(ready).primaryShardInfoCache(new PrimaryShardInfoFutureCache()));
1327 public void handleRecover(Object message) throws Exception {
1329 super.handleRecover(message);
1331 if(message instanceof RecoveryCompleted) {
1332 recoveryComplete.countDown();
1337 void waitForRecoveryComplete() {
1338 assertEquals("Recovery complete", true,
1339 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
1343 @SuppressWarnings("serial")
1344 static class TestShardManagerCreator implements Creator<TestShardManager> {
1345 String shardMrgIDSuffix;
1347 TestShardManagerCreator(String shardMrgIDSuffix) {
1348 this.shardMrgIDSuffix = shardMrgIDSuffix;
1352 public TestShardManager create() throws Exception {
1353 return new TestShardManager(shardMrgIDSuffix);
1358 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
1359 private static final long serialVersionUID = 1L;
1360 private final Creator<ShardManager> delegate;
1362 public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
1363 this.delegate = delegate;
1367 public ShardManager create() throws Exception {
1368 return delegate.create();
1372 private static class ForwardingShardManager extends ShardManager {
1373 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
1374 private CountDownLatch memberUpReceived = new CountDownLatch(1);
1375 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
1376 private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
1377 private CountDownLatch memberReachableReceived = new CountDownLatch(1);
1378 private final ActorRef shardActor;
1379 private final String name;
1381 public ForwardingShardManager(Builder builder, String name, ActorRef shardActor) {
1383 this.shardActor = shardActor;
1388 public void handleCommand(Object message) throws Exception {
1390 super.handleCommand(message);
1392 if(message instanceof FindPrimary) {
1393 findPrimaryMessageReceived.countDown();
1394 } else if(message instanceof ClusterEvent.MemberUp) {
1395 String role = ((ClusterEvent.MemberUp)message).member().roles().head();
1396 if(!getCluster().getCurrentMemberName().equals(role)) {
1397 memberUpReceived.countDown();
1399 } else if(message instanceof ClusterEvent.MemberRemoved) {
1400 String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
1401 if(!getCluster().getCurrentMemberName().equals(role)) {
1402 memberRemovedReceived.countDown();
1404 } else if(message instanceof ClusterEvent.UnreachableMember) {
1405 String role = ((ClusterEvent.UnreachableMember)message).member().roles().head();
1406 if(!getCluster().getCurrentMemberName().equals(role)) {
1407 memberUnreachableReceived.countDown();
1409 } else if(message instanceof ClusterEvent.ReachableMember) {
1410 String role = ((ClusterEvent.ReachableMember)message).member().roles().head();
1411 if(!getCluster().getCurrentMemberName().equals(role)) {
1412 memberReachableReceived.countDown();
1419 public String persistenceId() {
1424 protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
1428 void waitForMemberUp() {
1429 assertEquals("MemberUp received", true,
1430 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
1431 memberUpReceived = new CountDownLatch(1);
1434 void waitForMemberRemoved() {
1435 assertEquals("MemberRemoved received", true,
1436 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
1437 memberRemovedReceived = new CountDownLatch(1);
1440 void waitForUnreachableMember() {
1441 assertEquals("UnreachableMember received", true,
1442 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
1444 memberUnreachableReceived = new CountDownLatch(1);
1447 void waitForReachableMember() {
1448 assertEquals("ReachableMember received", true,
1449 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
1450 memberReachableReceived = new CountDownLatch(1);
1453 void verifyFindPrimary() {
1454 assertEquals("FindPrimary received", true,
1455 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
1456 findPrimaryMessageReceived = new CountDownLatch(1);
1460 private static class MockRespondActor extends MessageCollectorActor {
1462 private volatile Object responseMsg;
1464 public void updateResponse(Object response) {
1465 responseMsg = response;
1469 public void onReceive(Object message) throws Exception {
1470 super.onReceive(message);
1471 if (message instanceof AddServer) {
1472 if (responseMsg != null) {
1473 getSender().tell(responseMsg, getSelf());