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

   1 /*
   2  * Copyright (c) 2015, 2017 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;
   9
  10 import static org.awaitility.Awaitility.await;
  11 import static org.hamcrest.CoreMatchers.instanceOf;
  12 import static org.hamcrest.MatcherAssert.assertThat;
  13 import static org.hamcrest.Matchers.equalTo;
  14 import static org.junit.Assert.assertEquals;
  15 import static org.junit.Assert.assertNotNull;
  16 import static org.junit.Assert.assertThrows;
  17 import static org.junit.Assert.assertTrue;
  18 import static org.junit.Assume.assumeTrue;
  19 import static org.mockito.ArgumentMatchers.any;
  20 import static org.mockito.ArgumentMatchers.anyString;
  21 import static org.mockito.ArgumentMatchers.eq;
  22 import static org.mockito.Mockito.doAnswer;
  23 import static org.mockito.Mockito.mock;
  24 import static org.mockito.Mockito.timeout;
  25 import static org.mockito.Mockito.verify;
  26
  27 import akka.actor.ActorRef;
  28 import akka.actor.ActorSelection;
  29 import akka.actor.ActorSystem;
  30 import akka.actor.Address;
  31 import akka.actor.AddressFromURIString;
  32 import akka.cluster.Cluster;
  33 import akka.cluster.Member;
  34 import akka.dispatch.Futures;
  35 import akka.pattern.Patterns;
  36 import akka.testkit.javadsl.TestKit;
  37 import com.google.common.base.Stopwatch;
  38 import com.google.common.base.Throwables;
  39 import com.google.common.collect.ImmutableMap;
  40 import com.google.common.util.concurrent.ListenableFuture;
  41 import com.google.common.util.concurrent.MoreExecutors;
  42 import com.google.common.util.concurrent.Uninterruptibles;
  43 import com.typesafe.config.ConfigFactory;
  44 import java.util.Arrays;
  45 import java.util.Collection;
  46 import java.util.Collections;
  47 import java.util.LinkedList;
  48 import java.util.List;
  49 import java.util.Optional;
  50 import java.util.concurrent.ExecutionException;
  51 import java.util.concurrent.ExecutorService;
  52 import java.util.concurrent.Executors;
  53 import java.util.concurrent.TimeUnit;
  54 import java.util.concurrent.atomic.AtomicBoolean;
  55 import java.util.concurrent.atomic.AtomicLong;
  56 import org.junit.After;
  57 import org.junit.Before;
  58 import org.junit.Test;
  59 import org.junit.runner.RunWith;
  60 import org.junit.runners.Parameterized;
  61 import org.junit.runners.Parameterized.Parameter;
  62 import org.junit.runners.Parameterized.Parameters;
  63 import org.mockito.stubbing.Answer;
  64 import org.opendaylight.controller.cluster.access.client.RequestTimeoutException;
  65 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  66 import org.opendaylight.controller.cluster.databroker.ClientBackedDataStore;
  67 import org.opendaylight.controller.cluster.databroker.ConcurrentDOMDataBroker;
  68 import org.opendaylight.controller.cluster.databroker.TestClientBackedDataStore;
  69 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
  70 import org.opendaylight.controller.cluster.datastore.TestShard.RequestFrontendMetadata;
  71 import org.opendaylight.controller.cluster.datastore.TestShard.StartDropMessages;
  72 import org.opendaylight.controller.cluster.datastore.TestShard.StopDropMessages;
  73 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  74 import org.opendaylight.controller.cluster.datastore.exceptions.ShardLeaderNotRespondingException;
  75 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
  76 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
  77 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
  78 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
  79 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
  80 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
  81 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
  82 import org.opendaylight.controller.cluster.datastore.persisted.FrontendClientMetadata;
  83 import org.opendaylight.controller.cluster.datastore.persisted.FrontendShardDataTreeSnapshotMetadata;
  84 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
  85 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
  86 import org.opendaylight.controller.cluster.datastore.utils.UnsignedLongBitmap;
  87 import org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow;
  88 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
  89 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
  90 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
  91 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
  92 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
  93 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
  94 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  95 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
  96 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  97 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  98 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
  99 import org.opendaylight.controller.md.cluster.datastore.model.PeopleModel;
 100 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
 101 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
 102 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
 103 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
 104 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
 105 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
 106 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
 107 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
 108 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
 109 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
 110 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
 111 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
 112 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
 113 import org.opendaylight.yangtools.yang.common.Uint64;
 114 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 115 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 116 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 117 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 118 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
 119 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
 120 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 121 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
 122 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
 123 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 124 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
 125 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
 126 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 127 import scala.collection.Set;
 128 import scala.concurrent.Await;
 129 import scala.concurrent.Future;
 130 import scala.concurrent.duration.FiniteDuration;
 131
 132 /**
 133  * End-to-end distributed data store tests that exercise remote shards and transactions.
 134  *
 135  * @author Thomas Pantelis
 136  */
 137 @RunWith(Parameterized.class)
 138 public class DistributedDataStoreRemotingIntegrationTest extends AbstractTest {
 139
 140     @Parameters(name = "{0}")
 141     public static Collection<Object[]> data() {
 142         return Arrays.asList(new Object[][] {
 143                 { TestDistributedDataStore.class, 7}, { TestClientBackedDataStore.class, 12 }
 144         });
 145     }
 146
 147     @Parameter(0)
 148     public Class<? extends AbstractDataStore> testParameter;
 149     @Parameter(1)
 150     public int commitTimeout;
 151
 152     private static final String[] CARS_AND_PEOPLE = {"cars", "people"};
 153     private static final String[] CARS = {"cars"};
 154
 155     private static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse(
 156             "akka://cluster-test@127.0.0.1:2558");
 157     private static final Address MEMBER_2_ADDRESS = AddressFromURIString.parse(
 158             "akka://cluster-test@127.0.0.1:2559");
 159
 160     private static final String MODULE_SHARDS_CARS_ONLY_1_2 = "module-shards-cars-member-1-and-2.conf";
 161     private static final String MODULE_SHARDS_CARS_PEOPLE_1_2 = "module-shards-member1-and-2.conf";
 162     private static final String MODULE_SHARDS_CARS_PEOPLE_1_2_3 = "module-shards-member1-and-2-and-3.conf";
 163     private static final String MODULE_SHARDS_CARS_1_2_3 = "module-shards-cars-member-1-and-2-and-3.conf";
 164
 165     private ActorSystem leaderSystem;
 166     private ActorSystem followerSystem;
 167     private ActorSystem follower2System;
 168
 169     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
 170             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2);
 171
 172     private final DatastoreContext.Builder followerDatastoreContextBuilder =
 173             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
 174                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 175     private final TransactionIdentifier tx1 = nextTransactionId();
 176     private final TransactionIdentifier tx2 = nextTransactionId();
 177
 178     private AbstractDataStore followerDistributedDataStore;
 179     private AbstractDataStore leaderDistributedDataStore;
 180     private IntegrationTestKit followerTestKit;
 181     private IntegrationTestKit leaderTestKit;
 182
 183     @Before
 184     public void setUp() {
 185         InMemoryJournal.clear();
 186         InMemorySnapshotStore.clear();
 187
 188         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 189         Cluster.get(leaderSystem).join(MEMBER_1_ADDRESS);
 190
 191         followerSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
 192         Cluster.get(followerSystem).join(MEMBER_1_ADDRESS);
 193
 194         follower2System = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member3"));
 195         Cluster.get(follower2System).join(MEMBER_1_ADDRESS);
 196     }
 197
 198     @After
 199     public void tearDown() {
 200         if (followerDistributedDataStore != null) {
 201             leaderDistributedDataStore.close();
 202         }
 203         if (leaderDistributedDataStore != null) {
 204             leaderDistributedDataStore.close();
 205         }
 206
 207         TestKit.shutdownActorSystem(leaderSystem, true);
 208         TestKit.shutdownActorSystem(followerSystem, true);
 209         TestKit.shutdownActorSystem(follower2System,true);
 210
 211         InMemoryJournal.clear();
 212         InMemorySnapshotStore.clear();
 213     }
 214
 215     private void initDatastoresWithCars(final String type) throws Exception {
 216         initDatastores(type, MODULE_SHARDS_CARS_ONLY_1_2, CARS);
 217     }
 218
 219     private void initDatastoresWithCarsAndPeople(final String type) throws Exception {
 220         initDatastores(type, MODULE_SHARDS_CARS_PEOPLE_1_2, CARS_AND_PEOPLE);
 221     }
 222
 223     private void initDatastores(final String type, final String moduleShardsConfig, final String[] shards)
 224             throws Exception {
 225         initDatastores(type, moduleShardsConfig, shards, leaderDatastoreContextBuilder,
 226                 followerDatastoreContextBuilder);
 227     }
 228
 229     private void initDatastores(final String type, final String moduleShardsConfig, final String[] shards,
 230             final DatastoreContext.Builder leaderBuilder, final DatastoreContext.Builder followerBuilder)
 231                     throws Exception {
 232         leaderTestKit = new IntegrationTestKit(leaderSystem, leaderBuilder, commitTimeout);
 233
 234         leaderDistributedDataStore = leaderTestKit.setupAbstractDataStore(
 235                 testParameter, type, moduleShardsConfig, false, shards);
 236
 237         followerTestKit = new IntegrationTestKit(followerSystem, followerBuilder, commitTimeout);
 238         followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
 239                 testParameter, type, moduleShardsConfig, false, shards);
 240
 241         leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorUtils(), shards);
 242
 243         leaderTestKit.waitForMembersUp("member-2");
 244         followerTestKit.waitForMembersUp("member-1");
 245     }
 246
 247     private static void verifyCars(final DOMStoreReadTransaction readTx, final MapEntryNode... entries)
 248             throws Exception {
 249         final Optional<NormalizedNode> optional = readTx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS);
 250         assertTrue("isPresent", optional.isPresent());
 251
 252         final CollectionNodeBuilder<MapEntryNode, SystemMapNode> listBuilder = ImmutableNodes.mapNodeBuilder(
 253                 CarsModel.CAR_QNAME);
 254         for (final NormalizedNode entry: entries) {
 255             listBuilder.withChild((MapEntryNode) entry);
 256         }
 257
 258         assertEquals("Car list node", listBuilder.build(), optional.get());
 259     }
 260
 261     private static void verifyNode(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path,
 262             final NormalizedNode expNode) throws Exception {
 263         assertEquals(Optional.of(expNode), readTx.read(path).get(5, TimeUnit.SECONDS));
 264     }
 265
 266     private static void verifyExists(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path)
 267             throws Exception {
 268         assertEquals("exists", Boolean.TRUE, readTx.exists(path).get(5, TimeUnit.SECONDS));
 269     }
 270
 271     @Test
 272     public void testWriteTransactionWithSingleShard() throws Exception {
 273         final String testName = "testWriteTransactionWithSingleShard";
 274         initDatastoresWithCars(testName);
 275
 276         final String followerCarShardName = "member-2-shard-cars-" + testName;
 277
 278         DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 279         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 280
 281         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 282         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 283
 284         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 285         final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 286         writeTx.merge(car1Path, car1);
 287
 288         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
 289         final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
 290         writeTx.merge(car2Path, car2);
 291
 292         followerTestKit.doCommit(writeTx.ready());
 293
 294         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 295
 296         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 297
 298         // Test delete
 299
 300         writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 301
 302         writeTx.delete(car1Path);
 303
 304         followerTestKit.doCommit(writeTx.ready());
 305
 306         verifyExists(followerDistributedDataStore.newReadOnlyTransaction(), car2Path);
 307
 308         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
 309
 310         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car2);
 311
 312         // Re-instate the follower member 2 as a single-node to verify replication and recovery.
 313
 314         // The following is a bit tricky. Before we reinstate the follower we need to ensure it has persisted and
 315         // applied and all the log entries from the leader. Since we've verified the car data above we know that
 316         // all the transactions have been applied on the leader so we first read and capture its lastAppliedIndex.
 317         final AtomicLong leaderLastAppliedIndex = new AtomicLong();
 318         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, CARS[0],
 319             state -> leaderLastAppliedIndex.set(state.getLastApplied()));
 320
 321         // Now we need to make sure the follower has persisted the leader's lastAppliedIndex via ApplyJournalEntries.
 322         // However we don't know exactly how many ApplyJournalEntries messages there will be as it can differ between
 323         // the tell-based and ask-based front-ends. For ask-based there will be exactly 2 ApplyJournalEntries but
 324         // tell-based persists additional payloads which could be replicated and applied in a batch resulting in
 325         // either 2 or 3 ApplyJournalEntries. To handle this we read the follower's persisted ApplyJournalEntries
 326         // until we find the one that encompasses the leader's lastAppliedIndex.
 327         Stopwatch sw = Stopwatch.createStarted();
 328         boolean done = false;
 329         while (!done) {
 330             final List<ApplyJournalEntries> entries = InMemoryJournal.get(followerCarShardName,
 331                     ApplyJournalEntries.class);
 332             for (ApplyJournalEntries aje: entries) {
 333                 if (aje.getToIndex() >= leaderLastAppliedIndex.get()) {
 334                     done = true;
 335                     break;
 336                 }
 337             }
 338
 339             assertTrue("Follower did not persist ApplyJournalEntries containing leader's lastAppliedIndex "
 340                     + leaderLastAppliedIndex + ". Entries persisted: " + entries, sw.elapsed(TimeUnit.SECONDS) <= 5);
 341
 342             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 343         }
 344
 345         TestKit.shutdownActorSystem(leaderSystem, true);
 346         TestKit.shutdownActorSystem(followerSystem, true);
 347
 348         final ActorSystem newSystem = newActorSystem("reinstated-member2", "Member2");
 349
 350         try (AbstractDataStore member2Datastore = new IntegrationTestKit(newSystem, leaderDatastoreContextBuilder,
 351                 commitTimeout)
 352                 .setupAbstractDataStore(testParameter, testName, "module-shards-member2", true, CARS)) {
 353             verifyCars(member2Datastore.newReadOnlyTransaction(), car2);
 354         }
 355     }
 356
 357     @Test
 358     public void testSingleTransactionsWritesInQuickSuccession() throws Exception {
 359         initDatastoresWithCars("testSingleTransactionsWritesInQuickSuccession");
 360
 361         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 362
 363         DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 364         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 365         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 366         followerTestKit.doCommit(writeTx.ready());
 367
 368         int numCars = 5;
 369         for (int i = 0; i < numCars; i++) {
 370             writeTx = txChain.newWriteOnlyTransaction();
 371             writeTx.write(CarsModel.newCarPath("car" + i), CarsModel.newCarEntry("car" + i, Uint64.valueOf(20000)));
 372             followerTestKit.doCommit(writeTx.ready());
 373
 374             try (var tx = txChain.newReadOnlyTransaction()) {
 375                 tx.read(CarsModel.BASE_PATH).get();
 376             }
 377         }
 378
 379         // wait to let the shard catch up with purged
 380         await("Range set leak test").atMost(5, TimeUnit.SECONDS)
 381                 .pollInterval(500, TimeUnit.MILLISECONDS)
 382                 .untilAsserted(() -> {
 383                     final var localShard = leaderDistributedDataStore.getActorUtils().findLocalShard("cars")
 384                         .orElseThrow();
 385                     final var frontendMetadata =
 386                         (FrontendShardDataTreeSnapshotMetadata) leaderDistributedDataStore.getActorUtils()
 387                             .executeOperation(localShard, new RequestFrontendMetadata());
 388
 389                     final var clientMeta = frontendMetadata.getClients().get(0);
 390                     if (leaderDistributedDataStore.getActorUtils().getDatastoreContext().isUseTellBasedProtocol()) {
 391                         assertTellClientMetadata(clientMeta, numCars * 2);
 392                     } else {
 393                         assertAskClientMetadata(clientMeta);
 394                     }
 395                 });
 396
 397         try (var tx = txChain.newReadOnlyTransaction()) {
 398             final var body = tx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS).orElseThrow().body();
 399             assertThat(body, instanceOf(Collection.class));
 400             assertEquals(numCars, ((Collection<?>) body).size());
 401         }
 402     }
 403
 404     private void assertAskClientMetadata(final FrontendClientMetadata clientMeta) {
 405         // ask based should track no metadata
 406         assertEquals(List.of(), clientMeta.getCurrentHistories());
 407     }
 408
 409     private void assertTellClientMetadata(final FrontendClientMetadata clientMeta, final long lastPurged) {
 410         final var iterator = clientMeta.getCurrentHistories().iterator();
 411         var metadata = iterator.next();
 412         while (iterator.hasNext() && metadata.getHistoryId() != 1) {
 413             metadata = iterator.next();
 414         }
 415
 416         // FIXME: CONTROLLER-1991: remove this assumption
 417         assumeTrue(false);
 418
 419         assertEquals(UnsignedLongBitmap.of(), metadata.getClosedTransactions());
 420         assertEquals("[[0.." + lastPurged + "]]", metadata.getPurgedTransactions().ranges().toString());
 421     }
 422
 423     @Test
 424     public void testCloseTransactionMetadataLeak() throws Exception {
 425         // FIXME: Ask-based frontend seems to have some issues with back to back close
 426         assumeTrue(testParameter.isAssignableFrom(TestClientBackedDataStore.class));
 427
 428         initDatastoresWithCars("testCloseTransactionMetadataLeak");
 429
 430         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 431
 432         DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 433         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 434         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 435         followerTestKit.doCommit(writeTx.ready());
 436
 437         int numCars = 5;
 438         for (int i = 0; i < numCars; i++) {
 439             writeTx = txChain.newWriteOnlyTransaction();
 440             writeTx.close();
 441
 442             try (var tx = txChain.newReadOnlyTransaction()) {
 443                 tx.read(CarsModel.BASE_PATH).get();
 444             }
 445         }
 446
 447         writeTx = txChain.newWriteOnlyTransaction();
 448         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 449         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 450         followerTestKit.doCommit(writeTx.ready());
 451
 452         // wait to let the shard catch up with purged
 453         await("Close transaction purge leak test.").atMost(5, TimeUnit.SECONDS)
 454                 .pollInterval(500, TimeUnit.MILLISECONDS)
 455                 .untilAsserted(() -> {
 456                     final var localShard = leaderDistributedDataStore.getActorUtils().findLocalShard("cars")
 457                         .orElseThrow();
 458                     final var frontendMetadata =
 459                             (FrontendShardDataTreeSnapshotMetadata) leaderDistributedDataStore.getActorUtils()
 460                                     .executeOperation(localShard, new RequestFrontendMetadata());
 461
 462                     final var clientMeta = frontendMetadata.getClients().get(0);
 463                     if (leaderDistributedDataStore.getActorUtils().getDatastoreContext().isUseTellBasedProtocol()) {
 464                         assertTellClientMetadata(clientMeta, numCars * 2 + 1);
 465                     } else {
 466                         assertAskClientMetadata(clientMeta);
 467                     }
 468                 });
 469
 470         try (var tx = txChain.newReadOnlyTransaction()) {
 471             final var body = tx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS).orElseThrow().body();
 472             assertThat(body, instanceOf(Collection.class));
 473             assertEquals(numCars, ((Collection<?>) body).size());
 474         }
 475     }
 476
 477     @Test
 478     public void testReadWriteTransactionWithSingleShard() throws Exception {
 479         initDatastoresWithCars("testReadWriteTransactionWithSingleShard");
 480
 481         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 482         assertNotNull("newReadWriteTransaction returned null", rwTx);
 483
 484         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 485         rwTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 486
 487         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 488         rwTx.merge(CarsModel.newCarPath("optima"), car1);
 489
 490         verifyCars(rwTx, car1);
 491
 492         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
 493         final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
 494         rwTx.merge(car2Path, car2);
 495
 496         verifyExists(rwTx, car2Path);
 497
 498         followerTestKit.doCommit(rwTx.ready());
 499
 500         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 501     }
 502
 503     @Test
 504     public void testWriteTransactionWithMultipleShards() throws Exception {
 505         initDatastoresWithCarsAndPeople("testWriteTransactionWithMultipleShards");
 506
 507         final DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 508         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 509
 510         final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
 511         final NormalizedNode carsNode = CarsModel.emptyContainer();
 512         writeTx.write(carsPath, carsNode);
 513
 514         final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
 515         final NormalizedNode peopleNode = PeopleModel.emptyContainer();
 516         writeTx.write(peoplePath, peopleNode);
 517
 518         followerTestKit.doCommit(writeTx.ready());
 519
 520         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 521
 522         verifyNode(readTx, carsPath, carsNode);
 523         verifyNode(readTx, peoplePath, peopleNode);
 524     }
 525
 526     @Test
 527     public void testReadWriteTransactionWithMultipleShards() throws Exception {
 528         initDatastoresWithCarsAndPeople("testReadWriteTransactionWithMultipleShards");
 529
 530         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 531         assertNotNull("newReadWriteTransaction returned null", rwTx);
 532
 533         final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
 534         final NormalizedNode carsNode = CarsModel.emptyContainer();
 535         rwTx.write(carsPath, carsNode);
 536
 537         final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
 538         final NormalizedNode peopleNode = PeopleModel.emptyContainer();
 539         rwTx.write(peoplePath, peopleNode);
 540
 541         followerTestKit.doCommit(rwTx.ready());
 542
 543         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 544
 545         verifyNode(readTx, carsPath, carsNode);
 546         verifyNode(readTx, peoplePath, peopleNode);
 547     }
 548
 549     @Test
 550     public void testTransactionChainWithSingleShard() throws Exception {
 551         initDatastoresWithCars("testTransactionChainWithSingleShard");
 552
 553         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 554
 555         // Add the top-level cars container with write-only.
 556
 557         final DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 558         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 559
 560         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 561
 562         final DOMStoreThreePhaseCommitCohort writeTxReady = writeTx.ready();
 563
 564         // Verify the top-level cars container with read-only.
 565
 566         verifyNode(txChain.newReadOnlyTransaction(), CarsModel.BASE_PATH, CarsModel.emptyContainer());
 567
 568         // Perform car operations with read-write.
 569
 570         final DOMStoreReadWriteTransaction rwTx = txChain.newReadWriteTransaction();
 571
 572         verifyNode(rwTx, CarsModel.BASE_PATH, CarsModel.emptyContainer());
 573
 574         rwTx.merge(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 575
 576         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 577         final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 578         rwTx.write(car1Path, car1);
 579
 580         verifyExists(rwTx, car1Path);
 581
 582         verifyCars(rwTx, car1);
 583
 584         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
 585         rwTx.merge(CarsModel.newCarPath("sportage"), car2);
 586
 587         rwTx.delete(car1Path);
 588
 589         followerTestKit.doCommit(writeTxReady);
 590
 591         followerTestKit.doCommit(rwTx.ready());
 592
 593         txChain.close();
 594
 595         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
 596     }
 597
 598     @Test
 599     public void testTransactionChainWithMultipleShards() throws Exception {
 600         initDatastoresWithCarsAndPeople("testTransactionChainWithMultipleShards");
 601
 602         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 603
 604         DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 605         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 606
 607         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 608         writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 609
 610         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 611         writeTx.write(PeopleModel.PERSON_LIST_PATH, PeopleModel.newPersonMapNode());
 612
 613         followerTestKit.doCommit(writeTx.ready());
 614
 615         final DOMStoreReadWriteTransaction readWriteTx = txChain.newReadWriteTransaction();
 616
 617         final MapEntryNode car = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 618         final YangInstanceIdentifier carPath = CarsModel.newCarPath("optima");
 619         readWriteTx.write(carPath, car);
 620
 621         final MapEntryNode person = PeopleModel.newPersonEntry("jack");
 622         final YangInstanceIdentifier personPath = PeopleModel.newPersonPath("jack");
 623         readWriteTx.merge(personPath, person);
 624
 625         assertEquals(Optional.of(car), readWriteTx.read(carPath).get(5, TimeUnit.SECONDS));
 626         assertEquals(Optional.of(person), readWriteTx.read(personPath).get(5, TimeUnit.SECONDS));
 627
 628         final DOMStoreThreePhaseCommitCohort cohort2 = readWriteTx.ready();
 629
 630         writeTx = txChain.newWriteOnlyTransaction();
 631
 632         writeTx.delete(personPath);
 633
 634         final DOMStoreThreePhaseCommitCohort cohort3 = writeTx.ready();
 635
 636         followerTestKit.doCommit(cohort2);
 637         followerTestKit.doCommit(cohort3);
 638
 639         txChain.close();
 640
 641         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 642         verifyCars(readTx, car);
 643
 644         assertEquals(Optional.empty(), readTx.read(personPath).get(5, TimeUnit.SECONDS));
 645     }
 646
 647     @Test
 648     public void testChainedTransactionFailureWithSingleShard() throws Exception {
 649         initDatastoresWithCars("testChainedTransactionFailureWithSingleShard");
 650
 651         final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
 652                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
 653                         LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
 654                         MoreExecutors.directExecutor());
 655
 656         final DOMTransactionChainListener listener = mock(DOMTransactionChainListener.class);
 657         final DOMTransactionChain txChain = broker.createTransactionChain(listener);
 658
 659         final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 660
 661         final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 662                 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
 663                     .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
 664
 665         writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
 666
 667         final var ex = assertThrows(ExecutionException.class, () -> writeTx.commit().get(5, TimeUnit.SECONDS))
 668             .getCause();
 669         assertThat(ex, instanceOf(TransactionCommitFailedException.class));
 670
 671         verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
 672
 673         txChain.close();
 674         broker.close();
 675     }
 676
 677     @Test
 678     public void testChainedTransactionFailureWithMultipleShards() throws Exception {
 679         initDatastoresWithCarsAndPeople("testChainedTransactionFailureWithMultipleShards");
 680
 681         final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
 682                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
 683                         LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
 684                         MoreExecutors.directExecutor());
 685
 686         final DOMTransactionChainListener listener = mock(DOMTransactionChainListener.class);
 687         final DOMTransactionChain txChain = broker.createTransactionChain(listener);
 688
 689         final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 690
 691         writeTx.put(LogicalDatastoreType.CONFIGURATION, PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 692
 693         final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 694                 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
 695                     .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
 696
 697         // Note that merge will validate the data and fail but put succeeds b/c deep validation is not
 698         // done for put for performance reasons.
 699         writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
 700
 701         final var ex = assertThrows(ExecutionException.class, () -> writeTx.commit().get(5, TimeUnit.SECONDS))
 702             .getCause();
 703         assertThat(ex, instanceOf(TransactionCommitFailedException.class));
 704
 705         verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
 706
 707         txChain.close();
 708         broker.close();
 709     }
 710
 711     @Test
 712     public void testSingleShardTransactionsWithLeaderChanges() throws Exception {
 713         followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
 714         final String testName = "testSingleShardTransactionsWithLeaderChanges";
 715         initDatastoresWithCars(testName);
 716
 717         final String followerCarShardName = "member-2-shard-cars-" + testName;
 718         InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 1, ApplyJournalEntries.class);
 719
 720         // Write top-level car container from the follower so it uses a remote Tx.
 721
 722         DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 723
 724         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 725         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 726
 727         followerTestKit.doCommit(writeTx.ready());
 728
 729         InMemoryJournal.waitForWriteMessagesComplete(followerCarShardName);
 730
 731         // Switch the leader to the follower
 732
 733         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
 734                 .shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
 735
 736         TestKit.shutdownActorSystem(leaderSystem, true);
 737         Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
 738
 739         followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorUtils(), CARS);
 740
 741         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 742         Cluster.get(leaderSystem).join(MEMBER_2_ADDRESS);
 743
 744         final DatastoreContext.Builder newMember1Builder = DatastoreContext.newBuilder()
 745                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
 746         IntegrationTestKit newMember1TestKit = new IntegrationTestKit(leaderSystem, newMember1Builder, commitTimeout);
 747
 748         try (AbstractDataStore ds =
 749                 newMember1TestKit.setupAbstractDataStore(
 750                         testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS)) {
 751
 752             followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), CARS);
 753
 754             // Write a car entry to the new leader - should switch to local Tx
 755
 756             writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 757
 758             MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 759             YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 760             writeTx.merge(car1Path, car1);
 761
 762             followerTestKit.doCommit(writeTx.ready());
 763
 764             verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1);
 765         }
 766     }
 767
 768     @SuppressWarnings("unchecked")
 769     @Test
 770     public void testReadyLocalTransactionForwardedToLeader() throws Exception {
 771         initDatastoresWithCars("testReadyLocalTransactionForwardedToLeader");
 772         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), "cars");
 773
 774         final Optional<ActorRef> carsFollowerShard =
 775                 followerDistributedDataStore.getActorUtils().findLocalShard("cars");
 776         assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
 777
 778         final DataTree dataTree = new InMemoryDataTreeFactory().create(
 779             DataTreeConfiguration.DEFAULT_OPERATIONAL, SchemaContextHelper.full());
 780
 781         // Send a tx with immediate commit.
 782
 783         DataTreeModification modification = dataTree.takeSnapshot().newModification();
 784         new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
 785         new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
 786
 787         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 788         new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
 789         modification.ready();
 790
 791         ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(tx1 , modification, true, Optional.empty());
 792
 793         carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
 794         Object resp = followerTestKit.expectMsgClass(Object.class);
 795         if (resp instanceof akka.actor.Status.Failure) {
 796             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 797         }
 798
 799         assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
 800
 801         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
 802
 803         // Send another tx without immediate commit.
 804
 805         modification = dataTree.takeSnapshot().newModification();
 806         MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(30000));
 807         new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
 808         modification.ready();
 809
 810         readyLocal = new ReadyLocalTransaction(tx2 , modification, false, Optional.empty());
 811
 812         carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
 813         resp = followerTestKit.expectMsgClass(Object.class);
 814         if (resp instanceof akka.actor.Status.Failure) {
 815             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 816         }
 817
 818         assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
 819
 820         final ActorSelection txActor = leaderDistributedDataStore.getActorUtils().actorSelection(
 821                 ((ReadyTransactionReply)resp).getCohortPath());
 822
 823         ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(leaderDistributedDataStore.getActorUtils(),
 824             List.of(new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor),
 825                 () -> DataStoreVersions.CURRENT_VERSION)), tx2);
 826         cohort.canCommit().get(5, TimeUnit.SECONDS);
 827         cohort.preCommit().get(5, TimeUnit.SECONDS);
 828         cohort.commit().get(5, TimeUnit.SECONDS);
 829
 830         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 831     }
 832
 833     @SuppressWarnings("unchecked")
 834     @Test
 835     public void testForwardedReadyTransactionForwardedToLeader() throws Exception {
 836         initDatastoresWithCars("testForwardedReadyTransactionForwardedToLeader");
 837         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), "cars");
 838
 839         final Optional<ActorRef> carsFollowerShard =
 840                 followerDistributedDataStore.getActorUtils().findLocalShard("cars");
 841         assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
 842
 843         carsFollowerShard.get().tell(GetShardDataTree.INSTANCE, followerTestKit.getRef());
 844         final DataTree dataTree = followerTestKit.expectMsgClass(DataTree.class);
 845
 846         // Send a tx with immediate commit.
 847
 848         DataTreeModification modification = dataTree.takeSnapshot().newModification();
 849         new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
 850         new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
 851
 852         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 853         new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
 854
 855         ForwardedReadyTransaction forwardedReady = new ForwardedReadyTransaction(tx1, DataStoreVersions.CURRENT_VERSION,
 856             new ReadWriteShardDataTreeTransaction(mock(ShardDataTreeTransactionParent.class), tx1, modification),
 857             true, Optional.empty());
 858
 859         carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
 860         Object resp = followerTestKit.expectMsgClass(Object.class);
 861         if (resp instanceof akka.actor.Status.Failure) {
 862             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 863         }
 864
 865         assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
 866
 867         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
 868
 869         // Send another tx without immediate commit.
 870
 871         modification = dataTree.takeSnapshot().newModification();
 872         MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(30000));
 873         new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
 874
 875         forwardedReady = new ForwardedReadyTransaction(tx2, DataStoreVersions.CURRENT_VERSION,
 876             new ReadWriteShardDataTreeTransaction(mock(ShardDataTreeTransactionParent.class), tx2, modification),
 877             false, Optional.empty());
 878
 879         carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
 880         resp = followerTestKit.expectMsgClass(Object.class);
 881         if (resp instanceof akka.actor.Status.Failure) {
 882             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 883         }
 884
 885         assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
 886
 887         ActorSelection txActor = leaderDistributedDataStore.getActorUtils().actorSelection(
 888                 ((ReadyTransactionReply)resp).getCohortPath());
 889
 890         final ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
 891             leaderDistributedDataStore.getActorUtils(), List.of(
 892                 new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor),
 893                     () -> DataStoreVersions.CURRENT_VERSION)), tx2);
 894         cohort.canCommit().get(5, TimeUnit.SECONDS);
 895         cohort.preCommit().get(5, TimeUnit.SECONDS);
 896         cohort.commit().get(5, TimeUnit.SECONDS);
 897
 898         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 899     }
 900
 901     @Test
 902     public void testTransactionForwardedToLeaderAfterRetry() throws Exception {
 903         // FIXME: remove when test passes also for ClientBackedDataStore
 904         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
 905
 906         followerDatastoreContextBuilder.shardBatchedModificationCount(2);
 907         leaderDatastoreContextBuilder.shardBatchedModificationCount(2);
 908         initDatastoresWithCarsAndPeople("testTransactionForwardedToLeaderAfterRetry");
 909
 910         // Do an initial write to get the primary shard info cached.
 911
 912         final DOMStoreWriteTransaction initialWriteTx = followerDistributedDataStore.newWriteOnlyTransaction();
 913         initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 914         initialWriteTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 915         followerTestKit.doCommit(initialWriteTx.ready());
 916
 917         // Wait for the commit to be replicated to the follower.
 918
 919         MemberNode.verifyRaftState(followerDistributedDataStore, "cars",
 920             raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
 921
 922         MemberNode.verifyRaftState(followerDistributedDataStore, "people",
 923             raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
 924
 925         // Prepare, ready and canCommit a WO tx that writes to 2 shards. This will become the current tx in
 926         // the leader shard.
 927
 928         final DOMStoreWriteTransaction writeTx1 = followerDistributedDataStore.newWriteOnlyTransaction();
 929         writeTx1.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 930         writeTx1.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 931         final DOMStoreThreePhaseCommitCohort writeTx1Cohort = writeTx1.ready();
 932         final ListenableFuture<Boolean> writeTx1CanCommit = writeTx1Cohort.canCommit();
 933         writeTx1CanCommit.get(5, TimeUnit.SECONDS);
 934
 935         // Prepare and ready another WO tx that writes to 2 shards but don't canCommit yet. This will be queued
 936         // in the leader shard.
 937
 938         final DOMStoreWriteTransaction writeTx2 = followerDistributedDataStore.newWriteOnlyTransaction();
 939         final LinkedList<MapEntryNode> cars = new LinkedList<>();
 940         int carIndex = 1;
 941         cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 942         writeTx2.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 943         carIndex++;
 944         NormalizedNode people = ImmutableNodes.mapNodeBuilder(PeopleModel.PERSON_QNAME)
 945                 .withChild(PeopleModel.newPersonEntry("Dude")).build();
 946         writeTx2.write(PeopleModel.PERSON_LIST_PATH, people);
 947         final DOMStoreThreePhaseCommitCohort writeTx2Cohort = writeTx2.ready();
 948
 949         // Prepare another WO that writes to a single shard and thus will be directly committed on ready. This
 950         // tx writes 5 cars so 2 BatchedModidifications messages will be sent initially and cached in the
 951         // leader shard (with shardBatchedModificationCount set to 2). The 3rd BatchedModidifications will be
 952         // sent on ready.
 953
 954         final DOMStoreWriteTransaction writeTx3 = followerDistributedDataStore.newWriteOnlyTransaction();
 955         for (int i = 1; i <= 5; i++, carIndex++) {
 956             cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 957             writeTx3.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 958         }
 959
 960         // Prepare another WO that writes to a single shard. This will send a single BatchedModidifications
 961         // message on ready.
 962
 963         final DOMStoreWriteTransaction writeTx4 = followerDistributedDataStore.newWriteOnlyTransaction();
 964         cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 965         writeTx4.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 966         carIndex++;
 967
 968         // Prepare a RW tx that will create a tx actor and send a ForwardedReadyTransaciton message to the
 969         // leader shard on ready.
 970
 971         final DOMStoreReadWriteTransaction readWriteTx = followerDistributedDataStore.newReadWriteTransaction();
 972         cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 973         readWriteTx.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 974
 975         IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
 976             stats -> assertEquals("getReadWriteTransactionCount", 5, stats.getReadWriteTransactionCount()));
 977
 978         // Disable elections on the leader so it switches to follower.
 979
 980         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
 981                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
 982                 .shardElectionTimeoutFactor(10));
 983
 984         leaderTestKit.waitUntilNoLeader(leaderDistributedDataStore.getActorUtils(), "cars");
 985
 986         // Submit all tx's - the messages should get queued for retry.
 987
 988         final ListenableFuture<Boolean> writeTx2CanCommit = writeTx2Cohort.canCommit();
 989         final DOMStoreThreePhaseCommitCohort writeTx3Cohort = writeTx3.ready();
 990         final DOMStoreThreePhaseCommitCohort writeTx4Cohort = writeTx4.ready();
 991         final DOMStoreThreePhaseCommitCohort rwTxCohort = readWriteTx.ready();
 992
 993         // Enable elections on the other follower so it becomes the leader, at which point the
 994         // tx's should get forwarded from the previous leader to the new leader to complete the commits.
 995
 996         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
 997                 .customRaftPolicyImplementation(null).shardElectionTimeoutFactor(1));
 998         IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorUtils(), "cars")
 999                 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
