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

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.