opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/shardmanager/ShardManagerTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.controller.cluster.datastore.shardmanager;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertSame;
  15 import static org.junit.Assert.assertTrue;
  16 import static org.junit.Assert.fail;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.never;
  19 import static org.mockito.Mockito.times;
  20 import static org.mockito.Mockito.verify;
  21
  22 import akka.actor.ActorRef;
  23 import akka.actor.ActorSystem;
  24 import akka.actor.AddressFromURIString;
  25 import akka.actor.Props;
  26 import akka.actor.Status;
  27 import akka.actor.Status.Failure;
  28 import akka.actor.Status.Success;
  29 import akka.cluster.Cluster;
  30 import akka.cluster.ClusterEvent;
  31 import akka.cluster.Member;
  32 import akka.dispatch.Dispatchers;
  33 import akka.dispatch.OnComplete;
  34 import akka.japi.Creator;
  35 import akka.pattern.Patterns;
  36 import akka.persistence.RecoveryCompleted;
  37 import akka.serialization.Serialization;
  38 import akka.testkit.JavaTestKit;
  39 import akka.testkit.TestActorRef;
  40 import akka.util.Timeout;
  41 import com.google.common.base.Function;
  42 import com.google.common.base.Stopwatch;
  43 import com.google.common.collect.ImmutableMap;
  44 import com.google.common.collect.Lists;
  45 import com.google.common.collect.Sets;
  46 import com.google.common.util.concurrent.Uninterruptibles;
  47 import java.net.URI;
  48 import java.util.AbstractMap;
  49 import java.util.Arrays;
  50 import java.util.Collection;
  51 import java.util.Collections;
  52 import java.util.HashMap;
  53 import java.util.List;
  54 import java.util.Map;
  55 import java.util.Map.Entry;
  56 import java.util.Set;
  57 import java.util.concurrent.CountDownLatch;
  58 import java.util.concurrent.TimeUnit;
  59 import java.util.concurrent.TimeoutException;
  60 import java.util.stream.Collectors;
  61 import org.junit.Test;
  62 import org.mockito.Mockito;
  63 import org.opendaylight.controller.cluster.access.concepts.MemberName;
  64 import org.opendaylight.controller.cluster.datastore.AbstractShardManagerTest;
  65 import org.opendaylight.controller.cluster.datastore.ClusterWrapperImpl;
  66 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  67 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  68 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
  69 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  70 import org.opendaylight.controller.cluster.datastore.Shard;
  71 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
  72 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
  73 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  74 import org.opendaylight.controller.cluster.datastore.exceptions.AlreadyExistsException;
  75 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  76 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
  77 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
  78 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  79 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
  80 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
  81 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  82 import org.opendaylight.controller.cluster.datastore.messages.ChangeShardMembersVotingStatus;
  83 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  84 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
  85 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
  86 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
  87 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
  88 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
  89 import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
  90 import org.opendaylight.controller.cluster.datastore.messages.PeerUp;
  91 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
  92 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
  93 import org.opendaylight.controller.cluster.datastore.messages.RemoveShardReplica;
  94 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
  95 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
  96 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot;
  97 import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot.ShardSnapshot;
  98 import org.opendaylight.controller.cluster.datastore.persisted.ShardManagerSnapshot;
  99 import org.opendaylight.controller.cluster.datastore.utils.ForwardingActor;
 100 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
 101 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
 102 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
 103 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
 104 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
 105 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
 106 import org.opendaylight.controller.cluster.raft.RaftState;
 107 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
 108 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
 109 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
 110 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
 111 import org.opendaylight.controller.cluster.raft.messages.AddServer;
 112 import org.opendaylight.controller.cluster.raft.messages.AddServerReply;
 113 import org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus;
 114 import org.opendaylight.controller.cluster.raft.messages.RemoveServer;
 115 import org.opendaylight.controller.cluster.raft.messages.RemoveServerReply;
 116 import org.opendaylight.controller.cluster.raft.messages.ServerChangeReply;
 117 import org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus;
 118 import org.opendaylight.controller.cluster.raft.messages.ServerRemoved;
 119 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
 120 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
 121 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
 122 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
 123 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 124 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 125 import org.slf4j.Logger;
 126 import org.slf4j.LoggerFactory;
 127 import scala.concurrent.Await;
 128 import scala.concurrent.Future;
 129 import scala.concurrent.duration.FiniteDuration;
 130
 131 public class ShardManagerTest extends AbstractShardManagerTest {
 132     private static final Logger LOG = LoggerFactory.getLogger(ShardManagerTest.class);
 133     private static final MemberName MEMBER_2 = MemberName.forName("member-2");
 134     private static final MemberName MEMBER_3 = MemberName.forName("member-3");
 135
 136     private final String shardMgrID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 137
 138     private ActorSystem newActorSystem(final String config) {
 139         return newActorSystem("cluster-test", config);
 140     }
 141
 142     private ActorRef newMockShardActor(final ActorSystem system, final String shardName, final String memberName) {
 143         String name = ShardIdentifier.create(shardName, MemberName.forName(memberName), "config").toString();
 144         if (system == getSystem()) {
 145             return actorFactory.createActor(MessageCollectorActor.props(), name);
 146         }
 147
 148         return system.actorOf(MessageCollectorActor.props(), name);
 149     }
 150
 151     private Props newShardMgrProps() {
 152         return newShardMgrProps(new MockConfiguration());
 153     }
 154
 155     private static DatastoreContextFactory newDatastoreContextFactory(final DatastoreContext datastoreContext) {
 156         DatastoreContextFactory mockFactory = mock(DatastoreContextFactory.class);
 157         Mockito.doReturn(datastoreContext).when(mockFactory).getBaseDatastoreContext();
 158         Mockito.doReturn(datastoreContext).when(mockFactory).getShardDatastoreContext(Mockito.anyString());
 159         return mockFactory;
 160     }
 161
 162     private TestShardManager.Builder newTestShardMgrBuilderWithMockShardActor() {
 163         return newTestShardMgrBuilderWithMockShardActor(mockShardActor);
 164     }
 165
 166     private TestShardManager.Builder newTestShardMgrBuilderWithMockShardActor(final ActorRef shardActor) {
 167         return TestShardManager.builder(datastoreContextBuilder).shardActor(shardActor)
 168                 .distributedDataStore(mock(DistributedDataStore.class));
 169     }
 170
 171
 172     private Props newPropsShardMgrWithMockShardActor() {
 173         return newTestShardMgrBuilderWithMockShardActor().props().withDispatcher(
 174                 Dispatchers.DefaultDispatcherId());
 175     }
 176
 177     private Props newPropsShardMgrWithMockShardActor(final ActorRef shardActor) {
 178         return newTestShardMgrBuilderWithMockShardActor(shardActor).props()
 179                 .withDispatcher(Dispatchers.DefaultDispatcherId());
 180     }
 181
 182
 183     private TestShardManager newTestShardManager() {
 184         return newTestShardManager(newShardMgrProps());
 185     }
 186
 187     private TestShardManager newTestShardManager(final Props props) {
 188         TestActorRef<TestShardManager> shardManagerActor = actorFactory.createTestActor(props);
 189         TestShardManager shardManager = shardManagerActor.underlyingActor();
 190         shardManager.waitForRecoveryComplete();
 191         return shardManager;
 192     }
 193
 194     private static void waitForShardInitialized(final ActorRef shardManager, final String shardName,
 195             final JavaTestKit kit) {
 196         AssertionError last = null;
 197         Stopwatch sw = Stopwatch.createStarted();
 198         while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
 199             try {
 200                 shardManager.tell(new FindLocalShard(shardName, true), kit.getRef());
 201                 kit.expectMsgClass(LocalShardFound.class);
 202                 return;
 203             } catch (AssertionError e) {
 204                 last = e;
 205             }
 206
 207             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 208         }
 209
 210         throw last;
 211     }
 212
 213     @SuppressWarnings("unchecked")
 214     private static <T> T expectMsgClassOrFailure(final Class<T> msgClass, final JavaTestKit kit, final String msg) {
 215         Object reply = kit.expectMsgAnyClassOf(JavaTestKit.duration("5 sec"), msgClass, Failure.class);
 216         if (reply instanceof Failure) {
 217             throw new AssertionError(msg + " failed", ((Failure)reply).cause());
 218         }
 219
 220         return (T)reply;
 221     }
 222
 223     @Test
 224     public void testPerShardDatastoreContext() throws Exception {
 225         LOG.info("testPerShardDatastoreContext starting");
 226         final DatastoreContextFactory mockFactory = newDatastoreContextFactory(
 227                 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
 228
 229         Mockito.doReturn(
 230                 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(6).build())
 231                 .when(mockFactory).getShardDatastoreContext("default");
 232
 233         Mockito.doReturn(
 234                 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(7).build())
 235                 .when(mockFactory).getShardDatastoreContext("topology");
 236
 237         final MockConfiguration mockConfig = new MockConfiguration() {
 238             @Override
 239             public Collection<String> getMemberShardNames(final MemberName memberName) {
 240                 return Arrays.asList("default", "topology");
 241             }
 242
 243             @Override
 244             public Collection<MemberName> getMembersFromShardName(final String shardName) {
 245                 return members("member-1");
 246             }
 247         };
 248
 249         final ActorRef defaultShardActor = actorFactory.createActor(
 250                 MessageCollectorActor.props(), actorFactory.generateActorId("default"));
 251         final ActorRef topologyShardActor = actorFactory.createActor(
 252                 MessageCollectorActor.props(), actorFactory.generateActorId("topology"));
 253
 254         final Map<String, Entry<ActorRef, DatastoreContext>> shardInfoMap = Collections.synchronizedMap(
 255                 new HashMap<String, Entry<ActorRef, DatastoreContext>>());
 256         shardInfoMap.put("default", new AbstractMap.SimpleEntry<>(defaultShardActor, null));
 257         shardInfoMap.put("topology", new AbstractMap.SimpleEntry<>(topologyShardActor, null));
 258
 259         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 260         final CountDownLatch newShardActorLatch = new CountDownLatch(2);
 261         class LocalShardManager extends ShardManager {
 262             LocalShardManager(final AbstractShardManagerCreator<?> creator) {
 263                 super(creator);
 264             }
 265
 266             @Override
 267             protected ActorRef newShardActor(final ShardInformation info) {
 268                 Entry<ActorRef, DatastoreContext> entry = shardInfoMap.get(info.getShardName());
 269                 ActorRef ref = null;
 270                 if (entry != null) {
 271                     ref = entry.getKey();
 272                     entry.setValue(info.getDatastoreContext());
 273                 }
 274
 275                 newShardActorLatch.countDown();
 276                 return ref;
 277             }
 278         }
 279
 280         final Creator<ShardManager> creator = new Creator<ShardManager>() {
 281             private static final long serialVersionUID = 1L;
 282             @Override
 283             public ShardManager create() throws Exception {
 284                 return new LocalShardManager(
 285                         new GenericCreator<>(LocalShardManager.class).datastoreContextFactory(mockFactory)
 286                                 .primaryShardInfoCache(primaryShardInfoCache).configuration(mockConfig));
 287             }
 288         };
 289
 290         JavaTestKit kit = new JavaTestKit(getSystem());
 291
 292         final ActorRef shardManager = actorFactory.createActor(Props.create(
 293                 new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()));
 294
 295         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), kit.getRef());
 296
 297         assertEquals("Shard actors created", true, newShardActorLatch.await(5, TimeUnit.SECONDS));
 298         assertEquals("getShardElectionTimeoutFactor", 6,
 299                 shardInfoMap.get("default").getValue().getShardElectionTimeoutFactor());
 300         assertEquals("getShardElectionTimeoutFactor", 7,
 301                 shardInfoMap.get("topology").getValue().getShardElectionTimeoutFactor());
 302
 303         DatastoreContextFactory newMockFactory = newDatastoreContextFactory(
 304                 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
 305         Mockito.doReturn(
 306                 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(66).build())
 307                 .when(newMockFactory).getShardDatastoreContext("default");
 308
 309         Mockito.doReturn(
 310                 DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).shardElectionTimeoutFactor(77).build())
 311                 .when(newMockFactory).getShardDatastoreContext("topology");
 312
 313         shardManager.tell(newMockFactory, kit.getRef());
 314
 315         DatastoreContext newContext = MessageCollectorActor.expectFirstMatching(defaultShardActor,
 316                 DatastoreContext.class);
 317         assertEquals("getShardElectionTimeoutFactor", 66, newContext.getShardElectionTimeoutFactor());
 318
 319         newContext = MessageCollectorActor.expectFirstMatching(topologyShardActor, DatastoreContext.class);
 320         assertEquals("getShardElectionTimeoutFactor", 77, newContext.getShardElectionTimeoutFactor());
 321
 322         LOG.info("testPerShardDatastoreContext ending");
 323     }
 324
 325     @Test
 326     public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
 327         new JavaTestKit(getSystem()) {
 328             {
 329                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 330
 331                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 332
 333                 shardManager.tell(new FindPrimary("non-existent", false), getRef());
 334
 335                 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 336             }
 337         };
 338     }
 339
 340     @Test
 341     public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
 342         LOG.info("testOnReceiveFindPrimaryForLocalLeaderShard starting");
 343         new JavaTestKit(getSystem()) {
 344             {
 345                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 346
 347                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 348
 349                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 350                 shardManager.tell(new ActorInitialized(), mockShardActor);
 351
 352                 DataTree mockDataTree = mock(DataTree.class);
 353                 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mockDataTree,
 354                         DataStoreVersions.CURRENT_VERSION), getRef());
 355
 356                 MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
 357                 shardManager.tell(
 358                         new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
 359                         mockShardActor);
 360
 361                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 362
 363                 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"),
 364                         LocalPrimaryShardFound.class);
 365                 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
 366                         primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 367                 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 368             }
 369         };
 370
 371         LOG.info("testOnReceiveFindPrimaryForLocalLeaderShard ending");
 372     }
 373
 374     @Test
 375     public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
 376         LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp starting");
 377         new JavaTestKit(getSystem()) {
 378             {
 379                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 380
 381                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 382                 shardManager.tell(new ActorInitialized(), mockShardActor);
 383
 384                 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 385                 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 386                 shardManager.tell(
 387                         new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
 388                         mockShardActor);
 389                 shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION),
 390                         mockShardActor);
 391
 392                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 393
 394                 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 395             }
 396         };
 397
 398         LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp ending");
 399     }
 400
 401     @Test
 402     public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
 403         LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShard starting");
 404         new JavaTestKit(getSystem()) {
 405             {
 406                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 407
 408                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 409                 shardManager.tell(new ActorInitialized(), mockShardActor);
 410
 411                 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 412                 MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
 413
 414                 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 415                 shardManager.tell(
 416                         new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
 417                         mockShardActor);
 418                 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 419                 shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, leaderVersion), mockShardActor);
 420
 421                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 422
 423                 RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"),
 424                         RemotePrimaryShardFound.class);
 425                 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
 426                         primaryFound.getPrimaryPath().contains("member-2-shard-default"));
 427                 assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
 428             }
 429         };
 430
 431         LOG.info("testOnReceiveFindPrimaryForNonLocalLeaderShard ending");
 432     }
 433
 434     @Test
 435     public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
 436         new JavaTestKit(getSystem()) {
 437             {
 438                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 439
 440                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 441
 442                 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 443             }
 444         };
 445     }
 446
 447     @Test
 448     public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
 449         new JavaTestKit(getSystem()) {
 450             {
 451                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 452
 453                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 454                 shardManager.tell(new ActorInitialized(), mockShardActor);
 455
 456                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 457
 458                 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 459             }
 460         };
 461     }
 462
 463     @Test
 464     public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
 465         LOG.info("testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId starting");
 466         new JavaTestKit(getSystem()) {
 467             {
 468                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 469
 470                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 471                 shardManager.tell(new ActorInitialized(), mockShardActor);
 472
 473                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 474                 shardManager.tell(
 475                         new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Follower.name()),
 476                         mockShardActor);
 477
 478                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 479
 480                 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 481
 482                 DataTree mockDataTree = mock(DataTree.class);
 483                 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mockDataTree,
 484                         DataStoreVersions.CURRENT_VERSION), mockShardActor);
 485
 486                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 487
 488                 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"),
 489                         LocalPrimaryShardFound.class);
 490                 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
 491                         primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 492                 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 493             }
 494         };
 495
 496         LOG.info("testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId starting");
 497     }
 498
 499     @Test
 500     public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
 501         LOG.info("testOnReceiveFindPrimaryWaitForShardLeader starting");
 502         datastoreContextBuilder.shardInitializationTimeout(10, TimeUnit.SECONDS);
 503         new JavaTestKit(getSystem()) {
 504             {
 505                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 506
 507                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 508
 509                 // We're passing waitUntilInitialized = true to FindPrimary so
 510                 // the response should be
 511                 // delayed until we send ActorInitialized and
 512                 // RoleChangeNotification.
 513                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 514
 515                 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 516
 517                 shardManager.tell(new ActorInitialized(), mockShardActor);
 518
 519                 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 520
 521                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 522                 shardManager.tell(
 523                         new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
 524                         mockShardActor);
 525
 526                 expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 527
 528                 DataTree mockDataTree = mock(DataTree.class);
 529                 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mockDataTree,
 530                         DataStoreVersions.CURRENT_VERSION), mockShardActor);
 531
 532                 LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"),
 533                         LocalPrimaryShardFound.class);
 534                 assertTrue("Unexpected primary path " + primaryFound.getPrimaryPath(),
 535                         primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 536                 assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 537
 538                 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 539             }
 540         };
 541
 542         LOG.info("testOnReceiveFindPrimaryWaitForShardLeader ending");
 543     }
 544
 545     @Test
 546     public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
 547         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard starting");
 548         new JavaTestKit(getSystem()) {
 549             {
 550                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 551
 552                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 553
 554                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 555
 556                 expectMsgClass(duration("2 seconds"), NotInitializedException.class);
 557
 558                 shardManager.tell(new ActorInitialized(), mockShardActor);
 559
 560                 expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 561             }
 562         };
 563
 564         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard ending");
 565     }
 566
 567     @Test
 568     public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
 569         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithCandidateShard starting");
 570         new JavaTestKit(getSystem()) {
 571             {
 572                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 573
 574                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 575                 shardManager.tell(new ActorInitialized(), mockShardActor);
 576                 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix, null,
 577                         RaftState.Candidate.name()), mockShardActor);
 578
 579                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 580
 581                 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 582             }
 583         };
 584
 585         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithCandidateShard ending");
 586     }
 587
 588     @Test
 589     public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
 590         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard starting");
 591         new JavaTestKit(getSystem()) {
 592             {
 593                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 594
 595                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 596                 shardManager.tell(new ActorInitialized(), mockShardActor);
 597                 shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix, null,
 598                         RaftState.IsolatedLeader.name()), mockShardActor);
 599
 600                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 601
 602                 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 603             }
 604         };
 605
 606         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard ending");
 607     }
 608
 609     @Test
 610     public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
 611         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard starting");
 612         new JavaTestKit(getSystem()) {
 613             {
 614                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 615
 616                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 617                 shardManager.tell(new ActorInitialized(), mockShardActor);
 618
 619                 shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 620
 621                 expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 622             }
 623         };
 624
 625         LOG.info("testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard ending");
 626     }
 627
 628     @Test
 629     public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
 630         LOG.info("testOnReceiveFindPrimaryForRemoteShard starting");
 631         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 632
 633         // Create an ActorSystem ShardManager actor for member-1.
 634
 635         final ActorSystem system1 = newActorSystem("Member1");
 636         Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 637
 638         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 639                 newTestShardMgrBuilderWithMockShardActor().cluster(
 640                         new ClusterWrapperImpl(system1)).props().withDispatcher(
 641                                 Dispatchers.DefaultDispatcherId()), shardManagerID);
 642
 643         // Create an ActorSystem ShardManager actor for member-2.
 644
 645         final ActorSystem system2 = newActorSystem("Member2");
 646
 647         Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 648
 649         final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
 650
 651         MockConfiguration mockConfig2 = new MockConfiguration(
 652                 ImmutableMap.<String, List<String>>builder().put("default", Arrays.asList("member-1", "member-2"))
 653                         .put("astronauts", Arrays.asList("member-2")).build());
 654
 655         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 656                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 657                         new ClusterWrapperImpl(system2)).props().withDispatcher(
 658                                 Dispatchers.DefaultDispatcherId()), shardManagerID);
 659
 660         new JavaTestKit(system1) {
 661             {
 662                 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 663                 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 664
 665                 shardManager2.tell(new ActorInitialized(), mockShardActor2);
 666
 667                 String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
 668                 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 669                 shardManager2.tell(
 670                         new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class), leaderVersion),
 671                         mockShardActor2);
 672                 shardManager2.tell(
 673                         new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
 674                         mockShardActor2);
 675
 676                 shardManager1.underlyingActor().waitForMemberUp();
 677                 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 678
 679                 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 680                 String path = found.getPrimaryPath();
 681                 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
 682                 assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
 683
 684                 shardManager2.underlyingActor().verifyFindPrimary();
 685
 686                 Cluster.get(system2).down(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 687
 688                 shardManager1.underlyingActor().waitForMemberRemoved();
 689
 690                 shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 691
 692                 expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 693             }
 694         };
 695
 696         LOG.info("testOnReceiveFindPrimaryForRemoteShard ending");
 697     }
 698
 699     @Test
 700     public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
 701         LOG.info("testShardAvailabilityOnChangeOfMemberReachability starting");
 702         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 703
 704         // Create an ActorSystem ShardManager actor for member-1.
 705
 706         final ActorSystem system1 = newActorSystem("Member1");
 707         Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 708
 709         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 710
 711         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 712                 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(
 713                         new ClusterWrapperImpl(system1)).props().withDispatcher(
 714                                 Dispatchers.DefaultDispatcherId()), shardManagerID);
 715
 716         // Create an ActorSystem ShardManager actor for member-2.
 717
 718         final ActorSystem system2 = newActorSystem("Member2");
 719
 720         Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 721
 722         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 723
 724         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
 725                 .put("default", Arrays.asList("member-1", "member-2")).build());
 726
 727         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 728                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 729                         new ClusterWrapperImpl(system2)).props().withDispatcher(
 730                                 Dispatchers.DefaultDispatcherId()), shardManagerID);
 731
 732         new JavaTestKit(system1) {
 733             {
 734                 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 735                 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 736                 shardManager1.tell(new ActorInitialized(), mockShardActor1);
 737                 shardManager2.tell(new ActorInitialized(), mockShardActor2);
 738
 739                 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 740                 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 741                 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2, mock(DataTree.class),
 742                         DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 743                 shardManager1.tell(
 744                         new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
 745                         mockShardActor1);
 746                 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class),
 747                         DataStoreVersions.CURRENT_VERSION), mockShardActor2);
 748                 shardManager2.tell(
 749                         new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
 750                         mockShardActor2);
 751                 shardManager1.underlyingActor().waitForMemberUp();
 752
 753                 shardManager1.tell(new FindPrimary("default", true), getRef());
 754
 755                 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 756                 String path = found.getPrimaryPath();
 757                 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 758
 759                 shardManager1.tell(MockClusterWrapper.createUnreachableMember("member-2",
 760                         "akka://cluster-test@127.0.0.1:2558"), getRef());
 761
 762                 shardManager1.underlyingActor().waitForUnreachableMember();
 763
 764                 PeerDown peerDown = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 765                 assertEquals("getMemberName", MEMBER_2, peerDown.getMemberName());
 766                 MessageCollectorActor.clearMessages(mockShardActor1);
 767
 768                 shardManager1.tell(
 769                         MockClusterWrapper.createMemberRemoved("member-2", "akka://cluster-test@127.0.0.1:2558"),
 770                         getRef());
 771
 772                 MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 773
 774                 shardManager1.tell(new FindPrimary("default", true), getRef());
 775
 776                 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 777
 778                 shardManager1.tell(
 779                         MockClusterWrapper.createReachableMember("member-2", "akka://cluster-test@127.0.0.1:2558"),
 780                         getRef());
 781
 782                 shardManager1.underlyingActor().waitForReachableMember();
 783
 784                 PeerUp peerUp = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 785                 assertEquals("getMemberName", MEMBER_2, peerUp.getMemberName());
 786                 MessageCollectorActor.clearMessages(mockShardActor1);
 787
 788                 shardManager1.tell(new FindPrimary("default", true), getRef());
 789
 790                 RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 791                 String path1 = found1.getPrimaryPath();
 792                 assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
 793
 794                 shardManager1.tell(
 795                         MockClusterWrapper.createMemberUp("member-2", "akka://cluster-test@127.0.0.1:2558"),
 796                         getRef());
 797
 798                 MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 799
 800                 // Test FindPrimary wait succeeds after reachable member event.
 801
 802                 shardManager1.tell(MockClusterWrapper.createUnreachableMember("member-2",
 803                         "akka://cluster-test@127.0.0.1:2558"), getRef());
 804                 shardManager1.underlyingActor().waitForUnreachableMember();
 805
 806                 shardManager1.tell(new FindPrimary("default", true), getRef());
 807
 808                 shardManager1.tell(
 809                         MockClusterWrapper.createReachableMember("member-2", "akka://cluster-test@127.0.0.1:2558"),
 810                         getRef());
 811
 812                 RemotePrimaryShardFound found2 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 813                 String path2 = found2.getPrimaryPath();
 814                 assertTrue("Unexpected primary path " + path2, path2.contains("member-2-shard-default-config"));
 815             }
 816         };
 817
 818         LOG.info("testShardAvailabilityOnChangeOfMemberReachability ending");
 819     }
 820
 821     @Test
 822     public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
 823         LOG.info("testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange starting");
 824         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 825
 826         // Create an ActorSystem ShardManager actor for member-1.
 827
 828         final ActorSystem system1 = newActorSystem("Member1");
 829         Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 830
 831         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 832
 833         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 834         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 835                 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(new ClusterWrapperImpl(system1))
 836                         .primaryShardInfoCache(primaryShardInfoCache).props()
 837                         .withDispatcher(Dispatchers.DefaultDispatcherId()),
 838                 shardManagerID);
 839
 840         // Create an ActorSystem ShardManager actor for member-2.
 841
 842         final ActorSystem system2 = newActorSystem("Member2");
 843
 844         Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
 845
 846         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 847
 848         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
 849                 .put("default", Arrays.asList("member-1", "member-2")).build());
 850
 851         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 852                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 853                         new ClusterWrapperImpl(system2)).props().withDispatcher(
 854                                 Dispatchers.DefaultDispatcherId()), shardManagerID);
 855
 856         new JavaTestKit(system1) {
 857             {
 858                 shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 859                 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 860                 shardManager1.tell(new ActorInitialized(), mockShardActor1);
 861                 shardManager2.tell(new ActorInitialized(), mockShardActor2);
 862
 863                 String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 864                 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 865                 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2, mock(DataTree.class),
 866                         DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 867                 shardManager1.tell(
 868                         new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
 869                         mockShardActor1);
 870                 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class),
 871                         DataStoreVersions.CURRENT_VERSION), mockShardActor2);
 872                 shardManager2.tell(
 873                         new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
 874                         mockShardActor2);
 875                 shardManager1.underlyingActor().waitForMemberUp();
 876
 877                 shardManager1.tell(new FindPrimary("default", true), getRef());
 878
 879                 RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 880                 String path = found.getPrimaryPath();
 881                 assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 882
 883                 primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(
 884                         system1.actorSelection(mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION));
 885
 886                 shardManager1.tell(MockClusterWrapper.createUnreachableMember("member-2",
 887                         "akka://cluster-test@127.0.0.1:2558"), getRef());
 888
 889                 shardManager1.underlyingActor().waitForUnreachableMember();
 890
 891                 shardManager1.tell(new FindPrimary("default", true), getRef());
 892
 893                 expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 894
 895                 assertNull("Expected primaryShardInfoCache entry removed",
 896                         primaryShardInfoCache.getIfPresent("default"));
 897
 898                 shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, mock(DataTree.class),
 899                         DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 900                 shardManager1.tell(
 901                         new RoleChangeNotification(memberId1, RaftState.Follower.name(), RaftState.Leader.name()),
 902                         mockShardActor1);
 903
 904                 shardManager1.tell(new FindPrimary("default", true), getRef());
 905
 906                 LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 907                 String path1 = found1.getPrimaryPath();
 908                 assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
 909
 910             }
 911         };
 912
 913         LOG.info("testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange ending");
 914     }
 915
 916     @Test
 917     public void testShardAvailabilityChangeOnMemberWithNameContainedInLeaderIdUnreachable() throws Exception {
 918         LOG.info("testShardAvailabilityChangeOnMemberWithNameContainedInLeaderIdUnreachable starting");
 919         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 920
 921         MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
 922                 .put("default", Arrays.asList("member-256", "member-2")).build());
 923
 924         // Create an ActorSystem, ShardManager and actor for member-256.
 925
 926         final ActorSystem system256 = newActorSystem("Member256");
 927         // 2562 is the tcp port of Member256 in src/test/resources/application.conf.
 928         Cluster.get(system256).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2562"));
 929
 930         final ActorRef mockShardActor256 = newMockShardActor(system256, Shard.DEFAULT_NAME, "member-256");
 931
 932         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 933
 934         // ShardManager must be created with shard configuration to let its localShards has shards.
 935         final TestActorRef<TestShardManager> shardManager256 = TestActorRef.create(system256,
 936                 newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor256)
 937                         .cluster(new ClusterWrapperImpl(system256))
 938                         .primaryShardInfoCache(primaryShardInfoCache).props()
 939                         .withDispatcher(Dispatchers.DefaultDispatcherId()),
 940                 shardManagerID);
 941
 942         // Create an ActorSystem, ShardManager and actor for member-2 whose name is contained in member-256.
 943
 944         final ActorSystem system2 = newActorSystem("Member2");
 945
 946         // Join member-2 into the cluster of member-256.
 947         Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2562"));
 948
 949         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 950
 951         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 952                 newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor2).cluster(
 953                         new ClusterWrapperImpl(system2)).props().withDispatcher(
 954                                 Dispatchers.DefaultDispatcherId()), shardManagerID);
 955
 956         new JavaTestKit(system256) {
 957             {
 958                 shardManager256.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 959                 shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 960                 shardManager256.tell(new ActorInitialized(), mockShardActor256);
 961                 shardManager2.tell(new ActorInitialized(), mockShardActor2);
 962
 963                 String memberId256 = "member-256-shard-default-" + shardMrgIDSuffix;
 964                 String memberId2   = "member-2-shard-default-"   + shardMrgIDSuffix;
 965                 shardManager256.tell(new ShardLeaderStateChanged(memberId256, memberId256, mock(DataTree.class),
 966                         DataStoreVersions.CURRENT_VERSION), mockShardActor256);
 967                 shardManager256.tell(
 968                         new RoleChangeNotification(memberId256, RaftState.Candidate.name(), RaftState.Leader.name()),
 969                         mockShardActor256);
 970                 shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId256, mock(DataTree.class),
 971                         DataStoreVersions.CURRENT_VERSION), mockShardActor2);
 972                 shardManager2.tell(
 973                         new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Follower.name()),
 974                         mockShardActor2);
 975                 shardManager256.underlyingActor().waitForMemberUp();
 976
 977                 shardManager256.tell(new FindPrimary("default", true), getRef());
 978
 979                 LocalPrimaryShardFound found = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 980                 String path = found.getPrimaryPath();
 981                 assertTrue("Unexpected primary path " + path + " which must on member-256",
 982                             path.contains("member-256-shard-default-config"));
 983
 984                 PrimaryShardInfo primaryShardInfo = new PrimaryShardInfo(
 985                         system256.actorSelection(mockShardActor256.path()), DataStoreVersions.CURRENT_VERSION);
 986                 primaryShardInfoCache.putSuccessful("default", primaryShardInfo);
 987
 988                 // Simulate member-2 become unreachable.
 989                 shardManager256.tell(MockClusterWrapper.createUnreachableMember("member-2",
 990                         "akka://cluster-test@127.0.0.1:2558"), getRef());
 991                 shardManager256.underlyingActor().waitForUnreachableMember();
 992
 993                 // Make sure leader shard on member-256 is still leader and still in the cache.
 994                 shardManager256.tell(new FindPrimary("default", true), getRef());
 995                 found = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 996                 path = found.getPrimaryPath();
 997                 assertTrue("Unexpected primary path " + path + " which must still not on member-256",
 998                             path.contains("member-256-shard-default-config"));
 999                 Future<PrimaryShardInfo> futurePrimaryShard = primaryShardInfoCache.getIfPresent("default");
