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.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.never;
  18 import static org.mockito.Mockito.times;
  19 import static org.mockito.Mockito.verify;
  20 import akka.actor.ActorRef;
  21 import akka.actor.ActorSystem;
  22 import akka.actor.AddressFromURIString;
  23 import akka.actor.Props;
  24 import akka.actor.Status;
  25 import akka.actor.Status.Failure;
  26 import akka.actor.Status.Success;
  27 import akka.actor.Terminated;
  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.collect.ImmutableMap;
  41 import com.google.common.collect.ImmutableSet;
  42 import com.google.common.collect.Lists;
  43 import com.google.common.collect.Sets;
  44 import com.google.common.util.concurrent.Uninterruptibles;
  45 import com.typesafe.config.ConfigFactory;
  46 import java.net.URI;
  47 import java.util.AbstractMap;
  48 import java.util.ArrayList;
  49 import java.util.Arrays;
  50 import java.util.Collection;
  51 import java.util.Collections;
  52 import java.util.HashMap;
  53 import java.util.List;
  54 import java.util.Map;
  55 import java.util.Map.Entry;
  56 import java.util.Set;
  57 import java.util.concurrent.CountDownLatch;
  58 import java.util.concurrent.TimeUnit;
  59 import java.util.concurrent.TimeoutException;
  60 import org.junit.After;
  61 import org.junit.Before;
  62 import org.junit.Test;
  63 import org.mockito.Mock;
  64 import org.mockito.Mockito;
  65 import org.mockito.MockitoAnnotations;
  66 import org.opendaylight.controller.cluster.datastore.config.Configuration;
  67 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
  68 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
  69 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  70 import org.opendaylight.controller.cluster.datastore.exceptions.AlreadyExistsException;
  71 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  72 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
  73 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
  74 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  75 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
  76 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
  77 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  78 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  79 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot;
  80 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot.ShardSnapshot;
  81 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
  82 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
  83 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
  84 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
  85 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
  86 import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
  87 import org.opendaylight.controller.cluster.datastore.messages.PeerUp;
  88 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
  89 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
  90 import org.opendaylight.controller.cluster.datastore.messages.RemoveShardReplica;
  91 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
  92 import org.opendaylight.controller.cluster.datastore.messages.SwitchShardBehavior;
  93 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
  94 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
  95 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
  96 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
  97 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
  98 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
  99 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
 100 import org.opendaylight.controller.cluster.raft.RaftState;
 101 import org.opendaylight.controller.cluster.raft.TestActorFactory;
 102 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
 103 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
 104 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
 105 import org.opendaylight.controller.cluster.raft.messages.AddServer;
 106 import org.opendaylight.controller.cluster.raft.messages.AddServerReply;
 107 import org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus;
 108 import org.opendaylight.controller.cluster.raft.messages.ServerRemoved;
 109 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
 110 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
 111 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
 112 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
 113 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
 114 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 115 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 116 import scala.concurrent.Await;
 117 import scala.concurrent.Future;
 118 import scala.concurrent.duration.FiniteDuration;
 119
 120 public class ShardManagerTest extends AbstractActorTest {
 121     private static int ID_COUNTER = 1;
 122
 123     private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
 124     private final String shardMgrID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 125
 126     @Mock
 127     private static CountDownLatch ready;
 128
 129     private static TestActorRef<MessageCollectorActor> mockShardActor;
 130
 131     private static String mockShardName;
 132
 133     private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
 134             dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS)
 135                    .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(6);
 136
 137     private final Collection<ActorSystem> actorSystems = new ArrayList<>();
 138
 139     private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
 140
 141     @Before
 142     public void setUp() {
 143         MockitoAnnotations.initMocks(this);
 144
 145         InMemoryJournal.clear();
 146         InMemorySnapshotStore.clear();
 147
 148         if(mockShardActor == null) {
 149             mockShardName = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
 150             mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), mockShardName);
 151         }
 152
 153         mockShardActor.underlyingActor().clear();
 154     }
 155
 156     @After
 157     public void tearDown() {
 158         InMemoryJournal.clear();
 159         InMemorySnapshotStore.clear();
 160
 161         for(ActorSystem system: actorSystems) {
 162             JavaTestKit.shutdownActorSystem(system, null, Boolean.TRUE);
 163         }
 164
 165         actorFactory.close();
 166     }
 167
 168     private ActorSystem newActorSystem(String config) {
 169         ActorSystem system = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig(config));
 170         actorSystems.add(system);
 171         return system;
 172     }
 173
 174     private ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
 175         String name = new ShardIdentifier(shardName, memberName,"config").toString();
 176         if(system == getSystem()) {
 177             return actorFactory.createTestActor(Props.create(MessageCollectorActor.class), name);
 178         }
 179
 180         return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
 181     }
 182
 183     private Props newShardMgrProps() {
 184         return newShardMgrProps(new MockConfiguration());
 185     }
 186
 187     private static DatastoreContextFactory newDatastoreContextFactory(DatastoreContext datastoreContext) {
 188         DatastoreContextFactory mockFactory = mock(DatastoreContextFactory.class);
 189         Mockito.doReturn(datastoreContext).when(mockFactory).getBaseDatastoreContext();
 190         Mockito.doReturn(datastoreContext).when(mockFactory).getShardDatastoreContext(Mockito.anyString());
 191         return mockFactory;
 192     }
 193
 194     private TestShardManager.Builder newTestShardMgrBuilder() {
 195         return TestShardManager.builder(datastoreContextBuilder);
 196     }
 197
 198     private TestShardManager.Builder newTestShardMgrBuilder(Configuration config) {
 199         return TestShardManager.builder(datastoreContextBuilder).configuration(config);
 200     }
 201
 202     private Props newShardMgrProps(Configuration config) {
 203         return newTestShardMgrBuilder(config).props();
 204     }
 205
 206     private TestShardManager.Builder newTestShardMgrBuilderWithMockShardActor() {
 207         return TestShardManager.builder(datastoreContextBuilder).shardActor(mockShardActor);
 208     }
 209
 210     private Props newPropsShardMgrWithMockShardActor() {
 211         return newTestShardMgrBuilderWithMockShardActor().props();
 212     }
 213
 214     private TestShardManager newTestShardManager() {
 215         return newTestShardManager(newShardMgrProps());
 216     }
 217
 218     private TestShardManager newTestShardManager(Props props) {
 219         TestActorRef<TestShardManager> shardManagerActor = actorFactory.createTestActor(props);
 220         TestShardManager shardManager = shardManagerActor.underlyingActor();
 221         shardManager.waitForRecoveryComplete();
 222         return shardManager;
 223     }
 224
 225     @Test
 226     public void testPerShardDatastoreContext() throws Exception {
 227         final DatastoreContextFactory mockFactory = newDatastoreContextFactory(
 228                 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
 229
 230         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 231                 shardElectionTimeoutFactor(6).build()).when(mockFactory).getShardDatastoreContext("default");
 232
 233         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 234                 shardElectionTimeoutFactor(7).build()).when(mockFactory).getShardDatastoreContext("topology");
 235
 236         final MockConfiguration mockConfig = new MockConfiguration() {
 237             @Override
 238             public Collection<String> getMemberShardNames(String memberName) {
 239                 return Arrays.asList("default", "topology");
 240             }
 241
 242             @Override
 243             public Collection<String> getMembersFromShardName(String shardName) {
 244                 return Arrays.asList("member-1");
 245             }
 246         };
 247
 248         final TestActorRef<MessageCollectorActor> defaultShardActor = actorFactory.createTestActor(
 249                 Props.create(MessageCollectorActor.class), actorFactory.generateActorId("default"));
 250         final TestActorRef<MessageCollectorActor> topologyShardActor = actorFactory.createTestActor(
 251                 Props.create(MessageCollectorActor.class), actorFactory.generateActorId("topology"));
 252
 253         final Map<String, Entry<ActorRef, DatastoreContext>> shardInfoMap = Collections.synchronizedMap(
 254                 new HashMap<String, Entry<ActorRef, DatastoreContext>>());
 255         shardInfoMap.put("default", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(defaultShardActor, null));
 256         shardInfoMap.put("topology", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(topologyShardActor, null));
 257
 258         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 259         final CountDownLatch newShardActorLatch = new CountDownLatch(2);
 260         class LocalShardManager extends ShardManager {
 261             public LocalShardManager(AbstractBuilder<?> builder) {
 262                 super(builder);
 263             }
 264
 265             @Override
 266             protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
 267                 Entry<ActorRef, DatastoreContext> entry = shardInfoMap.get(info.getShardName());
 268                 ActorRef ref = null;
 269                 if(entry != null) {
 270                     ref = entry.getKey();
 271                     entry.setValue(info.getDatastoreContext());
 272                 }
 273
 274                 newShardActorLatch.countDown();
 275                 return ref;
 276             }
 277         }
 278
 279         final Creator<ShardManager> creator = new Creator<ShardManager>() {
 280             private static final long serialVersionUID = 1L;
 281             @Override
 282             public ShardManager create() throws Exception {
 283                 return new LocalShardManager(new GenericBuilder<LocalShardManager>(LocalShardManager.class).
 284                         datastoreContextFactory(mockFactory).primaryShardInfoCache(primaryShardInfoCache).
 285                         configuration(mockConfig));
 286             }
 287         };
 288
 289         JavaTestKit kit = new JavaTestKit(getSystem());
 290
 291         final ActorRef shardManager = actorFactory.createActor(Props.create(
 292                 new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId()));
 293
 294         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), kit.getRef());
 295
 296         assertEquals("Shard actors created", true, newShardActorLatch.await(5, TimeUnit.SECONDS));
 297         assertEquals("getShardElectionTimeoutFactor", 6, shardInfoMap.get("default").getValue().
 298                 getShardElectionTimeoutFactor());
 299         assertEquals("getShardElectionTimeoutFactor", 7, shardInfoMap.get("topology").getValue().
 300                 getShardElectionTimeoutFactor());
 301
 302         DatastoreContextFactory newMockFactory = newDatastoreContextFactory(
 303                 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
 304         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 305                 shardElectionTimeoutFactor(66).build()).when(newMockFactory).getShardDatastoreContext("default");
 306
 307         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 308                 shardElectionTimeoutFactor(77).build()).when(newMockFactory).getShardDatastoreContext("topology");
 309
 310         shardManager.tell(newMockFactory, kit.getRef());
 311
 312         DatastoreContext newContext = MessageCollectorActor.expectFirstMatching(defaultShardActor, DatastoreContext.class);
 313         assertEquals("getShardElectionTimeoutFactor", 66, newContext.getShardElectionTimeoutFactor());
 314
 315         newContext = MessageCollectorActor.expectFirstMatching(topologyShardActor, DatastoreContext.class);
 316         assertEquals("getShardElectionTimeoutFactor", 77, newContext.getShardElectionTimeoutFactor());
 317     }
 318
 319     @Test
 320     public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
 321         new JavaTestKit(getSystem()) {{
 322             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 323
 324             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 325
 326             shardManager.tell(new FindPrimary("non-existent", false), getRef());
 327
 328             expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 329         }};
 330     }
 331
 332     @Test
 333     public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
 334         new JavaTestKit(getSystem()) {{
 335             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 336
 337             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 338
 339             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 340             shardManager.tell(new ActorInitialized(), mockShardActor);
 341
 342             DataTree mockDataTree = mock(DataTree.class);
 343             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 344                     DataStoreVersions.CURRENT_VERSION), getRef());
 345
 346             MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
 347             shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
 348                     RaftState.Leader.name())), mockShardActor);
 349
 350             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 351
 352             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 353             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 354                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 355             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 356         }};
 357     }
 358
 359     @Test
 360     public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
 361         new JavaTestKit(getSystem()) {{
 362             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 363
 364             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 365             shardManager.tell(new ActorInitialized(), mockShardActor);
 366
 367             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 368             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 369             shardManager.tell(new RoleChangeNotification(memberId1,
 370                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 371             shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
 372
 373             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 374
 375             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 376         }};
 377     }
 378
 379     @Test
 380     public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
 381         new JavaTestKit(getSystem()) {{
 382             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 383
 384             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 385             shardManager.tell(new ActorInitialized(), mockShardActor);
 386
 387             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 388             MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
 389
 390             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 391             shardManager.tell(new RoleChangeNotification(memberId1,
 392                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 393             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 394             shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
 395                     leaderVersion), mockShardActor);
 396
 397             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 398
 399             RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 400             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 401                     primaryFound.getPrimaryPath().contains("member-2-shard-default"));
 402             assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
 403         }};
 404     }
 405
 406     @Test
 407     public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
 408         new JavaTestKit(getSystem()) {{
 409             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 410
 411             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 412
 413             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 414         }};
 415     }
 416
 417     @Test
 418     public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
 419         new JavaTestKit(getSystem()) {{
 420             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 421
 422             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 423             shardManager.tell(new ActorInitialized(), mockShardActor);
 424
 425             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 426
 427             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 428         }};
 429     }
 430
 431     @Test
 432     public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
 433         new JavaTestKit(getSystem()) {{
 434             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 435
 436             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 437             shardManager.tell(new ActorInitialized(), mockShardActor);
 438
 439             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 440             shardManager.tell(new RoleChangeNotification(memberId,
 441                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 442
 443             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 444
 445             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 446
 447             DataTree mockDataTree = mock(DataTree.class);
 448             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 449                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
 450
 451             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 452
 453             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 454             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 455                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 456             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 457         }};
 458     }
 459
 460     @Test
 461     public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
 462         new JavaTestKit(getSystem()) {{
 463             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 464
 465             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 466
 467             // We're passing waitUntilInitialized = true to FindPrimary so the response should be
 468             // delayed until we send ActorInitialized and RoleChangeNotification.
 469             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 470
 471             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 472
 473             shardManager.tell(new ActorInitialized(), mockShardActor);
 474
 475             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 476
 477             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 478             shardManager.tell(new RoleChangeNotification(memberId,
 479                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
 480
 481             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 482
 483             DataTree mockDataTree = mock(DataTree.class);
 484             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 485                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
 486
 487             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 488             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 489                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 490             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
 491
 492             expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 493         }};
 494     }
 495
 496     @Test
 497     public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
 498         new JavaTestKit(getSystem()) {{
 499             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 500
 501             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 502
 503             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 504
 505             expectMsgClass(duration("2 seconds"), NotInitializedException.class);
 506
 507             shardManager.tell(new ActorInitialized(), mockShardActor);
 508
 509             expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 510         }};
 511     }
 512
 513     @Test
 514     public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
 515         new JavaTestKit(getSystem()) {{
 516             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 517
 518             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 519             shardManager.tell(new ActorInitialized(), mockShardActor);
 520             shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 521                     null, RaftState.Candidate.name()), mockShardActor);
 522
 523             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 524
 525             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 526         }};
 527     }
 528
 529     @Test
 530     public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
 531         new JavaTestKit(getSystem()) {{
 532             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 533
 534             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 535             shardManager.tell(new ActorInitialized(), mockShardActor);
 536             shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 537                     null, RaftState.IsolatedLeader.name()), mockShardActor);
 538
 539             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 540
 541             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 542         }};
 543     }
 544
 545     @Test
 546     public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
 547         new JavaTestKit(getSystem()) {{
 548             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 549
 550             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 551             shardManager.tell(new ActorInitialized(), mockShardActor);
 552
 553             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 554
 555             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 556         }};
 557     }
 558
 559     @Test
 560     public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
 561         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 562
 563         // Create an ActorSystem ShardManager actor for member-1.
 564
 565         final ActorSystem system1 = newActorSystem("Member1");
 566         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 567
 568         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 569                 newTestShardMgrBuilderWithMockShardActor().cluster(
 570                         new ClusterWrapperImpl(system1)).props(), shardManagerID);
 571
 572         // Create an ActorSystem ShardManager actor for member-2.
 573
 574         final ActorSystem system2 = newActorSystem("Member2");
 575
 576         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 577
 578         final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
 579
 580         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 581                 put("default", Arrays.asList("member-1", "member-2")).
 582                 put("astronauts", Arrays.asList("member-2")).build());
 583
 584         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 585                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 586                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
 587
 588         new JavaTestKit(system1) {{
 589
 590             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 591             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 592
 593             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 594
 595             String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
 596             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 597             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
 598                     Optional.of(mock(DataTree.class)), leaderVersion), mockShardActor2);
 599             shardManager2.tell(new RoleChangeNotification(memberId2,
 600                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 601
 602             shardManager1.underlyingActor().waitForMemberUp();
 603
 604             shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 605
 606             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 607             String path = found.getPrimaryPath();
 608             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
 609             assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
 610
 611             shardManager2.underlyingActor().verifyFindPrimary();
 612
 613             Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 614
 615             shardManager1.underlyingActor().waitForMemberRemoved();
 616
 617             shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 618
 619             expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 620         }};
 621     }
 622
 623     @Test
 624     public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
 625         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 626
 627         // Create an ActorSystem ShardManager actor for member-1.
 628
 629         final ActorSystem system1 = newActorSystem("Member1");
 630         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 631
 632         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 633
 634         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 635                 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(
 636                         new ClusterWrapperImpl(system1)).props(), shardManagerID);
 637
 638         // Create an ActorSystem ShardManager actor for member-2.
 639
 640         final ActorSystem system2 = newActorSystem("Member2");
 641
 642         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 643
 644         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 645
 646         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 647             put("default", Arrays.asList("member-1", "member-2")).build());
 648
 649         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 650                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 651                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
 652
 653         new JavaTestKit(system1) {{
 654
 655             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 656             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 657             shardManager1.tell(new ActorInitialized(), mockShardActor1);
 658             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 659
 660             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 661             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 662             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
 663                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 664             shardManager1.tell(new RoleChangeNotification(memberId1,
 665                 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
 666             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
 667                     DataStoreVersions.CURRENT_VERSION),
 668                 mockShardActor2);
 669             shardManager2.tell(new RoleChangeNotification(memberId2,
 670                 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 671             shardManager1.underlyingActor().waitForMemberUp();
 672
 673             shardManager1.tell(new FindPrimary("default", true), getRef());
 674
 675             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 676             String path = found.getPrimaryPath();
 677             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 678
 679             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 680                 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 681
 682             shardManager1.underlyingActor().waitForUnreachableMember();
 683
 684             PeerDown peerDown = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 685             assertEquals("getMemberName", "member-2", peerDown.getMemberName());
 686             MessageCollectorActor.clearMessages(mockShardActor1);
 687
 688             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 689                     createMemberRemoved("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 690
 691             MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 692
 693             shardManager1.tell(new FindPrimary("default", true), getRef());
 694
 695             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 696
 697             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 698                 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 699
 700             shardManager1.underlyingActor().waitForReachableMember();
 701
 702             PeerUp peerUp = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 703             assertEquals("getMemberName", "member-2", peerUp.getMemberName());
 704             MessageCollectorActor.clearMessages(mockShardActor1);
 705
 706             shardManager1.tell(new FindPrimary("default", true), getRef());
 707
 708             RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 709             String path1 = found1.getPrimaryPath();
 710             assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
 711
 712             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 713                     createMemberUp("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 714
 715             MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 716
 717         }};
 718     }
 719
 720     @Test
 721     public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
 722         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 723
 724         // Create an ActorSystem ShardManager actor for member-1.
 725
 726         final ActorSystem system1 = newActorSystem("Member1");
 727         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 728
 729         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 730
 731         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 732         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 733                 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(
 734                         new ClusterWrapperImpl(system1)).primaryShardInfoCache(primaryShardInfoCache).props(),
 735                 shardManagerID);
 736
 737         // Create an ActorSystem ShardManager actor for member-2.
 738
 739         final ActorSystem system2 = newActorSystem("Member2");
 740
 741         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 742
 743         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 744
 745         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 746             put("default", Arrays.asList("member-1", "member-2")).build());
 747
 748         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 749                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 750                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
 751
 752         new JavaTestKit(system1) {{
 753             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 754             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 755             shardManager1.tell(new ActorInitialized(), mockShardActor1);
 756             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 757
 758             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 759             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 760             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
 761                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 762             shardManager1.tell(new RoleChangeNotification(memberId1,
 763                 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
 764             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
 765                     DataStoreVersions.CURRENT_VERSION),
 766                 mockShardActor2);
 767             shardManager2.tell(new RoleChangeNotification(memberId2,
 768                 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 769             shardManager1.underlyingActor().waitForMemberUp();
 770
 771             shardManager1.tell(new FindPrimary("default", true), getRef());
 772
 773             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 774             String path = found.getPrimaryPath();
 775             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 776
 777             primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
 778                     mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION, Optional.<DataTree>absent()));
 779
 780             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 781                 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 782
 783             shardManager1.underlyingActor().waitForUnreachableMember();
 784
 785             shardManager1.tell(new FindPrimary("default", true), getRef());
 786
 787             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 788
 789             assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
 790
 791             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
 792                     DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 793             shardManager1.tell(new RoleChangeNotification(memberId1,
 794                 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
 795
 796             shardManager1.tell(new FindPrimary("default", true), getRef());
 797
 798             LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 799             String path1 = found1.getPrimaryPath();
 800             assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
 801
 802         }};
 803     }
 804
 805
 806     @Test
 807     public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
 808         new JavaTestKit(getSystem()) {{
 809             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 810
 811             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 812
 813             shardManager.tell(new FindLocalShard("non-existent", false), getRef());
 814
 815             LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
 816
 817             assertEquals("getShardName", "non-existent", notFound.getShardName());
 818         }};
 819     }
 820
 821     @Test
 822     public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
 823         new JavaTestKit(getSystem()) {{
 824             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 825
 826             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 827             shardManager.tell(new ActorInitialized(), mockShardActor);
 828
 829             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
 830
 831             LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
 832
 833             assertTrue("Found path contains " + found.getPath().path().toString(),
 834                     found.getPath().path().toString().contains("member-1-shard-default-config"));
 835         }};
 836     }
 837
 838     @Test
 839     public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
 840         new JavaTestKit(getSystem()) {{
 841             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 842
 843             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
 844
 845             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 846         }};
 847     }
 848
 849     @Test
 850     public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
 851         new JavaTestKit(getSystem()) {{
 852             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
 853
 854             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 855
 856             // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
 857             // delayed until we send ActorInitialized.
 858             Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
 859                     new Timeout(5, TimeUnit.SECONDS));
 860
 861             shardManager.tell(new ActorInitialized(), mockShardActor);
 862
 863             Object resp = Await.result(future, duration("5 seconds"));
 864             assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
 865         }};
 866     }
 867
 868     @Test
 869     public void testOnRecoveryJournalIsCleaned() {
 870         String persistenceID = "shard-manager-" + shardMrgIDSuffix;
 871         InMemoryJournal.addEntry(persistenceID, 1L, new ShardManager.SchemaContextModules(
 872                 ImmutableSet.of("foo")));
 873         InMemoryJournal.addEntry(persistenceID, 2L, new ShardManager.SchemaContextModules(
 874                 ImmutableSet.of("bar")));
 875         InMemoryJournal.addDeleteMessagesCompleteLatch(persistenceID);
 876
 877         TestShardManager shardManager = newTestShardManager();
 878
 879         InMemoryJournal.waitForDeleteMessagesComplete(persistenceID);
 880
 881         // Journal entries up to the last one should've been deleted
 882         Map<Long, Object> journal = InMemoryJournal.get(persistenceID);
 883         synchronized (journal) {
 884             assertEquals("Journal size", 0, journal.size());
 885         }
 886     }
 887
 888     @Test
 889     public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
 890         TestShardManager shardManager = newTestShardManager();
 891
 892         String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 893         shardManager.onReceiveCommand(new RoleChangeNotification(
 894                 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
 895
 896         verify(ready, never()).countDown();
 897
 898         shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
 899                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
 900
 901         verify(ready, times(1)).countDown();
 902     }
 903
 904     @Test
 905     public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
 906         new JavaTestKit(getSystem()) {{
 907             TestShardManager shardManager = newTestShardManager();
 908
 909             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 910             shardManager.onReceiveCommand(new RoleChangeNotification(
 911                     memberId, null, RaftState.Follower.name()));
 912
 913             verify(ready, never()).countDown();
 914
 915             shardManager.onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
 916
 917             shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId,
 918                     "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
 919                     DataStoreVersions.CURRENT_VERSION));
 920
 921             verify(ready, times(1)).countDown();
 922         }};
 923     }
 924
 925     @Test
 926     public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
 927         new JavaTestKit(getSystem()) {{
 928             TestShardManager shardManager = newTestShardManager();
 929
 930             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 931             shardManager.onReceiveCommand(new RoleChangeNotification(memberId, null, RaftState.Follower.name()));
 932
 933             verify(ready, never()).countDown();
 934
 935             shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId,
 936                     "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
 937                     DataStoreVersions.CURRENT_VERSION));
 938
 939             shardManager.onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
 940
 941             verify(ready, times(1)).countDown();
 942         }};
 943     }
 944
 945     @Test
 946     public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
 947         TestShardManager shardManager = newTestShardManager();
 948
 949         shardManager.onReceiveCommand(new RoleChangeNotification(
 950                 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
 951
 952         verify(ready, never()).countDown();
 953     }
 954
 955     @Test
 956     public void testByDefaultSyncStatusIsFalse() throws Exception{
 957         TestShardManager shardManager = newTestShardManager();
 958
 959         assertEquals(false, shardManager.getMBean().getSyncStatus());
 960     }
 961
 962     @Test
 963     public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
 964         TestShardManager shardManager = newTestShardManager();
 965
 966         shardManager.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 967                 RaftState.Follower.name(), RaftState.Leader.name()));
 968
 969         assertEquals(true, shardManager.getMBean().getSyncStatus());
 970     }
 971
 972     @Test
 973     public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
 974         TestShardManager shardManager = newTestShardManager();
 975
 976         String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
 977         shardManager.onReceiveCommand(new RoleChangeNotification(shardId,
 978                 RaftState.Follower.name(), RaftState.Candidate.name()));
 979
 980         assertEquals(false, shardManager.getMBean().getSyncStatus());
 981
 982         // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
 983         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(
 984                 true, shardId));
 985
 986         assertEquals(false, shardManager.getMBean().getSyncStatus());
 987     }
 988
 989     @Test
 990     public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
 991         TestShardManager shardManager = newTestShardManager();
 992
 993         String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
 994         shardManager.onReceiveCommand(new RoleChangeNotification(shardId,
 995                 RaftState.Candidate.name(), RaftState.Follower.name()));
 996
 997         // Initially will be false
 998         assertEquals(false, shardManager.getMBean().getSyncStatus());
 999
