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