2 * Copyright (c) 2015, 2017 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertTrue;
13 import static org.junit.Assert.fail;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Matchers.eq;
16 import static org.mockito.Mockito.timeout;
17 import static org.mockito.Mockito.verify;
19 import akka.actor.ActorRef;
20 import akka.actor.ActorSelection;
21 import akka.actor.ActorSystem;
22 import akka.actor.Address;
23 import akka.actor.AddressFromURIString;
24 import akka.cluster.Cluster;
25 import akka.dispatch.Futures;
26 import akka.pattern.Patterns;
27 import akka.testkit.JavaTestKit;
28 import com.google.common.base.Optional;
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.concurrent.ExecutionException;
44 import java.util.concurrent.TimeUnit;
45 import java.util.concurrent.atomic.AtomicLong;
46 import org.junit.After;
47 import org.junit.Assume;
48 import org.junit.Before;
49 import org.junit.Test;
50 import org.junit.runner.RunWith;
51 import org.junit.runners.Parameterized;
52 import org.junit.runners.Parameterized.Parameter;
53 import org.junit.runners.Parameterized.Parameters;
54 import org.mockito.Mockito;
55 import org.mockito.stubbing.Answer;
56 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
57 import org.opendaylight.controller.cluster.databroker.ClientBackedDataStore;
58 import org.opendaylight.controller.cluster.databroker.ConcurrentDOMDataBroker;
59 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
60 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
61 import org.opendaylight.controller.cluster.datastore.exceptions.ShardLeaderNotRespondingException;
62 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
63 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
64 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
65 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
66 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
67 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
68 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
69 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
70 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
71 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
72 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
73 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
74 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
75 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
76 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
77 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
78 import org.opendaylight.controller.md.cluster.datastore.model.PeopleModel;
79 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
80 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
81 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
82 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
83 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
84 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
85 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
86 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
87 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
88 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
89 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
90 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
91 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
92 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
93 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
94 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
95 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
96 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
97 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
98 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
99 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
100 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
101 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
102 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
103 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
104 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
105 import scala.concurrent.Await;
106 import scala.concurrent.Future;
107 import scala.concurrent.duration.FiniteDuration;
110 * End-to-end distributed data store tests that exercise remote shards and transactions.
112 * @author Thomas Pantelis
114 @RunWith(Parameterized.class)
115 public class DistributedDataStoreRemotingIntegrationTest extends AbstractTest {
117 @Parameters(name = "{0}")
118 public static Collection<Object[]> data() {
119 return Arrays.asList(new Object[][] {
120 { DistributedDataStore.class, 7}, { ClientBackedDataStore.class, 60 }
125 public Class<? extends AbstractDataStore> testParameter;
127 public int commitTimeout;
129 private static final String[] CARS_AND_PEOPLE = {"cars", "people"};
130 private static final String[] CARS = {"cars"};
132 private static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse(
133 "akka://cluster-test@127.0.0.1:2558");
134 private static final Address MEMBER_2_ADDRESS = AddressFromURIString.parse(
135 "akka://cluster-test@127.0.0.1:2559");
137 private static final String MODULE_SHARDS_CARS_ONLY_1_2 = "module-shards-cars-member-1-and-2.conf";
138 private static final String MODULE_SHARDS_CARS_PEOPLE_1_2 = "module-shards-member1-and-2.conf";
139 private static final String MODULE_SHARDS_CARS_PEOPLE_1_2_3 = "module-shards-member1-and-2-and-3.conf";
141 private ActorSystem leaderSystem;
142 private ActorSystem followerSystem;
143 private ActorSystem follower2System;
145 private final DatastoreContext.Builder leaderDatastoreContextBuilder =
146 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2);
148 private final DatastoreContext.Builder followerDatastoreContextBuilder =
149 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
150 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
151 private final TransactionIdentifier tx1 = nextTransactionId();
152 private final TransactionIdentifier tx2 = nextTransactionId();
154 private AbstractDataStore followerDistributedDataStore;
155 private AbstractDataStore leaderDistributedDataStore;
156 private IntegrationTestKit followerTestKit;
157 private IntegrationTestKit leaderTestKit;
160 public void setUp() {
161 InMemoryJournal.clear();
162 InMemorySnapshotStore.clear();
164 leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
165 Cluster.get(leaderSystem).join(MEMBER_1_ADDRESS);
167 followerSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
168 Cluster.get(followerSystem).join(MEMBER_1_ADDRESS);
170 follower2System = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member3"));
171 Cluster.get(follower2System).join(MEMBER_1_ADDRESS);
175 public void tearDown() {
176 if (followerDistributedDataStore != null) {
177 leaderDistributedDataStore.close();
179 if (leaderDistributedDataStore != null) {
180 leaderDistributedDataStore.close();
183 JavaTestKit.shutdownActorSystem(leaderSystem);
184 JavaTestKit.shutdownActorSystem(followerSystem);
185 JavaTestKit.shutdownActorSystem(follower2System);
187 InMemoryJournal.clear();
188 InMemorySnapshotStore.clear();
191 private void initDatastoresWithCars(final String type) throws Exception {
192 initDatastores(type, MODULE_SHARDS_CARS_ONLY_1_2, CARS);
195 private void initDatastoresWithCarsAndPeople(final String type) throws Exception {
196 initDatastores(type, MODULE_SHARDS_CARS_PEOPLE_1_2, CARS_AND_PEOPLE);
199 private void initDatastores(final String type, final String moduleShardsConfig, final String[] shards)
201 leaderTestKit = new IntegrationTestKit(leaderSystem, leaderDatastoreContextBuilder, commitTimeout);
203 leaderDistributedDataStore = leaderTestKit.setupAbstractDataStore(
204 testParameter, type, moduleShardsConfig, false, shards);
206 followerTestKit = new IntegrationTestKit(followerSystem, followerDatastoreContextBuilder, commitTimeout);
207 followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
208 testParameter, type, moduleShardsConfig, false, shards);
210 leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorContext(), shards);
212 leaderTestKit.waitForMembersUp("member-2");
213 followerTestKit.waitForMembersUp("member-1");
216 private static void verifyCars(final DOMStoreReadTransaction readTx, final MapEntryNode... entries)
218 final Optional<NormalizedNode<?, ?>> optional = readTx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS);
219 assertEquals("isPresent", true, optional.isPresent());
221 final CollectionNodeBuilder<MapEntryNode, MapNode> listBuilder = ImmutableNodes.mapNodeBuilder(
222 CarsModel.CAR_QNAME);
223 for (final NormalizedNode<?, ?> entry: entries) {
224 listBuilder.withChild((MapEntryNode) entry);
227 assertEquals("Car list node", listBuilder.build(), optional.get());
230 private static void verifyNode(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path,
231 final NormalizedNode<?, ?> expNode) throws Exception {
232 final Optional<NormalizedNode<?, ?>> optional = readTx.read(path).get(5, TimeUnit.SECONDS);
233 assertEquals("isPresent", true, optional.isPresent());
234 assertEquals("Data node", expNode, optional.get());
237 private static void verifyExists(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path)
239 final Boolean exists = readTx.exists(path).get(5, TimeUnit.SECONDS);
240 assertEquals("exists", true, exists);
244 public void testWriteTransactionWithSingleShard() throws Exception {
245 final String testName = "testWriteTransactionWithSingleShard";
246 initDatastoresWithCars(testName);
248 final String followerCarShardName = "member-2-shard-cars-" + testName;
250 DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
251 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
253 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
254 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
256 final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
257 final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
258 writeTx.merge(car1Path, car1);
260 final MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(25000));
261 final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
262 writeTx.merge(car2Path, car2);
264 followerTestKit.doCommit(writeTx.ready());
266 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
268 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
272 writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
274 writeTx.delete(car1Path);
276 followerTestKit.doCommit(writeTx.ready());
278 verifyExists(followerDistributedDataStore.newReadOnlyTransaction(), car2Path);
280 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
282 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car2);
284 // Re-instate the follower member 2 as a single-node to verify replication and recovery.
286 // The following is a bit tricky. Before we reinstate the follower we need to ensure it has persisted and
287 // applied and all the log entries from the leader. Since we've verified the car data above we know that
288 // all the transactions have been applied on the leader so we first read and capture its lastAppliedIndex.
289 final AtomicLong leaderLastAppliedIndex = new AtomicLong();
290 IntegrationTestKit.verifyShardState(leaderDistributedDataStore, CARS[0],
291 state -> leaderLastAppliedIndex.set(state.getLastApplied()));
293 // Now we need to make sure the follower has persisted the leader's lastAppliedIndex via ApplyJournalEntries.
294 // However we don't know exactly how many ApplyJournalEntries messages there will be as it can differ between
295 // the tell-based and ask-based front-ends. For ask-based there will be exactly 2 ApplyJournalEntries but
296 // tell-based persists additional payloads which could be replicated and applied in a batch resulting in
297 // either 2 or 3 ApplyJournalEntries. To handle this we read the follower's persisted ApplyJournalEntries
298 // until we find the one that encompasses the leader's lastAppliedIndex.
299 Stopwatch sw = Stopwatch.createStarted();
300 boolean done = false;
302 final List<ApplyJournalEntries> entries = InMemoryJournal.get(followerCarShardName,
303 ApplyJournalEntries.class);
304 for (ApplyJournalEntries aje: entries) {
305 if (aje.getToIndex() >= leaderLastAppliedIndex.get()) {
311 assertTrue("Follower did not persist ApplyJournalEntries containing leader's lastAppliedIndex "
312 + leaderLastAppliedIndex + ". Entries persisted: " + entries, sw.elapsed(TimeUnit.SECONDS) <= 5);
314 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
317 JavaTestKit.shutdownActorSystem(leaderSystem, null, Boolean.TRUE);
318 JavaTestKit.shutdownActorSystem(followerSystem, null, Boolean.TRUE);
320 final ActorSystem newSystem = newActorSystem("reinstated-member2", "Member2");
322 try (AbstractDataStore member2Datastore = new IntegrationTestKit(newSystem, leaderDatastoreContextBuilder,
324 .setupAbstractDataStore(testParameter, testName, "module-shards-member2", true, CARS)) {
325 verifyCars(member2Datastore.newReadOnlyTransaction(), car2);
330 public void testReadWriteTransactionWithSingleShard() throws Exception {
331 initDatastoresWithCars("testReadWriteTransactionWithSingleShard");
333 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
334 assertNotNull("newReadWriteTransaction returned null", rwTx);
336 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
337 rwTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
339 final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
340 rwTx.merge(CarsModel.newCarPath("optima"), car1);
342 verifyCars(rwTx, car1);
344 final MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(25000));
345 final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
346 rwTx.merge(car2Path, car2);
348 verifyExists(rwTx, car2Path);
350 followerTestKit.doCommit(rwTx.ready());
352 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
356 public void testWriteTransactionWithMultipleShards() throws Exception {
357 initDatastoresWithCarsAndPeople("testWriteTransactionWithMultipleShards");
359 final DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
360 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
362 final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
363 final NormalizedNode<?, ?> carsNode = CarsModel.emptyContainer();
364 writeTx.write(carsPath, carsNode);
366 final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
367 final NormalizedNode<?, ?> peopleNode = PeopleModel.emptyContainer();
368 writeTx.write(peoplePath, peopleNode);
370 followerTestKit.doCommit(writeTx.ready());
372 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
374 verifyNode(readTx, carsPath, carsNode);
375 verifyNode(readTx, peoplePath, peopleNode);
379 public void testReadWriteTransactionWithMultipleShards() throws Exception {
380 initDatastoresWithCarsAndPeople("testReadWriteTransactionWithMultipleShards");
382 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
383 assertNotNull("newReadWriteTransaction returned null", rwTx);
385 final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
386 final NormalizedNode<?, ?> carsNode = CarsModel.emptyContainer();
387 rwTx.write(carsPath, carsNode);
389 final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
390 final NormalizedNode<?, ?> peopleNode = PeopleModel.emptyContainer();
391 rwTx.write(peoplePath, peopleNode);
393 followerTestKit.doCommit(rwTx.ready());
395 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
397 verifyNode(readTx, carsPath, carsNode);
398 verifyNode(readTx, peoplePath, peopleNode);
402 public void testTransactionChainWithSingleShard() throws Exception {
403 initDatastoresWithCars("testTransactionChainWithSingleShard");
405 final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
407 // Add the top-level cars container with write-only.
409 final DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
410 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
412 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
414 final DOMStoreThreePhaseCommitCohort writeTxReady = writeTx.ready();
416 // Verify the top-level cars container with read-only.
418 verifyNode(txChain.newReadOnlyTransaction(), CarsModel.BASE_PATH, CarsModel.emptyContainer());
420 // Perform car operations with read-write.
422 final DOMStoreReadWriteTransaction rwTx = txChain.newReadWriteTransaction();
424 verifyNode(rwTx, CarsModel.BASE_PATH, CarsModel.emptyContainer());
426 rwTx.merge(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
428 final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
429 final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
430 rwTx.write(car1Path, car1);
432 verifyExists(rwTx, car1Path);
434 verifyCars(rwTx, car1);
436 final MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(25000));
437 rwTx.merge(CarsModel.newCarPath("sportage"), car2);
439 rwTx.delete(car1Path);
441 followerTestKit.doCommit(writeTxReady);
443 followerTestKit.doCommit(rwTx.ready());
447 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
451 public void testTransactionChainWithMultipleShards() throws Exception {
452 initDatastoresWithCarsAndPeople("testTransactionChainWithMultipleShards");
454 final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
456 DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
457 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
459 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
460 writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
462 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
463 writeTx.write(PeopleModel.PERSON_LIST_PATH, PeopleModel.newPersonMapNode());
465 followerTestKit.doCommit(writeTx.ready());
467 final DOMStoreReadWriteTransaction readWriteTx = txChain.newReadWriteTransaction();
469 final MapEntryNode car = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
470 final YangInstanceIdentifier carPath = CarsModel.newCarPath("optima");
471 readWriteTx.write(carPath, car);
473 final MapEntryNode person = PeopleModel.newPersonEntry("jack");
474 final YangInstanceIdentifier personPath = PeopleModel.newPersonPath("jack");
475 readWriteTx.merge(personPath, person);
477 Optional<NormalizedNode<?, ?>> optional = readWriteTx.read(carPath).get(5, TimeUnit.SECONDS);
478 assertEquals("isPresent", true, optional.isPresent());
479 assertEquals("Data node", car, optional.get());
481 optional = readWriteTx.read(personPath).get(5, TimeUnit.SECONDS);
482 assertEquals("isPresent", true, optional.isPresent());
483 assertEquals("Data node", person, optional.get());
485 final DOMStoreThreePhaseCommitCohort cohort2 = readWriteTx.ready();
487 writeTx = txChain.newWriteOnlyTransaction();
489 writeTx.delete(personPath);
491 final DOMStoreThreePhaseCommitCohort cohort3 = writeTx.ready();
493 followerTestKit.doCommit(cohort2);
494 followerTestKit.doCommit(cohort3);
498 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
499 verifyCars(readTx, car);
501 optional = readTx.read(personPath).get(5, TimeUnit.SECONDS);
502 assertEquals("isPresent", false, optional.isPresent());
506 public void testChainedTransactionFailureWithSingleShard() throws Exception {
507 initDatastoresWithCars("testChainedTransactionFailureWithSingleShard");
509 final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
510 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
511 LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
512 MoreExecutors.directExecutor());
514 final TransactionChainListener listener = Mockito.mock(TransactionChainListener.class);
515 final DOMTransactionChain txChain = broker.createTransactionChain(listener);
517 final DOMDataWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
519 final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
520 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
521 .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
523 writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
526 writeTx.submit().checkedGet(5, TimeUnit.SECONDS);
527 fail("Expected TransactionCommitFailedException");
528 } catch (final TransactionCommitFailedException e) {
532 verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
539 public void testChainedTransactionFailureWithMultipleShards() throws Exception {
540 initDatastoresWithCarsAndPeople("testChainedTransactionFailureWithMultipleShards");
542 final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
543 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
544 LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
545 MoreExecutors.directExecutor());
547 final TransactionChainListener listener = Mockito.mock(TransactionChainListener.class);
548 final DOMTransactionChain txChain = broker.createTransactionChain(listener);
550 final DOMDataWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
552 writeTx.put(LogicalDatastoreType.CONFIGURATION, PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
554 final ContainerNode invalidData = ImmutableContainerNodeBuilder.create().withNodeIdentifier(
555 new YangInstanceIdentifier.NodeIdentifier(CarsModel.BASE_QNAME))
556 .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk")).build();
558 // Note that merge will validate the data and fail but put succeeds b/c deep validation is not
559 // done for put for performance reasons.
560 writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, invalidData);
563 writeTx.submit().checkedGet(5, TimeUnit.SECONDS);
564 fail("Expected TransactionCommitFailedException");
565 } catch (final TransactionCommitFailedException e) {
569 verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
576 public void testSingleShardTransactionsWithLeaderChanges() throws Exception {
577 final String testName = "testSingleShardTransactionsWithLeaderChanges";
578 initDatastoresWithCars(testName);
580 final String followerCarShardName = "member-2-shard-cars-" + testName;
581 InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 1, ApplyJournalEntries.class);
583 // Write top-level car container from the follower so it uses a remote Tx.
585 DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
587 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
588 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
590 followerTestKit.doCommit(writeTx.ready());
592 InMemoryJournal.waitForWriteMessagesComplete(followerCarShardName);
594 // Switch the leader to the follower
596 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
597 .shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
599 JavaTestKit.shutdownActorSystem(leaderSystem, null, true);
600 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
602 followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorContext(), CARS);
604 leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
605 Cluster.get(leaderSystem).join(MEMBER_2_ADDRESS);
607 final DatastoreContext.Builder newMember1Builder = DatastoreContext.newBuilder()
608 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
609 IntegrationTestKit newMember1TestKit = new IntegrationTestKit(leaderSystem, newMember1Builder, commitTimeout);
611 try (AbstractDataStore ds =
612 newMember1TestKit.setupAbstractDataStore(
613 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS)) {
615 followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), CARS);
617 // Write a car entry to the new leader - should switch to local Tx
619 writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
621 MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
622 YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
623 writeTx.merge(car1Path, car1);
625 followerTestKit.doCommit(writeTx.ready());
627 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1);
631 @SuppressWarnings("unchecked")
633 public void testReadyLocalTransactionForwardedToLeader() throws Exception {
634 initDatastoresWithCars("testReadyLocalTransactionForwardedToLeader");
635 followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), "cars");
637 final Optional<ActorRef> carsFollowerShard = followerDistributedDataStore.getActorContext()
638 .findLocalShard("cars");
639 assertEquals("Cars follower shard found", true, carsFollowerShard.isPresent());
641 final TipProducingDataTree dataTree = InMemoryDataTreeFactory.getInstance().create(TreeType.OPERATIONAL);
642 dataTree.setSchemaContext(SchemaContextHelper.full());
644 // Send a tx with immediate commit.
646 DataTreeModification modification = dataTree.takeSnapshot().newModification();
647 new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
648 new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
650 final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
651 new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
652 modification.ready();
654 ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(tx1 , modification, true);
656 carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
657 Object resp = followerTestKit.expectMsgClass(Object.class);
658 if (resp instanceof akka.actor.Status.Failure) {
659 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
662 assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
664 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
666 // Send another tx without immediate commit.
668 modification = dataTree.takeSnapshot().newModification();
669 MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(30000));
670 new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
671 modification.ready();
673 readyLocal = new ReadyLocalTransaction(tx2 , modification, false);
675 carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
676 resp = followerTestKit.expectMsgClass(Object.class);
677 if (resp instanceof akka.actor.Status.Failure) {
678 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
681 assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
683 final ActorSelection txActor = leaderDistributedDataStore.getActorContext().actorSelection(
684 ((ReadyTransactionReply)resp).getCohortPath());
686 final Supplier<Short> versionSupplier = Mockito.mock(Supplier.class);
687 Mockito.doReturn(DataStoreVersions.CURRENT_VERSION).when(versionSupplier).get();
688 ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
689 leaderDistributedDataStore.getActorContext(), Arrays.asList(
690 new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor), versionSupplier)), tx2);
691 cohort.canCommit().get(5, TimeUnit.SECONDS);
692 cohort.preCommit().get(5, TimeUnit.SECONDS);
693 cohort.commit().get(5, TimeUnit.SECONDS);
695 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
698 @SuppressWarnings("unchecked")
700 public void testForwardedReadyTransactionForwardedToLeader() throws Exception {
701 initDatastoresWithCars("testForwardedReadyTransactionForwardedToLeader");
702 followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorContext(), "cars");
704 final Optional<ActorRef> carsFollowerShard = followerDistributedDataStore.getActorContext()
705 .findLocalShard("cars");
706 assertEquals("Cars follower shard found", true, carsFollowerShard.isPresent());
708 carsFollowerShard.get().tell(GetShardDataTree.INSTANCE, followerTestKit.getRef());
709 final DataTree dataTree = followerTestKit.expectMsgClass(DataTree.class);
711 // Send a tx with immediate commit.
713 DataTreeModification modification = dataTree.takeSnapshot().newModification();
714 new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
715 new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
717 final MapEntryNode car1 = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
718 new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
720 ForwardedReadyTransaction forwardedReady = new ForwardedReadyTransaction(tx1,
721 DataStoreVersions.CURRENT_VERSION, new ReadWriteShardDataTreeTransaction(
722 Mockito.mock(ShardDataTreeTransactionParent.class), tx1, modification), true);
724 carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
725 Object resp = followerTestKit.expectMsgClass(Object.class);
726 if (resp instanceof akka.actor.Status.Failure) {
727 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
730 assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
732 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
734 // Send another tx without immediate commit.
736 modification = dataTree.takeSnapshot().newModification();
737 MapEntryNode car2 = CarsModel.newCarEntry("sportage", BigInteger.valueOf(30000));
738 new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
740 forwardedReady = new ForwardedReadyTransaction(tx2,
741 DataStoreVersions.CURRENT_VERSION, new ReadWriteShardDataTreeTransaction(
742 Mockito.mock(ShardDataTreeTransactionParent.class), tx2, modification), false);
744 carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
745 resp = followerTestKit.expectMsgClass(Object.class);
746 if (resp instanceof akka.actor.Status.Failure) {
747 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
750 assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
752 ActorSelection txActor = leaderDistributedDataStore.getActorContext().actorSelection(
753 ((ReadyTransactionReply)resp).getCohortPath());
755 final Supplier<Short> versionSupplier = Mockito.mock(Supplier.class);
756 Mockito.doReturn(DataStoreVersions.CURRENT_VERSION).when(versionSupplier).get();
757 final ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
758 leaderDistributedDataStore.getActorContext(), Arrays.asList(
759 new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor), versionSupplier)), tx2);
760 cohort.canCommit().get(5, TimeUnit.SECONDS);
761 cohort.preCommit().get(5, TimeUnit.SECONDS);
762 cohort.commit().get(5, TimeUnit.SECONDS);
764 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
768 public void testTransactionForwardedToLeaderAfterRetry() throws Exception {
769 //TODO remove when test passes also for ClientBackedDataStore
770 Assume.assumeTrue(testParameter.equals(DistributedDataStore.class));
771 followerDatastoreContextBuilder.shardBatchedModificationCount(2);
772 leaderDatastoreContextBuilder.shardBatchedModificationCount(2);
773 initDatastoresWithCarsAndPeople("testTransactionForwardedToLeaderAfterRetry");
775 // Do an initial write to get the primary shard info cached.
777 final DOMStoreWriteTransaction initialWriteTx = followerDistributedDataStore.newWriteOnlyTransaction();
778 initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
779 initialWriteTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
780 followerTestKit.doCommit(initialWriteTx.ready());
782 // Wait for the commit to be replicated to the follower.
784 MemberNode.verifyRaftState(followerDistributedDataStore, "cars",
785 raftState -> assertEquals("getLastApplied", 0, raftState.getLastApplied()));
787 MemberNode.verifyRaftState(followerDistributedDataStore, "people",
788 raftState -> assertEquals("getLastApplied", 0, raftState.getLastApplied()));
790 // Prepare, ready and canCommit a WO tx that writes to 2 shards. This will become the current tx in
793 final DOMStoreWriteTransaction writeTx1 = followerDistributedDataStore.newWriteOnlyTransaction();
794 writeTx1.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
795 writeTx1.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
796 final DOMStoreThreePhaseCommitCohort writeTx1Cohort = writeTx1.ready();
797 final ListenableFuture<Boolean> writeTx1CanCommit = writeTx1Cohort.canCommit();
798 writeTx1CanCommit.get(5, TimeUnit.SECONDS);
800 // Prepare and ready another WO tx that writes to 2 shards but don't canCommit yet. This will be queued
801 // in the leader shard.
803 final DOMStoreWriteTransaction writeTx2 = followerDistributedDataStore.newWriteOnlyTransaction();
804 final LinkedList<MapEntryNode> cars = new LinkedList<>();
806 cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
807 writeTx2.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
809 NormalizedNode<?, ?> people = PeopleModel.newPersonMapNode();
810 writeTx2.write(PeopleModel.PERSON_LIST_PATH, people);
811 final DOMStoreThreePhaseCommitCohort writeTx2Cohort = writeTx2.ready();
813 // Prepare another WO that writes to a single shard and thus will be directly committed on ready. This
814 // tx writes 5 cars so 2 BatchedModidifications messages will be sent initially and cached in the
815 // leader shard (with shardBatchedModificationCount set to 2). The 3rd BatchedModidifications will be
818 final DOMStoreWriteTransaction writeTx3 = followerDistributedDataStore.newWriteOnlyTransaction();
819 for (int i = 1; i <= 5; i++, carIndex++) {
820 cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
821 writeTx3.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
824 // Prepare another WO that writes to a single shard. This will send a single BatchedModidifications
827 final DOMStoreWriteTransaction writeTx4 = followerDistributedDataStore.newWriteOnlyTransaction();
828 cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
829 writeTx4.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
832 // Prepare a RW tx that will create a tx actor and send a ForwardedReadyTransaciton message to the
833 // leader shard on ready.
835 final DOMStoreReadWriteTransaction readWriteTx = followerDistributedDataStore.newReadWriteTransaction();
836 cars.add(CarsModel.newCarEntry("car" + carIndex, BigInteger.valueOf(carIndex)));
837 readWriteTx.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
839 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
840 stats -> assertEquals("getReadWriteTransactionCount", 1, stats.getReadWriteTransactionCount()));
842 // Disable elections on the leader so it switches to follower.
844 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
845 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
846 .shardElectionTimeoutFactor(10));
848 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
849 leaderTestKit.waitUntilNoLeader(leaderDistributedDataStore.getActorContext(), "cars");
851 // Submit all tx's - the messages should get queued for retry.
853 final ListenableFuture<Boolean> writeTx2CanCommit = writeTx2Cohort.canCommit();
854 final DOMStoreThreePhaseCommitCohort writeTx3Cohort = writeTx3.ready();
855 final DOMStoreThreePhaseCommitCohort writeTx4Cohort = writeTx4.ready();
856 final DOMStoreThreePhaseCommitCohort rwTxCohort = readWriteTx.ready();
858 // Enable elections on the other follower so it becomes the leader, at which point the
859 // tx's should get forwarded from the previous leader to the new leader to complete the commits.
861 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
862 .customRaftPolicyImplementation(null).shardElectionTimeoutFactor(1));
864 followerTestKit.doCommit(writeTx1CanCommit, writeTx1Cohort);
865 followerTestKit.doCommit(writeTx2CanCommit, writeTx2Cohort);
866 followerTestKit.doCommit(writeTx3Cohort);
867 followerTestKit.doCommit(writeTx4Cohort);
868 followerTestKit.doCommit(rwTxCohort);
870 DOMStoreReadTransaction readTx = leaderDistributedDataStore.newReadOnlyTransaction();
871 verifyCars(readTx, cars.toArray(new MapEntryNode[cars.size()]));
872 verifyNode(readTx, PeopleModel.PERSON_LIST_PATH, people);
876 public void testLeadershipTransferOnShutdown() throws Exception {
877 //TODO remove when test passes also for ClientBackedDataStore
878 Assume.assumeTrue(testParameter.equals(DistributedDataStore.class));
879 leaderDatastoreContextBuilder.shardBatchedModificationCount(1);
880 followerDatastoreContextBuilder.shardElectionTimeoutFactor(10).customRaftPolicyImplementation(null);
881 final String testName = "testLeadershipTransferOnShutdown";
882 initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS_AND_PEOPLE);
884 final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
885 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(100),
887 try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
888 testParameter, testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false)) {
890 followerTestKit.waitForMembersUp("member-3");
891 follower2TestKit.waitForMembersUp("member-1", "member-2");
893 // Create and submit a couple tx's so they're pending.
895 DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
896 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
897 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
898 writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
899 final DOMStoreThreePhaseCommitCohort cohort1 = writeTx.ready();
901 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
902 stats -> assertEquals("getTxCohortCacheSize", 1, stats.getTxCohortCacheSize()));
904 writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
905 final MapEntryNode car = CarsModel.newCarEntry("optima", BigInteger.valueOf(20000));
906 writeTx.write(CarsModel.newCarPath("optima"), car);
907 final DOMStoreThreePhaseCommitCohort cohort2 = writeTx.ready();
909 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
910 stats -> assertEquals("getTxCohortCacheSize", 2, stats.getTxCohortCacheSize()));
912 // Gracefully stop the leader via a Shutdown message.
914 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
915 .shardElectionTimeoutFactor(100));
917 final FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
918 final Future<ActorRef> future = leaderDistributedDataStore.getActorContext().findLocalShardAsync("cars");
919 final ActorRef leaderActor = Await.result(future, duration);
921 final Future<Boolean> stopFuture = Patterns.gracefulStop(leaderActor, duration, Shutdown.INSTANCE);
923 // Commit the 2 transactions. They should finish and succeed.
925 followerTestKit.doCommit(cohort1);
926 followerTestKit.doCommit(cohort2);
928 // Wait for the leader actor stopped.
930 final Boolean stopped = Await.result(stopFuture, duration);
931 assertEquals("Stopped", Boolean.TRUE, stopped);
933 // Verify leadership was transferred by reading the committed data from the other nodes.
935 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car);
936 verifyCars(follower2DistributedDataStore.newReadOnlyTransaction(), car);
941 public void testTransactionWithIsolatedLeader() throws Exception {
942 //TODO remove when test passes also for ClientBackedDataStore
943 Assume.assumeTrue(testParameter.equals(DistributedDataStore.class));
944 // Set the isolated leader check interval high so we can control the switch to IsolatedLeader.
945 leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(10000000);
946 final String testName = "testTransactionWithIsolatedLeader";
947 initDatastoresWithCars(testName);
949 // Tx that is submitted after the follower is stopped but before the leader transitions to IsolatedLeader.
950 final DOMStoreWriteTransaction preIsolatedLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
951 preIsolatedLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
953 // Tx that is submitted after the leader transitions to IsolatedLeader.
954 final DOMStoreWriteTransaction noShardLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
955 noShardLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
957 // Tx that is submitted after the follower is reinstated.
958 final DOMStoreWriteTransaction successWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
959 successWriteTx.merge(CarsModel.BASE_PATH, CarsModel.emptyContainer());
962 followerTestKit.watch(followerDistributedDataStore.getActorContext().getShardManager());
963 followerDistributedDataStore.close();
964 followerTestKit.expectTerminated(followerDistributedDataStore.getActorContext().getShardManager());
966 // Submit the preIsolatedLeaderWriteTx so it's pending
967 final DOMStoreThreePhaseCommitCohort preIsolatedLeaderTxCohort = preIsolatedLeaderWriteTx.ready();
969 // Change the isolated leader check interval low so it changes to IsolatedLeader.
970 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
971 .shardIsolatedLeaderCheckIntervalInMillis(200));
973 MemberNode.verifyRaftState(leaderDistributedDataStore, "cars",
974 raftState -> assertEquals("getRaftState", "IsolatedLeader", raftState.getRaftState()));
977 leaderTestKit.doCommit(noShardLeaderWriteTx.ready());
978 fail("Expected NoShardLeaderException");
979 } catch (final ExecutionException e) {
980 assertEquals("getCause", NoShardLeaderException.class, Throwables.getRootCause(e).getClass());
983 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
984 .shardElectionTimeoutFactor(100));
986 final DOMStoreThreePhaseCommitCohort successTxCohort = successWriteTx.ready();
988 followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
989 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS);
991 leaderTestKit.doCommit(preIsolatedLeaderTxCohort);
992 leaderTestKit.doCommit(successTxCohort);
996 public void testTransactionWithShardLeaderNotResponding() throws Exception {
997 followerDatastoreContextBuilder.shardElectionTimeoutFactor(50);
998 initDatastoresWithCars("testTransactionWithShardLeaderNotResponding");
1000 // Do an initial read to get the primary shard info cached.
1002 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1003 readTx.read(CarsModel.BASE_PATH).checkedGet(5, TimeUnit.SECONDS);
1005 // Shutdown the leader and try to create a new tx.
1007 JavaTestKit.shutdownActorSystem(leaderSystem, null, true);
1009 followerDatastoreContextBuilder.operationTimeoutInMillis(50).shardElectionTimeoutFactor(1);
1010 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
1012 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1014 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1017 followerTestKit.doCommit(rwTx.ready());
1018 fail("Exception expected");
1019 } catch (final ExecutionException e) {
1020 final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(e.getCause());
1021 assertTrue(msg, Throwables.getRootCause(e) instanceof NoShardLeaderException
1022 || e.getCause() instanceof ShardLeaderNotRespondingException);
1027 public void testTransactionWithCreateTxFailureDueToNoLeader() throws Exception {
1028 initDatastoresWithCars("testTransactionWithCreateTxFailureDueToNoLeader");
1030 // Do an initial read to get the primary shard info cached.
1032 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1033 readTx.read(CarsModel.BASE_PATH).checkedGet(5, TimeUnit.SECONDS);
1035 // Shutdown the leader and try to create a new tx.
1037 JavaTestKit.shutdownActorSystem(leaderSystem, null, true);
1039 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1041 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
1043 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1044 .operationTimeoutInMillis(10).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
1046 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1048 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1051 followerTestKit.doCommit(rwTx.ready());
1052 fail("Exception expected");
1053 } catch (final ExecutionException e) {
1054 final String msg = "Expected instance of NoShardLeaderException, actual: \n"
1055 + Throwables.getStackTraceAsString(e.getCause());
1056 assertTrue(msg, Throwables.getRootCause(e) instanceof NoShardLeaderException);
1061 public void testTransactionRetryWithInitialAskTimeoutExOnCreateTx() throws Exception {
1062 String testName = "testTransactionRetryWithInitialAskTimeoutExOnCreateTx";
1063 initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS);
1065 final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1066 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
1067 final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1068 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1070 try (AbstractDataStore ds =
1071 follower2TestKit.setupAbstractDataStore(
1072 testParameter, testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false, CARS)) {
1074 followerTestKit.waitForMembersUp("member-1", "member-3");
1075 follower2TestKit.waitForMembersUp("member-1", "member-2");
1077 // Do an initial read to get the primary shard info cached.
1079 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1080 readTx.read(CarsModel.BASE_PATH).checkedGet(5, TimeUnit.SECONDS);
1082 // Shutdown the leader and try to create a new tx.
1084 JavaTestKit.shutdownActorSystem(leaderSystem, null, true);
1086 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1088 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1089 .operationTimeoutInMillis(500).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
1091 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1093 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1095 followerTestKit.doCommit(rwTx.ready());
1100 public void testInstallSnapshot() throws Exception {
1101 final String testName = "testInstallSnapshot";
1102 final String leaderCarShardName = "member-1-shard-cars-" + testName;
1103 final String followerCarShardName = "member-2-shard-cars-" + testName;
1105 // Setup a saved snapshot on the leader. The follower will startup with no data and the leader should
1106 // install a snapshot to sync the follower.
1108 TipProducingDataTree tree = InMemoryDataTreeFactory.getInstance().create(TreeType.CONFIGURATION);
1109 tree.setSchemaContext(SchemaContextHelper.full());
1111 final ContainerNode carsNode = CarsModel.newCarsNode(
1112 CarsModel.newCarsMapNode(CarsModel.newCarEntry("optima", BigInteger.valueOf(20000))));
1113 AbstractShardTest.writeToStore(tree, CarsModel.BASE_PATH, carsNode);
1115 final NormalizedNode<?, ?> snapshotRoot = AbstractShardTest.readStore(tree, YangInstanceIdentifier.EMPTY);
1116 final Snapshot initialSnapshot = Snapshot.create(
1117 new ShardSnapshotState(new MetadataShardDataTreeSnapshot(snapshotRoot)),
1118 Collections.emptyList(), 5, 1, 5, 1, 1, null, null);
1119 InMemorySnapshotStore.addSnapshot(leaderCarShardName, initialSnapshot);
1121 InMemorySnapshotStore.addSnapshotSavedLatch(leaderCarShardName);
1122 InMemorySnapshotStore.addSnapshotSavedLatch(followerCarShardName);
1124 initDatastoresWithCars(testName);
1126 final Optional<NormalizedNode<?, ?>> readOptional = leaderDistributedDataStore.newReadOnlyTransaction().read(
1127 CarsModel.BASE_PATH).checkedGet(5, TimeUnit.SECONDS);
1128 assertEquals("isPresent", true, readOptional.isPresent());
1129 assertEquals("Node", carsNode, readOptional.get());
1131 verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(leaderCarShardName, Snapshot.class),
1132 initialSnapshot, snapshotRoot);
1134 verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(followerCarShardName, Snapshot.class),
1135 initialSnapshot, snapshotRoot);
1138 private static void verifySnapshot(final Snapshot actual, final Snapshot expected,
1139 final NormalizedNode<?, ?> expRoot) {
1140 assertEquals("Snapshot getLastAppliedTerm", expected.getLastAppliedTerm(), actual.getLastAppliedTerm());
1141 assertEquals("Snapshot getLastAppliedIndex", expected.getLastAppliedIndex(), actual.getLastAppliedIndex());
1142 assertEquals("Snapshot getLastTerm", expected.getLastTerm(), actual.getLastTerm());
1143 assertEquals("Snapshot getLastIndex", expected.getLastIndex(), actual.getLastIndex());
1144 assertEquals("Snapshot state type", ShardSnapshotState.class, actual.getState().getClass());
1145 MetadataShardDataTreeSnapshot shardSnapshot =
1146 (MetadataShardDataTreeSnapshot) ((ShardSnapshotState)actual.getState()).getSnapshot();
1147 assertEquals("Snapshot root node", expRoot, shardSnapshot.getRootNode().get());
1150 private static void sendDatastoreContextUpdate(final AbstractDataStore dataStore, final Builder builder) {
1151 final Builder newBuilder = DatastoreContext.newBuilderFrom(builder.build());
1152 final DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
1153 final Answer<DatastoreContext> answer = invocation -> newBuilder.build();
1154 Mockito.doAnswer(answer).when(mockContextFactory).getBaseDatastoreContext();
1155 Mockito.doAnswer(answer).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
1156 dataStore.onDatastoreContextUpdated(mockContextFactory);