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

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.cluster.datastore;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertSame;
  15 import static org.junit.Assert.assertTrue;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.never;
  18 import static org.mockito.Mockito.times;
  19 import static org.mockito.Mockito.verify;
  20 import akka.actor.ActorRef;
  21 import akka.actor.ActorSystem;
  22 import akka.actor.AddressFromURIString;
  23 import akka.actor.Props;
  24 import akka.actor.Status;
  25 import akka.cluster.Cluster;
  26 import akka.cluster.ClusterEvent;
  27 import akka.dispatch.Dispatchers;
  28 import akka.japi.Creator;
  29 import akka.pattern.Patterns;
  30 import akka.persistence.RecoveryCompleted;
  31 import akka.testkit.JavaTestKit;
  32 import akka.testkit.TestActorRef;
  33 import akka.util.Timeout;
  34 import com.google.common.base.Optional;
  35 import com.google.common.collect.ImmutableMap;
  36 import com.google.common.collect.ImmutableSet;
  37 import com.google.common.collect.Sets;
  38 import com.google.common.util.concurrent.Uninterruptibles;
  39 import com.typesafe.config.ConfigFactory;
  40 import java.net.URI;
  41 import java.util.Arrays;
  42 import java.util.List;
  43 import java.util.Map;
  44 import java.util.concurrent.CountDownLatch;
  45 import java.util.concurrent.TimeUnit;
  46 import org.junit.After;
  47 import org.junit.Before;
  48 import org.junit.Test;
  49 import org.mockito.Mock;
  50 import org.mockito.MockitoAnnotations;
  51 import org.opendaylight.controller.cluster.datastore.config.Configuration;
  52 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
  53 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
  54 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfiguration;
  55 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  56 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
  57 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
  58 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  59 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
  60 import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized;
  61 import org.opendaylight.controller.cluster.datastore.messages.AddShardReplica;
  62 import org.opendaylight.controller.cluster.datastore.messages.CreateShard;
  63 import org.opendaylight.controller.cluster.datastore.messages.CreateShardReply;
  64 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
  65 import org.opendaylight.controller.cluster.datastore.messages.FindPrimary;
  66 import org.opendaylight.controller.cluster.datastore.messages.LocalPrimaryShardFound;
  67 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
  68 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
  69 import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
  70 import org.opendaylight.controller.cluster.datastore.messages.PeerUp;
  71 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
  72 import org.opendaylight.controller.cluster.datastore.messages.RemotePrimaryShardFound;
  73 import org.opendaylight.controller.cluster.datastore.messages.RemoveShardReplica;
  74 import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged;
  75 import org.opendaylight.controller.cluster.datastore.messages.SwitchShardBehavior;
  76 import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext;
  77 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
  78 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
  79 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
  80 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
  81 import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener;
  82 import org.opendaylight.controller.cluster.notifications.RoleChangeNotification;
  83 import org.opendaylight.controller.cluster.raft.RaftState;
  84 import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus;
  85 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
  86 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  87 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
  88 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
  89 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  90 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  91 import scala.concurrent.Await;
  92 import scala.concurrent.Future;
  93 import scala.concurrent.duration.FiniteDuration;
  94
  95 public class ShardManagerTest extends AbstractActorTest {
  96     private static int ID_COUNTER = 1;
  97
  98     private final String shardMrgIDSuffix = "config" + ID_COUNTER++;
  99     private final String shardMgrID = "shard-manager-" + shardMrgIDSuffix;
 100
 101     @Mock
 102     private static CountDownLatch ready;
 103
 104     private static TestActorRef<MessageCollectorActor> mockShardActor;
 105
 106     private static String mockShardName;
 107
 108     private final DatastoreContext.Builder datastoreContextBuilder = DatastoreContext.newBuilder().
 109             dataStoreType(shardMrgIDSuffix).shardInitializationTimeout(600, TimeUnit.MILLISECONDS)
 110                    .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(6);
 111
 112     private static ActorRef newMockShardActor(ActorSystem system, String shardName, String memberName) {
 113         String name = new ShardIdentifier(shardName, memberName,"config").toString();
 114         return TestActorRef.create(system, Props.create(MessageCollectorActor.class), name);
 115     }
 116
 117     private final PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
 118
 119     @Before
 120     public void setUp() {
 121         MockitoAnnotations.initMocks(this);
 122
 123         InMemoryJournal.clear();
 124
 125         if(mockShardActor == null) {
 126             mockShardName = new ShardIdentifier(Shard.DEFAULT_NAME, "member-1", "config").toString();
 127             mockShardActor = TestActorRef.create(getSystem(), Props.create(MessageCollectorActor.class), mockShardName);
 128         }
 129
 130         mockShardActor.underlyingActor().clear();
 131     }
 132
 133     @After
 134     public void tearDown() {
 135         InMemoryJournal.clear();
 136     }
 137
 138     private Props newShardMgrProps() {
 139         return newShardMgrProps(new MockConfiguration());
 140     }
 141
 142     private Props newShardMgrProps(Configuration config) {
 143         return ShardManager.props(new MockClusterWrapper(), config, datastoreContextBuilder.build(), ready,
 144                 primaryShardInfoCache);
 145     }
 146
 147     private Props newPropsShardMgrWithMockShardActor() {
 148         return newPropsShardMgrWithMockShardActor("shardManager", mockShardActor, new MockClusterWrapper(),
 149                 new MockConfiguration());
 150     }
 151
 152     private Props newPropsShardMgrWithMockShardActor(final String name, final ActorRef shardActor,
 153             final ClusterWrapper clusterWrapper, final Configuration config) {
 154         Creator<ShardManager> creator = new Creator<ShardManager>() {
 155             private static final long serialVersionUID = 1L;
 156             @Override
 157             public ShardManager create() throws Exception {
 158                 return new ForwardingShardManager(clusterWrapper, config, datastoreContextBuilder.build(),
 159                         ready, name, shardActor, primaryShardInfoCache);
 160             }
 161         };
 162
 163         return Props.create(new DelegatingShardManagerCreator(creator)).withDispatcher(Dispatchers.DefaultDispatcherId());
 164     }
 165
 166     @Test
 167     public void testOnReceiveFindPrimaryForNonExistentShard() throws Exception {
 168         new JavaTestKit(getSystem()) {{
 169             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 170
 171             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 172
 173             shardManager.tell(new FindPrimary("non-existent", false), getRef());
 174
 175             expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 176         }};
 177     }
 178
 179     @Test
 180     public void testOnReceiveFindPrimaryForLocalLeaderShard() throws Exception {
 181         new JavaTestKit(getSystem()) {{
 182             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 183
 184             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 185
 186             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 187             shardManager.tell(new ActorInitialized(), mockShardActor);
 188
 189             DataTree mockDataTree = mock(DataTree.class);
 190             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 191                     DataStoreVersions.CURRENT_VERSION), getRef());
 192
 193             MessageCollectorActor.expectFirstMatching(mockShardActor, RegisterRoleChangeListener.class);
 194             shardManager.tell((new RoleChangeNotification(memberId, RaftState.Candidate.name(),
 195                     RaftState.Leader.name())), mockShardActor);
 196
 197             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 198
 199             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 200             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 201                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 202             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
 203         }};
 204     }
 205
 206     @Test
 207     public void testOnReceiveFindPrimaryForNonLocalLeaderShardBeforeMemberUp() throws Exception {
 208         new JavaTestKit(getSystem()) {{
 209             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 210
 211             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 212             shardManager.tell(new ActorInitialized(), mockShardActor);
 213
 214             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 215             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 216             shardManager.tell(new RoleChangeNotification(memberId1,
 217                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 218             shardManager.tell(new LeaderStateChanged(memberId1, memberId2, DataStoreVersions.CURRENT_VERSION), mockShardActor);
 219
 220             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 221
 222             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 223         }};
 224     }
 225
 226     @Test
 227     public void testOnReceiveFindPrimaryForNonLocalLeaderShard() throws Exception {
 228         new JavaTestKit(getSystem()) {{
 229             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 230
 231             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 232             shardManager.tell(new ActorInitialized(), mockShardActor);
 233
 234             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 235             MockClusterWrapper.sendMemberUp(shardManager, "member-2", getRef().path().toString());
 236
 237             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 238             shardManager.tell(new RoleChangeNotification(memberId1,
 239                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 240             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 241             shardManager.tell(new ShardLeaderStateChanged(memberId1, memberId2, Optional.<DataTree>absent(),
 242                     leaderVersion), mockShardActor);
 243
 244             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 245
 246             RemotePrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 247             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 248                     primaryFound.getPrimaryPath().contains("member-2-shard-default"));
 249             assertEquals("getPrimaryVersion", leaderVersion, primaryFound.getPrimaryVersion());
 250         }};
 251     }
 252
 253     @Test
 254     public void testOnReceiveFindPrimaryForUninitializedShard() throws Exception {
 255         new JavaTestKit(getSystem()) {{
 256             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 257
 258             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 259
 260             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 261         }};
 262     }
 263
 264     @Test
 265     public void testOnReceiveFindPrimaryForInitializedShardWithNoRole() throws Exception {
 266         new JavaTestKit(getSystem()) {{
 267             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 268
 269             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 270             shardManager.tell(new ActorInitialized(), mockShardActor);
 271
 272             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 273
 274             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 275         }};
 276     }
 277
 278     @Test
 279     public void testOnReceiveFindPrimaryForFollowerShardWithNoInitialLeaderId() throws Exception {
 280         new JavaTestKit(getSystem()) {{
 281             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 282
 283             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 284             shardManager.tell(new ActorInitialized(), mockShardActor);
 285
 286             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 287             shardManager.tell(new RoleChangeNotification(memberId,
 288                     RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor);
 289
 290             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 291
 292             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 293
 294             DataTree mockDataTree = mock(DataTree.class);
 295             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 296                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
 297
 298             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, false), getRef());
 299
 300             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 301             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 302                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 303             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
 304         }};
 305     }
 306
 307     @Test
 308     public void testOnReceiveFindPrimaryWaitForShardLeader() throws Exception {
 309         new JavaTestKit(getSystem()) {{
 310             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 311
 312             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 313
 314             // We're passing waitUntilInitialized = true to FindPrimary so the response should be
 315             // delayed until we send ActorInitialized and RoleChangeNotification.
 316             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 317
 318             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 319
 320             shardManager.tell(new ActorInitialized(), mockShardActor);
 321
 322             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 323
 324             String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 325             shardManager.tell(new RoleChangeNotification(memberId,
 326                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor);
 327
 328             expectNoMsg(FiniteDuration.create(150, TimeUnit.MILLISECONDS));
 329
 330             DataTree mockDataTree = mock(DataTree.class);
 331             shardManager.tell(new ShardLeaderStateChanged(memberId, memberId, Optional.of(mockDataTree),
 332                     DataStoreVersions.CURRENT_VERSION), mockShardActor);
 333
 334             LocalPrimaryShardFound primaryFound = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 335             assertTrue("Unexpected primary path " +  primaryFound.getPrimaryPath(),
 336                     primaryFound.getPrimaryPath().contains("member-1-shard-default"));
 337             assertSame("getLocalShardDataTree", mockDataTree, primaryFound.getLocalShardDataTree() );
 338
 339             expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 340         }};
 341     }
 342
 343     @Test
 344     public void testOnReceiveFindPrimaryWaitForReadyWithUninitializedShard() throws Exception {
 345         new JavaTestKit(getSystem()) {{
 346             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 347
 348             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 349
 350             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 351
 352             expectMsgClass(duration("2 seconds"), NotInitializedException.class);
 353
 354             shardManager.tell(new ActorInitialized(), mockShardActor);
 355
 356             expectNoMsg(FiniteDuration.create(200, TimeUnit.MILLISECONDS));
 357         }};
 358     }
 359
 360     @Test
 361     public void testOnReceiveFindPrimaryWaitForReadyWithCandidateShard() throws Exception {
 362         new JavaTestKit(getSystem()) {{
 363             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 364
 365             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 366             shardManager.tell(new ActorInitialized(), mockShardActor);
 367             shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 368                     null, RaftState.Candidate.name()), mockShardActor);
 369
 370             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 371
 372             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 373         }};
 374     }
 375
 376     @Test
 377     public void testOnReceiveFindPrimaryWaitForReadyWithIsolatedLeaderShard() throws Exception {
 378         new JavaTestKit(getSystem()) {{
 379             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 380
 381             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 382             shardManager.tell(new ActorInitialized(), mockShardActor);
 383             shardManager.tell(new RoleChangeNotification("member-1-shard-default-" + shardMrgIDSuffix,
 384                     null, RaftState.IsolatedLeader.name()), mockShardActor);
 385
 386             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 387
 388             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 389         }};
 390     }
 391
 392     @Test
 393     public void testOnReceiveFindPrimaryWaitForReadyWithNoRoleShard() throws Exception {
 394         new JavaTestKit(getSystem()) {{
 395             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 396
 397             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 398             shardManager.tell(new ActorInitialized(), mockShardActor);
 399
 400             shardManager.tell(new FindPrimary(Shard.DEFAULT_NAME, true), getRef());
 401
 402             expectMsgClass(duration("2 seconds"), NoShardLeaderException.class);
 403         }};
 404     }
 405
 406     @Test
 407     public void testOnReceiveFindPrimaryForRemoteShard() throws Exception {
 408         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 409
 410         // Create an ActorSystem ShardManager actor for member-1.
 411
 412         final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 413         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 414
 415         ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 416
 417         final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
 418                 newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
 419                         new MockConfiguration()), shardManagerID);
 420
 421         // Create an ActorSystem ShardManager actor for member-2.
 422
 423         final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
 424
 425         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 426
 427         final ActorRef mockShardActor2 = newMockShardActor(system2, "astronauts", "member-2");
 428
 429         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 430                 put("default", Arrays.asList("member-1", "member-2")).
 431                 put("astronauts", Arrays.asList("member-2")).build());
 432
 433         final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
 434                 newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
 435                         mockConfig2), shardManagerID);
 436
 437         new JavaTestKit(system1) {{
 438
 439             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 440             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 441
 442             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 443
 444             String memberId2 = "member-2-shard-astronauts-" + shardMrgIDSuffix;
 445             short leaderVersion = DataStoreVersions.CURRENT_VERSION - 1;
 446             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2,
 447                     Optional.of(mock(DataTree.class)), leaderVersion), mockShardActor2);
 448             shardManager2.tell(new RoleChangeNotification(memberId2,
 449                     RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 450
 451             shardManager1.underlyingActor().waitForMemberUp();
 452
 453             shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 454
 455             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 456             String path = found.getPrimaryPath();
 457             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-astronauts-config"));
 458             assertEquals("getPrimaryVersion", leaderVersion, found.getPrimaryVersion());
 459
 460             shardManager2.underlyingActor().verifyFindPrimary();
 461
 462             Cluster.get(system2).down(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 463
 464             shardManager1.underlyingActor().waitForMemberRemoved();
 465
 466             shardManager1.tell(new FindPrimary("astronauts", false), getRef());
 467
 468             expectMsgClass(duration("5 seconds"), PrimaryNotFoundException.class);
 469         }};
 470
 471         JavaTestKit.shutdownActorSystem(system1);
 472         JavaTestKit.shutdownActorSystem(system2);
 473     }
 474
 475     @Test
 476     public void testShardAvailabilityOnChangeOfMemberReachability() throws Exception {
 477         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 478
 479         // Create an ActorSystem ShardManager actor for member-1.
 480
 481         final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 482         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 483
 484         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 485
 486         final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
 487             newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
 488                 new MockConfiguration()), shardManagerID);
 489
 490         // Create an ActorSystem ShardManager actor for member-2.
 491
 492         final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
 493
 494         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 495
 496         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 497
 498         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 499             put("default", Arrays.asList("member-1", "member-2")).build());
 500
 501         final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
 502             newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
 503                 mockConfig2), shardManagerID);
 504
 505         new JavaTestKit(system1) {{
 506
 507             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 508             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 509             shardManager1.tell(new ActorInitialized(), mockShardActor1);
 510             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 511
 512             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 513             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 514             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
 515                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 516             shardManager1.tell(new RoleChangeNotification(memberId1,
 517                 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
 518             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
 519                     DataStoreVersions.CURRENT_VERSION),
 520                 mockShardActor2);
 521             shardManager2.tell(new RoleChangeNotification(memberId2,
 522                 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 523             shardManager1.underlyingActor().waitForMemberUp();
 524
 525             shardManager1.tell(new FindPrimary("default", true), getRef());
 526
 527             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 528             String path = found.getPrimaryPath();
 529             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 530
 531             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 532                 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 533
 534             shardManager1.underlyingActor().waitForUnreachableMember();
 535
 536             PeerDown peerDown = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 537             assertEquals("getMemberName", "member-2", peerDown.getMemberName());
 538             MessageCollectorActor.clearMessages(mockShardActor1);
 539
 540             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 541                     createMemberRemoved("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 542
 543             MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerDown.class);
 544
 545             shardManager1.tell(new FindPrimary("default", true), getRef());
 546
 547             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 548
 549             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 550                 createReachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 551
 552             shardManager1.underlyingActor().waitForReachableMember();
 553
 554             PeerUp peerUp = MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 555             assertEquals("getMemberName", "member-2", peerUp.getMemberName());
 556             MessageCollectorActor.clearMessages(mockShardActor1);
 557
 558             shardManager1.tell(new FindPrimary("default", true), getRef());
 559
 560             RemotePrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 561             String path1 = found1.getPrimaryPath();
 562             assertTrue("Unexpected primary path " + path1, path1.contains("member-2-shard-default-config"));
 563
 564             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 565                     createMemberUp("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 566
 567             MessageCollectorActor.expectFirstMatching(mockShardActor1, PeerUp.class);
 568
 569         }};
 570
 571         JavaTestKit.shutdownActorSystem(system1);
 572         JavaTestKit.shutdownActorSystem(system2);
 573     }
 574
 575     @Test
 576     public void testShardAvailabilityChangeOnMemberUnreachableAndLeadershipChange() throws Exception {
 577         String shardManagerID = ShardManagerIdentifier.builder().type(shardMrgIDSuffix).build().toString();
 578
 579         // Create an ActorSystem ShardManager actor for member-1.
 580
 581         final ActorSystem system1 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 582         Cluster.get(system1).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 583
 584         final ActorRef mockShardActor1 = newMockShardActor(system1, Shard.DEFAULT_NAME, "member-1");
 585
 586         final TestActorRef<ForwardingShardManager> shardManager1 = TestActorRef.create(system1,
 587             newPropsShardMgrWithMockShardActor("shardManager1", mockShardActor1, new ClusterWrapperImpl(system1),
 588                 new MockConfiguration()), shardManagerID);
 589
 590         // Create an ActorSystem ShardManager actor for member-2.
 591
 592         final ActorSystem system2 = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
 593
 594         Cluster.get(system2).join(AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558"));
 595
 596         final ActorRef mockShardActor2 = newMockShardActor(system2, Shard.DEFAULT_NAME, "member-2");
 597
 598         MockConfiguration mockConfig2 = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
 599             put("default", Arrays.asList("member-1", "member-2")).build());
 600
 601         final TestActorRef<ForwardingShardManager> shardManager2 = TestActorRef.create(system2,
 602             newPropsShardMgrWithMockShardActor("shardManager2", mockShardActor2, new ClusterWrapperImpl(system2),
 603                 mockConfig2), shardManagerID);
 604
 605         new JavaTestKit(system1) {{
 606
 607             shardManager1.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 608             shardManager2.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 609             shardManager1.tell(new ActorInitialized(), mockShardActor1);
 610             shardManager2.tell(new ActorInitialized(), mockShardActor2);
 611
 612             String memberId2 = "member-2-shard-default-" + shardMrgIDSuffix;
 613             String memberId1 = "member-1-shard-default-" + shardMrgIDSuffix;
 614             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId2,
 615                 Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 616             shardManager1.tell(new RoleChangeNotification(memberId1,
 617                 RaftState.Candidate.name(), RaftState.Follower.name()), mockShardActor1);
 618             shardManager2.tell(new ShardLeaderStateChanged(memberId2, memberId2, Optional.of(mock(DataTree.class)),
 619                     DataStoreVersions.CURRENT_VERSION),
 620                 mockShardActor2);
 621             shardManager2.tell(new RoleChangeNotification(memberId2,
 622                 RaftState.Candidate.name(), RaftState.Leader.name()), mockShardActor2);
 623             shardManager1.underlyingActor().waitForMemberUp();
 624
 625             shardManager1.tell(new FindPrimary("default", true), getRef());
 626
 627             RemotePrimaryShardFound found = expectMsgClass(duration("5 seconds"), RemotePrimaryShardFound.class);
 628             String path = found.getPrimaryPath();
 629             assertTrue("Unexpected primary path " + path, path.contains("member-2-shard-default-config"));
 630
 631             primaryShardInfoCache.putSuccessful("default", new PrimaryShardInfo(system1.actorSelection(
 632                     mockShardActor1.path()), DataStoreVersions.CURRENT_VERSION, Optional.<DataTree>absent()));
 633
 634             shardManager1.underlyingActor().onReceiveCommand(MockClusterWrapper.
 635                 createUnreachableMember("member-2", "akka.tcp://cluster-test@127.0.0.1:2558"));
 636
 637             shardManager1.underlyingActor().waitForUnreachableMember();
 638
 639             shardManager1.tell(new FindPrimary("default", true), getRef());
 640
 641             expectMsgClass(duration("5 seconds"), NoShardLeaderException.class);
 642
 643             assertNull("Expected primaryShardInfoCache entry removed", primaryShardInfoCache.getIfPresent("default"));
 644
 645             shardManager1.tell(new ShardLeaderStateChanged(memberId1, memberId1, Optional.of(mock(DataTree.class)),
 646                     DataStoreVersions.CURRENT_VERSION), mockShardActor1);
 647             shardManager1.tell(new RoleChangeNotification(memberId1,
 648                 RaftState.Follower.name(), RaftState.Leader.name()), mockShardActor1);
 649
 650             shardManager1.tell(new FindPrimary("default", true), getRef());
 651
 652             LocalPrimaryShardFound found1 = expectMsgClass(duration("5 seconds"), LocalPrimaryShardFound.class);
 653             String path1 = found1.getPrimaryPath();
 654             assertTrue("Unexpected primary path " + path1, path1.contains("member-1-shard-default-config"));
 655
 656         }};
 657
 658         JavaTestKit.shutdownActorSystem(system1);
 659         JavaTestKit.shutdownActorSystem(system2);
 660     }
 661
 662
 663     @Test
 664     public void testOnReceiveFindLocalShardForNonExistentShard() throws Exception {
 665         new JavaTestKit(getSystem()) {{
 666             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 667
 668             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 669
 670             shardManager.tell(new FindLocalShard("non-existent", false), getRef());
 671
 672             LocalShardNotFound notFound = expectMsgClass(duration("5 seconds"), LocalShardNotFound.class);
 673
 674             assertEquals("getShardName", "non-existent", notFound.getShardName());
 675         }};
 676     }
 677
 678     @Test
 679     public void testOnReceiveFindLocalShardForExistentShard() throws Exception {
 680         new JavaTestKit(getSystem()) {{
 681             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 682
 683             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 684             shardManager.tell(new ActorInitialized(), mockShardActor);
 685
 686             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
 687
 688             LocalShardFound found = expectMsgClass(duration("5 seconds"), LocalShardFound.class);
 689
 690             assertTrue("Found path contains " + found.getPath().path().toString(),
 691                     found.getPath().path().toString().contains("member-1-shard-default-config"));
 692         }};
 693     }
 694
 695     @Test
 696     public void testOnReceiveFindLocalShardForNotInitializedShard() throws Exception {
 697         new JavaTestKit(getSystem()) {{
 698             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 699
 700             shardManager.tell(new FindLocalShard(Shard.DEFAULT_NAME, false), getRef());
 701
 702             expectMsgClass(duration("5 seconds"), NotInitializedException.class);
 703         }};
 704     }
 705
 706     @Test
 707     public void testOnReceiveFindLocalShardWaitForShardInitialized() throws Exception {
 708         new JavaTestKit(getSystem()) {{
 709             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 710
 711             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 712
 713             // We're passing waitUntilInitialized = true to FindLocalShard so the response should be
 714             // delayed until we send ActorInitialized.
 715             Future<Object> future = Patterns.ask(shardManager, new FindLocalShard(Shard.DEFAULT_NAME, true),
 716                     new Timeout(5, TimeUnit.SECONDS));
 717
 718             shardManager.tell(new ActorInitialized(), mockShardActor);
 719
 720             Object resp = Await.result(future, duration("5 seconds"));
 721             assertTrue("Expected: LocalShardFound, Actual: " + resp, resp instanceof LocalShardFound);
 722         }};
 723     }
 724
 725     @Test
 726     public void testOnRecoveryJournalIsCleaned() {
 727         InMemoryJournal.addEntry(shardMgrID, 1L, new ShardManager.SchemaContextModules(
 728                 ImmutableSet.of("foo")));
 729         InMemoryJournal.addEntry(shardMgrID, 2L, new ShardManager.SchemaContextModules(
 730                 ImmutableSet.of("bar")));
 731         InMemoryJournal.addDeleteMessagesCompleteLatch(shardMgrID);
 732
 733         new JavaTestKit(getSystem()) {{
 734             TestActorRef<TestShardManager> shardManager = TestActorRef.create(getSystem(),
 735                     Props.create(new TestShardManagerCreator(shardMrgIDSuffix)));
 736
 737             shardManager.underlyingActor().waitForRecoveryComplete();
 738             InMemoryJournal.waitForDeleteMessagesComplete(shardMgrID);
 739
 740             // Journal entries up to the last one should've been deleted
 741             Map<Long, Object> journal = InMemoryJournal.get(shardMgrID);
 742             synchronized (journal) {
 743                 assertEquals("Journal size", 0, journal.size());
 744             }
 745         }};
 746     }
 747
 748     @Test
 749     public void testRoleChangeNotificationAndShardLeaderStateChangedReleaseReady() throws Exception {
 750         new JavaTestKit(getSystem()) {
 751             {
 752                 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
 753
 754                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 755                 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
 756                         memberId, RaftState.Candidate.name(), RaftState.Leader.name()));
 757
 758                 verify(ready, never()).countDown();
 759
 760                 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId, memberId,
 761                         Optional.of(mock(DataTree.class)), DataStoreVersions.CURRENT_VERSION));
 762
 763                 verify(ready, times(1)).countDown();
 764
 765             }};
 766     }
 767
 768     @Test
 769     public void testRoleChangeNotificationToFollowerWithShardLeaderStateChangedReleaseReady() throws Exception {
 770         new JavaTestKit(getSystem()) {
 771             {
 772                 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
 773
 774                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 775                 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
 776                         memberId, null, RaftState.Follower.name()));
 777
 778                 verify(ready, never()).countDown();
 779
 780                 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
 781
 782                 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
 783                         "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
 784                         DataStoreVersions.CURRENT_VERSION));
 785
 786                 verify(ready, times(1)).countDown();
 787
 788             }};
 789     }
 790
 791     @Test
 792     public void testReadyCountDownForMemberUpAfterLeaderStateChanged() throws Exception {
 793         new JavaTestKit(getSystem()) {
 794             {
 795                 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
 796
 797                 String memberId = "member-1-shard-default-" + shardMrgIDSuffix;
 798                 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
 799                         memberId, null, RaftState.Follower.name()));
 800
 801                 verify(ready, never()).countDown();
 802
 803                 shardManager.underlyingActor().onReceiveCommand(new ShardLeaderStateChanged(memberId,
 804                         "member-2-shard-default-" + shardMrgIDSuffix, Optional.of(mock(DataTree.class)),
 805                         DataStoreVersions.CURRENT_VERSION));
 806
 807                 shardManager.underlyingActor().onReceiveCommand(MockClusterWrapper.createMemberUp("member-2", getRef().path().toString()));
 808
 809                 verify(ready, times(1)).countDown();
 810
 811             }};
 812     }
 813
 814     @Test
 815     public void testRoleChangeNotificationDoNothingForUnknownShard() throws Exception {
 816         new JavaTestKit(getSystem()) {
 817             {
 818                 TestActorRef<ShardManager> shardManager = TestActorRef.create(getSystem(), newShardMgrProps());
 819
 820                 shardManager.underlyingActor().onReceiveCommand(new RoleChangeNotification(
 821                         "unknown", RaftState.Candidate.name(), RaftState.Leader.name()));
 822
 823                 verify(ready, never()).countDown();
 824
 825             }};
 826     }
 827
 828
 829     @Test
 830     public void testByDefaultSyncStatusIsFalse() throws Exception{
 831         final Props persistentProps = newShardMgrProps();
 832         final TestActorRef<ShardManager> shardManager =
 833                 TestActorRef.create(getSystem(), persistentProps);
 834
 835         ShardManager shardManagerActor = shardManager.underlyingActor();
 836
 837         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 838     }
 839
 840     @Test
 841     public void testWhenShardIsLeaderSyncStatusIsTrue() throws Exception{
 842         final Props persistentProps = ShardManager.props(
 843                 new MockClusterWrapper(),
 844                 new MockConfiguration(),
 845                 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
 846         final TestActorRef<ShardManager> shardManager =
 847                 TestActorRef.create(getSystem(), persistentProps);
 848
 849         ShardManager shardManagerActor = shardManager.underlyingActor();
 850         shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
 851                 RaftState.Follower.name(), RaftState.Leader.name()));
 852
 853         assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
 854     }
 855
 856     @Test
 857     public void testWhenShardIsCandidateSyncStatusIsFalse() throws Exception{
 858         final Props persistentProps = newShardMgrProps();
 859         final TestActorRef<ShardManager> shardManager =
 860                 TestActorRef.create(getSystem(), persistentProps);
 861
 862         ShardManager shardManagerActor = shardManager.underlyingActor();
 863         shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
 864                 RaftState.Follower.name(), RaftState.Candidate.name()));
 865
 866         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 867
 868         // Send a FollowerInitialSyncStatus with status = true for the replica whose current state is candidate
 869         shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
 870
 871         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 872     }
 873
 874     @Test
 875     public void testWhenShardIsFollowerSyncStatusDependsOnFollowerInitialSyncStatus() throws Exception{
 876         final Props persistentProps = ShardManager.props(
 877                 new MockClusterWrapper(),
 878                 new MockConfiguration(),
 879                 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
 880         final TestActorRef<ShardManager> shardManager =
 881                 TestActorRef.create(getSystem(), persistentProps);
 882
 883         ShardManager shardManagerActor = shardManager.underlyingActor();
 884         shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
 885                 RaftState.Candidate.name(), RaftState.Follower.name()));
 886
 887         // Initially will be false
 888         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 889
 890         // Send status true will make sync status true
 891         shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-default-unknown"));
 892
 893         assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
 894
 895         // Send status false will make sync status false
 896         shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(false, "member-1-shard-default-unknown"));
 897
 898         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 899
 900     }
 901
 902     @Test
 903     public void testWhenMultipleShardsPresentSyncStatusMustBeTrueForAllShards() throws Exception{
 904         final Props persistentProps = ShardManager.props(
 905                 new MockClusterWrapper(),
 906                 new MockConfiguration() {
 907                     @Override
 908                     public List<String> getMemberShardNames(String memberName) {
 909                         return Arrays.asList("default", "astronauts");
 910                     }
 911                 },
 912                 DatastoreContext.newBuilder().persistent(true).build(), ready, primaryShardInfoCache);
 913         final TestActorRef<ShardManager> shardManager =
 914                 TestActorRef.create(getSystem(), persistentProps);
 915
 916         ShardManager shardManagerActor = shardManager.underlyingActor();
 917
 918         // Initially will be false
 919         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 920
 921         // Make default shard leader
 922         shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-default-unknown",
 923                 RaftState.Follower.name(), RaftState.Leader.name()));
 924
 925         // default = Leader, astronauts is unknown so sync status remains false
 926         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 927
 928         // Make astronauts shard leader as well
 929         shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
 930                 RaftState.Follower.name(), RaftState.Leader.name()));
 931
 932         // Now sync status should be true
 933         assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
 934
 935         // Make astronauts a Follower
 936         shardManagerActor.onReceiveCommand(new RoleChangeNotification("member-1-shard-astronauts-unknown",
 937                 RaftState.Leader.name(), RaftState.Follower.name()));
 938
 939         // Sync status is not true
 940         assertEquals(false, shardManagerActor.getMBean().getSyncStatus());
 941
 942         // Make the astronauts follower sync status true
 943         shardManagerActor.onReceiveCommand(new FollowerInitialSyncUpStatus(true, "member-1-shard-astronauts-unknown"));
 944
 945         // Sync status is now true
 946         assertEquals(true, shardManagerActor.getMBean().getSyncStatus());
 947
 948     }
 949
 950     @Test
 951     public void testOnReceiveSwitchShardBehavior() throws Exception {
 952         new JavaTestKit(getSystem()) {{
 953             final ActorRef shardManager = getSystem().actorOf(newPropsShardMgrWithMockShardActor());
 954
 955             shardManager.tell(new UpdateSchemaContext(TestModel.createTestContext()), getRef());
 956             shardManager.tell(new ActorInitialized(), mockShardActor);
 957
 958             shardManager.tell(new SwitchShardBehavior(mockShardName, "Leader", 1000), getRef());
 959
 960             SwitchBehavior switchBehavior = MessageCollectorActor.expectFirstMatching(mockShardActor, SwitchBehavior.class);
 961
 962             assertEquals(RaftState.Leader, switchBehavior.getNewState());
 963             assertEquals(1000, switchBehavior.getNewTerm());
 964         }};
 965     }
 966
 967     @Test
 968     public void testOnReceiveCreateShard() {
 969         new JavaTestKit(getSystem()) {{
 970             datastoreContextBuilder.shardInitializationTimeout(1, TimeUnit.MINUTES).persistent(true);
 971
 972             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
 973                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
 974
 975             SchemaContext schemaContext = TestModel.createTestContext();
 976             shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
 977
 978             DatastoreContext datastoreContext = DatastoreContext.newBuilder().shardElectionTimeoutFactor(100).
 979                     persistent(false).build();
 980             TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
 981
 982             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
 983                     "foo", null, Arrays.asList("member-1", "member-5", "member-6"));
 984             shardManager.tell(new CreateShard(config, shardPropsCreator, datastoreContext), getRef());
 985
 986             expectMsgClass(duration("5 seconds"), CreateShardReply.class);
 987
 988             shardManager.tell(new FindLocalShard("foo", true), getRef());
 989
 990             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
 991
 992             assertEquals("isRecoveryApplicable", false, shardPropsCreator.datastoreContext.isPersistent());
 993             assertTrue("Epxected ShardPeerAddressResolver", shardPropsCreator.datastoreContext.getShardRaftConfig().
 994                     getPeerAddressResolver() instanceof ShardPeerAddressResolver);
 995             assertEquals("peerMembers", Sets.newHashSet(new ShardIdentifier("foo", "member-5", shardMrgIDSuffix).toString(),
 996                     new ShardIdentifier("foo", "member-6", shardMrgIDSuffix).toString()),
 997                     shardPropsCreator.peerAddresses.keySet());
 998             assertEquals("ShardIdentifier", new ShardIdentifier("foo", "member-1", shardMrgIDSuffix),
 999                     shardPropsCreator.shardId);
1000             assertSame("schemaContext", schemaContext, shardPropsCreator.schemaContext);
1001
1002             // Send CreateShard with same name - should fail.
1003
1004             shardManager.tell(new CreateShard(config, shardPropsCreator, null), getRef());
1005
1006             expectMsgClass(duration("5 seconds"), akka.actor.Status.Failure.class);
1007         }};
1008     }
1009
1010     @Test
1011     public void testOnReceiveCreateShardWithNoInitialSchemaContext() {
1012         new JavaTestKit(getSystem()) {{
1013             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1014                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1015
1016             TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
1017
1018             ModuleShardConfiguration config = new ModuleShardConfiguration(URI.create("foo-ns"), "foo-module",
1019                     "foo", null, Arrays.asList("member-1"));
1020             shardManager.tell(new CreateShard(config, shardPropsCreator, null), getRef());
1021
1022             expectMsgClass(duration("5 seconds"), CreateShardReply.class);
1023
1024             SchemaContext schemaContext = TestModel.createTestContext();
1025             shardManager.tell(new UpdateSchemaContext(schemaContext), ActorRef.noSender());
1026
1027             shardManager.tell(new FindLocalShard("foo", true), getRef());
1028
1029             expectMsgClass(duration("5 seconds"), LocalShardFound.class);
1030
1031             assertSame("schemaContext", schemaContext, shardPropsCreator.schemaContext);
1032             assertNotNull("schemaContext is null", shardPropsCreator.datastoreContext);
1033         }};
1034     }
1035
1036     @Test
1037     public void testAddShardReplicaForNonExistentShard() throws Exception {
1038         new JavaTestKit(getSystem()) {{
1039             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1040                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1041
1042             shardManager.tell(new AddShardReplica("model-inventory"), getRef());
1043             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1044
1045             assertEquals("Failure obtained", true,
1046                           (resp.cause() instanceof IllegalArgumentException));
1047         }};
1048     }
1049
1050     @Test
1051     public void testAddShardReplicaForAlreadyCreatedShard() throws Exception {
1052         new JavaTestKit(getSystem()) {{
1053             ActorRef shardManager = getSystem().actorOf(newShardMgrProps());
1054             shardManager.tell(new AddShardReplica("default"), getRef());
1055             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1056             assertEquals("Failure obtained", true,
1057                           (resp.cause() instanceof IllegalArgumentException));
1058         }};
1059     }
1060
1061     @Test
1062     public void testAddShardReplica() throws Exception {
1063         new JavaTestKit(getSystem()) {{
1064             MockConfiguration mockConfig = new MockConfiguration(ImmutableMap.<String, List<String>>builder().
1065                 put("default", Arrays.asList("member-1", "member-2")).
1066                 put("astronauts", Arrays.asList("member-2")).build());
1067
1068             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(mockConfig));
1069
1070             shardManager.tell(new AddShardReplica("astronauts"), getRef());
1071             expectMsgClass(duration("2 seconds"), Status.Success.class);
1072          }};
1073     }
1074
1075     @Test
1076     public void testRemoveShardReplicaForNonExistentShard() throws Exception {
1077         new JavaTestKit(getSystem()) {{
1078             ActorRef shardManager = getSystem().actorOf(newShardMgrProps(
1079                     new ConfigurationImpl(new EmptyModuleShardConfigProvider())));
1080
1081             shardManager.tell(new RemoveShardReplica("model-inventory"), getRef());
1082             Status.Failure resp = expectMsgClass(duration("2 seconds"), Status.Failure.class);
1083             assertEquals("Failure obtained", true,
1084                          (resp.cause() instanceof IllegalArgumentException));
1085         }};
1086
1087     }
1088
1089     private static class TestShardPropsCreator implements ShardPropsCreator {
1090         ShardIdentifier shardId;
1091         Map<String, String> peerAddresses;
1092         SchemaContext schemaContext;
1093         DatastoreContext datastoreContext;
1094
1095         @Override
1096         public Props newProps(ShardIdentifier shardId, Map<String, String> peerAddresses,
1097                 DatastoreContext datastoreContext, SchemaContext schemaContext) {
1098             this.shardId = shardId;
1099             this.peerAddresses = peerAddresses;
1100             this.schemaContext = schemaContext;
1101             this.datastoreContext = datastoreContext;
1102             return Shard.props(shardId, peerAddresses, datastoreContext, schemaContext);
1103         }
1104
1105     }
1106
1107     private static class TestShardManager extends ShardManager {
1108         private final CountDownLatch recoveryComplete = new CountDownLatch(1);
1109
1110         TestShardManager(String shardMrgIDSuffix) {
1111             super(new MockClusterWrapper(), new MockConfiguration(),
1112                     DatastoreContext.newBuilder().dataStoreType(shardMrgIDSuffix).build(), ready,
1113                     new PrimaryShardInfoFutureCache());
1114         }
1115
1116         @Override
1117         public void handleRecover(Object message) throws Exception {
1118             try {
1119                 super.handleRecover(message);
1120             } finally {
1121                 if(message instanceof RecoveryCompleted) {
1122                     recoveryComplete.countDown();
1123                 }
1124             }
1125         }
1126
1127         void waitForRecoveryComplete() {
1128             assertEquals("Recovery complete", true,
1129                     Uninterruptibles.awaitUninterruptibly(recoveryComplete, 5, TimeUnit.SECONDS));
1130         }
1131     }
1132
1133     @SuppressWarnings("serial")
1134     static class TestShardManagerCreator implements Creator<TestShardManager> {
1135         String shardMrgIDSuffix;
1136
1137         TestShardManagerCreator(String shardMrgIDSuffix) {
1138             this.shardMrgIDSuffix = shardMrgIDSuffix;
1139         }
1140
1141         @Override
1142         public TestShardManager create() throws Exception {
1143             return new TestShardManager(shardMrgIDSuffix);
1144         }
1145
1146     }
1147
1148     private static class DelegatingShardManagerCreator implements Creator<ShardManager> {
1149         private static final long serialVersionUID = 1L;
1150         private final Creator<ShardManager> delegate;
1151
1152         public DelegatingShardManagerCreator(Creator<ShardManager> delegate) {
1153             this.delegate = delegate;
1154         }
1155
1156         @Override
1157         public ShardManager create() throws Exception {
1158             return delegate.create();
1159         }
1160     }
1161
1162     private static class ForwardingShardManager extends ShardManager {
1163         private CountDownLatch findPrimaryMessageReceived = new CountDownLatch(1);
1164         private CountDownLatch memberUpReceived = new CountDownLatch(1);
1165         private CountDownLatch memberRemovedReceived = new CountDownLatch(1);
1166         private CountDownLatch memberUnreachableReceived = new CountDownLatch(1);
1167         private CountDownLatch memberReachableReceived = new CountDownLatch(1);
1168         private final ActorRef shardActor;
1169         private final String name;
1170
1171         protected ForwardingShardManager(ClusterWrapper cluster, Configuration configuration,
1172                 DatastoreContext datastoreContext, CountDownLatch waitTillReadyCountdownLatch, String name,
1173                 ActorRef shardActor, PrimaryShardInfoFutureCache primaryShardInfoCache) {
1174             super(cluster, configuration, datastoreContext, waitTillReadyCountdownLatch, primaryShardInfoCache);
1175             this.shardActor = shardActor;
1176             this.name = name;
1177         }
1178
1179         @Override
1180         public void handleCommand(Object message) throws Exception {
1181             try{
1182                 super.handleCommand(message);
1183             } finally {
1184                 if(message instanceof FindPrimary) {
1185                     findPrimaryMessageReceived.countDown();
1186                 } else if(message instanceof ClusterEvent.MemberUp) {
1187                     String role = ((ClusterEvent.MemberUp)message).member().roles().head();
1188                     if(!getCluster().getCurrentMemberName().equals(role)) {
1189                         memberUpReceived.countDown();
1190                     }
1191                 } else if(message instanceof ClusterEvent.MemberRemoved) {
1192                     String role = ((ClusterEvent.MemberRemoved)message).member().roles().head();
1193                     if(!getCluster().getCurrentMemberName().equals(role)) {
1194                         memberRemovedReceived.countDown();
1195                     }
1196                 } else if(message instanceof ClusterEvent.UnreachableMember) {
1197                     String role = ((ClusterEvent.UnreachableMember)message).member().roles().head();
1198                     if(!getCluster().getCurrentMemberName().equals(role)) {
1199                         memberUnreachableReceived.countDown();
1200                     }
1201                 } else if(message instanceof ClusterEvent.ReachableMember) {
1202                     String role = ((ClusterEvent.ReachableMember)message).member().roles().head();
1203                     if(!getCluster().getCurrentMemberName().equals(role)) {
1204                         memberReachableReceived.countDown();
1205                     }
1206                 }
1207             }
1208         }
1209
1210         @Override
1211         public String persistenceId() {
1212             return name;
1213         }
1214
1215         @Override
1216         protected ActorRef newShardActor(SchemaContext schemaContext, ShardInformation info) {
1217             return shardActor;
1218         }
1219
1220         void waitForMemberUp() {
1221             assertEquals("MemberUp received", true,
1222                     Uninterruptibles.awaitUninterruptibly(memberUpReceived, 5, TimeUnit.SECONDS));
1223             memberUpReceived = new CountDownLatch(1);
1224         }
1225
1226         void waitForMemberRemoved() {
1227             assertEquals("MemberRemoved received", true,
1228                     Uninterruptibles.awaitUninterruptibly(memberRemovedReceived, 5, TimeUnit.SECONDS));
1229             memberRemovedReceived = new CountDownLatch(1);
1230         }
1231
1232         void waitForUnreachableMember() {
1233             assertEquals("UnreachableMember received", true,
1234                 Uninterruptibles.awaitUninterruptibly(memberUnreachableReceived, 5, TimeUnit.SECONDS
1235                 ));
1236             memberUnreachableReceived = new CountDownLatch(1);
1237         }
1238
1239         void waitForReachableMember() {
1240             assertEquals("ReachableMember received", true,
1241                 Uninterruptibles.awaitUninterruptibly(memberReachableReceived, 5, TimeUnit.SECONDS));
1242             memberReachableReceived = new CountDownLatch(1);
1243         }
1244
1245         void verifyFindPrimary() {
1246             assertEquals("FindPrimary received", true,
1247                     Uninterruptibles.awaitUninterruptibly(findPrimaryMessageReceived, 5, TimeUnit.SECONDS));
1248             findPrimaryMessageReceived = new CountDownLatch(1);
1249         }
1250     }
1251 }