Fix testLeaderAndFollowerEntityOwnersReassignedAfterShutdown failure

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / entityownership / DistributedEntityOwnershipIntegrationTest.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipIntegrationTest.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipIntegrationTest.java
index b4ad323c495088afd15b8c43321e666765abd57c..aaf4bc2de99e22ea041d9964a84bcff973ce06d9 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipIntegrationTest.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipIntegrationTest.java
@@ -11,6 +11,7 @@ import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;

+import static org.mockito.AdditionalMatchers.or;

 import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.reset;
 import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.reset;


@@ -37,6 +38,7 @@ import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import java.util.Collection;
 import java.util.List;
 import java.util.concurrent.TimeUnit;

+import java.util.concurrent.atomic.AtomicLong;

 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;


@@ -44,6 +46,7 @@ import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.MockitoAnnotations;
 import org.mockito.Mock;
 import org.mockito.Mockito;
 import org.mockito.MockitoAnnotations;

+import org.mockito.exceptions.base.MockitoException;

 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;
 import org.opendaylight.controller.cluster.datastore.AbstractDataStore;
 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
 import org.opendaylight.controller.cluster.datastore.IntegrationTestKit;


@@ -55,7 +58,6 @@ import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolic
 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;

-import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;

 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;


@@ -129,7 +131,7 @@ public class DistributedEntityOwnershipIntegrationTest {
 
     @Test
     public void testFunctionalityWithThreeNodes() throws Exception {
 
     @Test
     public void testFunctionalityWithThreeNodes() throws Exception {

-        String name = "test";
+        String name = "testFunctionalityWithThreeNodes";

         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();


@@ -183,6 +185,7 @@ public class DistributedEntityOwnershipIntegrationTest {
         follower1EntityOwnershipService.registerCandidate(ENTITY1);
         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");
         follower1EntityOwnershipService.registerCandidate(ENTITY1);
         verifyCandidates(leaderDistributedDataStore, ENTITY1, "member-1", "member-2");
         verifyOwner(leaderDistributedDataStore, ENTITY1, "member-1");

+        verifyOwner(follower2Node.configDataStore(), ENTITY1, "member-1");

         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
         verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
         verify(leaderMockListener, never()).ownershipChanged(ownershipChange(ENTITY1));
         verify(follower1MockListener, never()).ownershipChanged(ownershipChange(ENTITY1));


@@ -193,13 +196,14 @@ public class DistributedEntityOwnershipIntegrationTest {
                 follower1EntityOwnershipService.registerCandidate(ENTITY2);
         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
                 follower1EntityOwnershipService.registerCandidate(ENTITY2);
         verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, true, true));
         verify(leaderMockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));

+        verifyOwner(follower2Node.configDataStore(), ENTITY2, "member-2");

         reset(leaderMockListener, follower1MockListener);
 
         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
 
         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);
         reset(leaderMockListener, follower1MockListener);
 
         // Register follower2 candidate for entity2 and verify it gets added but doesn't become owner
 
         follower2EntityOwnershipService.registerListener(ENTITY_TYPE1, follower2MockListener);

-        verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY2, false, false, true));
-        verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
+        verify(follower2MockListener, timeout(5000).times(2)).ownershipChanged(or(
+                ownershipChange(ENTITY1, false, false, true), ownershipChange(ENTITY2, false, false, true)));

 
         follower2EntityOwnershipService.registerCandidate(ENTITY2);
         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");
 
         follower2EntityOwnershipService.registerCandidate(ENTITY2);
         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-2", "member-3");


