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
8 package org.opendaylight.controller.cluster.datastore.shardmanager;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertFalse;
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.junit.Assert.fail;
17 import static org.mockito.ArgumentMatchers.anyString;
18 import static org.mockito.Mockito.doReturn;
19 import static org.mockito.Mockito.mock;
20 import static org.mockito.Mockito.reset;
21 import static org.mockito.Mockito.timeout;
22 import static org.mockito.Mockito.verify;
23 import static org.mockito.Mockito.verifyNoMoreInteractions;
25 import akka.actor.ActorRef;
26 import akka.actor.ActorSystem;
27 import akka.actor.AddressFromURIString;
28 import akka.actor.Props;
29 import akka.actor.Status;
30 import akka.actor.Status.Failure;
31 import akka.actor.Status.Success;
32 import akka.cluster.Cluster;
33 import akka.cluster.ClusterEvent;
34 import akka.cluster.Member;
35 import akka.dispatch.Dispatchers;
36 import akka.dispatch.OnComplete;
37 import akka.japi.Creator;
38 import akka.pattern.Patterns;
39 import akka.persistence.RecoveryCompleted;
40 import akka.serialization.Serialization;
41 import akka.testkit.TestActorRef;
42 import akka.testkit.javadsl.TestKit;
43 import akka.util.Timeout;
44 import com.google.common.base.Stopwatch;
45 import com.google.common.collect.ImmutableMap;
46 import com.google.common.collect.Lists;
47 import com.google.common.collect.Sets;
48 import com.google.common.util.concurrent.Uninterruptibles;
49 import java.time.Duration;
50 import java.util.AbstractMap;
51 import java.util.Arrays;
52 import java.util.Collection;
53 import java.util.Collections;
54 import java.util.HashMap;
55 import java.util.List;
57 import java.util.Map.Entry;
59 import java.util.concurrent.CountDownLatch;
60 import java.util.concurrent.TimeUnit;
61 import java.util.concurrent.TimeoutException;
62 import java.util.function.Consumer;
63 import java.util.function.Function;
64 import java.util.stream.Collectors;
65 import org.junit.AfterClass;
66 import org.junit.BeforeClass;
67 import org.junit.Test;
68 import org.opendaylight.controller.cluster.access.concepts.MemberName;
69 import org.opendaylight.controller.cluster.datastore.AbstractShardManagerTest;
70 import org.opendaylight.controller.cluster.datastore.ClusterWrapperImpl;
71 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
72 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
73 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
74 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
75 import org.opendaylight.controller.cluster.datastore.Shard;
76 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
77 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
78 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
79 import org.opendaylight.controller.cluster.datastore.exceptions.AlreadyExistsException;
80 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
81 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
82 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
83 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
84 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
85 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
86 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
87 import org.opendaylight.controller.cluster.datastore.messages.ChangeShardMembersVotingStatus;
88 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
89 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
90 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
91 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
92 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
93 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
94 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
95 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
96 import org.opendaylight.controller.cluster.datastore.messages.RemoveShardReplica;
97 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
98 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
99 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot;
100 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot.ShardSnapshot;
101 import org.opendaylight.controller.cluster.datastore.persisted.ShardManagerSnapshot;
102 import org.opendaylight.controller.cluster.datastore.utils.ForwardingActor;
103 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
104 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
105 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
106 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
107 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
108 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
109 import org.opendaylight.controller.cluster.raft.RaftState;
110 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
111 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
112 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
113 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
114 import org.opendaylight.controller.cluster.raft.messages.AddServer;
115 import org.opendaylight.controller.cluster.raft.messages.AddServerReply;
116 import org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus;
117 import org.opendaylight.controller.cluster.raft.messages.RemoveServer;
118 import org.opendaylight.controller.cluster.raft.messages.RemoveServerReply;
119 import org.opendaylight.controller.cluster.raft.messages.ServerChangeReply;
120 import org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus;
121 import org.opendaylight.controller.cluster.raft.messages.ServerRemoved;
122 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
123 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
124 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
125 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
126 import org.opendaylight.yangtools.concepts.Registration;
127 import org.opendaylight.yangtools.yang.common.XMLNamespace;
128 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
129 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
130 import org.slf4j.Logger;
131 import org.slf4j.LoggerFactory;
132 import scala.concurrent.Await;
133 import scala.concurrent.Future;
134 import scala.concurrent.duration.FiniteDuration;
136 public class ShardManagerTest extends AbstractShardManagerTest {
137 private static final Logger LOG = LoggerFactory.getLogger(ShardManagerTest.class);
138 private static final MemberName MEMBER_2 = MemberName.forName("member-2");
139 private static final MemberName MEMBER_3 = MemberName.forName("member-3");
141 private static EffectiveModelContext TEST_SCHEMA_CONTEXT;
143 private final String shardMgrID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
146 public static void beforeClass() {
147 TEST_SCHEMA_CONTEXT = TestModel.createTestContext();
151 public static void afterClass() {
152 TEST_SCHEMA_CONTEXT = null;
155 private ActorSystem newActorSystem(final String config) {
156 return newActorSystem("cluster-test", config);
159 private ActorRef newMockShardActor(final ActorSystem system, final String shardName, final String memberName) {
160 String name = ShardIdentifier.create(shardName, MemberName.forName(memberName), "config").toString();
161 if (system == getSystem()) {
162 return actorFactory.createActor(MessageCollectorActor.props(), name);
165 return system.actorOf(MessageCollectorActor.props(), name);
168 private Props newShardMgrProps() {
169 return newShardMgrProps(new MockConfiguration());
172 private static DatastoreContextFactory newDatastoreContextFactory(final DatastoreContext datastoreContext) {
173 DatastoreContextFactory mockFactory = mock(DatastoreContextFactory.class);
174 doReturn(datastoreContext).when(mockFactory).getBaseDatastoreContext();
175 doReturn(datastoreContext).when(mockFactory).getShardDatastoreContext(anyString());
179 private TestShardManager.Builder newTestShardMgrBuilderWithMockShardActor() {
180 return newTestShardMgrBuilderWithMockShardActor(mockShardActor);
183 private TestShardManager.Builder newTestShardMgrBuilderWithMockShardActor(final ActorRef shardActor) {
184 return TestShardManager.builder(datastoreContextBuilder).shardActor(shardActor)
185 .distributedDataStore(mock(DistributedDataStore.class));
189 private Props newPropsShardMgrWithMockShardActor() {
190 return newTestShardMgrBuilderWithMockShardActor().props().withDispatcher(
191 Dispatchers.DefaultDispatcherId());
194 private Props newPropsShardMgrWithMockShardActor(final ActorRef shardActor) {
195 return newTestShardMgrBuilderWithMockShardActor(shardActor).props()
196 .withDispatcher(Dispatchers.DefaultDispatcherId());
200 private TestShardManager newTestShardManager() {
201 return newTestShardManager(newShardMgrProps());
204 private TestShardManager newTestShardManager(final Props props) {
205 TestActorRef<TestShardManager> shardManagerActor = actorFactory.createTestActor(props);
206 TestShardManager shardManager = shardManagerActor.underlyingActor();
207 shardManager.waitForRecoveryComplete();
211 private static void waitForShardInitialized(final ActorRef shardManager, final String shardName,
213 AssertionError last = null;
214 Stopwatch sw = Stopwatch.createStarted();
215 while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
217 shardManager.tell(new FindLocalShard(shardName, true), kit.getRef());
218 kit.expectMsgClass(LocalShardFound.class);
220 } catch (AssertionError e) {
224 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
230 @SuppressWarnings("unchecked")
231 private static <T> T expectMsgClassOrFailure(final Class<T> msgClass, final TestKit kit, final String msg) {
232 Object reply = kit.expectMsgAnyClassOf(kit.duration("5 sec"), msgClass, Failure.class);
233 if (reply instanceof Failure) {
234 throw new AssertionError(msg + " failed", ((Failure)reply).cause());
241 public void testPerShardDatastoreContext() throws Exception {
242 LOG.info("testPerShardDatastoreContext starting");
243 final DatastoreContextFactory mockFactory = newDatastoreContextFactory(
244 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
247 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(6).build())
248 .when(mockFactory).getShardDatastoreContext("default");
251 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(7).build())
252 .when(mockFactory).getShardDatastoreContext("topology");
254 final MockConfiguration mockConfig = new MockConfiguration() {
256 public Collection<String> getMemberShardNames(final MemberName memberName) {
257 return Arrays.asList("default", "topology");
261 public Collection<MemberName> getMembersFromShardName(final String shardName) {
262 return members("member-1");
266 final ActorRef defaultShardActor = actorFactory.createActor(
267 MessageCollectorActor.props(), actorFactory.generateActorId("default"));
268 final ActorRef topologyShardActor = actorFactory.createActor(
269 MessageCollectorActor.props(), actorFactory.generateActorId("topology"));
271 final Map<String, Entry<ActorRef, DatastoreContext>> shardInfoMap = Collections.synchronizedMap(
272 new HashMap<String, Entry<ActorRef, DatastoreContext>>());
273 shardInfoMap.put("default", new AbstractMap.SimpleEntry<>(defaultShardActor, null));
274 shardInfoMap.put("topology", new AbstractMap.SimpleEntry<>(topologyShardActor, null));
276 final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
277 final CountDownLatch newShardActorLatch = new CountDownLatch(2);
278 class LocalShardManager extends ShardManager {
279 LocalShardManager(final AbstractShardManagerCreator<?> creator) {
284 protected ActorRef newShardActor(final ShardInformation info) {
285 Entry<ActorRef, DatastoreContext> entry = shardInfoMap.get(info.getShardName());
288 ref = entry.getKey();
289 entry.setValue(info.getDatastoreContext());
292 newShardActorLatch.countDown();
297 final Creator<ShardManager> creator = new Creator<>() {
298 private static final long serialVersionUID = 1L;
300 public ShardManager create() {
301 return new LocalShardManager(
302 new GenericCreator<>(LocalShardManager.class).datastoreContextFactory(mockFactory)
303 .primaryShardInfoCache(primaryShardInfoCache).configuration(mockConfig));
307 final TestKit kit = new TestKit(getSystem());
309 final ActorRef shardManager = actorFactory.createActor(Props.create(ShardManager.class,
310 new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()));
312 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
314 assertTrue("Shard actors created", newShardActorLatch.await(5, TimeUnit.SECONDS));
315 assertEquals("getShardElectionTimeoutFactor", 6,
316 shardInfoMap.get("default").getValue().getShardElectionTimeoutFactor());
317 assertEquals("getShardElectionTimeoutFactor", 7,
318 shardInfoMap.get("topology").getValue().getShardElectionTimeoutFactor());
320 DatastoreContextFactory newMockFactory = newDatastoreContextFactory(
321 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
323 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(66).build())
324 .when(newMockFactory).getShardDatastoreContext("default");
327 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(77).build())
328 .when(newMockFactory).getShardDatastoreContext("topology");
330 shardManager.tell(newMockFactory, kit.getRef());
332 DatastoreContext newContext = MessageCollectorActor.expectFirstMatching(defaultShardActor,
333 DatastoreContext.class);
334 assertEquals("getShardElectionTimeoutFactor", 66, newContext.getShardElectionTimeoutFactor());
336 newContext = MessageCollectorActor.expectFirstMatching(topologyShardActor, DatastoreContext.class);
337 assertEquals("getShardElectionTimeoutFactor", 77, newContext.getShardElectionTimeoutFactor());
339 LOG.info("testPerShardDatastoreContext ending");
343 public void testOnReceiveFindPrimaryForNonExistentShard() {
344 final TestKit kit = new TestKit(getSystem());
345 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
347 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
349 shardManager.tell(new FindPrimary("non-existent", false), kit.getRef());
351 kit.expectMsgClass(Duration.ofSeconds(5), PrimaryNotFoundException.class);
355 public void testOnReceiveFindPrimaryForLocalLeaderShard() {
356 LOG.info("testOnReceiveFindPrimaryForLocalLeaderShard starting");
357 final TestKit kit = new TestKit(getSystem());
358 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
360 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
362 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
363 shardManager.tell(new ActorInitialized(), mockShardActor);
365 DataTree mockDataTree = mock(DataTree.class);
366 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mockDataTree,
367 DataStoreVersions.CURRENT_VERSION), kit.getRef());
369 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
371 new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
374 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
376 LocalPrimaryShardFound primaryFound = kit.expectMsgClass(Duration.ofSeconds(5),
377 LocalPrimaryShardFound.class);
378 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
379 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
380 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
382 LOG.info("testOnReceiveFindPrimaryForLocalLeaderShard ending");
386 public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() {
387 LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp starting");
388 final TestKit kit = new TestKit(getSystem());
389 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
391 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
392 shardManager.tell(new ActorInitialized(), mockShardActor);
394 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
395 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
397 new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
399 shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION),
402 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
404 kit.expectMsgClass(Duration.ofSeconds(5), NoShardLeaderException.class);
406 LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp ending");
410 public void testOnReceiveFindPrimaryForNonLocalLeaderShard() {
411 LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShard starting");
412 final TestKit kit = new TestKit(getSystem());
413 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
415 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
416 shardManager.tell(new ActorInitialized(), mockShardActor);
418 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
419 MockClusterWrapper.sendMemberUp(shardManager, "member-2", kit.getRef().path().toString());
421 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
423 new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
425 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
426 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, leaderVersion), mockShardActor);
428 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
430 RemotePrimaryShardFound primaryFound = kit.expectMsgClass(Duration.ofSeconds(5), RemotePrimaryShardFound.class);
431 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
432 primaryFound.getPrimaryPath().contains("member-2-shard-default"));
433 assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
435 LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShard ending");
439 public void testOnReceiveFindPrimaryForUninitializedShard() {
440 final TestKit kit = new TestKit(getSystem());
441 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
443 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
445 kit.expectMsgClass(Duration.ofSeconds(5), NotInitializedException.class);
449 public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() {
450 final TestKit kit = new TestKit(getSystem());
451 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
453 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
454 shardManager.tell(new ActorInitialized(), mockShardActor);
456 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
458 kit.expectMsgClass(Duration.ofSeconds(5), NoShardLeaderException.class);
462 public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() {
463 LOG.info("testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId starting");
464 final TestKit kit = new TestKit(getSystem());
465 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
467 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
468 shardManager.tell(new ActorInitialized(), mockShardActor);
470 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
472 new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Follower.name()),
475 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
477 kit.expectMsgClass(Duration.ofSeconds(5), NoShardLeaderException.class);
479 DataTree mockDataTree = mock(DataTree.class);
480 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mockDataTree,
481 DataStoreVersions.CURRENT_VERSION), mockShardActor);
483 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), kit.getRef());
485 LocalPrimaryShardFound primaryFound = kit.expectMsgClass(Duration.ofSeconds(5),
486 LocalPrimaryShardFound.class);
487 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
488 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
489 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
491 LOG.info("testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId starting");
495 public void testOnReceiveFindPrimaryWaitForShardLeader() {
496 LOG.info("testOnReceiveFindPrimaryWaitForShardLeader starting");
497 datastoreContextBuilder.shardInitializationTimeout(10, TimeUnit.SECONDS);
498 final TestKit kit = new TestKit(getSystem());
499 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
501 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
503 // We're passing waitUntilInitialized = true to FindPrimary so
504 // the response should be
505 // delayed until we send ActorInitialized and
506 // RoleChangeNotification.
507 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), kit.getRef());
509 kit.expectNoMessage(Duration.ofMillis(150));
511 shardManager.tell(new ActorInitialized(), mockShardActor);
513 kit.expectNoMessage(Duration.ofMillis(150));
515 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
517 new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
520 kit.expectNoMessage(Duration.ofMillis(150));
522 DataTree mockDataTree = mock(DataTree.class);
523 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mockDataTree,
524 DataStoreVersions.CURRENT_VERSION), mockShardActor);
526 LocalPrimaryShardFound primaryFound = kit.expectMsgClass(Duration.ofSeconds(5), LocalPrimaryShardFound.class);
527 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
528 primaryFound.getPrimaryPath().contains("member-1-shard-default"));
529 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
531 kit.expectNoMessage(Duration.ofMillis(200));
533 LOG.info("testOnReceiveFindPrimaryWaitForShardLeader ending");
537 public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() {
538 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard starting");
539 final TestKit kit = new TestKit(getSystem());
540 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
542 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
544 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), kit.getRef());
546 kit.expectMsgClass(Duration.ofSeconds(2), NotInitializedException.class);
548 shardManager.tell(new ActorInitialized(), mockShardActor);
550 kit.expectNoMessage(Duration.ofMillis(200));
552 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard ending");
556 public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() {
557 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithCandidateShard starting");
558 final TestKit kit = new TestKit(getSystem());
559 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
561 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
562 shardManager.tell(new ActorInitialized(), mockShardActor);
563 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix, null,
564 RaftState.Candidate.name()), mockShardActor);
566 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), kit.getRef());
568 kit.expectMsgClass(Duration.ofSeconds(2), NoShardLeaderException.class);
570 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithCandidateShard ending");
574 public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() {
575 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard starting");
576 final TestKit kit = new TestKit(getSystem());
577 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
579 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
580 shardManager.tell(new ActorInitialized(), mockShardActor);
581 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix, null,
582 RaftState.IsolatedLeader.name()), mockShardActor);
584 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true),kit. getRef());
586 kit.expectMsgClass(Duration.ofSeconds(2), NoShardLeaderException.class);
588 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard ending");
592 public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() {
593 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard starting");
594 final TestKit kit = new TestKit(getSystem());
595 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
597 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
598 shardManager.tell(new ActorInitialized(), mockShardActor);
600 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), kit.getRef());
602 kit.expectMsgClass(Duration.ofSeconds(2), NoShardLeaderException.class);
604 LOG.info("testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard ending");
608 public void testOnReceiveFindPrimaryForRemoteShard() {
609 LOG.info("testOnReceiveFindPrimaryForRemoteShard starting");
610 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
612 // Create an ActorSystem ShardManager actor for member-1.
614 final ActorSystem system1 = newActorSystem("Member1");
615 Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
617 final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
618 newTestShardMgrBuilderWithMockShardActor().cluster(
619 new ClusterWrapperImpl(system1)).props().withDispatcher(
620 Dispatchers.DefaultDispatcherId()), shardManagerID);
622 // Create an ActorSystem ShardManager actor for member-2.
624 final ActorSystem system2 = newActorSystem("Member2");
626 Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
628 final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
630 MockConfiguration mockConfig2 = new MockConfiguration(
631 ImmutableMap.<String, List<String>>builder().put("default", Arrays.asList("member-1", "member-2"))
632 .put("astronauts", Arrays.asList("member-2")).build());
634 final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
635 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
636 new ClusterWrapperImpl(system2)).props().withDispatcher(
637 Dispatchers.DefaultDispatcherId()), shardManagerID);
639 final TestKit kit = new TestKit(system1);
640 shardManager1.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
641 shardManager2.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
643 shardManager2.tell(new ActorInitialized(), mockShardActor2);
645 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
646 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
647 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class), leaderVersion),
649 shardManager2.tell(new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
652 shardManager1.underlyingActor().waitForMemberUp();
653 shardManager1.tell(new FindPrimary("astronauts", false), kit.getRef());
655 RemotePrimaryShardFound found = kit.expectMsgClass(Duration.ofSeconds(5), RemotePrimaryShardFound.class);
656 String path = found.getPrimaryPath();
657 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
658 assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
660 shardManager2.underlyingActor().verifyFindPrimary();
662 // This part times out quite a bit on jenkins for some reason
664 // Cluster.get(system2).down(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
666 // shardManager1.underlyingActor().waitForMemberRemoved();
668 // shardManager1.tell(new FindPrimary("astronauts", false), getRef());
670 // expectMsgClass(Duration.ofSeconds(5), PrimaryNotFoundException.class);
672 LOG.info("testOnReceiveFindPrimaryForRemoteShard ending");
676 public void testShardAvailabilityOnChangeOfMemberReachability() {
677 LOG.info("testShardAvailabilityOnChangeOfMemberReachability starting");
678 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
680 // Create an ActorSystem ShardManager actor for member-1.
682 final ActorSystem system1 = newActorSystem("Member1");
683 Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
685 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
687 final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
688 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(
689 new ClusterWrapperImpl(system1)).props().withDispatcher(
690 Dispatchers.DefaultDispatcherId()), shardManagerID);
692 // Create an ActorSystem ShardManager actor for member-2.
694 final ActorSystem system2 = newActorSystem("Member2");
696 Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
698 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
700 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
701 .put("default", Arrays.asList("member-1", "member-2")).build());
703 final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
704 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
705 new ClusterWrapperImpl(system2)).props().withDispatcher(
706 Dispatchers.DefaultDispatcherId()), shardManagerID);
708 final TestKit kit = new TestKit(system1);
709 shardManager1.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
710 shardManager2.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
711 shardManager1.tell(new ActorInitialized(), mockShardActor1);
712 shardManager2.tell(new ActorInitialized(), mockShardActor2);
714 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
715 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
716 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2, mock(DataTree.class),
717 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
719 new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
721 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class),
722 DataStoreVersions.CURRENT_VERSION), mockShardActor2);
724 new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
726 shardManager1.underlyingActor().waitForMemberUp();
728 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
730 RemotePrimaryShardFound found = kit.expectMsgClass(Duration.ofSeconds(5), RemotePrimaryShardFound.class);
731 String path = found.getPrimaryPath();
732 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
734 shardManager1.tell(MockClusterWrapper.createUnreachableMember("member-2", "akka://cluster-test@127.0.0.1:2558"),
737 shardManager1.underlyingActor().waitForUnreachableMember();
738 MessageCollectorActor.clearMessages(mockShardActor1);
740 shardManager1.tell(MockClusterWrapper.createMemberRemoved("member-2", "akka://cluster-test@127.0.0.1:2558"),
743 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
745 kit.expectMsgClass(Duration.ofSeconds(5), NoShardLeaderException.class);
747 shardManager1.tell(MockClusterWrapper.createReachableMember("member-2", "akka://cluster-test@127.0.0.1:2558"),
750 shardManager1.underlyingActor().waitForReachableMember();
752 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
754 RemotePrimaryShardFound found1 = kit.expectMsgClass(Duration.ofSeconds(5), RemotePrimaryShardFound.class);
755 String path1 = found1.getPrimaryPath();
756 assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
758 shardManager1.tell(MockClusterWrapper.createMemberUp("member-2", "akka://cluster-test@127.0.0.1:2558"),
761 // Test FindPrimary wait succeeds after reachable member event.
763 shardManager1.tell(MockClusterWrapper.createUnreachableMember("member-2",
764 "akka://cluster-test@127.0.0.1:2558"), kit.getRef());
765 shardManager1.underlyingActor().waitForUnreachableMember();
767 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
770 MockClusterWrapper.createReachableMember("member-2", "akka://cluster-test@127.0.0.1:2558"), kit.getRef());
772 RemotePrimaryShardFound found2 = kit.expectMsgClass(Duration.ofSeconds(5), RemotePrimaryShardFound.class);
773 String path2 = found2.getPrimaryPath();
774 assertTrue("Unexpected primary path " + path2, path2.contains("member-2-shard-default-config"));
776 LOG.info("testShardAvailabilityOnChangeOfMemberReachability ending");
780 public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() {
781 LOG.info("testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange starting");
782 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
784 // Create an ActorSystem ShardManager actor for member-1.
786 final ActorSystem system1 = newActorSystem("Member1");
787 Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
789 final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
791 final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
792 final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
793 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(new ClusterWrapperImpl(system1))
794 .primaryShardInfoCache(primaryShardInfoCache).props()
795 .withDispatcher(Dispatchers.DefaultDispatcherId()),
798 // Create an ActorSystem ShardManager actor for member-2.
800 final ActorSystem system2 = newActorSystem("Member2");
802 Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
804 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
806 MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
807 .put("default", Arrays.asList("member-1", "member-2")).build());
809 final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
810 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
811 new ClusterWrapperImpl(system2)).props().withDispatcher(
812 Dispatchers.DefaultDispatcherId()), shardManagerID);
814 final TestKit kit = new TestKit(system1);
815 shardManager1.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
816 shardManager2.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
817 shardManager1.tell(new ActorInitialized(), mockShardActor1);
818 shardManager2.tell(new ActorInitialized(), mockShardActor2);
820 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
821 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
822 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2, mock(DataTree.class),
823 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
825 new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
827 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class),
828 DataStoreVersions.CURRENT_VERSION), mockShardActor2);
830 new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
832 shardManager1.underlyingActor().waitForMemberUp();
834 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
836 RemotePrimaryShardFound found = kit.expectMsgClass(Duration.ofSeconds(5), RemotePrimaryShardFound.class);
837 String path = found.getPrimaryPath();
838 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
840 primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(
841 system1.actorSelection(mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION));
843 shardManager1.tell(MockClusterWrapper.createUnreachableMember("member-2",
844 "akka://cluster-test@127.0.0.1:2558"), kit.getRef());
846 shardManager1.underlyingActor().waitForUnreachableMember();
848 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
850 kit.expectMsgClass(Duration.ofSeconds(5), NoShardLeaderException.class);
852 assertNull("Expected primaryShardInfoCache entry removed",
853 primaryShardInfoCache.getIfPresent("default"));
855 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, mock(DataTree.class),
856 DataStoreVersions.CURRENT_VERSION), mockShardActor1);
858 new RoleChangeNotification(memberId1, RaftState.Follower.name(), RaftState.Leader.name()),
861 shardManager1.tell(new FindPrimary("default", true), kit.getRef());
863 LocalPrimaryShardFound found1 = kit.expectMsgClass(Duration.ofSeconds(5), LocalPrimaryShardFound.class);
864 String path1 = found1.getPrimaryPath();
865 assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
867 LOG.info("testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange ending");
871 public void testShardAvailabilityChangeOnMemberWithNameContainedInLeaderIdUnreachable() {
872 LOG.info("testShardAvailabilityChangeOnMemberWithNameContainedInLeaderIdUnreachable starting");
873 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
875 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
876 .put("default", Arrays.asList("member-256", "member-2")).build());
878 // Create an ActorSystem, ShardManager and actor for member-256.
880 final ActorSystem system256 = newActorSystem("Member256");
881 // 2562 is the tcp port of Member256 in src/test/resources/application.conf.
882 Cluster.get(system256).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2562"));
884 final ActorRef mockShardActor256 = newMockShardActor(system256, Shard.DEFAULT_NAME, "member-256");
886 final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
888 // ShardManager must be created with shard configuration to let its localShards has shards.
889 final TestActorRef<TestShardManager> shardManager256 = TestActorRef.create(system256,
890 newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor256)
891 .cluster(new ClusterWrapperImpl(system256))
892 .primaryShardInfoCache(primaryShardInfoCache).props()
893 .withDispatcher(Dispatchers.DefaultDispatcherId()),
896 // Create an ActorSystem, ShardManager and actor for member-2 whose name is contained in member-256.
898 final ActorSystem system2 = newActorSystem("Member2");
900 // Join member-2 into the cluster of member-256.
901 Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2562"));
903 final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
905 final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
906 newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor2).cluster(
907 new ClusterWrapperImpl(system2)).props().withDispatcher(
908 Dispatchers.DefaultDispatcherId()), shardManagerID);
910 final TestKit kit256 = new TestKit(system256);
911 shardManager256.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit256.getRef());
912 shardManager2.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit256.getRef());
913 shardManager256.tell(new ActorInitialized(), mockShardActor256);
914 shardManager2.tell(new ActorInitialized(), mockShardActor2);
916 String memberId256 = "member-256-shard-default-" + shardMrgIDSuffix;
917 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
918 shardManager256.tell(new ShardLeaderStateChanged(memberId256, memberId256, mock(DataTree.class),
919 DataStoreVersions.CURRENT_VERSION), mockShardActor256);
920 shardManager256.tell(
921 new RoleChangeNotification(memberId256, RaftState.Candidate.name(), RaftState.Leader.name()),
923 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId256, mock(DataTree.class),
924 DataStoreVersions.CURRENT_VERSION), mockShardActor2);
926 new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Follower.name()),
928 shardManager256.underlyingActor().waitForMemberUp();
930 shardManager256.tell(new FindPrimary("default", true), kit256.getRef());
932 LocalPrimaryShardFound found = kit256.expectMsgClass(Duration.ofSeconds(5), LocalPrimaryShardFound.class);
933 String path = found.getPrimaryPath();
934 assertTrue("Unexpected primary path " + path + " which must on member-256",
935 path.contains("member-256-shard-default-config"));
937 PrimaryShardInfo primaryShardInfo = new PrimaryShardInfo(
938 system256.actorSelection(mockShardActor256.path()), DataStoreVersions.CURRENT_VERSION);
939 primaryShardInfoCache.putSuccessful("default", primaryShardInfo);
941 // Simulate member-2 become unreachable.
942 shardManager256.tell(MockClusterWrapper.createUnreachableMember("member-2",
943 "akka://cluster-test@127.0.0.1:2558"), kit256.getRef());
944 shardManager256.underlyingActor().waitForUnreachableMember();
946 // Make sure leader shard on member-256 is still leader and still in the cache.
947 shardManager256.tell(new FindPrimary("default", true), kit256.getRef());
948 found = kit256.expectMsgClass(Duration.ofSeconds(5), LocalPrimaryShardFound.class);
949 path = found.getPrimaryPath();
950 assertTrue("Unexpected primary path " + path + " which must still not on member-256",
951 path.contains("member-256-shard-default-config"));
952 Future<PrimaryShardInfo> futurePrimaryShard = primaryShardInfoCache.getIfPresent("default");
953 futurePrimaryShard.onComplete(new OnComplete<PrimaryShardInfo>() {
955 public void onComplete(final Throwable failure, final PrimaryShardInfo futurePrimaryShardInfo) {
956 if (failure != null) {
957 assertTrue("Primary shard info is unexpectedly removed from primaryShardInfoCache", false);
959 assertEquals("Expected primaryShardInfoCache entry",
960 primaryShardInfo, futurePrimaryShardInfo);
963 }, system256.dispatchers().defaultGlobalDispatcher());
965 LOG.info("testShardAvailabilityChangeOnMemberWithNameContainedInLeaderIdUnreachable ending");
969 public void testOnReceiveFindLocalShardForNonExistentShard() {
970 final TestKit kit = new TestKit(getSystem());
971 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
973 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
975 shardManager.tell(new FindLocalShard("non-existent", false), kit.getRef());
977 LocalShardNotFound notFound = kit.expectMsgClass(Duration.ofSeconds(5), LocalShardNotFound.class);
979 assertEquals("getShardName", "non-existent", notFound.getShardName());
983 public void testOnReceiveFindLocalShardForExistentShard() {
984 final TestKit kit = new TestKit(getSystem());
985 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
987 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
988 shardManager.tell(new ActorInitialized(), mockShardActor);
990 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), kit.getRef());
992 LocalShardFound found = kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
994 assertTrue("Found path contains " + found.getPath().path().toString(),
995 found.getPath().path().toString().contains("member-1-shard-default-config"));
999 public void testOnReceiveFindLocalShardForNotInitializedShard() {
1000 final TestKit kit = new TestKit(getSystem());
1001 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1003 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), kit.getRef());
1005 kit.expectMsgClass(Duration.ofSeconds(5), NotInitializedException.class);
1009 public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
1010 LOG.info("testOnReceiveFindLocalShardWaitForShardInitialized starting");
1011 final TestKit kit = new TestKit(getSystem());
1012 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1014 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1016 // We're passing waitUntilInitialized = true to FindLocalShard
1017 // so the response should be
1018 // delayed until we send ActorInitialized.
1019 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
1020 new Timeout(5, TimeUnit.SECONDS));
1022 shardManager.tell(new ActorInitialized(), mockShardActor);
1024 Object resp = Await.result(future, kit.duration("5 seconds"));
1025 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
1027 LOG.info("testOnReceiveFindLocalShardWaitForShardInitialized starting");
1031 public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
1032 TestShardManager shardManager = newTestShardManager();
1034 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1035 shardManager.handleCommand(new RoleChangeNotification(
1036 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
1037 assertFalse(ready.isDone());
1039 shardManager.handleCommand(new ShardLeaderStateChanged(memberId, memberId,
1040 mock(DataTree.class), DataStoreVersions.CURRENT_VERSION));
1041 assertTrue(ready.isDone());
1045 public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
1046 final TestKit kit = new TestKit(getSystem());
1047 TestShardManager shardManager = newTestShardManager();
1049 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1050 shardManager.handleCommand(new RoleChangeNotification(memberId, null, RaftState.Follower.name()));
1051 assertFalse(ready.isDone());
1053 shardManager.handleCommand(MockClusterWrapper.createMemberUp("member-2", kit.getRef().path().toString()));
1055 shardManager.handleCommand(
1056 new ShardLeaderStateChanged(memberId, "member-2-shard-default-" + shardMrgIDSuffix,
1057 mock(DataTree.class), DataStoreVersions.CURRENT_VERSION));
1058 assertTrue(ready.isDone());
1062 public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
1063 final TestKit kit = new TestKit(getSystem());
1064 TestShardManager shardManager = newTestShardManager();
1066 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1067 shardManager.handleCommand(new RoleChangeNotification(memberId, null, RaftState.Follower.name()));
1068 assertFalse(ready.isDone());
1070 shardManager.handleCommand(
1071 new ShardLeaderStateChanged(memberId, "member-2-shard-default-" + shardMrgIDSuffix,
1072 mock(DataTree.class), DataStoreVersions.CURRENT_VERSION));
1074 shardManager.handleCommand(MockClusterWrapper.createMemberUp("member-2", kit.getRef().path().toString()));
1075 assertTrue(ready.isDone());
1079 public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
1080 TestShardManager shardManager = newTestShardManager();
1082 shardManager.handleCommand(new RoleChangeNotification("unknown", RaftState.Candidate.name(),
1083 RaftState.Leader.name()));
1084 assertFalse(ready.isDone());
1088 public void testByDefaultSyncStatusIsFalse() {
1089 TestShardManager shardManager = newTestShardManager();
1091 assertFalse(shardManager.getMBean().getSyncStatus());
1095 public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception {
1096 TestShardManager shardManager = newTestShardManager();
1098 shardManager.handleCommand(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
1099 RaftState.Follower.name(), RaftState.Leader.name()));
1101 assertTrue(shardManager.getMBean().getSyncStatus());
1105 public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception {
1106 TestShardManager shardManager = newTestShardManager();
1108 String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
1109 shardManager.handleCommand(new RoleChangeNotification(shardId,
1110 RaftState.Follower.name(), RaftState.Candidate.name()));
1112 assertFalse(shardManager.getMBean().getSyncStatus());
1114 // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
1115 shardManager.handleCommand(new FollowerInitialSyncUpStatus(
1118 assertFalse(shardManager.getMBean().getSyncStatus());
1122 public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception {
1123 TestShardManager shardManager = newTestShardManager();
1125 String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
1126 shardManager.handleCommand(new RoleChangeNotification(shardId,
1127 RaftState.Candidate.name(), RaftState.Follower.name()));
1129 // Initially will be false
1130 assertFalse(shardManager.getMBean().getSyncStatus());
1132 // Send status true will make sync status true
1133 shardManager.handleCommand(new FollowerInitialSyncUpStatus(true, shardId));
1135 assertTrue(shardManager.getMBean().getSyncStatus());
1137 // Send status false will make sync status false
1138 shardManager.handleCommand(new FollowerInitialSyncUpStatus(false, shardId));
1140 assertFalse(shardManager.getMBean().getSyncStatus());
1144 public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception {
1145 LOG.info("testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards starting");
1146 TestShardManager shardManager = newTestShardManager(newShardMgrProps(new MockConfiguration() {
1148 public List<String> getMemberShardNames(final MemberName memberName) {
1149 return Arrays.asList("default", "astronauts");
1153 // Initially will be false
1154 assertFalse(shardManager.getMBean().getSyncStatus());
1156 // Make default shard leader
1157 String defaultShardId = "member-1-shard-default-" + shardMrgIDSuffix;
1158 shardManager.handleCommand(new RoleChangeNotification(defaultShardId,
1159 RaftState.Follower.name(), RaftState.Leader.name()));
1161 // default = Leader, astronauts is unknown so sync status remains false
1162 assertFalse(shardManager.getMBean().getSyncStatus());
1164 // Make astronauts shard leader as well
1165 String astronautsShardId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1166 shardManager.handleCommand(new RoleChangeNotification(astronautsShardId,
1167 RaftState.Follower.name(), RaftState.Leader.name()));
1169 // Now sync status should be true
1170 assertTrue(shardManager.getMBean().getSyncStatus());
1172 // Make astronauts a Follower
1173 shardManager.handleCommand(new RoleChangeNotification(astronautsShardId,
1174 RaftState.Leader.name(), RaftState.Follower.name()));
1176 // Sync status is not true
1177 assertFalse(shardManager.getMBean().getSyncStatus());
1179 // Make the astronauts follower sync status true
1180 shardManager.handleCommand(new FollowerInitialSyncUpStatus(true, astronautsShardId));
1182 // Sync status is now true
1183 assertTrue(shardManager.getMBean().getSyncStatus());
1185 LOG.info("testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards ending");
1189 public void testOnReceiveSwitchShardBehavior() {
1190 final TestKit kit = new TestKit(getSystem());
1191 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1193 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1194 shardManager.tell(new ActorInitialized(), mockShardActor);
1196 shardManager.tell(new SwitchShardBehavior(mockShardName, RaftState.Leader, 1000), kit.getRef());
1198 SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor,
1199 SwitchBehavior.class);
1201 assertEquals(RaftState.Leader, switchBehavior.getNewState());
1202 assertEquals(1000, switchBehavior.getNewTerm());
1205 private static List<MemberName> members(final String... names) {
1206 return Arrays.asList(names).stream().map(MemberName::forName).collect(Collectors.toList());
1210 public void testOnCreateShard() {
1211 LOG.info("testOnCreateShard starting");
1212 final TestKit kit = new TestKit(getSystem());
1213 datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1215 ActorRef shardManager = actorFactory
1216 .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1217 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1219 EffectiveModelContext schemaContext = TEST_SCHEMA_CONTEXT;
1220 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1222 DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100)
1223 .persistent(false).build();
1224 Shard.Builder shardBuilder = Shard.builder();
1226 ModuleShardConfiguration config = new ModuleShardConfiguration(XMLNamespace.of("foo-ns"), "foo-module",
1227 "foo", null, members("member-1", "member-5", "member-6"));
1228 shardManager.tell(new CreateShard(config, shardBuilder, datastoreContext), kit.getRef());
1230 kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
1232 shardManager.tell(new FindLocalShard("foo", true), kit.getRef());
1234 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
1236 assertFalse("isRecoveryApplicable", shardBuilder.getDatastoreContext().isPersistent());
1237 assertTrue("Epxected ShardPeerAddressResolver", shardBuilder.getDatastoreContext().getShardRaftConfig()
1238 .getPeerAddressResolver() instanceof ShardPeerAddressResolver);
1239 assertEquals("peerMembers", Sets.newHashSet(
1240 ShardIdentifier.create("foo", MemberName.forName("member-5"), shardMrgIDSuffix).toString(),
1241 ShardIdentifier.create("foo", MemberName.forName("member-6"), shardMrgIDSuffix).toString()),
1242 shardBuilder.getPeerAddresses().keySet());
1243 assertEquals("ShardIdentifier", ShardIdentifier.create("foo", MEMBER_1, shardMrgIDSuffix),
1244 shardBuilder.getId());
1245 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1247 // Send CreateShard with same name - should return Success with
1250 shardManager.tell(new CreateShard(config, shardBuilder, null), kit.getRef());
1252 Success success = kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
1253 assertNotNull("Success status is null", success.status());
1255 LOG.info("testOnCreateShard ending");
1259 public void testOnCreateShardWithLocalMemberNotInShardConfig() {
1260 LOG.info("testOnCreateShardWithLocalMemberNotInShardConfig starting");
1261 final TestKit kit = new TestKit(getSystem());
1262 datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1264 ActorRef shardManager = actorFactory
1265 .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1266 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1268 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), ActorRef.noSender());
1270 Shard.Builder shardBuilder = Shard.builder();
1271 ModuleShardConfiguration config = new ModuleShardConfiguration(XMLNamespace.of("foo-ns"), "foo-module",
1272 "foo", null, members("member-5", "member-6"));
1274 shardManager.tell(new CreateShard(config, shardBuilder, null), kit.getRef());
1275 kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
1277 shardManager.tell(new FindLocalShard("foo", true), kit.getRef());
1278 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
1280 assertEquals("peerMembers size", 0, shardBuilder.getPeerAddresses().size());
1281 assertEquals("schemaContext", DisableElectionsRaftPolicy.class.getName(), shardBuilder
1282 .getDatastoreContext().getShardRaftConfig().getCustomRaftPolicyImplementationClass());
1284 LOG.info("testOnCreateShardWithLocalMemberNotInShardConfig ending");
1288 public void testOnCreateShardWithNoInitialSchemaContext() {
1289 LOG.info("testOnCreateShardWithNoInitialSchemaContext starting");
1290 final TestKit kit = new TestKit(getSystem());
1291 ActorRef shardManager = actorFactory
1292 .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1293 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1295 Shard.Builder shardBuilder = Shard.builder();
1297 ModuleShardConfiguration config = new ModuleShardConfiguration(XMLNamespace.of("foo-ns"), "foo-module",
1298 "foo", null, members("member-1"));
1299 shardManager.tell(new CreateShard(config, shardBuilder, null), kit.getRef());
1301 kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
1303 EffectiveModelContext schemaContext = TEST_SCHEMA_CONTEXT;
1304 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1306 shardManager.tell(new FindLocalShard("foo", true), kit.getRef());
1308 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
1310 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1311 assertNotNull("schemaContext is null", shardBuilder.getDatastoreContext());
1313 LOG.info("testOnCreateShardWithNoInitialSchemaContext ending");
1317 public void testGetSnapshot() {
1318 LOG.info("testGetSnapshot starting");
1319 TestKit kit = new TestKit(getSystem());
1321 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1322 .put("shard1", Arrays.asList("member-1")).put("shard2", Arrays.asList("member-1"))
1323 .put("astronauts", Collections.<String>emptyList()).build());
1325 TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(newShardMgrProps(mockConfig)
1326 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1328 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1329 Failure failure = kit.expectMsgClass(Failure.class);
1330 assertEquals("Failure cause type", IllegalStateException.class, failure.cause().getClass());
1332 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), ActorRef.noSender());
1334 waitForShardInitialized(shardManager, "shard1", kit);
1335 waitForShardInitialized(shardManager, "shard2", kit);
1337 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1339 DatastoreSnapshot datastoreSnapshot = expectMsgClassOrFailure(DatastoreSnapshot.class, kit, "GetSnapshot");
1341 assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1342 assertNull("Expected null ShardManagerSnapshot", datastoreSnapshot.getShardManagerSnapshot());
1344 assertEquals("Shard names", Sets.newHashSet("shard1", "shard2"), Sets.newHashSet(
1345 datastoreSnapshot.getShardSnapshots().stream().map(ShardSnapshot::getName).collect(Collectors.toSet())));
1347 // Add a new replica
1349 TestKit mockShardLeaderKit = new TestKit(getSystem());
1351 TestShardManager shardManagerInstance = shardManager.underlyingActor();
1352 shardManagerInstance.setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1354 shardManager.tell(new AddShardReplica("astronauts"), kit.getRef());
1355 mockShardLeaderKit.expectMsgClass(AddServer.class);
1356 mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.OK, ""));
1357 kit.expectMsgClass(Status.Success.class);
1358 waitForShardInitialized(shardManager, "astronauts", kit);
1360 // Send another GetSnapshot and verify
1362 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1363 datastoreSnapshot = expectMsgClassOrFailure(DatastoreSnapshot.class, kit, "GetSnapshot");
1365 assertEquals("Shard names", Sets.newHashSet("shard1", "shard2", "astronauts"), Sets.newHashSet(
1366 Lists.transform(datastoreSnapshot.getShardSnapshots(), ShardSnapshot::getName)));
1368 ShardManagerSnapshot snapshot = datastoreSnapshot.getShardManagerSnapshot();
1369 assertNotNull("Expected ShardManagerSnapshot", snapshot);
1370 assertEquals("Shard names", Sets.newHashSet("shard1", "shard2", "astronauts"),
1371 Sets.newHashSet(snapshot.getShardList()));
1373 LOG.info("testGetSnapshot ending");
1377 public void testRestoreFromSnapshot() {
1378 LOG.info("testRestoreFromSnapshot starting");
1380 datastoreContextBuilder.shardInitializationTimeout(3, TimeUnit.SECONDS);
1382 TestKit kit = new TestKit(getSystem());
1384 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1385 .put("shard1", Collections.<String>emptyList()).put("shard2", Collections.<String>emptyList())
1386 .put("astronauts", Collections.<String>emptyList()).build());
1388 ShardManagerSnapshot snapshot =
1389 new ShardManagerSnapshot(Arrays.asList("shard1", "shard2", "astronauts"));
1390 DatastoreSnapshot restoreFromSnapshot = new DatastoreSnapshot(shardMrgIDSuffix, snapshot,
1391 Collections.<ShardSnapshot>emptyList());
1392 TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(newTestShardMgrBuilder(mockConfig)
1393 .restoreFromSnapshot(restoreFromSnapshot).props().withDispatcher(Dispatchers.DefaultDispatcherId()));
1395 shardManager.underlyingActor().waitForRecoveryComplete();
1397 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), ActorRef.noSender());
1399 waitForShardInitialized(shardManager, "shard1", kit);
1400 waitForShardInitialized(shardManager, "shard2", kit);
1401 waitForShardInitialized(shardManager, "astronauts", kit);
1403 shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1405 DatastoreSnapshot datastoreSnapshot = expectMsgClassOrFailure(DatastoreSnapshot.class, kit, "GetSnapshot");
1407 assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1409 assertNotNull("Expected ShardManagerSnapshot", datastoreSnapshot.getShardManagerSnapshot());
1410 assertEquals("Shard names", Sets.newHashSet("shard1", "shard2", "astronauts"),
1411 Sets.newHashSet(datastoreSnapshot.getShardManagerSnapshot().getShardList()));
1413 LOG.info("testRestoreFromSnapshot ending");
1417 public void testAddShardReplicaForNonExistentShardConfig() {
1418 final TestKit kit = new TestKit(getSystem());
1419 ActorRef shardManager = actorFactory
1420 .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1421 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1423 shardManager.tell(new AddShardReplica("model-inventory"), kit.getRef());
1424 Status.Failure resp = kit.expectMsgClass(Duration.ofSeconds(2), Status.Failure.class);
1426 assertTrue("Failure obtained", resp.cause() instanceof IllegalArgumentException);
1430 public void testAddShardReplica() {
1431 LOG.info("testAddShardReplica starting");
1432 MockConfiguration mockConfig = new MockConfiguration(
1433 ImmutableMap.<String, List<String>>builder().put("default", Arrays.asList("member-1", "member-2"))
1434 .put("astronauts", Arrays.asList("member-2")).build());
1436 final String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1437 datastoreContextBuilder.shardManagerPersistenceId(shardManagerID);
1439 // Create an ActorSystem ShardManager actor for member-1.
1440 final ActorSystem system1 = newActorSystem("Member1");
1441 Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1442 ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1443 final TestActorRef<TestShardManager> newReplicaShardManager = TestActorRef.create(system1,
1444 newTestShardMgrBuilder(mockConfig).shardActor(mockDefaultShardActor)
1445 .cluster(new ClusterWrapperImpl(system1)).props()
1446 .withDispatcher(Dispatchers.DefaultDispatcherId()),
1449 // Create an ActorSystem ShardManager actor for member-2.
1450 final ActorSystem system2 = newActorSystem("Member2");
1451 Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1453 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
1454 String name = ShardIdentifier.create("astronauts", MEMBER_2, "config").toString();
1455 final TestActorRef<MockRespondActor> mockShardLeaderActor = TestActorRef.create(system2,
1456 Props.create(MockRespondActor.class, AddServer.class,
1457 new AddServerReply(ServerChangeStatus.OK, memberId2))
1458 .withDispatcher(Dispatchers.DefaultDispatcherId()),
1460 final TestActorRef<TestShardManager> leaderShardManager = TestActorRef.create(system2,
1461 newTestShardMgrBuilder(mockConfig).shardActor(mockShardLeaderActor)
1462 .cluster(new ClusterWrapperImpl(system2)).props()
1463 .withDispatcher(Dispatchers.DefaultDispatcherId()),
1466 final TestKit kit = new TestKit(getSystem());
1467 newReplicaShardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1468 leaderShardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1470 leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1472 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1473 leaderShardManager.tell(
1474 new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class), leaderVersion),
1475 mockShardLeaderActor);
1476 leaderShardManager.tell(
1477 new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
1478 mockShardLeaderActor);
1480 newReplicaShardManager.underlyingActor().waitForMemberUp();
1481 leaderShardManager.underlyingActor().waitForMemberUp();
1483 // Have a dummy snapshot to be overwritten by the new data
1485 String[] restoredShards = { "default", "people" };
1486 ShardManagerSnapshot snapshot =
1487 new ShardManagerSnapshot(Arrays.asList(restoredShards));
1488 InMemorySnapshotStore.addSnapshot(shardManagerID, snapshot);
1489 Uninterruptibles.sleepUninterruptibly(2, TimeUnit.MILLISECONDS);
1491 InMemorySnapshotStore.addSnapshotSavedLatch(shardManagerID);
1492 InMemorySnapshotStore.addSnapshotDeletedLatch(shardManagerID);
1494 // construct a mock response message
1495 newReplicaShardManager.tell(new AddShardReplica("astronauts"), kit.getRef());
1496 AddServer addServerMsg = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1498 String addServerId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1499 assertEquals("AddServer serverId", addServerId, addServerMsg.getNewServerId());
1500 kit.expectMsgClass(Duration.ofSeconds(5), Status.Success.class);
1502 InMemorySnapshotStore.waitForSavedSnapshot(shardManagerID, ShardManagerSnapshot.class);
1503 InMemorySnapshotStore.waitForDeletedSnapshot(shardManagerID);
1504 List<ShardManagerSnapshot> persistedSnapshots = InMemorySnapshotStore.getSnapshots(shardManagerID,
1505 ShardManagerSnapshot.class);
1506 assertEquals("Number of snapshots persisted", 1, persistedSnapshots.size());
1507 ShardManagerSnapshot shardManagerSnapshot = persistedSnapshots.get(0);
1508 assertEquals("Persisted local shards", Sets.newHashSet("default", "astronauts"),
1509 Sets.newHashSet(shardManagerSnapshot.getShardList()));
1510 LOG.info("testAddShardReplica ending");
1514 public void testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader() {
1515 LOG.info("testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader starting");
1516 final TestKit kit = new TestKit(getSystem());
1517 TestActorRef<TestShardManager> shardManager = actorFactory
1518 .createTestActor(newPropsShardMgrWithMockShardActor(), shardMgrID);
1520 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1521 shardManager.tell(new ActorInitialized(), mockShardActor);
1523 String leaderId = "leader-member-shard-default-" + shardMrgIDSuffix;
1524 AddServerReply addServerReply = new AddServerReply(ServerChangeStatus.ALREADY_EXISTS, null);
1525 ActorRef leaderShardActor = shardManager.underlyingActor().getContext()
1526 .actorOf(Props.create(MockRespondActor.class, AddServer.class, addServerReply), leaderId);
1528 MockClusterWrapper.sendMemberUp(shardManager, "leader-member", leaderShardActor.path().toString());
1530 String newReplicaId = "member-1-shard-default-" + shardMrgIDSuffix;
1532 new RoleChangeNotification(newReplicaId, RaftState.Candidate.name(), RaftState.Follower.name()),
1535 new ShardLeaderStateChanged(newReplicaId, leaderId, DataStoreVersions.CURRENT_VERSION),
1538 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), kit.getRef());
1540 MessageCollectorActor.expectFirstMatching(leaderShardActor, AddServer.class);
1542 Failure resp = kit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1543 assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1545 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), kit.getRef());
1546 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
1548 // Send message again to verify previous in progress state is
1551 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), kit.getRef());
1552 resp = kit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1553 assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1555 // Send message again with an AddServer timeout to verify the
1556 // pre-existing shard actor isn't terminated.
1559 newDatastoreContextFactory(
1560 datastoreContextBuilder.shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build()), kit.getRef());
1561 leaderShardActor.tell(MockRespondActor.CLEAR_RESPONSE, ActorRef.noSender());
1562 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), kit.getRef());
1563 kit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1565 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), kit.getRef());
1566 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
1568 LOG.info("testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader ending");
1572 public void testAddShardReplicaWithPreExistingLocalReplicaLeader() {
1573 LOG.info("testAddShardReplicaWithPreExistingLocalReplicaLeader starting");
1574 final TestKit kit = new TestKit(getSystem());
1575 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1576 ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1578 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1579 shardManager.tell(new ActorInitialized(), mockShardActor);
1580 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mock(DataTree.class),
1581 DataStoreVersions.CURRENT_VERSION), kit.getRef());
1583 new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
1586 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), kit.getRef());
1587 Failure resp = kit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1588 assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1590 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), kit.getRef());
1591 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardFound.class);
1593 LOG.info("testAddShardReplicaWithPreExistingLocalReplicaLeader ending");
1597 public void testAddShardReplicaWithAddServerReplyFailure() {
1598 LOG.info("testAddShardReplicaWithAddServerReplyFailure starting");
1599 final TestKit kit = new TestKit(getSystem());
1600 final TestKit mockShardLeaderKit = new TestKit(getSystem());
1602 MockConfiguration mockConfig = new MockConfiguration(
1603 ImmutableMap.of("astronauts", Arrays.asList("member-2")));
1605 ActorRef mockNewReplicaShardActor = newMockShardActor(getSystem(), "astronauts", "member-1");
1606 final TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1607 newTestShardMgrBuilder(mockConfig).shardActor(mockNewReplicaShardActor).props()
1608 .withDispatcher(Dispatchers.DefaultDispatcherId()), shardMgrID);
1609 shardManager.underlyingActor().setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1611 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1613 TestKit terminateWatcher = new TestKit(getSystem());
1614 terminateWatcher.watch(mockNewReplicaShardActor);
1616 shardManager.tell(new AddShardReplica("astronauts"), kit.getRef());
1618 AddServer addServerMsg = mockShardLeaderKit.expectMsgClass(AddServer.class);
1619 assertEquals("AddServer serverId", "member-1-shard-astronauts-" + shardMrgIDSuffix,
1620 addServerMsg.getNewServerId());
1621 mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.TIMEOUT, null));
1623 Failure failure = kit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1624 assertEquals("Failure cause", TimeoutException.class, failure.cause().getClass());
1626 shardManager.tell(new FindLocalShard("astronauts", false), kit.getRef());
1627 kit.expectMsgClass(Duration.ofSeconds(5), LocalShardNotFound.class);
1629 terminateWatcher.expectTerminated(mockNewReplicaShardActor);
1631 shardManager.tell(new AddShardReplica("astronauts"), kit.getRef());
1632 mockShardLeaderKit.expectMsgClass(AddServer.class);
1633 mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.NO_LEADER, null));
1634 failure = kit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1635 assertEquals("Failure cause", NoShardLeaderException.class, failure.cause().getClass());
1637 LOG.info("testAddShardReplicaWithAddServerReplyFailure ending");
1641 public void testAddShardReplicaWithAlreadyInProgress() {
1642 testServerChangeWhenAlreadyInProgress("astronauts", new AddShardReplica("astronauts"),
1643 AddServer.class, new AddShardReplica("astronauts"));
1647 public void testAddShardReplicaWithFindPrimaryTimeout() {
1648 LOG.info("testAddShardReplicaWithFindPrimaryTimeout starting");
1649 datastoreContextBuilder.shardInitializationTimeout(100, TimeUnit.MILLISECONDS);
1650 final TestKit kit = new TestKit(getSystem());
1651 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.of("astronauts", Arrays.asList("member-2")));
1653 final ActorRef newReplicaShardManager = actorFactory
1654 .createActor(newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor).props()
1655 .withDispatcher(Dispatchers.DefaultDispatcherId()), shardMgrID);
1657 newReplicaShardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1658 MockClusterWrapper.sendMemberUp(newReplicaShardManager, "member-2",
1659 AddressFromURIString.parse("akka://non-existent@127.0.0.1:5").toString());
1661 newReplicaShardManager.tell(new AddShardReplica("astronauts"), kit.getRef());
1662 Status.Failure resp = kit.expectMsgClass(Duration.ofSeconds(5), Status.Failure.class);
1663 assertTrue("Failure obtained", resp.cause() instanceof RuntimeException);
1665 LOG.info("testAddShardReplicaWithFindPrimaryTimeout ending");
1669 public void testRemoveShardReplicaForNonExistentShard() {
1670 final TestKit kit = new TestKit(getSystem());
1671 ActorRef shardManager = actorFactory
1672 .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1673 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1675 shardManager.tell(new RemoveShardReplica("model-inventory", MEMBER_1), kit.getRef());
1676 Status.Failure resp = kit.expectMsgClass(Duration.ofSeconds(10), Status.Failure.class);
1677 assertTrue("Failure obtained", resp.cause() instanceof PrimaryNotFoundException);
1684 public void testRemoveShardReplicaLocal() {
1685 final TestKit kit = new TestKit(getSystem());
1686 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1688 final ActorRef respondActor = actorFactory.createActor(Props.create(MockRespondActor.class,
1689 RemoveServer.class, new RemoveServerReply(ServerChangeStatus.OK, null)), memberId);
1691 ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor(respondActor));
1693 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1694 shardManager.tell(new ActorInitialized(), respondActor);
1695 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mock(DataTree.class),
1696 DataStoreVersions.CURRENT_VERSION), kit.getRef());
1698 new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
1701 shardManager.tell(new RemoveShardReplica(Shard.DEFAULT_NAME, MEMBER_1), kit.getRef());
1702 final RemoveServer removeServer = MessageCollectorActor.expectFirstMatching(respondActor,
1703 RemoveServer.class);
1704 assertEquals(ShardIdentifier.create("default", MEMBER_1, shardMrgIDSuffix).toString(),
1705 removeServer.getServerId());
1706 kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
1710 public void testRemoveShardReplicaRemote() {
1711 MockConfiguration mockConfig = new MockConfiguration(
1712 ImmutableMap.<String, List<String>>builder().put("default", Arrays.asList("member-1", "member-2"))
1713 .put("astronauts", Arrays.asList("member-1")).build());
1715 String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1717 // Create an ActorSystem ShardManager actor for member-1.
1718 final ActorSystem system1 = newActorSystem("Member1");
1719 Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1720 ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1722 final TestActorRef<TestShardManager> newReplicaShardManager = TestActorRef.create(system1,
1723 newTestShardMgrBuilder().configuration(mockConfig).shardActor(mockDefaultShardActor).cluster(
1724 new ClusterWrapperImpl(system1)).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1727 // Create an ActorSystem ShardManager actor for member-2.
1728 final ActorSystem system2 = newActorSystem("Member2");
1729 Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1731 String name = ShardIdentifier.create("default", MEMBER_2, shardMrgIDSuffix).toString();
1732 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
1733 final TestActorRef<MockRespondActor> mockShardLeaderActor =
1734 TestActorRef.create(system2, Props.create(MockRespondActor.class, RemoveServer.class,
1735 new RemoveServerReply(ServerChangeStatus.OK, memberId2)), name);
1737 LOG.error("Mock Shard Leader Actor : {}", mockShardLeaderActor);
1739 final TestActorRef<TestShardManager> leaderShardManager = TestActorRef.create(system2,
1740 newTestShardMgrBuilder().configuration(mockConfig).shardActor(mockShardLeaderActor).cluster(
1741 new ClusterWrapperImpl(system2)).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1744 // Because mockShardLeaderActor is created at the top level of the actor system it has an address like so,
1745 // akka://cluster-test@127.0.0.1:2559/user/member-2-shard-default-config1
1746 // However when a shard manager has a local shard which is a follower and a leader that is remote it will
1747 // try to compute an address for the remote shard leader using the ShardPeerAddressResolver. This address will
1749 // akka://cluster-test@127.0.0.1:2559/user/shardmanager-config1/member-2-shard-default-config1
1750 // In this specific case if we did a FindPrimary for shard default from member-1 we would come up
1751 // with the address of an actor which does not exist, therefore any message sent to that actor would go to
1753 // To work around this problem we create a ForwardingActor with the right address and pass to it the
1754 // mockShardLeaderActor. The ForwardingActor simply forwards all messages to the mockShardLeaderActor and every
1755 // thing works as expected
1756 final ActorRef actorRef = leaderShardManager.underlyingActor().context()
1757 .actorOf(Props.create(ForwardingActor.class, mockShardLeaderActor),
1758 "member-2-shard-default-" + shardMrgIDSuffix);
1760 LOG.error("Forwarding actor : {}", actorRef);
1762 final TestKit kit = new TestKit(getSystem());
1763 newReplicaShardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1764 leaderShardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1766 leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1767 newReplicaShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1769 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1770 leaderShardManager.tell(
1771 new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class), leaderVersion),
1772 mockShardLeaderActor);
1773 leaderShardManager.tell(
1774 new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
1775 mockShardLeaderActor);
1777 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
1778 newReplicaShardManager.tell(
1779 new ShardLeaderStateChanged(memberId1, memberId2, mock(DataTree.class), leaderVersion),
1781 newReplicaShardManager.tell(
1782 new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
1785 newReplicaShardManager.underlyingActor().waitForMemberUp();
1786 leaderShardManager.underlyingActor().waitForMemberUp();
1788 // construct a mock response message
1789 newReplicaShardManager.tell(new RemoveShardReplica("default", MEMBER_1), kit.getRef());
1790 RemoveServer removeServer = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1791 RemoveServer.class);
1792 String removeServerId = ShardIdentifier.create("default", MEMBER_1, shardMrgIDSuffix).toString();
1793 assertEquals("RemoveServer serverId", removeServerId, removeServer.getServerId());
1794 kit.expectMsgClass(Duration.ofSeconds(5), Status.Success.class);
1798 public void testRemoveShardReplicaWhenAnotherRemoveShardReplicaAlreadyInProgress() {
1799 testServerChangeWhenAlreadyInProgress("astronauts", new RemoveShardReplica("astronauts", MEMBER_2),
1800 RemoveServer.class, new RemoveShardReplica("astronauts", MEMBER_3));
1804 public void testRemoveShardReplicaWhenAddShardReplicaAlreadyInProgress() {
1805 testServerChangeWhenAlreadyInProgress("astronauts", new AddShardReplica("astronauts"),
1806 AddServer.class, new RemoveShardReplica("astronauts", MEMBER_2));
1810 public void testServerChangeWhenAlreadyInProgress(final String shardName, final Object firstServerChange,
1811 final Class<?> firstForwardedServerChangeClass,
1812 final Object secondServerChange) {
1813 final TestKit kit = new TestKit(getSystem());
1814 final TestKit mockShardLeaderKit = new TestKit(getSystem());
1815 final TestKit secondRequestKit = new TestKit(getSystem());
1817 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1818 .put(shardName, Arrays.asList("member-2")).build());
1820 final TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
1821 newTestShardMgrBuilder().configuration(mockConfig).shardActor(mockShardActor)
1822 .cluster(new MockClusterWrapper()).props()
1823 .withDispatcher(Dispatchers.DefaultDispatcherId()),
1826 shardManager.underlyingActor().setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1828 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1830 shardManager.tell(firstServerChange, kit.getRef());
1832 mockShardLeaderKit.expectMsgClass(firstForwardedServerChangeClass);
1834 shardManager.tell(secondServerChange, secondRequestKit.getRef());
1836 secondRequestKit.expectMsgClass(Duration.ofSeconds(5), Failure.class);
1840 public void testServerRemovedShardActorNotRunning() {
1841 LOG.info("testServerRemovedShardActorNotRunning starting");
1842 final TestKit kit = new TestKit(getSystem());
1843 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1844 .put("default", Arrays.asList("member-1", "member-2"))
1845 .put("astronauts", Arrays.asList("member-2"))
1846 .put("people", Arrays.asList("member-1", "member-2")).build());
1848 TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1849 newShardMgrProps(mockConfig).withDispatcher(Dispatchers.DefaultDispatcherId()));
1851 shardManager.underlyingActor().waitForRecoveryComplete();
1852 shardManager.tell(new FindLocalShard("people", false), kit.getRef());
1853 kit.expectMsgClass(Duration.ofSeconds(5), NotInitializedException.class);
1855 shardManager.tell(new FindLocalShard("default", false), kit.getRef());
1856 kit.expectMsgClass(Duration.ofSeconds(5), NotInitializedException.class);
1858 // Removed the default shard replica from member-1
1859 ShardIdentifier.Builder builder = new ShardIdentifier.Builder();
1860 ShardIdentifier shardId = builder.shardName("default").memberName(MEMBER_1).type(shardMrgIDSuffix)
1862 shardManager.tell(new ServerRemoved(shardId.toString()), kit.getRef());
1864 shardManager.underlyingActor().verifySnapshotPersisted(Sets.newHashSet("people"));
1866 LOG.info("testServerRemovedShardActorNotRunning ending");
1870 public void testServerRemovedShardActorRunning() {
1871 LOG.info("testServerRemovedShardActorRunning starting");
1872 final TestKit kit = new TestKit(getSystem());
1873 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1874 .put("default", Arrays.asList("member-1", "member-2"))
1875 .put("astronauts", Arrays.asList("member-2"))
1876 .put("people", Arrays.asList("member-1", "member-2")).build());
1878 String shardId = ShardIdentifier.create("default", MEMBER_1, shardMrgIDSuffix).toString();
1879 ActorRef shard = actorFactory.createActor(MessageCollectorActor.props(), shardId);
1881 TestActorRef<TestShardManager> shardManager = actorFactory
1882 .createTestActor(newTestShardMgrBuilder(mockConfig).addShardActor("default", shard).props()
1883 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1885 shardManager.underlyingActor().waitForRecoveryComplete();
1887 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1888 shardManager.tell(new ActorInitialized(), shard);
1890 waitForShardInitialized(shardManager, "people", kit);
1891 waitForShardInitialized(shardManager, "default", kit);
1893 // Removed the default shard replica from member-1
1894 shardManager.tell(new ServerRemoved(shardId), kit.getRef());
1896 shardManager.underlyingActor().verifySnapshotPersisted(Sets.newHashSet("people"));
1898 MessageCollectorActor.expectFirstMatching(shard, Shutdown.class);
1900 LOG.info("testServerRemovedShardActorRunning ending");
1904 public void testShardPersistenceWithRestoredData() {
1905 LOG.info("testShardPersistenceWithRestoredData starting");
1906 final TestKit kit = new TestKit(getSystem());
1907 MockConfiguration mockConfig =
1908 new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1909 .put("default", Arrays.asList("member-1", "member-2"))
1910 .put("astronauts", Arrays.asList("member-2"))
1911 .put("people", Arrays.asList("member-1", "member-2")).build());
1912 String[] restoredShards = {"default", "astronauts"};
1913 ShardManagerSnapshot snapshot =
1914 new ShardManagerSnapshot(Arrays.asList(restoredShards));
1915 InMemorySnapshotStore.addSnapshot("shard-manager-" + shardMrgIDSuffix, snapshot);
1917 // create shardManager to come up with restored data
1918 TestActorRef<TestShardManager> newRestoredShardManager = actorFactory.createTestActor(
1919 newShardMgrProps(mockConfig).withDispatcher(Dispatchers.DefaultDispatcherId()));
1921 newRestoredShardManager.underlyingActor().waitForRecoveryComplete();
1923 newRestoredShardManager.tell(new FindLocalShard("people", false), kit.getRef());
1924 LocalShardNotFound notFound = kit.expectMsgClass(Duration.ofSeconds(5), LocalShardNotFound.class);
1925 assertEquals("for uninitialized shard", "people", notFound.getShardName());
1927 // Verify a local shard is created for the restored shards,
1928 // although we expect a NotInitializedException for the shards
1929 // as the actor initialization
1930 // message is not sent for them
1931 newRestoredShardManager.tell(new FindLocalShard("default", false), kit.getRef());
1932 kit.expectMsgClass(Duration.ofSeconds(5), NotInitializedException.class);
1934 newRestoredShardManager.tell(new FindLocalShard("astronauts", false), kit.getRef());
1935 kit.expectMsgClass(Duration.ofSeconds(5), NotInitializedException.class);
1937 LOG.info("testShardPersistenceWithRestoredData ending");
1941 public void testShutDown() throws Exception {
1942 LOG.info("testShutDown starting");
1943 final TestKit kit = new TestKit(getSystem());
1944 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1945 .put("shard1", Arrays.asList("member-1")).put("shard2", Arrays.asList("member-1")).build());
1947 String shardId1 = ShardIdentifier.create("shard1", MEMBER_1, shardMrgIDSuffix).toString();
1948 ActorRef shard1 = actorFactory.createActor(MessageCollectorActor.props(), shardId1);
1950 String shardId2 = ShardIdentifier.create("shard2", MEMBER_1, shardMrgIDSuffix).toString();
1951 ActorRef shard2 = actorFactory.createActor(MessageCollectorActor.props(), shardId2);
1953 ActorRef shardManager = actorFactory.createActor(newTestShardMgrBuilder(mockConfig)
1954 .addShardActor("shard1", shard1).addShardActor("shard2", shard2).props());
1956 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1957 shardManager.tell(new ActorInitialized(), shard1);
1958 shardManager.tell(new ActorInitialized(), shard2);
1960 FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
1961 Future<Boolean> stopFuture = Patterns.gracefulStop(shardManager, duration, Shutdown.INSTANCE);
1963 MessageCollectorActor.expectFirstMatching(shard1, Shutdown.class);
1964 MessageCollectorActor.expectFirstMatching(shard2, Shutdown.class);
1967 Await.ready(stopFuture, FiniteDuration.create(500, TimeUnit.MILLISECONDS));
1968 fail("ShardManager actor stopped without waiting for the Shards to be stopped");
1969 } catch (TimeoutException e) {
1973 actorFactory.killActor(shard1, kit);
1974 actorFactory.killActor(shard2, kit);
1976 Boolean stopped = Await.result(stopFuture, duration);
1977 assertEquals("Stopped", Boolean.TRUE, stopped);
1979 LOG.info("testShutDown ending");
1983 public void testChangeServersVotingStatus() {
1984 final TestKit kit = new TestKit(getSystem());
1985 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1987 ActorRef respondActor = actorFactory
1988 .createActor(Props.create(MockRespondActor.class, ChangeServersVotingStatus.class,
1989 new ServerChangeReply(ServerChangeStatus.OK, null)), memberId);
1991 ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor(respondActor));
1993 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
1994 shardManager.tell(new ActorInitialized(), respondActor);
1995 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mock(DataTree.class),
1996 DataStoreVersions.CURRENT_VERSION), kit.getRef());
1998 new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
2002 new ChangeShardMembersVotingStatus("default", ImmutableMap.of("member-2", Boolean.TRUE)), kit.getRef());
2004 ChangeServersVotingStatus actualChangeStatusMsg = MessageCollectorActor
2005 .expectFirstMatching(respondActor, ChangeServersVotingStatus.class);
2006 assertEquals("ChangeServersVotingStatus map", actualChangeStatusMsg.getServerVotingStatusMap(),
2007 ImmutableMap.of(ShardIdentifier
2008 .create("default", MemberName.forName("member-2"), shardMrgIDSuffix).toString(),
2011 kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
2015 public void testChangeServersVotingStatusWithNoLeader() {
2016 final TestKit kit = new TestKit(getSystem());
2017 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
2019 ActorRef respondActor = actorFactory
2020 .createActor(Props.create(MockRespondActor.class, ChangeServersVotingStatus.class,
2021 new ServerChangeReply(ServerChangeStatus.NO_LEADER, null)), memberId);
2023 ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor(respondActor));
2025 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
2026 shardManager.tell(new ActorInitialized(), respondActor);
2027 shardManager.tell(new RoleChangeNotification(memberId, null, RaftState.Follower.name()), respondActor);
2030 new ChangeShardMembersVotingStatus("default", ImmutableMap.of("member-2", Boolean.TRUE)), kit.getRef());
2032 MessageCollectorActor.expectFirstMatching(respondActor, ChangeServersVotingStatus.class);
2034 Status.Failure resp = kit.expectMsgClass(Duration.ofSeconds(5), Status.Failure.class);
2035 assertTrue("Failure resposnse", resp.cause() instanceof NoShardLeaderException);
2038 @SuppressWarnings("unchecked")
2040 public void testRegisterForShardLeaderChanges() {
2041 LOG.info("testRegisterForShardLeaderChanges starting");
2043 final String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
2044 final String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
2045 final TestKit kit = new TestKit(getSystem());
2046 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
2048 shardManager.tell(new UpdateSchemaContext(TEST_SCHEMA_CONTEXT), kit.getRef());
2049 shardManager.tell(new ActorInitialized(), mockShardActor);
2051 final Consumer<String> mockCallback = mock(Consumer.class);
2052 shardManager.tell(new RegisterForShardAvailabilityChanges(mockCallback), kit.getRef());
2054 final Success reply = kit.expectMsgClass(Duration.ofSeconds(5), Success.class);
2055 final Registration reg = (Registration) reply.status();
2057 final DataTree mockDataTree = mock(DataTree.class);
2058 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId1, mockDataTree,
2059 DataStoreVersions.CURRENT_VERSION), mockShardActor);
2061 verify(mockCallback, timeout(5000)).accept("default");
2063 reset(mockCallback);
2064 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId1, mockDataTree,
2065 DataStoreVersions.CURRENT_VERSION), mockShardActor);
2067 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
2068 verifyNoMoreInteractions(mockCallback);
2070 shardManager.tell(new ShardLeaderStateChanged(memberId1, null, mockDataTree,
2071 DataStoreVersions.CURRENT_VERSION), mockShardActor);
2073 verify(mockCallback, timeout(5000)).accept("default");
2075 reset(mockCallback);
2076 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, mockDataTree,
2077 DataStoreVersions.CURRENT_VERSION), mockShardActor);
2079 verify(mockCallback, timeout(5000)).accept("default");
2081 reset(mockCallback);
2084 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId1, mockDataTree,
2085 DataStoreVersions.CURRENT_VERSION), mockShardActor);
2087 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
2088 verifyNoMoreInteractions(mockCallback);
2090 LOG.info("testRegisterForShardLeaderChanges ending");
2093 public static class TestShardManager extends ShardManager {
2094 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
2095 private final CountDownLatch snapshotPersist = new CountDownLatch(1);
2096 private ShardManagerSnapshot snapshot;
2097 private final Map<String, ActorRef> shardActors;
2098 private final ActorRef shardActor;
2099 private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
2100 private CountDownLatch memberUpReceived = new CountDownLatch(1);
2101 private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
2102 private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
2103 private CountDownLatch memberReachableReceived = new CountDownLatch(1);
2104 private volatile MessageInterceptor messageInterceptor;
2106 TestShardManager(final Builder builder) {
2108 shardActor = builder.shardActor;
2109 shardActors = builder.shardActors;
2113 protected void handleRecover(final Object message) throws Exception {
2115 super.handleRecover(message);
2117 if (message instanceof RecoveryCompleted) {
2118 recoveryComplete.countDown();
2123 private void countDownIfOther(final Member member, final CountDownLatch latch) {
2124 if (!getCluster().getCurrentMemberName().equals(memberToName(member))) {
2130 public void handleCommand(final Object message) throws Exception {
2132 if (messageInterceptor != null && messageInterceptor.canIntercept(message)) {
2133 getSender().tell(messageInterceptor.apply(message), getSelf());
2135 super.handleCommand(message);
2138 if (message instanceof FindPrimary) {
2139 findPrimaryMessageReceived.countDown();
2140 } else if (message instanceof ClusterEvent.MemberUp) {
2141 countDownIfOther(((ClusterEvent.MemberUp) message).member(), memberUpReceived);
2142 } else if (message instanceof ClusterEvent.MemberRemoved) {
2143 countDownIfOther(((ClusterEvent.MemberRemoved) message).member(), memberRemovedReceived);
2144 } else if (message instanceof ClusterEvent.UnreachableMember) {
2145 countDownIfOther(((ClusterEvent.UnreachableMember) message).member(), memberUnreachableReceived);
2146 } else if (message instanceof ClusterEvent.ReachableMember) {
2147 countDownIfOther(((ClusterEvent.ReachableMember) message).member(), memberReachableReceived);
2152 void setMessageInterceptor(final MessageInterceptor messageInterceptor) {
2153 this.messageInterceptor = messageInterceptor;
2156 void waitForRecoveryComplete() {
2157 assertTrue("Recovery complete",
2158 Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
2161 public void waitForMemberUp() {
2162 assertTrue("MemberUp received",
2163 Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
2164 memberUpReceived = new CountDownLatch(1);
2167 void waitForMemberRemoved() {
2168 assertTrue("MemberRemoved received",
2169 Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
2170 memberRemovedReceived = new CountDownLatch(1);
2173 void waitForUnreachableMember() {
2174 assertTrue("UnreachableMember received",
2175 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS));
2176 memberUnreachableReceived = new CountDownLatch(1);
2179 void waitForReachableMember() {
2180 assertTrue("ReachableMember received",
2181 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
2182 memberReachableReceived = new CountDownLatch(1);
2185 void verifyFindPrimary() {
2186 assertTrue("FindPrimary received",
2187 Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
2188 findPrimaryMessageReceived = new CountDownLatch(1);
2191 public static Builder builder(final DatastoreContext.Builder datastoreContextBuilder) {
2192 return new Builder(datastoreContextBuilder);
2195 public static class Builder extends AbstractGenericCreator<Builder, TestShardManager> {
2196 private ActorRef shardActor;
2197 private final Map<String, ActorRef> shardActors = new HashMap<>();
2199 Builder(final DatastoreContext.Builder datastoreContextBuilder) {
2200 super(TestShardManager.class);
2201 datastoreContextFactory(newDatastoreContextFactory(datastoreContextBuilder.build()));
2204 Builder shardActor(final ActorRef newShardActor) {
2205 this.shardActor = newShardActor;
2209 Builder addShardActor(final String shardName, final ActorRef actorRef) {
2210 shardActors.put(shardName, actorRef);
2216 public void saveSnapshot(final Object obj) {
2217 snapshot = (ShardManagerSnapshot) obj;
2218 snapshotPersist.countDown();
2219 super.saveSnapshot(obj);
2222 void verifySnapshotPersisted(final Set<String> shardList) {
2223 assertTrue("saveSnapshot invoked",
2224 Uninterruptibles.awaitUninterruptibly(snapshotPersist, 5, TimeUnit.SECONDS));
2225 assertEquals("Shard Persisted", shardList, Sets.newHashSet(snapshot.getShardList()));
2229 protected ActorRef newShardActor(final ShardInformation info) {
2230 if (shardActors.get(info.getShardName()) != null) {
2231 return shardActors.get(info.getShardName());
2234 if (shardActor != null) {
2238 return super.newShardActor(info);
2242 private abstract static class AbstractGenericCreator<T extends AbstractGenericCreator<T, ?>, C extends ShardManager>
2243 extends AbstractShardManagerCreator<T> {
2244 private final Class<C> shardManagerClass;
2246 AbstractGenericCreator(final Class<C> shardManagerClass) {
2247 this.shardManagerClass = shardManagerClass;
2248 cluster(new MockClusterWrapper()).configuration(new MockConfiguration()).readinessFuture(ready)
2249 .primaryShardInfoCache(new PrimaryShardInfoFutureCache());
2253 public Props props() {
2255 return Props.create(shardManagerClass, this);
2259 private static class GenericCreator<C extends ShardManager> extends AbstractGenericCreator<GenericCreator<C>, C> {
2260 GenericCreator(final Class<C> shardManagerClass) {
2261 super(shardManagerClass);
2265 private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
2266 private static final long serialVersionUID = 1L;
2267 private final Creator<ShardManager> delegate;
2269 DelegatingShardManagerCreator(final Creator<ShardManager> delegate) {
2270 this.delegate = delegate;
2274 public ShardManager create() throws Exception {
2275 return delegate.create();
2279 interface MessageInterceptor extends Function<Object, Object> {
2280 boolean canIntercept(Object message);
2283 private static MessageInterceptor newFindPrimaryInterceptor(final ActorRef primaryActor) {
2284 return new MessageInterceptor() {
2286 public Object apply(final Object message) {
2287 return new RemotePrimaryShardFound(Serialization.serializedActorPath(primaryActor), (short) 1);
2291 public boolean canIntercept(final Object message) {
2292 return message instanceof FindPrimary;
2297 private static class MockRespondActor extends MessageCollectorActor {
2298 static final String CLEAR_RESPONSE = "clear-response";
2300 private Object responseMsg;
2301 private final Class<?> requestClass;
2303 @SuppressWarnings("unused")
2304 MockRespondActor(final Class<?> requestClass, final Object responseMsg) {
2305 this.requestClass = requestClass;
2306 this.responseMsg = responseMsg;
2310 public void onReceive(final Object message) throws Exception {
2311 if (message.equals(CLEAR_RESPONSE)) {
2314 super.onReceive(message);
2315 if (message.getClass().equals(requestClass) && responseMsg != null) {
2316 getSender().tell(responseMsg, getSelf());