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