Transaction message retry when no shard leader present
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / DistributedDataStoreRemotingIntegrationTest.java
index 005e904e4c9401938fd334738b3fdfa97a478399..3c4c9046c82c4d48e0504cfe4677231e2ef50c25 100644 (file)
@@ -40,8 +40,11 @@ import org.mockito.Mockito;
 import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
+import org.opendaylight.controller.cluster.datastore.IntegrationTestKit.ShardStatsVerifier;
+import org.opendaylight.controller.cluster.datastore.MemberNode.RaftStateVerifier;
 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
 import org.opendaylight.controller.cluster.datastore.exceptions.ShardLeaderNotRespondingException;
+import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
@@ -50,6 +53,8 @@ import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionRe
 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
+import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
+import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
 import org.opendaylight.controller.md.cluster.datastore.model.PeopleModel;
@@ -87,23 +92,26 @@ import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFac
  */
 public class DistributedDataStoreRemotingIntegrationTest {
 
-    private static final String[] SHARD_NAMES = {"cars", "people"};
+    private static final String[] CARS_AND_PEOPLE = {"cars", "people"};
+    private static final String[] CARS = {"cars"};
 
     private static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2558");
     private static final Address MEMBER_2_ADDRESS = AddressFromURIString.parse("akka.tcp://cluster-test@127.0.0.1:2559");
 
-    private static final String MODULE_SHARDS_CONFIG_2 = "module-shards-member1-and-2.conf";
-    private static final String MODULE_SHARDS_CONFIG_3 = "module-shards-member1-and-2-and-3.conf";
+    private static final String MODULE_SHARDS_CARS_ONLY_1_2 = "module-shards-cars-member-1-and-2.conf";
+    private static final String MODULE_SHARDS_CARS_PEOPLE_1_2 = "module-shards-member1-and-2.conf";
+    private static final String MODULE_SHARDS_CARS_PEOPLE_1_2_3 = "module-shards-member1-and-2-and-3.conf";
 
     private ActorSystem leaderSystem;
     private ActorSystem followerSystem;
     private ActorSystem follower2System;
 
     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
-            DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(1);
+            DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2);
 
     private final DatastoreContext.Builder followerDatastoreContextBuilder =
-            DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
+            DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5).
+                customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 
     private DistributedDataStore followerDistributedDataStore;
     private DistributedDataStore leaderDistributedDataStore;
@@ -129,19 +137,23 @@ public class DistributedDataStoreRemotingIntegrationTest {
         JavaTestKit.shutdownActorSystem(follower2System);
     }
 
