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.MapNode;
 118 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 119 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 120 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
 121 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
 122 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 123 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
 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);
 208         TestKit.shutdownActorSystem(followerSystem);
 209         TestKit.shutdownActorSystem(follower2System);
 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, MapNode> 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().getValue();
 399             assertThat(body, instanceOf(Collection.class));
 400             assertEquals(numCars, ((Collection<?>) body).size());
 401         }
 402     }
 403
 404     private static void assertAskClientMetadata(final FrontendClientMetadata clientMeta) {
 405         // ask based should track no metadata
 406         assertEquals(List.of(), clientMeta.getCurrentHistories());
 407     }
 408
 409     private static 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         assertEquals(UnsignedLongBitmap.of(), metadata.getClosedTransactions());
 417         assertEquals("[[0.." + lastPurged + "]]", metadata.getPurgedTransactions().ranges().toString());
 418     }
 419
 420     @Test
 421     public void testCloseTransactionMetadataLeak() throws Exception {
 422         // FIXME: Ask-based frontend seems to have some issues with back to back close
 423         assumeTrue(testParameter.isAssignableFrom(TestClientBackedDataStore.class));
 424
 425         initDatastoresWithCars("testCloseTransactionMetadataLeak");
 426
 427         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 428
 429         DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 430         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 431         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 432         followerTestKit.doCommit(writeTx.ready());
 433
 434         int numCars = 5;
 435         for (int i = 0; i < numCars; i++) {
 436             try (var tx = txChain.newWriteOnlyTransaction()) {
 437                 // Empty on purpose
 438             }
 439
 440             try (var tx = txChain.newReadOnlyTransaction()) {
 441                 tx.read(CarsModel.BASE_PATH).get();
 442             }
 443         }
 444
 445         // wait to let the shard catch up with purged
 446         await("wait for purges to settle").atMost(5, TimeUnit.SECONDS)
 447                 .pollInterval(500, TimeUnit.MILLISECONDS)
 448                 .untilAsserted(() -> {
 449                     final var localShard = leaderDistributedDataStore.getActorUtils().findLocalShard("cars")
 450                         .orElseThrow();
 451                     final var frontendMetadata =
 452                             (FrontendShardDataTreeSnapshotMetadata) leaderDistributedDataStore.getActorUtils()
 453                                     .executeOperation(localShard, new RequestFrontendMetadata());
 454
 455                     final var clientMeta = frontendMetadata.getClients().get(0);
 456                     if (leaderDistributedDataStore.getActorUtils().getDatastoreContext().isUseTellBasedProtocol()) {
 457                         assertTellClientMetadata(clientMeta, numCars * 2);
 458                     } else {
 459                         assertAskClientMetadata(clientMeta);
 460                     }
 461                 });
 462     }
 463
 464     @Test
 465     public void testReadWriteTransactionWithSingleShard() throws Exception {
 466         initDatastoresWithCars("testReadWriteTransactionWithSingleShard");
 467
 468         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 469         assertNotNull("newReadWriteTransaction returned null", rwTx);
 470
 471         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 472         rwTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 473
 474         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 475         rwTx.merge(CarsModel.newCarPath("optima"), car1);
 476
 477         verifyCars(rwTx, car1);
 478
 479         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
 480         final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
 481         rwTx.merge(car2Path, car2);
 482
 483         verifyExists(rwTx, car2Path);
 484
 485         followerTestKit.doCommit(rwTx.ready());
 486
 487         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 488     }
 489
 490     @Test
 491     public void testWriteTransactionWithMultipleShards() throws Exception {
 492         initDatastoresWithCarsAndPeople("testWriteTransactionWithMultipleShards");
 493
 494         final DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 495         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 496
 497         final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
 498         final NormalizedNode<?, ?> carsNode = CarsModel.emptyContainer();
 499         writeTx.write(carsPath, carsNode);
 500
 501         final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
 502         final NormalizedNode<?, ?> peopleNode = PeopleModel.emptyContainer();
 503         writeTx.write(peoplePath, peopleNode);
 504
 505         followerTestKit.doCommit(writeTx.ready());
 506
 507         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 508
 509         verifyNode(readTx, carsPath, carsNode);
 510         verifyNode(readTx, peoplePath, peopleNode);
 511     }
 512
 513     @Test
 514     public void testReadWriteTransactionWithMultipleShards() throws Exception {
 515         initDatastoresWithCarsAndPeople("testReadWriteTransactionWithMultipleShards");
 516
 517         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 518         assertNotNull("newReadWriteTransaction returned null", rwTx);
 519
 520         final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
 521         final NormalizedNode<?, ?> carsNode = CarsModel.emptyContainer();
 522         rwTx.write(carsPath, carsNode);
 523
 524         final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
 525         final NormalizedNode<?, ?> peopleNode = PeopleModel.emptyContainer();
 526         rwTx.write(peoplePath, peopleNode);
 527
 528         followerTestKit.doCommit(rwTx.ready());
 529
 530         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 531
 532         verifyNode(readTx, carsPath, carsNode);
 533         verifyNode(readTx, peoplePath, peopleNode);
 534     }
 535
 536     @Test
 537     public void testTransactionChainWithSingleShard() throws Exception {
 538         initDatastoresWithCars("testTransactionChainWithSingleShard");
 539
 540         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 541
 542         // Add the top-level cars container with write-only.
 543
 544         final DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 545         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 546
 547         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 548
 549         final DOMStoreThreePhaseCommitCohort writeTxReady = writeTx.ready();
 550
 551         // Verify the top-level cars container with read-only.
 552
 553         verifyNode(txChain.newReadOnlyTransaction(), CarsModel.BASE_PATH, CarsModel.emptyContainer());
 554
 555         // Perform car operations with read-write.
 556
 557         final DOMStoreReadWriteTransaction rwTx = txChain.newReadWriteTransaction();
 558
 559         verifyNode(rwTx, CarsModel.BASE_PATH, CarsModel.emptyContainer());
 560
 561         rwTx.merge(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 562
 563         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 564         final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 565         rwTx.write(car1Path, car1);
 566
 567         verifyExists(rwTx, car1Path);
 568
 569         verifyCars(rwTx, car1);
 570
 571         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
 572         rwTx.merge(CarsModel.newCarPath("sportage"), car2);
 573
 574         rwTx.delete(car1Path);
 575
 576         followerTestKit.doCommit(writeTxReady);
 577
 578         followerTestKit.doCommit(rwTx.ready());
 579
 580         txChain.close();
 581
 582         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
 583     }
 584
 585     @Test
 586     public void testTransactionChainWithMultipleShards() throws Exception {
 587         initDatastoresWithCarsAndPeople("testTransactionChainWithMultipleShards");
 588
 589         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 590
 591         DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 592         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 593
 594         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 595         writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 596
 597         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 598         writeTx.write(PeopleModel.PERSON_LIST_PATH, PeopleModel.newPersonMapNode());
 599
 600         followerTestKit.doCommit(writeTx.ready());
 601
 602         final DOMStoreReadWriteTransaction readWriteTx = txChain.newReadWriteTransaction();
 603
 604         final MapEntryNode car = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 605         final YangInstanceIdentifier carPath = CarsModel.newCarPath("optima");
 606         readWriteTx.write(carPath, car);
 607
 608         final MapEntryNode person = PeopleModel.newPersonEntry("jack");
 609         final YangInstanceIdentifier personPath = PeopleModel.newPersonPath("jack");
 610         readWriteTx.merge(personPath, person);
 611
 612         assertEquals(Optional.of(car), readWriteTx.read(carPath).get(5, TimeUnit.SECONDS));
 613         assertEquals(Optional.of(person), readWriteTx.read(personPath).get(5, TimeUnit.SECONDS));
 614
 615         final DOMStoreThreePhaseCommitCohort cohort2 = readWriteTx.ready();
 616
 617         writeTx = txChain.newWriteOnlyTransaction();
 618
 619         writeTx.delete(personPath);
 620
 621         final DOMStoreThreePhaseCommitCohort cohort3 = writeTx.ready();
 622
 623         followerTestKit.doCommit(cohort2);
 624         followerTestKit.doCommit(cohort3);
 625
 626         txChain.close();
 627
 628         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 629         verifyCars(readTx, car);
 630
 631         assertEquals(Optional.empty(), readTx.read(personPath).get(5, TimeUnit.SECONDS));
 632     }
 633
 634     @Test
 635     public void testChainedTransactionFailureWithSingleShard() throws Exception {
 636         initDatastoresWithCars("testChainedTransactionFailureWithSingleShard");
 637
 638         final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
 639                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
 640                         LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
 641                         MoreExecutors.directExecutor());
 642
 643         final DOMTransactionChainListener listener = mock(DOMTransactionChainListener.class);
 644         final DOMTransactionChain txChain = broker.createTransactionChain(listener);
 645
 646         final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 647
 648         final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 649                 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
 650                     .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
 651
 652         writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
 653
 654         final var ex = assertThrows(ExecutionException.class, () -> writeTx.commit().get(5, TimeUnit.SECONDS))
 655             .getCause();
 656         assertThat(ex, instanceOf(TransactionCommitFailedException.class));
 657
 658         verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
 659
 660         txChain.close();
 661         broker.close();
 662     }
 663
 664     @Test
 665     public void testChainedTransactionFailureWithMultipleShards() throws Exception {
 666         initDatastoresWithCarsAndPeople("testChainedTransactionFailureWithMultipleShards");
 667
 668         final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
 669                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
 670                         LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
 671                         MoreExecutors.directExecutor());
 672
 673         final DOMTransactionChainListener listener = mock(DOMTransactionChainListener.class);
 674         final DOMTransactionChain txChain = broker.createTransactionChain(listener);
 675
 676         final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 677
 678         writeTx.put(LogicalDatastoreType.CONFIGURATION, PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 679
 680         final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 681                 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
 682                     .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
 683
 684         // Note that merge will validate the data and fail but put succeeds b/c deep validation is not
 685         // done for put for performance reasons.
 686         writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
 687
 688         final var ex = assertThrows(ExecutionException.class, () -> writeTx.commit().get(5, TimeUnit.SECONDS))
 689             .getCause();
 690         assertThat(ex, instanceOf(TransactionCommitFailedException.class));
 691
 692         verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
 693
 694         txChain.close();
 695         broker.close();
 696     }
 697
 698     @Test
 699     public void testSingleShardTransactionsWithLeaderChanges() throws Exception {
 700         followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
 701         final String testName = "testSingleShardTransactionsWithLeaderChanges";
 702         initDatastoresWithCars(testName);
 703
 704         final String followerCarShardName = "member-2-shard-cars-" + testName;
 705         InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 1, ApplyJournalEntries.class);
 706
 707         // Write top-level car container from the follower so it uses a remote Tx.
 708
 709         DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 710
 711         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 712         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 713
 714         followerTestKit.doCommit(writeTx.ready());
 715
 716         InMemoryJournal.waitForWriteMessagesComplete(followerCarShardName);
 717
 718         // Switch the leader to the follower
 719
 720         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
 721                 .shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
 722
 723         TestKit.shutdownActorSystem(leaderSystem, true);
 724         Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
 725
 726         followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorUtils(), CARS);
 727
 728         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 729         Cluster.get(leaderSystem).join(MEMBER_2_ADDRESS);
 730
 731         final DatastoreContext.Builder newMember1Builder = DatastoreContext.newBuilder()
 732                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
 733         IntegrationTestKit newMember1TestKit = new IntegrationTestKit(leaderSystem, newMember1Builder, commitTimeout);
 734
 735         try (AbstractDataStore ds =
 736                 newMember1TestKit.setupAbstractDataStore(
 737                         testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS)) {
 738
 739             followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), CARS);
 740
 741             // Write a car entry to the new leader - should switch to local Tx
 742
 743             writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 744
 745             MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 746             YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 747             writeTx.merge(car1Path, car1);
 748
 749             followerTestKit.doCommit(writeTx.ready());
 750
 751             verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1);
 752         }
 753     }
 754
 755     @SuppressWarnings("unchecked")
 756     @Test
 757     public void testReadyLocalTransactionForwardedToLeader() throws Exception {
 758         initDatastoresWithCars("testReadyLocalTransactionForwardedToLeader");
 759         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), "cars");
 760
 761         final Optional<ActorRef> carsFollowerShard =
 762                 followerDistributedDataStore.getActorUtils().findLocalShard("cars");
 763         assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
 764
 765         final DataTree dataTree = new InMemoryDataTreeFactory().create(
 766             DataTreeConfiguration.DEFAULT_OPERATIONAL, SchemaContextHelper.full());
 767
 768         // Send a tx with immediate commit.
 769
 770         DataTreeModification modification = dataTree.takeSnapshot().newModification();
 771         new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
 772         new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
 773
 774         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 775         new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
 776         modification.ready();
 777
 778         ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(tx1 , modification, true, Optional.empty());
 779
 780         carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
 781         Object resp = followerTestKit.expectMsgClass(Object.class);
 782         if (resp instanceof akka.actor.Status.Failure) {
 783             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 784         }
 785
 786         assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
 787
 788         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
 789
 790         // Send another tx without immediate commit.
 791
 792         modification = dataTree.takeSnapshot().newModification();
 793         MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(30000));
 794         new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
 795         modification.ready();
 796
 797         readyLocal = new ReadyLocalTransaction(tx2 , modification, false, Optional.empty());
 798
 799         carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
 800         resp = followerTestKit.expectMsgClass(Object.class);
 801         if (resp instanceof akka.actor.Status.Failure) {
 802             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 803         }
 804
 805         assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
 806
 807         final ActorSelection txActor = leaderDistributedDataStore.getActorUtils().actorSelection(
 808                 ((ReadyTransactionReply)resp).getCohortPath());
 809
 810         ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(leaderDistributedDataStore.getActorUtils(),
 811             List.of(new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor),
 812                 () -> DataStoreVersions.CURRENT_VERSION)), tx2);
 813         cohort.canCommit().get(5, TimeUnit.SECONDS);
 814         cohort.preCommit().get(5, TimeUnit.SECONDS);
 815         cohort.commit().get(5, TimeUnit.SECONDS);
 816
 817         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 818     }
 819
 820     @SuppressWarnings("unchecked")
 821     @Test
 822     public void testForwardedReadyTransactionForwardedToLeader() throws Exception {
 823         initDatastoresWithCars("testForwardedReadyTransactionForwardedToLeader");
 824         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), "cars");
 825
 826         final Optional<ActorRef> carsFollowerShard =
 827                 followerDistributedDataStore.getActorUtils().findLocalShard("cars");
 828         assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
 829
 830         carsFollowerShard.get().tell(GetShardDataTree.INSTANCE, followerTestKit.getRef());
 831         final DataTree dataTree = followerTestKit.expectMsgClass(DataTree.class);
 832
 833         // Send a tx with immediate commit.
 834
 835         DataTreeModification modification = dataTree.takeSnapshot().newModification();
 836         new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
 837         new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
 838
 839         final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
 840         new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
 841
 842         ForwardedReadyTransaction forwardedReady = new ForwardedReadyTransaction(tx1, DataStoreVersions.CURRENT_VERSION,
 843             new ReadWriteShardDataTreeTransaction(mock(ShardDataTreeTransactionParent.class), tx1, modification),
 844             true, Optional.empty());
 845
 846         carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
 847         Object resp = followerTestKit.expectMsgClass(Object.class);
 848         if (resp instanceof akka.actor.Status.Failure) {
 849             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 850         }
 851
 852         assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
 853
 854         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
 855
 856         // Send another tx without immediate commit.
 857
 858         modification = dataTree.takeSnapshot().newModification();
 859         MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(30000));
 860         new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
 861
 862         forwardedReady = new ForwardedReadyTransaction(tx2, DataStoreVersions.CURRENT_VERSION,
 863             new ReadWriteShardDataTreeTransaction(mock(ShardDataTreeTransactionParent.class), tx2, modification),
 864             false, Optional.empty());
 865
 866         carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
 867         resp = followerTestKit.expectMsgClass(Object.class);
 868         if (resp instanceof akka.actor.Status.Failure) {
 869             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 870         }
 871
 872         assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
 873
 874         ActorSelection txActor = leaderDistributedDataStore.getActorUtils().actorSelection(
 875                 ((ReadyTransactionReply)resp).getCohortPath());
 876
 877         final ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
 878             leaderDistributedDataStore.getActorUtils(), List.of(
 879                 new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor),
 880                     () -> DataStoreVersions.CURRENT_VERSION)), tx2);
 881         cohort.canCommit().get(5, TimeUnit.SECONDS);
 882         cohort.preCommit().get(5, TimeUnit.SECONDS);
 883         cohort.commit().get(5, TimeUnit.SECONDS);
 884
 885         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 886     }
 887
 888     @Test
 889     public void testTransactionForwardedToLeaderAfterRetry() throws Exception {
 890         followerDatastoreContextBuilder.shardBatchedModificationCount(2);
 891         leaderDatastoreContextBuilder.shardBatchedModificationCount(2);
 892         initDatastoresWithCarsAndPeople("testTransactionForwardedToLeaderAfterRetry");
 893
 894         // Do an initial write to get the primary shard info cached.
 895
 896         final DOMStoreWriteTransaction initialWriteTx = followerDistributedDataStore.newWriteOnlyTransaction();
 897         initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 898         initialWriteTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 899         followerTestKit.doCommit(initialWriteTx.ready());
 900
 901         // Wait for the commit to be replicated to the follower.
 902
 903         MemberNode.verifyRaftState(followerDistributedDataStore, "cars",
 904             raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
 905
 906         MemberNode.verifyRaftState(followerDistributedDataStore, "people",
 907             raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
 908
 909         // Prepare, ready and canCommit a WO tx that writes to 2 shards. This will become the current tx in
 910         // the leader shard.
 911
 912         final DOMStoreWriteTransaction writeTx1 = followerDistributedDataStore.newWriteOnlyTransaction();
 913         writeTx1.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 914         writeTx1.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 915         final DOMStoreThreePhaseCommitCohort writeTx1Cohort = writeTx1.ready();
 916         final ListenableFuture<Boolean> writeTx1CanCommit = writeTx1Cohort.canCommit();
 917         writeTx1CanCommit.get(5, TimeUnit.SECONDS);
 918
 919         // Prepare and ready another WO tx that writes to 2 shards but don't canCommit yet. This will be queued
 920         // in the leader shard.
 921
 922         final DOMStoreWriteTransaction writeTx2 = followerDistributedDataStore.newWriteOnlyTransaction();
 923         final LinkedList<MapEntryNode> cars = new LinkedList<>();
 924         int carIndex = 1;
 925         cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 926         writeTx2.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 927         carIndex++;
 928         NormalizedNode<?, ?> people = ImmutableNodes.mapNodeBuilder(PeopleModel.PERSON_QNAME)
 929                 .withChild(PeopleModel.newPersonEntry("Dude")).build();
 930         writeTx2.write(PeopleModel.PERSON_LIST_PATH, people);
 931         final DOMStoreThreePhaseCommitCohort writeTx2Cohort = writeTx2.ready();
 932
 933         // Prepare another WO that writes to a single shard and thus will be directly committed on ready. This
 934         // tx writes 5 cars so 2 BatchedModidifications messages will be sent initially and cached in the
 935         // leader shard (with shardBatchedModificationCount set to 2). The 3rd BatchedModidifications will be
 936         // sent on ready.
 937
 938         final DOMStoreWriteTransaction writeTx3 = followerDistributedDataStore.newWriteOnlyTransaction();
 939         for (int i = 1; i <= 5; i++, carIndex++) {
 940             cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 941             writeTx3.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 942         }
 943
 944         // Prepare another WO that writes to a single shard. This will send a single BatchedModidifications
 945         // message on ready.
 946
 947         final DOMStoreWriteTransaction writeTx4 = followerDistributedDataStore.newWriteOnlyTransaction();
 948         cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 949         writeTx4.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 950         carIndex++;
 951
 952         // Prepare a RW tx that will create a tx actor and send a ForwardedReadyTransaciton message to the
 953         // leader shard on ready.
 954
 955         final DOMStoreReadWriteTransaction readWriteTx = followerDistributedDataStore.newReadWriteTransaction();
 956         cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
 957         readWriteTx.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 958
 959         // FIXME: CONTROLLER-2017: ClientBackedDataStore reports only 4 transactions
 960         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
 961         IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
 962             stats -> assertEquals("getReadWriteTransactionCount", 5, stats.getReadWriteTransactionCount()));
 963
 964         // Disable elections on the leader so it switches to follower.
 965
 966         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
 967                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
 968                 .shardElectionTimeoutFactor(10));
 969
 970         leaderTestKit.waitUntilNoLeader(leaderDistributedDataStore.getActorUtils(), "cars");
 971
 972         // Submit all tx's - the messages should get queued for retry.
 973
 974         final ListenableFuture<Boolean> writeTx2CanCommit = writeTx2Cohort.canCommit();
 975         final DOMStoreThreePhaseCommitCohort writeTx3Cohort = writeTx3.ready();
 976         final DOMStoreThreePhaseCommitCohort writeTx4Cohort = writeTx4.ready();
 977         final DOMStoreThreePhaseCommitCohort rwTxCohort = readWriteTx.ready();
 978
 979         // Enable elections on the other follower so it becomes the leader, at which point the
 980         // tx's should get forwarded from the previous leader to the new leader to complete the commits.
 981
 982         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
 983                 .customRaftPolicyImplementation(null).shardElectionTimeoutFactor(1));
 984         IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorUtils(), "cars")
 985                 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
 986         IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorUtils(), "people")
 987                 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
 988
 989         followerTestKit.doCommit(writeTx1CanCommit, writeTx1Cohort);
 990         followerTestKit.doCommit(writeTx2CanCommit, writeTx2Cohort);
 991         followerTestKit.doCommit(writeTx3Cohort);
 992         followerTestKit.doCommit(writeTx4Cohort);
 993         followerTestKit.doCommit(rwTxCohort);
 994
 995         DOMStoreReadTransaction readTx = leaderDistributedDataStore.newReadOnlyTransaction();
 996         verifyCars(readTx, cars.toArray(new MapEntryNode[cars.size()]));
 997         verifyNode(readTx, PeopleModel.PERSON_LIST_PATH, people);
 998     }
 999
