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