@@ -270,7 +274,7 @@ public class DistributedEntityOwnershipIntegrationTest {
         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
                     .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 
         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
                     .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 

-        String name = "test";
+        String name = "testLeaderEntityOwnersReassignedAfterShutdown";

         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();


@@ -289,6 +293,8 @@ public class DistributedEntityOwnershipIntegrationTest {
         follower1Node.configDataStore().waitTillReady();
         follower2Node.configDataStore().waitTillReady();
 
         follower1Node.configDataStore().waitTillReady();
         follower2Node.configDataStore().waitTillReady();
 

+        follower1Node.waitForMembersUp("member-1", "member-3");
+

         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
         final DOMEntityOwnershipService follower1EntityOwnershipService =
                 newOwnershipService(follower1Node.configDataStore());
         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
         final DOMEntityOwnershipService follower1EntityOwnershipService =
                 newOwnershipService(follower1Node.configDataStore());


@@ -319,6 +325,18 @@ public class DistributedEntityOwnershipIntegrationTest {
         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 
         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3");
         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 

+        // Get the leader's lastIndex and verify followers are fully synced before shutting down the leader
+
+        AtomicLong leaderLastIndex = new AtomicLong();
+        MemberNode.verifyRaftState(leaderDistributedDataStore, ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> leaderLastIndex.set(raftState.getLastIndex()));
+
+        MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> assertEquals("Last index", leaderLastIndex.get(), raftState.getLastIndex()));
+
+        MemberNode.verifyRaftState(follower2Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> assertEquals("Last index", leaderLastIndex.get(), raftState.getLastIndex()));
+

         // Shutdown the leader and verify its removed from the candidate list
 
         leaderNode.cleanup();
         // Shutdown the leader and verify its removed from the candidate list
 
         leaderNode.cleanup();


@@ -347,7 +365,7 @@ public class DistributedEntityOwnershipIntegrationTest {
         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 
         followerDatastoreContextBuilder.shardElectionTimeoutFactor(5)
                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 

-        String name = "test";
+        String name = "testLeaderAndFollowerEntityOwnersReassignedAfterShutdown";

         final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
                 .useAkkaArtery(false).testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)
         final MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1")
                 .useAkkaArtery(false).testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_5_NODE_CONFIG).schemaContext(SCHEMA_CONTEXT)


@@ -378,6 +396,11 @@ public class DistributedEntityOwnershipIntegrationTest {
         leaderDistributedDataStore.waitTillReady();
         follower1Node.configDataStore().waitTillReady();
         follower2Node.configDataStore().waitTillReady();
         leaderDistributedDataStore.waitTillReady();
         follower1Node.configDataStore().waitTillReady();
         follower2Node.configDataStore().waitTillReady();

+        follower3Node.configDataStore().waitTillReady();
+        follower4Node.configDataStore().waitTillReady();
+
+        leaderNode.waitForMembersUp("member-2", "member-3", "member-4", "member-5");
+        follower1Node.waitForMembersUp("member-1", "member-3", "member-4", "member-5");

 
         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
         final DOMEntityOwnershipService follower1EntityOwnershipService =
 
         final DOMEntityOwnershipService leaderEntityOwnershipService = newOwnershipService(leaderDistributedDataStore);
         final DOMEntityOwnershipService follower1EntityOwnershipService =


@@ -418,6 +441,20 @@ public class DistributedEntityOwnershipIntegrationTest {
         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 
         verifyCandidates(leaderDistributedDataStore, ENTITY2, "member-1", "member-3", "member-4");
         verifyOwner(leaderDistributedDataStore, ENTITY2, "member-1");
 

+        // Get the leader's lastIndex and verify followers are fully synced before shutting down the leader
+        AtomicLong leaderLastIndex = new AtomicLong();
+        MemberNode.verifyRaftState(leaderDistributedDataStore, ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> leaderLastIndex.set(raftState.getLastIndex()));
+
+        MemberNode.verifyRaftState(follower1Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> assertEquals("Last index", leaderLastIndex.get(), raftState.getLastIndex()));
+
+        MemberNode.verifyRaftState(follower2Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> assertEquals("Last index", leaderLastIndex.get(), raftState.getLastIndex()));
+
+        MemberNode.verifyRaftState(follower4Node.configDataStore(), ENTITY_OWNERSHIP_SHARD_NAME,
+            raftState -> assertEquals("Last index", leaderLastIndex.get(), raftState.getLastIndex()));
+

         // Shutdown the leader and follower3
 
         leaderNode.cleanup();
         // Shutdown the leader and follower3
 
         leaderNode.cleanup();


@@ -448,7 +485,7 @@ public class DistributedEntityOwnershipIntegrationTest {
      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
      */
     @Test
      * Reproduces bug <a href="https://bugs.opendaylight.org/show_bug.cgi?id=4554">4554</a>.
      */
     @Test

-    public void testCloseCandidateRegistrationInQuickSuccession() throws CandidateAlreadyRegisteredException {
+    public void testCloseCandidateRegistrationInQuickSuccession() throws Exception {

         String name = "testCloseCandidateRegistrationInQuickSuccession";
         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
         String name = "testCloseCandidateRegistrationInQuickSuccession";
         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)


@@ -486,10 +523,13 @@ public class DistributedEntityOwnershipIntegrationTest {
 
         final DOMEntityOwnershipCandidateRegistration candidate2 =
                 follower1EntityOwnershipService.registerCandidate(ENTITY1);
 
         final DOMEntityOwnershipCandidateRegistration candidate2 =
                 follower1EntityOwnershipService.registerCandidate(ENTITY1);

+        verify(follower1MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));
+

         final DOMEntityOwnershipCandidateRegistration candidate3 =
                 follower2EntityOwnershipService.registerCandidate(ENTITY1);
         final DOMEntityOwnershipCandidateRegistration candidate3 =
                 follower2EntityOwnershipService.registerCandidate(ENTITY1);

+        verify(follower2MockListener, timeout(5000)).ownershipChanged(ownershipChange(ENTITY1, false, false, true));

 
 

-        Mockito.reset(leaderMockListener);
+        Mockito.reset(leaderMockListener, follower1MockListener, follower2MockListener);

 
         ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);
 
         ArgumentCaptor<DOMEntityOwnershipChange> leaderChangeCaptor =
                 ArgumentCaptor.forClass(DOMEntityOwnershipChange.class);


@@ -508,20 +548,20 @@ public class DistributedEntityOwnershipIntegrationTest {
         boolean passed = false;
         for (int i = 0; i < 100; i++) {
             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
         boolean passed = false;
         for (int i = 0; i < 100; i++) {
             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);

-            if (!leaderEntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
-                    || leaderEntityOwnershipService.getOwnershipState(ENTITY1).get() == EntityOwnershipState.NO_OWNER
-                            && follower1EntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
-                            && follower1EntityOwnershipService.getOwnershipState(ENTITY1)
-                                    .get() == EntityOwnershipState.NO_OWNER
-                            && follower2EntityOwnershipService.getOwnershipState(ENTITY1).isPresent()
-                            && follower2EntityOwnershipService.getOwnershipState(ENTITY1)
-                                    .get() == EntityOwnershipState.NO_OWNER
-                            && leaderChangeCaptor.getAllValues().size() > 0
-                            && !leaderChangeCaptor.getValue().getState().hasOwner()
-                            && leaderChangeCaptor.getAllValues().size() > 0
-                            && !follower1ChangeCaptor.getValue().getState().hasOwner()
-                            && leaderChangeCaptor.getAllValues().size() > 0
-                            && !follower2ChangeCaptor.getValue().getState().hasOwner()) {
+            final Optional<EntityOwnershipState> leaderState = leaderEntityOwnershipService.getOwnershipState(ENTITY1);
+            final Optional<EntityOwnershipState> follower1State =
+                    follower1EntityOwnershipService.getOwnershipState(ENTITY1);
+            final Optional<EntityOwnershipState> follower2State =
+                    follower2EntityOwnershipService.getOwnershipState(ENTITY1);
+            final Optional<DOMEntityOwnershipChange> leaderChange = getValueSafely(leaderChangeCaptor);
+            final Optional<DOMEntityOwnershipChange> follower1Change = getValueSafely(follower1ChangeCaptor);
+            final Optional<DOMEntityOwnershipChange> follower2Change = getValueSafely(follower2ChangeCaptor);
+            if (!leaderState.isPresent() || leaderState.get() == EntityOwnershipState.NO_OWNER
+                    && follower1State.isPresent() && follower1State.get() == EntityOwnershipState.NO_OWNER
+                    && follower2State.isPresent() && follower2State.get() == EntityOwnershipState.NO_OWNER
+                    && leaderChange.isPresent() && !leaderChange.get().getState().hasOwner()
+                    && follower1Change.isPresent() && !follower1Change.get().getState().hasOwner()
+                    && follower2Change.isPresent() && !follower2Change.get().getState().hasOwner()) {

                 passed = true;
                 break;
             }
                 passed = true;
                 break;
             }


@@ -530,6 +570,15 @@ public class DistributedEntityOwnershipIntegrationTest {
         assertTrue("No ownership change message was sent with hasOwner=false", passed);
     }
 
         assertTrue("No ownership change message was sent with hasOwner=false", passed);
     }
 

+    private static Optional<DOMEntityOwnershipChange> getValueSafely(ArgumentCaptor<DOMEntityOwnershipChange> captor) {
+        try {
+            return Optional.fromNullable(captor.getValue());
+        } catch (MockitoException e) {
+            // No value was captured
+            return Optional.absent();
+        }
+    }
+

     /**
      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring
     /**
      * Tests bootstrapping the entity-ownership shard when there's no shards initially configured for local
      * member. The entity-ownership shard is initially created as inactive (ie remains a follower), requiring


@@ -608,7 +657,7 @@ public class DistributedEntityOwnershipIntegrationTest {
 
     @Test
     public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {
 
     @Test
     public void testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates() throws Exception {

-        String name = "test";
+        String name = "testOwnerSelectedOnRapidUnregisteringAndRegisteringOfCandidates";

         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();


@@ -651,7 +700,7 @@ public class DistributedEntityOwnershipIntegrationTest {
 
     @Test
     public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {
 
     @Test
     public void testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates() throws Exception {

-        String name = "test";
+        String name = "testOwnerSelectedOnRapidRegisteringAndUnregisteringOfCandidates";

         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();
         MemberNode leaderNode = MemberNode.builder(memberNodes).akkaConfig("Member1").testName(name)
                 .moduleShardsConfig(MODULE_SHARDS_CONFIG).schemaContext(SCHEMA_CONTEXT).createOperDatastore(false)
                 .datastoreContextBuilder(leaderDatastoreContextBuilder).build();