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.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.junit.Assert.fail;
  15 import static org.mockito.ArgumentMatchers.any;
  16 import static org.mockito.ArgumentMatchers.eq;
  17 import static org.mockito.Mockito.timeout;
  18 import static org.mockito.Mockito.verify;
  19
  20 import akka.actor.ActorRef;
  21 import akka.actor.ActorSelection;
  22 import akka.actor.ActorSystem;
  23 import akka.actor.Address;
  24 import akka.actor.AddressFromURIString;
  25 import akka.cluster.Cluster;
  26 import akka.dispatch.Futures;
  27 import akka.pattern.Patterns;
  28 import akka.testkit.javadsl.TestKit;
  29 import com.google.common.base.Stopwatch;
  30 import com.google.common.base.Supplier;
  31 import com.google.common.base.Throwables;
  32 import com.google.common.collect.ImmutableMap;
  33 import com.google.common.util.concurrent.ListenableFuture;
  34 import com.google.common.util.concurrent.MoreExecutors;
  35 import com.google.common.util.concurrent.Uninterruptibles;
  36 import com.typesafe.config.ConfigFactory;
  37 import java.math.BigInteger;
  38 import java.util.Arrays;
  39 import java.util.Collection;
  40 import java.util.Collections;
  41 import java.util.LinkedList;
  42 import java.util.List;
  43 import java.util.Optional;
  44 import java.util.concurrent.ExecutionException;
  45 import java.util.concurrent.TimeUnit;
  46 import java.util.concurrent.atomic.AtomicLong;
  47 import org.junit.After;
  48 import org.junit.Assume;
  49 import org.junit.Before;
  50 import org.junit.Test;
  51 import org.junit.runner.RunWith;
  52 import org.junit.runners.Parameterized;
  53 import org.junit.runners.Parameterized.Parameter;
  54 import org.junit.runners.Parameterized.Parameters;
  55 import org.mockito.Mockito;
  56 import org.mockito.stubbing.Answer;
  57 import org.opendaylight.controller.cluster.access.client.RequestTimeoutException;
  58 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  59 import org.opendaylight.controller.cluster.databroker.ClientBackedDataStore;
  60 import org.opendaylight.controller.cluster.databroker.ConcurrentDOMDataBroker;
  61 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
  62 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
  63 import org.opendaylight.controller.cluster.datastore.exceptions.ShardLeaderNotRespondingException;
  64 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
  65 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
  66 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
  67 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
  68 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
  69 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
  70 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
  71 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
  72 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
  73 import org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow;
  74 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
  75 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
  76 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  77 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
  78 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  79 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  80 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
  81 import org.opendaylight.controller.md.cluster.datastore.model.PeopleModel;
  82 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  83 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
  84 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  85 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  86 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  87 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
  88 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  89 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  90 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  91 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  92 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  93 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  94 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  95 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  96 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  97 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  98 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  99 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 100 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
 101 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
 102 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 103 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
 104 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
 105 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
 106 import scala.concurrent.Await;
 107 import scala.concurrent.Future;
 108 import scala.concurrent.duration.FiniteDuration;
 109
 110 /**
 111  * End-to-end distributed data store tests that exercise remote shards and transactions.
 112  *
 113  * @author Thomas Pantelis
 114  */
 115 @RunWith(Parameterized.class)
 116 public class DistributedDataStoreRemotingIntegrationTest extends AbstractTest {
 117
 118     @Parameters(name = "{0}")
 119     public static Collection<Object[]> data() {
 120         return Arrays.asList(new Object[][] {
 121                 { DistributedDataStore.class, 7}, { ClientBackedDataStore.class, 12 }
 122         });
 123     }
 124
 125     @Parameter(0)
 126     public Class<? extends AbstractDataStore> testParameter;
 127     @Parameter(1)
 128     public int commitTimeout;
 129
 130     private static final String[] CARS_AND_PEOPLE = {"cars", "people"};
 131     private static final String[] CARS = {"cars"};
 132
 133     private static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse(
 134             "akka://cluster-test@127.0.0.1:2558");
 135     private static final Address MEMBER_2_ADDRESS = AddressFromURIString.parse(
 136             "akka://cluster-test@127.0.0.1:2559");
 137
 138     private static final String MODULE_SHARDS_CARS_ONLY_1_2 = "module-shards-cars-member-1-and-2.conf";
 139     private static final String MODULE_SHARDS_CARS_PEOPLE_1_2 = "module-shards-member1-and-2.conf";
 140     private static final String MODULE_SHARDS_CARS_PEOPLE_1_2_3 = "module-shards-member1-and-2-and-3.conf";
 141     private static final String MODULE_SHARDS_CARS_1_2_3 = "module-shards-cars-member-1-and-2-and-3.conf";
 142
 143     private ActorSystem leaderSystem;
 144     private ActorSystem followerSystem;
 145     private ActorSystem follower2System;
 146
 147     private final DatastoreContext.Builder leaderDatastoreContextBuilder =
 148             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2);
 149
 150     private final DatastoreContext.Builder followerDatastoreContextBuilder =
 151             DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
 152                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
 153     private final TransactionIdentifier tx1 = nextTransactionId();
 154     private final TransactionIdentifier tx2 = nextTransactionId();
 155
 156     private AbstractDataStore followerDistributedDataStore;
 157     private AbstractDataStore leaderDistributedDataStore;
 158     private IntegrationTestKit followerTestKit;
 159     private IntegrationTestKit leaderTestKit;
 160
 161     @Before
 162     public void setUp() {
 163         InMemoryJournal.clear();
 164         InMemorySnapshotStore.clear();
 165
 166         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 167         Cluster.get(leaderSystem).join(MEMBER_1_ADDRESS);
 168
 169         followerSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
 170         Cluster.get(followerSystem).join(MEMBER_1_ADDRESS);
 171
 172         follower2System = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member3"));
 173         Cluster.get(follower2System).join(MEMBER_1_ADDRESS);
 174     }
 175
 176     @After
 177     public void tearDown() {
 178         if (followerDistributedDataStore != null) {
 179             leaderDistributedDataStore.close();
 180         }
 181         if (leaderDistributedDataStore != null) {
 182             leaderDistributedDataStore.close();
 183         }
 184
 185         TestKit.shutdownActorSystem(leaderSystem);
 186         TestKit.shutdownActorSystem(followerSystem);
 187         TestKit.shutdownActorSystem(follower2System);
 188
 189         InMemoryJournal.clear();
 190         InMemorySnapshotStore.clear();
 191     }
 192
 193     private void initDatastoresWithCars(final String type) throws Exception {
 194         initDatastores(type, MODULE_SHARDS_CARS_ONLY_1_2, CARS);
 195     }
 196
 197     private void initDatastoresWithCarsAndPeople(final String type) throws Exception {
 198         initDatastores(type, MODULE_SHARDS_CARS_PEOPLE_1_2, CARS_AND_PEOPLE);
 199     }
 200
 201     private void initDatastores(final String type, final String moduleShardsConfig, final String[] shards)
 202             throws Exception {
 203         leaderTestKit = new IntegrationTestKit(leaderSystem, leaderDatastoreContextBuilder, commitTimeout);
 204
 205         leaderDistributedDataStore = leaderTestKit.setupAbstractDataStore(
 206                 testParameter, type, moduleShardsConfig, false, shards);
 207
 208         followerTestKit = new IntegrationTestKit(followerSystem, followerDatastoreContextBuilder, commitTimeout);
 209         followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
 210                 testParameter, type, moduleShardsConfig, false, shards);
 211
 212         leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorContext(), shards);
 213
 214         leaderTestKit.waitForMembersUp("member-2");
 215         followerTestKit.waitForMembersUp("member-1");
 216     }
 217
 218     private static void verifyCars(final DOMStoreReadTransaction readTx, final MapEntryNode... entries)
 219             throws Exception {
 220         final Optional<NormalizedNode<?, ?>> optional = readTx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS);
 221         assertTrue("isPresent", optional.isPresent());
 222
 223         final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = ImmutableNodes.mapNodeBuilder(
 224                 CarsModel.CAR_QNAME);
 225         for (final NormalizedNode<?, ?> entry: entries) {
 226             listBuilder.withChild((MapEntryNode) entry);
 227         }
 228
 229         assertEquals("Car list node", listBuilder.build(), optional.get());
 230     }
 231
 232     private static void verifyNode(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path,
 233             final NormalizedNode<?, ?> expNode) throws Exception {
 234         final Optional<NormalizedNode<?, ?>> optional = readTx.read(path).get(5, TimeUnit.SECONDS);
 235         assertTrue("isPresent", optional.isPresent());
 236         assertEquals("Data node", expNode, optional.get());
 237     }
 238
 239     private static void verifyExists(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path)
 240             throws Exception {
 241         final Boolean exists = readTx.exists(path).get(5, TimeUnit.SECONDS);
 242         assertEquals("exists", Boolean.TRUE, exists);
 243     }
 244
 245     @Test
 246     public void testWriteTransactionWithSingleShard() throws Exception {
 247         final String testName = "testWriteTransactionWithSingleShard";
 248         initDatastoresWithCars(testName);
 249
 250         final String followerCarShardName = "member-2-shard-cars-" + testName;
 251
 252         DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 253         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 254
 255         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 256         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 257
 258         final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 259         final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 260         writeTx.merge(car1Path, car1);
 261
 262         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(25000));
 263         final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
 264         writeTx.merge(car2Path, car2);
 265
 266         followerTestKit.doCommit(writeTx.ready());
 267
 268         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 269
 270         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 271
 272         // Test delete
 273
 274         writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 275
 276         writeTx.delete(car1Path);
 277
 278         followerTestKit.doCommit(writeTx.ready());
 279
 280         verifyExists(followerDistributedDataStore.newReadOnlyTransaction(), car2Path);
 281
 282         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
 283
 284         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car2);
 285
 286         // Re-instate the follower member 2 as a single-node to verify replication and recovery.
 287
 288         // The following is a bit tricky. Before we reinstate the follower we need to ensure it has persisted and
 289         // applied and all the log entries from the leader. Since we've verified the car data above we know that
 290         // all the transactions have been applied on the leader so we first read and capture its lastAppliedIndex.
 291         final AtomicLong leaderLastAppliedIndex = new AtomicLong();
 292         IntegrationTestKit.verifyShardState(leaderDistributedDataStore, CARS[0],
 293             state -> leaderLastAppliedIndex.set(state.getLastApplied()));
 294
 295         // Now we need to make sure the follower has persisted the leader's lastAppliedIndex via ApplyJournalEntries.
 296         // However we don't know exactly how many ApplyJournalEntries messages there will be as it can differ between
 297         // the tell-based and ask-based front-ends. For ask-based there will be exactly 2 ApplyJournalEntries but
 298         // tell-based persists additional payloads which could be replicated and applied in a batch resulting in
 299         // either 2 or 3 ApplyJournalEntries. To handle this we read the follower's persisted ApplyJournalEntries
 300         // until we find the one that encompasses the leader's lastAppliedIndex.
 301         Stopwatch sw = Stopwatch.createStarted();
 302         boolean done = false;
 303         while (!done) {
 304             final List<ApplyJournalEntries> entries = InMemoryJournal.get(followerCarShardName,
 305                     ApplyJournalEntries.class);
 306             for (ApplyJournalEntries aje: entries) {
 307                 if (aje.getToIndex() >= leaderLastAppliedIndex.get()) {
 308                     done = true;
 309                     break;
 310                 }
 311             }
 312
 313             assertTrue("Follower did not persist ApplyJournalEntries containing leader's lastAppliedIndex "
 314                     + leaderLastAppliedIndex + ". Entries persisted: " + entries, sw.elapsed(TimeUnit.SECONDS) <= 5);
 315
 316             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 317         }
 318
 319         TestKit.shutdownActorSystem(leaderSystem, true);
 320         TestKit.shutdownActorSystem(followerSystem, true);
 321
 322         final ActorSystem newSystem = newActorSystem("reinstated-member2", "Member2");
 323
 324         try (AbstractDataStore member2Datastore = new IntegrationTestKit(newSystem, leaderDatastoreContextBuilder,
 325                 commitTimeout)
 326                 .setupAbstractDataStore(testParameter, testName, "module-shards-member2", true, CARS)) {
 327             verifyCars(member2Datastore.newReadOnlyTransaction(), car2);
 328         }
 329     }
 330
 331     @Test
 332     public void testReadWriteTransactionWithSingleShard() throws Exception {
 333         initDatastoresWithCars("testReadWriteTransactionWithSingleShard");
 334
 335         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 336         assertNotNull("newReadWriteTransaction returned null", rwTx);
 337
 338         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 339         rwTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 340
 341         final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 342         rwTx.merge(CarsModel.newCarPath("optima"), car1);
 343
 344         verifyCars(rwTx, car1);
 345
 346         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(25000));
 347         final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
 348         rwTx.merge(car2Path, car2);
 349
 350         verifyExists(rwTx, car2Path);
 351
 352         followerTestKit.doCommit(rwTx.ready());
 353
 354         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 355     }
 356
 357     @Test
 358     public void testWriteTransactionWithMultipleShards() throws Exception {
 359         initDatastoresWithCarsAndPeople("testWriteTransactionWithMultipleShards");
 360
 361         final DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 362         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 363
 364         final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
 365         final NormalizedNode<?, ?> carsNode = CarsModel.emptyContainer();
 366         writeTx.write(carsPath, carsNode);
 367
 368         final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
 369         final NormalizedNode<?, ?> peopleNode = PeopleModel.emptyContainer();
 370         writeTx.write(peoplePath, peopleNode);
 371
 372         followerTestKit.doCommit(writeTx.ready());
 373
 374         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 375
 376         verifyNode(readTx, carsPath, carsNode);
 377         verifyNode(readTx, peoplePath, peopleNode);
 378     }
 379
 380     @Test
 381     public void testReadWriteTransactionWithMultipleShards() throws Exception {
 382         initDatastoresWithCarsAndPeople("testReadWriteTransactionWithMultipleShards");
 383
 384         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
 385         assertNotNull("newReadWriteTransaction returned null", rwTx);
 386
 387         final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
 388         final NormalizedNode<?, ?> carsNode = CarsModel.emptyContainer();
 389         rwTx.write(carsPath, carsNode);
 390
 391         final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
 392         final NormalizedNode<?, ?> peopleNode = PeopleModel.emptyContainer();
 393         rwTx.write(peoplePath, peopleNode);
 394
 395         followerTestKit.doCommit(rwTx.ready());
 396
 397         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 398
 399         verifyNode(readTx, carsPath, carsNode);
 400         verifyNode(readTx, peoplePath, peopleNode);
 401     }
 402
 403     @Test
 404     public void testTransactionChainWithSingleShard() throws Exception {
 405         initDatastoresWithCars("testTransactionChainWithSingleShard");
 406
 407         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 408
 409         // Add the top-level cars container with write-only.
 410
 411         final DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 412         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 413
 414         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 415
 416         final DOMStoreThreePhaseCommitCohort writeTxReady = writeTx.ready();
 417
 418         // Verify the top-level cars container with read-only.
 419
 420         verifyNode(txChain.newReadOnlyTransaction(), CarsModel.BASE_PATH, CarsModel.emptyContainer());
 421
 422         // Perform car operations with read-write.
 423
 424         final DOMStoreReadWriteTransaction rwTx = txChain.newReadWriteTransaction();
 425
 426         verifyNode(rwTx, CarsModel.BASE_PATH, CarsModel.emptyContainer());
 427
 428         rwTx.merge(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 429
 430         final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 431         final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 432         rwTx.write(car1Path, car1);
 433
 434         verifyExists(rwTx, car1Path);
 435
 436         verifyCars(rwTx, car1);
 437
 438         final MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(25000));
 439         rwTx.merge(CarsModel.newCarPath("sportage"), car2);
 440
 441         rwTx.delete(car1Path);
 442
 443         followerTestKit.doCommit(writeTxReady);
 444
 445         followerTestKit.doCommit(rwTx.ready());
 446
 447         txChain.close();
 448
 449         verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
 450     }
 451
 452     @Test
 453     public void testTransactionChainWithMultipleShards() throws Exception {
 454         initDatastoresWithCarsAndPeople("testTransactionChainWithMultipleShards");
 455
 456         final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
 457
 458         DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 459         assertNotNull("newWriteOnlyTransaction returned null", writeTx);
 460
 461         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 462         writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 463
 464         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 465         writeTx.write(PeopleModel.PERSON_LIST_PATH, PeopleModel.newPersonMapNode());
 466
 467         followerTestKit.doCommit(writeTx.ready());
 468
 469         final DOMStoreReadWriteTransaction readWriteTx = txChain.newReadWriteTransaction();
 470
 471         final MapEntryNode car = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 472         final YangInstanceIdentifier carPath = CarsModel.newCarPath("optima");
 473         readWriteTx.write(carPath, car);
 474
 475         final MapEntryNode person = PeopleModel.newPersonEntry("jack");
 476         final YangInstanceIdentifier personPath = PeopleModel.newPersonPath("jack");
 477         readWriteTx.merge(personPath, person);
 478
 479         Optional<NormalizedNode<?, ?>> optional = readWriteTx.read(carPath).get(5, TimeUnit.SECONDS);
 480         assertTrue("isPresent", optional.isPresent());
 481         assertEquals("Data node", car, optional.get());
 482
 483         optional = readWriteTx.read(personPath).get(5, TimeUnit.SECONDS);
 484         assertTrue("isPresent", optional.isPresent());
 485         assertEquals("Data node", person, optional.get());
 486
 487         final DOMStoreThreePhaseCommitCohort cohort2 = readWriteTx.ready();
 488
 489         writeTx = txChain.newWriteOnlyTransaction();
 490
 491         writeTx.delete(personPath);
 492
 493         final DOMStoreThreePhaseCommitCohort cohort3 = writeTx.ready();
 494
 495         followerTestKit.doCommit(cohort2);
 496         followerTestKit.doCommit(cohort3);
 497
 498         txChain.close();
 499
 500         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
 501         verifyCars(readTx, car);
 502
 503         optional = readTx.read(personPath).get(5, TimeUnit.SECONDS);
 504         assertFalse("isPresent", optional.isPresent());
 505     }
 506
 507     @Test
 508     public void testChainedTransactionFailureWithSingleShard() throws Exception {
 509         initDatastoresWithCars("testChainedTransactionFailureWithSingleShard");
 510
 511         final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
 512                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
 513                         LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
 514                         MoreExecutors.directExecutor());
 515
 516         final DOMTransactionChainListener listener = Mockito.mock(DOMTransactionChainListener.class);
 517         final DOMTransactionChain txChain = broker.createTransactionChain(listener);
 518
 519         final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 520
 521         final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 522                 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
 523                     .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
 524
 525         writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
 526
 527         try {
 528             writeTx.commit().get(5, TimeUnit.SECONDS);
 529             fail("Expected TransactionCommitFailedException");
 530         } catch (final ExecutionException e) {
 531             // Expected
 532         }
 533
 534         verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
 535
 536         txChain.close();
 537         broker.close();
 538     }
 539
 540     @Test
 541     public void testChainedTransactionFailureWithMultipleShards() throws Exception {
 542         initDatastoresWithCarsAndPeople("testChainedTransactionFailureWithMultipleShards");
 543
 544         final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
 545                 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
 546                         LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
 547                         MoreExecutors.directExecutor());
 548
 549         final DOMTransactionChainListener listener = Mockito.mock(DOMTransactionChainListener.class);
 550         final DOMTransactionChain txChain = broker.createTransactionChain(listener);
 551
 552         final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 553
 554         writeTx.put(LogicalDatastoreType.CONFIGURATION, PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 555
 556         final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
 557                 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
 558                     .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
 559
 560         // Note that merge will validate the data and fail but put succeeds b/c deep validation is not
 561         // done for put for performance reasons.
 562         writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
 563
 564         try {
 565             writeTx.commit().get(5, TimeUnit.SECONDS);
 566             fail("Expected TransactionCommitFailedException");
 567         } catch (final ExecutionException e) {
 568             // Expected
 569         }
 570
 571         verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
 572
 573         txChain.close();
 574         broker.close();
 575     }
 576
 577     @Test
 578     public void testSingleShardTransactionsWithLeaderChanges() throws Exception {
 579         followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
 580         final String testName = "testSingleShardTransactionsWithLeaderChanges";
 581         initDatastoresWithCars(testName);
 582
 583         final String followerCarShardName = "member-2-shard-cars-" + testName;
 584         InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 1, ApplyJournalEntries.class);
 585
 586         // Write top-level car container from the follower so it uses a remote Tx.
 587
 588         DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 589
 590         writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 591         writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 592
 593         followerTestKit.doCommit(writeTx.ready());
 594
 595         InMemoryJournal.waitForWriteMessagesComplete(followerCarShardName);
 596
 597         // Switch the leader to the follower
 598
 599         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
 600                 .shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
 601
 602         TestKit.shutdownActorSystem(leaderSystem, true);
 603         Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
 604
 605         followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorContext(), CARS);
 606
 607         leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
 608         Cluster.get(leaderSystem).join(MEMBER_2_ADDRESS);
 609
 610         final DatastoreContext.Builder newMember1Builder = DatastoreContext.newBuilder()
 611                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
 612         IntegrationTestKit newMember1TestKit = new IntegrationTestKit(leaderSystem, newMember1Builder, commitTimeout);
 613
 614         try (AbstractDataStore ds =
 615                 newMember1TestKit.setupAbstractDataStore(
 616                         testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS)) {
 617
 618             followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), CARS);
 619
 620             // Write a car entry to the new leader - should switch to local Tx
 621
 622             writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 623
 624             MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 625             YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
 626             writeTx.merge(car1Path, car1);
 627
 628             followerTestKit.doCommit(writeTx.ready());
 629
 630             verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1);
 631         }
 632     }
 633
 634     @SuppressWarnings("unchecked")
 635     @Test
 636     public void testReadyLocalTransactionForwardedToLeader() throws Exception {
 637         initDatastoresWithCars("testReadyLocalTransactionForwardedToLeader");
 638         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), "cars");
 639
 640         final com.google.common.base.Optional<ActorRef> carsFollowerShard =
 641                 followerDistributedDataStore.getActorContext().findLocalShard("cars");
 642         assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
 643
 644         final DataTree dataTree = new InMemoryDataTreeFactory().create(
 645             DataTreeConfiguration.DEFAULT_OPERATIONAL, SchemaContextHelper.full());
 646
 647         // Send a tx with immediate commit.
 648
 649         DataTreeModification modification = dataTree.takeSnapshot().newModification();
 650         new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
 651         new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
 652
 653         final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 654         new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
 655         modification.ready();
 656
 657         ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(tx1 , modification, true,
 658                 java.util.Optional.empty());
 659
 660         carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
 661         Object resp = followerTestKit.expectMsgClass(Object.class);
 662         if (resp instanceof akka.actor.Status.Failure) {
 663             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 664         }
 665
 666         assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
 667
 668         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
 669
 670         // Send another tx without immediate commit.
 671
 672         modification = dataTree.takeSnapshot().newModification();
 673         MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(30000));
 674         new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
 675         modification.ready();
 676
 677         readyLocal = new ReadyLocalTransaction(tx2 , modification, false, java.util.Optional.empty());
 678
 679         carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
 680         resp = followerTestKit.expectMsgClass(Object.class);
 681         if (resp instanceof akka.actor.Status.Failure) {
 682             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 683         }
 684
 685         assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
 686
 687         final ActorSelection txActor = leaderDistributedDataStore.getActorContext().actorSelection(
 688                 ((ReadyTransactionReply)resp).getCohortPath());
 689
 690         final Supplier<Short> versionSupplier = Mockito.mock(Supplier.class);
 691         Mockito.doReturn(DataStoreVersions.CURRENT_VERSION).when(versionSupplier).get();
 692         ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
 693                 leaderDistributedDataStore.getActorContext(), Arrays.asList(
 694                         new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor), versionSupplier)), tx2);
 695         cohort.canCommit().get(5, TimeUnit.SECONDS);
 696         cohort.preCommit().get(5, TimeUnit.SECONDS);
 697         cohort.commit().get(5, TimeUnit.SECONDS);
 698
 699         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 700     }
 701
 702     @SuppressWarnings("unchecked")
 703     @Test
 704     public void testForwardedReadyTransactionForwardedToLeader() throws Exception {
 705         initDatastoresWithCars("testForwardedReadyTransactionForwardedToLeader");
 706         followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), "cars");
 707
 708         final com.google.common.base.Optional<ActorRef> carsFollowerShard =
 709                 followerDistributedDataStore.getActorContext().findLocalShard("cars");
 710         assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
 711
 712         carsFollowerShard.get().tell(GetShardDataTree.INSTANCE, followerTestKit.getRef());
 713         final DataTree dataTree = followerTestKit.expectMsgClass(DataTree.class);
 714
 715         // Send a tx with immediate commit.
 716
 717         DataTreeModification modification = dataTree.takeSnapshot().newModification();
 718         new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
 719         new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
 720
 721         final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 722         new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
 723
 724         ForwardedReadyTransaction forwardedReady = new ForwardedReadyTransaction(tx1,
 725                 DataStoreVersions.CURRENT_VERSION, new ReadWriteShardDataTreeTransaction(
 726                         Mockito.mock(ShardDataTreeTransactionParent.class), tx1, modification), true,
 727                 java.util.Optional.empty());
 728
 729         carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
 730         Object resp = followerTestKit.expectMsgClass(Object.class);
 731         if (resp instanceof akka.actor.Status.Failure) {
 732             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 733         }
 734
 735         assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
 736
 737         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
 738
 739         // Send another tx without immediate commit.
 740
 741         modification = dataTree.takeSnapshot().newModification();
 742         MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(30000));
 743         new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
 744
 745         forwardedReady = new ForwardedReadyTransaction(tx2,
 746                 DataStoreVersions.CURRENT_VERSION, new ReadWriteShardDataTreeTransaction(
 747                         Mockito.mock(ShardDataTreeTransactionParent.class), tx2, modification), false,
 748                 java.util.Optional.empty());
 749
 750         carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
 751         resp = followerTestKit.expectMsgClass(Object.class);
 752         if (resp instanceof akka.actor.Status.Failure) {
 753             throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
 754         }
 755
 756         assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
 757
 758         ActorSelection txActor = leaderDistributedDataStore.getActorContext().actorSelection(
 759                 ((ReadyTransactionReply)resp).getCohortPath());
 760
 761         final Supplier<Short> versionSupplier = Mockito.mock(Supplier.class);
 762         Mockito.doReturn(DataStoreVersions.CURRENT_VERSION).when(versionSupplier).get();
 763         final ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
 764                 leaderDistributedDataStore.getActorContext(), Arrays.asList(
 765                         new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor), versionSupplier)), tx2);
 766         cohort.canCommit().get(5, TimeUnit.SECONDS);
 767         cohort.preCommit().get(5, TimeUnit.SECONDS);
 768         cohort.commit().get(5, TimeUnit.SECONDS);
 769
 770         verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
 771     }
 772
 773     @Test
 774     public void testTransactionForwardedToLeaderAfterRetry() throws Exception {
 775         //TODO remove when test passes also for ClientBackedDataStore
 776         Assume.assumeTrue(testParameter.equals(DistributedDataStore.class));
 777         followerDatastoreContextBuilder.shardBatchedModificationCount(2);
 778         leaderDatastoreContextBuilder.shardBatchedModificationCount(2);
 779         initDatastoresWithCarsAndPeople("testTransactionForwardedToLeaderAfterRetry");
 780
 781         // Do an initial write to get the primary shard info cached.
 782
 783         final DOMStoreWriteTransaction initialWriteTx = followerDistributedDataStore.newWriteOnlyTransaction();
 784         initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 785         initialWriteTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 786         followerTestKit.doCommit(initialWriteTx.ready());
 787
 788         // Wait for the commit to be replicated to the follower.
 789
 790         MemberNode.verifyRaftState(followerDistributedDataStore, "cars",
 791             raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
 792
 793         MemberNode.verifyRaftState(followerDistributedDataStore, "people",
 794             raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
 795
 796         // Prepare, ready and canCommit a WO tx that writes to 2 shards. This will become the current tx in
 797         // the leader shard.
 798
 799         final DOMStoreWriteTransaction writeTx1 = followerDistributedDataStore.newWriteOnlyTransaction();
 800         writeTx1.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 801         writeTx1.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 802         final DOMStoreThreePhaseCommitCohort writeTx1Cohort = writeTx1.ready();
 803         final ListenableFuture<Boolean> writeTx1CanCommit = writeTx1Cohort.canCommit();
 804         writeTx1CanCommit.get(5, TimeUnit.SECONDS);
 805
 806         // Prepare and ready another WO tx that writes to 2 shards but don't canCommit yet. This will be queued
 807         // in the leader shard.
 808
 809         final DOMStoreWriteTransaction writeTx2 = followerDistributedDataStore.newWriteOnlyTransaction();
 810         final LinkedList<MapEntryNode> cars = new LinkedList<>();
 811         int carIndex = 1;
 812         cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
 813         writeTx2.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 814         carIndex++;
 815         NormalizedNode<?, ?> people = ImmutableNodes.mapNodeBuilder(PeopleModel.PERSON_QNAME)
 816                 .withChild(PeopleModel.newPersonEntry("Dude")).build();
 817         writeTx2.write(PeopleModel.PERSON_LIST_PATH, people);
 818         final DOMStoreThreePhaseCommitCohort writeTx2Cohort = writeTx2.ready();
 819
 820         // Prepare another WO that writes to a single shard and thus will be directly committed on ready. This
 821         // tx writes 5 cars so 2 BatchedModidifications messages will be sent initially and cached in the
 822         // leader shard (with shardBatchedModificationCount set to 2). The 3rd BatchedModidifications will be
 823         // sent on ready.
 824
 825         final DOMStoreWriteTransaction writeTx3 = followerDistributedDataStore.newWriteOnlyTransaction();
 826         for (int i = 1; i <= 5; i++, carIndex++) {
 827             cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
 828             writeTx3.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 829         }
 830
 831         // Prepare another WO that writes to a single shard. This will send a single BatchedModidifications
 832         // message on ready.
 833
 834         final DOMStoreWriteTransaction writeTx4 = followerDistributedDataStore.newWriteOnlyTransaction();
 835         cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
 836         writeTx4.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 837         carIndex++;
 838
 839         // Prepare a RW tx that will create a tx actor and send a ForwardedReadyTransaciton message to the
 840         // leader shard on ready.
 841
 842         final DOMStoreReadWriteTransaction readWriteTx = followerDistributedDataStore.newReadWriteTransaction();
 843         cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
 844         readWriteTx.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
 845
 846         IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
 847             stats -> assertEquals("getReadWriteTransactionCount", 1, stats.getReadWriteTransactionCount()));
 848
 849         // Disable elections on the leader so it switches to follower.
 850
 851         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
 852                 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
 853                 .shardElectionTimeoutFactor(10));
 854
 855         leaderTestKit.waitUntilNoLeader(leaderDistributedDataStore.getActorContext(), "cars");
 856
 857         // Submit all tx's - the messages should get queued for retry.
 858
 859         final ListenableFuture<Boolean> writeTx2CanCommit = writeTx2Cohort.canCommit();
 860         final DOMStoreThreePhaseCommitCohort writeTx3Cohort = writeTx3.ready();
 861         final DOMStoreThreePhaseCommitCohort writeTx4Cohort = writeTx4.ready();
 862         final DOMStoreThreePhaseCommitCohort rwTxCohort = readWriteTx.ready();
 863
 864         // Enable elections on the other follower so it becomes the leader, at which point the
 865         // tx's should get forwarded from the previous leader to the new leader to complete the commits.
 866
 867         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
 868                 .customRaftPolicyImplementation(null).shardElectionTimeoutFactor(1));
 869         IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorContext(), "cars")
 870                 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
 871         IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorContext(), "people")
 872                 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
 873
 874         followerTestKit.doCommit(writeTx1CanCommit, writeTx1Cohort);
 875         followerTestKit.doCommit(writeTx2CanCommit, writeTx2Cohort);
 876         followerTestKit.doCommit(writeTx3Cohort);
 877         followerTestKit.doCommit(writeTx4Cohort);
 878         followerTestKit.doCommit(rwTxCohort);
 879
 880         DOMStoreReadTransaction readTx = leaderDistributedDataStore.newReadOnlyTransaction();
 881         verifyCars(readTx, cars.toArray(new MapEntryNode[cars.size()]));
 882         verifyNode(readTx, PeopleModel.PERSON_LIST_PATH, people);
 883     }
 884
 885     @Test
 886     public void testLeadershipTransferOnShutdown() throws Exception {
 887         //TODO remove when test passes also for ClientBackedDataStore
 888         Assume.assumeTrue(testParameter.equals(DistributedDataStore.class));
 889         leaderDatastoreContextBuilder.shardBatchedModificationCount(1);
 890         followerDatastoreContextBuilder.shardElectionTimeoutFactor(10).customRaftPolicyImplementation(null);
 891         final String testName = "testLeadershipTransferOnShutdown";
 892         initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS_AND_PEOPLE);
 893
 894         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
 895                 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(100),
 896                 commitTimeout);
 897         try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
 898                 testParameter, testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false)) {
 899
 900             followerTestKit.waitForMembersUp("member-3");
 901             follower2TestKit.waitForMembersUp("member-1", "member-2");
 902
 903             // Create and submit a couple tx's so they're pending.
 904
 905             DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 906             writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 907             writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
 908             writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
 909             final DOMStoreThreePhaseCommitCohort cohort1 = writeTx.ready();
 910
 911             IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
 912                 stats -> assertEquals("getTxCohortCacheSize", 1, stats.getTxCohortCacheSize()));
 913
 914             writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
 915             final MapEntryNode car = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
 916             writeTx.write(CarsModel.newCarPath("optima"), car);
 917             final DOMStoreThreePhaseCommitCohort cohort2 = writeTx.ready();
 918
 919             IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
 920                 stats -> assertEquals("getTxCohortCacheSize", 2, stats.getTxCohortCacheSize()));
 921
 922             // Gracefully stop the leader via a Shutdown message.
 923
 924             sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
 925                 .shardElectionTimeoutFactor(100));
 926
 927             final FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
 928             final Future<ActorRef> future = leaderDistributedDataStore.getActorContext().findLocalShardAsync("cars");
 929             final ActorRef leaderActor = Await.result(future, duration);
 930
 931             final Future<Boolean> stopFuture = Patterns.gracefulStop(leaderActor, duration, Shutdown.INSTANCE);
 932
 933             // Commit the 2 transactions. They should finish and succeed.
 934
 935             followerTestKit.doCommit(cohort1);
 936             followerTestKit.doCommit(cohort2);
 937
 938             // Wait for the leader actor stopped.
 939
 940             final Boolean stopped = Await.result(stopFuture, duration);
 941             assertEquals("Stopped", Boolean.TRUE, stopped);
 942
 943             // Verify leadership was transferred by reading the committed data from the other nodes.
 944
 945             verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car);
 946             verifyCars(follower2DistributedDataStore.newReadOnlyTransaction(), car);
 947         }
 948     }
 949
 950     @Test
 951     public void testTransactionWithIsolatedLeader() throws Exception {
 952         //TODO remove when test passes also for ClientBackedDataStore
 953         Assume.assumeTrue(testParameter.equals(DistributedDataStore.class));
 954         // Set the isolated leader check interval high so we can control the switch to IsolatedLeader.
 955         leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(10000000);
 956         final String testName = "testTransactionWithIsolatedLeader";
 957         initDatastoresWithCars(testName);
 958
 959         // Tx that is submitted after the follower is stopped but before the leader transitions to IsolatedLeader.
 960         final DOMStoreWriteTransaction preIsolatedLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
 961         preIsolatedLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 962
 963         // Tx that is submitted after the leader transitions to IsolatedLeader.
 964         final DOMStoreWriteTransaction noShardLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
 965         noShardLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 966
 967         // Tx that is submitted after the follower is reinstated.
 968         final DOMStoreWriteTransaction successWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
 969         successWriteTx.merge(CarsModel.BASE_PATH, CarsModel.emptyContainer());
 970
 971         // Stop the follower
 972         followerTestKit.watch(followerDistributedDataStore.getActorContext().getShardManager());
 973         followerDistributedDataStore.close();
 974         followerTestKit.expectTerminated(followerDistributedDataStore.getActorContext().getShardManager());
 975
 976         // Submit the preIsolatedLeaderWriteTx so it's pending
 977         final DOMStoreThreePhaseCommitCohort preIsolatedLeaderTxCohort = preIsolatedLeaderWriteTx.ready();
 978
 979         // Change the isolated leader check interval low so it changes to IsolatedLeader.
 980         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
 981                 .shardIsolatedLeaderCheckIntervalInMillis(200));
 982
 983         MemberNode.verifyRaftState(leaderDistributedDataStore, "cars",
 984             raftState -> assertEquals("getRaftState", "IsolatedLeader", raftState.getRaftState()));
 985
 986         try {
 987             leaderTestKit.doCommit(noShardLeaderWriteTx.ready());
 988             fail("Expected NoShardLeaderException");
 989         } catch (final ExecutionException e) {
 990             assertEquals("getCause", NoShardLeaderException.class, Throwables.getRootCause(e).getClass());
 991         }
 992
 993         sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
 994                 .shardElectionTimeoutFactor(100));
 995
 996         final DOMStoreThreePhaseCommitCohort successTxCohort = successWriteTx.ready();
 997
 998         followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
 999                 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS);
