X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fentityownership%2FEntityOwnershipShardTest.java;h=77d8119ba287c3f11e751a79120e96419284ea23;hb=refs%2Fchanges%2F26%2F28726%2F5;hp=e4aaaa188851b4db4e19d69f822f56857497a944;hpb=a8f617e6dd21f9a453e9ece1e57f4549899584e7;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShardTest.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShardTest.java index e4aaaa1888..77d8119ba2 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShardTest.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipShardTest.java @@ -8,17 +8,30 @@ package org.opendaylight.controller.cluster.datastore.entityownership; import static org.junit.Assert.assertEquals; +import static org.mockito.AdditionalMatchers.or; +import static org.mockito.Matchers.any; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.timeout; +import static org.mockito.Mockito.verify; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH; +import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath; +import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate; import akka.actor.ActorRef; +import akka.actor.PoisonPill; import akka.actor.Props; +import akka.actor.Terminated; import akka.actor.UntypedActor; import akka.dispatch.Dispatchers; +import akka.testkit.JavaTestKit; import akka.testkit.TestActorRef; -import com.google.common.base.Stopwatch; +import com.google.common.base.Function; import com.google.common.collect.ImmutableMap; import com.google.common.util.concurrent.Uninterruptibles; +import java.util.ArrayList; import java.util.Collections; +import java.util.List; import java.util.Map; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; @@ -29,22 +42,32 @@ import org.opendaylight.controller.cluster.datastore.AbstractShardTest; import org.opendaylight.controller.cluster.datastore.DataStoreVersions; import org.opendaylight.controller.cluster.datastore.DatastoreContext; import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder; +import org.opendaylight.controller.cluster.datastore.ShardDataTree; import org.opendaylight.controller.cluster.datastore.ShardTestKit; import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal; +import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal; +import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal; +import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal; import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications; import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply; +import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved; +import org.opendaylight.controller.cluster.datastore.messages.PeerDown; +import org.opendaylight.controller.cluster.datastore.messages.PeerUp; import org.opendaylight.controller.cluster.datastore.messages.SuccessReply; import org.opendaylight.controller.cluster.datastore.modification.MergeModification; +import org.opendaylight.controller.cluster.datastore.modification.Modification; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; import org.opendaylight.controller.cluster.raft.TestActorFactory; +import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout; import org.opendaylight.controller.cluster.raft.messages.AppendEntries; import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; import org.opendaylight.controller.cluster.raft.messages.RequestVote; import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply; import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper; import org.opendaylight.controller.md.sal.common.api.clustering.Entity; -import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidate; +import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange; +import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; @@ -61,13 +84,16 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity1")); private static final YangInstanceIdentifier ENTITY_ID2 = YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity2")); + private static final YangInstanceIdentifier ENTITY_ID3 = + YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity3")); + private static final YangInstanceIdentifier ENTITY_ID4 = + YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity4")); + private static final YangInstanceIdentifier ENTITY_ID5 = + YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "entity5")); private static final SchemaContext SCHEMA_CONTEXT = SchemaContextHelper.entityOwners(); private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger(); private static final String LOCAL_MEMBER_NAME = "member-1"; - private final ShardIdentifier shardID = ShardIdentifier.builder().memberName(LOCAL_MEMBER_NAME) - .shardName("entity-ownership").type("operational" + NEXT_SHARD_NUM.getAndIncrement()).build(); - private final Builder dataStoreContextBuilder = DatastoreContext.newBuilder(); private final TestActorFactory actorFactory = new TestActorFactory(getSystem()); @@ -86,12 +112,12 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { YangInstanceIdentifier entityId = ENTITY_ID1; Entity entity = new Entity(ENTITY_TYPE, entityId); - EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class); - shard.tell(new RegisterCandidateLocal(candidate, entity), kit.getRef()); + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); kit.expectMsgClass(SuccessReply.class); verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); } @Test @@ -100,8 +126,8 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2); - String peerId = actorFactory.generateActorId("follower"); - TestActorRef peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId). + String peerId = newShardId("follower").toString(); + TestActorRef peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId, false). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId); TestActorRef shard = actorFactory.createTestActor(newShardProps( @@ -110,15 +136,15 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { YangInstanceIdentifier entityId = ENTITY_ID1; Entity entity = new Entity(ENTITY_TYPE, entityId); - EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class); - shard.tell(new RegisterCandidateLocal(candidate, entity), kit.getRef()); + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); kit.expectMsgClass(SuccessReply.class); // Now grant the vote so the shard becomes the leader. This should retry the commit. peer.underlyingActor().grantVote = true; verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); } @Test @@ -128,12 +154,11 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2). shardTransactionCommitTimeoutInSeconds(1); - String peerId = actorFactory.generateActorId("follower"); + String peerId = newShardId("follower").toString(); TestActorRef peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId); MockFollower follower = peer.underlyingActor(); - follower.grantVote = true; // Drop AppendEntries so consensus isn't reached. follower.dropAppendEntries = true; @@ -146,9 +171,8 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { YangInstanceIdentifier entityId = ENTITY_ID1; Entity entity = new Entity(ENTITY_TYPE, entityId); - EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class); - shard.tell(new RegisterCandidateLocal(candidate, entity), kit.getRef()); + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); kit.expectMsgClass(SuccessReply.class); // Wait enough time for the commit to timeout. @@ -157,7 +181,9 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { // Resume AppendEntries - the follower should ack the commit which should then result in the candidate // write being applied to the state. follower.dropAppendEntries = false; + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); } @Test @@ -167,12 +193,11 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2). shardIsolatedLeaderCheckIntervalInMillis(50); - String peerId = actorFactory.generateActorId("follower"); + String peerId = newShardId("follower").toString(); TestActorRef peer = actorFactory.createTestActor(Props.create(MockFollower.class, peerId). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId); MockFollower follower = peer.underlyingActor(); - follower.grantVote = true; TestActorRef shard = actorFactory.createTestActor(newShardProps( ImmutableMap.builder().put(peerId, peer.path().toString()).build()). @@ -186,81 +211,591 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { YangInstanceIdentifier entityId = ENTITY_ID1; Entity entity = new Entity(ENTITY_TYPE, entityId); - EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class); - shard.tell(new RegisterCandidateLocal(candidate, entity), kit.getRef()); + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); kit.expectMsgClass(SuccessReply.class); // Resume AppendEntries - the candidate write should now be committed. follower.dropAppendEntries = false; verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, entityId, LOCAL_MEMBER_NAME); } @Test public void testOnRegisterCandidateLocalWithRemoteLeader() throws Exception { ShardTestKit kit = new ShardTestKit(getSystem()); - dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(100); + dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2). + shardBatchedModificationCount(5); - String peerId = actorFactory.generateActorId("leader"); + String peerId = newShardId("leader").toString(); TestActorRef peer = actorFactory.createTestActor(Props.create(MockLeader.class). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId); - TestActorRef shard = actorFactory.createTestActor(newShardProps( - ImmutableMap.builder().put(peerId, peer.path().toString()).build()). - withDispatcher(Dispatchers.DefaultDispatcherId())); + TestActorRef shard = actorFactory.createTestActor(Props.create( + TestEntityOwnershipShard.class, newShardId(LOCAL_MEMBER_NAME), + ImmutableMap.builder().put(peerId, peer.path().toString()).build(), + dataStoreContextBuilder.build()).withDispatcher(Dispatchers.DefaultDispatcherId())); shard.tell(new AppendEntries(1L, peerId, -1L, -1L, Collections.emptyList(), -1L, -1L, DataStoreVersions.CURRENT_VERSION), peer); - EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class); - - shard.tell(new RegisterCandidateLocal(candidate, new Entity(ENTITY_TYPE, ENTITY_ID1)), kit.getRef()); + shard.tell(new RegisterCandidateLocal(new Entity(ENTITY_TYPE, ENTITY_ID1)), kit.getRef()); kit.expectMsgClass(SuccessReply.class); MockLeader leader = peer.underlyingActor(); assertEquals("Leader received BatchedModifications", true, Uninterruptibles.awaitUninterruptibly( leader.modificationsReceived, 5, TimeUnit.SECONDS)); - verifyBatchedEntityCandidate(leader.receivedModifications, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyBatchedEntityCandidate(leader.getAndClearReceivedModifications(), ENTITY_TYPE, ENTITY_ID1, + LOCAL_MEMBER_NAME); + + // Test with initial commit timeout and subsequent retry. - leader.modificationsReceived = new CountDownLatch(2); + leader.modificationsReceived = new CountDownLatch(1); leader.sendReply = false; shard.tell(dataStoreContextBuilder.shardTransactionCommitTimeoutInSeconds(1).build(), ActorRef.noSender()); - shard.tell(new RegisterCandidateLocal(candidate, new Entity(ENTITY_TYPE, ENTITY_ID2)), kit.getRef()); + shard.tell(new RegisterCandidateLocal(new Entity(ENTITY_TYPE, ENTITY_ID2)), kit.getRef()); kit.expectMsgClass(SuccessReply.class); assertEquals("Leader received BatchedModifications", true, Uninterruptibles.awaitUninterruptibly( leader.modificationsReceived, 5, TimeUnit.SECONDS)); - verifyBatchedEntityCandidate(leader.receivedModifications, ENTITY_TYPE, ENTITY_ID2, LOCAL_MEMBER_NAME); + verifyBatchedEntityCandidate(leader.getAndClearReceivedModifications(), ENTITY_TYPE, ENTITY_ID2, + LOCAL_MEMBER_NAME); + + // Send a bunch of registration messages quickly and verify. + + int max = 100; + leader.delay = 4; + leader.modificationsReceived = new CountDownLatch(max); + List entityIds = new ArrayList<>(); + for(int i = 1; i <= max; i++) { + YangInstanceIdentifier id = YangInstanceIdentifier.of(QName.create("test", "2015-08-14", "test" + i)); + entityIds.add(id); + shard.tell(new RegisterCandidateLocal(new Entity(ENTITY_TYPE, id)), kit.getRef()); + } + + assertEquals("Leader received BatchedModifications", true, Uninterruptibles.awaitUninterruptibly( + leader.modificationsReceived, 10, TimeUnit.SECONDS)); + + // Sleep a little to ensure no additional BatchedModifications are received. + + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + + List receivedMods = leader.getAndClearReceivedModifications(); + for(int i = 0; i < max; i++) { + verifyBatchedEntityCandidate(receivedMods.get(i), ENTITY_TYPE, entityIds.get(i), LOCAL_MEMBER_NAME); + } + + assertEquals("# modifications received", max, receivedMods.size()); } - private void verifyCommittedEntityCandidate(TestActorRef shard, String entityType, - YangInstanceIdentifier entityId, String candidateName) throws Exception { - verifyEntityCandidate(readEntityOwners(shard), entityType, entityId, candidateName); + @Test + public void testOnUnregisterCandidateLocal() throws Exception { + ShardTestKit kit = new ShardTestKit(getSystem()); + TestActorRef shard = actorFactory.createTestActor(newShardProps()); + kit.waitUntilLeader(shard); + + Entity entity = new Entity(ENTITY_TYPE, ENTITY_ID1); + + // Register + + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Unregister + + shard.tell(new UnregisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, ""); + + // Register again + + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); } - private void verifyBatchedEntityCandidate(BatchedModifications mods, String entityType, - YangInstanceIdentifier entityId, String candidateName) throws Exception { - assertEquals("BatchedModifications size", 1, mods.getModifications().size()); - assertEquals("Modification type", MergeModification.class, mods.getModifications().get(0).getClass()); - verifyEntityCandidate(((MergeModification)mods.getModifications().get(0)).getData(), entityType, - entityId, candidateName); + @Test + public void testOwnershipChanges() throws Exception { + ShardTestKit kit = new ShardTestKit(getSystem()); + TestActorRef shard = actorFactory.createTestActor(newShardProps()); + kit.waitUntilLeader(shard); + + Entity entity = new Entity(ENTITY_TYPE, ENTITY_ID1); + ShardDataTree shardDataTree = shard.underlyingActor().getDataStore(); + + // Add a remote candidate + + String remoteMemberName1 = "remoteMember1"; + writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName1), shardDataTree); + + // Register local + + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + // Verify the remote candidate becomes owner + + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1); + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1); + + // Add another remote candidate and verify ownership doesn't change + + String remoteMemberName2 = "remoteMember2"; + writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName2), shardDataTree); + + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2); + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1); + + // Remove the second remote candidate and verify ownership doesn't change + + deleteNode(candidatePath(ENTITY_TYPE, ENTITY_ID1, remoteMemberName2), shardDataTree); + + verifyEntityCandidateRemoved(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2); + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1); + + // Remove the first remote candidate and verify the local candidate becomes owner + + deleteNode(candidatePath(ENTITY_TYPE, ENTITY_ID1, remoteMemberName1), shardDataTree); + + verifyEntityCandidateRemoved(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName1); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Add the second remote candidate back and verify ownership doesn't change + + writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, remoteMemberName2), shardDataTree); + + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2); + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Unregister the local candidate and verify the second remote candidate becomes owner + + shard.tell(new UnregisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verifyEntityCandidateRemoved(shard, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyOwner(shard, ENTITY_TYPE, ENTITY_ID1, remoteMemberName2); + } + + @Test + public void testOwnerChangesOnPeerAvailabilityChanges() throws Exception { + ShardTestKit kit = new ShardTestKit(getSystem()); + + dataStoreContextBuilder.shardHeartbeatIntervalInMillis(500).shardElectionTimeoutFactor(10000); + + String peerMemberName1 = "peerMember1"; + String peerMemberName2 = "peerMember2"; + + ShardIdentifier leaderId = newShardId(LOCAL_MEMBER_NAME); + ShardIdentifier peerId1 = newShardId(peerMemberName1); + ShardIdentifier peerId2 = newShardId(peerMemberName2); + + TestActorRef peer1 = actorFactory.createTestActor(newShardProps(peerId1, + ImmutableMap.builder().put(leaderId.toString(), ""). put(peerId2.toString(), "").build(), + peerMemberName1).withDispatcher(Dispatchers.DefaultDispatcherId()), peerId1.toString()); + + TestActorRef peer2 = actorFactory.createTestActor(newShardProps(peerId2, + ImmutableMap.builder().put(leaderId.toString(), ""). put(peerId1.toString(), "").build(), + peerMemberName2). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId2.toString()); + + TestActorRef leader = actorFactory.createTestActor(newShardProps(leaderId, + ImmutableMap.builder().put(peerId1.toString(), peer1.path().toString()). + put(peerId2.toString(), peer2.path().toString()).build(), LOCAL_MEMBER_NAME). + withDispatcher(Dispatchers.DefaultDispatcherId()), leaderId.toString()); + leader.tell(new ElectionTimeout(), leader); + + kit.waitUntilLeader(leader); + + // Send PeerDown and PeerUp with no entities + + leader.tell(new PeerDown(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + leader.tell(new PeerUp(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + + // Add candidates for entity1 with the local leader as the owner + + leader.tell(new RegisterCandidateLocal(new Entity(ENTITY_TYPE, ENTITY_ID1)), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, peerMemberName2), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2); + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, peerMemberName1), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Add candidates for entity2 with peerMember2 as the owner + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID2, peerMemberName2), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID2, peerMemberName1), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + + // Add candidates for entity3 with peerMember2 as the owner. + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID3, peerMemberName2), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2); + + leader.tell(new RegisterCandidateLocal(new Entity(ENTITY_TYPE, ENTITY_ID3)), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID3, peerMemberName1), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2); + + // Add only candidate peerMember2 for entity4. + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID4, peerMemberName2), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2); + + // Add only candidate peerMember1 for entity5. + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID5, peerMemberName1), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID5, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID5, peerMemberName1); + + // Kill peerMember2 and send PeerDown - the entities (2, 3, 4) owned by peerMember2 should get a new + // owner selected + + kit.watch(peer2); + peer2.tell(PoisonPill.getInstance(), ActorRef.noSender()); + kit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class); + kit.unwatch(peer2); + + leader.tell(new PeerDown(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + // Send PeerDown again - should be noop + leader.tell(new PeerDown(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + peer1.tell(new PeerDown(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, ""); // no other candidates so should clear + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2); + verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2); + verifyNoEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID4, peerMemberName2); + + // Reinstate peerMember2 - no owners should change + + peer2 = actorFactory.createTestActor(newShardProps(peerId2, + ImmutableMap.builder().put(leaderId.toString(), ""). put(peerId1.toString(), "").build(), + peerMemberName2). withDispatcher(Dispatchers.DefaultDispatcherId()), peerId2.toString()); + leader.tell(new PeerUp(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + // Send PeerUp again - should be noop + leader.tell(new PeerUp(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + peer1.tell(new PeerUp(peerMemberName2, peerId2.toString()), ActorRef.noSender()); + + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, ""); + + // Add back candidate peerMember2 for entities 1, 2, & 3. + + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID1, peerMemberName2), kit); + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID2, peerMemberName2), kit); + commitModification(leader, entityOwnersWithCandidate(ENTITY_TYPE, ENTITY_ID3, peerMemberName2), kit); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID1, peerMemberName2); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + verifyCommittedEntityCandidate(leader, ENTITY_TYPE, ENTITY_ID3, peerMemberName2); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName1); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + + // Kill peerMember1 and send PeerDown - entity 2 should get a new owner selected + + peer1.tell(PoisonPill.getInstance(), ActorRef.noSender()); + leader.tell(new PeerDown(peerMemberName1, peerId1.toString()), ActorRef.noSender()); + + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + + // Verify the reinstated peerMember2 is fully synced. + + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID4, ""); + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Reinstate peerMember1 and verify no owner changes + + peer1 = actorFactory.createTestActor(newShardProps(peerId1, + ImmutableMap.builder().put(leaderId.toString(), ""). put(peerId2.toString(), "").build(), + peerMemberName1).withDispatcher(Dispatchers.DefaultDispatcherId()), peerId1.toString()); + leader.tell(new PeerUp(peerMemberName1, peerId1.toString()), ActorRef.noSender()); + + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID4, ""); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + verifyOwner(leader, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Verify the reinstated peerMember1 is fully synced. + + verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID4, ""); + verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID3, LOCAL_MEMBER_NAME); + verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + verifyOwner(peer1, ENTITY_TYPE, ENTITY_ID1, LOCAL_MEMBER_NAME); + + // Kill the local leader and elect peer2 the leader. This should cause a new owner to be selected for + // the entities (1 and 3) previously owned by the local leader member. + + peer2.tell(new PeerAddressResolved(peerId1.toString(), peer1.path().toString()), ActorRef.noSender()); + peer2.tell(new PeerUp(LOCAL_MEMBER_NAME, leaderId.toString()), ActorRef.noSender()); + peer2.tell(new PeerUp(peerMemberName1, peerId1.toString()), ActorRef.noSender()); + + leader.tell(PoisonPill.getInstance(), ActorRef.noSender()); + peer2.tell(new PeerDown(LOCAL_MEMBER_NAME, leaderId.toString()), ActorRef.noSender()); + peer2.tell(new ElectionTimeout(), peer2); + + kit.waitUntilLeader(peer2); + + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID4, ""); + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID3, peerMemberName2); + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID2, peerMemberName2); + verifyOwner(peer2, ENTITY_TYPE, ENTITY_ID1, peerMemberName2); + } + + @Test + public void testLocalCandidateRemovedWithCandidateRegistered() throws Exception { + ShardTestKit kit = new ShardTestKit(getSystem()); + + dataStoreContextBuilder.shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10000); + ShardIdentifier leaderId = newShardId("leader"); + ShardIdentifier localId = newShardId(LOCAL_MEMBER_NAME); + + TestActorRef shard = actorFactory.createTestActor(Props.create( + TestEntityOwnershipShard.class, localId, + ImmutableMap.builder().put(leaderId.toString(), "".toString()).build(), + dataStoreContextBuilder.build()).withDispatcher(Dispatchers.DefaultDispatcherId())); + + TestActorRef leader = actorFactory.createTestActor(newShardProps(leaderId, + ImmutableMap.builder().put(localId.toString(), shard.path().toString()).build(), + LOCAL_MEMBER_NAME).withDispatcher(Dispatchers.DefaultDispatcherId()), leaderId.toString()); + leader.tell(new ElectionTimeout(), leader); + + kit.waitUntilLeader(leader); + + shard.tell(new PeerAddressResolved(leaderId.toString(), leader.path().toString()), ActorRef.noSender()); + + Entity entity = new Entity(ENTITY_TYPE, ENTITY_ID1); + EntityOwnershipListener listener = mock(EntityOwnershipListener.class); + + shard.tell(new RegisterListenerLocal(listener, ENTITY_TYPE), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + // Register local candidate + + shard.tell(new RegisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + verifyCommittedEntityCandidate(shard, entity.getType(), entity.getId(), LOCAL_MEMBER_NAME); + verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity, false, true, true)); + reset(listener); + + // Simulate a replicated commit from the leader to remove the local candidate that would occur after a + // network partition is healed. + + leader.tell(new PeerDown(LOCAL_MEMBER_NAME, localId.toString()), ActorRef.noSender()); + + verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity, true, false, false)); + + // Since the the shard has a local candidate registered, it should re-add its candidate to the entity. + + verifyCommittedEntityCandidate(shard, entity.getType(), entity.getId(), LOCAL_MEMBER_NAME); + verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity, false, true, true)); + + // Unregister the local candidate and verify it's removed and no re-added. + + shard.tell(new UnregisterCandidateLocal(entity), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verifyNoEntityCandidate(shard, entity.getType(), entity.getId(), LOCAL_MEMBER_NAME); + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verifyNoEntityCandidate(shard, entity.getType(), entity.getId(), LOCAL_MEMBER_NAME); + } + + @Test + public void testListenerRegistration() throws Exception { + ShardTestKit kit = new ShardTestKit(getSystem()); + TestActorRef shard = actorFactory.createTestActor(newShardProps()); + kit.waitUntilLeader(shard); + ShardDataTree shardDataTree = shard.underlyingActor().getDataStore(); + + String otherEntityType = "otherEntityType"; + Entity entity1 = new Entity(ENTITY_TYPE, ENTITY_ID1); + Entity entity2 = new Entity(ENTITY_TYPE, ENTITY_ID2); + Entity entity3 = new Entity(ENTITY_TYPE, ENTITY_ID3); + Entity entity4 = new Entity(otherEntityType, ENTITY_ID3); + EntityOwnershipListener listener = mock(EntityOwnershipListener.class); + + // Register listener + + shard.tell(new RegisterListenerLocal(listener, ENTITY_TYPE), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + // Register a couple candidates for the desired entity type and verify listener is notified. + + shard.tell(new RegisterCandidateLocal(entity1), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity1, false, true, true)); + + shard.tell(new RegisterCandidateLocal(entity2), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity2, false, true, true)); + reset(listener); + + // Register another candidate for another entity type and verify listener is not notified. + + shard.tell(new RegisterCandidateLocal(entity4), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verify(listener, never()).ownershipChanged(ownershipChange(entity4)); + + // Register remote candidate for entity1 + + String remoteMemberName = "remoteMember"; + writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getId(), remoteMemberName), + shardDataTree); + verifyCommittedEntityCandidate(shard, ENTITY_TYPE, entity1.getId(), remoteMemberName); + + // Unregister the local candidate for entity1 and verify listener is notified + + shard.tell(new UnregisterCandidateLocal(entity1), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verify(listener, timeout(5000)).ownershipChanged(ownershipChange(entity1, true, false, true)); + reset(listener); + + // Unregister the listener, add a candidate for entity3 and verify listener isn't notified + + shard.tell(new UnregisterListenerLocal(listener, ENTITY_TYPE), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + shard.tell(new RegisterCandidateLocal(entity3), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verifyOwner(shard, ENTITY_TYPE, entity3.getId(), LOCAL_MEMBER_NAME); + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verify(listener, never()).ownershipChanged(any(EntityOwnershipChange.class)); + + // Re-register the listener and verify it gets notified of currently owned entities + + reset(listener); + + shard.tell(new RegisterListenerLocal(listener, ENTITY_TYPE), kit.getRef()); + kit.expectMsgClass(SuccessReply.class); + + verify(listener, timeout(5000).times(2)).ownershipChanged(or(ownershipChange(entity2, false, true, true), + ownershipChange(entity3, false, true, true))); + Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS); + verify(listener, never()).ownershipChanged(ownershipChange(entity4)); + verify(listener, never()).ownershipChanged(ownershipChange(entity1)); + } + + private static void commitModification(TestActorRef shard, NormalizedNode node, + JavaTestKit sender) { + BatchedModifications modifications = newBatchedModifications(); + modifications.addModification(new MergeModification(ENTITY_OWNERS_PATH, node)); + + shard.tell(modifications, sender.getRef()); + sender.expectMsgClass(CommitTransactionReply.SERIALIZABLE_CLASS); } - private NormalizedNode readEntityOwners(TestActorRef shard) throws Exception { - Stopwatch sw = Stopwatch.createStarted(); - while(sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) { - NormalizedNode node = AbstractShardTest.readStore(shard, ENTITY_OWNERS_PATH); - if(node != null) { - return node; + private static BatchedModifications newBatchedModifications() { + BatchedModifications modifications = new BatchedModifications("tnx", DataStoreVersions.CURRENT_VERSION, ""); + modifications.setDoCommitOnReady(true); + modifications.setReady(true); + modifications.setTotalMessagesSent(1); + return modifications; + } + + private void verifyEntityCandidateRemoved(final TestActorRef shard, String entityType, + YangInstanceIdentifier entityId, String candidateName) { + verifyNodeRemoved(candidatePath(entityType, entityId, candidateName), + new Function>() { + @Override + public NormalizedNode apply(YangInstanceIdentifier path) { + try { + return AbstractShardTest.readStore(shard, path); + } catch(Exception e) { + throw new AssertionError("Failed to read " + path, e); + } + } + }); + } + + private void verifyCommittedEntityCandidate(final TestActorRef shard, String entityType, + YangInstanceIdentifier entityId, String candidateName) { + verifyEntityCandidate(entityType, entityId, candidateName, new Function>() { + @Override + public NormalizedNode apply(YangInstanceIdentifier path) { + try { + return AbstractShardTest.readStore(shard, path); + } catch(Exception e) { + throw new AssertionError("Failed to read " + path, e); + } } + }); + } - Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS); - } + private void verifyNoEntityCandidate(final TestActorRef shard, String entityType, + YangInstanceIdentifier entityId, String candidateName) { + verifyEntityCandidate(entityType, entityId, candidateName, new Function>() { + @Override + public NormalizedNode apply(YangInstanceIdentifier path) { + try { + return AbstractShardTest.readStore(shard, path); + } catch(Exception e) { + throw new AssertionError("Failed to read " + path, e); + } + } + }, false); + } + + private void verifyBatchedEntityCandidate(List mods, String entityType, + YangInstanceIdentifier entityId, String candidateName) throws Exception { + assertEquals("BatchedModifications size", 1, mods.size()); + verifyBatchedEntityCandidate(mods.get(0), entityType, entityId, candidateName); + } - return null; + private void verifyBatchedEntityCandidate(Modification mod, String entityType, + YangInstanceIdentifier entityId, String candidateName) throws Exception { + assertEquals("Modification type", MergeModification.class, mod.getClass()); + verifyEntityCandidate(((MergeModification)mod).getData(), entityType, + entityId, candidateName, true); + } + + private static void verifyOwner(final TestActorRef shard, String entityType, + YangInstanceIdentifier entityId, String localMemberName) { + verifyOwner(localMemberName, entityType, entityId, new Function>() { + @Override + public NormalizedNode apply(YangInstanceIdentifier path) { + try { + return AbstractShardTest.readStore(shard, path); + } catch(Exception e) { + return null; + } + } + }); } private Props newShardProps() { @@ -268,8 +803,34 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { } private Props newShardProps(Map peers) { - return EntityOwnershipShard.props(shardID, peers, dataStoreContextBuilder.build(), SCHEMA_CONTEXT, - LOCAL_MEMBER_NAME); + return newShardProps(newShardId(LOCAL_MEMBER_NAME), peers, LOCAL_MEMBER_NAME); + } + + private Props newShardProps(ShardIdentifier shardId, Map peers, String memberName) { + return EntityOwnershipShard.props(shardId, peers, dataStoreContextBuilder.build(), + SCHEMA_CONTEXT, memberName); + } + + private static ShardIdentifier newShardId(String memberName) { + return ShardIdentifier.builder().memberName(memberName).shardName("entity-ownership"). + type("operational" + NEXT_SHARD_NUM.getAndIncrement()).build(); + } + + public static class TestEntityOwnershipShard extends EntityOwnershipShard { + + TestEntityOwnershipShard(ShardIdentifier name, Map peerAddresses, + DatastoreContext datastoreContext) { + super(name, peerAddresses, datastoreContext, SCHEMA_CONTEXT, LOCAL_MEMBER_NAME); + } + + @Override + public void onReceiveCommand(Object message) throws Exception { + if(!(message instanceof ElectionTimeout)) { + super.onReceiveCommand(message); + } + } + + } public static class MockFollower extends UntypedActor { @@ -278,7 +839,12 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { private final String myId; public MockFollower(String myId) { + this(myId, true); + } + + public MockFollower(String myId, boolean grantVote) { this.myId = myId; + this.grantVote = grantVote; } @Override @@ -306,20 +872,39 @@ public class EntityOwnershipShardTest extends AbstractEntityOwnershipTest { public static class MockLeader extends UntypedActor { volatile CountDownLatch modificationsReceived = new CountDownLatch(1); - volatile BatchedModifications receivedModifications; + List receivedModifications = new ArrayList<>(); volatile boolean sendReply = true; + volatile long delay; @Override public void onReceive(Object message) { if(message instanceof BatchedModifications) { - receivedModifications = (BatchedModifications) message; - modificationsReceived.countDown(); + if(delay > 0) { + Uninterruptibles.sleepUninterruptibly(delay, TimeUnit.MILLISECONDS); + } + if(sendReply) { + BatchedModifications mods = (BatchedModifications) message; + synchronized (receivedModifications) { + for(int i = 0; i < mods.getModifications().size(); i++) { + receivedModifications.add(mods.getModifications().get(i)); + modificationsReceived.countDown(); + } + } + getSender().tell(CommitTransactionReply.INSTANCE.toSerializable(), getSelf()); } else { sendReply = true; } } } + + List getAndClearReceivedModifications() { + synchronized (receivedModifications) { + List ret = new ArrayList<>(receivedModifications); + receivedModifications.clear(); + return ret; + } + } } }