1000                 futurePrimaryShard.onComplete(new OnComplete<PrimaryShardInfo>() {
1001                     @Override
1002                     public void onComplete(final Throwable failure, final PrimaryShardInfo futurePrimaryShardInfo) {
1003                         if (failure != null) {
1004                             assertTrue("Primary shard info is unexpectedly removed from primaryShardInfoCache", false);
1005                         } else {
1006                             assertEquals("Expected primaryShardInfoCache entry",
1007                                         primaryShardInfo, futurePrimaryShardInfo);
1008                         }
1009                     }
1010                 }, system256.dispatchers().defaultGlobalDispatcher());
1011             }
1012         };
1013
1014         LOG.info("testShardAvailabilityChangeOnMemberWithNameContainedInLeaderIdUnreachable ending");
1015     }
1016
1017     @Test
1018     public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
1019         new JavaTestKit(getSystem()) {
1020             {
1021                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1022
1023                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1024
1025                 shardManager.tell(new FindLocalShard("non-existent", false), getRef());
1026
1027                 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
1028
1029                 assertEquals("getShardName", "non-existent", notFound.getShardName());
1030             }
1031         };
1032     }
1033
1034     @Test
1035     public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
1036         new JavaTestKit(getSystem()) {
1037             {
1038                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1039
1040                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1041                 shardManager.tell(new ActorInitialized(), mockShardActor);
1042
1043                 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1044
1045                 LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1046
1047                 assertTrue("Found path contains " + found.getPath().path().toString(),
1048                         found.getPath().path().toString().contains("member-1-shard-default-config"));
1049             }
1050         };
1051     }
1052
1053     @Test
1054     public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
1055         new JavaTestKit(getSystem()) {
1056             {
1057                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1058
1059                 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1060
1061                 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1062             }
1063         };
1064     }
1065
1066     @Test
1067     public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
1068         LOG.info("testOnReceiveFindLocalShardWaitForShardInitialized starting");
1069         new JavaTestKit(getSystem()) {
1070             {
1071                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1072
1073                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1074
1075                 // We're passing waitUntilInitialized = true to FindLocalShard
1076                 // so the response should be
1077                 // delayed until we send ActorInitialized.
1078                 Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
1079                         new Timeout(5, TimeUnit.SECONDS));
1080
1081                 shardManager.tell(new ActorInitialized(), mockShardActor);
1082
1083                 Object resp = Await.result(future, duration("5 seconds"));
1084                 assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
1085             }
1086         };
1087
1088         LOG.info("testOnReceiveFindLocalShardWaitForShardInitialized starting");
1089     }
1090
1091     @Test
1092     public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
1093         TestShardManager shardManager = newTestShardManager();
1094
1095         String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1096         shardManager.onReceiveCommand(new RoleChangeNotification(
1097                 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
1098
1099         verify(ready, never()).countDown();
1100
1101         shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
1102                 mock(DataTree.class), DataStoreVersions.CURRENT_VERSION));
1103
1104         verify(ready, times(1)).countDown();
1105     }
1106
1107     @Test
1108     public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
1109         new JavaTestKit(getSystem()) {
1110             {
1111                 TestShardManager shardManager = newTestShardManager();
1112
1113                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1114                 shardManager.onReceiveCommand(new RoleChangeNotification(memberId, null, RaftState.Follower.name()));
1115
1116                 verify(ready, never()).countDown();
1117
1118                 shardManager
1119                         .onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
1120
1121                 shardManager.onReceiveCommand(
1122                         new ShardLeaderStateChanged(memberId, "member-2-shard-default-" + shardMrgIDSuffix,
1123                                 mock(DataTree.class), DataStoreVersions.CURRENT_VERSION));
1124
1125                 verify(ready, times(1)).countDown();
1126             }
1127         };
1128     }
1129
1130     @Test
1131     public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
1132         new JavaTestKit(getSystem()) {
1133             {
1134                 TestShardManager shardManager = newTestShardManager();
1135
1136                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1137                 shardManager.onReceiveCommand(new RoleChangeNotification(memberId, null, RaftState.Follower.name()));
1138
1139                 verify(ready, never()).countDown();
1140
1141                 shardManager.onReceiveCommand(
1142                         new ShardLeaderStateChanged(memberId, "member-2-shard-default-" + shardMrgIDSuffix,
1143                                 mock(DataTree.class), DataStoreVersions.CURRENT_VERSION));
1144
1145                 shardManager
1146                         .onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
1147
1148                 verify(ready, times(1)).countDown();
1149             }
1150         };
1151     }
1152
1153     @Test
1154     public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
1155         TestShardManager shardManager = newTestShardManager();
1156
1157         shardManager.onReceiveCommand(new RoleChangeNotification(
1158                 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
1159
1160         verify(ready, never()).countDown();
1161     }
1162
1163     @Test
1164     public void testByDefaultSyncStatusIsFalse() throws Exception {
1165         TestShardManager shardManager = newTestShardManager();
1166
1167         assertEquals(false, shardManager.getMBean().getSyncStatus());
1168     }
1169
1170     @Test
1171     public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception {
1172         TestShardManager shardManager = newTestShardManager();
1173
1174         shardManager.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
1175                 RaftState.Follower.name(), RaftState.Leader.name()));
1176
1177         assertEquals(true, shardManager.getMBean().getSyncStatus());
1178     }
1179
1180     @Test
1181     public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception {
1182         TestShardManager shardManager = newTestShardManager();
1183
1184         String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
1185         shardManager.onReceiveCommand(new RoleChangeNotification(shardId,
1186                 RaftState.Follower.name(), RaftState.Candidate.name()));
1187
1188         assertEquals(false, shardManager.getMBean().getSyncStatus());
1189
1190         // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
1191         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(
1192                 true, shardId));
1193
1194         assertEquals(false, shardManager.getMBean().getSyncStatus());
1195     }
1196
1197     @Test
1198     public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception {
1199         TestShardManager shardManager = newTestShardManager();
1200
1201         String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
1202         shardManager.onReceiveCommand(new RoleChangeNotification(shardId,
1203                 RaftState.Candidate.name(), RaftState.Follower.name()));
1204
1205         // Initially will be false
1206         assertEquals(false, shardManager.getMBean().getSyncStatus());
1207
1208         // Send status true will make sync status true
1209         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(true, shardId));
1210
1211         assertEquals(true, shardManager.getMBean().getSyncStatus());
1212
1213         // Send status false will make sync status false
1214         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(false, shardId));
1215
1216         assertEquals(false, shardManager.getMBean().getSyncStatus());
1217
1218     }
1219
1220     @Test
1221     public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception {
1222         LOG.info("testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards starting");
1223         TestShardManager shardManager = newTestShardManager(newShardMgrProps(new MockConfiguration() {
1224             @Override
1225             public List<String> getMemberShardNames(final MemberName memberName) {
1226                 return Arrays.asList("default", "astronauts");
1227             }
1228         }));
1229
1230         // Initially will be false
1231         assertEquals(false, shardManager.getMBean().getSyncStatus());
1232
1233         // Make default shard leader
1234         String defaultShardId = "member-1-shard-default-" + shardMrgIDSuffix;
1235         shardManager.onReceiveCommand(new RoleChangeNotification(defaultShardId,
1236                 RaftState.Follower.name(), RaftState.Leader.name()));
1237
1238         // default = Leader, astronauts is unknown so sync status remains false
1239         assertEquals(false, shardManager.getMBean().getSyncStatus());
1240
1241         // Make astronauts shard leader as well
1242         String astronautsShardId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1243         shardManager.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1244                 RaftState.Follower.name(), RaftState.Leader.name()));
1245
1246         // Now sync status should be true
1247         assertEquals(true, shardManager.getMBean().getSyncStatus());
1248
1249         // Make astronauts a Follower
1250         shardManager.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1251                 RaftState.Leader.name(), RaftState.Follower.name()));
1252
1253         // Sync status is not true
1254         assertEquals(false, shardManager.getMBean().getSyncStatus());
1255
1256         // Make the astronauts follower sync status true
1257         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(true, astronautsShardId));
1258
1259         // Sync status is now true
1260         assertEquals(true, shardManager.getMBean().getSyncStatus());
1261
1262         LOG.info("testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards ending");
1263     }
1264
1265     @Test
1266     public void testOnReceiveSwitchShardBehavior() throws Exception {
1267         new JavaTestKit(getSystem()) {
1268             {
1269                 final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1270
1271                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1272                 shardManager.tell(new ActorInitialized(), mockShardActor);
1273
1274                 shardManager.tell(new SwitchShardBehavior(mockShardName, RaftState.Leader, 1000), getRef());
1275
1276                 SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor,
1277                         SwitchBehavior.class);
1278
1279                 assertEquals(RaftState.Leader, switchBehavior.getNewState());
1280                 assertEquals(1000, switchBehavior.getNewTerm());
1281             }
1282         };
1283     }
1284
1285     private static List<MemberName> members(final String... names) {
1286         return Arrays.asList(names).stream().map(MemberName::forName).collect(Collectors.toList());
1287     }
1288
1289     @Test
1290     public void testOnCreateShard() {
1291         LOG.info("testOnCreateShard starting");
1292         new JavaTestKit(getSystem()) {
1293             {
1294                 datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1295
1296                 ActorRef shardManager = actorFactory
1297                         .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1298                                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1299
1300                 SchemaContext schemaContext = TestModel.createTestContext();
1301                 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1302
1303                 DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100)
1304                         .persistent(false).build();
1305                 Shard.Builder shardBuilder = Shard.builder();
1306
1307                 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1308                         "foo", null, members("member-1", "member-5", "member-6"));
1309                 shardManager.tell(new CreateShard(config, shardBuilder, datastoreContext), getRef());
1310
1311                 expectMsgClass(duration("5 seconds"), Success.class);
1312
1313                 shardManager.tell(new FindLocalShard("foo", true), getRef());
1314
1315                 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1316
1317                 assertEquals("isRecoveryApplicable", false, shardBuilder.getDatastoreContext().isPersistent());
1318                 assertTrue("Epxected ShardPeerAddressResolver", shardBuilder.getDatastoreContext().getShardRaftConfig()
1319                         .getPeerAddressResolver() instanceof ShardPeerAddressResolver);
1320                 assertEquals("peerMembers", Sets.newHashSet(
1321                         ShardIdentifier.create("foo", MemberName.forName("member-5"), shardMrgIDSuffix).toString(),
1322                         ShardIdentifier.create("foo", MemberName.forName("member-6"), shardMrgIDSuffix).toString()),
1323                         shardBuilder.getPeerAddresses().keySet());
1324                 assertEquals("ShardIdentifier", ShardIdentifier.create("foo", MEMBER_1, shardMrgIDSuffix),
1325                         shardBuilder.getId());
1326                 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1327
1328                 // Send CreateShard with same name - should return Success with
1329                 // a message.
1330
1331                 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1332
1333                 Success success = expectMsgClass(duration("5 seconds"), Success.class);
1334                 assertNotNull("Success status is null", success.status());
1335             }
1336         };
1337
1338         LOG.info("testOnCreateShard ending");
1339     }
1340
1341     @Test
1342     public void testOnCreateShardWithLocalMemberNotInShardConfig() {
1343         LOG.info("testOnCreateShardWithLocalMemberNotInShardConfig starting");
1344         new JavaTestKit(getSystem()) {
1345             {
1346                 datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1347
1348                 ActorRef shardManager = actorFactory
1349                         .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1350                                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1351
1352                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1353
1354                 Shard.Builder shardBuilder = Shard.builder();
1355                 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1356                         "foo", null, members("member-5", "member-6"));
1357
1358                 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1359                 expectMsgClass(duration("5 seconds"), Success.class);
1360
1361                 shardManager.tell(new FindLocalShard("foo", true), getRef());
1362                 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1363
1364                 assertEquals("peerMembers size", 0, shardBuilder.getPeerAddresses().size());
1365                 assertEquals("schemaContext", DisableElectionsRaftPolicy.class.getName(), shardBuilder
1366                         .getDatastoreContext().getShardRaftConfig().getCustomRaftPolicyImplementationClass());
1367             }
1368         };
1369
1370         LOG.info("testOnCreateShardWithLocalMemberNotInShardConfig ending");
1371     }
1372
1373     @Test
1374     public void testOnCreateShardWithNoInitialSchemaContext() {
1375         LOG.info("testOnCreateShardWithNoInitialSchemaContext starting");
1376         new JavaTestKit(getSystem()) {
1377             {
1378                 ActorRef shardManager = actorFactory
1379                         .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1380                                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1381
1382                 Shard.Builder shardBuilder = Shard.builder();
1383
1384                 ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1385                         "foo", null, members("member-1"));
1386                 shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1387
1388                 expectMsgClass(duration("5 seconds"), Success.class);
1389
1390                 SchemaContext schemaContext = TestModel.createTestContext();
1391                 shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1392
1393                 shardManager.tell(new FindLocalShard("foo", true), getRef());
1394
1395                 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1396
1397                 assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1398                 assertNotNull("schemaContext is null", shardBuilder.getDatastoreContext());
1399             }
1400         };
1401
1402         LOG.info("testOnCreateShardWithNoInitialSchemaContext ending");
1403     }
1404
1405     @Test
1406     public void testGetSnapshot() throws Exception {
1407         LOG.info("testGetSnapshot starting");
1408         JavaTestKit kit = new JavaTestKit(getSystem());
1409
1410         MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1411                 .put("shard1", Arrays.asList("member-1")).put("shard2", Arrays.asList("member-1"))
1412                 .put("astronauts", Collections.<String>emptyList()).build());
1413
1414         TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(newShardMgrProps(mockConfig)
1415                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1416
1417         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1418         Failure failure = kit.expectMsgClass(Failure.class);
1419         assertEquals("Failure cause type", IllegalStateException.class, failure.cause().getClass());
1420
1421         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1422
1423         waitForShardInitialized(shardManager, "shard1", kit);
1424         waitForShardInitialized(shardManager, "shard2", kit);
1425
1426         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1427
1428         DatastoreSnapshot datastoreSnapshot = expectMsgClassOrFailure(DatastoreSnapshot.class, kit, "GetSnapshot");
1429
1430         assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1431         assertNull("Expected null ShardManagerSnapshot", datastoreSnapshot.getShardManagerSnapshot());
1432
1433         Function<ShardSnapshot, String> shardNameTransformer = ShardSnapshot::getName;
1434
1435         assertEquals("Shard names", Sets.newHashSet("shard1", "shard2"), Sets.newHashSet(
1436                 Lists.transform(datastoreSnapshot.getShardSnapshots(), shardNameTransformer)));
1437
1438         // Add a new replica
1439
1440         JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1441
1442         TestShardManager shardManagerInstance = shardManager.underlyingActor();
1443         shardManagerInstance.setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1444
1445         shardManager.tell(new AddShardReplica("astronauts"), kit.getRef());
1446         mockShardLeaderKit.expectMsgClass(AddServer.class);
1447         mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.OK, ""));
1448         kit.expectMsgClass(Status.Success.class);
1449         waitForShardInitialized(shardManager, "astronauts", kit);
1450
1451         // Send another GetSnapshot and verify
1452
1453         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1454         datastoreSnapshot = expectMsgClassOrFailure(DatastoreSnapshot.class, kit, "GetSnapshot");
1455
1456         assertEquals("Shard names", Sets.newHashSet("shard1", "shard2", "astronauts"), Sets.newHashSet(
1457                 Lists.transform(datastoreSnapshot.getShardSnapshots(), shardNameTransformer)));
1458
1459         ShardManagerSnapshot snapshot = datastoreSnapshot.getShardManagerSnapshot();
1460         assertNotNull("Expected ShardManagerSnapshot", snapshot);
1461         assertEquals("Shard names", Sets.newHashSet("shard1", "shard2", "astronauts"),
1462                 Sets.newHashSet(snapshot.getShardList()));
1463
1464         LOG.info("testGetSnapshot ending");
1465     }
1466
1467     @Test
1468     public void testRestoreFromSnapshot() throws Exception {
1469         LOG.info("testRestoreFromSnapshot starting");
1470
1471         datastoreContextBuilder.shardInitializationTimeout(3, TimeUnit.SECONDS);
1472
1473         JavaTestKit kit = new JavaTestKit(getSystem());
1474
1475         MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1476                 .put("shard1", Collections.<String>emptyList()).put("shard2", Collections.<String>emptyList())
1477                 .put("astronauts", Collections.<String>emptyList()).build());
1478
1479         ShardManagerSnapshot snapshot =
1480                 new ShardManagerSnapshot(Arrays.asList("shard1", "shard2", "astronauts"), Collections.emptyMap());
1481         DatastoreSnapshot restoreFromSnapshot = new DatastoreSnapshot(shardMrgIDSuffix, snapshot,
1482                 Collections.<ShardSnapshot>emptyList());
1483         TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(newTestShardMgrBuilder(mockConfig)
1484                 .restoreFromSnapshot(restoreFromSnapshot).props().withDispatcher(Dispatchers.DefaultDispatcherId()));
1485
1486         shardManager.underlyingActor().waitForRecoveryComplete();
1487
1488         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1489
1490         waitForShardInitialized(shardManager, "shard1", kit);
1491         waitForShardInitialized(shardManager, "shard2", kit);
1492         waitForShardInitialized(shardManager, "astronauts", kit);
1493
1494         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1495
1496         DatastoreSnapshot datastoreSnapshot = expectMsgClassOrFailure(DatastoreSnapshot.class, kit, "GetSnapshot");
1497
1498         assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1499
1500         assertNotNull("Expected ShardManagerSnapshot", datastoreSnapshot.getShardManagerSnapshot());
1501         assertEquals("Shard names", Sets.newHashSet("shard1", "shard2", "astronauts"),
1502                 Sets.newHashSet(datastoreSnapshot.getShardManagerSnapshot().getShardList()));
1503
1504         LOG.info("testRestoreFromSnapshot ending");
1505     }
1506
1507     @Test
1508     public void testAddShardReplicaForNonExistentShardConfig() throws Exception {
1509         new JavaTestKit(getSystem()) {
1510             {
1511                 ActorRef shardManager = actorFactory
1512                         .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1513                                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1514
1515                 shardManager.tell(new AddShardReplica("model-inventory"), getRef());
1516                 Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1517
1518                 assertEquals("Failure obtained", true, resp.cause() instanceof IllegalArgumentException);
1519             }
1520         };
1521     }
1522
1523     @Test
1524     public void testAddShardReplica() throws Exception {
1525         LOG.info("testAddShardReplica starting");
1526         MockConfiguration mockConfig = new MockConfiguration(
1527                 ImmutableMap.<String, List<String>>builder().put("default", Arrays.asList("member-1", "member-2"))
1528                         .put("astronauts", Arrays.asList("member-2")).build());
1529
1530         final String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1531         datastoreContextBuilder.shardManagerPersistenceId(shardManagerID);
1532
1533         // Create an ActorSystem ShardManager actor for member-1.
1534         final ActorSystem system1 = newActorSystem("Member1");
1535         Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1536         ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1537         final TestActorRef<TestShardManager> newReplicaShardManager = TestActorRef.create(system1,
1538                 newTestShardMgrBuilder(mockConfig).shardActor(mockDefaultShardActor)
1539                         .cluster(new ClusterWrapperImpl(system1)).props()
1540                         .withDispatcher(Dispatchers.DefaultDispatcherId()),
1541                 shardManagerID);
1542
1543         // Create an ActorSystem ShardManager actor for member-2.
1544         final ActorSystem system2 = newActorSystem("Member2");
1545         Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1546
1547         String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
1548         String name = ShardIdentifier.create("astronauts", MEMBER_2, "config").toString();
1549         final TestActorRef<MockRespondActor> mockShardLeaderActor = TestActorRef.create(system2,
1550                 Props.create(MockRespondActor.class, AddServer.class,
1551                         new AddServerReply(ServerChangeStatus.OK, memberId2))
1552                         .withDispatcher(Dispatchers.DefaultDispatcherId()),
1553                 name);
1554         final TestActorRef<TestShardManager> leaderShardManager = TestActorRef.create(system2,
1555                 newTestShardMgrBuilder(mockConfig).shardActor(mockShardLeaderActor)
1556                         .cluster(new ClusterWrapperImpl(system2)).props()
1557                         .withDispatcher(Dispatchers.DefaultDispatcherId()),
1558                 shardManagerID);
1559
1560         new JavaTestKit(system1) {
1561             {
1562                 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1563                 leaderShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1564
1565                 leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1566
1567                 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1568                 leaderShardManager.tell(
1569                         new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class), leaderVersion),
1570                         mockShardLeaderActor);
1571                 leaderShardManager.tell(
1572                         new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
1573                         mockShardLeaderActor);
1574
1575                 newReplicaShardManager.underlyingActor().waitForMemberUp();
1576                 leaderShardManager.underlyingActor().waitForMemberUp();
1577
1578                 // Have a dummy snapshot to be overwritten by the new data
1579                 // persisted.
1580                 String[] restoredShards = { "default", "people" };
1581                 ShardManagerSnapshot snapshot =
1582                         new ShardManagerSnapshot(Arrays.asList(restoredShards), Collections.emptyMap());
1583                 InMemorySnapshotStore.addSnapshot(shardManagerID, snapshot);
1584                 Uninterruptibles.sleepUninterruptibly(2, TimeUnit.MILLISECONDS);
1585
1586                 InMemorySnapshotStore.addSnapshotSavedLatch(shardManagerID);
1587                 InMemorySnapshotStore.addSnapshotDeletedLatch(shardManagerID);
1588
1589                 // construct a mock response message
1590                 newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1591                 AddServer addServerMsg = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1592                         AddServer.class);
1593                 String addServerId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1594                 assertEquals("AddServer serverId", addServerId, addServerMsg.getNewServerId());
1595                 expectMsgClass(duration("5 seconds"), Status.Success.class);
1596
1597                 InMemorySnapshotStore.waitForSavedSnapshot(shardManagerID, ShardManagerSnapshot.class);
1598                 InMemorySnapshotStore.waitForDeletedSnapshot(shardManagerID);
1599                 List<ShardManagerSnapshot> persistedSnapshots = InMemorySnapshotStore.getSnapshots(shardManagerID,
1600                         ShardManagerSnapshot.class);
1601                 assertEquals("Number of snapshots persisted", 1, persistedSnapshots.size());
1602                 ShardManagerSnapshot shardManagerSnapshot = persistedSnapshots.get(0);
1603                 assertEquals("Persisted local shards", Sets.newHashSet("default", "astronauts"),
1604                         Sets.newHashSet(shardManagerSnapshot.getShardList()));
1605             }
1606         };
1607         LOG.info("testAddShardReplica ending");
1608     }
1609
1610     @Test
1611     public void testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader() throws Exception {
1612         LOG.info("testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader starting");
1613         new JavaTestKit(getSystem()) {
1614             {
1615                 TestActorRef<TestShardManager> shardManager = actorFactory
1616                         .createTestActor(newPropsShardMgrWithMockShardActor(), shardMgrID);
1617
1618                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1619                 shardManager.tell(new ActorInitialized(), mockShardActor);
1620
1621                 String leaderId = "leader-member-shard-default-" + shardMrgIDSuffix;
1622                 AddServerReply addServerReply = new AddServerReply(ServerChangeStatus.ALREADY_EXISTS, null);
1623                 ActorRef leaderShardActor = shardManager.underlyingActor().getContext()
1624                         .actorOf(Props.create(MockRespondActor.class, AddServer.class, addServerReply), leaderId);
1625
1626                 MockClusterWrapper.sendMemberUp(shardManager, "leader-member", leaderShardActor.path().toString());
1627
1628                 String newReplicaId = "member-1-shard-default-" + shardMrgIDSuffix;
1629                 shardManager.tell(
1630                         new RoleChangeNotification(newReplicaId, RaftState.Candidate.name(), RaftState.Follower.name()),
1631                         mockShardActor);
1632                 shardManager.tell(
1633                         new ShardLeaderStateChanged(newReplicaId, leaderId, DataStoreVersions.CURRENT_VERSION),
1634                         mockShardActor);
1635
1636                 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1637
1638                 MessageCollectorActor.expectFirstMatching(leaderShardActor, AddServer.class);
1639
1640                 Failure resp = expectMsgClass(duration("5 seconds"), Failure.class);
1641                 assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1642
1643                 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1644                 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1645
1646                 // Send message again to verify previous in progress state is
1647                 // cleared
1648
1649                 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1650                 resp = expectMsgClass(duration("5 seconds"), Failure.class);
1651                 assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1652
1653                 // Send message again with an AddServer timeout to verify the
1654                 // pre-existing shard actor isn't terminated.
1655
1656                 shardManager.tell(
1657                         newDatastoreContextFactory(
1658                                 datastoreContextBuilder.shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build()),
1659                         getRef());
1660                 leaderShardActor.tell(MockRespondActor.CLEAR_RESPONSE, ActorRef.noSender());
1661                 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1662                 expectMsgClass(duration("5 seconds"), Failure.class);
1663
1664                 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1665                 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1666             }
1667         };
1668
1669         LOG.info("testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader ending");
1670     }
1671
1672     @Test
1673     public void testAddShardReplicaWithPreExistingLocalReplicaLeader() throws Exception {
1674         LOG.info("testAddShardReplicaWithPreExistingLocalReplicaLeader starting");
1675         new JavaTestKit(getSystem()) {
1676             {
1677                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1678                 ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1679
1680                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1681                 shardManager.tell(new ActorInitialized(), mockShardActor);
1682                 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mock(DataTree.class),
1683                         DataStoreVersions.CURRENT_VERSION), getRef());
1684                 shardManager.tell(
1685                         new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
1686                         mockShardActor);
1687
1688                 shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1689                 Failure resp = expectMsgClass(duration("5 seconds"), Failure.class);
1690                 assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1691
1692                 shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1693                 expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1694             }
1695         };
1696
1697         LOG.info("testAddShardReplicaWithPreExistingLocalReplicaLeader ending");
1698     }
1699
1700     @Test
1701     public void testAddShardReplicaWithAddServerReplyFailure() throws Exception {
1702         LOG.info("testAddShardReplicaWithAddServerReplyFailure starting");
1703         new JavaTestKit(getSystem()) {
1704             {
1705                 JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1706
1707                 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1708                         .put("astronauts", Arrays.asList("member-2")).build());
1709
1710                 ActorRef mockNewReplicaShardActor = newMockShardActor(getSystem(), "astronauts", "member-1");
1711                 final TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1712                         newTestShardMgrBuilder(mockConfig).shardActor(mockNewReplicaShardActor).props()
1713                             .withDispatcher(Dispatchers.DefaultDispatcherId()), shardMgrID);
1714                 shardManager.underlyingActor()
1715                         .setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1716
1717                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1718
1719                 JavaTestKit terminateWatcher = new JavaTestKit(getSystem());
1720                 terminateWatcher.watch(mockNewReplicaShardActor);
1721
1722                 shardManager.tell(new AddShardReplica("astronauts"), getRef());
1723
1724                 AddServer addServerMsg = mockShardLeaderKit.expectMsgClass(AddServer.class);
1725                 assertEquals("AddServer serverId", "member-1-shard-astronauts-" + shardMrgIDSuffix,
1726                         addServerMsg.getNewServerId());
1727                 mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.TIMEOUT, null));
1728
1729                 Failure failure = expectMsgClass(duration("5 seconds"), Failure.class);
1730                 assertEquals("Failure cause", TimeoutException.class, failure.cause().getClass());
1731
1732                 shardManager.tell(new FindLocalShard("astronauts", false), getRef());
1733                 expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
1734
1735                 terminateWatcher.expectTerminated(mockNewReplicaShardActor);
1736
1737                 shardManager.tell(new AddShardReplica("astronauts"), getRef());
1738                 mockShardLeaderKit.expectMsgClass(AddServer.class);
1739                 mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.NO_LEADER, null));
1740                 failure = expectMsgClass(duration("5 seconds"), Failure.class);
1741                 assertEquals("Failure cause", NoShardLeaderException.class, failure.cause().getClass());
1742             }
1743         };
1744
1745         LOG.info("testAddShardReplicaWithAddServerReplyFailure ending");
1746     }
1747
1748     @Test
1749     public void testAddShardReplicaWithAlreadyInProgress() throws Exception {
1750         testServerChangeWhenAlreadyInProgress("astronauts", new AddShardReplica("astronauts"),
1751                 AddServer.class, new AddShardReplica("astronauts"));
1752     }
1753
1754     @Test
1755     public void testAddShardReplicaWithFindPrimaryTimeout() throws Exception {
1756         LOG.info("testAddShardReplicaWithFindPrimaryTimeout starting");
1757         datastoreContextBuilder.shardInitializationTimeout(100, TimeUnit.MILLISECONDS);
1758         new JavaTestKit(getSystem()) {
1759             {
1760                 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1761                         .put("astronauts", Arrays.asList("member-2")).build());
1762
1763                 final ActorRef newReplicaShardManager = actorFactory
1764                         .createActor(newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor).props()
1765                                 .withDispatcher(Dispatchers.DefaultDispatcherId()), shardMgrID);
1766
1767                 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1768                 MockClusterWrapper.sendMemberUp(newReplicaShardManager, "member-2",
1769                         AddressFromURIString.parse("akka://non-existent@127.0.0.1:5").toString());
1770
1771                 newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1772                 Status.Failure resp = expectMsgClass(duration("5 seconds"), Status.Failure.class);
1773                 assertEquals("Failure obtained", true, resp.cause() instanceof RuntimeException);
1774             }
1775         };
1776
1777         LOG.info("testAddShardReplicaWithFindPrimaryTimeout ending");
1778     }
1779
1780     @Test
1781     public void testRemoveShardReplicaForNonExistentShard() throws Exception {
1782         new JavaTestKit(getSystem()) {
1783             {
1784                 ActorRef shardManager = actorFactory
1785                         .createActor(newShardMgrProps(new ConfigurationImpl(new EmptyModuleShardConfigProvider()))
1786                                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
1787
1788                 shardManager.tell(new RemoveShardReplica("model-inventory", MEMBER_1), getRef());
1789                 Status.Failure resp = expectMsgClass(duration("10 seconds"), Status.Failure.class);
1790                 assertEquals("Failure obtained", true, resp.cause() instanceof PrimaryNotFoundException);
1791             }
1792         };
1793     }
1794
1795     @Test
1796     /**
1797      * Primary is Local
1798      */
1799     public void testRemoveShardReplicaLocal() throws Exception {
1800         new JavaTestKit(getSystem()) {
1801             {
1802                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1803
1804                 final ActorRef respondActor = actorFactory.createActor(Props.create(MockRespondActor.class,
1805                         RemoveServer.class, new RemoveServerReply(ServerChangeStatus.OK, null)), memberId);
1806
1807                 ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor(respondActor));
1808
1809                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1810                 shardManager.tell(new ActorInitialized(), respondActor);
1811                 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mock(DataTree.class),
1812                         DataStoreVersions.CURRENT_VERSION), getRef());
1813                 shardManager.tell(
1814                         new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
1815                         respondActor);
1816
1817                 shardManager.tell(new RemoveShardReplica(Shard.DEFAULT_NAME, MEMBER_1), getRef());
1818                 final RemoveServer removeServer = MessageCollectorActor.expectFirstMatching(respondActor,
1819                         RemoveServer.class);
1820                 assertEquals(ShardIdentifier.create("default", MEMBER_1, shardMrgIDSuffix).toString(),
1821                         removeServer.getServerId());
1822                 expectMsgClass(duration("5 seconds"), Success.class);
1823             }
1824         };
1825     }
1826
1827     @Test
1828     public void testRemoveShardReplicaRemote() throws Exception {
1829         MockConfiguration mockConfig = new MockConfiguration(
1830                 ImmutableMap.<String, List<String>>builder().put("default", Arrays.asList("member-1", "member-2"))
1831                         .put("astronauts", Arrays.asList("member-1")).build());
1832
1833         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1834
1835         // Create an ActorSystem ShardManager actor for member-1.
1836         final ActorSystem system1 = newActorSystem("Member1");
1837         Cluster.get(system1).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1838         ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1839
1840         final TestActorRef<TestShardManager> newReplicaShardManager = TestActorRef.create(system1,
1841                 newTestShardMgrBuilder().configuration(mockConfig).shardActor(mockDefaultShardActor).cluster(
1842                         new ClusterWrapperImpl(system1)).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1843                 shardManagerID);
1844
1845         // Create an ActorSystem ShardManager actor for member-2.
1846         final ActorSystem system2 = newActorSystem("Member2");
1847         Cluster.get(system2).join(AddressFromURIString.parse("akka://cluster-test@127.0.0.1:2558"));
1848
1849         String name = ShardIdentifier.create("default", MEMBER_2, shardMrgIDSuffix).toString();
1850         String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
1851         final TestActorRef<MockRespondActor> mockShardLeaderActor =
1852                 TestActorRef.create(system2, Props.create(MockRespondActor.class, RemoveServer.class,
1853                         new RemoveServerReply(ServerChangeStatus.OK, memberId2)), name);
1854
1855         LOG.error("Mock Shard Leader Actor : {}", mockShardLeaderActor);
1856
1857         final TestActorRef<TestShardManager> leaderShardManager = TestActorRef.create(system2,
1858                 newTestShardMgrBuilder().configuration(mockConfig).shardActor(mockShardLeaderActor).cluster(
1859                         new ClusterWrapperImpl(system2)).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
1860                 shardManagerID);
1861
1862         // Because mockShardLeaderActor is created at the top level of the actor system it has an address like so,
1863         //    akka://cluster-test@127.0.0.1:2559/user/member-2-shard-default-config1
1864         // However when a shard manager has a local shard which is a follower and a leader that is remote it will
1865         // try to compute an address for the remote shard leader using the ShardPeerAddressResolver. This address will
1866         // look like so,
1867         //    akka://cluster-test@127.0.0.1:2559/user/shardmanager-config1/member-2-shard-default-config1
1868         // In this specific case if we did a FindPrimary for shard default from member-1 we would come up
1869         // with the address of an actor which does not exist, therefore any message sent to that actor would go to
1870         // dead letters.
1871         // To work around this problem we create a ForwardingActor with the right address and pass to it the
1872         // mockShardLeaderActor. The ForwardingActor simply forwards all messages to the mockShardLeaderActor and every
1873         // thing works as expected
1874         final ActorRef actorRef = leaderShardManager.underlyingActor().context()
1875                 .actorOf(Props.create(ForwardingActor.class, mockShardLeaderActor),
1876                         "member-2-shard-default-" + shardMrgIDSuffix);
1877
1878         LOG.error("Forwarding actor : {}", actorRef);
1879
1880         new JavaTestKit(system1) {
1881             {
1882                 newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1883                 leaderShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1884
1885                 leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1886                 newReplicaShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1887
1888                 short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1889                 leaderShardManager.tell(
1890                         new ShardLeaderStateChanged(memberId2, memberId2, mock(DataTree.class), leaderVersion),
1891                         mockShardLeaderActor);
1892                 leaderShardManager.tell(
1893                         new RoleChangeNotification(memberId2, RaftState.Candidate.name(), RaftState.Leader.name()),
1894                         mockShardLeaderActor);
1895
1896                 String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
1897                 newReplicaShardManager.tell(
1898                         new ShardLeaderStateChanged(memberId1, memberId2, mock(DataTree.class), leaderVersion),
1899                         mockShardActor);
1900                 newReplicaShardManager.tell(
1901                         new RoleChangeNotification(memberId1, RaftState.Candidate.name(), RaftState.Follower.name()),
1902                         mockShardActor);
1903
1904                 newReplicaShardManager.underlyingActor().waitForMemberUp();
1905                 leaderShardManager.underlyingActor().waitForMemberUp();
1906
1907                 // construct a mock response message
1908                 newReplicaShardManager.tell(new RemoveShardReplica("default", MEMBER_1), getRef());
1909                 RemoveServer removeServer = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1910                         RemoveServer.class);
1911                 String removeServerId = ShardIdentifier.create("default", MEMBER_1, shardMrgIDSuffix).toString();
1912                 assertEquals("RemoveServer serverId", removeServerId, removeServer.getServerId());
1913                 expectMsgClass(duration("5 seconds"), Status.Success.class);
1914             }
1915         };
1916     }
1917
1918     @Test
1919     public void testRemoveShardReplicaWhenAnotherRemoveShardReplicaAlreadyInProgress() throws Exception {
1920         testServerChangeWhenAlreadyInProgress("astronauts", new RemoveShardReplica("astronauts", MEMBER_2),
1921                 RemoveServer.class, new RemoveShardReplica("astronauts", MEMBER_3));
1922     }
1923
1924     @Test
1925     public void testRemoveShardReplicaWhenAddShardReplicaAlreadyInProgress() throws Exception {
1926         testServerChangeWhenAlreadyInProgress("astronauts", new AddShardReplica("astronauts"),
1927                 AddServer.class, new RemoveShardReplica("astronauts", MEMBER_2));
1928     }
1929
1930
1931     public void testServerChangeWhenAlreadyInProgress(final String shardName, final Object firstServerChange,
1932                                                       final Class<?> firstForwardedServerChangeClass,
1933                                                       final Object secondServerChange) throws Exception {
1934         new JavaTestKit(getSystem()) {
1935             {
1936                 JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1937                 final JavaTestKit secondRequestKit = new JavaTestKit(getSystem());
1938
1939                 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1940                         .put(shardName, Arrays.asList("member-2")).build());
1941
1942                 final TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
1943                         newTestShardMgrBuilder().configuration(mockConfig).shardActor(mockShardActor)
1944                                 .cluster(new MockClusterWrapper()).props()
1945                                 .withDispatcher(Dispatchers.DefaultDispatcherId()),
1946                         shardMgrID);
1947
1948                 shardManager.underlyingActor()
1949                         .setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1950
1951                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1952
1953                 shardManager.tell(firstServerChange, getRef());
1954
1955                 mockShardLeaderKit.expectMsgClass(firstForwardedServerChangeClass);
1956
1957                 shardManager.tell(secondServerChange, secondRequestKit.getRef());
1958
1959                 secondRequestKit.expectMsgClass(duration("5 seconds"), Failure.class);
1960             }
1961         };
1962     }
1963
1964     @Test
1965     public void testServerRemovedShardActorNotRunning() throws Exception {
1966         LOG.info("testServerRemovedShardActorNotRunning starting");
1967         new JavaTestKit(getSystem()) {
1968             {
1969                 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
1970                         .put("default", Arrays.asList("member-1", "member-2"))
1971                         .put("astronauts", Arrays.asList("member-2"))
1972                         .put("people", Arrays.asList("member-1", "member-2")).build());
1973
1974                 TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1975                         newShardMgrProps(mockConfig).withDispatcher(Dispatchers.DefaultDispatcherId()));
1976
1977                 shardManager.underlyingActor().waitForRecoveryComplete();
1978                 shardManager.tell(new FindLocalShard("people", false), getRef());
1979                 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1980
1981                 shardManager.tell(new FindLocalShard("default", false), getRef());
1982                 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1983
1984                 // Removed the default shard replica from member-1
1985                 ShardIdentifier.Builder builder = new ShardIdentifier.Builder();
1986                 ShardIdentifier shardId = builder.shardName("default").memberName(MEMBER_1).type(shardMrgIDSuffix)
1987                         .build();
1988                 shardManager.tell(new ServerRemoved(shardId.toString()), getRef());
1989
1990                 shardManager.underlyingActor().verifySnapshotPersisted(Sets.newHashSet("people"));
1991             }
1992         };
1993
1994         LOG.info("testServerRemovedShardActorNotRunning ending");
1995     }
1996
1997     @Test
1998     public void testServerRemovedShardActorRunning() throws Exception {
1999         LOG.info("testServerRemovedShardActorRunning starting");
2000         new JavaTestKit(getSystem()) {
2001             {
2002                 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
2003                         .put("default", Arrays.asList("member-1", "member-2"))
2004                         .put("astronauts", Arrays.asList("member-2"))
2005                         .put("people", Arrays.asList("member-1", "member-2")).build());
2006
2007                 String shardId = ShardIdentifier.create("default", MEMBER_1, shardMrgIDSuffix).toString();
2008                 ActorRef shard = actorFactory.createActor(MessageCollectorActor.props(), shardId);
2009
2010                 TestActorRef<TestShardManager> shardManager = actorFactory
2011                         .createTestActor(newTestShardMgrBuilder(mockConfig).addShardActor("default", shard).props()
2012                                 .withDispatcher(Dispatchers.DefaultDispatcherId()));
2013
2014                 shardManager.underlyingActor().waitForRecoveryComplete();
2015
2016                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
2017                 shardManager.tell(new ActorInitialized(), shard);
2018
2019                 waitForShardInitialized(shardManager, "people", this);
2020                 waitForShardInitialized(shardManager, "default", this);
2021
2022                 // Removed the default shard replica from member-1
2023                 shardManager.tell(new ServerRemoved(shardId), getRef());
2024
2025                 shardManager.underlyingActor().verifySnapshotPersisted(Sets.newHashSet("people"));
2026
2027                 MessageCollectorActor.expectFirstMatching(shard, Shutdown.class);
2028             }
2029         };
2030
2031         LOG.info("testServerRemovedShardActorRunning ending");
2032     }
2033
2034     @Test
2035     public void testShardPersistenceWithRestoredData() throws Exception {
2036         LOG.info("testShardPersistenceWithRestoredData starting");
2037         new JavaTestKit(getSystem()) {
2038             {
2039                 MockConfiguration mockConfig =
2040                     new MockConfiguration(ImmutableMap.<String, List<String>>builder()
2041                             .put("default", Arrays.asList("member-1", "member-2"))
2042                             .put("astronauts", Arrays.asList("member-2"))
2043                             .put("people", Arrays.asList("member-1", "member-2")).build());
2044                 String[] restoredShards = {"default", "astronauts"};
2045                 ShardManagerSnapshot snapshot =
2046                         new ShardManagerSnapshot(Arrays.asList(restoredShards), Collections.emptyMap());
2047                 InMemorySnapshotStore.addSnapshot("shard-manager-" + shardMrgIDSuffix, snapshot);
2048
2049                 // create shardManager to come up with restored data
2050                 TestActorRef<TestShardManager> newRestoredShardManager = actorFactory.createTestActor(
2051                         newShardMgrProps(mockConfig).withDispatcher(Dispatchers.DefaultDispatcherId()));
2052
2053                 newRestoredShardManager.underlyingActor().waitForRecoveryComplete();
2054
2055                 newRestoredShardManager.tell(new FindLocalShard("people", false), getRef());
2056                 LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
2057                 assertEquals("for uninitialized shard", "people", notFound.getShardName());
2058
2059                 // Verify a local shard is created for the restored shards,
2060                 // although we expect a NotInitializedException for the shards
2061                 // as the actor initialization
2062                 // message is not sent for them
2063                 newRestoredShardManager.tell(new FindLocalShard("default", false), getRef());
2064                 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
2065
2066                 newRestoredShardManager.tell(new FindLocalShard("astronauts", false), getRef());
2067                 expectMsgClass(duration("5 seconds"), NotInitializedException.class);
2068             }
2069         };
2070
2071         LOG.info("testShardPersistenceWithRestoredData ending");
2072     }
2073
2074     @Test
2075     public void testShutDown() throws Exception {
2076         LOG.info("testShutDown starting");
2077         new JavaTestKit(getSystem()) {
2078             {
2079                 MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder()
2080                         .put("shard1", Arrays.asList("member-1")).put("shard2", Arrays.asList("member-1")).build());
2081
2082                 String shardId1 = ShardIdentifier.create("shard1", MEMBER_1, shardMrgIDSuffix).toString();
2083                 ActorRef shard1 = actorFactory.createActor(MessageCollectorActor.props(), shardId1);
2084
2085                 String shardId2 = ShardIdentifier.create("shard2", MEMBER_1, shardMrgIDSuffix).toString();
2086                 ActorRef shard2 = actorFactory.createActor(MessageCollectorActor.props(), shardId2);
2087
2088                 ActorRef shardManager = actorFactory.createActor(newTestShardMgrBuilder(mockConfig)
2089                         .addShardActor("shard1", shard1).addShardActor("shard2", shard2).props());
2090
2091                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
2092                 shardManager.tell(new ActorInitialized(), shard1);
2093                 shardManager.tell(new ActorInitialized(), shard2);
2094
2095                 FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
2096                 Future<Boolean> stopFuture = Patterns.gracefulStop(shardManager, duration, Shutdown.INSTANCE);
2097
2098                 MessageCollectorActor.expectFirstMatching(shard1, Shutdown.class);
2099                 MessageCollectorActor.expectFirstMatching(shard2, Shutdown.class);
2100
2101                 try {
2102                     Await.ready(stopFuture, FiniteDuration.create(500, TimeUnit.MILLISECONDS));
2103                     fail("ShardManager actor stopped without waiting for the Shards to be stopped");
2104                 } catch (TimeoutException e) {
2105                     // expected
2106                 }
2107
2108                 actorFactory.killActor(shard1, this);
2109                 actorFactory.killActor(shard2, this);
2110
2111                 Boolean stopped = Await.result(stopFuture, duration);
2112                 assertEquals("Stopped", Boolean.TRUE, stopped);
2113             }
2114         };
2115
2116         LOG.info("testShutDown ending");
2117     }
2118
2119     @Test
2120     public void testChangeServersVotingStatus() throws Exception {
2121         new JavaTestKit(getSystem()) {
2122             {
2123                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
2124
2125                 ActorRef respondActor = actorFactory
2126                         .createActor(Props.create(MockRespondActor.class, ChangeServersVotingStatus.class,
2127                                 new ServerChangeReply(ServerChangeStatus.OK, null)), memberId);
2128
2129                 ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor(respondActor));
2130
2131                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
2132                 shardManager.tell(new ActorInitialized(), respondActor);
2133                 shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, mock(DataTree.class),
2134                         DataStoreVersions.CURRENT_VERSION), getRef());
2135                 shardManager.tell(
2136                         new RoleChangeNotification(memberId, RaftState.Candidate.name(), RaftState.Leader.name()),
2137                         respondActor);
2138
2139                 shardManager.tell(
2140                         new ChangeShardMembersVotingStatus("default", ImmutableMap.of("member-2", Boolean.TRUE)),
2141                         getRef());
2142
2143                 ChangeServersVotingStatus actualChangeStatusMsg = MessageCollectorActor
2144                         .expectFirstMatching(respondActor, ChangeServersVotingStatus.class);
2145                 assertEquals("ChangeServersVotingStatus map", actualChangeStatusMsg.getServerVotingStatusMap(),
2146                         ImmutableMap.of(ShardIdentifier
2147                                 .create("default", MemberName.forName("member-2"), shardMrgIDSuffix).toString(),
2148                                 Boolean.TRUE));
2149
2150                 expectMsgClass(duration("5 seconds"), Success.class);
2151             }
2152         };
2153     }
2154
2155     @Test
2156     public void testChangeServersVotingStatusWithNoLeader() throws Exception {
2157         new JavaTestKit(getSystem()) {
2158             {
2159                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
2160
2161                 ActorRef respondActor = actorFactory
2162                         .createActor(Props.create(MockRespondActor.class, ChangeServersVotingStatus.class,
2163                                 new ServerChangeReply(ServerChangeStatus.NO_LEADER, null)), memberId);
2164
2165                 ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor(respondActor));
2166
2167                 shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
2168                 shardManager.tell(new ActorInitialized(), respondActor);
2169                 shardManager.tell(new RoleChangeNotification(memberId, null, RaftState.Follower.name()), respondActor);
2170
2171                 shardManager.tell(
2172                         new ChangeShardMembersVotingStatus("default", ImmutableMap.of("member-2", Boolean.TRUE)),
2173                         getRef());
2174
2175                 MessageCollectorActor.expectFirstMatching(respondActor, ChangeServersVotingStatus.class);
2176
2177                 Status.Failure resp = expectMsgClass(duration("5 seconds"), Status.Failure.class);
2178                 assertEquals("Failure resposnse", true, resp.cause() instanceof NoShardLeaderException);
2179             }
2180         };
2181     }
2182
2183     public static class TestShardManager extends ShardManager {
2184         private final CountDownLatch recoveryComplete = new CountDownLatch(1);
2185         private final CountDownLatch snapshotPersist = new CountDownLatch(1);
2186         private ShardManagerSnapshot snapshot;
2187         private final Map<String, ActorRef> shardActors;
2188         private final ActorRef shardActor;
2189         private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
2190         private CountDownLatch memberUpReceived = new CountDownLatch(1);
2191         private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
2192         private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
2193         private CountDownLatch memberReachableReceived = new CountDownLatch(1);
2194         private volatile MessageInterceptor messageInterceptor;
2195
2196         TestShardManager(final Builder builder) {
2197             super(builder);
2198             shardActor = builder.shardActor;
2199             shardActors = builder.shardActors;
2200         }
2201
2202         @Override
2203         protected void handleRecover(final Object message) throws Exception {
2204             try {
2205                 super.handleRecover(message);
2206             } finally {
2207                 if (message instanceof RecoveryCompleted) {
2208                     recoveryComplete.countDown();
2209                 }
2210             }
2211         }
2212
2213         private void countDownIfOther(final Member member, final CountDownLatch latch) {
2214             if (!getCluster().getCurrentMemberName().equals(memberToName(member))) {
2215                 latch.countDown();
2216             }
2217         }
2218
2219         @Override
2220         public void handleCommand(final Object message) throws Exception {
2221             try {
2222                 if (messageInterceptor != null && messageInterceptor.canIntercept(message)) {
2223                     getSender().tell(messageInterceptor.apply(message), getSelf());
2224                 } else {
2225                     super.handleCommand(message);
2226                 }
2227             } finally {
2228                 if (message instanceof FindPrimary) {
2229                     findPrimaryMessageReceived.countDown();
2230                 } else if (message instanceof ClusterEvent.MemberUp) {
2231                     countDownIfOther(((ClusterEvent.MemberUp) message).member(), memberUpReceived);
2232                 } else if (message instanceof ClusterEvent.MemberRemoved) {
2233                     countDownIfOther(((ClusterEvent.MemberRemoved) message).member(), memberRemovedReceived);
2234                 } else if (message instanceof ClusterEvent.UnreachableMember) {
2235                     countDownIfOther(((ClusterEvent.UnreachableMember) message).member(), memberUnreachableReceived);
2236                 } else if (message instanceof ClusterEvent.ReachableMember) {
2237                     countDownIfOther(((ClusterEvent.ReachableMember) message).member(), memberReachableReceived);
2238                 }
2239             }
2240         }
2241
2242         void setMessageInterceptor(final MessageInterceptor messageInterceptor) {
2243             this.messageInterceptor = messageInterceptor;
2244         }
2245
2246         void waitForRecoveryComplete() {
2247             assertEquals("Recovery complete", true,
2248                     Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
2249         }
2250
2251         public void waitForMemberUp() {
2252             assertEquals("MemberUp received", true,
2253                     Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
2254             memberUpReceived = new CountDownLatch(1);
2255         }
2256
2257         void waitForMemberRemoved() {
2258             assertEquals("MemberRemoved received", true,
2259                     Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
2260             memberRemovedReceived = new CountDownLatch(1);
2261         }
2262
2263         void waitForUnreachableMember() {
2264             assertEquals("UnreachableMember received", true,
2265                 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
2266                 ));
2267             memberUnreachableReceived = new CountDownLatch(1);
2268         }
2269
2270         void waitForReachableMember() {
2271             assertEquals("ReachableMember received", true,
2272                 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
2273             memberReachableReceived = new CountDownLatch(1);
2274         }
2275
2276         void verifyFindPrimary() {
2277             assertEquals("FindPrimary received", true,
2278                     Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
2279             findPrimaryMessageReceived = new CountDownLatch(1);
2280         }
2281
2282         public static Builder builder(final DatastoreContext.Builder datastoreContextBuilder) {
2283             return new Builder(datastoreContextBuilder);
2284         }
2285
2286         public static class Builder extends AbstractGenericCreator<Builder, TestShardManager> {
2287             private ActorRef shardActor;
2288             private final Map<String, ActorRef> shardActors = new HashMap<>();
2289
2290             Builder(final DatastoreContext.Builder datastoreContextBuilder) {
2291                 super(TestShardManager.class);
2292                 datastoreContextFactory(newDatastoreContextFactory(datastoreContextBuilder.build()));
2293             }
2294
2295             Builder shardActor(final ActorRef newShardActor) {
2296                 this.shardActor = newShardActor;
2297                 return this;
2298             }
2299
2300             Builder addShardActor(final String shardName, final ActorRef actorRef) {
2301                 shardActors.put(shardName, actorRef);
2302                 return this;
2303             }
2304         }
2305
2306         @Override
2307         public void saveSnapshot(final Object obj) {
2308             snapshot = (ShardManagerSnapshot) obj;
2309             snapshotPersist.countDown();
2310             super.saveSnapshot(obj);
2311         }
2312
2313         void verifySnapshotPersisted(final Set<String> shardList) {
2314             assertEquals("saveSnapshot invoked", true,
2315                     Uninterruptibles.awaitUninterruptibly(snapshotPersist, 5, TimeUnit.SECONDS));
2316             assertEquals("Shard Persisted", shardList, Sets.newHashSet(snapshot.getShardList()));
2317         }
2318
2319         @Override
2320         protected ActorRef newShardActor(final ShardInformation info) {
2321             if (shardActors.get(info.getShardName()) != null) {
2322                 return shardActors.get(info.getShardName());
2323             }
2324
2325             if (shardActor != null) {
2326                 return shardActor;
2327             }
2328
2329             return super.newShardActor(info);
2330         }
2331     }
2332
2333     private abstract static class AbstractGenericCreator<T extends AbstractGenericCreator<T, ?>, C extends ShardManager>
2334                                                      extends AbstractShardManagerCreator<T> {
2335         private final Class<C> shardManagerClass;
2336
2337         AbstractGenericCreator(final Class<C> shardManagerClass) {
2338             this.shardManagerClass = shardManagerClass;
2339             cluster(new MockClusterWrapper()).configuration(new MockConfiguration()).waitTillReadyCountDownLatch(ready)
2340                     .primaryShardInfoCache(new PrimaryShardInfoFutureCache());
2341         }
2342
2343         @Override
2344         public Props props() {
2345             verify();
2346             return Props.create(shardManagerClass, this);
2347         }
2348     }
2349
2350     private static class GenericCreator<C extends ShardManager> extends AbstractGenericCreator<GenericCreator<C>, C> {
2351         GenericCreator(final Class<C> shardManagerClass) {
2352             super(shardManagerClass);
2353         }
2354     }
2355
2356     private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
2357         private static final long serialVersionUID = 1L;
2358         private final Creator<ShardManager> delegate;
2359
2360         DelegatingShardManagerCreator(final Creator<ShardManager> delegate) {
2361             this.delegate = delegate;
2362         }
2363
2364         @Override
2365         public ShardManager create() throws Exception {
2366             return delegate.create();
2367         }
2368     }
2369
2370     interface MessageInterceptor extends Function<Object, Object> {
2371         boolean canIntercept(Object message);
2372     }
2373
2374     private static MessageInterceptor newFindPrimaryInterceptor(final ActorRef primaryActor) {
2375         return new MessageInterceptor() {
2376             @Override
2377             public Object apply(final Object message) {
2378                 return new RemotePrimaryShardFound(Serialization.serializedActorPath(primaryActor), (short) 1);
2379             }
2380
2381             @Override
2382             public boolean canIntercept(final Object message) {
2383                 return message instanceof FindPrimary;
2384             }
2385         };
2386     }
2387
2388     private static class MockRespondActor extends MessageCollectorActor {
2389         static final String CLEAR_RESPONSE = "clear-response";
2390
2391         private Object responseMsg;
2392         private final Class<?> requestClass;
2393
2394         @SuppressWarnings("unused")
2395         MockRespondActor(final Class<?> requestClass, final Object responseMsg) {
2396             this.requestClass = requestClass;
2397             this.responseMsg = responseMsg;
2398         }
2399
2400         @Override
2401         public void onReceive(final Object message) throws Exception {
2402             if (message.equals(CLEAR_RESPONSE)) {
2403                 responseMsg = null;
2404             } else {
2405                 super.onReceive(message);
2406                 if (message.getClass().equals(requestClass) && responseMsg != null) {
2407                     getSender().tell(responseMsg, getSelf());
2408                 }
2409             }
2410         }
2411     }
2412 }