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.PoisonPill;
  24 import akka.actor.Props;
  25 import akka.actor.Status;
  26 import akka.actor.Status.Failure;
  27 import akka.actor.Status.Success;
  28 import akka.actor.Terminated;
  29 import akka.cluster.Cluster;
  30 import akka.cluster.ClusterEvent;
  31 import akka.dispatch.Dispatchers;
  32 import akka.japi.Creator;
  33 import akka.pattern.Patterns;
  34 import akka.persistence.RecoveryCompleted;
  35 import akka.serialization.Serialization;
  36 import akka.testkit.JavaTestKit;
  37 import akka.testkit.TestActorRef;
  38 import akka.util.Timeout;
  39 import com.google.common.base.Function;
  40 import com.google.common.base.Optional;
  41 import com.google.common.collect.ImmutableMap;
  42 import com.google.common.collect.ImmutableSet;
  43 import com.google.common.collect.Lists;
  44 import com.google.common.collect.Sets;
  45 import com.google.common.util.concurrent.Uninterruptibles;
  46 import com.typesafe.config.ConfigFactory;
  47 import java.net.URI;
  48 import java.util.AbstractMap;
  49 import java.util.ArrayList;
  50 import java.util.Arrays;
  51 import java.util.Collection;
  52 import java.util.Collections;
  53 import java.util.HashMap;
  54 import java.util.List;
  55 import java.util.Map;
  56 import java.util.Map.Entry;
  57 import java.util.Set;
  58 import java.util.concurrent.CountDownLatch;
  59 import java.util.concurrent.TimeUnit;
  60 import java.util.concurrent.TimeoutException;
  61 import org.junit.After;
  62 import org.junit.Before;
  63 import org.junit.Test;
  64 import org.mockito.Mock;
  65 import org.mockito.Mockito;
  66 import org.mockito.MockitoAnnotations;
  67 import org.opendaylight.controller.cluster.datastore.config.Configuration;
  68 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
  69 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
  70 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  71 import org.opendaylight.controller.cluster.datastore.exceptions.AlreadyExistsException;
  72 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  73 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
  74 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
  75 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  76 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
  77 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
  78 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  79 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  80 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot;
  81 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot.ShardSnapshot;
  82 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
  83 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
  84 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
  85 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
  86 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
  87 import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
  88 import org.opendaylight.controller.cluster.datastore.messages.PeerUp;
  89 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
  90 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
  91 import org.opendaylight.controller.cluster.datastore.messages.RemoveShardReplica;
  92 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
  93 import org.opendaylight.controller.cluster.datastore.messages.SwitchShardBehavior;
  94 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
  95 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
  96 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
  97 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
  98 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
  99 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
 100 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
 101 import org.opendaylight.controller.cluster.raft.RaftState;
 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 static ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
 138         String name = new ShardIdentifier(shardName, memberName,"config").toString();
 139         return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
 140     }
 141
 142     private final Collection<ActorSystem> actorSystems = new ArrayList<>();
 143
 144     @Before
 145     public void setUp() {
 146         MockitoAnnotations.initMocks(this);
 147
 148         InMemoryJournal.clear();
 149         InMemorySnapshotStore.clear();
 150
 151         if(mockShardActor == null) {
 152             mockShardName = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
 153             mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), mockShardName);
 154         }
 155
 156         mockShardActor.underlyingActor().clear();
 157     }
 158
 159     @After
 160     public void tearDown() {
 161         InMemoryJournal.clear();
 162         InMemorySnapshotStore.clear();
 163
 164         for(ActorSystem system: actorSystems) {
 165             JavaTestKit.shutdownActorSystem(system, null, Boolean.TRUE);
 166         }
 167     }
 168
 169     private ActorSystem newActorSystem(String config) {
 170         ActorSystem system = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig(config));
 171         actorSystems.add(system);
 172         return system;
 173     }
 174
 175     private Props newShardMgrProps() {
 176         return newShardMgrProps(new MockConfiguration());
 177     }
 178
 179     private static DatastoreContextFactory newDatastoreContextFactory(DatastoreContext datastoreContext) {
 180         DatastoreContextFactory mockFactory = mock(DatastoreContextFactory.class);
 181         Mockito.doReturn(datastoreContext).when(mockFactory).getBaseDatastoreContext();
 182         Mockito.doReturn(datastoreContext).when(mockFactory).getShardDatastoreContext(Mockito.anyString());
 183         return mockFactory;
 184     }
 185
 186     private TestShardManager.Builder newTestShardMgrBuilder() {
 187         return TestShardManager.builder(datastoreContextBuilder);
 188     }
 189
 190     private TestShardManager.Builder newTestShardMgrBuilder(Configuration config) {
 191         return TestShardManager.builder(datastoreContextBuilder).configuration(config);
 192     }
 193
 194     private Props newShardMgrProps(Configuration config) {
 195         return newTestShardMgrBuilder(config).props();
 196     }
 197
 198     private TestShardManager.Builder newTestShardMgrBuilderWithMockShardActor() {
 199         return TestShardManager.builder(datastoreContextBuilder).shardActor(mockShardActor);
 200     }
 201
 202     private Props newPropsShardMgrWithMockShardActor() {
 203         return newTestShardMgrBuilderWithMockShardActor().props();
 204     }
 205
 206     private TestShardManager newTestShardManager() {
 207         return newTestShardManager(newShardMgrProps());
 208     }
 209
 210     private TestShardManager newTestShardManager(Props props) {
 211         TestActorRef<TestShardManager> shardManagerActor = TestActorRef.create(getSystem(), props);
 212         TestShardManager shardManager = shardManagerActor.underlyingActor();
 213         shardManager.waitForRecoveryComplete();
 214         return shardManager;
 215     }
 216
 217     @Test
 218     public void testPerShardDatastoreContext() throws Exception {
 219         final DatastoreContextFactory mockFactory = newDatastoreContextFactory(
 220                 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
 221
 222         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 223                 shardElectionTimeoutFactor(6).build()).when(mockFactory).getShardDatastoreContext("default");
 224
 225         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 226                 shardElectionTimeoutFactor(7).build()).when(mockFactory).getShardDatastoreContext("topology");
 227
 228         final MockConfiguration mockConfig = new MockConfiguration() {
 229             @Override
 230             public Collection<String> getMemberShardNames(String memberName) {
 231                 return Arrays.asList("default", "topology");
 232             }
 233
 234             @Override
 235             public Collection<String> getMembersFromShardName(String shardName) {
 236                 return Arrays.asList("member-1");
 237             }
 238         };
 239
 240         final TestActorRef<MessageCollectorActor> defaultShardActor = TestActorRef.create(getSystem(),
 241                 Props.create(MessageCollectorActor.class), "default");
 242         final TestActorRef<MessageCollectorActor> topologyShardActor = TestActorRef.create(getSystem(),
 243                 Props.create(MessageCollectorActor.class), "topology");
 244
 245         final Map<String, Entry<ActorRef, DatastoreContext>> shardInfoMap = Collections.synchronizedMap(
 246                 new HashMap<String, Entry<ActorRef, DatastoreContext>>());
 247         shardInfoMap.put("default", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(defaultShardActor, null));
 248         shardInfoMap.put("topology", new AbstractMap.SimpleEntry<ActorRef, DatastoreContext>(topologyShardActor, null));
 249
 250         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 251         final CountDownLatch newShardActorLatch = new CountDownLatch(2);
 252         class LocalShardManager extends ShardManager {
 253             public LocalShardManager(AbstractBuilder<?> builder) {
 254                 super(builder);
 255             }
 256
 257             @Override
 258             protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
 259                 Entry<ActorRef, DatastoreContext> entry = shardInfoMap.get(info.getShardName());
 260                 ActorRef ref = null;
 261                 if(entry != null) {
 262                     ref = entry.getKey();
 263                     entry.setValue(info.getDatastoreContext());
 264                 }
 265
 266                 newShardActorLatch.countDown();
 267                 return ref;
 268             }
 269         }
 270
 271         final Creator<ShardManager> creator = new Creator<ShardManager>() {
 272             private static final long serialVersionUID = 1L;
 273             @Override
 274             public ShardManager create() throws Exception {
 275                 return new LocalShardManager(new GenericBuilder<LocalShardManager>(LocalShardManager.class).
 276                         datastoreContextFactory(mockFactory).primaryShardInfoCache(primaryShardInfoCache).
 277                         configuration(mockConfig));
 278             }
 279         };
 280
 281         JavaTestKit kit = new JavaTestKit(getSystem());
 282
 283         final ActorRef shardManager = getSystem().actorOf(Props.create(new DelegatingShardManagerCreator(creator)).
 284                     withDispatcher(Dispatchers.DefaultDispatcherId()));
 285
 286         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), kit.getRef());
 287
 288         assertEquals("Shard actors created", true, newShardActorLatch.await(5, TimeUnit.SECONDS));
 289         assertEquals("getShardElectionTimeoutFactor", 6, shardInfoMap.get("default").getValue().
 290                 getShardElectionTimeoutFactor());
 291         assertEquals("getShardElectionTimeoutFactor", 7, shardInfoMap.get("topology").getValue().
 292                 getShardElectionTimeoutFactor());
 293
 294         DatastoreContextFactory newMockFactory = newDatastoreContextFactory(
 295                 datastoreContextBuilder.shardElectionTimeoutFactor(5).build());
 296         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 297                 shardElectionTimeoutFactor(66).build()).when(newMockFactory).getShardDatastoreContext("default");
 298
 299         Mockito.doReturn(DatastoreContext.newBuilderFrom(datastoreContextBuilder.build()).
 300                 shardElectionTimeoutFactor(77).build()).when(newMockFactory).getShardDatastoreContext("topology");
 301
 302         shardManager.tell(newMockFactory, kit.getRef());
 303
 304         DatastoreContext newContext = MessageCollectorActor.expectFirstMatching(defaultShardActor, DatastoreContext.class);
 305         assertEquals("getShardElectionTimeoutFactor", 66, newContext.getShardElectionTimeoutFactor());
 306
 307         newContext = MessageCollectorActor.expectFirstMatching(topologyShardActor, DatastoreContext.class);
 308         assertEquals("getShardElectionTimeoutFactor", 77, newContext.getShardElectionTimeoutFactor());
 309
 310         defaultShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
 311         topologyShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
 312     }
 313
 314     @Test
 315     public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
 316         new JavaTestKit(getSystem()) {{
 317             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 318
 319             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 320
 321             shardManager.tell(new FindPrimary("non-existent", false), getRef());
 322
 323             expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 324         }};
 325     }
 326
 327     @Test
 328     public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
 329         new JavaTestKit(getSystem()) {{
 330             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 331
 332             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 333
 334             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 335             shardManager.tell(new ActorInitialized(), mockShardActor);
 336
 337             DataTree mockDataTree = mock(DataTree.class);
 338             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 339                     DataStoreVersions.CURRENT_VERSION), getRef());
 340
 341             MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
 342             shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
 343                     RaftState.Leader.name())), mockShardActor);
 344
 345             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 346
 347             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 348             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 349                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 350             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 351         }};
 352     }
 353
 354     @Test
 355     public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
 356         new JavaTestKit(getSystem()) {{
 357             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 358
 359             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 360             shardManager.tell(new ActorInitialized(), mockShardActor);
 361
 362             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 363             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 364             shardManager.tell(new RoleChangeNotification(memberId1,
 365                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 366             shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
 367
 368             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 369
 370             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 371         }};
 372     }
 373
 374     @Test
 375     public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
 376         new JavaTestKit(getSystem()) {{
 377             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 378
 379             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 380             shardManager.tell(new ActorInitialized(), mockShardActor);
 381
 382             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 383             MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
 384
 385             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 386             shardManager.tell(new RoleChangeNotification(memberId1,
 387                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 388             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 389             shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
 390                     leaderVersion), mockShardActor);
 391
 392             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 393
 394             RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 395             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 396                     primaryFound.getPrimaryPath().contains("member-2-shard-default"));
 397             assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
 398         }};
 399     }
 400
 401     @Test
 402     public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
 403         new JavaTestKit(getSystem()) {{
 404             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 405
 406             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 407
 408             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 409         }};
 410     }
 411
 412     @Test
 413     public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
 414         new JavaTestKit(getSystem()) {{
 415             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 416
 417             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 418             shardManager.tell(new ActorInitialized(), mockShardActor);
 419
 420             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 421
 422             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 423         }};
 424     }
 425
 426     @Test
 427     public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
 428         new JavaTestKit(getSystem()) {{
 429             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 430
 431             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 432             shardManager.tell(new ActorInitialized(), mockShardActor);
 433
 434             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 435             shardManager.tell(new RoleChangeNotification(memberId,
 436                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 437
 438             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 439
 440             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 441
 442             DataTree mockDataTree = mock(DataTree.class);
 443             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 444                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
 445
 446             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 447
 448             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 449             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 450                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 451             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree());
 452         }};
 453     }
 454
 455     @Test
 456     public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
 457         new JavaTestKit(getSystem()) {{
 458             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 459
 460             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 461
 462             // We're passing waitUntilInitialized = true to FindPrimary so the response should be
 463             // delayed until we send ActorInitialized and RoleChangeNotification.
 464             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 465
 466             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 467
 468             shardManager.tell(new ActorInitialized(), mockShardActor);
 469
 470             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 471
 472             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 473             shardManager.tell(new RoleChangeNotification(memberId,
 474                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
 475
 476             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 477
 478             DataTree mockDataTree = mock(DataTree.class);
 479             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 480                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
 481
 482             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 483             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 484                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 485             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
 486
 487             expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 488         }};
 489     }
 490
 491     @Test
 492     public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
 493         new JavaTestKit(getSystem()) {{
 494             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 495
 496             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 497
 498             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 499
 500             expectMsgClass(duration("2 seconds"), NotInitializedException.class);
 501
 502             shardManager.tell(new ActorInitialized(), mockShardActor);
 503
 504             expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 505         }};
 506     }
 507
 508     @Test
 509     public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
 510         new JavaTestKit(getSystem()) {{
 511             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 512
 513             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 514             shardManager.tell(new ActorInitialized(), mockShardActor);
 515             shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 516                     null, RaftState.Candidate.name()), mockShardActor);
 517
 518             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 519
 520             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 521         }};
 522     }
 523
 524     @Test
 525     public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
 526         new JavaTestKit(getSystem()) {{
 527             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 528
 529             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 530             shardManager.tell(new ActorInitialized(), mockShardActor);
 531             shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 532                     null, RaftState.IsolatedLeader.name()), mockShardActor);
 533
 534             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 535
 536             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 537         }};
 538     }
 539
 540     @Test
 541     public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
 542         new JavaTestKit(getSystem()) {{
 543             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 544
 545             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 546             shardManager.tell(new ActorInitialized(), mockShardActor);
 547
 548             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 549
 550             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 551         }};
 552     }
 553
 554     @Test
 555     public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
 556         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 557
 558         // Create an ActorSystem ShardManager actor for member-1.
 559
 560         final ActorSystem system1 = newActorSystem("Member1");
 561         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 562
 563         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 564                 newTestShardMgrBuilderWithMockShardActor().cluster(
 565                         new ClusterWrapperImpl(system1)).props(), shardManagerID);
 566
 567         // Create an ActorSystem ShardManager actor for member-2.
 568
 569         final ActorSystem system2 = newActorSystem("Member2");
 570
 571         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 572
 573         final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
 574
 575         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 576                 put("default", Arrays.asList("member-1", "member-2")).
 577                 put("astronauts", Arrays.asList("member-2")).build());
 578
 579         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 580                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 581                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
 582
 583         new JavaTestKit(system1) {{
 584
 585             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 586             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 587
 588             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 589
 590             String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
 591             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 592             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
 593                     Optional.of(mock(DataTree.class)), leaderVersion), mockShardActor2);
 594             shardManager2.tell(new RoleChangeNotification(memberId2,
 595                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 596
 597             shardManager1.underlyingActor().waitForMemberUp();
 598
 599             shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 600
 601             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 602             String path = found.getPrimaryPath();
 603             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
 604             assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
 605
 606             shardManager2.underlyingActor().verifyFindPrimary();
 607
 608             Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 609
 610             shardManager1.underlyingActor().waitForMemberRemoved();
 611
 612             shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 613
 614             expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 615         }};
 616     }
 617
 618     @Test
 619     public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
 620         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 621
 622         // Create an ActorSystem ShardManager actor for member-1.
 623
 624         final ActorSystem system1 = newActorSystem("Member1");
 625         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 626
 627         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 628
 629         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 630                 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(
 631                         new ClusterWrapperImpl(system1)).props(), shardManagerID);
 632
 633         // Create an ActorSystem ShardManager actor for member-2.
 634
 635         final ActorSystem system2 = newActorSystem("Member2");
 636
 637         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 638
 639         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 640
 641         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 642             put("default", Arrays.asList("member-1", "member-2")).build());
 643
 644         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 645                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 646                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
 647
 648         new JavaTestKit(system1) {{
 649
 650             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 651             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 652             shardManager1.tell(new ActorInitialized(), mockShardActor1);
 653             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 654
 655             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 656             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 657             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
 658                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 659             shardManager1.tell(new RoleChangeNotification(memberId1,
 660                 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
 661             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
 662                     DataStoreVersions.CURRENT_VERSION),
 663                 mockShardActor2);
 664             shardManager2.tell(new RoleChangeNotification(memberId2,
 665                 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 666             shardManager1.underlyingActor().waitForMemberUp();
 667
 668             shardManager1.tell(new FindPrimary("default", true), getRef());
 669
 670             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 671             String path = found.getPrimaryPath();
 672             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 673
 674             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 675                 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 676
 677             shardManager1.underlyingActor().waitForUnreachableMember();
 678
 679             PeerDown peerDown = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 680             assertEquals("getMemberName", "member-2", peerDown.getMemberName());
 681             MessageCollectorActor.clearMessages(mockShardActor1);
 682
 683             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 684                     createMemberRemoved("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 685
 686             MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 687
 688             shardManager1.tell(new FindPrimary("default", true), getRef());
 689
 690             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 691
 692             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 693                 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 694
 695             shardManager1.underlyingActor().waitForReachableMember();
 696
 697             PeerUp peerUp = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 698             assertEquals("getMemberName", "member-2", peerUp.getMemberName());
 699             MessageCollectorActor.clearMessages(mockShardActor1);
 700
 701             shardManager1.tell(new FindPrimary("default", true), getRef());
 702
 703             RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 704             String path1 = found1.getPrimaryPath();
 705             assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
 706
 707             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 708                     createMemberUp("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 709
 710             MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 711
 712         }};
 713     }
 714
 715     @Test
 716     public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
 717         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 718
 719         // Create an ActorSystem ShardManager actor for member-1.
 720
 721         final ActorSystem system1 = newActorSystem("Member1");
 722         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 723
 724         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 725
 726         final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 727         final TestActorRef<TestShardManager> shardManager1 = TestActorRef.create(system1,
 728                 newTestShardMgrBuilder().shardActor(mockShardActor1).cluster(
 729                         new ClusterWrapperImpl(system1)).primaryShardInfoCache(primaryShardInfoCache).props(),
 730                 shardManagerID);
 731
 732         // Create an ActorSystem ShardManager actor for member-2.
 733
 734         final ActorSystem system2 = newActorSystem("Member2");
 735
 736         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 737
 738         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 739
 740         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 741             put("default", Arrays.asList("member-1", "member-2")).build());
 742
 743         final TestActorRef<TestShardManager> shardManager2 = TestActorRef.create(system2,
 744                 newTestShardMgrBuilder(mockConfig2).shardActor(mockShardActor2).cluster(
 745                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
 746
 747         new JavaTestKit(system1) {{
 748             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 749             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 750             shardManager1.tell(new ActorInitialized(), mockShardActor1);
 751             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 752
 753             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 754             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 755             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
 756                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 757             shardManager1.tell(new RoleChangeNotification(memberId1,
 758                 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
 759             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
 760                     DataStoreVersions.CURRENT_VERSION),
 761                 mockShardActor2);
 762             shardManager2.tell(new RoleChangeNotification(memberId2,
 763                 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 764             shardManager1.underlyingActor().waitForMemberUp();
 765
 766             shardManager1.tell(new FindPrimary("default", true), getRef());
 767
 768             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 769             String path = found.getPrimaryPath();
 770             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 771
 772             primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
 773                     mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION, Optional.<DataTree>absent()));
 774
 775             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 776                 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 777
 778             shardManager1.underlyingActor().waitForUnreachableMember();
 779
 780             shardManager1.tell(new FindPrimary("default", true), getRef());
 781
 782             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 783
 784             assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
 785
 786             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
 787                     DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 788             shardManager1.tell(new RoleChangeNotification(memberId1,
 789                 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
 790
 791             shardManager1.tell(new FindPrimary("default", true), getRef());
 792
 793             LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 794             String path1 = found1.getPrimaryPath();
 795             assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
 796
 797         }};
 798     }
 799
 800
 801     @Test
 802     public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
 803         new JavaTestKit(getSystem()) {{
 804             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 805
 806             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 807
 808             shardManager.tell(new FindLocalShard("non-existent", false), getRef());
 809
 810             LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
 811
 812             assertEquals("getShardName", "non-existent", notFound.getShardName());
 813         }};
 814     }
 815
 816     @Test
 817     public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
 818         new JavaTestKit(getSystem()) {{
 819             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 820
 821             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 822             shardManager.tell(new ActorInitialized(), mockShardActor);
 823
 824             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
 825
 826             LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
 827
 828             assertTrue("Found path contains " + found.getPath().path().toString(),
 829                     found.getPath().path().toString().contains("member-1-shard-default-config"));
 830         }};
 831     }
 832
 833     @Test
 834     public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
 835         new JavaTestKit(getSystem()) {{
 836             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 837
 838             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
 839
 840             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 841         }};
 842     }
 843
 844     @Test
 845     public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
 846         new JavaTestKit(getSystem()) {{
 847             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 848
 849             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 850
 851             // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
 852             // delayed until we send ActorInitialized.
 853             Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
 854                     new Timeout(5, TimeUnit.SECONDS));
 855
 856             shardManager.tell(new ActorInitialized(), mockShardActor);
 857
 858             Object resp = Await.result(future, duration("5 seconds"));
 859             assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
 860         }};
 861     }
 862
 863     @Test
 864     public void testOnRecoveryJournalIsCleaned() {
 865         String persistenceID = "shard-manager-" + shardMrgIDSuffix;
 866         InMemoryJournal.addEntry(persistenceID, 1L, new ShardManager.SchemaContextModules(
 867                 ImmutableSet.of("foo")));
 868         InMemoryJournal.addEntry(persistenceID, 2L, new ShardManager.SchemaContextModules(
 869                 ImmutableSet.of("bar")));
 870         InMemoryJournal.addDeleteMessagesCompleteLatch(persistenceID);
 871
 872         TestShardManager shardManager = newTestShardManager();
 873
 874         InMemoryJournal.waitForDeleteMessagesComplete(persistenceID);
 875
 876         // Journal entries up to the last one should've been deleted
 877         Map<Long, Object> journal = InMemoryJournal.get(persistenceID);
 878         synchronized (journal) {
 879             assertEquals("Journal size", 0, journal.size());
 880         }
 881     }
 882
 883     @Test
 884     public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
 885         TestShardManager shardManager = newTestShardManager();
 886
 887         String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 888         shardManager.onReceiveCommand(new RoleChangeNotification(
 889                 memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
 890
 891         verify(ready, never()).countDown();
 892
 893         shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
 894                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
 895
 896         verify(ready, times(1)).countDown();
 897     }
 898
 899     @Test
 900     public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
 901         new JavaTestKit(getSystem()) {{
 902             TestShardManager shardManager = newTestShardManager();
 903
 904             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 905             shardManager.onReceiveCommand(new RoleChangeNotification(
 906                     memberId, null, RaftState.Follower.name()));
 907
 908             verify(ready, never()).countDown();
 909
 910             shardManager.onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
 911
 912             shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId,
 913                     "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
 914                     DataStoreVersions.CURRENT_VERSION));
 915
 916             verify(ready, times(1)).countDown();
 917         }};
 918     }
 919
 920     @Test
 921     public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
 922         new JavaTestKit(getSystem()) {{
 923             TestShardManager shardManager = newTestShardManager();
 924
 925             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 926             shardManager.onReceiveCommand(new RoleChangeNotification(memberId, null, RaftState.Follower.name()));
 927
 928             verify(ready, never()).countDown();
 929
 930             shardManager.onReceiveCommand(new ShardLeaderStateChanged(memberId,
 931                     "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
 932                     DataStoreVersions.CURRENT_VERSION));
 933
 934             shardManager.onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
 935
 936             verify(ready, times(1)).countDown();
 937         }};
 938     }
 939
 940     @Test
 941     public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
 942         TestShardManager shardManager = newTestShardManager();
 943
 944         shardManager.onReceiveCommand(new RoleChangeNotification(
 945                 "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
 946
 947         verify(ready, never()).countDown();
 948     }
 949
 950     @Test
 951     public void testByDefaultSyncStatusIsFalse() throws Exception{
 952         TestShardManager shardManager = newTestShardManager();
 953
 954         assertEquals(false, shardManager.getMBean().getSyncStatus());
 955     }
 956
 957     @Test
 958     public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
 959         TestShardManager shardManager = newTestShardManager();
 960
 961         shardManager.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 962                 RaftState.Follower.name(), RaftState.Leader.name()));
 963
 964         assertEquals(true, shardManager.getMBean().getSyncStatus());
 965     }
 966
 967     @Test
 968     public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
 969         TestShardManager shardManager = newTestShardManager();
 970
 971         String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
 972         shardManager.onReceiveCommand(new RoleChangeNotification(shardId,
 973                 RaftState.Follower.name(), RaftState.Candidate.name()));
 974
 975         assertEquals(false, shardManager.getMBean().getSyncStatus());
 976
 977         // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
 978         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(
 979                 true, shardId));
 980
 981         assertEquals(false, shardManager.getMBean().getSyncStatus());
 982     }
 983
 984     @Test
 985     public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
 986         TestShardManager shardManager = newTestShardManager();
 987
 988         String shardId = "member-1-shard-default-" + shardMrgIDSuffix;
 989         shardManager.onReceiveCommand(new RoleChangeNotification(shardId,
 990                 RaftState.Candidate.name(), RaftState.Follower.name()));
 991
 992         // Initially will be false
 993         assertEquals(false, shardManager.getMBean().getSyncStatus());
 994
 995         // Send status true will make sync status true
 996         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(true, shardId));
 997
 998         assertEquals(true, shardManager.getMBean().getSyncStatus());
 999