1000         IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorUtils(), "people")
1001                 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
1002
1003         followerTestKit.doCommit(writeTx1CanCommit, writeTx1Cohort);
1004         followerTestKit.doCommit(writeTx2CanCommit, writeTx2Cohort);
1005         followerTestKit.doCommit(writeTx3Cohort);
1006         followerTestKit.doCommit(writeTx4Cohort);
1007         followerTestKit.doCommit(rwTxCohort);
1008
1009         DOMStoreReadTransaction readTx = leaderDistributedDataStore.newReadOnlyTransaction();
1010         verifyCars(readTx, cars.toArray(new MapEntryNode[cars.size()]));
1011         verifyNode(readTx, PeopleModel.PERSON_LIST_PATH, people);
1012     }
1013
1014     @Test
1015     public void testLeadershipTransferOnShutdown() throws Exception {
1016         // FIXME: remove when test passes also for ClientBackedDataStore
1017         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
1018
1019         leaderDatastoreContextBuilder.shardBatchedModificationCount(1);
1020         followerDatastoreContextBuilder.shardElectionTimeoutFactor(10).customRaftPolicyImplementation(null);
1021         final String testName = "testLeadershipTransferOnShutdown";
1022         initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS_AND_PEOPLE);
1023
1024         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
1025                 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(500),
1026                 commitTimeout);
1027         try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
1028                 testParameter, testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false)) {
1029
1030             followerTestKit.waitForMembersUp("member-3");
1031             follower2TestKit.waitForMembersUp("member-1", "member-2");
1032
1033             // Create and submit a couple tx's so they're pending.
1034
1035             DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
1036             writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1037             writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
1038             writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
1039             final DOMStoreThreePhaseCommitCohort cohort1 = writeTx.ready();
1040
1041             IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
1042                 stats -> assertEquals("getTxCohortCacheSize", 1, stats.getTxCohortCacheSize()));
1043
1044             writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
1045             final MapEntryNode car = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
1046             writeTx.write(CarsModel.newCarPath("optima"), car);
1047             final DOMStoreThreePhaseCommitCohort cohort2 = writeTx.ready();
1048
1049             IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
1050                 stats -> assertEquals("getTxCohortCacheSize", 2, stats.getTxCohortCacheSize()));
1051
1052             // Gracefully stop the leader via a Shutdown message.
1053
1054             sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1055                 .shardElectionTimeoutFactor(100));
1056
1057             final FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
1058             final Future<ActorRef> future = leaderDistributedDataStore.getActorUtils().findLocalShardAsync("cars");
1059             final ActorRef leaderActor = Await.result(future, duration);
1060
1061             final Future<Boolean> stopFuture = Patterns.gracefulStop(leaderActor, duration, Shutdown.INSTANCE);
1062
1063             // Commit the 2 transactions. They should finish and succeed.
1064
1065             followerTestKit.doCommit(cohort1);
1066             followerTestKit.doCommit(cohort2);
1067
1068             // Wait for the leader actor stopped.
1069
1070             final Boolean stopped = Await.result(stopFuture, duration);
1071             assertEquals("Stopped", Boolean.TRUE, stopped);
1072
1073             // Verify leadership was transferred by reading the committed data from the other nodes.
1074
1075             verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car);
1076             verifyCars(follower2DistributedDataStore.newReadOnlyTransaction(), car);
1077         }
1078     }
1079
1080     @Test
1081     public void testTransactionWithIsolatedLeader() throws Exception {
1082         // FIXME: remove when test passes also for ClientBackedDataStore
1083         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
1084
1085         // Set the isolated leader check interval high so we can control the switch to IsolatedLeader.
1086         leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(10000000);
1087         final String testName = "testTransactionWithIsolatedLeader";
1088         initDatastoresWithCars(testName);
1089
1090         // Tx that is submitted after the follower is stopped but before the leader transitions to IsolatedLeader.
1091         final DOMStoreWriteTransaction preIsolatedLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1092         preIsolatedLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1093
1094         // Tx that is submitted after the leader transitions to IsolatedLeader.
1095         final DOMStoreWriteTransaction noShardLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1096         noShardLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1097
1098         // Tx that is submitted after the follower is reinstated.
1099         final DOMStoreWriteTransaction successWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1100         successWriteTx.merge(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1101
1102         // Stop the follower
1103         followerTestKit.watch(followerDistributedDataStore.getActorUtils().getShardManager());
1104         followerDistributedDataStore.close();
1105         followerTestKit.expectTerminated(followerDistributedDataStore.getActorUtils().getShardManager());
1106
1107         // Submit the preIsolatedLeaderWriteTx so it's pending
1108         final DOMStoreThreePhaseCommitCohort preIsolatedLeaderTxCohort = preIsolatedLeaderWriteTx.ready();
1109
1110         // Change the isolated leader check interval low so it changes to IsolatedLeader.
1111         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1112                 .shardIsolatedLeaderCheckIntervalInMillis(200));
1113
1114         MemberNode.verifyRaftState(leaderDistributedDataStore, "cars",
1115             raftState -> assertEquals("getRaftState", "IsolatedLeader", raftState.getRaftState()));
1116
1117         final var ex = assertThrows(ExecutionException.class,
1118             () -> leaderTestKit.doCommit(noShardLeaderWriteTx.ready()));
1119         assertEquals(NoShardLeaderException.class, Throwables.getRootCause(ex).getClass());
1120
1121         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1122                 .shardElectionTimeoutFactor(100));
1123
1124         final DOMStoreThreePhaseCommitCohort successTxCohort = successWriteTx.ready();
1125
1126         followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
1127                 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS);
1128
1129         leaderTestKit.doCommit(preIsolatedLeaderTxCohort);
1130         leaderTestKit.doCommit(successTxCohort);
1131     }
1132
1133     @Test
1134     public void testTransactionWithShardLeaderNotResponding() throws Exception {
1135         followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1136         followerDatastoreContextBuilder.shardElectionTimeoutFactor(50);
1137         initDatastoresWithCars("testTransactionWithShardLeaderNotResponding");
1138
1139         // Do an initial read to get the primary shard info cached.
1140
1141         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1142         readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1143
1144         // Shutdown the leader and try to create a new tx.
1145
1146         TestKit.shutdownActorSystem(leaderSystem, true);
1147
1148         followerDatastoreContextBuilder.operationTimeoutInMillis(50).shardElectionTimeoutFactor(1);
1149         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
1150
1151         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1152
1153         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1154
1155         final var ex = assertThrows(ExecutionException.class, () -> followerTestKit.doCommit(rwTx.ready()));
1156         final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(ex.getCause());
1157         if (DistributedDataStore.class.isAssignableFrom(testParameter)) {
1158             assertTrue(msg, Throwables.getRootCause(ex) instanceof NoShardLeaderException
1159                 || ex.getCause() instanceof ShardLeaderNotRespondingException);
1160         } else {
1161             assertThat(msg, Throwables.getRootCause(ex), instanceOf(RequestTimeoutException.class));
1162         }
1163     }
1164
1165     @Test
1166     public void testTransactionWithCreateTxFailureDueToNoLeader() throws Exception {
1167         followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1168         initDatastoresWithCars("testTransactionWithCreateTxFailureDueToNoLeader");
1169
1170         // Do an initial read to get the primary shard info cached.
1171
1172         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1173         readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1174
1175         // Shutdown the leader and try to create a new tx.
1176
1177         TestKit.shutdownActorSystem(leaderSystem, true);
1178
1179         Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1180
1181         Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
1182
1183         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1184                 .operationTimeoutInMillis(10).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
1185
1186         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1187
1188         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1189
1190         final var ex = assertThrows(ExecutionException.class, () -> followerTestKit.doCommit(rwTx.ready()));
1191         final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(ex.getCause());
1192         if (DistributedDataStore.class.isAssignableFrom(testParameter)) {
1193             assertThat(msg, Throwables.getRootCause(ex), instanceOf(NoShardLeaderException.class));
1194         } else {
1195             assertThat(msg, Throwables.getRootCause(ex), instanceOf(RequestTimeoutException.class));
1196         }
1197     }
1198
1199     @Test
1200     public void testTransactionRetryWithInitialAskTimeoutExOnCreateTx() throws Exception {
1201         followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
1202         String testName = "testTransactionRetryWithInitialAskTimeoutExOnCreateTx";
1203         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1204
1205         final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1206                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1207         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1208                 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1209
1210         try (AbstractDataStore ds =
1211                 follower2TestKit.setupAbstractDataStore(
1212                         testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS)) {
1213
1214             followerTestKit.waitForMembersUp("member-1", "member-3");
1215             follower2TestKit.waitForMembersUp("member-1", "member-2");
1216
1217             // Do an initial read to get the primary shard info cached.
1218
1219             final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1220             readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1221
1222             // Shutdown the leader and try to create a new tx.
1223
1224             TestKit.shutdownActorSystem(leaderSystem, true);
1225
1226             Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1227
1228             sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1229                 .operationTimeoutInMillis(500).shardElectionTimeoutFactor(5).customRaftPolicyImplementation(null));
1230
1231             final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1232
1233             rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1234
1235             followerTestKit.doCommit(rwTx.ready());
1236         }
1237     }
1238
1239     @Test
1240     public void testSemiReachableCandidateNotDroppingLeader() throws Exception {
1241         final String testName = "testSemiReachableCandidateNotDroppingLeader";
1242         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1243
1244         final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1245                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1246         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1247                 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1248
1249         final AbstractDataStore ds2 =
1250                      follower2TestKit.setupAbstractDataStore(
1251                              testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS);
1252
1253         followerTestKit.waitForMembersUp("member-1", "member-3");
1254         follower2TestKit.waitForMembersUp("member-1", "member-2");
1255
1256         // behavior is controlled by akka.coordinated-shutdown.run-by-actor-system-terminate configuration option
1257         TestKit.shutdownActorSystem(follower2System, true);
1258
1259         ActorRef cars = leaderDistributedDataStore.getActorUtils().findLocalShard("cars").get();
1260         final OnDemandRaftState initialState = (OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1261                 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1262
1263         Cluster leaderCluster = Cluster.get(leaderSystem);
1264         Cluster followerCluster = Cluster.get(followerSystem);
1265         Cluster follower2Cluster = Cluster.get(follower2System);
1266
1267         Member follower2Member = follower2Cluster.readView().self();
1268
1269         await().atMost(10, TimeUnit.SECONDS)
1270                 .until(() -> containsUnreachable(leaderCluster, follower2Member));
1271         await().atMost(10, TimeUnit.SECONDS)
1272                 .until(() -> containsUnreachable(followerCluster, follower2Member));
1273
1274         ActorRef followerCars = followerDistributedDataStore.getActorUtils().findLocalShard("cars").get();
1275
1276         // to simulate a follower not being able to receive messages, but still being able to send messages and becoming
1277         // candidate, we can just send a couple of RequestVotes to both leader and follower.
1278         cars.tell(new RequestVote(initialState.getCurrentTerm() + 1, "member-3-shard-cars", -1, -1), null);
1279         followerCars.tell(new RequestVote(initialState.getCurrentTerm() + 1, "member-3-shard-cars", -1, -1), null);
1280         cars.tell(new RequestVote(initialState.getCurrentTerm() + 3, "member-3-shard-cars", -1, -1), null);
1281         followerCars.tell(new RequestVote(initialState.getCurrentTerm() + 3, "member-3-shard-cars", -1, -1), null);
1282
1283         OnDemandRaftState stateAfter = (OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1284                 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1285         OnDemandRaftState followerState = (OnDemandRaftState) followerDistributedDataStore.getActorUtils()
1286                 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1287
1288         assertEquals(initialState.getCurrentTerm(), stateAfter.getCurrentTerm());
1289         assertEquals(initialState.getCurrentTerm(), followerState.getCurrentTerm());
1290
1291         ds2.close();
1292     }
1293
1294     private static Boolean containsUnreachable(final Cluster cluster, final Member member) {
1295         // unreachableMembers() returns scala.collection.immutable.Set, but we are using scala.collection.Set to fix JDT
1296         // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=468276#c32
1297         final Set<Member> members = cluster.readView().unreachableMembers();
1298         return members.contains(member);
1299     }
1300
1301     @Test
1302     public void testInstallSnapshot() throws Exception {
1303         final String testName = "testInstallSnapshot";
1304         final String leaderCarShardName = "member-1-shard-cars-" + testName;
1305         final String followerCarShardName = "member-2-shard-cars-" + testName;
1306
1307         // Setup a saved snapshot on the leader. The follower will startup with no data and the leader should
1308         // install a snapshot to sync the follower.
1309
1310         DataTree tree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION,
1311             SchemaContextHelper.full());
1312
1313         final ContainerNode carsNode = CarsModel.newCarsNode(
1314                 CarsModel.newCarsMapNode(CarsModel.newCarEntry("optima", Uint64.valueOf(20000))));
1315         AbstractShardTest.writeToStore(tree, CarsModel.BASE_PATH, carsNode);
1316
1317         final NormalizedNode snapshotRoot = AbstractShardTest.readStore(tree, YangInstanceIdentifier.empty());
1318         final Snapshot initialSnapshot = Snapshot.create(
1319                 new ShardSnapshotState(new MetadataShardDataTreeSnapshot(snapshotRoot)),
1320                 Collections.emptyList(), 5, 1, 5, 1, 1, null, null);
1321         InMemorySnapshotStore.addSnapshot(leaderCarShardName, initialSnapshot);
1322
1323         InMemorySnapshotStore.addSnapshotSavedLatch(leaderCarShardName);
1324         InMemorySnapshotStore.addSnapshotSavedLatch(followerCarShardName);
1325
1326         initDatastoresWithCars(testName);
1327
1328         assertEquals(Optional.of(carsNode), leaderDistributedDataStore.newReadOnlyTransaction().read(
1329             CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS));
1330
1331         verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(leaderCarShardName, Snapshot.class),
1332                 initialSnapshot, snapshotRoot);
1333
1334         verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(followerCarShardName, Snapshot.class),
1335                 initialSnapshot, snapshotRoot);
1336     }
1337
1338     @Test
1339     public void testReadWriteMessageSlicing() throws Exception {
1340         // The slicing is only implemented for tell-based protocol
1341         assumeTrue(ClientBackedDataStore.class.isAssignableFrom(testParameter));
1342
1343         leaderDatastoreContextBuilder.maximumMessageSliceSize(100);
1344         followerDatastoreContextBuilder.maximumMessageSliceSize(100);
1345         initDatastoresWithCars("testLargeReadReplySlicing");
1346
1347         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1348
1349         final NormalizedNode carsNode = CarsModel.create();
1350         rwTx.write(CarsModel.BASE_PATH, carsNode);
1351
1352         verifyNode(rwTx, CarsModel.BASE_PATH, carsNode);
1353     }
1354
1355     @SuppressWarnings("IllegalCatch")
1356     @Test
1357     public void testRaftCallbackDuringLeadershipDrop() throws Exception {
1358         final String testName = "testRaftCallbackDuringLeadershipDrop";
1359         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1360
1361         final ExecutorService executor = Executors.newSingleThreadExecutor();
1362
1363         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
1364                 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(500)
1365                         .shardLeaderElectionTimeoutInSeconds(3600),
1366                 commitTimeout);
1367
1368         final DOMStoreWriteTransaction initialWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1369         initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1370         leaderTestKit.doCommit(initialWriteTx.ready());
1371
1372         try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
1373                 testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false)) {
1374
1375             final ActorRef member3Cars = ((LocalShardStore) follower2DistributedDataStore).getLocalShards()
1376                     .getLocalShards().get("cars").getActor();
1377             final ActorRef member2Cars = ((LocalShardStore)followerDistributedDataStore).getLocalShards()
1378                     .getLocalShards().get("cars").getActor();
1379             member2Cars.tell(new StartDropMessages(AppendEntries.class), null);
1380             member3Cars.tell(new StartDropMessages(AppendEntries.class), null);
1381
1382             final DOMStoreWriteTransaction newTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1383             newTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
1384             final AtomicBoolean submitDone = new AtomicBoolean(false);
1385             executor.submit(() -> {
1386                 try {
1387                     leaderTestKit.doCommit(newTx.ready());
1388                     submitDone.set(true);
1389                 } catch (Exception e) {
1390                     throw new RuntimeException(e);
1391                 }
1392             });
1393             final ActorRef leaderCars = ((LocalShardStore) leaderDistributedDataStore).getLocalShards()
1394                     .getLocalShards().get("cars").getActor();
1395             await().atMost(10, TimeUnit.SECONDS)
1396                     .until(() -> ((OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1397                             .executeOperation(leaderCars, GetOnDemandRaftState.INSTANCE)).getLastIndex() >= 1);
1398
1399             final OnDemandRaftState raftState = (OnDemandRaftState)leaderDistributedDataStore.getActorUtils()
1400                     .executeOperation(leaderCars, GetOnDemandRaftState.INSTANCE);
1401
1402             // Simulate a follower not receiving heartbeats but still being able to send messages ie RequestVote with
1403             // new term(switching to candidate after election timeout)
1404             leaderCars.tell(new RequestVote(raftState.getCurrentTerm() + 1,
1405                     "member-3-shard-cars-testRaftCallbackDuringLeadershipDrop", -1,
1406                             -1), member3Cars);
1407
1408             member2Cars.tell(new StopDropMessages(AppendEntries.class), null);
1409             member3Cars.tell(new StopDropMessages(AppendEntries.class), null);
1410
1411             await("Is tx stuck in COMMIT_PENDING")
1412                     .atMost(10, TimeUnit.SECONDS).untilAtomic(submitDone, equalTo(true));
1413
1414         }
1415
1416         executor.shutdownNow();
1417     }
1418
1419     @Test
1420     public void testSnapshotOnRootOverwrite() throws Exception {
1421         // FIXME: ClientBackedDatastore does not have stable indexes/term, the snapshot index seems to fluctuate
1422         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
1423
1424         final String testName = "testSnapshotOnRootOverwrite";
1425         final String[] shards = {"cars", "default"};
1426         initDatastores(testName, "module-shards-default-cars-member1-and-2.conf", shards,
1427                 leaderDatastoreContextBuilder.snapshotOnRootOverwrite(true),
1428                 followerDatastoreContextBuilder.snapshotOnRootOverwrite(true));
1429
1430         leaderTestKit.waitForMembersUp("member-2");
1431         final ContainerNode rootNode = ImmutableContainerNodeBuilder.create()
1432                 .withNodeIdentifier(YangInstanceIdentifier.NodeIdentifier.create(SchemaContext.NAME))
1433                 .withChild(CarsModel.create())
1434                 .build();
1435
1436         leaderTestKit.testWriteTransaction(leaderDistributedDataStore, YangInstanceIdentifier.empty(), rootNode);
1437
1438         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1439             state -> assertEquals(1, state.getSnapshotIndex()));
1440
1441         IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1442             state -> assertEquals(1, state.getSnapshotIndex()));
1443
1444         verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 1);
1445         verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 1);
1446
1447         for (int i = 0; i < 10; i++) {
1448             leaderTestKit.testWriteTransaction(leaderDistributedDataStore, CarsModel.newCarPath("car " + i),
1449                     CarsModel.newCarEntry("car " + i, Uint64.ONE));
1450         }
1451
1452         // fake snapshot causes the snapshotIndex to move
1453         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1454             state -> assertEquals(10, state.getSnapshotIndex()));
1455         IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1456             state -> assertEquals(10, state.getSnapshotIndex()));
1457
1458         // however the real snapshot still has not changed and was taken at index 1
1459         verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 1);
1460         verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 1);
1461
1462         // root overwrite so expect a snapshot
1463         leaderTestKit.testWriteTransaction(leaderDistributedDataStore, YangInstanceIdentifier.empty(), rootNode);
1464
1465         // this was a real snapshot so everything should be in it(1(DisableTrackingPayload) + 1 + 10 + 1)
1466         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1467             state -> assertEquals(12, state.getSnapshotIndex()));
1468         IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1469             state -> assertEquals(12, state.getSnapshotIndex()));
1470
1471         verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 12);
1472         verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 12);
1473     }
1474
1475     private void verifySnapshot(final String persistenceId, final long lastAppliedIndex) {
1476         await().atMost(5, TimeUnit.SECONDS).untilAsserted(() -> {
1477                 List<Snapshot> snap = InMemorySnapshotStore.getSnapshots(persistenceId, Snapshot.class);
1478                 assertEquals(1, snap.size());
1479                 assertEquals(lastAppliedIndex, snap.get(0).getLastAppliedIndex());
1480             }
1481         );
1482     }
1483
1484     private static void verifySnapshot(final Snapshot actual, final Snapshot expected,
1485                                        final NormalizedNode expRoot) {
1486         assertEquals("Snapshot getLastAppliedTerm", expected.getLastAppliedTerm(), actual.getLastAppliedTerm());
1487         assertEquals("Snapshot getLastAppliedIndex", expected.getLastAppliedIndex(), actual.getLastAppliedIndex());
1488         assertEquals("Snapshot getLastTerm", expected.getLastTerm(), actual.getLastTerm());
1489         assertEquals("Snapshot getLastIndex", expected.getLastIndex(), actual.getLastIndex());
1490         assertEquals("Snapshot state type", ShardSnapshotState.class, actual.getState().getClass());
1491         MetadataShardDataTreeSnapshot shardSnapshot =
1492                 (MetadataShardDataTreeSnapshot) ((ShardSnapshotState)actual.getState()).getSnapshot();
1493         assertEquals("Snapshot root node", expRoot, shardSnapshot.getRootNode().get());
1494     }
1495
1496     private static void sendDatastoreContextUpdate(final AbstractDataStore dataStore, final Builder builder) {
1497         final Builder newBuilder = DatastoreContext.newBuilderFrom(builder.build());
1498         final DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
1499         final Answer<DatastoreContext> answer = invocation -> newBuilder.build();
1500         doAnswer(answer).when(mockContextFactory).getBaseDatastoreContext();
1501         doAnswer(answer).when(mockContextFactory).getShardDatastoreContext(anyString());
1502         dataStore.onDatastoreContextUpdated(mockContextFactory);
1503     }
1504 }