1000
1001         leaderTestKit.doCommit(preIsolatedLeaderTxCohort);
1002         leaderTestKit.doCommit(successTxCohort);
1003     }
1004
1005     @Test
1006     public void testTransactionWithShardLeaderNotResponding() throws Exception {
1007         followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1008         followerDatastoreContextBuilder.shardElectionTimeoutFactor(50);
1009         initDatastoresWithCars("testTransactionWithShardLeaderNotResponding");
1010
1011         // Do an initial read to get the primary shard info cached.
1012
1013         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1014         readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1015
1016         // Shutdown the leader and try to create a new tx.
1017
1018         TestKit.shutdownActorSystem(leaderSystem, true);
1019
1020         followerDatastoreContextBuilder.operationTimeoutInMillis(50).shardElectionTimeoutFactor(1);
1021         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
1022
1023         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1024
1025         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1026
1027         try {
1028             followerTestKit.doCommit(rwTx.ready());
1029             fail("Exception expected");
1030         } catch (final ExecutionException e) {
1031             final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(e.getCause());
1032             if (DistributedDataStore.class.equals(testParameter)) {
1033                 assertTrue(msg, Throwables.getRootCause(e) instanceof NoShardLeaderException
1034                         || e.getCause() instanceof ShardLeaderNotRespondingException);
1035             } else {
1036                 assertTrue(msg, Throwables.getRootCause(e) instanceof RequestTimeoutException);
1037             }
1038         }
1039     }
1040
1041     @Test
1042     public void testTransactionWithCreateTxFailureDueToNoLeader() throws Exception {
1043         followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1044         initDatastoresWithCars("testTransactionWithCreateTxFailureDueToNoLeader");
1045
1046         // Do an initial read to get the primary shard info cached.
1047
1048         final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1049         readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1050
1051         // Shutdown the leader and try to create a new tx.
1052
1053         TestKit.shutdownActorSystem(leaderSystem, true);
1054
1055         Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1056
1057         Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
1058
1059         sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1060                 .operationTimeoutInMillis(10).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
1061
1062         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1063
1064         rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1065
1066         try {
1067             followerTestKit.doCommit(rwTx.ready());
1068             fail("Exception expected");
1069         } catch (final ExecutionException e) {
1070             final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(e.getCause());
1071             if (DistributedDataStore.class.equals(testParameter)) {
1072                 assertTrue(msg, Throwables.getRootCause(e) instanceof NoShardLeaderException);
1073             } else {
1074                 assertTrue(msg, Throwables.getRootCause(e) instanceof RequestTimeoutException);
1075             }
1076         }
1077     }
1078
1079     @Test
1080     public void testTransactionRetryWithInitialAskTimeoutExOnCreateTx() throws Exception {
1081         followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
1082         String testName = "testTransactionRetryWithInitialAskTimeoutExOnCreateTx";
1083         initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1084
1085         final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1086                 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1087         final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1088                 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1089
1090         try (AbstractDataStore ds =
1091                 follower2TestKit.setupAbstractDataStore(
1092                         testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS)) {
1093
1094             followerTestKit.waitForMembersUp("member-1", "member-3");
1095             follower2TestKit.waitForMembersUp("member-1", "member-2");
1096
1097             // Do an initial read to get the primary shard info cached.
1098
1099             final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1100             readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1101
1102             // Shutdown the leader and try to create a new tx.
1103
1104             TestKit.shutdownActorSystem(leaderSystem, true);
1105
1106             Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1107
1108             sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1109                 .operationTimeoutInMillis(500).shardElectionTimeoutFactor(5).customRaftPolicyImplementation(null));
1110
1111             final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1112
1113             rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1114
1115             followerTestKit.doCommit(rwTx.ready());
1116         }
1117     }
1118
1119     @Test
1120     public void testInstallSnapshot() throws Exception {
1121         final String testName = "testInstallSnapshot";
1122         final String leaderCarShardName = "member-1-shard-cars-" + testName;
1123         final String followerCarShardName = "member-2-shard-cars-" + testName;
1124
1125         // Setup a saved snapshot on the leader. The follower will startup with no data and the leader should
1126         // install a snapshot to sync the follower.
1127
1128         DataTree tree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION,
1129             SchemaContextHelper.full());
1130
1131         final ContainerNode carsNode = CarsModel.newCarsNode(
1132                 CarsModel.newCarsMapNode(CarsModel.newCarEntry("optima", BigInteger.valueOf(20000))));
1133         AbstractShardTest.writeToStore(tree, CarsModel.BASE_PATH, carsNode);
1134
1135         final NormalizedNode<?, ?> snapshotRoot = AbstractShardTest.readStore(tree, YangInstanceIdentifier.EMPTY);
1136         final Snapshot initialSnapshot = Snapshot.create(
1137                 new ShardSnapshotState(new MetadataShardDataTreeSnapshot(snapshotRoot)),
1138                 Collections.emptyList(), 5, 1, 5, 1, 1, null, null);
1139         InMemorySnapshotStore.addSnapshot(leaderCarShardName, initialSnapshot);
1140
1141         InMemorySnapshotStore.addSnapshotSavedLatch(leaderCarShardName);
1142         InMemorySnapshotStore.addSnapshotSavedLatch(followerCarShardName);
1143
1144         initDatastoresWithCars(testName);
1145
1146         final Optional<NormalizedNode<?, ?>> readOptional = leaderDistributedDataStore.newReadOnlyTransaction().read(
1147                 CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1148         assertTrue("isPresent", readOptional.isPresent());
1149         assertEquals("Node", carsNode, readOptional.get());
1150
1151         verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(leaderCarShardName, Snapshot.class),
1152                 initialSnapshot, snapshotRoot);
1153
1154         verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(followerCarShardName, Snapshot.class),
1155                 initialSnapshot, snapshotRoot);
1156     }
1157
1158     @Test
1159     public void testReadWriteMessageSlicing() throws Exception {
1160         // The slicing is only implemented for tell-based protocol
1161         Assume.assumeTrue(testParameter.equals(ClientBackedDataStore.class));
1162
1163         leaderDatastoreContextBuilder.maximumMessageSliceSize(100);
1164         followerDatastoreContextBuilder.maximumMessageSliceSize(100);
1165         initDatastoresWithCars("testLargeReadReplySlicing");
1166
1167         final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1168
1169         final NormalizedNode<?, ?> carsNode = CarsModel.create();
1170         rwTx.write(CarsModel.BASE_PATH, carsNode);
1171
1172         verifyNode(rwTx, CarsModel.BASE_PATH, carsNode);
1173     }
1174
1175     private static void verifySnapshot(final Snapshot actual, final Snapshot expected,
1176                                        final NormalizedNode<?, ?> expRoot) {
1177         assertEquals("Snapshot getLastAppliedTerm", expected.getLastAppliedTerm(), actual.getLastAppliedTerm());
1178         assertEquals("Snapshot getLastAppliedIndex", expected.getLastAppliedIndex(), actual.getLastAppliedIndex());
1179         assertEquals("Snapshot getLastTerm", expected.getLastTerm(), actual.getLastTerm());
1180         assertEquals("Snapshot getLastIndex", expected.getLastIndex(), actual.getLastIndex());
1181         assertEquals("Snapshot state type", ShardSnapshotState.class, actual.getState().getClass());
1182         MetadataShardDataTreeSnapshot shardSnapshot =
1183                 (MetadataShardDataTreeSnapshot) ((ShardSnapshotState)actual.getState()).getSnapshot();
1184         assertEquals("Snapshot root node", expRoot, shardSnapshot.getRootNode().get());
1185     }
1186
1187     private static void sendDatastoreContextUpdate(final AbstractDataStore dataStore, final Builder builder) {
1188         final Builder newBuilder = DatastoreContext.newBuilderFrom(builder.build());
1189         final DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
1190         final Answer<DatastoreContext> answer = invocation -> newBuilder.build();
1191         Mockito.doAnswer(answer).when(mockContextFactory).getBaseDatastoreContext();
1192         Mockito.doAnswer(answer).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
1193         dataStore.onDatastoreContextUpdated(mockContextFactory);
1194     }
1195 }