-    private void initDatastores(String type) {
-        initDatastores(type, MODULE_SHARDS_CONFIG_2);
+    private void initDatastoresWithCars(String type) {
+        initDatastores(type, MODULE_SHARDS_CARS_ONLY_1_2, CARS);
     }
 
-    private void initDatastores(String type, String moduleShardsConfig) {
+    private void initDatastoresWithCarsAndPeople(String type) {
+        initDatastores(type, MODULE_SHARDS_CARS_PEOPLE_1_2, CARS_AND_PEOPLE);
+    }
+
+    private void initDatastores(String type, String moduleShardsConfig, String[] shards) {
         leaderTestKit = new IntegrationTestKit(leaderSystem, leaderDatastoreContextBuilder);
 
-        leaderDistributedDataStore = leaderTestKit.setupDistributedDataStore(type, moduleShardsConfig, false, SHARD_NAMES);
+        leaderDistributedDataStore = leaderTestKit.setupDistributedDataStore(type, moduleShardsConfig, false, shards);
 
         followerTestKit = new IntegrationTestKit(followerSystem, followerDatastoreContextBuilder);
-        followerDistributedDataStore = followerTestKit.setupDistributedDataStore(type, moduleShardsConfig, false, SHARD_NAMES);
+        followerDistributedDataStore = followerTestKit.setupDistributedDataStore(type, moduleShardsConfig, false, shards);
 
-        leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorContext(), SHARD_NAMES);
+        leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorContext(), shards);
     }
 
     private static void verifyCars(DOMStoreReadTransaction readTx, MapEntryNode... entries) throws Exception {
@@ -171,7 +183,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
     @Test
     public void testWriteTransactionWithSingleShard() throws Exception {
         String testName = "testWriteTransactionWithSingleShard";
-        initDatastores(testName);
+        initDatastoresWithCars(testName);
 
         String followerCarShardName = "member-2-shard-cars-" + testName;
         InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 2, ApplyJournalEntries.class );
@@ -220,7 +232,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
         ActorSystem newSystem = ActorSystem.create("reinstated-member2", ConfigFactory.load().getConfig("Member2"));
 
         DistributedDataStore member2Datastore = new IntegrationTestKit(newSystem, leaderDatastoreContextBuilder).
-                setupDistributedDataStore(testName, "module-shards-member2", true, SHARD_NAMES);
+                setupDistributedDataStore(testName, "module-shards-member2", true, CARS_AND_PEOPLE);
 
         verifyCars(member2Datastore.newReadOnlyTransaction(), car2);
 
@@ -229,7 +241,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testReadWriteTransactionWithSingleShard() throws Exception {
-        initDatastores("testReadWriteTransactionWithSingleShard");
+        initDatastoresWithCars("testReadWriteTransactionWithSingleShard");
 
         DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
         assertNotNull("newReadWriteTransaction returned null", rwTx);
@@ -255,7 +267,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testWriteTransactionWithMultipleShards() throws Exception {
-        initDatastores("testWriteTransactionWithMultipleShards");
+        initDatastoresWithCarsAndPeople("testWriteTransactionWithMultipleShards");
 
         DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
@@ -278,7 +290,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testReadWriteTransactionWithMultipleShards() throws Exception {
-        initDatastores("testReadWriteTransactionWithMultipleShards");
+        initDatastoresWithCarsAndPeople("testReadWriteTransactionWithMultipleShards");
 
         DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
         assertNotNull("newReadWriteTransaction returned null", rwTx);
@@ -301,7 +313,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testTransactionChainWithSingleShard() throws Exception {
-        initDatastores("testTransactionChainWithSingleShard");
+        initDatastoresWithCars("testTransactionChainWithSingleShard");
 
         DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 
@@ -348,7 +360,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testTransactionChainWithMultipleShards() throws Exception{
-        initDatastores("testTransactionChainWithMultipleShards");
+        initDatastoresWithCarsAndPeople("testTransactionChainWithMultipleShards");
 
         DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 
@@ -403,7 +415,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testChainedTransactionFailureWithSingleShard() throws Exception {
-        initDatastores("testChainedTransactionFailureWithSingleShard");
+        initDatastoresWithCars("testChainedTransactionFailureWithSingleShard");
 
         ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
@@ -436,7 +448,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testChainedTransactionFailureWithMultipleShards() throws Exception {
-        initDatastores("testChainedTransactionFailureWithMultipleShards");
+        initDatastoresWithCarsAndPeople("testChainedTransactionFailureWithMultipleShards");
 
         ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
@@ -474,7 +486,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
     @Test
     public void testSingleShardTransactionsWithLeaderChanges() throws Exception {
         String testName = "testSingleShardTransactionsWithLeaderChanges";
-        initDatastores(testName);
+        initDatastoresWithCars(testName);
 
         String followerCarShardName = "member-2-shard-cars-" + testName;
         InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 1, ApplyJournalEntries.class );
@@ -492,12 +504,12 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
         // Switch the leader to the follower
 
-        followerDatastoreContextBuilder.shardElectionTimeoutFactor(1);
-        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
+        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder.
+                shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
 
         JavaTestKit.shutdownActorSystem(leaderSystem, null, true);
 
-        followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorContext(), SHARD_NAMES);
+        followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorContext(), CARS);
 
         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
         Cluster.get(leaderSystem).join(MEMBER_2_ADDRESS);
@@ -505,9 +517,9 @@ public class DistributedDataStoreRemotingIntegrationTest {
         DatastoreContext.Builder newMember1Builder = DatastoreContext.newBuilder().
                 shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
         IntegrationTestKit newMember1TestKit = new IntegrationTestKit(leaderSystem, newMember1Builder);
-        newMember1TestKit.setupDistributedDataStore(testName, MODULE_SHARDS_CONFIG_2, false, SHARD_NAMES);
+        newMember1TestKit.setupDistributedDataStore(testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS);
 
-        followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), SHARD_NAMES);
+        followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), CARS);
 
         // Write a car entry to the new leader - should switch to local Tx
 
@@ -524,7 +536,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testReadyLocalTransactionForwardedToLeader() throws Exception {
-        initDatastores("testReadyLocalTransactionForwardedToLeader");
+        initDatastoresWithCars("testReadyLocalTransactionForwardedToLeader");
         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), "cars");
 
         Optional<ActorRef> carsFollowerShard = followerDistributedDataStore.getActorContext().findLocalShard("cars");
@@ -586,7 +598,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testForwardedReadyTransactionForwardedToLeader() throws Exception {
-        initDatastores("testForwardedReadyTransactionForwardedToLeader");
+        initDatastoresWithCars("testForwardedReadyTransactionForwardedToLeader");
         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), "cars");
 
         Optional<ActorRef> carsFollowerShard = followerDistributedDataStore.getActorContext().findLocalShard("cars");
@@ -648,16 +660,80 @@ public class DistributedDataStoreRemotingIntegrationTest {
         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
     }
 
+    @Test
+    public void testTransactionForwardedToLeaderAfterRetry() throws Exception {
+        initDatastoresWithCars("testTransactionForwardedToLeaderAfterRetry");
+
+        // Do an initial write to get the primary shard info cached.
+
+        DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
+        writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
+        writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
+        followerTestKit.doCommit(writeTx.ready());
+
+        // Wait for the commit to be replicated to the follower.
+
+        MemberNode.verifyRaftState(followerDistributedDataStore, "cars", new RaftStateVerifier() {
+            @Override
+            public void verify(OnDemandRaftState raftState) {
+                assertEquals("getLastApplied", 0, raftState.getLastApplied());
+            }
+        });
+
+        // Create and prepare wo and rw tx's.
+
+        writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
+        MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
+        writeTx.write(CarsModel.newCarPath("optima"), car1);
+
+        DOMStoreReadWriteTransaction readWriteTx = followerDistributedDataStore.newReadWriteTransaction();
+        MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(30000));
+        readWriteTx.write(CarsModel.newCarPath("sportage"), car2);
+
+        IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars", new ShardStatsVerifier() {
+            @Override
+            public void verify(ShardStats stats) {
+                assertEquals("getReadWriteTransactionCount", 1, stats.getReadWriteTransactionCount());
+            }
+        });
+
+        // Disable elections on the leader so it switches to follower.
+
+        sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder.
+                customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName()).
+                shardElectionTimeoutFactor(10));
+
+        leaderTestKit.waitUntilNoLeader(leaderDistributedDataStore.getActorContext(), "cars");
+
+        // Submit tx's and enable elections on the follower so it becomes the leader, at which point the
+        // readied tx's should get forwarded from the previous leader.
+
+        DOMStoreThreePhaseCommitCohort cohort1 = writeTx.ready();
+        DOMStoreThreePhaseCommitCohort cohort2 = readWriteTx.ready();
+
+        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder.
+                customRaftPolicyImplementation(null).shardElectionTimeoutFactor(1));
+
+        followerTestKit.doCommit(cohort1);
+        followerTestKit.doCommit(cohort2);
+
+        verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
+    }
+
     @Test(expected=NoShardLeaderException.class)
     public void testTransactionWithIsolatedLeader() throws Throwable {
-        leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(300);
+        leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(200);
         String testName = "testTransactionWithIsolatedLeader";
-        initDatastores(testName);
+        initDatastoresWithCars(testName);
 
         JavaTestKit.shutdownActorSystem(followerSystem, null, true);
 
-        Uninterruptibles.sleepUninterruptibly(leaderDistributedDataStore.getActorContext().getDatastoreContext()
-                .getShardRaftConfig().getElectionTimeOutInterval().toMillis() * 3, TimeUnit.MILLISECONDS);
+        MemberNode.verifyRaftState(leaderDistributedDataStore, "cars", new RaftStateVerifier() {
+            @Override
+            public void verify(OnDemandRaftState raftState) {
+                assertEquals("getRaftState", "IsolatedLeader", raftState.getRaftState());
+            }
+        });
 
         DOMStoreWriteTransaction writeTx = leaderDistributedDataStore.newWriteOnlyTransaction();
         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
@@ -671,8 +747,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test(expected=AskTimeoutException.class)
     public void testTransactionWithShardLeaderNotResponding() throws Throwable {
-        followerDatastoreContextBuilder.shardElectionTimeoutFactor(30);
-        initDatastores("testTransactionWithShardLeaderNotResponding");
+        initDatastoresWithCars("testTransactionWithShardLeaderNotResponding");
 
         // Do an initial read to get the primary shard info cached.
 
@@ -702,7 +777,7 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test(expected=NoShardLeaderException.class)
     public void testTransactionWithCreateTxFailureDueToNoLeader() throws Throwable {
-        initDatastores("testTransactionWithCreateTxFailureDueToNoLeader");
+        initDatastoresWithCars("testTransactionWithCreateTxFailureDueToNoLeader");
 
         // Do an initial read to get the primary shard info cached.
 
@@ -715,8 +790,8 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
         Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 
-        followerDatastoreContextBuilder.operationTimeoutInMillis(10).shardElectionTimeoutFactor(1);
-        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
+        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder.
+                operationTimeoutInMillis(10).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
 
         DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 
@@ -731,14 +806,13 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
     @Test
     public void testTransactionRetryWithInitialAskTimeoutExOnCreateTx() throws Exception {
-        followerDatastoreContextBuilder.shardElectionTimeoutFactor(30);
         String testName = "testTransactionRetryWithInitialAskTimeoutExOnCreateTx";
-        initDatastores(testName, MODULE_SHARDS_CONFIG_3);
+        initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS);
 
         DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder().
                 shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
         IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System, follower2DatastoreContextBuilder);
-        follower2TestKit.setupDistributedDataStore(testName, MODULE_SHARDS_CONFIG_3, false, SHARD_NAMES);
+        follower2TestKit.setupDistributedDataStore(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false, CARS);
 
         // Do an initial read to get the primary shard info cached.
 
@@ -749,8 +823,8 @@ public class DistributedDataStoreRemotingIntegrationTest {
 
         JavaTestKit.shutdownActorSystem(leaderSystem, null, true);
 
-        followerDatastoreContextBuilder.operationTimeoutInMillis(500);
-        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
+        sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder.
+                operationTimeoutInMillis(500).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
 
         DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 
@@ -760,11 +834,12 @@ public class DistributedDataStoreRemotingIntegrationTest {
     }
 
     private static void sendDatastoreContextUpdate(DistributedDataStore dataStore, final Builder builder) {
+        final Builder newBuilder = DatastoreContext.newBuilderFrom(builder.build());
         DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
         Answer<DatastoreContext> answer = new Answer<DatastoreContext>() {
             @Override
             public DatastoreContext answer(InvocationOnMock invocation) {
-                return builder.build();
+                return newBuilder.build();
             }
         };
         Mockito.doAnswer(answer).when(mockContextFactory).getBaseDatastoreContext();