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.awaitility.Awaitility.await;
11 import static org.hamcrest.CoreMatchers.containsString;
12 import static org.hamcrest.CoreMatchers.instanceOf;
13 import static org.hamcrest.MatcherAssert.assertThat;
14 import static org.hamcrest.Matchers.equalTo;
15 import static org.junit.Assert.assertEquals;
16 import static org.junit.Assert.assertFalse;
17 import static org.junit.Assert.assertNotNull;
18 import static org.junit.Assert.assertThrows;
19 import static org.junit.Assert.assertTrue;
20 import static org.junit.Assume.assumeTrue;
21 import static org.mockito.ArgumentMatchers.any;
22 import static org.mockito.ArgumentMatchers.anyString;
23 import static org.mockito.ArgumentMatchers.eq;
24 import static org.mockito.Mockito.doAnswer;
25 import static org.mockito.Mockito.mock;
26 import static org.mockito.Mockito.timeout;
27 import static org.mockito.Mockito.verify;
29 import akka.actor.ActorRef;
30 import akka.actor.ActorSelection;
31 import akka.actor.ActorSystem;
32 import akka.actor.Address;
33 import akka.actor.AddressFromURIString;
34 import akka.cluster.Cluster;
35 import akka.cluster.Member;
36 import akka.dispatch.Futures;
37 import akka.pattern.Patterns;
38 import akka.testkit.javadsl.TestKit;
39 import com.google.common.base.Stopwatch;
40 import com.google.common.base.Throwables;
41 import com.google.common.collect.ImmutableMap;
42 import com.google.common.util.concurrent.ListenableFuture;
43 import com.google.common.util.concurrent.MoreExecutors;
44 import com.google.common.util.concurrent.Uninterruptibles;
45 import com.typesafe.config.ConfigFactory;
46 import java.util.Arrays;
47 import java.util.Collection;
48 import java.util.Collections;
49 import java.util.LinkedList;
50 import java.util.List;
51 import java.util.Optional;
52 import java.util.concurrent.ExecutionException;
53 import java.util.concurrent.ExecutorService;
54 import java.util.concurrent.Executors;
55 import java.util.concurrent.TimeUnit;
56 import java.util.concurrent.atomic.AtomicBoolean;
57 import java.util.concurrent.atomic.AtomicLong;
58 import org.junit.After;
59 import org.junit.Before;
60 import org.junit.Test;
61 import org.junit.runner.RunWith;
62 import org.junit.runners.Parameterized;
63 import org.junit.runners.Parameterized.Parameter;
64 import org.junit.runners.Parameterized.Parameters;
65 import org.mockito.stubbing.Answer;
66 import org.opendaylight.controller.cluster.access.client.RequestTimeoutException;
67 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
68 import org.opendaylight.controller.cluster.databroker.ClientBackedDataStore;
69 import org.opendaylight.controller.cluster.databroker.ConcurrentDOMDataBroker;
70 import org.opendaylight.controller.cluster.databroker.TestClientBackedDataStore;
71 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
72 import org.opendaylight.controller.cluster.datastore.TestShard.RequestFrontendMetadata;
73 import org.opendaylight.controller.cluster.datastore.TestShard.StartDropMessages;
74 import org.opendaylight.controller.cluster.datastore.TestShard.StopDropMessages;
75 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
76 import org.opendaylight.controller.cluster.datastore.exceptions.ShardLeaderNotRespondingException;
77 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
78 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
79 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
80 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
81 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
82 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
83 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
84 import org.opendaylight.controller.cluster.datastore.persisted.FrontendClientMetadata;
85 import org.opendaylight.controller.cluster.datastore.persisted.FrontendShardDataTreeSnapshotMetadata;
86 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
87 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
88 import org.opendaylight.controller.cluster.datastore.utils.UnsignedLongBitmap;
89 import org.opendaylight.controller.cluster.raft.base.messages.TimeoutNow;
90 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
91 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
92 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
93 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
94 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
95 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
96 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
97 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
98 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
99 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
100 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
101 import org.opendaylight.controller.md.cluster.datastore.model.PeopleModel;
102 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
103 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
104 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
105 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
106 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
107 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
108 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
109 import org.opendaylight.mdsal.dom.api.DOMTransactionChainListener;
110 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
111 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
112 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
113 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
114 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
115 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
116 import org.opendaylight.yangtools.yang.common.Uint64;
117 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
118 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
119 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
120 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
121 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
122 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
123 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
124 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
125 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
126 import org.opendaylight.yangtools.yang.data.tree.api.ConflictingModificationAppliedException;
127 import org.opendaylight.yangtools.yang.data.tree.api.DataTree;
128 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
129 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
130 import org.opendaylight.yangtools.yang.data.tree.impl.di.InMemoryDataTreeFactory;
131 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
132 import scala.collection.Set;
133 import scala.concurrent.Await;
134 import scala.concurrent.Future;
135 import scala.concurrent.duration.FiniteDuration;
138 * End-to-end distributed data store tests that exercise remote shards and transactions.
140 * @author Thomas Pantelis
142 @RunWith(Parameterized.class)
143 public class DistributedDataStoreRemotingIntegrationTest extends AbstractTest {
145 @Parameters(name = "{0}")
146 public static Collection<Object[]> data() {
147 return Arrays.asList(new Object[][] {
148 { TestDistributedDataStore.class, 7 }, { TestClientBackedDataStore.class, 12 }
153 public Class<? extends AbstractDataStore> testParameter;
155 public int commitTimeout;
157 private static final String[] CARS_AND_PEOPLE = {"cars", "people"};
158 private static final String[] CARS = {"cars"};
160 private static final Address MEMBER_1_ADDRESS = AddressFromURIString.parse(
161 "akka://cluster-test@127.0.0.1:2558");
162 private static final Address MEMBER_2_ADDRESS = AddressFromURIString.parse(
163 "akka://cluster-test@127.0.0.1:2559");
165 private static final String MODULE_SHARDS_CARS_ONLY_1_2 = "module-shards-cars-member-1-and-2.conf";
166 private static final String MODULE_SHARDS_CARS_PEOPLE_1_2 = "module-shards-member1-and-2.conf";
167 private static final String MODULE_SHARDS_CARS_PEOPLE_1_2_3 = "module-shards-member1-and-2-and-3.conf";
168 private static final String MODULE_SHARDS_CARS_1_2_3 = "module-shards-cars-member-1-and-2-and-3.conf";
170 private ActorSystem leaderSystem;
171 private ActorSystem followerSystem;
172 private ActorSystem follower2System;
174 private final DatastoreContext.Builder leaderDatastoreContextBuilder =
175 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(2);
177 private final DatastoreContext.Builder followerDatastoreContextBuilder =
178 DatastoreContext.newBuilder().shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5)
179 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName());
180 private final TransactionIdentifier tx1 = nextTransactionId();
181 private final TransactionIdentifier tx2 = nextTransactionId();
183 private AbstractDataStore followerDistributedDataStore;
184 private AbstractDataStore leaderDistributedDataStore;
185 private IntegrationTestKit followerTestKit;
186 private IntegrationTestKit leaderTestKit;
189 public void setUp() {
190 InMemoryJournal.clear();
191 InMemorySnapshotStore.clear();
193 leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
194 Cluster.get(leaderSystem).join(MEMBER_1_ADDRESS);
196 followerSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member2"));
197 Cluster.get(followerSystem).join(MEMBER_1_ADDRESS);
199 follower2System = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member3"));
200 Cluster.get(follower2System).join(MEMBER_1_ADDRESS);
204 public void tearDown() {
205 if (followerDistributedDataStore != null) {
206 leaderDistributedDataStore.close();
208 if (leaderDistributedDataStore != null) {
209 leaderDistributedDataStore.close();
212 TestKit.shutdownActorSystem(leaderSystem, true);
213 TestKit.shutdownActorSystem(followerSystem, true);
214 TestKit.shutdownActorSystem(follower2System,true);
216 InMemoryJournal.clear();
217 InMemorySnapshotStore.clear();
220 private void initDatastoresWithCars(final String type) throws Exception {
221 initDatastores(type, MODULE_SHARDS_CARS_ONLY_1_2, CARS);
224 private void initDatastoresWithCarsAndPeople(final String type) throws Exception {
225 initDatastores(type, MODULE_SHARDS_CARS_PEOPLE_1_2, CARS_AND_PEOPLE);
228 private void initDatastores(final String type, final String moduleShardsConfig, final String[] shards)
230 initDatastores(type, moduleShardsConfig, shards, leaderDatastoreContextBuilder,
231 followerDatastoreContextBuilder);
234 private void initDatastores(final String type, final String moduleShardsConfig, final String[] shards,
235 final DatastoreContext.Builder leaderBuilder, final DatastoreContext.Builder followerBuilder)
237 leaderTestKit = new IntegrationTestKit(leaderSystem, leaderBuilder, commitTimeout);
239 leaderDistributedDataStore = leaderTestKit.setupAbstractDataStore(
240 testParameter, type, moduleShardsConfig, false, shards);
242 followerTestKit = new IntegrationTestKit(followerSystem, followerBuilder, commitTimeout);
243 followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
244 testParameter, type, moduleShardsConfig, false, shards);
246 leaderTestKit.waitUntilLeader(leaderDistributedDataStore.getActorUtils(), shards);
248 leaderTestKit.waitForMembersUp("member-2");
249 followerTestKit.waitForMembersUp("member-1");
252 private static void verifyCars(final DOMStoreReadTransaction readTx, final MapEntryNode... entries)
254 final Optional<NormalizedNode> optional = readTx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS);
255 assertTrue("isPresent", optional.isPresent());
257 final CollectionNodeBuilder<MapEntryNode, SystemMapNode> listBuilder = ImmutableNodes.mapNodeBuilder(
258 CarsModel.CAR_QNAME);
259 for (final NormalizedNode entry: entries) {
260 listBuilder.withChild((MapEntryNode) entry);
263 assertEquals("Car list node", listBuilder.build(), optional.get());
266 private static void verifyNode(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path,
267 final NormalizedNode expNode) throws Exception {
268 assertEquals(Optional.of(expNode), readTx.read(path).get(5, TimeUnit.SECONDS));
271 private static void verifyExists(final DOMStoreReadTransaction readTx, final YangInstanceIdentifier path)
273 assertEquals("exists", Boolean.TRUE, readTx.exists(path).get(5, TimeUnit.SECONDS));
277 public void testWriteTransactionWithSingleShard() throws Exception {
278 final String testName = "testWriteTransactionWithSingleShard";
279 initDatastoresWithCars(testName);
281 final String followerCarShardName = "member-2-shard-cars-" + testName;
283 DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
284 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
286 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
287 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
289 final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
290 final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
291 writeTx.merge(car1Path, car1);
293 final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
294 final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
295 writeTx.merge(car2Path, car2);
297 followerTestKit.doCommit(writeTx.ready());
299 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
301 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
305 writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
307 writeTx.delete(car1Path);
309 followerTestKit.doCommit(writeTx.ready());
311 verifyExists(followerDistributedDataStore.newReadOnlyTransaction(), car2Path);
313 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
315 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car2);
317 // Re-instate the follower member 2 as a single-node to verify replication and recovery.
319 // The following is a bit tricky. Before we reinstate the follower we need to ensure it has persisted and
320 // applied and all the log entries from the leader. Since we've verified the car data above we know that
321 // all the transactions have been applied on the leader so we first read and capture its lastAppliedIndex.
322 final AtomicLong leaderLastAppliedIndex = new AtomicLong();
323 IntegrationTestKit.verifyShardState(leaderDistributedDataStore, CARS[0],
324 state -> leaderLastAppliedIndex.set(state.getLastApplied()));
326 // Now we need to make sure the follower has persisted the leader's lastAppliedIndex via ApplyJournalEntries.
327 // However we don't know exactly how many ApplyJournalEntries messages there will be as it can differ between
328 // the tell-based and ask-based front-ends. For ask-based there will be exactly 2 ApplyJournalEntries but
329 // tell-based persists additional payloads which could be replicated and applied in a batch resulting in
330 // either 2 or 3 ApplyJournalEntries. To handle this we read the follower's persisted ApplyJournalEntries
331 // until we find the one that encompasses the leader's lastAppliedIndex.
332 Stopwatch sw = Stopwatch.createStarted();
333 boolean done = false;
335 final List<ApplyJournalEntries> entries = InMemoryJournal.get(followerCarShardName,
336 ApplyJournalEntries.class);
337 for (ApplyJournalEntries aje: entries) {
338 if (aje.getToIndex() >= leaderLastAppliedIndex.get()) {
344 assertTrue("Follower did not persist ApplyJournalEntries containing leader's lastAppliedIndex "
345 + leaderLastAppliedIndex + ". Entries persisted: " + entries, sw.elapsed(TimeUnit.SECONDS) <= 5);
347 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
350 TestKit.shutdownActorSystem(leaderSystem, true);
351 TestKit.shutdownActorSystem(followerSystem, true);
353 final ActorSystem newSystem = newActorSystem("reinstated-member2", "Member2");
355 try (AbstractDataStore member2Datastore = new IntegrationTestKit(newSystem, leaderDatastoreContextBuilder,
357 .setupAbstractDataStore(testParameter, testName, "module-shards-member2", true, CARS)) {
358 verifyCars(member2Datastore.newReadOnlyTransaction(), car2);
363 public void testSingleTransactionsWritesInQuickSuccession() throws Exception {
364 initDatastoresWithCars("testSingleTransactionsWritesInQuickSuccession");
366 final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
368 DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
369 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
370 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
371 followerTestKit.doCommit(writeTx.ready());
374 for (int i = 0; i < numCars; i++) {
375 writeTx = txChain.newWriteOnlyTransaction();
376 writeTx.write(CarsModel.newCarPath("car" + i), CarsModel.newCarEntry("car" + i, Uint64.valueOf(20000)));
377 followerTestKit.doCommit(writeTx.ready());
379 try (var tx = txChain.newReadOnlyTransaction()) {
380 tx.read(CarsModel.BASE_PATH).get();
384 // wait to let the shard catch up with purged
385 await("Range set leak test").atMost(5, TimeUnit.SECONDS)
386 .pollInterval(500, TimeUnit.MILLISECONDS)
387 .untilAsserted(() -> {
388 final var localShard = leaderDistributedDataStore.getActorUtils().findLocalShard("cars")
390 final var frontendMetadata =
391 (FrontendShardDataTreeSnapshotMetadata) leaderDistributedDataStore.getActorUtils()
392 .executeOperation(localShard, new RequestFrontendMetadata());
394 final var clientMeta = frontendMetadata.getClients().get(0);
395 if (leaderDistributedDataStore.getActorUtils().getDatastoreContext().isUseTellBasedProtocol()) {
396 assertTellClientMetadata(clientMeta, numCars * 2);
398 assertAskClientMetadata(clientMeta);
402 try (var tx = txChain.newReadOnlyTransaction()) {
403 final var body = tx.read(CarsModel.CAR_LIST_PATH).get(5, TimeUnit.SECONDS).orElseThrow().body();
404 assertThat(body, instanceOf(Collection.class));
405 assertEquals(numCars, ((Collection<?>) body).size());
409 private static void assertAskClientMetadata(final FrontendClientMetadata clientMeta) {
410 // ask based should track no metadata
411 assertEquals(List.of(), clientMeta.getCurrentHistories());
414 private static void assertTellClientMetadata(final FrontendClientMetadata clientMeta, final long lastPurged) {
415 final var iterator = clientMeta.getCurrentHistories().iterator();
416 var metadata = iterator.next();
417 while (iterator.hasNext() && metadata.getHistoryId() != 1) {
418 metadata = iterator.next();
421 assertEquals(UnsignedLongBitmap.of(), metadata.getClosedTransactions());
422 assertEquals("[[0.." + lastPurged + "]]", metadata.getPurgedTransactions().ranges().toString());
426 public void testCloseTransactionMetadataLeak() throws Exception {
427 // FIXME: CONTROLLER-2016: ask-based frontend triggers this:
429 // java.lang.IllegalStateException: Previous transaction
430 // member-2-datastore-testCloseTransactionMetadataLeak-fe-0-chn-1-txn-1-0 is not ready yet
431 // at org.opendaylight.controller.cluster.datastore.TransactionChainProxy$Allocated.checkReady()
432 // at org.opendaylight.controller.cluster.datastore.TransactionChainProxy.newReadOnlyTransaction()
433 assumeTrue(testParameter.isAssignableFrom(ClientBackedDataStore.class));
435 initDatastoresWithCars("testCloseTransactionMetadataLeak");
437 final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
439 DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
440 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
441 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
442 followerTestKit.doCommit(writeTx.ready());
445 for (int i = 0; i < numCars; i++) {
446 try (var tx = txChain.newWriteOnlyTransaction()) {
450 try (var tx = txChain.newReadOnlyTransaction()) {
451 tx.read(CarsModel.BASE_PATH).get();
455 // wait to let the shard catch up with purged
456 await("wait for purges to settle").atMost(5, TimeUnit.SECONDS)
457 .pollInterval(500, TimeUnit.MILLISECONDS)
458 .untilAsserted(() -> {
459 final var localShard = leaderDistributedDataStore.getActorUtils().findLocalShard("cars")
461 final var frontendMetadata =
462 (FrontendShardDataTreeSnapshotMetadata) leaderDistributedDataStore.getActorUtils()
463 .executeOperation(localShard, new RequestFrontendMetadata());
465 final var clientMeta = frontendMetadata.getClients().get(0);
466 if (leaderDistributedDataStore.getActorUtils().getDatastoreContext().isUseTellBasedProtocol()) {
467 assertTellClientMetadata(clientMeta, numCars * 2);
469 assertAskClientMetadata(clientMeta);
475 public void testReadWriteTransactionWithSingleShard() throws Exception {
476 initDatastoresWithCars("testReadWriteTransactionWithSingleShard");
478 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
479 assertNotNull("newReadWriteTransaction returned null", rwTx);
481 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
482 rwTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
484 final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
485 rwTx.merge(CarsModel.newCarPath("optima"), car1);
487 verifyCars(rwTx, car1);
489 final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
490 final YangInstanceIdentifier car2Path = CarsModel.newCarPath("sportage");
491 rwTx.merge(car2Path, car2);
493 verifyExists(rwTx, car2Path);
495 followerTestKit.doCommit(rwTx.ready());
497 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1, car2);
501 public void testWriteTransactionWithMultipleShards() throws Exception {
502 initDatastoresWithCarsAndPeople("testWriteTransactionWithMultipleShards");
504 final DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
505 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
507 final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
508 final NormalizedNode carsNode = CarsModel.emptyContainer();
509 writeTx.write(carsPath, carsNode);
511 final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
512 final NormalizedNode peopleNode = PeopleModel.emptyContainer();
513 writeTx.write(peoplePath, peopleNode);
515 followerTestKit.doCommit(writeTx.ready());
517 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
519 verifyNode(readTx, carsPath, carsNode);
520 verifyNode(readTx, peoplePath, peopleNode);
524 public void testReadWriteTransactionWithMultipleShards() throws Exception {
525 initDatastoresWithCarsAndPeople("testReadWriteTransactionWithMultipleShards");
527 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
528 assertNotNull("newReadWriteTransaction returned null", rwTx);
530 final YangInstanceIdentifier carsPath = CarsModel.BASE_PATH;
531 final NormalizedNode carsNode = CarsModel.emptyContainer();
532 rwTx.write(carsPath, carsNode);
534 final YangInstanceIdentifier peoplePath = PeopleModel.BASE_PATH;
535 final NormalizedNode peopleNode = PeopleModel.emptyContainer();
536 rwTx.write(peoplePath, peopleNode);
538 followerTestKit.doCommit(rwTx.ready());
540 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
542 verifyNode(readTx, carsPath, carsNode);
543 verifyNode(readTx, peoplePath, peopleNode);
547 public void testTransactionChainWithSingleShard() throws Exception {
548 initDatastoresWithCars("testTransactionChainWithSingleShard");
550 final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
552 // Add the top-level cars container with write-only.
554 final DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
555 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
557 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
559 final DOMStoreThreePhaseCommitCohort writeTxReady = writeTx.ready();
561 // Verify the top-level cars container with read-only.
563 verifyNode(txChain.newReadOnlyTransaction(), CarsModel.BASE_PATH, CarsModel.emptyContainer());
565 // Perform car operations with read-write.
567 final DOMStoreReadWriteTransaction rwTx = txChain.newReadWriteTransaction();
569 verifyNode(rwTx, CarsModel.BASE_PATH, CarsModel.emptyContainer());
571 rwTx.merge(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
573 final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
574 final YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
575 rwTx.write(car1Path, car1);
577 verifyExists(rwTx, car1Path);
579 verifyCars(rwTx, car1);
581 final MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(25000));
582 rwTx.merge(CarsModel.newCarPath("sportage"), car2);
584 rwTx.delete(car1Path);
586 followerTestKit.doCommit(writeTxReady);
588 followerTestKit.doCommit(rwTx.ready());
592 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car2);
596 public void testTransactionChainWithMultipleShards() throws Exception {
597 initDatastoresWithCarsAndPeople("testTransactionChainWithMultipleShards");
599 final DOMStoreTransactionChain txChain = followerDistributedDataStore.createTransactionChain();
601 DOMStoreWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
602 assertNotNull("newWriteOnlyTransaction returned null", writeTx);
604 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
605 writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
607 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
608 writeTx.write(PeopleModel.PERSON_LIST_PATH, PeopleModel.newPersonMapNode());
610 followerTestKit.doCommit(writeTx.ready());
612 final DOMStoreReadWriteTransaction readWriteTx = txChain.newReadWriteTransaction();
614 final MapEntryNode car = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
615 final YangInstanceIdentifier carPath = CarsModel.newCarPath("optima");
616 readWriteTx.write(carPath, car);
618 final MapEntryNode person = PeopleModel.newPersonEntry("jack");
619 final YangInstanceIdentifier personPath = PeopleModel.newPersonPath("jack");
620 readWriteTx.merge(personPath, person);
622 assertEquals(Optional.of(car), readWriteTx.read(carPath).get(5, TimeUnit.SECONDS));
623 assertEquals(Optional.of(person), readWriteTx.read(personPath).get(5, TimeUnit.SECONDS));
625 final DOMStoreThreePhaseCommitCohort cohort2 = readWriteTx.ready();
627 writeTx = txChain.newWriteOnlyTransaction();
629 writeTx.delete(personPath);
631 final DOMStoreThreePhaseCommitCohort cohort3 = writeTx.ready();
633 followerTestKit.doCommit(cohort2);
634 followerTestKit.doCommit(cohort3);
638 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
639 verifyCars(readTx, car);
641 assertEquals(Optional.empty(), readTx.read(personPath).get(5, TimeUnit.SECONDS));
645 public void testChainedTransactionFailureWithSingleShard() throws Exception {
646 initDatastoresWithCars("testChainedTransactionFailureWithSingleShard");
648 final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
649 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
650 LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
651 MoreExecutors.directExecutor());
653 final DOMTransactionChainListener listener = mock(DOMTransactionChainListener.class);
654 final DOMTransactionChain txChain = broker.createTransactionChain(listener);
656 final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
658 writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, Builders.containerBuilder()
659 .withNodeIdentifier(new NodeIdentifier(CarsModel.BASE_QNAME))
660 .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk"))
663 final var ex = assertThrows(ExecutionException.class, () -> writeTx.commit().get(5, TimeUnit.SECONDS))
665 assertThat(ex, instanceOf(TransactionCommitFailedException.class));
667 verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
674 public void testChainedTransactionFailureWithMultipleShards() throws Exception {
675 initDatastoresWithCarsAndPeople("testChainedTransactionFailureWithMultipleShards");
677 final ConcurrentDOMDataBroker broker = new ConcurrentDOMDataBroker(
678 ImmutableMap.<LogicalDatastoreType, DOMStore>builder().put(
679 LogicalDatastoreType.CONFIGURATION, followerDistributedDataStore).build(),
680 MoreExecutors.directExecutor());
682 final DOMTransactionChainListener listener = mock(DOMTransactionChainListener.class);
683 final DOMTransactionChain txChain = broker.createTransactionChain(listener);
685 final DOMDataTreeWriteTransaction writeTx = txChain.newWriteOnlyTransaction();
687 writeTx.put(LogicalDatastoreType.CONFIGURATION, PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
689 // Note that merge will validate the data and fail but put succeeds b/c deep validation is not
690 // done for put for performance reasons.
691 writeTx.merge(LogicalDatastoreType.CONFIGURATION, CarsModel.BASE_PATH, Builders.containerBuilder()
692 .withNodeIdentifier(new NodeIdentifier(CarsModel.BASE_QNAME))
693 .withChild(ImmutableNodes.leafNode(TestModel.JUNK_QNAME, "junk"))
696 final var ex = assertThrows(ExecutionException.class, () -> writeTx.commit().get(5, TimeUnit.SECONDS))
698 assertThat(ex, instanceOf(TransactionCommitFailedException.class));
700 verify(listener, timeout(5000)).onTransactionChainFailed(eq(txChain), eq(writeTx), any(Throwable.class));
707 public void testSingleShardTransactionsWithLeaderChanges() throws Exception {
708 followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
709 final String testName = "testSingleShardTransactionsWithLeaderChanges";
710 initDatastoresWithCars(testName);
712 final String followerCarShardName = "member-2-shard-cars-" + testName;
713 InMemoryJournal.addWriteMessagesCompleteLatch(followerCarShardName, 1, ApplyJournalEntries.class);
715 // Write top-level car container from the follower so it uses a remote Tx.
717 DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
719 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
720 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
722 followerTestKit.doCommit(writeTx.ready());
724 InMemoryJournal.waitForWriteMessagesComplete(followerCarShardName);
726 // Switch the leader to the follower
728 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
729 .shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
731 TestKit.shutdownActorSystem(leaderSystem, true);
732 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
734 followerTestKit.waitUntilNoLeader(followerDistributedDataStore.getActorUtils(), CARS);
736 leaderSystem = ActorSystem.create("cluster-test", ConfigFactory.load().getConfig("Member1"));
737 Cluster.get(leaderSystem).join(MEMBER_2_ADDRESS);
739 final DatastoreContext.Builder newMember1Builder = DatastoreContext.newBuilder()
740 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(5);
741 IntegrationTestKit newMember1TestKit = new IntegrationTestKit(leaderSystem, newMember1Builder, commitTimeout);
743 try (AbstractDataStore ds =
744 newMember1TestKit.setupAbstractDataStore(
745 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS)) {
747 followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), CARS);
749 // Write a car entry to the new leader - should switch to local Tx
751 writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
753 MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
754 YangInstanceIdentifier car1Path = CarsModel.newCarPath("optima");
755 writeTx.merge(car1Path, car1);
757 followerTestKit.doCommit(writeTx.ready());
759 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car1);
764 public void testReadyLocalTransactionForwardedToLeader() throws Exception {
765 initDatastoresWithCars("testReadyLocalTransactionForwardedToLeader");
766 followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), "cars");
768 final Optional<ActorRef> carsFollowerShard =
769 followerDistributedDataStore.getActorUtils().findLocalShard("cars");
770 assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
772 final DataTree dataTree = new InMemoryDataTreeFactory().create(
773 DataTreeConfiguration.DEFAULT_OPERATIONAL, SchemaContextHelper.full());
775 // Send a tx with immediate commit.
777 DataTreeModification modification = dataTree.takeSnapshot().newModification();
778 new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
779 new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
781 final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
782 new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
783 modification.ready();
785 ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(tx1 , modification, true, Optional.empty());
787 carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
788 Object resp = followerTestKit.expectMsgClass(Object.class);
789 if (resp instanceof akka.actor.Status.Failure) {
790 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
793 assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
795 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
797 // Send another tx without immediate commit.
799 modification = dataTree.takeSnapshot().newModification();
800 MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(30000));
801 new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
802 modification.ready();
804 readyLocal = new ReadyLocalTransaction(tx2 , modification, false, Optional.empty());
806 carsFollowerShard.get().tell(readyLocal, followerTestKit.getRef());
807 resp = followerTestKit.expectMsgClass(Object.class);
808 if (resp instanceof akka.actor.Status.Failure) {
809 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
812 assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
814 final ActorSelection txActor = leaderDistributedDataStore.getActorUtils().actorSelection(
815 ((ReadyTransactionReply)resp).getCohortPath());
817 ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(leaderDistributedDataStore.getActorUtils(),
818 List.of(new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor),
819 () -> DataStoreVersions.CURRENT_VERSION)), tx2);
820 cohort.canCommit().get(5, TimeUnit.SECONDS);
821 cohort.preCommit().get(5, TimeUnit.SECONDS);
822 cohort.commit().get(5, TimeUnit.SECONDS);
824 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
828 public void testForwardedReadyTransactionForwardedToLeader() throws Exception {
829 initDatastoresWithCars("testForwardedReadyTransactionForwardedToLeader");
830 followerTestKit.waitUntilLeader(followerDistributedDataStore.getActorUtils(), "cars");
832 final Optional<ActorRef> carsFollowerShard =
833 followerDistributedDataStore.getActorUtils().findLocalShard("cars");
834 assertTrue("Cars follower shard found", carsFollowerShard.isPresent());
836 carsFollowerShard.get().tell(GetShardDataTree.INSTANCE, followerTestKit.getRef());
837 final DataTree dataTree = followerTestKit.expectMsgClass(DataTree.class);
839 // Send a tx with immediate commit.
841 DataTreeModification modification = dataTree.takeSnapshot().newModification();
842 new WriteModification(CarsModel.BASE_PATH, CarsModel.emptyContainer()).apply(modification);
843 new MergeModification(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode()).apply(modification);
845 final MapEntryNode car1 = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
846 new WriteModification(CarsModel.newCarPath("optima"), car1).apply(modification);
848 ForwardedReadyTransaction forwardedReady = new ForwardedReadyTransaction(tx1, DataStoreVersions.CURRENT_VERSION,
849 new ReadWriteShardDataTreeTransaction(mock(ShardDataTreeTransactionParent.class), tx1, modification),
850 true, Optional.empty());
852 carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
853 Object resp = followerTestKit.expectMsgClass(Object.class);
854 if (resp instanceof akka.actor.Status.Failure) {
855 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
858 assertEquals("Response type", CommitTransactionReply.class, resp.getClass());
860 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1);
862 // Send another tx without immediate commit.
864 modification = dataTree.takeSnapshot().newModification();
865 MapEntryNode car2 = CarsModel.newCarEntry("sportage", Uint64.valueOf(30000));
866 new WriteModification(CarsModel.newCarPath("sportage"), car2).apply(modification);
868 forwardedReady = new ForwardedReadyTransaction(tx2, DataStoreVersions.CURRENT_VERSION,
869 new ReadWriteShardDataTreeTransaction(mock(ShardDataTreeTransactionParent.class), tx2, modification),
870 false, Optional.empty());
872 carsFollowerShard.get().tell(forwardedReady, followerTestKit.getRef());
873 resp = followerTestKit.expectMsgClass(Object.class);
874 if (resp instanceof akka.actor.Status.Failure) {
875 throw new AssertionError("Unexpected failure response", ((akka.actor.Status.Failure)resp).cause());
878 assertEquals("Response type", ReadyTransactionReply.class, resp.getClass());
880 ActorSelection txActor = leaderDistributedDataStore.getActorUtils().actorSelection(
881 ((ReadyTransactionReply)resp).getCohortPath());
883 final ThreePhaseCommitCohortProxy cohort = new ThreePhaseCommitCohortProxy(
884 leaderDistributedDataStore.getActorUtils(), List.of(
885 new ThreePhaseCommitCohortProxy.CohortInfo(Futures.successful(txActor),
886 () -> DataStoreVersions.CURRENT_VERSION)), tx2);
887 cohort.canCommit().get(5, TimeUnit.SECONDS);
888 cohort.preCommit().get(5, TimeUnit.SECONDS);
889 cohort.commit().get(5, TimeUnit.SECONDS);
891 verifyCars(leaderDistributedDataStore.newReadOnlyTransaction(), car1, car2);
895 public void testTransactionForwardedToLeaderAfterRetry() throws Exception {
896 followerDatastoreContextBuilder.shardBatchedModificationCount(2);
897 leaderDatastoreContextBuilder.shardBatchedModificationCount(2);
898 initDatastoresWithCarsAndPeople("testTransactionForwardedToLeaderAfterRetry");
900 // Verify backend statistics on start
901 verifyCarsReadWriteTransactions(leaderDistributedDataStore, 0);
902 verifyCarsReadWriteTransactions(followerDistributedDataStore, 0);
904 // Do an initial write to get the primary shard info cached.
906 final DOMStoreWriteTransaction initialWriteTx = followerDistributedDataStore.newWriteOnlyTransaction();
907 initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
908 initialWriteTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
909 followerTestKit.doCommit(initialWriteTx.ready());
911 // Wait for the commit to be replicated to the follower.
913 MemberNode.verifyRaftState(followerDistributedDataStore, "cars",
914 raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
916 MemberNode.verifyRaftState(followerDistributedDataStore, "people",
917 raftState -> assertEquals("getLastApplied", 1, raftState.getLastApplied()));
919 // Prepare, ready and canCommit a WO tx that writes to 2 shards. This will become the current tx in
922 final DOMStoreWriteTransaction writeTx1 = followerDistributedDataStore.newWriteOnlyTransaction();
923 writeTx1.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
924 writeTx1.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
925 final DOMStoreThreePhaseCommitCohort writeTx1Cohort = writeTx1.ready();
926 final ListenableFuture<Boolean> writeTx1CanCommit = writeTx1Cohort.canCommit();
927 writeTx1CanCommit.get(5, TimeUnit.SECONDS);
929 // Prepare and ready another WO tx that writes to 2 shards but don't canCommit yet. This will be queued
930 // in the leader shard.
932 final DOMStoreWriteTransaction writeTx2 = followerDistributedDataStore.newWriteOnlyTransaction();
933 final LinkedList<MapEntryNode> cars = new LinkedList<>();
935 cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
936 writeTx2.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
938 NormalizedNode people = ImmutableNodes.mapNodeBuilder(PeopleModel.PERSON_QNAME)
939 .withChild(PeopleModel.newPersonEntry("Dude")).build();
940 writeTx2.write(PeopleModel.PERSON_LIST_PATH, people);
941 final DOMStoreThreePhaseCommitCohort writeTx2Cohort = writeTx2.ready();
943 // At this point only leader should see the transactions
944 verifyCarsReadWriteTransactions(leaderDistributedDataStore, 2);
945 verifyCarsReadWriteTransactions(followerDistributedDataStore, 0);
947 // Prepare another WO that writes to a single shard and thus will be directly committed on ready. This
948 // tx writes 5 cars so 2 BatchedModifications messages will be sent initially and cached in the leader shard
949 // (with shardBatchedModificationCount set to 2). The 3rd BatchedModifications will be sent on ready.
951 final DOMStoreWriteTransaction writeTx3 = followerDistributedDataStore.newWriteOnlyTransaction();
952 for (int i = 1; i <= 5; i++, carIndex++) {
953 cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
954 writeTx3.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
957 // Prepare another WO that writes to a single shard. This will send a single BatchedModifications message
960 final DOMStoreWriteTransaction writeTx4 = followerDistributedDataStore.newWriteOnlyTransaction();
961 cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
962 writeTx4.write(CarsModel.newCarPath("car" + carIndex), cars.getLast());
965 // Prepare a RW tx that will create a tx actor and send a ForwardedReadyTransaction message to the leader shard
968 final DOMStoreReadWriteTransaction readWriteTx = followerDistributedDataStore.newReadWriteTransaction();
969 cars.add(CarsModel.newCarEntry("car" + carIndex, Uint64.valueOf(carIndex)));
970 final YangInstanceIdentifier carPath = CarsModel.newCarPath("car" + carIndex);
971 readWriteTx.write(carPath, cars.getLast());
973 // There is a difference here between implementations: tell-based protocol enforces batching on per-transaction
974 // level whereas ask-based protocol has a global limit towards a shard -- and hence flushes out last two
975 // transactions eagerly.
976 final int earlyTxCount = DistributedDataStore.class.isAssignableFrom(testParameter) ? 5 : 3;
977 verifyCarsReadWriteTransactions(leaderDistributedDataStore, earlyTxCount);
978 verifyCarsReadWriteTransactions(followerDistributedDataStore, 0);
980 // Disable elections on the leader so it switches to follower.
982 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
983 .customRaftPolicyImplementation(DisableElectionsRaftPolicy.class.getName())
984 .shardElectionTimeoutFactor(10));
986 leaderTestKit.waitUntilNoLeader(leaderDistributedDataStore.getActorUtils(), "cars");
988 // Submit all tx's - the messages should get queued for retry.
990 final ListenableFuture<Boolean> writeTx2CanCommit = writeTx2Cohort.canCommit();
991 final DOMStoreThreePhaseCommitCohort writeTx3Cohort = writeTx3.ready();
992 final DOMStoreThreePhaseCommitCohort writeTx4Cohort = writeTx4.ready();
993 final DOMStoreThreePhaseCommitCohort rwTxCohort = readWriteTx.ready();
995 // Enable elections on the other follower so it becomes the leader, at which point the
996 // tx's should get forwarded from the previous leader to the new leader to complete the commits.
998 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
999 .customRaftPolicyImplementation(null).shardElectionTimeoutFactor(1));
1000 IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorUtils(), "cars")
1001 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
1002 IntegrationTestKit.findLocalShard(followerDistributedDataStore.getActorUtils(), "people")
1003 .tell(TimeoutNow.INSTANCE, ActorRef.noSender());
1005 followerTestKit.doCommit(writeTx1CanCommit, writeTx1Cohort);
1006 followerTestKit.doCommit(writeTx2CanCommit, writeTx2Cohort);
1007 followerTestKit.doCommit(writeTx3Cohort);
1008 followerTestKit.doCommit(writeTx4Cohort);
1009 followerTestKit.doCommit(rwTxCohort);
1011 // At this point everything is committed and the follower datastore should see 5 transactions, but leader should
1012 // only see the initial transactions
1013 verifyCarsReadWriteTransactions(leaderDistributedDataStore, earlyTxCount);
1014 verifyCarsReadWriteTransactions(followerDistributedDataStore, 5);
1016 DOMStoreReadTransaction readTx = leaderDistributedDataStore.newReadOnlyTransaction();
1017 verifyCars(readTx, cars.toArray(new MapEntryNode[cars.size()]));
1018 verifyNode(readTx, PeopleModel.PERSON_LIST_PATH, people);
1021 private static void verifyCarsReadWriteTransactions(final AbstractDataStore datastore, final int expected)
1023 IntegrationTestKit.verifyShardStats(datastore, "cars",
1024 stats -> assertEquals("getReadWriteTransactionCount", expected, stats.getReadWriteTransactionCount()));
1028 public void testLeadershipTransferOnShutdown() throws Exception {
1029 leaderDatastoreContextBuilder.shardBatchedModificationCount(1);
1030 followerDatastoreContextBuilder.shardElectionTimeoutFactor(10).customRaftPolicyImplementation(null);
1031 final String testName = "testLeadershipTransferOnShutdown";
1032 initDatastores(testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, CARS_AND_PEOPLE);
1034 final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
1035 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(500),
1037 try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
1038 testParameter, testName, MODULE_SHARDS_CARS_PEOPLE_1_2_3, false)) {
1040 followerTestKit.waitForMembersUp("member-3");
1041 follower2TestKit.waitForMembersUp("member-1", "member-2");
1043 // Create and submit a couple tx's so they're pending.
1045 DOMStoreWriteTransaction writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
1046 writeTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1047 writeTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
1048 writeTx.write(PeopleModel.BASE_PATH, PeopleModel.emptyContainer());
1049 final DOMStoreThreePhaseCommitCohort cohort1 = writeTx.ready();
1051 final var usesCohorts = DistributedDataStore.class.isAssignableFrom(testParameter);
1053 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
1054 stats -> assertEquals("getTxCohortCacheSize", 1, stats.getTxCohortCacheSize()));
1057 writeTx = followerDistributedDataStore.newWriteOnlyTransaction();
1058 final MapEntryNode car = CarsModel.newCarEntry("optima", Uint64.valueOf(20000));
1059 writeTx.write(CarsModel.newCarPath("optima"), car);
1060 final DOMStoreThreePhaseCommitCohort cohort2 = writeTx.ready();
1063 IntegrationTestKit.verifyShardStats(leaderDistributedDataStore, "cars",
1064 stats -> assertEquals("getTxCohortCacheSize", 2, stats.getTxCohortCacheSize()));
1067 // Gracefully stop the leader via a Shutdown message.
1069 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1070 .shardElectionTimeoutFactor(100));
1072 final FiniteDuration duration = FiniteDuration.create(5, TimeUnit.SECONDS);
1073 final Future<ActorRef> future = leaderDistributedDataStore.getActorUtils().findLocalShardAsync("cars");
1074 final ActorRef leaderActor = Await.result(future, duration);
1076 final Future<Boolean> stopFuture = Patterns.gracefulStop(leaderActor, duration, Shutdown.INSTANCE);
1078 // Commit the 2 transactions. They should finish and succeed.
1080 followerTestKit.doCommit(cohort1);
1081 followerTestKit.doCommit(cohort2);
1083 // Wait for the leader actor stopped.
1085 final Boolean stopped = Await.result(stopFuture, duration);
1086 assertEquals("Stopped", Boolean.TRUE, stopped);
1088 // Verify leadership was transferred by reading the committed data from the other nodes.
1090 verifyCars(followerDistributedDataStore.newReadOnlyTransaction(), car);
1091 verifyCars(follower2DistributedDataStore.newReadOnlyTransaction(), car);
1096 public void testTransactionWithIsolatedLeader() throws Exception {
1097 // Set the isolated leader check interval high so we can control the switch to IsolatedLeader.
1098 leaderDatastoreContextBuilder.shardIsolatedLeaderCheckIntervalInMillis(10000000);
1099 final String testName = "testTransactionWithIsolatedLeader";
1100 initDatastoresWithCars(testName);
1102 // Tx that is submitted after the follower is stopped but before the leader transitions to IsolatedLeader.
1103 final DOMStoreWriteTransaction preIsolatedLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1104 preIsolatedLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1106 // Tx that is submitted after the leader transitions to IsolatedLeader.
1107 final DOMStoreWriteTransaction noShardLeaderWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1108 noShardLeaderWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1110 // Tx that is submitted after the follower is reinstated.
1111 final DOMStoreWriteTransaction successWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1112 successWriteTx.merge(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1114 // Stop the follower
1115 followerTestKit.watch(followerDistributedDataStore.getActorUtils().getShardManager());
1116 followerDistributedDataStore.close();
1117 followerTestKit.expectTerminated(followerDistributedDataStore.getActorUtils().getShardManager());
1119 // Submit the preIsolatedLeaderWriteTx so it's pending
1120 final DOMStoreThreePhaseCommitCohort preIsolatedLeaderTxCohort = preIsolatedLeaderWriteTx.ready();
1122 // Change the isolated leader check interval low so it changes to IsolatedLeader.
1123 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1124 .shardIsolatedLeaderCheckIntervalInMillis(200));
1126 MemberNode.verifyRaftState(leaderDistributedDataStore, "cars",
1127 raftState -> assertEquals("getRaftState", "IsolatedLeader", raftState.getRaftState()));
1129 final var noShardLeaderCohort = noShardLeaderWriteTx.ready();
1130 final ListenableFuture<Boolean> canCommit;
1132 // There is difference in behavior here:
1133 if (!leaderDistributedDataStore.getActorUtils().getDatastoreContext().isUseTellBasedProtocol()) {
1134 // ask-based canCommit() times out and aborts
1135 final var ex = assertThrows(ExecutionException.class,
1136 () -> leaderTestKit.doCommit(noShardLeaderCohort)).getCause();
1137 assertThat(ex, instanceOf(NoShardLeaderException.class));
1138 assertThat(ex.getMessage(), containsString(
1139 "Shard member-1-shard-cars-testTransactionWithIsolatedLeader currently has no leader."));
1142 // tell-based canCommit() does not have a real timeout and hence continues
1143 canCommit = noShardLeaderCohort.canCommit();
1144 Uninterruptibles.sleepUninterruptibly(commitTimeout, TimeUnit.SECONDS);
1145 assertFalse(canCommit.isDone());
1148 sendDatastoreContextUpdate(leaderDistributedDataStore, leaderDatastoreContextBuilder
1149 .shardElectionTimeoutFactor(100));
1151 final DOMStoreThreePhaseCommitCohort successTxCohort = successWriteTx.ready();
1153 followerDistributedDataStore = followerTestKit.setupAbstractDataStore(
1154 testParameter, testName, MODULE_SHARDS_CARS_ONLY_1_2, false, CARS);
1156 leaderTestKit.doCommit(preIsolatedLeaderTxCohort);
1157 leaderTestKit.doCommit(successTxCohort);
1159 // continuation of tell-based protocol: readied transaction will complete commit, but will report an OLFE
1160 if (canCommit != null) {
1161 final var ex = assertThrows(ExecutionException.class,
1162 () -> canCommit.get(commitTimeout, TimeUnit.SECONDS)).getCause();
1163 assertThat(ex, instanceOf(OptimisticLockFailedException.class));
1164 assertEquals("Optimistic lock failed for path " + CarsModel.BASE_PATH, ex.getMessage());
1165 final var cause = ex.getCause();
1166 assertThat(cause, instanceOf(ConflictingModificationAppliedException.class));
1167 final var cmae = (ConflictingModificationAppliedException) cause;
1168 assertEquals("Node was created by other transaction.", cmae.getMessage());
1169 assertEquals(CarsModel.BASE_PATH, cmae.getPath());
1174 public void testTransactionWithShardLeaderNotResponding() throws Exception {
1175 followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1176 followerDatastoreContextBuilder.shardElectionTimeoutFactor(50);
1177 initDatastoresWithCars("testTransactionWithShardLeaderNotResponding");
1179 // Do an initial read to get the primary shard info cached.
1181 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1182 readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1184 // Shutdown the leader and try to create a new tx.
1186 TestKit.shutdownActorSystem(leaderSystem, true);
1188 followerDatastoreContextBuilder.operationTimeoutInMillis(50).shardElectionTimeoutFactor(1);
1189 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder);
1191 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1193 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1195 final var ex = assertThrows(ExecutionException.class, () -> followerTestKit.doCommit(rwTx.ready()));
1196 final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(ex.getCause());
1197 if (DistributedDataStore.class.isAssignableFrom(testParameter)) {
1198 assertTrue(msg, Throwables.getRootCause(ex) instanceof NoShardLeaderException
1199 || ex.getCause() instanceof ShardLeaderNotRespondingException);
1201 assertThat(msg, Throwables.getRootCause(ex), instanceOf(RequestTimeoutException.class));
1206 public void testTransactionWithCreateTxFailureDueToNoLeader() throws Exception {
1207 followerDatastoreContextBuilder.frontendRequestTimeoutInSeconds(2);
1208 initDatastoresWithCars("testTransactionWithCreateTxFailureDueToNoLeader");
1210 // Do an initial read to get the primary shard info cached.
1212 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1213 readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1215 // Shutdown the leader and try to create a new tx.
1217 TestKit.shutdownActorSystem(leaderSystem, true);
1219 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1221 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
1223 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1224 .operationTimeoutInMillis(10).shardElectionTimeoutFactor(1).customRaftPolicyImplementation(null));
1226 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1228 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1230 final var ex = assertThrows(ExecutionException.class, () -> followerTestKit.doCommit(rwTx.ready()));
1231 final String msg = "Unexpected exception: " + Throwables.getStackTraceAsString(ex.getCause());
1232 if (DistributedDataStore.class.isAssignableFrom(testParameter)) {
1233 assertThat(msg, Throwables.getRootCause(ex), instanceOf(NoShardLeaderException.class));
1235 assertThat(msg, Throwables.getRootCause(ex), instanceOf(RequestTimeoutException.class));
1240 public void testTransactionRetryWithInitialAskTimeoutExOnCreateTx() throws Exception {
1241 followerDatastoreContextBuilder.backendAlivenessTimerIntervalInSeconds(2);
1242 String testName = "testTransactionRetryWithInitialAskTimeoutExOnCreateTx";
1243 initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1245 final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1246 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1247 final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1248 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1250 try (AbstractDataStore ds =
1251 follower2TestKit.setupAbstractDataStore(
1252 testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS)) {
1254 followerTestKit.waitForMembersUp("member-1", "member-3");
1255 follower2TestKit.waitForMembersUp("member-1", "member-2");
1257 // Do an initial read to get the primary shard info cached.
1259 final DOMStoreReadTransaction readTx = followerDistributedDataStore.newReadOnlyTransaction();
1260 readTx.read(CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS);
1262 // Shutdown the leader and try to create a new tx.
1264 TestKit.shutdownActorSystem(leaderSystem, true);
1266 Cluster.get(followerSystem).leave(MEMBER_1_ADDRESS);
1268 sendDatastoreContextUpdate(followerDistributedDataStore, followerDatastoreContextBuilder
1269 .operationTimeoutInMillis(500).shardElectionTimeoutFactor(5).customRaftPolicyImplementation(null));
1271 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1273 rwTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1275 followerTestKit.doCommit(rwTx.ready());
1280 public void testSemiReachableCandidateNotDroppingLeader() throws Exception {
1281 final String testName = "testSemiReachableCandidateNotDroppingLeader";
1282 initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1284 final DatastoreContext.Builder follower2DatastoreContextBuilder = DatastoreContext.newBuilder()
1285 .shardHeartbeatIntervalInMillis(100).shardElectionTimeoutFactor(10);
1286 final IntegrationTestKit follower2TestKit = new IntegrationTestKit(
1287 follower2System, follower2DatastoreContextBuilder, commitTimeout);
1289 final AbstractDataStore ds2 =
1290 follower2TestKit.setupAbstractDataStore(
1291 testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false, CARS);
1293 followerTestKit.waitForMembersUp("member-1", "member-3");
1294 follower2TestKit.waitForMembersUp("member-1", "member-2");
1296 // behavior is controlled by akka.coordinated-shutdown.run-by-actor-system-terminate configuration option
1297 TestKit.shutdownActorSystem(follower2System, true);
1299 ActorRef cars = leaderDistributedDataStore.getActorUtils().findLocalShard("cars").get();
1300 final OnDemandRaftState initialState = (OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1301 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1303 Cluster leaderCluster = Cluster.get(leaderSystem);
1304 Cluster followerCluster = Cluster.get(followerSystem);
1305 Cluster follower2Cluster = Cluster.get(follower2System);
1307 Member follower2Member = follower2Cluster.readView().self();
1309 await().atMost(10, TimeUnit.SECONDS)
1310 .until(() -> containsUnreachable(leaderCluster, follower2Member));
1311 await().atMost(10, TimeUnit.SECONDS)
1312 .until(() -> containsUnreachable(followerCluster, follower2Member));
1314 ActorRef followerCars = followerDistributedDataStore.getActorUtils().findLocalShard("cars").get();
1316 // to simulate a follower not being able to receive messages, but still being able to send messages and becoming
1317 // candidate, we can just send a couple of RequestVotes to both leader and follower.
1318 cars.tell(new RequestVote(initialState.getCurrentTerm() + 1, "member-3-shard-cars", -1, -1), null);
1319 followerCars.tell(new RequestVote(initialState.getCurrentTerm() + 1, "member-3-shard-cars", -1, -1), null);
1320 cars.tell(new RequestVote(initialState.getCurrentTerm() + 3, "member-3-shard-cars", -1, -1), null);
1321 followerCars.tell(new RequestVote(initialState.getCurrentTerm() + 3, "member-3-shard-cars", -1, -1), null);
1323 OnDemandRaftState stateAfter = (OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1324 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1325 OnDemandRaftState followerState = (OnDemandRaftState) followerDistributedDataStore.getActorUtils()
1326 .executeOperation(cars, GetOnDemandRaftState.INSTANCE);
1328 assertEquals(initialState.getCurrentTerm(), stateAfter.getCurrentTerm());
1329 assertEquals(initialState.getCurrentTerm(), followerState.getCurrentTerm());
1334 private static Boolean containsUnreachable(final Cluster cluster, final Member member) {
1335 // unreachableMembers() returns scala.collection.immutable.Set, but we are using scala.collection.Set to fix JDT
1336 // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=468276#c32
1337 final Set<Member> members = cluster.readView().unreachableMembers();
1338 return members.contains(member);
1342 public void testInstallSnapshot() throws Exception {
1343 final String testName = "testInstallSnapshot";
1344 final String leaderCarShardName = "member-1-shard-cars-" + testName;
1345 final String followerCarShardName = "member-2-shard-cars-" + testName;
1347 // Setup a saved snapshot on the leader. The follower will startup with no data and the leader should
1348 // install a snapshot to sync the follower.
1350 DataTree tree = new InMemoryDataTreeFactory().create(DataTreeConfiguration.DEFAULT_CONFIGURATION,
1351 SchemaContextHelper.full());
1353 final ContainerNode carsNode = CarsModel.newCarsNode(
1354 CarsModel.newCarsMapNode(CarsModel.newCarEntry("optima", Uint64.valueOf(20000))));
1355 AbstractShardTest.writeToStore(tree, CarsModel.BASE_PATH, carsNode);
1357 final NormalizedNode snapshotRoot = AbstractShardTest.readStore(tree, YangInstanceIdentifier.empty());
1358 final Snapshot initialSnapshot = Snapshot.create(
1359 new ShardSnapshotState(new MetadataShardDataTreeSnapshot(snapshotRoot)),
1360 Collections.emptyList(), 5, 1, 5, 1, 1, null, null);
1361 InMemorySnapshotStore.addSnapshot(leaderCarShardName, initialSnapshot);
1363 InMemorySnapshotStore.addSnapshotSavedLatch(leaderCarShardName);
1364 InMemorySnapshotStore.addSnapshotSavedLatch(followerCarShardName);
1366 initDatastoresWithCars(testName);
1368 assertEquals(Optional.of(carsNode), leaderDistributedDataStore.newReadOnlyTransaction().read(
1369 CarsModel.BASE_PATH).get(5, TimeUnit.SECONDS));
1371 verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(leaderCarShardName, Snapshot.class),
1372 initialSnapshot, snapshotRoot);
1374 verifySnapshot(InMemorySnapshotStore.waitForSavedSnapshot(followerCarShardName, Snapshot.class),
1375 initialSnapshot, snapshotRoot);
1379 public void testReadWriteMessageSlicing() throws Exception {
1380 // The slicing is only implemented for tell-based protocol
1381 assumeTrue(ClientBackedDataStore.class.isAssignableFrom(testParameter));
1383 leaderDatastoreContextBuilder.maximumMessageSliceSize(100);
1384 followerDatastoreContextBuilder.maximumMessageSliceSize(100);
1385 initDatastoresWithCars("testLargeReadReplySlicing");
1387 final DOMStoreReadWriteTransaction rwTx = followerDistributedDataStore.newReadWriteTransaction();
1389 final NormalizedNode carsNode = CarsModel.create();
1390 rwTx.write(CarsModel.BASE_PATH, carsNode);
1392 verifyNode(rwTx, CarsModel.BASE_PATH, carsNode);
1395 @SuppressWarnings("IllegalCatch")
1397 public void testRaftCallbackDuringLeadershipDrop() throws Exception {
1398 final String testName = "testRaftCallbackDuringLeadershipDrop";
1399 initDatastores(testName, MODULE_SHARDS_CARS_1_2_3, CARS);
1401 final ExecutorService executor = Executors.newSingleThreadExecutor();
1403 final IntegrationTestKit follower2TestKit = new IntegrationTestKit(follower2System,
1404 DatastoreContext.newBuilderFrom(followerDatastoreContextBuilder.build()).operationTimeoutInMillis(500)
1405 .shardLeaderElectionTimeoutInSeconds(3600),
1408 final DOMStoreWriteTransaction initialWriteTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1409 initialWriteTx.write(CarsModel.BASE_PATH, CarsModel.emptyContainer());
1410 leaderTestKit.doCommit(initialWriteTx.ready());
1412 try (AbstractDataStore follower2DistributedDataStore = follower2TestKit.setupAbstractDataStore(
1413 testParameter, testName, MODULE_SHARDS_CARS_1_2_3, false)) {
1415 final ActorRef member3Cars = ((LocalShardStore) follower2DistributedDataStore).getLocalShards()
1416 .getLocalShards().get("cars").getActor();
1417 final ActorRef member2Cars = ((LocalShardStore)followerDistributedDataStore).getLocalShards()
1418 .getLocalShards().get("cars").getActor();
1419 member2Cars.tell(new StartDropMessages(AppendEntries.class), null);
1420 member3Cars.tell(new StartDropMessages(AppendEntries.class), null);
1422 final DOMStoreWriteTransaction newTx = leaderDistributedDataStore.newWriteOnlyTransaction();
1423 newTx.write(CarsModel.CAR_LIST_PATH, CarsModel.newCarMapNode());
1424 final AtomicBoolean submitDone = new AtomicBoolean(false);
1425 executor.submit(() -> {
1427 leaderTestKit.doCommit(newTx.ready());
1428 submitDone.set(true);
1429 } catch (Exception e) {
1430 throw new RuntimeException(e);
1433 final ActorRef leaderCars = ((LocalShardStore) leaderDistributedDataStore).getLocalShards()
1434 .getLocalShards().get("cars").getActor();
1435 await().atMost(10, TimeUnit.SECONDS)
1436 .until(() -> ((OnDemandRaftState) leaderDistributedDataStore.getActorUtils()
1437 .executeOperation(leaderCars, GetOnDemandRaftState.INSTANCE)).getLastIndex() >= 1);
1439 final OnDemandRaftState raftState = (OnDemandRaftState)leaderDistributedDataStore.getActorUtils()
1440 .executeOperation(leaderCars, GetOnDemandRaftState.INSTANCE);
1442 // Simulate a follower not receiving heartbeats but still being able to send messages ie RequestVote with
1443 // new term(switching to candidate after election timeout)
1444 leaderCars.tell(new RequestVote(raftState.getCurrentTerm() + 1,
1445 "member-3-shard-cars-testRaftCallbackDuringLeadershipDrop", -1,
1448 member2Cars.tell(new StopDropMessages(AppendEntries.class), null);
1449 member3Cars.tell(new StopDropMessages(AppendEntries.class), null);
1451 await("Is tx stuck in COMMIT_PENDING")
1452 .atMost(10, TimeUnit.SECONDS).untilAtomic(submitDone, equalTo(true));
1456 executor.shutdownNow();
1460 public void testSnapshotOnRootOverwrite() throws Exception {
1461 initDatastores("testSnapshotOnRootOverwrite", "module-shards-default-cars-member1-and-2.conf",
1462 new String[] {"cars", "default"},
1463 leaderDatastoreContextBuilder.snapshotOnRootOverwrite(true),
1464 followerDatastoreContextBuilder.snapshotOnRootOverwrite(true));
1466 leaderTestKit.waitForMembersUp("member-2");
1467 final ContainerNode rootNode = Builders.containerBuilder()
1468 .withNodeIdentifier(NodeIdentifier.create(SchemaContext.NAME))
1469 .withChild(CarsModel.create())
1472 leaderTestKit.testWriteTransaction(leaderDistributedDataStore, YangInstanceIdentifier.empty(), rootNode);
1474 // FIXME: CONTROLLER-2020: ClientBackedDatastore does not have stable indexes/term,
1475 // the snapshot index seems to fluctuate
1476 assumeTrue(DistributedDataStore.class.isAssignableFrom(testParameter));
1477 IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1478 state -> assertEquals(1, state.getSnapshotIndex()));
1480 IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1481 state -> assertEquals(1, state.getSnapshotIndex()));
1483 verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 1);
1484 verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 1);
1486 for (int i = 0; i < 10; i++) {
1487 leaderTestKit.testWriteTransaction(leaderDistributedDataStore, CarsModel.newCarPath("car " + i),
1488 CarsModel.newCarEntry("car " + i, Uint64.ONE));
1491 // fake snapshot causes the snapshotIndex to move
1492 IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1493 state -> assertEquals(10, state.getSnapshotIndex()));
1494 IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1495 state -> assertEquals(10, state.getSnapshotIndex()));
1497 // however the real snapshot still has not changed and was taken at index 1
1498 verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 1);
1499 verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 1);
1501 // root overwrite so expect a snapshot
1502 leaderTestKit.testWriteTransaction(leaderDistributedDataStore, YangInstanceIdentifier.empty(), rootNode);
1504 // this was a real snapshot so everything should be in it(1(DisableTrackingPayload) + 1 + 10 + 1)
1505 IntegrationTestKit.verifyShardState(leaderDistributedDataStore, "cars",
1506 state -> assertEquals(12, state.getSnapshotIndex()));
1507 IntegrationTestKit.verifyShardState(followerDistributedDataStore, "cars",
1508 state -> assertEquals(12, state.getSnapshotIndex()));
1510 verifySnapshot("member-1-shard-cars-testSnapshotOnRootOverwrite", 12);
1511 verifySnapshot("member-2-shard-cars-testSnapshotOnRootOverwrite", 12);
1514 private static void verifySnapshot(final String persistenceId, final long lastAppliedIndex) {
1515 await().atMost(5, TimeUnit.SECONDS).untilAsserted(() -> {
1516 List<Snapshot> snap = InMemorySnapshotStore.getSnapshots(persistenceId, Snapshot.class);
1517 assertEquals(1, snap.size());
1518 assertEquals(lastAppliedIndex, snap.get(0).getLastAppliedIndex());
1523 private static void verifySnapshot(final Snapshot actual, final Snapshot expected,
1524 final NormalizedNode expRoot) {
1525 assertEquals("Snapshot getLastAppliedTerm", expected.getLastAppliedTerm(), actual.getLastAppliedTerm());
1526 assertEquals("Snapshot getLastAppliedIndex", expected.getLastAppliedIndex(), actual.getLastAppliedIndex());
1527 assertEquals("Snapshot getLastTerm", expected.getLastTerm(), actual.getLastTerm());
1528 assertEquals("Snapshot getLastIndex", expected.getLastIndex(), actual.getLastIndex());
1529 assertEquals("Snapshot state type", ShardSnapshotState.class, actual.getState().getClass());
1530 MetadataShardDataTreeSnapshot shardSnapshot =
1531 (MetadataShardDataTreeSnapshot) ((ShardSnapshotState)actual.getState()).getSnapshot();
1532 assertEquals("Snapshot root node", expRoot, shardSnapshot.getRootNode().get());
1535 private static void sendDatastoreContextUpdate(final AbstractDataStore dataStore, final Builder builder) {
1536 final Builder newBuilder = DatastoreContext.newBuilderFrom(builder.build());
1537 final DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
1538 final Answer<DatastoreContext> answer = invocation -> newBuilder.build();
1539 doAnswer(answer).when(mockContextFactory).getBaseDatastoreContext();
1540 doAnswer(answer).when(mockContextFactory).getShardDatastoreContext(anyString());
1541 dataStore.onDatastoreContextUpdated(mockContextFactory);