1000     @Test
1001     public void testLeadershipTransferOnShutdown() throws Exception {
1002         leaderDatastoreContextBuilder.shardBatchedModificationCount(1);
1003         followerDatastoreContextBuilder.shardElectionTimeoutFactor(10).customRaftPolicyImplementation(null);
1004         final String testName = "testLeadershipTransferOnShutdown";
1005         initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS_AND_PEOPLE);
1006
1007         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
1008                 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(500),
1009                 commitTimeout);
1010         try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
1011                 testParameter, testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false)) {
1012
1013             followerTestKit.waitForMembersUp("member-3");
1014             follower2TestKit.waitForMembersUp("member-1", "member-2");
1015
1016             // Create and submit a couple tx's so they're pending.
1017
1018             DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
1019             writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1020             writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
1021             writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
1022             final DOMStoreThreePhaseCommitCohort cohort1 = writeTx.ready();
1023
1024             final var usesCohorts = DistributedDataStore.class.isAssignableFrom(testParameter);
1025             if (usesCohorts) {
1026                 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
1027                     stats -> assertEquals("getTxCohortCacheSize", 1, stats.getTxCohortCacheSize()));
1028             }
1029
1030             writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
1031             final MapEntryNode car = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
1032             writeTx.write(CarsModel.newCarPath("optima"), car);
1033             final DOMStoreThreePhaseCommitCohort cohort2 = writeTx.ready();
1034
1035             if (usesCohorts) {
1036                 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
1037                     stats -> assertEquals("getTxCohortCacheSize", 2, stats.getTxCohortCacheSize()));
1038             }
1039
1040             // Gracefully stop the leader via a Shutdown message.
1041
1042             sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1043                 .shardElectionTimeoutFactor(100));
1044
1045             final FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
1046             final Future<ActorRef> future = leaderDistributedDataStore.getActorUtils().findLocalShardAsync("cars");
1047             final ActorRef leaderActor = Await.result(future, duration);
1048
1049             final Future<Boolean> stopFuture = Patterns.gracefulStop(leaderActor, duration, Shutdown.INSTANCE);
1050
1051             // Commit the 2 transactions. They should finish and succeed.
1052
1053             followerTestKit.doCommit(cohort1);
1054             followerTestKit.doCommit(cohort2);
1055
1056             // Wait for the leader actor stopped.
1057
1058             final Boolean stopped = Await.result(stopFuture, duration);
1059             assertEquals("Stopped", Boolean.TRUE, stopped);
1060
1061             // Verify leadership was transferred by reading the committed data from the other nodes.
1062
1063             verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car);
1064             verifyCars(follower2DistributedDataStore.newReadOnlyTransaction(), car);
1065         }
1066     }
1067
1068     @Test
1069     public void testTransactionWithIsolatedLeader() throws Exception {
1070         // FIXME: CONTROLLER-2018: remove when test passes also for ClientBackedDataStore
1071         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
1072
1073         // Set the isolated leader check interval high so we can control the switch to IsolatedLeader.
1074         leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(10000000);
1075         final String testName = "testTransactionWithIsolatedLeader";
1076         initDatastoresWithCars(testName);
1077
1078         // Tx that is submitted after the follower is stopped but before the leader transitions to IsolatedLeader.
1079         final DOMStoreWriteTransaction preIsolatedLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1080         preIsolatedLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1081
1082         // Tx that is submitted after the leader transitions to IsolatedLeader.
1083         final DOMStoreWriteTransaction noShardLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1084         noShardLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1085
1086         // Tx that is submitted after the follower is reinstated.
1087         final DOMStoreWriteTransaction successWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1088         successWriteTx.merge(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1089
1090         // Stop the follower
1091         followerTestKit.watch(followerDistributedDataStore.getActorUtils().getShardManager());
1092         followerDistributedDataStore.close();
1093         followerTestKit.expectTerminated(followerDistributedDataStore.getActorUtils().getShardManager());
1094
1095         // Submit the preIsolatedLeaderWriteTx so it's pending
1096         final DOMStoreThreePhaseCommitCohort preIsolatedLeaderTxCohort = preIsolatedLeaderWriteTx.ready();
1097
1098         // Change the isolated leader check interval low so it changes to IsolatedLeader.
1099         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1100                 .shardIsolatedLeaderCheckIntervalInMillis(200));
1101
1102         MemberNode.verifyRaftState(leaderDistributedDataStore, "cars",
1103             raftState -> assertEquals("getRaftState", "IsolatedLeader", raftState.getRaftState()));
1104
1105         final var ex = assertThrows(ExecutionException.class,
1106             () -> leaderTestKit.doCommit(noShardLeaderWriteTx.ready()));
1107         assertEquals(NoShardLeaderException.class, Throwables.getRootCause(ex).getClass());
1108
1109         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1110                 .shardElectionTimeoutFactor(100));
1111
1112         final DOMStoreThreePhaseCommitCohort successTxCohort = successWriteTx.ready();
1113
1114         followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
1115                 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS);
1116
1117         leaderTestKit.doCommit(preIsolatedLeaderTxCohort);
1118         leaderTestKit.doCommit(successTxCohort);
1119     }
1120
1121     @Test
1122     public void testTransactionWithShardLeaderNotResponding() throws Exception {
1123         followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1124         followerDatastoreContextBuilder.shardElectionTimeoutFactor(50);
1125         initDatastoresWithCars("testTransactionWithShardLeaderNotResponding");
1126
1127         // Do an initial read to get the primary shard info cached.
1128
1129         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1130         readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1131
1132         // Shutdown the leader and try to create a new tx.
1133
1134         TestKit.shutdownActorSystem(leaderSystem, true);
1135
1136         followerDatastoreContextBuilder.operationTimeoutInMillis(50).shardElectionTimeoutFactor(1);
1137         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
1138
1139         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1140
1141         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1142
1143         final var ex = assertThrows(ExecutionException.class, () -> followerTestKit.doCommit(rwTx.ready()));
1144         final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(ex.getCause());
1145         if (DistributedDataStore.class.isAssignableFrom(testParameter)) {
1146             assertTrue(msg, Throwables.getRootCause(ex) instanceof NoShardLeaderException
1147                 || ex.getCause() instanceof ShardLeaderNotRespondingException);
1148         } else {
1149             assertThat(msg, Throwables.getRootCause(ex), instanceOf(RequestTimeoutException.class));
1150         }
1151     }
1152
1153     @Test
1154     public void testTransactionWithCreateTxFailureDueToNoLeader() throws Exception {
1155         followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1156         initDatastoresWithCars("testTransactionWithCreateTxFailureDueToNoLeader");
1157
1158         // Do an initial read to get the primary shard info cached.
1159
1160         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1161         readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1162
1163         // Shutdown the leader and try to create a new tx.
1164
1165         TestKit.shutdownActorSystem(leaderSystem, true);
1166
1167         Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1168
1169         Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
1170
1171         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1172                 .operationTimeoutInMillis(10).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
1173
1174         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1175
1176         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1177
1178         final var ex = assertThrows(ExecutionException.class, () -> followerTestKit.doCommit(rwTx.ready()));
1179         final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(ex.getCause());
1180         if (DistributedDataStore.class.isAssignableFrom(testParameter)) {
1181             assertThat(msg, Throwables.getRootCause(ex), instanceOf(NoShardLeaderException.class));
1182         } else {
1183             assertThat(msg, Throwables.getRootCause(ex), instanceOf(RequestTimeoutException.class));
1184         }
1185     }
1186
1187     @Test
1188     public void testTransactionRetryWithInitialAskTimeoutExOnCreateTx() throws Exception {
1189         followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
1190         String testName = "testTransactionRetryWithInitialAskTimeoutExOnCreateTx";
1191         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1192
1193         final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1194                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1195         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1196                 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1197
1198         try (AbstractDataStore ds =
1199                 follower2TestKit.setupAbstractDataStore(
1200                         testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS)) {
1201
1202             followerTestKit.waitForMembersUp("member-1", "member-3");
1203             follower2TestKit.waitForMembersUp("member-1", "member-2");
1204
1205             // Do an initial read to get the primary shard info cached.
1206
1207             final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1208             readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1209
1210             // Shutdown the leader and try to create a new tx.
1211
1212             TestKit.shutdownActorSystem(leaderSystem, true);
1213
1214             Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1215
1216             sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1217                 .operationTimeoutInMillis(500).shardElectionTimeoutFactor(5).customRaftPolicyImplementation(null));
1218
1219             final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1220
1221             rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1222
1223             followerTestKit.doCommit(rwTx.ready());
1224         }
1225     }
1226
1227     @Test
1228     public void testSemiReachableCandidateNotDroppingLeader() throws Exception {
1229         final String testName = "testSemiReachableCandidateNotDroppingLeader";
1230         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1231
1232         final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1233                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1234         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1235                 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1236
1237         final AbstractDataStore ds2 =
1238                      follower2TestKit.setupAbstractDataStore(
1239                              testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS);
1240
1241         followerTestKit.waitForMembersUp("member-1", "member-3");
1242         follower2TestKit.waitForMembersUp("member-1", "member-2");
1243
1244         TestKit.shutdownActorSystem(follower2System);
1245
1246         ActorRef cars = leaderDistributedDataStore.getActorUtils().findLocalShard("cars").get();
1247         OnDemandRaftState initialState = (OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1248                 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1249
1250         Cluster leaderCluster = Cluster.get(leaderSystem);
1251         Cluster followerCluster = Cluster.get(followerSystem);
1252         Cluster follower2Cluster = Cluster.get(follower2System);
1253
1254         Member follower2Member = follower2Cluster.readView().self();
1255
1256         await().atMost(10, TimeUnit.SECONDS)
1257                 .until(() -> containsUnreachable(leaderCluster, follower2Member));
1258         await().atMost(10, TimeUnit.SECONDS)
1259                 .until(() -> containsUnreachable(followerCluster, follower2Member));
1260
1261         ActorRef followerCars = followerDistributedDataStore.getActorUtils().findLocalShard("cars").get();
1262
1263         // to simulate a follower not being able to receive messages, but still being able to send messages and becoming
1264         // candidate, we can just send a couple of RequestVotes to both leader and follower.
1265         cars.tell(new RequestVote(initialState.getCurrentTerm() + 1, "member-3-shard-cars", -1, -1), null);
1266         followerCars.tell(new RequestVote(initialState.getCurrentTerm() + 1, "member-3-shard-cars", -1, -1), null);
1267         cars.tell(new RequestVote(initialState.getCurrentTerm() + 3, "member-3-shard-cars", -1, -1), null);
1268         followerCars.tell(new RequestVote(initialState.getCurrentTerm() + 3, "member-3-shard-cars", -1, -1), null);
1269
1270         OnDemandRaftState stateAfter = (OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1271                 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1272         OnDemandRaftState followerState = (OnDemandRaftState) followerDistributedDataStore.getActorUtils()
1273                 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1274
1275         assertEquals(initialState.getCurrentTerm(), stateAfter.getCurrentTerm());
1276         assertEquals(initialState.getCurrentTerm(), followerState.getCurrentTerm());
1277
1278         ds2.close();
1279     }
1280
1281     private static Boolean containsUnreachable(final Cluster cluster, final Member member) {
1282         // unreachableMembers() returns scala.collection.immutable.Set, but we are using scala.collection.Set to fix JDT
1283         // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=468276#c32
1284         final Set<Member> members = cluster.readView().unreachableMembers();
1285         return members.contains(member);
1286     }
1287
1288     @Test
1289     public void testInstallSnapshot() throws Exception {
1290         final String testName = "testInstallSnapshot";
1291         final String leaderCarShardName = "member-1-shard-cars-" + testName;
1292         final String followerCarShardName = "member-2-shard-cars-" + testName;
1293
1294         // Setup a saved snapshot on the leader. The follower will startup with no data and the leader should
1295         // install a snapshot to sync the follower.
1296
1297         DataTree tree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION,
1298             SchemaContextHelper.full());
1299
1300         final ContainerNode carsNode = CarsModel.newCarsNode(
1301                 CarsModel.newCarsMapNode(CarsModel.newCarEntry("optima", Uint64.valueOf(20000))));
1302         AbstractShardTest.writeToStore(tree, CarsModel.BASE_PATH, carsNode);
1303
1304         final NormalizedNode<?, ?> snapshotRoot = AbstractShardTest.readStore(tree, YangInstanceIdentifier.empty());
1305         final Snapshot initialSnapshot = Snapshot.create(
1306                 new ShardSnapshotState(new MetadataShardDataTreeSnapshot(snapshotRoot)),
1307                 Collections.emptyList(), 5, 1, 5, 1, 1, null, null);
1308         InMemorySnapshotStore.addSnapshot(leaderCarShardName, initialSnapshot);
1309
1310         InMemorySnapshotStore.addSnapshotSavedLatch(leaderCarShardName);
1311         InMemorySnapshotStore.addSnapshotSavedLatch(followerCarShardName);
1312
1313         initDatastoresWithCars(testName);
1314
1315         assertEquals(Optional.of(carsNode), leaderDistributedDataStore.newReadOnlyTransaction().read(
1316             CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS));
1317
1318         verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(leaderCarShardName, Snapshot.class),
1319                 initialSnapshot, snapshotRoot);
1320
1321         verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(followerCarShardName, Snapshot.class),
1322                 initialSnapshot, snapshotRoot);
1323     }
1324
1325     @Test
1326     public void testReadWriteMessageSlicing() throws Exception {
1327         // The slicing is only implemented for tell-based protocol
1328         assumeTrue(ClientBackedDataStore.class.isAssignableFrom(testParameter));
1329
1330         leaderDatastoreContextBuilder.maximumMessageSliceSize(100);
1331         followerDatastoreContextBuilder.maximumMessageSliceSize(100);
1332         initDatastoresWithCars("testLargeReadReplySlicing");
1333
1334         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1335
1336         final NormalizedNode<?, ?> carsNode = CarsModel.create();
1337         rwTx.write(CarsModel.BASE_PATH, carsNode);
1338
1339         verifyNode(rwTx, CarsModel.BASE_PATH, carsNode);
1340     }
1341
1342     @SuppressWarnings("IllegalCatch")
1343     @Test
1344     public void testRaftCallbackDuringLeadershipDrop() throws Exception {
1345         final String testName = "testRaftCallbackDuringLeadershipDrop";
1346         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1347
1348         final ExecutorService executor = Executors.newSingleThreadExecutor();
1349
1350         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
1351                 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(500)
1352                         .shardLeaderElectionTimeoutInSeconds(3600),
1353                 commitTimeout);
1354
1355         final DOMStoreWriteTransaction initialWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1356         initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1357         leaderTestKit.doCommit(initialWriteTx.ready());
1358
1359         try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
1360                 testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false)) {
1361
1362             final ActorRef member3Cars = ((LocalShardStore) follower2DistributedDataStore).getLocalShards()
1363                     .getLocalShards().get("cars").getActor();
1364             final ActorRef member2Cars = ((LocalShardStore)followerDistributedDataStore).getLocalShards()
1365                     .getLocalShards().get("cars").getActor();
1366             member2Cars.tell(new StartDropMessages(AppendEntries.class), null);
1367             member3Cars.tell(new StartDropMessages(AppendEntries.class), null);
1368
1369             final DOMStoreWriteTransaction newTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1370             newTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
1371             final AtomicBoolean submitDone = new AtomicBoolean(false);
1372             executor.submit(() -> {
1373                 try {
1374                     leaderTestKit.doCommit(newTx.ready());
1375                     submitDone.set(true);
1376                 } catch (Exception e) {
1377                     throw new RuntimeException(e);
1378                 }
1379             });
1380             final ActorRef leaderCars = ((LocalShardStore) leaderDistributedDataStore).getLocalShards()
1381                     .getLocalShards().get("cars").getActor();
1382             await().atMost(10, TimeUnit.SECONDS)
1383                     .until(() -> ((OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1384                             .executeOperation(leaderCars, GetOnDemandRaftState.INSTANCE)).getLastIndex() >= 1);
1385
1386             final OnDemandRaftState raftState = (OnDemandRaftState)leaderDistributedDataStore.getActorUtils()
1387                     .executeOperation(leaderCars, GetOnDemandRaftState.INSTANCE);
1388
1389             // Simulate a follower not receiving heartbeats but still being able to send messages ie RequestVote with
1390             // new term(switching to candidate after election timeout)
1391             leaderCars.tell(new RequestVote(raftState.getCurrentTerm() + 1,
1392                     "member-3-shard-cars-testRaftCallbackDuringLeadershipDrop", -1,
1393                             -1), member3Cars);
1394
1395             member2Cars.tell(new StopDropMessages(AppendEntries.class), null);
1396             member3Cars.tell(new StopDropMessages(AppendEntries.class), null);
1397
1398             await("Is tx stuck in COMMIT_PENDING")
1399                     .atMost(10, TimeUnit.SECONDS).untilAtomic(submitDone, equalTo(true));
1400
1401         }
1402
1403         executor.shutdownNow();
1404     }
1405
1406     @Test
1407     public void testSnapshotOnRootOverwrite() throws Exception {
1408         // FIXME: ClientBackedDatastore does not have stable indexes/term, the snapshot index seems to fluctuate
1409         assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
1410
1411         final String testName = "testSnapshotOnRootOverwrite";
1412         final String[] shards = {"cars", "default"};
1413         initDatastores(testName, "module-shards-default-cars-member1-and-2.conf", shards,
1414                 leaderDatastoreContextBuilder.snapshotOnRootOverwrite(true),
1415                 followerDatastoreContextBuilder.snapshotOnRootOverwrite(true));
1416
1417         leaderTestKit.waitForMembersUp("member-2");
1418         final ContainerNode rootNode = ImmutableContainerNodeBuilder.create()
1419                 .withNodeIdentifier(YangInstanceIdentifier.NodeIdentifier.create(SchemaContext.NAME))
1420                 .withChild((ContainerNode) CarsModel.create())
1421                 .build();
1422
1423         leaderTestKit.testWriteTransaction(leaderDistributedDataStore, YangInstanceIdentifier.empty(), rootNode);
1424
1425         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1426             state -> assertEquals(1, state.getSnapshotIndex()));
1427
1428         IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1429             state -> assertEquals(1, state.getSnapshotIndex()));
1430
1431         verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 1);
1432         verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 1);
1433
1434         for (int i = 0; i < 10; i++) {
1435             leaderTestKit.testWriteTransaction(leaderDistributedDataStore, CarsModel.newCarPath("car " + i),
1436                     CarsModel.newCarEntry("car " + i, Uint64.ONE));
1437         }
1438
1439         // fake snapshot causes the snapshotIndex to move
1440         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1441             state -> assertEquals(10, state.getSnapshotIndex()));
1442         IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1443             state -> assertEquals(10, state.getSnapshotIndex()));
1444
1445         // however the real snapshot still has not changed and was taken at index 1
1446         verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 1);
1447         verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 1);
1448
1449         // root overwrite so expect a snapshot
1450         leaderTestKit.testWriteTransaction(leaderDistributedDataStore, YangInstanceIdentifier.empty(), rootNode);
1451
1452         // this was a real snapshot so everything should be in it(1(DisableTrackingPayload) + 1 + 10 + 1)
1453         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1454             state -> assertEquals(12, state.getSnapshotIndex()));
1455         IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1456             state -> assertEquals(12, state.getSnapshotIndex()));
1457
1458         verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 12);
1459         verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 12);
1460     }
1461
1462     private void verifySnapshot(final String persistenceId, final long lastAppliedIndex) {
1463         await().atMost(5, TimeUnit.SECONDS).untilAsserted(() -> {
1464                 List<Snapshot> snap = InMemorySnapshotStore.getSnapshots(persistenceId, Snapshot.class);
1465                 assertEquals(1, snap.size());
1466                 assertEquals(lastAppliedIndex, snap.get(0).getLastAppliedIndex());
1467             }
1468         );
1469     }
1470
1471     private static void verifySnapshot(final Snapshot actual, final Snapshot expected,
1472                                        final NormalizedNode<?, ?> expRoot) {
1473         assertEquals("Snapshot getLastAppliedTerm", expected.getLastAppliedTerm(), actual.getLastAppliedTerm());
1474         assertEquals("Snapshot getLastAppliedIndex", expected.getLastAppliedIndex(), actual.getLastAppliedIndex());
1475         assertEquals("Snapshot getLastTerm", expected.getLastTerm(), actual.getLastTerm());
1476         assertEquals("Snapshot getLastIndex", expected.getLastIndex(), actual.getLastIndex());
1477         assertEquals("Snapshot state type", ShardSnapshotState.class, actual.getState().getClass());
1478         MetadataShardDataTreeSnapshot shardSnapshot =
1479                 (MetadataShardDataTreeSnapshot) ((ShardSnapshotState)actual.getState()).getSnapshot();
1480         assertEquals("Snapshot root node", expRoot, shardSnapshot.getRootNode().get());
1481     }
1482
1483     private static void sendDatastoreContextUpdate(final AbstractDataStore dataStore, final Builder builder) {
1484         final Builder newBuilder = DatastoreContext.newBuilderFrom(builder.build());
1485         final DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
1486         final Answer<DatastoreContext> answer = invocation -> newBuilder.build();
1487         doAnswer(answer).when(mockContextFactory).getBaseDatastoreContext();
1488         doAnswer(answer).when(mockContextFactory).getShardDatastoreContext(anyString());
1489         dataStore.onDatastoreContextUpdated(mockContextFactory);
1490     }
1491 }