2 * Copyright (c) 2014, 2015 Cisco 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
9 package org.opendaylight.controller.cluster.datastore;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertTrue;
14 import static org.mockito.Matchers.any;
15 import static org.mockito.Matchers.anyString;
16 import static org.mockito.Matchers.eq;
17 import static org.mockito.Matchers.isA;
18 import static org.mockito.Mockito.doReturn;
19 import static org.mockito.Mockito.doThrow;
20 import static org.mockito.Mockito.mock;
21 import static org.mockito.Mockito.verify;
22 import static org.opendaylight.controller.cluster.datastore.TransactionType.READ_ONLY;
23 import static org.opendaylight.controller.cluster.datastore.TransactionType.READ_WRITE;
24 import static org.opendaylight.controller.cluster.datastore.TransactionType.WRITE_ONLY;
25 import akka.actor.ActorRef;
26 import akka.actor.ActorSelection;
27 import akka.actor.ActorSystem;
28 import akka.actor.Props;
29 import akka.dispatch.Futures;
30 import akka.util.Timeout;
31 import com.google.common.base.Optional;
32 import com.google.common.collect.Sets;
33 import com.google.common.util.concurrent.CheckedFuture;
34 import com.google.common.util.concurrent.FutureCallback;
35 import com.google.common.util.concurrent.Uninterruptibles;
36 import java.util.Collection;
37 import java.util.List;
38 import java.util.concurrent.CountDownLatch;
39 import java.util.concurrent.ExecutionException;
40 import java.util.concurrent.TimeUnit;
41 import java.util.concurrent.atomic.AtomicReference;
42 import org.junit.Assert;
43 import org.junit.Test;
44 import org.mockito.InOrder;
45 import org.mockito.Mockito;
46 import org.opendaylight.controller.cluster.datastore.config.Configuration;
47 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
48 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
49 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
50 import org.opendaylight.controller.cluster.datastore.exceptions.TimeoutException;
51 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
52 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
53 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
54 import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
55 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
56 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
57 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
58 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
59 import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy;
60 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregatorTest;
61 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
62 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
63 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
64 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
65 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
66 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
67 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
68 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
69 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
70 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
71 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
72 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
73 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
74 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
75 import scala.concurrent.Promise;
77 @SuppressWarnings("resource")
78 public class TransactionProxyTest extends AbstractTransactionProxyTest {
80 @SuppressWarnings("serial")
81 static class TestException extends RuntimeException {
84 static interface Invoker {
85 CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception;
89 public void testRead() throws Exception {
90 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
92 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
94 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
95 eq(actorSelection(actorRef)), eqReadData());
97 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
98 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
100 assertEquals("NormalizedNode isPresent", false, readOptional.isPresent());
102 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
104 doReturn(readDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
105 eq(actorSelection(actorRef)), eqReadData());
107 readOptional = transactionProxy.read(TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
109 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
111 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
114 @Test(expected = ReadFailedException.class)
115 public void testReadWithInvalidReplyMessageType() throws Exception {
116 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
118 doReturn(Futures.successful(new Object())).when(mockActorContext).
119 executeOperationAsync(eq(actorSelection(actorRef)), eqReadData());
121 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
123 transactionProxy.read(TestModel.TEST_PATH).checkedGet(5, TimeUnit.SECONDS);
126 @Test(expected = TestException.class)
127 public void testReadWithAsyncRemoteOperatonFailure() throws Throwable {
128 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
130 doReturn(Futures.failed(new TestException())).when(mockActorContext).
131 executeOperationAsync(eq(actorSelection(actorRef)), eqReadData());
133 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
135 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
138 private void testExceptionOnInitialCreateTransaction(Exception exToThrow, Invoker invoker)
140 ActorRef actorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
142 if (exToThrow instanceof PrimaryNotFoundException) {
143 doReturn(Futures.failed(exToThrow)).when(mockActorContext).findPrimaryShardAsync(anyString());
145 doReturn(primaryShardInfoReply(getSystem(), actorRef)).
146 when(mockActorContext).findPrimaryShardAsync(anyString());
149 doReturn(Futures.failed(exToThrow)).when(mockActorContext).executeOperationAsync(
150 any(ActorSelection.class), any(), any(Timeout.class));
152 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
154 propagateReadFailedExceptionCause(invoker.invoke(transactionProxy));
157 private void testReadWithExceptionOnInitialCreateTransaction(Exception exToThrow) throws Throwable {
158 testExceptionOnInitialCreateTransaction(exToThrow, new Invoker() {
160 public CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception {
161 return proxy.read(TestModel.TEST_PATH);
166 @Test(expected = PrimaryNotFoundException.class)
167 public void testReadWhenAPrimaryNotFoundExceptionIsThrown() throws Throwable {
168 testReadWithExceptionOnInitialCreateTransaction(new PrimaryNotFoundException("test"));
171 @Test(expected = TimeoutException.class)
172 public void testReadWhenATimeoutExceptionIsThrown() throws Throwable {
173 testReadWithExceptionOnInitialCreateTransaction(new TimeoutException("test",
174 new Exception("reason")));
177 @Test(expected = TestException.class)
178 public void testReadWhenAnyOtherExceptionIsThrown() throws Throwable {
179 testReadWithExceptionOnInitialCreateTransaction(new TestException());
183 public void testReadWithPriorRecordingOperationSuccessful() throws Throwable {
184 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
186 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
188 expectBatchedModifications(actorRef, 1);
190 doReturn(readDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
191 eq(actorSelection(actorRef)), eqReadData());
193 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
195 transactionProxy.write(TestModel.TEST_PATH, expectedNode);
197 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
198 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
200 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
201 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
203 InOrder inOrder = Mockito.inOrder(mockActorContext);
204 inOrder.verify(mockActorContext).executeOperationAsync(
205 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
207 inOrder.verify(mockActorContext).executeOperationAsync(
208 eq(actorSelection(actorRef)), eqReadData());
211 @Test(expected=IllegalStateException.class)
212 public void testReadPreConditionCheck() {
213 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
214 transactionProxy.read(TestModel.TEST_PATH);
217 @Test(expected=IllegalArgumentException.class)
218 public void testInvalidCreateTransactionReply() throws Throwable {
219 ActorRef actorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
221 doReturn(getSystem().actorSelection(actorRef.path())).when(mockActorContext).
222 actorSelection(actorRef.path().toString());
224 doReturn(primaryShardInfoReply(getSystem(), actorRef)).
225 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
227 doReturn(Futures.successful(new Object())).when(mockActorContext).executeOperationAsync(
228 eq(getSystem().actorSelection(actorRef.path())), eqCreateTransaction(memberName, READ_ONLY),
231 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
233 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
237 public void testExists() throws Exception {
238 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
240 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
242 doReturn(dataExistsReply(false)).when(mockActorContext).executeOperationAsync(
243 eq(actorSelection(actorRef)), eqDataExists());
245 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
247 assertEquals("Exists response", false, exists);
249 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
250 eq(actorSelection(actorRef)), eqDataExists());
252 exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
254 assertEquals("Exists response", true, exists);
257 @Test(expected = PrimaryNotFoundException.class)
258 public void testExistsWhenAPrimaryNotFoundExceptionIsThrown() throws Throwable {
259 testExceptionOnInitialCreateTransaction(new PrimaryNotFoundException("test"), new Invoker() {
261 public CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception {
262 return proxy.exists(TestModel.TEST_PATH);
267 @Test(expected = ReadFailedException.class)
268 public void testExistsWithInvalidReplyMessageType() throws Exception {
269 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
271 doReturn(Futures.successful(new Object())).when(mockActorContext).
272 executeOperationAsync(eq(actorSelection(actorRef)), eqDataExists());
274 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
276 transactionProxy.exists(TestModel.TEST_PATH).checkedGet(5, TimeUnit.SECONDS);
279 @Test(expected = TestException.class)
280 public void testExistsWithAsyncRemoteOperatonFailure() throws Throwable {
281 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
283 doReturn(Futures.failed(new TestException())).when(mockActorContext).
284 executeOperationAsync(eq(actorSelection(actorRef)), eqDataExists());
286 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
288 propagateReadFailedExceptionCause(transactionProxy.exists(TestModel.TEST_PATH));
292 public void testExistsWithPriorRecordingOperationSuccessful() throws Throwable {
293 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
295 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
297 expectBatchedModifications(actorRef, 1);
299 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
300 eq(actorSelection(actorRef)), eqDataExists());
302 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
304 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
306 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
308 assertEquals("Exists response", true, exists);
310 InOrder inOrder = Mockito.inOrder(mockActorContext);
311 inOrder.verify(mockActorContext).executeOperationAsync(
312 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
314 inOrder.verify(mockActorContext).executeOperationAsync(
315 eq(actorSelection(actorRef)), eqDataExists());
318 @Test(expected=IllegalStateException.class)
319 public void testExistsPreConditionCheck() {
320 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
321 transactionProxy.exists(TestModel.TEST_PATH);
325 public void testWrite() throws Exception {
326 dataStoreContextBuilder.shardBatchedModificationCount(1);
327 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
329 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
331 expectBatchedModifications(actorRef, 1);
333 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
335 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
337 verifyOneBatchedModification(actorRef, new WriteModification(TestModel.TEST_PATH, nodeToWrite), false);
341 public void testWriteAfterAsyncRead() throws Throwable {
342 ActorRef actorRef = setupActorContextWithoutInitialCreateTransaction(getSystem(), DefaultShardStrategy.DEFAULT_SHARD);
344 Promise<Object> createTxPromise = akka.dispatch.Futures.promise();
345 doReturn(createTxPromise).when(mockActorContext).executeOperationAsync(
346 eq(getSystem().actorSelection(actorRef.path())),
347 eqCreateTransaction(memberName, READ_WRITE), any(Timeout.class));
349 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
350 eq(actorSelection(actorRef)), eqReadData());
352 expectBatchedModificationsReady(actorRef);
354 final NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
356 final TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
358 final CountDownLatch readComplete = new CountDownLatch(1);
359 final AtomicReference<Throwable> caughtEx = new AtomicReference<>();
360 com.google.common.util.concurrent.Futures.addCallback(transactionProxy.read(TestModel.TEST_PATH),
361 new FutureCallback<Optional<NormalizedNode<?, ?>>>() {
363 public void onSuccess(Optional<NormalizedNode<?, ?>> result) {
365 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
366 } catch (Exception e) {
369 readComplete.countDown();
374 public void onFailure(Throwable t) {
376 readComplete.countDown();
380 createTxPromise.success(createTransactionReply(actorRef, DataStoreVersions.CURRENT_VERSION));
382 Uninterruptibles.awaitUninterruptibly(readComplete, 5, TimeUnit.SECONDS);
384 if(caughtEx.get() != null) {
385 throw caughtEx.get();
388 // This sends the batched modification.
389 transactionProxy.ready();
391 verifyOneBatchedModification(actorRef, new WriteModification(TestModel.TEST_PATH, nodeToWrite), true);
394 @Test(expected=IllegalStateException.class)
395 public void testWritePreConditionCheck() {
396 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
397 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
400 @Test(expected=IllegalStateException.class)
401 public void testWriteAfterReadyPreConditionCheck() {
402 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
404 transactionProxy.ready();
406 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
410 public void testMerge() throws Exception {
411 dataStoreContextBuilder.shardBatchedModificationCount(1);
412 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
414 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
416 expectBatchedModifications(actorRef, 1);
418 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
420 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
422 verifyOneBatchedModification(actorRef, new MergeModification(TestModel.TEST_PATH, nodeToWrite), false);
426 public void testDelete() throws Exception {
427 dataStoreContextBuilder.shardBatchedModificationCount(1);
428 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
430 expectBatchedModifications(actorRef, 1);
432 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
434 transactionProxy.delete(TestModel.TEST_PATH);
436 verifyOneBatchedModification(actorRef, new DeleteModification(TestModel.TEST_PATH), false);
440 public void testReadWrite() throws Exception {
441 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
443 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
445 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
446 eq(actorSelection(actorRef)), eqReadData());
448 expectBatchedModifications(actorRef, 1);
450 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
452 transactionProxy.read(TestModel.TEST_PATH);
454 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
456 transactionProxy.read(TestModel.TEST_PATH);
458 transactionProxy.read(TestModel.TEST_PATH);
460 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
461 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
463 verifyBatchedModifications(batchedModifications.get(0), false,
464 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
468 public void testReadyWithReadWrite() throws Exception {
469 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
471 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
473 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
474 eq(actorSelection(actorRef)), eqReadData());
476 expectBatchedModificationsReady(actorRef, true);
478 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
480 transactionProxy.read(TestModel.TEST_PATH);
482 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
484 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
486 assertTrue(ready instanceof SingleCommitCohortProxy);
488 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
490 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
491 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
493 verifyBatchedModifications(batchedModifications.get(0), true, true,
494 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
496 assertEquals("getTotalMessageCount", 1, batchedModifications.get(0).getTotalMessagesSent());
500 public void testReadyWithNoModifications() throws Exception {
501 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
503 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
504 eq(actorSelection(actorRef)), eqReadData());
506 expectBatchedModificationsReady(actorRef, true);
508 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
510 transactionProxy.read(TestModel.TEST_PATH);
512 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
514 assertTrue(ready instanceof SingleCommitCohortProxy);
516 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
518 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
519 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
521 verifyBatchedModifications(batchedModifications.get(0), true, true);
525 public void testReadyWithMultipleShardWrites() throws Exception {
526 ActorRef actorRef1 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
528 ActorRef actorRef2 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY, "junk");
530 expectBatchedModificationsReady(actorRef1);
531 expectBatchedModificationsReady(actorRef2);
533 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
535 transactionProxy.write(TestModel.JUNK_PATH, ImmutableNodes.containerNode(TestModel.JUNK_QNAME));
536 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
538 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
540 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
542 verifyCohortFutures((ThreePhaseCommitCohortProxy)ready, actorSelection(actorRef1),
543 actorSelection(actorRef2));
547 public void testReadyWithWriteOnlyAndLastBatchPending() throws Exception {
548 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
550 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
552 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
554 expectBatchedModificationsReady(actorRef, true);
556 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
558 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
560 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
562 assertTrue(ready instanceof SingleCommitCohortProxy);
564 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
566 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
567 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
569 verifyBatchedModifications(batchedModifications.get(0), true, true,
570 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
574 public void testReadyWithWriteOnlyAndLastBatchEmpty() throws Exception {
575 dataStoreContextBuilder.shardBatchedModificationCount(1).writeOnlyTransactionOptimizationsEnabled(true);
576 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
578 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
580 expectBatchedModificationsReady(actorRef, true);
582 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
584 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
586 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
588 assertTrue(ready instanceof SingleCommitCohortProxy);
590 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
592 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
593 assertEquals("Captured BatchedModifications count", 2, batchedModifications.size());
595 verifyBatchedModifications(batchedModifications.get(0), false,
596 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
598 verifyBatchedModifications(batchedModifications.get(1), true, true);
602 public void testReadyWithReplyFailure() throws Exception {
603 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
605 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
607 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
609 expectFailedBatchedModifications(actorRef);
611 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
613 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
615 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
617 assertTrue(ready instanceof SingleCommitCohortProxy);
619 verifyCohortFutures((SingleCommitCohortProxy)ready, TestException.class);
623 public void testReadyWithDebugContextEnabled() throws Exception {
624 dataStoreContextBuilder.transactionDebugContextEnabled(true);
626 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
628 expectBatchedModificationsReady(actorRef, true);
630 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
632 transactionProxy.merge(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
634 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
636 assertTrue(ready instanceof DebugThreePhaseCommitCohort);
638 verifyCohortFutures((DebugThreePhaseCommitCohort)ready, new CommitTransactionReply().toSerializable());
642 public void testReadyWithLocalTransaction() throws Exception {
643 ActorRef shardActorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
645 doReturn(getSystem().actorSelection(shardActorRef.path())).
646 when(mockActorContext).actorSelection(shardActorRef.path().toString());
648 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef, createDataTree()))).
649 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
651 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
653 expectReadyLocalTransaction(shardActorRef, true);
655 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
656 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
658 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
659 assertTrue(ready instanceof SingleCommitCohortProxy);
660 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
664 public void testReadyWithLocalTransactionWithFailure() throws Exception {
665 ActorRef shardActorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
667 doReturn(getSystem().actorSelection(shardActorRef.path())).
668 when(mockActorContext).actorSelection(shardActorRef.path().toString());
670 Optional<DataTree> mockDataTree = createDataTree();
671 DataTreeModification mockModification = mockDataTree.get().takeSnapshot().newModification();
672 doThrow(new RuntimeException("mock")).when(mockModification).ready();
674 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef, mockDataTree))).
675 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
677 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
679 expectReadyLocalTransaction(shardActorRef, true);
681 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
682 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
684 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
685 assertTrue(ready instanceof SingleCommitCohortProxy);
686 verifyCohortFutures((SingleCommitCohortProxy)ready, RuntimeException.class);
689 private void testWriteOnlyTxWithFindPrimaryShardFailure(Exception toThrow) throws Exception {
690 doReturn(Futures.failed(toThrow)).when(mockActorContext).findPrimaryShardAsync(anyString());
692 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
694 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
696 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
698 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
700 transactionProxy.delete(TestModel.TEST_PATH);
702 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
704 assertTrue(ready instanceof SingleCommitCohortProxy);
706 verifyCohortFutures((SingleCommitCohortProxy)ready, toThrow.getClass());
710 public void testWriteOnlyTxWithPrimaryNotFoundException() throws Exception {
711 testWriteOnlyTxWithFindPrimaryShardFailure(new PrimaryNotFoundException("mock"));
715 public void testWriteOnlyTxWithNotInitializedException() throws Exception {
716 testWriteOnlyTxWithFindPrimaryShardFailure(new NotInitializedException("mock"));
720 public void testWriteOnlyTxWithNoShardLeaderException() throws Exception {
721 testWriteOnlyTxWithFindPrimaryShardFailure(new NoShardLeaderException("mock"));
725 public void testReadyWithInvalidReplyMessageType() throws Exception {
726 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
727 ActorRef actorRef1 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
729 ActorRef actorRef2 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY, "junk");
731 doReturn(Futures.successful(new Object())).when(mockActorContext).
732 executeOperationAsync(eq(actorSelection(actorRef1)), isA(BatchedModifications.class));
734 expectBatchedModificationsReady(actorRef2);
736 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
738 transactionProxy.write(TestModel.JUNK_PATH, ImmutableNodes.containerNode(TestModel.JUNK_QNAME));
739 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
741 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
743 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
745 verifyCohortFutures((ThreePhaseCommitCohortProxy)ready, actorSelection(actorRef2),
746 IllegalArgumentException.class);
750 public void testGetIdentifier() {
751 setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
752 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
754 Object id = transactionProxy.getIdentifier();
755 assertNotNull("getIdentifier returned null", id);
756 assertTrue("Invalid identifier: " + id, id.toString().startsWith(memberName));
760 public void testClose() throws Exception{
761 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
763 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
764 eq(actorSelection(actorRef)), eqReadData());
766 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
768 transactionProxy.read(TestModel.TEST_PATH);
770 transactionProxy.close();
772 verify(mockActorContext).sendOperationAsync(
773 eq(actorSelection(actorRef)), isA(CloseTransaction.class));
776 private static interface TransactionProxyOperation {
777 void run(TransactionProxy transactionProxy);
780 private void throttleOperation(TransactionProxyOperation operation) {
781 throttleOperation(operation, 1, true);
784 private void throttleOperation(TransactionProxyOperation operation, int outstandingOpsLimit, boolean shardFound){
785 throttleOperation(operation, outstandingOpsLimit, shardFound, TimeUnit.MILLISECONDS.toNanos(
786 mockActorContext.getDatastoreContext().getOperationTimeoutInMillis()));
789 private PrimaryShardInfo newPrimaryShardInfo(ActorRef actorRef){
790 return new PrimaryShardInfo(getSystem().actorSelection(actorRef.path()), DataStoreVersions.CURRENT_VERSION,
791 Optional.<DataTree>absent());
794 private PrimaryShardInfo newPrimaryShardInfo(ActorRef actorRef, Optional<DataTree> dataTreeOptional){
795 return new PrimaryShardInfo(getSystem().actorSelection(actorRef.path()), DataStoreVersions.CURRENT_VERSION,
800 private void throttleOperation(TransactionProxyOperation operation, int outstandingOpsLimit, boolean shardFound, long expectedCompletionTime){
801 ActorSystem actorSystem = getSystem();
802 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
804 // Note that we setting batchedModificationCount to one less than what we need because in TransactionProxy
805 // we now allow one extra permit to be allowed for ready
806 doReturn(dataStoreContextBuilder.operationTimeoutInSeconds(2).
807 shardBatchedModificationCount(outstandingOpsLimit-1).build()).when(mockActorContext).getDatastoreContext();
809 doReturn(actorSystem.actorSelection(shardActorRef.path())).
810 when(mockActorContext).actorSelection(shardActorRef.path().toString());
813 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef))).
814 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
815 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef))).
816 when(mockActorContext).findPrimaryShardAsync(eq("cars"));
819 doReturn(Futures.failed(new Exception("not found")))
820 .when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
823 String actorPath = "akka.tcp://system@127.0.0.1:2550/user/tx-actor";
825 doReturn(incompleteFuture()).when(mockActorContext).
826 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
827 eqCreateTransaction(memberName, READ_WRITE), any(Timeout.class));
829 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
831 long start = System.nanoTime();
833 operation.run(transactionProxy);
835 long end = System.nanoTime();
837 Assert.assertTrue(String.format("Expected elapsed time: %s. Actual: %s",
838 expectedCompletionTime, (end-start)),
839 ((end - start) > expectedCompletionTime) && ((end - start) < expectedCompletionTime*2));
843 private void completeOperation(TransactionProxyOperation operation){
844 completeOperation(operation, true);
847 private void completeOperation(TransactionProxyOperation operation, boolean shardFound){
848 ActorSystem actorSystem = getSystem();
849 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
851 doReturn(actorSystem.actorSelection(shardActorRef.path())).
852 when(mockActorContext).actorSelection(shardActorRef.path().toString());
855 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef))).
856 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
858 doReturn(Futures.failed(new PrimaryNotFoundException("test")))
859 .when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
862 ActorRef txActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
863 String actorPath = txActorRef.path().toString();
864 CreateTransactionReply createTransactionReply = new CreateTransactionReply(actorPath, "txn-1",
865 DataStoreVersions.CURRENT_VERSION);
867 doReturn(actorSystem.actorSelection(actorPath)).when(mockActorContext).actorSelection(actorPath);
869 doReturn(Futures.successful(createTransactionReply)).when(mockActorContext).
870 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
871 eqCreateTransaction(memberName, READ_WRITE), any(Timeout.class));
873 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
875 long start = System.nanoTime();
877 operation.run(transactionProxy);
879 long end = System.nanoTime();
881 long expected = TimeUnit.MILLISECONDS.toNanos(mockActorContext.getDatastoreContext().getOperationTimeoutInMillis());
882 Assert.assertTrue(String.format("Expected elapsed time: %s. Actual: %s",
883 expected, (end-start)), (end - start) <= expected);
886 private void completeOperationLocal(TransactionProxyOperation operation, Optional<DataTree> dataTreeOptional){
887 ActorSystem actorSystem = getSystem();
888 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
890 doReturn(actorSystem.actorSelection(shardActorRef.path())).
891 when(mockActorContext).actorSelection(shardActorRef.path().toString());
893 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef, dataTreeOptional))).
894 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
896 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
898 long start = System.nanoTime();
900 operation.run(transactionProxy);
902 long end = System.nanoTime();
904 long expected = TimeUnit.MILLISECONDS.toNanos(mockActorContext.getDatastoreContext().getOperationTimeoutInMillis());
905 Assert.assertTrue(String.format("Expected elapsed time: %s. Actual: %s",
906 expected, (end-start)), (end - start) <= expected);
909 private static Optional<DataTree> createDataTree(){
910 DataTree dataTree = mock(DataTree.class);
911 Optional<DataTree> dataTreeOptional = Optional.of(dataTree);
912 DataTreeSnapshot dataTreeSnapshot = mock(DataTreeSnapshot.class);
913 DataTreeModification dataTreeModification = mock(DataTreeModification.class);
915 doReturn(dataTreeSnapshot).when(dataTree).takeSnapshot();
916 doReturn(dataTreeModification).when(dataTreeSnapshot).newModification();
918 return dataTreeOptional;
921 private static Optional<DataTree> createDataTree(NormalizedNode<?, ?> readResponse){
922 DataTree dataTree = mock(DataTree.class);
923 Optional<DataTree> dataTreeOptional = Optional.of(dataTree);
924 DataTreeSnapshot dataTreeSnapshot = mock(DataTreeSnapshot.class);
925 DataTreeModification dataTreeModification = mock(DataTreeModification.class);
927 doReturn(dataTreeSnapshot).when(dataTree).takeSnapshot();
928 doReturn(dataTreeModification).when(dataTreeSnapshot).newModification();
929 doReturn(Optional.of(readResponse)).when(dataTreeModification).readNode(any(YangInstanceIdentifier.class));
931 return dataTreeOptional;
936 public void testWriteCompletionForLocalShard(){
937 completeOperationLocal(new TransactionProxyOperation() {
939 public void run(TransactionProxy transactionProxy) {
940 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
942 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
944 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
947 }, createDataTree());
951 public void testWriteThrottlingWhenShardFound(){
952 throttleOperation(new TransactionProxyOperation() {
954 public void run(TransactionProxy transactionProxy) {
955 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
957 expectIncompleteBatchedModifications();
959 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
961 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
967 public void testWriteThrottlingWhenShardNotFound(){
968 // Confirm that there is no throttling when the Shard is not found
969 completeOperation(new TransactionProxyOperation() {
971 public void run(TransactionProxy transactionProxy) {
972 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
974 expectBatchedModifications(2);
976 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
978 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
986 public void testWriteCompletion(){
987 completeOperation(new TransactionProxyOperation() {
989 public void run(TransactionProxy transactionProxy) {
990 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
992 expectBatchedModifications(2);
994 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
996 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1002 public void testMergeThrottlingWhenShardFound(){
1003 throttleOperation(new TransactionProxyOperation() {
1005 public void run(TransactionProxy transactionProxy) {
1006 NormalizedNode<?, ?> nodeToMerge = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1008 expectIncompleteBatchedModifications();
1010 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1012 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1018 public void testMergeThrottlingWhenShardNotFound(){
1019 completeOperation(new TransactionProxyOperation() {
1021 public void run(TransactionProxy transactionProxy) {
1022 NormalizedNode<?, ?> nodeToMerge = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1024 expectBatchedModifications(2);
1026 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1028 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1034 public void testMergeCompletion(){
1035 completeOperation(new TransactionProxyOperation() {
1037 public void run(TransactionProxy transactionProxy) {
1038 NormalizedNode<?, ?> nodeToMerge = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1040 expectBatchedModifications(2);
1042 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1044 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1051 public void testMergeCompletionForLocalShard(){
1052 completeOperationLocal(new TransactionProxyOperation() {
1054 public void run(TransactionProxy transactionProxy) {
1055 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1057 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
1059 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
1062 }, createDataTree());
1067 public void testDeleteThrottlingWhenShardFound(){
1069 throttleOperation(new TransactionProxyOperation() {
1071 public void run(TransactionProxy transactionProxy) {
1072 expectIncompleteBatchedModifications();
1074 transactionProxy.delete(TestModel.TEST_PATH);
1076 transactionProxy.delete(TestModel.TEST_PATH);
1083 public void testDeleteThrottlingWhenShardNotFound(){
1085 completeOperation(new TransactionProxyOperation() {
1087 public void run(TransactionProxy transactionProxy) {
1088 expectBatchedModifications(2);
1090 transactionProxy.delete(TestModel.TEST_PATH);
1092 transactionProxy.delete(TestModel.TEST_PATH);
1098 public void testDeleteCompletionForLocalShard(){
1099 completeOperationLocal(new TransactionProxyOperation() {
1101 public void run(TransactionProxy transactionProxy) {
1103 transactionProxy.delete(TestModel.TEST_PATH);
1105 transactionProxy.delete(TestModel.TEST_PATH);
1107 }, createDataTree());
1112 public void testDeleteCompletion(){
1113 completeOperation(new TransactionProxyOperation() {
1115 public void run(TransactionProxy transactionProxy) {
1116 expectBatchedModifications(2);
1118 transactionProxy.delete(TestModel.TEST_PATH);
1120 transactionProxy.delete(TestModel.TEST_PATH);
1127 public void testReadThrottlingWhenShardFound(){
1129 throttleOperation(new TransactionProxyOperation() {
1131 public void run(TransactionProxy transactionProxy) {
1132 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1133 any(ActorSelection.class), eqReadData());
1135 transactionProxy.read(TestModel.TEST_PATH);
1137 transactionProxy.read(TestModel.TEST_PATH);
1143 public void testReadThrottlingWhenShardNotFound(){
1145 completeOperation(new TransactionProxyOperation() {
1147 public void run(TransactionProxy transactionProxy) {
1148 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1149 any(ActorSelection.class), eqReadData());
1151 transactionProxy.read(TestModel.TEST_PATH);
1153 transactionProxy.read(TestModel.TEST_PATH);
1160 public void testReadCompletion(){
1161 completeOperation(new TransactionProxyOperation() {
1163 public void run(TransactionProxy transactionProxy) {
1164 NormalizedNode<?, ?> nodeToRead = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1166 doReturn(readDataReply(nodeToRead)).when(mockActorContext).executeOperationAsync(
1167 any(ActorSelection.class), eqReadData());
1169 transactionProxy.read(TestModel.TEST_PATH);
1171 transactionProxy.read(TestModel.TEST_PATH);
1178 public void testReadCompletionForLocalShard(){
1179 final NormalizedNode<?, ?> nodeToRead = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1180 completeOperationLocal(new TransactionProxyOperation() {
1182 public void run(TransactionProxy transactionProxy) {
1183 transactionProxy.read(TestModel.TEST_PATH);
1185 transactionProxy.read(TestModel.TEST_PATH);
1187 }, createDataTree(nodeToRead));
1192 public void testReadCompletionForLocalShardWhenExceptionOccurs(){
1193 completeOperationLocal(new TransactionProxyOperation() {
1195 public void run(TransactionProxy transactionProxy) {
1196 transactionProxy.read(TestModel.TEST_PATH);
1198 transactionProxy.read(TestModel.TEST_PATH);
1200 }, createDataTree());
1205 public void testExistsThrottlingWhenShardFound(){
1207 throttleOperation(new TransactionProxyOperation() {
1209 public void run(TransactionProxy transactionProxy) {
1210 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1211 any(ActorSelection.class), eqDataExists());
1213 transactionProxy.exists(TestModel.TEST_PATH);
1215 transactionProxy.exists(TestModel.TEST_PATH);
1221 public void testExistsThrottlingWhenShardNotFound(){
1223 completeOperation(new TransactionProxyOperation() {
1225 public void run(TransactionProxy transactionProxy) {
1226 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1227 any(ActorSelection.class), eqDataExists());
1229 transactionProxy.exists(TestModel.TEST_PATH);
1231 transactionProxy.exists(TestModel.TEST_PATH);
1238 public void testExistsCompletion(){
1239 completeOperation(new TransactionProxyOperation() {
1241 public void run(TransactionProxy transactionProxy) {
1242 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
1243 any(ActorSelection.class), eqDataExists());
1245 transactionProxy.exists(TestModel.TEST_PATH);
1247 transactionProxy.exists(TestModel.TEST_PATH);
1254 public void testExistsCompletionForLocalShard(){
1255 final NormalizedNode<?, ?> nodeToRead = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1256 completeOperationLocal(new TransactionProxyOperation() {
1258 public void run(TransactionProxy transactionProxy) {
1259 transactionProxy.exists(TestModel.TEST_PATH);
1261 transactionProxy.exists(TestModel.TEST_PATH);
1263 }, createDataTree(nodeToRead));
1268 public void testExistsCompletionForLocalShardWhenExceptionOccurs(){
1269 completeOperationLocal(new TransactionProxyOperation() {
1271 public void run(TransactionProxy transactionProxy) {
1272 transactionProxy.exists(TestModel.TEST_PATH);
1274 transactionProxy.exists(TestModel.TEST_PATH);
1276 }, createDataTree());
1280 public void testReadyThrottling(){
1282 throttleOperation(new TransactionProxyOperation() {
1284 public void run(TransactionProxy transactionProxy) {
1285 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1287 expectBatchedModifications(1);
1289 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1291 transactionProxy.ready();
1297 public void testReadyThrottlingWithTwoTransactionContexts(){
1298 throttleOperation(new TransactionProxyOperation() {
1300 public void run(TransactionProxy transactionProxy) {
1301 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1302 NormalizedNode<?, ?> carsNode = ImmutableNodes.containerNode(CarsModel.BASE_QNAME);
1304 expectBatchedModifications(2);
1306 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1308 // Trying to write to Cars will cause another transaction context to get created
1309 transactionProxy.write(CarsModel.BASE_PATH, carsNode);
1311 // Now ready should block for both transaction contexts
1312 transactionProxy.ready();
1314 }, 1, true, TimeUnit.MILLISECONDS.toNanos(mockActorContext.getDatastoreContext().getOperationTimeoutInMillis()) * 2);
1317 private void testModificationOperationBatching(TransactionType type) throws Exception {
1318 int shardBatchedModificationCount = 3;
1319 dataStoreContextBuilder.shardBatchedModificationCount(shardBatchedModificationCount);
1321 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), type);
1323 expectBatchedModifications(actorRef, shardBatchedModificationCount);
1325 YangInstanceIdentifier writePath1 = TestModel.TEST_PATH;
1326 NormalizedNode<?, ?> writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1328 YangInstanceIdentifier writePath2 = TestModel.OUTER_LIST_PATH;
1329 NormalizedNode<?, ?> writeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME);
1331 YangInstanceIdentifier writePath3 = TestModel.INNER_LIST_PATH;
1332 NormalizedNode<?, ?> writeNode3 = ImmutableNodes.containerNode(TestModel.INNER_LIST_QNAME);
1334 YangInstanceIdentifier mergePath1 = TestModel.TEST_PATH;
1335 NormalizedNode<?, ?> mergeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1337 YangInstanceIdentifier mergePath2 = TestModel.OUTER_LIST_PATH;
1338 NormalizedNode<?, ?> mergeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME);
1340 YangInstanceIdentifier mergePath3 = TestModel.INNER_LIST_PATH;
1341 NormalizedNode<?, ?> mergeNode3 = ImmutableNodes.containerNode(TestModel.INNER_LIST_QNAME);
1343 YangInstanceIdentifier deletePath1 = TestModel.TEST_PATH;
1344 YangInstanceIdentifier deletePath2 = TestModel.OUTER_LIST_PATH;
1346 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, type);
1348 transactionProxy.write(writePath1, writeNode1);
1349 transactionProxy.write(writePath2, writeNode2);
1350 transactionProxy.delete(deletePath1);
1351 transactionProxy.merge(mergePath1, mergeNode1);
1352 transactionProxy.merge(mergePath2, mergeNode2);
1353 transactionProxy.write(writePath3, writeNode3);
1354 transactionProxy.merge(mergePath3, mergeNode3);
1355 transactionProxy.delete(deletePath2);
1357 // This sends the last batch.
1358 transactionProxy.ready();
1360 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
1361 assertEquals("Captured BatchedModifications count", 3, batchedModifications.size());
1363 verifyBatchedModifications(batchedModifications.get(0), false, new WriteModification(writePath1, writeNode1),
1364 new WriteModification(writePath2, writeNode2), new DeleteModification(deletePath1));
1366 verifyBatchedModifications(batchedModifications.get(1), false, new MergeModification(mergePath1, mergeNode1),
1367 new MergeModification(mergePath2, mergeNode2), new WriteModification(writePath3, writeNode3));
1369 verifyBatchedModifications(batchedModifications.get(2), true, true,
1370 new MergeModification(mergePath3, mergeNode3), new DeleteModification(deletePath2));
1372 assertEquals("getTotalMessageCount", 3, batchedModifications.get(2).getTotalMessagesSent());
1376 public void testReadWriteModificationOperationBatching() throws Throwable {
1377 testModificationOperationBatching(READ_WRITE);
1381 public void testWriteOnlyModificationOperationBatching() throws Throwable {
1382 testModificationOperationBatching(WRITE_ONLY);
1386 public void testOptimizedWriteOnlyModificationOperationBatching() throws Throwable {
1387 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
1388 testModificationOperationBatching(WRITE_ONLY);
1392 public void testModificationOperationBatchingWithInterleavedReads() throws Throwable {
1394 int shardBatchedModificationCount = 10;
1395 dataStoreContextBuilder.shardBatchedModificationCount(shardBatchedModificationCount);
1397 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
1399 expectBatchedModifications(actorRef, shardBatchedModificationCount);
1401 YangInstanceIdentifier writePath1 = TestModel.TEST_PATH;
1402 NormalizedNode<?, ?> writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1404 YangInstanceIdentifier writePath2 = TestModel.OUTER_LIST_PATH;
1405 NormalizedNode<?, ?> writeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME);
1407 YangInstanceIdentifier mergePath1 = TestModel.TEST_PATH;
1408 NormalizedNode<?, ?> mergeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1410 YangInstanceIdentifier mergePath2 = TestModel.INNER_LIST_PATH;
1411 NormalizedNode<?, ?> mergeNode2 = ImmutableNodes.containerNode(TestModel.INNER_LIST_QNAME);
1413 YangInstanceIdentifier deletePath = TestModel.OUTER_LIST_PATH;
1415 doReturn(readDataReply(writeNode2)).when(mockActorContext).executeOperationAsync(
1416 eq(actorSelection(actorRef)), eqReadData(writePath2));
1418 doReturn(readDataReply(mergeNode2)).when(mockActorContext).executeOperationAsync(
1419 eq(actorSelection(actorRef)), eqReadData(mergePath2));
1421 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
1422 eq(actorSelection(actorRef)), eqDataExists());
1424 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
1426 transactionProxy.write(writePath1, writeNode1);
1427 transactionProxy.write(writePath2, writeNode2);
1429 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(writePath2).
1430 get(5, TimeUnit.SECONDS);
1432 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1433 assertEquals("Response NormalizedNode", writeNode2, readOptional.get());
1435 transactionProxy.merge(mergePath1, mergeNode1);
1436 transactionProxy.merge(mergePath2, mergeNode2);
1438 readOptional = transactionProxy.read(mergePath2).get(5, TimeUnit.SECONDS);
1440 transactionProxy.delete(deletePath);
1442 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
1443 assertEquals("Exists response", true, exists);
1445 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1446 assertEquals("Response NormalizedNode", mergeNode2, readOptional.get());
1448 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
1449 assertEquals("Captured BatchedModifications count", 3, batchedModifications.size());
1451 verifyBatchedModifications(batchedModifications.get(0), false, new WriteModification(writePath1, writeNode1),
1452 new WriteModification(writePath2, writeNode2));
1454 verifyBatchedModifications(batchedModifications.get(1), false, new MergeModification(mergePath1, mergeNode1),
1455 new MergeModification(mergePath2, mergeNode2));
1457 verifyBatchedModifications(batchedModifications.get(2), false, new DeleteModification(deletePath));
1459 InOrder inOrder = Mockito.inOrder(mockActorContext);
1460 inOrder.verify(mockActorContext).executeOperationAsync(
1461 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
1463 inOrder.verify(mockActorContext).executeOperationAsync(
1464 eq(actorSelection(actorRef)), eqReadData(writePath2));
1466 inOrder.verify(mockActorContext).executeOperationAsync(
1467 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
1469 inOrder.verify(mockActorContext).executeOperationAsync(
1470 eq(actorSelection(actorRef)), eqReadData(mergePath2));
1472 inOrder.verify(mockActorContext).executeOperationAsync(
1473 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
1475 inOrder.verify(mockActorContext).executeOperationAsync(
1476 eq(actorSelection(actorRef)), eqDataExists());
1480 public void testReadRoot() throws ReadFailedException, InterruptedException, ExecutionException, java.util.concurrent.TimeoutException {
1482 SchemaContext schemaContext = SchemaContextHelper.full();
1483 Configuration configuration = mock(Configuration.class);
1484 doReturn(configuration).when(mockActorContext).getConfiguration();
1485 doReturn(schemaContext).when(mockActorContext).getSchemaContext();
1486 doReturn(Sets.newHashSet("test", "cars")).when(configuration).getAllShardNames();
1488 NormalizedNode<?, ?> expectedNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1489 NormalizedNode<?, ?> expectedNode2 = ImmutableNodes.containerNode(CarsModel.CARS_QNAME);
1491 setUpReadData("test", NormalizedNodeAggregatorTest.getRootNode(expectedNode1, schemaContext));
1492 setUpReadData("cars", NormalizedNodeAggregatorTest.getRootNode(expectedNode2, schemaContext));
1494 doReturn(memberName).when(mockActorContext).getCurrentMemberName();
1496 doReturn(getSystem().dispatchers().defaultGlobalDispatcher()).when(mockActorContext).getClientDispatcher();
1498 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
1500 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
1501 YangInstanceIdentifier.builder().build()).get(5, TimeUnit.SECONDS);
1503 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1505 NormalizedNode<?, ?> normalizedNode = readOptional.get();
1507 assertTrue("Expect value to be a Collection", normalizedNode.getValue() instanceof Collection);
1509 @SuppressWarnings("unchecked")
1510 Collection<NormalizedNode<?,?>> collection = (Collection<NormalizedNode<?,?>>) normalizedNode.getValue();
1512 for(NormalizedNode<?,?> node : collection){
1513 assertTrue("Expected " + node + " to be a ContainerNode", node instanceof ContainerNode);
1516 assertTrue("Child with QName = " + TestModel.TEST_QNAME + " not found",
1517 NormalizedNodeAggregatorTest.findChildWithQName(collection, TestModel.TEST_QNAME) != null);
1519 assertEquals(expectedNode1, NormalizedNodeAggregatorTest.findChildWithQName(collection, TestModel.TEST_QNAME));
1521 assertTrue("Child with QName = " + CarsModel.BASE_QNAME + " not found",
1522 NormalizedNodeAggregatorTest.findChildWithQName(collection, CarsModel.BASE_QNAME) != null);
1524 assertEquals(expectedNode2, NormalizedNodeAggregatorTest.findChildWithQName(collection, CarsModel.BASE_QNAME));
1528 private void setUpReadData(String shardName, NormalizedNode<?, ?> expectedNode) {
1529 ActorSystem actorSystem = getSystem();
1530 ActorRef shardActorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
1532 doReturn(getSystem().actorSelection(shardActorRef.path())).
1533 when(mockActorContext).actorSelection(shardActorRef.path().toString());
1535 doReturn(primaryShardInfoReply(getSystem(), shardActorRef)).
1536 when(mockActorContext).findPrimaryShardAsync(eq(shardName));
1538 ActorRef txActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
1540 doReturn(actorSystem.actorSelection(txActorRef.path())).
1541 when(mockActorContext).actorSelection(txActorRef.path().toString());
1543 doReturn(Futures.successful(createTransactionReply(txActorRef, DataStoreVersions.CURRENT_VERSION))).when(mockActorContext).
1544 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
1545 eqCreateTransaction(memberName, TransactionType.READ_ONLY), any(Timeout.class));
1547 doReturn(readDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
1548 eq(actorSelection(txActorRef)), eqReadData(YangInstanceIdentifier.builder().build()));