1000         // Send status true will make sync status true
1001         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(true, shardId));
1002
1003         assertEquals(true, shardManager.getMBean().getSyncStatus());
1004
1005         // Send status false will make sync status false
1006         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(false, shardId));
1007
1008         assertEquals(false, shardManager.getMBean().getSyncStatus());
1009
1010     }
1011
1012     @Test
1013     public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
1014         TestShardManager shardManager = newTestShardManager(newShardMgrProps(new MockConfiguration() {
1015             @Override
1016             public List<String> getMemberShardNames(String memberName) {
1017                 return Arrays.asList("default", "astronauts");
1018             }
1019         }));
1020
1021         // Initially will be false
1022         assertEquals(false, shardManager.getMBean().getSyncStatus());
1023
1024         // Make default shard leader
1025         String defaultShardId = "member-1-shard-default-" + shardMrgIDSuffix;
1026         shardManager.onReceiveCommand(new RoleChangeNotification(defaultShardId,
1027                 RaftState.Follower.name(), RaftState.Leader.name()));
1028
1029         // default = Leader, astronauts is unknown so sync status remains false
1030         assertEquals(false, shardManager.getMBean().getSyncStatus());
1031
1032         // Make astronauts shard leader as well
1033         String astronautsShardId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1034         shardManager.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1035                 RaftState.Follower.name(), RaftState.Leader.name()));
1036
1037         // Now sync status should be true
1038         assertEquals(true, shardManager.getMBean().getSyncStatus());
1039
1040         // Make astronauts a Follower
1041         shardManager.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1042                 RaftState.Leader.name(), RaftState.Follower.name()));
1043
1044         // Sync status is not true
1045         assertEquals(false, shardManager.getMBean().getSyncStatus());
1046
1047         // Make the astronauts follower sync status true
1048         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(true, astronautsShardId));
1049
1050         // Sync status is now true
1051         assertEquals(true, shardManager.getMBean().getSyncStatus());
1052
1053     }
1054
1055     @Test
1056     public void testOnReceiveSwitchShardBehavior() throws Exception {
1057         new JavaTestKit(getSystem()) {{
1058             final ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1059
1060             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1061             shardManager.tell(new ActorInitialized(), mockShardActor);
1062
1063             shardManager.tell(new SwitchShardBehavior(mockShardName, "Leader", 1000), getRef());
1064
1065             SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor, SwitchBehavior.class);
1066
1067             assertEquals(RaftState.Leader, switchBehavior.getNewState());
1068             assertEquals(1000, switchBehavior.getNewTerm());
1069         }};
1070     }
1071
1072     @Test
1073     public void testOnCreateShard() {
1074         new JavaTestKit(getSystem()) {{
1075             datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1076
1077             ActorRef shardManager = actorFactory.createActor(newShardMgrProps(
1078                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1079
1080             SchemaContext schemaContext = TestModel.createTestContext();
1081             shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1082
1083             DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100).
1084                     persistent(false).build();
1085             Shard.Builder shardBuilder = Shard.builder();
1086
1087             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1088                     "foo", null, Arrays.asList("member-1", "member-5", "member-6"));
1089             shardManager.tell(new CreateShard(config, shardBuilder, datastoreContext), getRef());
1090
1091             expectMsgClass(duration("5 seconds"), Success.class);
1092
1093             shardManager.tell(new FindLocalShard("foo", true), getRef());
1094
1095             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1096
1097             assertEquals("isRecoveryApplicable", false, shardBuilder.getDatastoreContext().isPersistent());
1098             assertTrue("Epxected ShardPeerAddressResolver", shardBuilder.getDatastoreContext().getShardRaftConfig().
1099                     getPeerAddressResolver() instanceof ShardPeerAddressResolver);
1100             assertEquals("peerMembers", Sets.newHashSet(new ShardIdentifier("foo", "member-5", shardMrgIDSuffix).toString(),
1101                     new ShardIdentifier("foo", "member-6", shardMrgIDSuffix).toString()),
1102                     shardBuilder.getPeerAddresses().keySet());
1103             assertEquals("ShardIdentifier", new ShardIdentifier("foo", "member-1", shardMrgIDSuffix),
1104                     shardBuilder.getId());
1105             assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1106
1107             // Send CreateShard with same name - should return Success with a message.
1108
1109             shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1110
1111             Success success = expectMsgClass(duration("5 seconds"), Success.class);
1112             assertNotNull("Success status is null", success.status());
1113         }};
1114     }
1115
1116     @Test
1117     public void testOnCreateShardWithLocalMemberNotInShardConfig() {
1118         new JavaTestKit(getSystem()) {{
1119             datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1120
1121             ActorRef shardManager = actorFactory.createActor(newShardMgrProps(
1122                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1123
1124             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1125
1126             Shard.Builder shardBuilder = Shard.builder();
1127             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1128                     "foo", null, Arrays.asList("member-5", "member-6"));
1129
1130             shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1131             expectMsgClass(duration("5 seconds"), Success.class);
1132
1133             shardManager.tell(new FindLocalShard("foo", true), getRef());
1134             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1135
1136             assertEquals("peerMembers size", 0, shardBuilder.getPeerAddresses().size());
1137             assertEquals("schemaContext", DisableElectionsRaftPolicy.class.getName(),
1138                     shardBuilder.getDatastoreContext().getShardRaftConfig().getCustomRaftPolicyImplementationClass());
1139         }};
1140     }
1141
1142     @Test
1143     public void testOnCreateShardWithNoInitialSchemaContext() {
1144         new JavaTestKit(getSystem()) {{
1145             ActorRef shardManager = actorFactory.createActor(newShardMgrProps(
1146                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1147
1148             Shard.Builder shardBuilder = Shard.builder();
1149
1150             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1151                     "foo", null, Arrays.asList("member-1"));
1152             shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1153
1154             expectMsgClass(duration("5 seconds"), Success.class);
1155
1156             SchemaContext schemaContext = TestModel.createTestContext();
1157             shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1158
1159             shardManager.tell(new FindLocalShard("foo", true), getRef());
1160
1161             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1162
1163             assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1164             assertNotNull("schemaContext is null", shardBuilder.getDatastoreContext());
1165         }};
1166     }
1167
1168     @Test
1169     public void testGetSnapshot() throws Throwable {
1170         JavaTestKit kit = new JavaTestKit(getSystem());
1171
1172         MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1173                    put("shard1", Arrays.asList("member-1")).
1174                    put("shard2", Arrays.asList("member-1")).build());
1175
1176         ActorRef shardManager = actorFactory.createActor(newShardMgrProps(mockConfig).withDispatcher(
1177                 Dispatchers.DefaultDispatcherId()));
1178
1179         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1180         Failure failure = kit.expectMsgClass(Failure.class);
1181         assertEquals("Failure cause type", IllegalStateException.class, failure.cause().getClass());
1182
1183         kit = new JavaTestKit(getSystem());
1184
1185         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1186
1187         shardManager.tell(new FindLocalShard("shard1", true), kit.getRef());
1188         kit.expectMsgClass(LocalShardFound.class);
1189         shardManager.tell(new FindLocalShard("shard2", true), kit.getRef());
1190         kit.expectMsgClass(LocalShardFound.class);
1191
1192         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1193
1194         DatastoreSnapshot datastoreSnapshot = kit.expectMsgClass(DatastoreSnapshot.class);
1195
1196         assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1197         assertNull("Expected null ShardManagerSnapshot", datastoreSnapshot.getShardManagerSnapshot());
1198
1199         Function<ShardSnapshot, String> shardNameTransformer = new Function<ShardSnapshot, String>() {
1200             @Override
1201             public String apply(ShardSnapshot s) {
1202                 return s.getName();
1203             }
1204         };
1205
1206         assertEquals("Shard names", Sets.newHashSet("shard1", "shard2"), Sets.newHashSet(
1207                 Lists.transform(datastoreSnapshot.getShardSnapshots(), shardNameTransformer)));
1208     }
1209
1210     @Test
1211     public void testAddShardReplicaForNonExistentShardConfig() throws Exception {
1212         new JavaTestKit(getSystem()) {{
1213             ActorRef shardManager = actorFactory.createActor(newShardMgrProps(
1214                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1215
1216             shardManager.tell(new AddShardReplica("model-inventory"), getRef());
1217             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1218
1219             assertEquals("Failure obtained", true,
1220                           (resp.cause() instanceof IllegalArgumentException));
1221         }};
1222     }
1223
1224     @Test
1225     public void testAddShardReplica() throws Exception {
1226         MockConfiguration mockConfig =
1227                 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1228                    put("default", Arrays.asList("member-1", "member-2")).
1229                    put("astronauts", Arrays.asList("member-2")).build());
1230
1231         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1232
1233         // Create an ActorSystem ShardManager actor for member-1.
1234         final ActorSystem system1 = newActorSystem("Member1");
1235         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1236         ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1237         final TestActorRef<TestShardManager> newReplicaShardManager = TestActorRef.create(system1,
1238                 newTestShardMgrBuilder(mockConfig).shardActor(mockDefaultShardActor).cluster(
1239                         new ClusterWrapperImpl(system1)).props(), shardManagerID);
1240
1241         // Create an ActorSystem ShardManager actor for member-2.
1242         final ActorSystem system2 = newActorSystem("Member2");
1243         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1244
1245         String name = new ShardIdentifier("astronauts", "member-2", "config").toString();
1246         final TestActorRef<MockRespondActor> mockShardLeaderActor =
1247                 TestActorRef.create(system2, Props.create(MockRespondActor.class), name);
1248         final TestActorRef<TestShardManager> leaderShardManager = TestActorRef.create(system2,
1249                 newTestShardMgrBuilder(mockConfig).shardActor(mockShardLeaderActor).cluster(
1250                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
1251
1252         new JavaTestKit(system1) {{
1253
1254             newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1255             leaderShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1256
1257             leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1258
1259             String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
1260             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1261             leaderShardManager.tell(new ShardLeaderStateChanged(memberId2, memberId2,
1262                     Optional.of(mock(DataTree.class)), leaderVersion), mockShardLeaderActor);
1263             leaderShardManager.tell(new RoleChangeNotification(memberId2,
1264                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardLeaderActor);
1265
1266             newReplicaShardManager.underlyingActor().waitForMemberUp();
1267             leaderShardManager.underlyingActor().waitForMemberUp();
1268
1269             //construct a mock response message
1270             AddServerReply response = new AddServerReply(ServerChangeStatus.OK, memberId2);
1271             mockShardLeaderActor.underlyingActor().updateResponse(response);
1272             newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1273             AddServer addServerMsg = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1274                 AddServer.class);
1275             String addServerId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1276             assertEquals("AddServer serverId", addServerId, addServerMsg.getNewServerId());
1277             newReplicaShardManager.underlyingActor()
1278                 .verifySnapshotPersisted(Sets.newHashSet("default", "astronauts"));
1279             expectMsgClass(duration("5 seconds"), Status.Success.class);
1280         }};
1281     }
1282
1283     @Test
1284     public void testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader() throws Exception {
1285         new JavaTestKit(getSystem()) {{
1286             TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1287                     newPropsShardMgrWithMockShardActor(), shardMgrID);
1288
1289             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1290             shardManager.tell(new ActorInitialized(), mockShardActor);
1291
1292             String leaderId = "leader-member-shard-default-" + shardMrgIDSuffix;
1293             AddServerReply addServerReply = new AddServerReply(ServerChangeStatus.ALREADY_EXISTS, null);
1294             ActorRef leaderShardActor = shardManager.underlyingActor().getContext().actorOf(
1295                     Props.create(MockRespondActor.class, addServerReply), leaderId);
1296
1297             MockClusterWrapper.sendMemberUp(shardManager, "leader-member", leaderShardActor.path().toString());
1298
1299             String newReplicaId = "member-1-shard-default-" + shardMrgIDSuffix;
1300             shardManager.tell(new RoleChangeNotification(newReplicaId,
1301                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
1302             shardManager.tell(new ShardLeaderStateChanged(newReplicaId, leaderId, Optional.<DataTree>absent(),
1303                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
1304
1305             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1306
1307             MessageCollectorActor.expectFirstMatching(leaderShardActor, AddServer.class);
1308
1309             Failure resp = expectMsgClass(duration("5 seconds"), Failure.class);
1310             assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1311
1312             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1313             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1314
1315             // Send message again to verify previous in progress state is cleared
1316
1317             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1318             resp = expectMsgClass(duration("5 seconds"), Failure.class);
1319             assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1320
1321             // Send message again with an AddServer timeout to verify the pre-existing shard actor isn't terminated.
1322
1323             shardManager.tell(newDatastoreContextFactory(datastoreContextBuilder.
1324                     shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build()), getRef());
1325             leaderShardActor.tell(MockRespondActor.CLEAR_RESPONSE, ActorRef.noSender());
1326             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1327             expectMsgClass(duration("5 seconds"), Failure.class);
1328
1329             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1330             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1331         }};
1332     }
1333
1334     @Test
1335     public void testAddShardReplicaWithPreExistingLocalReplicaLeader() throws Exception {
1336         new JavaTestKit(getSystem()) {{
1337             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1338             ActorRef shardManager = actorFactory.createActor(newPropsShardMgrWithMockShardActor());
1339
1340             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1341             shardManager.tell(new ActorInitialized(), mockShardActor);
1342             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mock(DataTree.class)),
1343                     DataStoreVersions.CURRENT_VERSION), getRef());
1344             shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
1345                     RaftState.Leader.name())), mockShardActor);
1346
1347             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1348             Failure resp = expectMsgClass(duration("5 seconds"), Failure.class);
1349             assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1350
1351             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1352             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1353         }};
1354     }
1355
1356     @Test
1357     public void testAddShardReplicaWithAddServerReplyFailure() throws Exception {
1358         new JavaTestKit(getSystem()) {{
1359             JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1360
1361             MockConfiguration mockConfig =
1362                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1363                        put("astronauts", Arrays.asList("member-2")).build());
1364
1365             ActorRef mockNewReplicaShardActor = newMockShardActor(getSystem(), "astronauts", "member-1");
1366             final TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1367                     newTestShardMgrBuilder(mockConfig).shardActor(mockNewReplicaShardActor).props(), shardMgrID);
1368             shardManager.underlyingActor().setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1369
1370             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1371
1372             JavaTestKit terminateWatcher = new JavaTestKit(getSystem());
1373             terminateWatcher.watch(mockNewReplicaShardActor);
1374
1375             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1376
1377             AddServer addServerMsg = mockShardLeaderKit.expectMsgClass(AddServer.class);
1378             assertEquals("AddServer serverId", "member-1-shard-astronauts-" + shardMrgIDSuffix,
1379                     addServerMsg.getNewServerId());
1380             mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.TIMEOUT, null));
1381
1382             Failure failure = expectMsgClass(duration("5 seconds"), Failure.class);
1383             assertEquals("Failure cause", TimeoutException.class, failure.cause().getClass());
1384
1385             shardManager.tell(new FindLocalShard("astronauts", false), getRef());
1386             expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
1387
1388             terminateWatcher.expectTerminated(mockNewReplicaShardActor);
1389
1390             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1391             mockShardLeaderKit.expectMsgClass(AddServer.class);
1392             mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.NO_LEADER, null));
1393             failure = expectMsgClass(duration("5 seconds"), Failure.class);
1394             assertEquals("Failure cause", NoShardLeaderException.class, failure.cause().getClass());
1395         }};
1396     }
1397
1398     @Test
1399     public void testAddShardReplicaWithAlreadyInProgress() throws Exception {
1400         new JavaTestKit(getSystem()) {{
1401             JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1402             JavaTestKit secondRequestKit = new JavaTestKit(getSystem());
1403
1404             MockConfiguration mockConfig =
1405                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1406                        put("astronauts", Arrays.asList("member-2")).build());
1407
1408             final TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1409                     newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor).props(), shardMgrID);
1410             shardManager.underlyingActor().setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1411
1412             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1413
1414             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1415
1416             mockShardLeaderKit.expectMsgClass(AddServer.class);
1417
1418             shardManager.tell(new AddShardReplica("astronauts"), secondRequestKit.getRef());
1419
1420             secondRequestKit.expectMsgClass(duration("5 seconds"), Failure.class);
1421         }};
1422     }
1423
1424     @Test
1425     public void testAddShardReplicaWithFindPrimaryTimeout() throws Exception {
1426         new JavaTestKit(getSystem()) {{
1427             MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1428                        put("astronauts", Arrays.asList("member-2")).build());
1429
1430             final ActorRef newReplicaShardManager = actorFactory.createActor(newTestShardMgrBuilder(mockConfig).
1431                     shardActor(mockShardActor).props(), shardMgrID);
1432
1433             newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1434             MockClusterWrapper.sendMemberUp(newReplicaShardManager, "member-2", getRef().path().toString());
1435
1436             newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1437             Status.Failure resp = expectMsgClass(duration("5 seconds"), Status.Failure.class);
1438             assertEquals("Failure obtained", true,
1439                           (resp.cause() instanceof RuntimeException));
1440         }};
1441     }
1442
1443     @Test
1444     public void testRemoveShardReplicaForNonExistentShard() throws Exception {
1445         new JavaTestKit(getSystem()) {{
1446             ActorRef shardManager = actorFactory.createActor(newShardMgrProps(
1447                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1448
1449             shardManager.tell(new RemoveShardReplica("model-inventory"), getRef());
1450             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1451             assertEquals("Failure obtained", true,
1452                          (resp.cause() instanceof IllegalArgumentException));
1453         }};
1454
1455     }
1456
1457     @Test
1458     public void testServerRemovedShardActorNotRunning() throws Exception {
1459         new JavaTestKit(getSystem()) {{
1460             MockConfiguration mockConfig =
1461                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1462                             put("default", Arrays.asList("member-1", "member-2")).
1463                             put("astronauts", Arrays.asList("member-2")).
1464                             put("people", Arrays.asList("member-1", "member-2")).build());
1465
1466             TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(newShardMgrProps(mockConfig));
1467
1468             shardManager.underlyingActor().waitForRecoveryComplete();
1469
1470             shardManager.tell(new FindLocalShard("people", false), getRef());
1471             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1472
1473             shardManager.tell(new FindLocalShard("default", false), getRef());
1474             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1475
1476             // Removed the default shard replica from member-1
1477             ShardIdentifier.Builder builder = new ShardIdentifier.Builder();
1478             final ShardIdentifier shardId = builder.shardName("default").memberName("member-1").type("config1").build();
1479             shardManager.tell(new ServerRemoved(shardId.toString()), getRef());
1480
1481             shardManager.underlyingActor().verifySnapshotPersisted(Sets.newHashSet("people"));
1482         }};
1483     }
1484
1485     @Test
1486     public void testServerRemovedShardActorRunning() throws Exception {
1487         new JavaTestKit(getSystem()) {{
1488             MockConfiguration mockConfig =
1489                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1490                             put("default", Arrays.asList("member-1", "member-2")).
1491                             put("astronauts", Arrays.asList("member-2")).
1492                             put("people", Arrays.asList("member-1", "member-2")).build());
1493
1494             TestActorRef<MessageCollectorActor> shard = actorFactory.createTestActor(MessageCollectorActor.props());
1495
1496             TestActorRef<TestShardManager> shardManager = actorFactory.createTestActor(
1497                     newTestShardMgrBuilder(mockConfig).addShardActor("default", shard).props());
1498
1499             watch(shard);
1500
1501             shardManager.underlyingActor().waitForRecoveryComplete();
1502
1503             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1504
1505             shardManager.tell(new FindLocalShard("people", false), getRef());
1506             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1507
1508             shardManager.tell(new FindLocalShard("default", false), getRef());
1509             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1510
1511             // Removed the default shard replica from member-1
1512             ShardIdentifier.Builder builder = new ShardIdentifier.Builder();
1513             final ShardIdentifier shardId = builder.shardName("default").memberName("member-1").type("config1").build();
1514             shardManager.tell(new ServerRemoved(shardId.toString()), getRef());
1515
1516             shardManager.underlyingActor().verifySnapshotPersisted(Sets.newHashSet("people"));
1517
1518             expectMsgClass(duration("5 seconds"), Terminated.class);
1519         }};
1520     }
1521
1522
1523     @Test
1524     public void testShardPersistenceWithRestoredData() throws Exception {
1525         new JavaTestKit(getSystem()) {{
1526             MockConfiguration mockConfig =
1527                 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1528                    put("default", Arrays.asList("member-1", "member-2")).
1529                    put("astronauts", Arrays.asList("member-2")).
1530                    put("people", Arrays.asList("member-1", "member-2")).build());
1531             String[] restoredShards = {"default", "astronauts"};
1532             ShardManagerSnapshot snapshot = new ShardManagerSnapshot(Arrays.asList(restoredShards));
1533             InMemorySnapshotStore.addSnapshot("shard-manager-" + shardMrgIDSuffix, snapshot);
1534
1535             //create shardManager to come up with restored data
1536             TestActorRef<TestShardManager> newRestoredShardManager = actorFactory.createTestActor(
1537                     newShardMgrProps(mockConfig));
1538
1539             newRestoredShardManager.underlyingActor().waitForRecoveryComplete();
1540
1541             newRestoredShardManager.tell(new FindLocalShard("people", false), getRef());
1542             LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
1543             assertEquals("for uninitialized shard", "people", notFound.getShardName());
1544
1545             //Verify a local shard is created for the restored shards,
1546             //although we expect a NotInitializedException for the shards as the actor initialization
1547             //message is not sent for them
1548             newRestoredShardManager.tell(new FindLocalShard("default", false), getRef());
1549             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1550
1551             newRestoredShardManager.tell(new FindLocalShard("astronauts", false), getRef());
1552             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
1553         }};
1554     }
1555
1556
1557     private static class TestShardManager extends ShardManager {
1558         private final CountDownLatch recoveryComplete = new CountDownLatch(1);
1559         private final CountDownLatch snapshotPersist = new CountDownLatch(1);
1560         private ShardManagerSnapshot snapshot;
1561         private final Map<String, ActorRef> shardActors;
1562         private final ActorRef shardActor;
1563         private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
1564         private CountDownLatch memberUpReceived = new CountDownLatch(1);
1565         private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
1566         private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
1567         private CountDownLatch memberReachableReceived = new CountDownLatch(1);
1568         private volatile MessageInterceptor messageInterceptor;
1569
1570         private TestShardManager(Builder builder) {
1571             super(builder);
1572             shardActor = builder.shardActor;
1573             shardActors = builder.shardActors;
1574         }
1575
1576         @Override
1577         public void handleRecover(Object message) throws Exception {
1578             try {
1579                 super.handleRecover(message);
1580             } finally {
1581                 if(message instanceof RecoveryCompleted) {
1582                     recoveryComplete.countDown();
1583                 }
1584             }
1585         }
1586
1587         @Override
1588         public void handleCommand(Object message) throws Exception {
1589             try{
1590                 if(messageInterceptor != null && messageInterceptor.canIntercept(message)) {
1591                     getSender().tell(messageInterceptor.apply(message), getSelf());
1592                 } else {
1593                     super.handleCommand(message);
1594                 }
1595             } finally {
1596                 if(message instanceof FindPrimary) {
1597                     findPrimaryMessageReceived.countDown();
1598                 } else if(message instanceof ClusterEvent.MemberUp) {
1599                     String role = ((ClusterEvent.MemberUp)message).member().roles().head();
1600                     if(!getCluster().getCurrentMemberName().equals(role)) {
1601                         memberUpReceived.countDown();
1602                     }
1603                 } else if(message instanceof ClusterEvent.MemberRemoved) {
1604                     String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
1605                     if(!getCluster().getCurrentMemberName().equals(role)) {
1606                         memberRemovedReceived.countDown();
1607                     }
1608                 } else if(message instanceof ClusterEvent.UnreachableMember) {
1609                     String role = ((ClusterEvent.UnreachableMember)message).member().roles().head();
1610                     if(!getCluster().getCurrentMemberName().equals(role)) {
1611                         memberUnreachableReceived.countDown();
1612                     }
1613                 } else if(message instanceof ClusterEvent.ReachableMember) {
1614                     String role = ((ClusterEvent.ReachableMember)message).member().roles().head();
1615                     if(!getCluster().getCurrentMemberName().equals(role)) {
1616                         memberReachableReceived.countDown();
1617                     }
1618                 }
1619             }
1620         }
1621
1622         void setMessageInterceptor(MessageInterceptor messageInterceptor) {
1623             this.messageInterceptor = messageInterceptor;
1624         }
1625
1626         void waitForRecoveryComplete() {
1627             assertEquals("Recovery complete", true,
1628                     Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
1629         }
1630
1631         void waitForMemberUp() {
1632             assertEquals("MemberUp received", true,
1633                     Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
1634             memberUpReceived = new CountDownLatch(1);
1635         }
1636
1637         void waitForMemberRemoved() {
1638             assertEquals("MemberRemoved received", true,
1639                     Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
1640             memberRemovedReceived = new CountDownLatch(1);
1641         }
1642
1643         void waitForUnreachableMember() {
1644             assertEquals("UnreachableMember received", true,
1645                 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
1646                 ));
1647             memberUnreachableReceived = new CountDownLatch(1);
1648         }
1649
1650         void waitForReachableMember() {
1651             assertEquals("ReachableMember received", true,
1652                 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
1653             memberReachableReceived = new CountDownLatch(1);
1654         }
1655
1656         void verifyFindPrimary() {
1657             assertEquals("FindPrimary received", true,
1658                     Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
1659             findPrimaryMessageReceived = new CountDownLatch(1);
1660         }
1661
1662         public static Builder builder(DatastoreContext.Builder datastoreContextBuilder) {
1663             return new Builder(datastoreContextBuilder);
1664         }
1665
1666         private static class Builder extends AbstractGenericBuilder<Builder, TestShardManager> {
1667             private ActorRef shardActor;
1668             private final Map<String, ActorRef> shardActors = new HashMap<>();
1669
1670             Builder(DatastoreContext.Builder datastoreContextBuilder) {
1671                 super(TestShardManager.class);
1672                 datastoreContextFactory(newDatastoreContextFactory(datastoreContextBuilder.build()));
1673             }
1674
1675             Builder shardActor(ActorRef shardActor) {
1676                 this.shardActor = shardActor;
1677                 return this;
1678             }
1679
1680             Builder addShardActor(String shardName, ActorRef actorRef){
1681                 shardActors.put(shardName, actorRef);
1682                 return this;
1683             }
1684         }
1685
1686         @Override
1687         public void saveSnapshot(Object obj) {
1688             snapshot = (ShardManagerSnapshot) obj;
1689             snapshotPersist.countDown();
1690         }
1691
1692         void verifySnapshotPersisted(Set<String> shardList) {
1693             assertEquals("saveSnapshot invoked", true,
1694                     Uninterruptibles.awaitUninterruptibly(snapshotPersist, 5, TimeUnit.SECONDS));
1695             assertEquals("Shard Persisted", shardList, Sets.newHashSet(snapshot.getShardList()));
1696         }
1697
1698         @Override
1699         protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
1700             if(shardActors.get(info.getShardName()) != null){
1701                 return shardActors.get(info.getShardName());
1702             }
1703
1704             if(shardActor != null) {
1705                 return shardActor;
1706             }
1707
1708             return super.newShardActor(schemaContext, info);
1709         }
1710     }
1711
1712     private static abstract class AbstractGenericBuilder<T extends AbstractGenericBuilder<T, ?>, C extends ShardManager>
1713                                                      extends ShardManager.AbstractBuilder<T> {
1714         private final Class<C> shardManagerClass;
1715
1716         AbstractGenericBuilder(Class<C> shardManagerClass) {
1717             this.shardManagerClass = shardManagerClass;
1718             cluster(new MockClusterWrapper()).configuration(new MockConfiguration()).
1719                     waitTillReadyCountdownLatch(ready).primaryShardInfoCache(new PrimaryShardInfoFutureCache());
1720         }
1721
1722         @Override
1723         public Props props() {
1724             verify();
1725             return Props.create(shardManagerClass, this);
1726         }
1727     }
1728
1729     private static class GenericBuilder<C extends ShardManager> extends AbstractGenericBuilder<GenericBuilder<C>, C> {
1730         GenericBuilder(Class<C> shardManagerClass) {
1731             super(shardManagerClass);
1732         }
1733     }
1734
1735     private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
1736         private static final long serialVersionUID = 1L;
1737         private final Creator<ShardManager> delegate;
1738
1739         public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
1740             this.delegate = delegate;
1741         }
1742
1743         @Override
1744         public ShardManager create() throws Exception {
1745             return delegate.create();
1746         }
1747     }
1748
1749     interface MessageInterceptor extends Function<Object, Object> {
1750         boolean canIntercept(Object message);
1751     }
1752
1753     private MessageInterceptor newFindPrimaryInterceptor(final ActorRef primaryActor) {
1754         return new MessageInterceptor(){
1755             @Override
1756             public Object apply(Object message) {
1757                 return new RemotePrimaryShardFound(Serialization.serializedActorPath(primaryActor), (short) 1);
1758             }
1759
1760             @Override
1761             public boolean canIntercept(Object message) {
1762                 return message instanceof FindPrimary;
1763             }
1764         };
1765     }
1766
1767     private static class MockRespondActor extends MessageCollectorActor {
1768         static final String CLEAR_RESPONSE = "clear-response";
1769
1770         private volatile Object responseMsg;
1771
1772         @SuppressWarnings("unused")
1773         public MockRespondActor() {
1774         }
1775
1776         @SuppressWarnings("unused")
1777         public MockRespondActor(Object responseMsg) {
1778             this.responseMsg = responseMsg;
1779         }
1780
1781         public void updateResponse(Object response) {
1782             responseMsg = response;
1783         }
1784
1785         @Override
1786         public void onReceive(Object message) throws Exception {
1787             super.onReceive(message);
1788             if (message instanceof AddServer) {
1789                 if (responseMsg != null) {
1790                     getSender().tell(responseMsg, getSelf());
1791                 }
1792             } if(message.equals(CLEAR_RESPONSE)) {
1793                 responseMsg = null;
1794             }
1795         }
1796     }
1797 }