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

   1 /*
   2  * Copyright (c) 2015 Brocade Communications 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 package org.opendaylight.controller.cluster.datastore.entityownership;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.AdditionalMatchers.or;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.never;
  15 import static org.mockito.Mockito.reset;
  16 import static org.mockito.Mockito.timeout;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
  20 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath;
  21 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate;
  22 import akka.actor.ActorRef;
  23 import akka.actor.PoisonPill;
  24 import akka.actor.Props;
  25 import akka.actor.Terminated;
  26 import akka.actor.UntypedActor;
  27 import akka.dispatch.Dispatchers;
  28 import akka.testkit.JavaTestKit;
  29 import akka.testkit.TestActorRef;
  30 import com.google.common.collect.ImmutableMap;
  31 import com.google.common.util.concurrent.Uninterruptibles;
  32 import java.util.ArrayList;
  33 import java.util.Collections;
  34 import java.util.List;
  35 import java.util.Map;
  36 import java.util.concurrent.CountDownLatch;
  37 import java.util.concurrent.TimeUnit;
  38 import java.util.concurrent.atomic.AtomicInteger;
  39 import org.junit.After;
  40 import org.junit.Test;
  41 import org.opendaylight.controller.cluster.access.concepts.MemberName;
  42 import org.opendaylight.controller.cluster.datastore.AbstractShardTest;
  43 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  44 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  45 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
  46 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
  47 import org.opendaylight.controller.cluster.datastore.ShardTestKit;
  48 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
  49 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
  50 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
  51 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
  52 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
  53 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.LastCandidateSelectionStrategy;
  54 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  55 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
  56 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
  57 import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved;
  58 import org.opendaylight.controller.cluster.datastore.messages.PeerDown;
  59 import org.opendaylight.controller.cluster.datastore.messages.PeerUp;
  60 import org.opendaylight.controller.cluster.datastore.messages.SuccessReply;
  61 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
  62 import org.opendaylight.controller.cluster.datastore.modification.Modification;
  63 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
  64 import org.opendaylight.controller.cluster.raft.TestActorFactory;
  65 import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout;
  66 import org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow;
  67 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
  68 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
  69 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
  70 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
  71 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  72 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
  73 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
  74 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
  75 import org.opendaylight.yangtools.yang.common.QName;
  76 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  77 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  78 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  79
  80 /**
  81  * Unit tests for EntityOwnershipShard.
  82  *
  83  * @author Thomas Pantelis
  84  */
  85 public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest {
  86     private static final String ENTITY_TYPE = "test type";
  87     private static final YangInstanceIdentifier ENTITY_ID1 =
  88             YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity1"));
  89     private static final YangInstanceIdentifier ENTITY_ID2 =
  90             YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity2"));
  91     private static final YangInstanceIdentifier ENTITY_ID3 =
  92             YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity3"));
  93     private static final YangInstanceIdentifier ENTITY_ID4 =
  94             YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity4"));
  95     private static final YangInstanceIdentifier ENTITY_ID5 =
  96             YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity5"));
  97     private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners();
  98     private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger();
  99     private static final String LOCAL_MEMBER_NAME = "member-1";
 100
 101     private final Builder dataStoreContextBuilder = DatastoreContext.newBuilder();
 102     private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
 103
 104     @After
 105     public void tearDown() {
 106         actorFactory.close();
 107     }
 108
 109     @Test
 110     public void testOnRegisterCandidateLocal() throws Exception {
 111         ShardTestKit kit = new ShardTestKit(getSystem());
 112
 113         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps());
 114
 115         ShardTestKit.waitUntilLeader(shard);
 116
 117         YangInstanceIdentifier entityId = ENTITY_ID1;
 118         DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
 119
 120         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 121         kit.expectMsgClass(SuccessReply.class);
 122
 123         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 124         verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 125     }
 126
 127     @Test
 128     public void testOnRegisterCandidateLocalWithNoInitialLeader() throws Exception {
 129         ShardTestKit kit = new ShardTestKit(getSystem());
 130
 131         dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2);
 132
 133         String peerId = newShardId("follower").toString();
 134         TestActorRef<MockFollower> peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId, false).
 135                 withDispatcher(Dispatchers.DefaultDispatcherId()), peerId);
 136
 137         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps(
 138                 ImmutableMap.<String, String>builder().put(peerId, peer.path().toString()).build()).
 139                 withDispatcher(Dispatchers.DefaultDispatcherId()));
 140
 141         YangInstanceIdentifier entityId = ENTITY_ID1;
 142         DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
 143
 144         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 145         kit.expectMsgClass(SuccessReply.class);
 146
 147         // Now grant the vote so the shard becomes the leader. This should retry the commit.
 148         peer.underlyingActor().grantVote = true;
 149
 150         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 151         verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 152     }
 153
 154     @Test
 155     public void testOnRegisterCandidateLocalWithNoInitialConsensus() throws Exception {
 156         ShardTestKit kit = new ShardTestKit(getSystem());
 157
 158         dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2).
 159                 shardTransactionCommitTimeoutInSeconds(1);
 160
 161         String peerId = newShardId("follower").toString();
 162         TestActorRef<MockFollower> peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId).
 163                 withDispatcher(Dispatchers.DefaultDispatcherId()), peerId);
 164
 165         MockFollower follower = peer.underlyingActor();
 166
 167         // Drop AppendEntries so consensus isn't reached.
 168         follower.dropAppendEntries = true;
 169
 170         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps(
 171                 ImmutableMap.<String, String>builder().put(peerId, peer.path().toString()).build()).
 172                 withDispatcher(Dispatchers.DefaultDispatcherId()));
 173
 174         ShardTestKit.waitUntilLeader(shard);
 175
 176         YangInstanceIdentifier entityId = ENTITY_ID1;
 177         DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
 178
 179         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 180         kit.expectMsgClass(SuccessReply.class);
 181
 182         // Wait enough time for the commit to timeout.
 183         Uninterruptibles.sleepUninterruptibly(1, TimeUnit.SECONDS);
 184
 185         // Resume AppendEntries - the follower should ack the commit which should then result in the candidate
 186         // write being applied to the state.
 187         follower.dropAppendEntries = false;
 188
 189         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 190         verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 191     }
 192
 193     @Test
 194     public void testOnRegisterCandidateLocalWithIsolatedLeader() throws Exception {
 195         ShardTestKit kit = new ShardTestKit(getSystem());
 196
 197         dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2).
 198                 shardIsolatedLeaderCheckIntervalInMillis(50);
 199
 200         String peerId = newShardId("follower").toString();
 201         TestActorRef<MockFollower> peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId).
 202                 withDispatcher(Dispatchers.DefaultDispatcherId()), peerId);
 203
 204         MockFollower follower = peer.underlyingActor();
 205
 206         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps(
 207                 ImmutableMap.<String, String>builder().put(peerId, peer.path().toString()).build()).
 208                 withDispatcher(Dispatchers.DefaultDispatcherId()));
 209
 210         ShardTestKit.waitUntilLeader(shard);
 211
 212         // Drop AppendEntries and wait enough time for the shard to switch to IsolatedLeader.
 213         follower.dropAppendEntries = true;
 214         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 215
 216         YangInstanceIdentifier entityId = ENTITY_ID1;
 217         DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
 218
 219         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 220         kit.expectMsgClass(SuccessReply.class);
 221
 222         // Resume AppendEntries - the candidate write should now be committed.
 223         follower.dropAppendEntries = false;
 224         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 225         verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME);
 226     }
 227
 228     @Test
 229     public void testOnRegisterCandidateLocalWithRemoteLeader() throws Exception {
 230         ShardTestKit kit = new ShardTestKit(getSystem());
 231
 232         dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2).
 233                 shardBatchedModificationCount(5);
 234
 235         String peerId = newShardId("leader").toString();
 236         TestActorRef<MockLeader> peer = actorFactory.createTestActor(Props.create(MockLeader.class).
 237                 withDispatcher(Dispatchers.DefaultDispatcherId()), peerId);
 238
 239         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(Props.create(
 240                 TestEntityOwnershipShard.class, newShardId(LOCAL_MEMBER_NAME),
 241                         ImmutableMap.<String, String>builder().put(peerId, peer.path().toString()).build(),
 242                         dataStoreContextBuilder.build()).withDispatcher(Dispatchers.DefaultDispatcherId()));
 243
 244         shard.tell(new AppendEntries(1L, peerId, -1L, -1L, Collections.<ReplicatedLogEntry>emptyList(), -1L, -1L,
 245                 DataStoreVersions.CURRENT_VERSION), peer);
 246
 247         shard.tell(new RegisterCandidateLocal(new DOMEntity(ENTITY_TYPE, ENTITY_ID1)), kit.getRef());
 248         kit.expectMsgClass(SuccessReply.class);
 249
 250         MockLeader leader = peer.underlyingActor();
 251         assertEquals("Leader received BatchedModifications", true, Uninterruptibles.awaitUninterruptibly(
 252                 leader.modificationsReceived, 5, TimeUnit.SECONDS));
 253         verifyBatchedEntityCandidate(leader.getAndClearReceivedModifications(), ENTITY_TYPE, ENTITY_ID1,
 254                 LOCAL_MEMBER_NAME);
 255
 256         // Test with initial commit timeout and subsequent retry.
 257
 258         leader.modificationsReceived = new CountDownLatch(1);
 259         leader.sendReply = false;
 260
 261         shard.tell(dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1).build(), ActorRef.noSender());
 262
 263         shard.tell(new RegisterCandidateLocal(new DOMEntity(ENTITY_TYPE, ENTITY_ID2)), kit.getRef());
 264         kit.expectMsgClass(SuccessReply.class);
 265
 266         assertEquals("Leader received BatchedModifications", true, Uninterruptibles.awaitUninterruptibly(
 267                 leader.modificationsReceived, 5, TimeUnit.SECONDS));
 268         verifyBatchedEntityCandidate(leader.getAndClearReceivedModifications(), ENTITY_TYPE, ENTITY_ID2,
 269                 LOCAL_MEMBER_NAME);
 270
 271         // Send a bunch of registration messages quickly and verify.
 272
 273         int max = 100;
 274         leader.delay = 4;
 275         leader.modificationsReceived = new CountDownLatch(max);
 276         List<YangInstanceIdentifier> entityIds = new ArrayList<>();
 277         for(int i = 1; i <= max; i++) {
 278             YangInstanceIdentifier id = YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "test" + i));
 279             entityIds.add(id);
 280             shard.tell(new RegisterCandidateLocal(new DOMEntity(ENTITY_TYPE, id)), kit.getRef());
 281         }
 282
 283         assertEquals("Leader received BatchedModifications", true, Uninterruptibles.awaitUninterruptibly(
 284                 leader.modificationsReceived, 10, TimeUnit.SECONDS));
 285
 286         // Sleep a little to ensure no additional BatchedModifications are received.
 287
 288         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 289
 290         List<Modification> receivedMods = leader.getAndClearReceivedModifications();
 291         for(int i = 0; i < max; i++) {
 292             verifyBatchedEntityCandidate(receivedMods.get(i), ENTITY_TYPE, entityIds.get(i), LOCAL_MEMBER_NAME);
 293         }
 294
 295         assertEquals("# modifications received", max, receivedMods.size());
 296     }
 297
 298     @Test
 299     public void testOnUnregisterCandidateLocal() throws Exception {
 300         ShardTestKit kit = new ShardTestKit(getSystem());
 301         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps());
 302         ShardTestKit.waitUntilLeader(shard);
 303
 304         DOMEntity entity = new DOMEntity(ENTITY_TYPE, ENTITY_ID1);
 305
 306         // Register
 307
 308         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 309         kit.expectMsgClass(SuccessReply.class);
 310
 311         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 312         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 313
 314         // Unregister
 315
 316         shard.tell(new UnregisterCandidateLocal(entity), kit.getRef());
 317         kit.expectMsgClass(SuccessReply.class);
 318
 319         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, "");
 320
 321         // Register again
 322
 323         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 324         kit.expectMsgClass(SuccessReply.class);
 325
 326         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 327         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 328     }
 329
 330     @Test
 331     public void testOwnershipChanges() throws Exception {
 332         ShardTestKit kit = new ShardTestKit(getSystem());
 333         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps());
 334         ShardTestKit.waitUntilLeader(shard);
 335
 336         DOMEntity entity = new DOMEntity(ENTITY_TYPE, ENTITY_ID1);
 337         ShardDataTree shardDataTree = shard.underlyingActor().getDataStore();
 338
 339         // Add a remote candidate
 340
 341         String remoteMemberName1 = "remoteMember1";
 342         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName1), shardDataTree);
 343
 344         // Register local
 345
 346         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 347         kit.expectMsgClass(SuccessReply.class);
 348
 349         // Verify the remote candidate becomes owner
 350
 351         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 352         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 353         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 354
 355         // Add another remote candidate and verify ownership doesn't change
 356
 357         String remoteMemberName2 = "remoteMember2";
 358         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName2), shardDataTree);
 359
 360         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2);
 361         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 362         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 363
 364         // Remove the second remote candidate and verify ownership doesn't change
 365
 366         deleteNode(candidatePath(ENTITY_TYPE, ENTITY_ID1, remoteMemberName2), shardDataTree);
 367
 368         verifyEntityCandidateRemoved(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2);
 369         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 370         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 371
 372         // Remove the first remote candidate and verify the local candidate becomes owner
 373
 374         deleteNode(candidatePath(ENTITY_TYPE, ENTITY_ID1, remoteMemberName1), shardDataTree);
 375
 376         verifyEntityCandidateRemoved(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 377         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 378
 379         // Add the second remote candidate back and verify ownership doesn't change
 380
 381         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName2), shardDataTree);
 382
 383         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2);
 384         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 385         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 386
 387         // Unregister the local candidate and verify the second remote candidate becomes owner
 388
 389         shard.tell(new UnregisterCandidateLocal(entity), kit.getRef());
 390         kit.expectMsgClass(SuccessReply.class);
 391
 392         verifyEntityCandidateRemoved(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 393         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2);
 394     }
 395
 396     @Test
 397     public void testOwnerChangesOnPeerAvailabilityChanges() throws Exception {
 398         ShardTestKit kit = new ShardTestKit(getSystem());
 399
 400         dataStoreContextBuilder.shardHeartbeatIntervalInMillis(500).shardElectionTimeoutFactor(10000);
 401
 402         String peerMemberName1 = "peerMember1";
 403         String peerMemberName2 = "peerMember2";
 404
 405         ShardIdentifier leaderId = newShardId(LOCAL_MEMBER_NAME);
 406         ShardIdentifier peerId1 = newShardId(peerMemberName1);
 407         ShardIdentifier peerId2 = newShardId(peerMemberName2);
 408
 409         TestActorRef<EntityOwnershipShard> peer1 = actorFactory.createTestActor(newShardProps(peerId1,
 410                 ImmutableMap.<String, String>builder().put(leaderId.toString(), actorFactory.createTestActorPath(leaderId.toString())).
 411                         put(peerId2.toString(), actorFactory.createTestActorPath(peerId2.toString())).build(), peerMemberName1,
 412                 EntityOwnerSelectionStrategyConfig.newBuilder().build()).withDispatcher(Dispatchers.DefaultDispatcherId()), peerId1.toString());
 413
 414         TestActorRef<EntityOwnershipShard> peer2 = actorFactory.createTestActor(newShardProps(peerId2,
 415                 ImmutableMap.<String, String>builder().put(leaderId.toString(), actorFactory.createTestActorPath(leaderId.toString())).
 416                         put(peerId1.toString(), peer1.path().toString()).build(), peerMemberName2,
 417                 EntityOwnerSelectionStrategyConfig.newBuilder().build()). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId2.toString());
 418
 419         TestActorRef<EntityOwnershipShard> leader = actorFactory.createTestActor(newShardProps(leaderId,
 420                 ImmutableMap.<String, String>builder().put(peerId1.toString(), peer1.path().toString()).
 421                         put(peerId2.toString(), peer2.path().toString()).build(), LOCAL_MEMBER_NAME, EntityOwnerSelectionStrategyConfig.newBuilder().build()).
 422                 withDispatcher(Dispatchers.DefaultDispatcherId()), leaderId.toString());
 423         leader.tell(TimeoutNow.INSTANCE, leader);
 424
 425         ShardTestKit.waitUntilLeader(leader);
 426
 427         // Send PeerDown and PeerUp with no entities
 428
 429         leader.tell(new PeerDown(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 430         leader.tell(new PeerUp(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 431
 432         // Add candidates for entity1 with the local leader as the owner
 433
 434         leader.tell(new RegisterCandidateLocal(new DOMEntity(ENTITY_TYPE, ENTITY_ID1)), kit.getRef());
 435         kit.expectMsgClass(SuccessReply.class);
 436         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 437
 438         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, peerMemberName2), kit);
 439         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2);
 440
 441         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, peerMemberName1), kit);
 442         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName1);
 443         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 444
 445         // Add candidates for entity2 with peerMember2 as the owner
 446
 447         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID2, peerMemberName2), kit);
 448         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 449
 450         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID2, peerMemberName1), kit);
 451         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1);
 452         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 453
 454         // Add candidates for entity3 with peerMember2 as the owner.
 455
 456         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID3, peerMemberName2), kit);
 457         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2);
 458
 459         leader.tell(new RegisterCandidateLocal(new DOMEntity(ENTITY_TYPE, ENTITY_ID3)), kit.getRef());
 460         kit.expectMsgClass(SuccessReply.class);
 461         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 462
 463         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID3, peerMemberName1), kit);
 464         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName1);
 465         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2);
 466
 467         // Add only candidate peerMember2 for entity4.
 468
 469         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID4, peerMemberName2), kit);
 470         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2);
 471         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2);
 472
 473         // Add only candidate peerMember1 for entity5.
 474
 475         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID5, peerMemberName1), kit);
 476         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID5, peerMemberName1);
 477         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID5, peerMemberName1);
 478
 479         // Kill peerMember2 and send PeerDown - the entities (2, 3, 4) owned by peerMember2 should get a new
 480         // owner selected
 481
 482         kit.watch(peer2);
 483         peer2.tell(PoisonPill.getInstance(), ActorRef.noSender());
 484         kit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
 485         kit.unwatch(peer2);
 486
 487         leader.tell(new PeerDown(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 488         // Send PeerDown again - should be noop
 489         leader.tell(new PeerDown(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 490         peer1.tell(new PeerDown(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 491
 492         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 493         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1);
 494         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 495         // no other candidates for entity4 so peerMember2 should remain owner.
 496         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2);
 497
 498         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2);
 499         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 500         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2);
 501         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2);
 502
 503         // Reinstate peerMember2
 504
 505         peer2 = actorFactory.createTestActor(newShardProps(peerId2,
 506                     ImmutableMap.<String, String>builder().put(leaderId.toString(), leader.path().toString()).
 507                             put(peerId1.toString(), peer1.path().toString()).build(), peerMemberName2,
 508                     EntityOwnerSelectionStrategyConfig.newBuilder().build()). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId2.toString());
 509         leader.tell(new PeerUp(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 510         // Send PeerUp again - should be noop
 511         leader.tell(new PeerUp(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 512         peer1.tell(new PeerUp(peerId2.getMemberName(), peerId2.toString()), ActorRef.noSender());
 513
 514         // peerMember2's candidates should be removed on startup.
 515         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2);
 516         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 517         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2);
 518         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2);
 519
 520         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 521         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1);
 522         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 523         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, "");
 524
 525         // Add back candidate peerMember2 for entities 1, 2, & 3.
 526
 527         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, peerMemberName2), kit);
 528         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID2, peerMemberName2), kit);
 529         commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID3, peerMemberName2), kit);
 530         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2);
 531         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 532         verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2);
 533         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 534         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1);
 535         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 536
 537         // Kill peerMember1 and send PeerDown - entity 2 should get a new owner selected
 538
 539         peer1.tell(PoisonPill.getInstance(), ActorRef.noSender());
 540         leader.tell(new PeerDown(peerId1.getMemberName(), peerId1.toString()), ActorRef.noSender());
 541
 542         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 543
 544         // Verify the reinstated peerMember2 is fully synced.
 545
 546         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 547         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 548         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 549         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID4, "");
 550
 551         // Reinstate peerMember1 and verify no owner changes
 552
 553         peer1 = actorFactory.createTestActor(newShardProps(peerId1,
 554                 ImmutableMap.<String, String>builder().put(leaderId.toString(), leader.path().toString()).
 555                         put(peerId2.toString(), peer2.path().toString()).build(), peerMemberName1,
 556                 EntityOwnerSelectionStrategyConfig.newBuilder().build()).withDispatcher(Dispatchers.DefaultDispatcherId()), peerId1.toString());
 557         leader.tell(new PeerUp(peerId1.getMemberName(), peerId1.toString()), ActorRef.noSender());
 558
 559         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 560         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 561         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 562         verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, "");
 563
 564         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName1);
 565         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1);
 566         verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName1);
 567
 568         // Verify the reinstated peerMember1 is fully synced.
 569
 570         verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 571         verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 572         verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME);
 573         verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID4, "");
 574
 575         // Kill the local leader and elect peer2 the leader. This should cause a new owner to be selected for
 576         // the entities (1 and 3) previously owned by the local leader member.
 577
 578         peer2.tell(new PeerAddressResolved(peerId1.toString(), peer1.path().toString()), ActorRef.noSender());
 579         peer2.tell(new PeerUp(leaderId.getMemberName(), leaderId.toString()), ActorRef.noSender());
 580         peer2.tell(new PeerUp(peerId1.getMemberName(), peerId1.toString()), ActorRef.noSender());
 581
 582         leader.tell(PoisonPill.getInstance(), ActorRef.noSender());
 583         peer2.tell(new PeerDown(leaderId.getMemberName(), leaderId.toString()), ActorRef.noSender());
 584         peer2.tell(TimeoutNow.INSTANCE, peer2);
 585
 586         ShardTestKit.waitUntilLeader(peer2);
 587
 588         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID1, peerMemberName2);
 589         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID2, peerMemberName2);
 590         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID3, peerMemberName2);
 591         verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID4, "");
 592     }
 593
 594     @Test
 595     public void testListenerRegistration() throws Exception {
 596         ShardTestKit kit = new ShardTestKit(getSystem());
 597         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps());
 598         ShardTestKit.waitUntilLeader(shard);
 599         ShardDataTree shardDataTree = shard.underlyingActor().getDataStore();
 600
 601         String otherEntityType = "otherEntityType";
 602         DOMEntity entity1 = new DOMEntity(ENTITY_TYPE, ENTITY_ID1);
 603         DOMEntity entity2 = new DOMEntity(ENTITY_TYPE, ENTITY_ID2);
 604         DOMEntity entity3 = new DOMEntity(ENTITY_TYPE, ENTITY_ID3);
 605         DOMEntity entity4 = new DOMEntity(otherEntityType, ENTITY_ID3);
 606         DOMEntityOwnershipListener listener = mock(DOMEntityOwnershipListener.class);
 607
 608         // Register listener
 609
 610         shard.tell(new RegisterListenerLocal(listener, ENTITY_TYPE), kit.getRef());
 611         kit.expectMsgClass(SuccessReply.class);
 612
 613         // Register a couple candidates for the desired entity type and verify listener is notified.
 614
 615         shard.tell(new RegisterCandidateLocal(entity1), kit.getRef());
 616         kit.expectMsgClass(SuccessReply.class);
 617
 618         verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity1, false, true, true));
 619
 620         shard.tell(new RegisterCandidateLocal(entity2), kit.getRef());
 621         kit.expectMsgClass(SuccessReply.class);
 622
 623         verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity2, false, true, true));
 624         reset(listener);
 625
 626         // Register another candidate for another entity type and verify listener is not notified.
 627
 628         shard.tell(new RegisterCandidateLocal(entity4), kit.getRef());
 629         kit.expectMsgClass(SuccessReply.class);
 630
 631         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 632         verify(listener, never()).ownershipChanged(ownershipChange(entity4));
 633
 634         // Register remote candidate for entity1
 635
 636         String remoteMemberName = "remoteMember";
 637         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getIdentifier(), remoteMemberName),
 638                 shardDataTree);
 639         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entity1.getIdentifier(), remoteMemberName);
 640
 641         // Unregister the local candidate for entity1 and verify listener is notified
 642
 643         shard.tell(new UnregisterCandidateLocal(entity1), kit.getRef());
 644         kit.expectMsgClass(SuccessReply.class);
 645
 646         verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity1, true, false, true));
 647         reset(listener);
 648
 649         // Unregister the listener, add a candidate for entity3 and verify listener isn't notified
 650
 651         shard.tell(new UnregisterListenerLocal(listener, ENTITY_TYPE), kit.getRef());
 652         kit.expectMsgClass(SuccessReply.class);
 653
 654         shard.tell(new RegisterCandidateLocal(entity3), kit.getRef());
 655         kit.expectMsgClass(SuccessReply.class);
 656
 657         verifyOwner(shard, ENTITY_TYPE, entity3.getIdentifier(), LOCAL_MEMBER_NAME);
 658         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
 659         verify(listener, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
 660
 661         // Re-register the listener and verify it gets notified of currently owned entities
 662
 663         reset(listener);
 664
 665         shard.tell(new RegisterListenerLocal(listener, ENTITY_TYPE), kit.getRef());
 666         kit.expectMsgClass(SuccessReply.class);
 667
 668         verify(listener, timeout(5000).times(2)).ownershipChanged(or(ownershipChange(entity2, false, true, true),
 669                 ownershipChange(entity3, false, true, true)));
 670         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 671         verify(listener, never()).ownershipChanged(ownershipChange(entity4));
 672         verify(listener, times(1)).ownershipChanged(ownershipChange(entity1));
 673     }
 674
 675     private static void commitModification(TestActorRef<EntityOwnershipShard> shard, NormalizedNode<?, ?> node,
 676             JavaTestKit sender) {
 677         BatchedModifications modifications = newBatchedModifications();
 678         modifications.addModification(new MergeModification(ENTITY_OWNERS_PATH, node));
 679
 680         shard.tell(modifications, sender.getRef());
 681         sender.expectMsgClass(CommitTransactionReply.class);
 682     }
 683
 684     private static BatchedModifications newBatchedModifications() {
 685         BatchedModifications modifications = new BatchedModifications(nextTransactionId(), DataStoreVersions.CURRENT_VERSION);
 686         modifications.setDoCommitOnReady(true);
 687         modifications.setReady(true);
 688         modifications.setTotalMessagesSent(1);
 689         return modifications;
 690     }
 691
 692     private void verifyEntityCandidateRemoved(final TestActorRef<EntityOwnershipShard> shard, String entityType,
 693             YangInstanceIdentifier entityId, String candidateName) {
 694         verifyNodeRemoved(candidatePath(entityType, entityId, candidateName),
 695                 path -> {
 696                     try {
 697                         return AbstractShardTest.readStore(shard, path);
 698                     } catch(Exception e) {
 699                         throw new AssertionError("Failed to read " + path, e);
 700                     }
 701             });
 702     }
 703
 704     private void verifyCommittedEntityCandidate(final TestActorRef<EntityOwnershipShard> shard, String entityType,
 705             YangInstanceIdentifier entityId, String candidateName) {
 706         verifyEntityCandidate(entityType, entityId, candidateName, path -> {
 707             try {
 708                 return AbstractShardTest.readStore(shard, path);
 709             } catch(Exception e) {
 710                 throw new AssertionError("Failed to read " + path, e);
 711             }
 712         });
 713     }
 714
 715     private void verifyNoEntityCandidate(final TestActorRef<EntityOwnershipShard> shard, String entityType,
 716             YangInstanceIdentifier entityId, String candidateName) {
 717         verifyEntityCandidate(entityType, entityId, candidateName, path -> {
 718             try {
 719                 return AbstractShardTest.readStore(shard, path);
 720             } catch(Exception e) {
 721                 throw new AssertionError("Failed to read " + path, e);
 722             }
 723         }, false);
 724     }
 725
 726     private void verifyBatchedEntityCandidate(List<Modification> mods, String entityType,
 727             YangInstanceIdentifier entityId, String candidateName) throws Exception {
 728         assertEquals("BatchedModifications size", 1, mods.size());
 729         verifyBatchedEntityCandidate(mods.get(0), entityType, entityId, candidateName);
 730     }
 731
 732     private void verifyBatchedEntityCandidate(Modification mod, String entityType,
 733             YangInstanceIdentifier entityId, String candidateName) throws Exception {
 734         assertEquals("Modification type", MergeModification.class, mod.getClass());
 735         verifyEntityCandidate(((MergeModification)mod).getData(), entityType,
 736                 entityId, candidateName, true);
 737     }
 738
 739     private static void verifyOwner(final TestActorRef<EntityOwnershipShard> shard, String entityType,
 740             YangInstanceIdentifier entityId, String localMemberName) {
 741         verifyOwner(localMemberName, entityType, entityId, path -> {
 742             try {
 743                 return AbstractShardTest.readStore(shard, path);
 744             } catch(Exception e) {
 745                 return null;
 746             }
 747         });
 748     }
 749
 750     private Props newShardProps() {
 751         return newShardProps(Collections.<String,String>emptyMap());
 752     }
 753
 754     private Props newShardProps(EntityOwnerSelectionStrategyConfig strategyConfig, Map<String, String> peers) {
 755         return newShardProps(newShardId(LOCAL_MEMBER_NAME), peers, LOCAL_MEMBER_NAME, strategyConfig);
 756     }
 757
 758     private Props newShardProps(Map<String, String> peers) {
 759         return newShardProps(newShardId(LOCAL_MEMBER_NAME), peers, LOCAL_MEMBER_NAME, EntityOwnerSelectionStrategyConfig.newBuilder().build());
 760     }
 761
 762     private Props newShardProps(ShardIdentifier shardId, Map<String,String> peers, String memberName,
 763                                 EntityOwnerSelectionStrategyConfig config) {
 764         return EntityOwnershipShard.newBuilder().id(shardId).peerAddresses(peers).
 765                 datastoreContext(dataStoreContextBuilder.build()).schemaContext(SCHEMA_CONTEXT).
 766                 localMemberName(MemberName.forName(memberName)).ownerSelectionStrategyConfig(config).props()
 767                 .withDispatcher(Dispatchers.DefaultDispatcherId());
 768     }
 769
 770     private static ShardIdentifier newShardId(String memberName) {
 771         return ShardIdentifier.create("entity-ownership", MemberName.forName(memberName),
 772             "operational" + NEXT_SHARD_NUM.getAndIncrement());
 773     }
 774
 775     private static class TestEntityOwnershipShard extends EntityOwnershipShard {
 776
 777         TestEntityOwnershipShard(ShardIdentifier name, Map<String, String> peerAddresses,
 778                 DatastoreContext datastoreContext) {
 779             super(newBuilder().id(name).peerAddresses(peerAddresses).datastoreContext(datastoreContext).
 780                     schemaContext(SCHEMA_CONTEXT).localMemberName(name.getMemberName()));
 781         }
 782
 783         @Override
 784         public void handleCommand(Object message) {
 785             if(!(message instanceof ElectionTimeout)) {
 786                 super.handleCommand(message);
 787             }
 788         }
 789     }
 790
 791     private static class MockFollower extends UntypedActor {
 792         volatile boolean grantVote;
 793         volatile boolean dropAppendEntries;
 794         private final String myId;
 795
 796         @SuppressWarnings("unused")
 797         public MockFollower(String myId) {
 798             this(myId, true);
 799         }
 800
 801         public MockFollower(String myId, boolean grantVote) {
 802             this.myId = myId;
 803             this.grantVote = grantVote;
 804         }
 805
 806         @Override
 807         public void onReceive(Object message) {
 808             if(message instanceof RequestVote) {
 809                 if(grantVote) {
 810                     getSender().tell(new RequestVoteReply(((RequestVote)message).getTerm(), true), getSelf());
 811                 }
 812             } else if(message instanceof AppendEntries) {
 813                 if(!dropAppendEntries) {
 814                     AppendEntries req = (AppendEntries) message;
 815                     long lastIndex = req.getLeaderCommit();
 816                     if (req.getEntries().size() > 0) {
 817                         for(ReplicatedLogEntry entry : req.getEntries()) {
 818                             lastIndex = entry.getIndex();
 819                         }
 820                     }
 821
 822                     getSender().tell(new AppendEntriesReply(myId, req.getTerm(), true, lastIndex, req.getTerm(),
 823                             DataStoreVersions.CURRENT_VERSION), getSelf());
 824                 }
 825             }
 826         }
 827     }
 828
 829
 830     @Test
 831     public void testDelayedEntityOwnerSelectionWhenMaxPeerRequestsReceived() throws Exception {
 832         ShardTestKit kit = new ShardTestKit(getSystem());
 833         EntityOwnerSelectionStrategyConfig.Builder builder
 834                 = EntityOwnerSelectionStrategyConfig.newBuilder().addStrategy(ENTITY_TYPE, LastCandidateSelectionStrategy.class, 500);
 835
 836         String peerId = newShardId("follower").toString();
 837         TestActorRef<MockFollower> peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId, false).
 838                 withDispatcher(Dispatchers.DefaultDispatcherId()), peerId);
 839
 840         peer.underlyingActor().grantVote = true;
 841
 842         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps(builder.build(),
 843                 ImmutableMap.of(peerId.toString(), peer.path().toString())));
 844         ShardTestKit.waitUntilLeader(shard);
 845
 846         DOMEntity entity = new DOMEntity(ENTITY_TYPE, ENTITY_ID1);
 847         ShardDataTree shardDataTree = shard.underlyingActor().getDataStore();
 848
 849         // Add a remote candidate
 850
 851         String remoteMemberName1 = "follower";
 852         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName1), shardDataTree);
 853
 854         // Register local
 855
 856         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 857         kit.expectMsgClass(SuccessReply.class);
 858
 859         // Verify the local candidate becomes owner
 860
 861         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 862         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 863         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 864     }
 865
 866     @Test
 867     public void testDelayedEntityOwnerSelection() throws Exception {
 868         ShardTestKit kit = new ShardTestKit(getSystem());
 869         EntityOwnerSelectionStrategyConfig.Builder builder
 870                 = EntityOwnerSelectionStrategyConfig.newBuilder().addStrategy(ENTITY_TYPE, LastCandidateSelectionStrategy.class, 500);
 871
 872         String follower1Id = newShardId("follower1").toString();
 873         TestActorRef<MockFollower> follower1 = actorFactory.createTestActor(Props.create(MockFollower.class, follower1Id, false).
 874                 withDispatcher(Dispatchers.DefaultDispatcherId()), follower1Id);
 875
 876         follower1.underlyingActor().grantVote = true;
 877
 878         String follower2Id = newShardId("follower").toString();
 879         TestActorRef<MockFollower> follower2 = actorFactory.createTestActor(Props.create(MockFollower.class, follower2Id, false).
 880                 withDispatcher(Dispatchers.DefaultDispatcherId()), follower2Id);
 881
 882         follower2.underlyingActor().grantVote = true;
 883
 884
 885         TestActorRef<EntityOwnershipShard> shard = actorFactory.createTestActor(newShardProps(builder.build(),
 886                 ImmutableMap.of(follower1Id.toString(), follower2.path().toString(), follower2Id.toString(), follower2.path().toString())));
 887         ShardTestKit.waitUntilLeader(shard);
 888
 889         DOMEntity entity = new DOMEntity(ENTITY_TYPE, ENTITY_ID1);
 890         ShardDataTree shardDataTree = shard.underlyingActor().getDataStore();
 891
 892         // Add a remote candidate
 893
 894         String remoteMemberName1 = "follower";
 895         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName1), shardDataTree);
 896
 897         // Register local
 898
 899         shard.tell(new RegisterCandidateLocal(entity), kit.getRef());
 900         kit.expectMsgClass(SuccessReply.class);
 901
 902         // Verify the local candidate becomes owner
 903
 904         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1);
 905         verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 906         verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME);
 907     }
 908
 909     private static class MockLeader extends UntypedActor {
 910         volatile CountDownLatch modificationsReceived = new CountDownLatch(1);
 911         List<Modification> receivedModifications = new ArrayList<>();
 912         volatile boolean sendReply = true;
 913         volatile long delay;
 914
 915         @Override
 916         public void onReceive(Object message) {
 917             if(message instanceof BatchedModifications) {
 918                 if(delay > 0) {
 919                     Uninterruptibles.sleepUninterruptibly(delay, TimeUnit.MILLISECONDS);
 920                 }
 921
 922                 if(sendReply) {
 923                     BatchedModifications mods = (BatchedModifications) message;
 924                     synchronized (receivedModifications) {
 925                         for(int i = 0; i < mods.getModifications().size(); i++) {
 926                             receivedModifications.add(mods.getModifications().get(i));
 927                             modificationsReceived.countDown();
 928                         }
 929                     }
 930
 931                     getSender().tell(CommitTransactionReply.instance(DataStoreVersions.CURRENT_VERSION).
 932                             toSerializable(), getSelf());
 933                 } else {
 934                     sendReply = true;
 935                 }
 936             }
 937         }
 938
 939         List<Modification> getAndClearReceivedModifications() {
 940             synchronized (receivedModifications) {
 941                 List<Modification> ret = new ArrayList<>(receivedModifications);
 942                 receivedModifications.clear();
 943                 return ret;
 944             }
 945         }
 946     }
 947 }