1000         // Send status false will make sync status false
1001         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(false, shardId));
1002
1003         assertEquals(false, shardManager.getMBean().getSyncStatus());
1004
1005     }
1006
1007     @Test
1008     public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
1009         TestShardManager shardManager = newTestShardManager(newShardMgrProps(new MockConfiguration() {
1010             @Override
1011             public List<String> getMemberShardNames(String memberName) {
1012                 return Arrays.asList("default", "astronauts");
1013             }
1014         }));
1015
1016         // Initially will be false
1017         assertEquals(false, shardManager.getMBean().getSyncStatus());
1018
1019         // Make default shard leader
1020         String defaultShardId = "member-1-shard-default-" + shardMrgIDSuffix;
1021         shardManager.onReceiveCommand(new RoleChangeNotification(defaultShardId,
1022                 RaftState.Follower.name(), RaftState.Leader.name()));
1023
1024         // default = Leader, astronauts is unknown so sync status remains false
1025         assertEquals(false, shardManager.getMBean().getSyncStatus());
1026
1027         // Make astronauts shard leader as well
1028         String astronautsShardId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1029         shardManager.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1030                 RaftState.Follower.name(), RaftState.Leader.name()));
1031
1032         // Now sync status should be true
1033         assertEquals(true, shardManager.getMBean().getSyncStatus());
1034
1035         // Make astronauts a Follower
1036         shardManager.onReceiveCommand(new RoleChangeNotification(astronautsShardId,
1037                 RaftState.Leader.name(), RaftState.Follower.name()));
1038
1039         // Sync status is not true
1040         assertEquals(false, shardManager.getMBean().getSyncStatus());
1041
1042         // Make the astronauts follower sync status true
1043         shardManager.onReceiveCommand(new FollowerInitialSyncUpStatus(true, astronautsShardId));
1044
1045         // Sync status is now true
1046         assertEquals(true, shardManager.getMBean().getSyncStatus());
1047
1048     }
1049
1050     @Test
1051     public void testOnReceiveSwitchShardBehavior() throws Exception {
1052         new JavaTestKit(getSystem()) {{
1053             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
1054
1055             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1056             shardManager.tell(new ActorInitialized(), mockShardActor);
1057
1058             shardManager.tell(new SwitchShardBehavior(mockShardName, "Leader", 1000), getRef());
1059
1060             SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor, SwitchBehavior.class);
1061
1062             assertEquals(RaftState.Leader, switchBehavior.getNewState());
1063             assertEquals(1000, switchBehavior.getNewTerm());
1064         }};
1065     }
1066
1067     @Test
1068     public void testOnCreateShard() {
1069         new JavaTestKit(getSystem()) {{
1070             datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1071
1072             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1073                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1074
1075             SchemaContext schemaContext = TestModel.createTestContext();
1076             shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1077
1078             DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100).
1079                     persistent(false).build();
1080             Shard.Builder shardBuilder = Shard.builder();
1081
1082             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1083                     "foo", null, Arrays.asList("member-1", "member-5", "member-6"));
1084             shardManager.tell(new CreateShard(config, shardBuilder, datastoreContext), getRef());
1085
1086             expectMsgClass(duration("5 seconds"), Success.class);
1087
1088             shardManager.tell(new FindLocalShard("foo", true), getRef());
1089
1090             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1091
1092             assertEquals("isRecoveryApplicable", false, shardBuilder.getDatastoreContext().isPersistent());
1093             assertTrue("Epxected ShardPeerAddressResolver", shardBuilder.getDatastoreContext().getShardRaftConfig().
1094                     getPeerAddressResolver() instanceof ShardPeerAddressResolver);
1095             assertEquals("peerMembers", Sets.newHashSet(new ShardIdentifier("foo", "member-5", shardMrgIDSuffix).toString(),
1096                     new ShardIdentifier("foo", "member-6", shardMrgIDSuffix).toString()),
1097                     shardBuilder.getPeerAddresses().keySet());
1098             assertEquals("ShardIdentifier", new ShardIdentifier("foo", "member-1", shardMrgIDSuffix),
1099                     shardBuilder.getId());
1100             assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1101
1102             // Send CreateShard with same name - should return Success with a message.
1103
1104             shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1105
1106             Success success = expectMsgClass(duration("5 seconds"), Success.class);
1107             assertNotNull("Success status is null", success.status());
1108         }};
1109     }
1110
1111     @Test
1112     public void testOnCreateShardWithLocalMemberNotInShardConfig() {
1113         new JavaTestKit(getSystem()) {{
1114             datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
1115
1116             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1117                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1118
1119             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1120
1121             Shard.Builder shardBuilder = Shard.builder();
1122             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1123                     "foo", null, Arrays.asList("member-5", "member-6"));
1124
1125             shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1126             expectMsgClass(duration("5 seconds"), Success.class);
1127
1128             shardManager.tell(new FindLocalShard("foo", true), getRef());
1129             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1130
1131             assertEquals("peerMembers size", 0, shardBuilder.getPeerAddresses().size());
1132             assertEquals("schemaContext", DisableElectionsRaftPolicy.class.getName(),
1133                     shardBuilder.getDatastoreContext().getShardRaftConfig().getCustomRaftPolicyImplementationClass());
1134         }};
1135     }
1136
1137     @Test
1138     public void testOnCreateShardWithNoInitialSchemaContext() {
1139         new JavaTestKit(getSystem()) {{
1140             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1141                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1142
1143             Shard.Builder shardBuilder = Shard.builder();
1144
1145             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1146                     "foo", null, Arrays.asList("member-1"));
1147             shardManager.tell(new CreateShard(config, shardBuilder, null), getRef());
1148
1149             expectMsgClass(duration("5 seconds"), Success.class);
1150
1151             SchemaContext schemaContext = TestModel.createTestContext();
1152             shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1153
1154             shardManager.tell(new FindLocalShard("foo", true), getRef());
1155
1156             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1157
1158             assertSame("schemaContext", schemaContext, shardBuilder.getSchemaContext());
1159             assertNotNull("schemaContext is null", shardBuilder.getDatastoreContext());
1160         }};
1161     }
1162
1163     @Test
1164     public void testGetSnapshot() throws Throwable {
1165         JavaTestKit kit = new JavaTestKit(getSystem());
1166
1167         MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1168                    put("shard1", Arrays.asList("member-1")).
1169                    put("shard2", Arrays.asList("member-1")).build());
1170
1171         ActorRef shardManager = getSystem().actorOf(newShardMgrProps(mockConfig).withDispatcher(
1172                 Dispatchers.DefaultDispatcherId()));
1173
1174         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1175         Failure failure = kit.expectMsgClass(Failure.class);
1176         assertEquals("Failure cause type", IllegalStateException.class, failure.cause().getClass());
1177
1178         kit = new JavaTestKit(getSystem());
1179
1180         shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), ActorRef.noSender());
1181
1182         shardManager.tell(new FindLocalShard("shard1", true), kit.getRef());
1183         kit.expectMsgClass(LocalShardFound.class);
1184         shardManager.tell(new FindLocalShard("shard2", true), kit.getRef());
1185         kit.expectMsgClass(LocalShardFound.class);
1186
1187         shardManager.tell(GetSnapshot.INSTANCE, kit.getRef());
1188
1189         DatastoreSnapshot datastoreSnapshot = kit.expectMsgClass(DatastoreSnapshot.class);
1190
1191         assertEquals("getType", shardMrgIDSuffix, datastoreSnapshot.getType());
1192         assertNull("Expected null ShardManagerSnapshot", datastoreSnapshot.getShardManagerSnapshot());
1193
1194         Function<ShardSnapshot, String> shardNameTransformer = new Function<ShardSnapshot, String>() {
1195             @Override
1196             public String apply(ShardSnapshot s) {
1197                 return s.getName();
1198             }
1199         };
1200
1201         assertEquals("Shard names", Sets.newHashSet("shard1", "shard2"), Sets.newHashSet(
1202                 Lists.transform(datastoreSnapshot.getShardSnapshots(), shardNameTransformer)));
1203
1204         shardManager.tell(PoisonPill.getInstance(), ActorRef.noSender());
1205     }
1206
1207     @Test
1208     public void testAddShardReplicaForNonExistentShardConfig() throws Exception {
1209         new JavaTestKit(getSystem()) {{
1210             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1211                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1212
1213             shardManager.tell(new AddShardReplica("model-inventory"), getRef());
1214             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1215
1216             assertEquals("Failure obtained", true,
1217                           (resp.cause() instanceof IllegalArgumentException));
1218         }};
1219     }
1220
1221     @Test
1222     public void testAddShardReplica() throws Exception {
1223         MockConfiguration mockConfig =
1224                 new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1225                    put("default", Arrays.asList("member-1", "member-2")).
1226                    put("astronauts", Arrays.asList("member-2")).build());
1227
1228         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
1229
1230         // Create an ActorSystem ShardManager actor for member-1.
1231         final ActorSystem system1 = newActorSystem("Member1");
1232         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1233         ActorRef mockDefaultShardActor = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
1234         final TestActorRef<TestShardManager> newReplicaShardManager = TestActorRef.create(system1,
1235                 newTestShardMgrBuilder(mockConfig).shardActor(mockDefaultShardActor).cluster(
1236                         new ClusterWrapperImpl(system1)).props(), shardManagerID);
1237
1238         // Create an ActorSystem ShardManager actor for member-2.
1239         final ActorSystem system2 = newActorSystem("Member2");
1240         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
1241
1242         String name = new ShardIdentifier("astronauts", "member-2", "config").toString();
1243         final TestActorRef<MockRespondActor> mockShardLeaderActor =
1244                 TestActorRef.create(system2, Props.create(MockRespondActor.class), name);
1245         final TestActorRef<TestShardManager> leaderShardManager = TestActorRef.create(system2,
1246                 newTestShardMgrBuilder(mockConfig).shardActor(mockShardLeaderActor).cluster(
1247                         new ClusterWrapperImpl(system2)).props(), shardManagerID);
1248
1249         new JavaTestKit(system1) {{
1250
1251             newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1252             leaderShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1253
1254             leaderShardManager.tell(new ActorInitialized(), mockShardLeaderActor);
1255
1256             String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
1257             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
1258             leaderShardManager.tell(new ShardLeaderStateChanged(memberId2, memberId2,
1259                     Optional.of(mock(DataTree.class)), leaderVersion), mockShardLeaderActor);
1260             leaderShardManager.tell(new RoleChangeNotification(memberId2,
1261                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardLeaderActor);
1262
1263             newReplicaShardManager.underlyingActor().waitForMemberUp();
1264             leaderShardManager.underlyingActor().waitForMemberUp();
1265
1266             //construct a mock response message
1267             AddServerReply response = new AddServerReply(ServerChangeStatus.OK, memberId2);
1268             mockShardLeaderActor.underlyingActor().updateResponse(response);
1269             newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1270             AddServer addServerMsg = MessageCollectorActor.expectFirstMatching(mockShardLeaderActor,
1271                 AddServer.class);
1272             String addServerId = "member-1-shard-astronauts-" + shardMrgIDSuffix;
1273             assertEquals("AddServer serverId", addServerId, addServerMsg.getNewServerId());
1274             newReplicaShardManager.underlyingActor()
1275                 .verifySnapshotPersisted(Sets.newHashSet("default", "astronauts"));
1276             expectMsgClass(duration("5 seconds"), Status.Success.class);
1277         }};
1278     }
1279
1280     @Test
1281     public void testAddShardReplicaWithPreExistingReplicaInRemoteShardLeader() throws Exception {
1282         new JavaTestKit(getSystem()) {{
1283             TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
1284                     newPropsShardMgrWithMockShardActor(), shardMgrID);
1285
1286             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1287             shardManager.tell(new ActorInitialized(), mockShardActor);
1288
1289             String leaderId = "leader-member-shard-default-" + shardMrgIDSuffix;
1290             AddServerReply addServerReply = new AddServerReply(ServerChangeStatus.ALREADY_EXISTS, null);
1291             ActorRef leaderShardActor = shardManager.underlyingActor().getContext().actorOf(
1292                     Props.create(MockRespondActor.class, addServerReply), leaderId);
1293
1294             MockClusterWrapper.sendMemberUp(shardManager, "leader-member", leaderShardActor.path().toString());
1295
1296             String newReplicaId = "member-1-shard-default-" + shardMrgIDSuffix;
1297             shardManager.tell(new RoleChangeNotification(newReplicaId,
1298                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
1299             shardManager.tell(new ShardLeaderStateChanged(newReplicaId, leaderId, Optional.<DataTree>absent(),
1300                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
1301
1302             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1303
1304             MessageCollectorActor.expectFirstMatching(leaderShardActor, AddServer.class);
1305
1306             Failure resp = expectMsgClass(duration("5 seconds"), Failure.class);
1307             assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1308
1309             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1310             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1311
1312             // Send message again to verify previous in progress state is cleared
1313
1314             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1315             resp = expectMsgClass(duration("5 seconds"), Failure.class);
1316             assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1317
1318             // Send message again with an AddServer timeout to verify the pre-existing shard actor isn't terminated.
1319
1320             shardManager.tell(newDatastoreContextFactory(datastoreContextBuilder.
1321                     shardLeaderElectionTimeout(100, TimeUnit.MILLISECONDS).build()), getRef());
1322             leaderShardActor.tell(MockRespondActor.CLEAR_RESPONSE, ActorRef.noSender());
1323             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1324             expectMsgClass(duration("5 seconds"), Failure.class);
1325
1326             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1327             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1328
1329             leaderShardActor.tell(PoisonPill.getInstance(), ActorRef.noSender());
1330         }};
1331     }
1332
1333     @Test
1334     public void testAddShardReplicaWithPreExistingLocalReplicaLeader() throws Exception {
1335         new JavaTestKit(getSystem()) {{
1336             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
1337             ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
1338
1339             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1340             shardManager.tell(new ActorInitialized(), mockShardActor);
1341             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mock(DataTree.class)),
1342                     DataStoreVersions.CURRENT_VERSION), getRef());
1343             shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
1344                     RaftState.Leader.name())), mockShardActor);
1345
1346             shardManager.tell(new AddShardReplica(Shard.DEFAULT_NAME), getRef());
1347             Failure resp = expectMsgClass(duration("5 seconds"), Failure.class);
1348             assertEquals("Failure cause", AlreadyExistsException.class, resp.cause().getClass());
1349
1350             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
1351             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1352         }};
1353     }
1354
1355     @Test
1356     public void testAddShardReplicaWithAddServerReplyFailure() throws Exception {
1357         new JavaTestKit(getSystem()) {{
1358             JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1359
1360             MockConfiguration mockConfig =
1361                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1362                        put("astronauts", Arrays.asList("member-2")).build());
1363
1364             ActorRef mockNewReplicaShardActor = newMockShardActor(getSystem(), "astronauts", "member-1");
1365             final TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
1366                     newTestShardMgrBuilder(mockConfig).shardActor(mockNewReplicaShardActor).props(), shardMgrID);
1367             shardManager.underlyingActor().setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1368
1369             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1370
1371             JavaTestKit terminateWatcher = new JavaTestKit(getSystem());
1372             terminateWatcher.watch(mockNewReplicaShardActor);
1373
1374             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1375
1376             AddServer addServerMsg = mockShardLeaderKit.expectMsgClass(AddServer.class);
1377             assertEquals("AddServer serverId", "member-1-shard-astronauts-" + shardMrgIDSuffix,
1378                     addServerMsg.getNewServerId());
1379             mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.TIMEOUT, null));
1380
1381             Failure failure = expectMsgClass(duration("5 seconds"), Failure.class);
1382             assertEquals("Failure cause", TimeoutException.class, failure.cause().getClass());
1383
1384             shardManager.tell(new FindLocalShard("astronauts", false), getRef());
1385             expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
1386
1387             terminateWatcher.expectTerminated(mockNewReplicaShardActor);
1388
1389             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1390             mockShardLeaderKit.expectMsgClass(AddServer.class);
1391             mockShardLeaderKit.reply(new AddServerReply(ServerChangeStatus.NO_LEADER, null));
1392             failure = expectMsgClass(duration("5 seconds"), Failure.class);
1393             assertEquals("Failure cause", NoShardLeaderException.class, failure.cause().getClass());
1394         }};
1395     }
1396
1397     @Test
1398     public void testAddShardReplicaWithAlreadyInProgress() throws Exception {
1399         new JavaTestKit(getSystem()) {{
1400             JavaTestKit mockShardLeaderKit = new JavaTestKit(getSystem());
1401             JavaTestKit secondRequestKit = new JavaTestKit(getSystem());
1402
1403             MockConfiguration mockConfig =
1404                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1405                        put("astronauts", Arrays.asList("member-2")).build());
1406
1407             final TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
1408                     newTestShardMgrBuilder(mockConfig).shardActor(mockShardActor).props(), shardMgrID);
1409             shardManager.underlyingActor().setMessageInterceptor(newFindPrimaryInterceptor(mockShardLeaderKit.getRef()));
1410
1411             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1412
1413             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1414
1415             mockShardLeaderKit.expectMsgClass(AddServer.class);
1416
1417             shardManager.tell(new AddShardReplica("astronauts"), secondRequestKit.getRef());
1418
1419             secondRequestKit.expectMsgClass(duration("5 seconds"), Failure.class);
1420         }};
1421     }
1422
1423     @Test
1424     public void testAddShardReplicaWithFindPrimaryTimeout() throws Exception {
1425         new JavaTestKit(getSystem()) {{
1426             MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1427                        put("astronauts", Arrays.asList("member-2")).build());
1428
1429             final ActorRef newReplicaShardManager = getSystem().actorOf(newTestShardMgrBuilder(mockConfig).
1430                     shardActor(mockShardActor).props(), shardMgrID);
1431
1432             newReplicaShardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
1433             MockClusterWrapper.sendMemberUp(newReplicaShardManager, "member-2", getRef().path().toString());
1434
1435             newReplicaShardManager.tell(new AddShardReplica("astronauts"), getRef());
1436             Status.Failure resp = expectMsgClass(duration("5 seconds"), Status.Failure.class);
1437             assertEquals("Failure obtained", true,
1438                           (resp.cause() instanceof RuntimeException));
1439         }};
1440     }
1441
1442     @Test
1443     public void testRemoveShardReplicaForNonExistentShard() throws Exception {
1444         new JavaTestKit(getSystem()) {{
1445             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1446                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1447
1448             shardManager.tell(new RemoveShardReplica("model-inventory"), getRef());
1449             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1450             assertEquals("Failure obtained", true,
1451                          (resp.cause() instanceof IllegalArgumentException));
1452         }};
1453
1454     }
1455
1456     @Test
1457     public void testServerRemovedShardActorNotRunning() throws Exception {
1458         new JavaTestKit(getSystem()) {{
1459             MockConfiguration mockConfig =
1460                     new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1461                             put("default", Arrays.asList("member-1", "member-2")).
1462                             put("astronauts", Arrays.asList("member-2")).
1463                             put("people", Arrays.asList("member-1", "member-2")).build());
1464
1465             TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
1466                     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 = TestActorRef.create(getSystem(), MessageCollectorActor.props());
1495
1496             TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
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 = TestActorRef.create(getSystem(),
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 }