1 package org.opendaylight.controller.cluster.datastore;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertNotNull;
5 import static org.junit.Assert.assertTrue;
6 import static org.mockito.Matchers.any;
7 import static org.mockito.Matchers.anyString;
8 import static org.mockito.Matchers.eq;
9 import static org.mockito.Matchers.isA;
10 import static org.mockito.Mockito.doReturn;
11 import static org.mockito.Mockito.mock;
12 import static org.mockito.Mockito.never;
13 import static org.mockito.Mockito.verify;
14 import static org.opendaylight.controller.cluster.datastore.TransactionType.READ_ONLY;
15 import static org.opendaylight.controller.cluster.datastore.TransactionType.READ_WRITE;
16 import static org.opendaylight.controller.cluster.datastore.TransactionType.WRITE_ONLY;
17 import akka.actor.ActorRef;
18 import akka.actor.ActorSelection;
19 import akka.actor.ActorSystem;
20 import akka.actor.Props;
21 import akka.dispatch.Futures;
22 import com.google.common.base.Optional;
23 import com.google.common.collect.Sets;
24 import com.google.common.util.concurrent.CheckedFuture;
25 import com.google.common.util.concurrent.FutureCallback;
26 import com.google.common.util.concurrent.Uninterruptibles;
27 import java.util.Collection;
28 import java.util.List;
29 import java.util.concurrent.CountDownLatch;
30 import java.util.concurrent.ExecutionException;
31 import java.util.concurrent.TimeUnit;
32 import java.util.concurrent.atomic.AtomicReference;
33 import org.junit.Assert;
34 import org.junit.Test;
35 import org.mockito.InOrder;
36 import org.mockito.Mockito;
37 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
38 import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
39 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
40 import org.opendaylight.controller.cluster.datastore.exceptions.TimeoutException;
41 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
42 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
43 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
44 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
45 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
46 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
47 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
48 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
49 import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy;
50 import org.opendaylight.controller.cluster.datastore.utils.DoNothingActor;
51 import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregatorTest;
52 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
53 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
54 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
55 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
56 import org.opendaylight.controller.protobuff.messages.transaction.ShardTransactionMessages.CreateTransactionReply;
57 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
59 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
61 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
62 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
63 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
64 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
65 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
66 import scala.concurrent.Promise;
68 @SuppressWarnings("resource")
69 public class TransactionProxyTest extends AbstractTransactionProxyTest {
71 @SuppressWarnings("serial")
72 static class TestException extends RuntimeException {
75 static interface Invoker {
76 CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception;
80 public void testRead() throws Exception {
81 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
83 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
85 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
86 eq(actorSelection(actorRef)), eqSerializedReadData());
88 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
89 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
91 assertEquals("NormalizedNode isPresent", false, readOptional.isPresent());
93 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
95 doReturn(readSerializedDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
96 eq(actorSelection(actorRef)), eqSerializedReadData());
98 readOptional = transactionProxy.read(TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
100 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
102 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
105 @Test(expected = ReadFailedException.class)
106 public void testReadWithInvalidReplyMessageType() throws Exception {
107 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
109 doReturn(Futures.successful(new Object())).when(mockActorContext).
110 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedReadData());
112 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
114 transactionProxy.read(TestModel.TEST_PATH).checkedGet(5, TimeUnit.SECONDS);
117 @Test(expected = TestException.class)
118 public void testReadWithAsyncRemoteOperatonFailure() throws Throwable {
119 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
121 doReturn(Futures.failed(new TestException())).when(mockActorContext).
122 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedReadData());
124 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
126 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
129 private void testExceptionOnInitialCreateTransaction(Exception exToThrow, Invoker invoker)
131 ActorRef actorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
133 if (exToThrow instanceof PrimaryNotFoundException) {
134 doReturn(Futures.failed(exToThrow)).when(mockActorContext).findPrimaryShardAsync(anyString());
136 doReturn(primaryShardInfoReply(getSystem(), actorRef)).
137 when(mockActorContext).findPrimaryShardAsync(anyString());
140 doReturn(Futures.failed(exToThrow)).when(mockActorContext).executeOperationAsync(
141 any(ActorSelection.class), any());
143 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
145 propagateReadFailedExceptionCause(invoker.invoke(transactionProxy));
148 private void testReadWithExceptionOnInitialCreateTransaction(Exception exToThrow) throws Throwable {
149 testExceptionOnInitialCreateTransaction(exToThrow, new Invoker() {
151 public CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception {
152 return proxy.read(TestModel.TEST_PATH);
157 @Test(expected = PrimaryNotFoundException.class)
158 public void testReadWhenAPrimaryNotFoundExceptionIsThrown() throws Throwable {
159 testReadWithExceptionOnInitialCreateTransaction(new PrimaryNotFoundException("test"));
162 @Test(expected = TimeoutException.class)
163 public void testReadWhenATimeoutExceptionIsThrown() throws Throwable {
164 testReadWithExceptionOnInitialCreateTransaction(new TimeoutException("test",
165 new Exception("reason")));
168 @Test(expected = TestException.class)
169 public void testReadWhenAnyOtherExceptionIsThrown() throws Throwable {
170 testReadWithExceptionOnInitialCreateTransaction(new TestException());
174 public void testReadWithPriorRecordingOperationSuccessful() throws Throwable {
175 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
177 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
179 expectBatchedModifications(actorRef, 1);
181 doReturn(readSerializedDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
182 eq(actorSelection(actorRef)), eqSerializedReadData());
184 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
186 transactionProxy.write(TestModel.TEST_PATH, expectedNode);
188 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
189 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
191 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
192 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
194 InOrder inOrder = Mockito.inOrder(mockActorContext);
195 inOrder.verify(mockActorContext).executeOperationAsync(
196 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
198 inOrder.verify(mockActorContext).executeOperationAsync(
199 eq(actorSelection(actorRef)), eqSerializedReadData());
202 @Test(expected=IllegalStateException.class)
203 public void testReadPreConditionCheck() {
204 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
205 transactionProxy.read(TestModel.TEST_PATH);
208 @Test(expected=IllegalArgumentException.class)
209 public void testInvalidCreateTransactionReply() throws Throwable {
210 ActorRef actorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
212 doReturn(getSystem().actorSelection(actorRef.path())).when(mockActorContext).
213 actorSelection(actorRef.path().toString());
215 doReturn(primaryShardInfoReply(getSystem(), actorRef)).
216 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
218 doReturn(Futures.successful(new Object())).when(mockActorContext).executeOperationAsync(
219 eq(getSystem().actorSelection(actorRef.path())), eqCreateTransaction(memberName, READ_ONLY));
221 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
223 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
227 public void testExists() throws Exception {
228 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
230 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
232 doReturn(dataExistsSerializedReply(false)).when(mockActorContext).executeOperationAsync(
233 eq(actorSelection(actorRef)), eqSerializedDataExists());
235 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
237 assertEquals("Exists response", false, exists);
239 doReturn(dataExistsSerializedReply(true)).when(mockActorContext).executeOperationAsync(
240 eq(actorSelection(actorRef)), eqSerializedDataExists());
242 exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
244 assertEquals("Exists response", true, exists);
247 @Test(expected = PrimaryNotFoundException.class)
248 public void testExistsWhenAPrimaryNotFoundExceptionIsThrown() throws Throwable {
249 testExceptionOnInitialCreateTransaction(new PrimaryNotFoundException("test"), new Invoker() {
251 public CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception {
252 return proxy.exists(TestModel.TEST_PATH);
257 @Test(expected = ReadFailedException.class)
258 public void testExistsWithInvalidReplyMessageType() throws Exception {
259 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
261 doReturn(Futures.successful(new Object())).when(mockActorContext).
262 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedDataExists());
264 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
266 transactionProxy.exists(TestModel.TEST_PATH).checkedGet(5, TimeUnit.SECONDS);
269 @Test(expected = TestException.class)
270 public void testExistsWithAsyncRemoteOperatonFailure() throws Throwable {
271 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
273 doReturn(Futures.failed(new TestException())).when(mockActorContext).
274 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedDataExists());
276 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
278 propagateReadFailedExceptionCause(transactionProxy.exists(TestModel.TEST_PATH));
282 public void testExistsWithPriorRecordingOperationSuccessful() throws Throwable {
283 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
285 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
287 expectBatchedModifications(actorRef, 1);
289 doReturn(dataExistsSerializedReply(true)).when(mockActorContext).executeOperationAsync(
290 eq(actorSelection(actorRef)), eqSerializedDataExists());
292 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
294 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
296 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
298 assertEquals("Exists response", true, exists);
300 InOrder inOrder = Mockito.inOrder(mockActorContext);
301 inOrder.verify(mockActorContext).executeOperationAsync(
302 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
304 inOrder.verify(mockActorContext).executeOperationAsync(
305 eq(actorSelection(actorRef)), eqSerializedDataExists());
308 @Test(expected=IllegalStateException.class)
309 public void testExistsPreConditionCheck() {
310 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
311 transactionProxy.exists(TestModel.TEST_PATH);
315 public void testWrite() throws Exception {
316 dataStoreContextBuilder.shardBatchedModificationCount(1);
317 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
319 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
321 expectBatchedModifications(actorRef, 1);
323 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
325 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
327 verifyOneBatchedModification(actorRef, new WriteModification(TestModel.TEST_PATH, nodeToWrite), false);
331 public void testWriteAfterAsyncRead() throws Throwable {
332 ActorRef actorRef = setupActorContextWithoutInitialCreateTransaction(getSystem(), DefaultShardStrategy.DEFAULT_SHARD);
334 Promise<Object> createTxPromise = akka.dispatch.Futures.promise();
335 doReturn(createTxPromise).when(mockActorContext).executeOperationAsync(
336 eq(getSystem().actorSelection(actorRef.path())),
337 eqCreateTransaction(memberName, READ_WRITE));
339 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
340 eq(actorSelection(actorRef)), eqSerializedReadData());
342 expectBatchedModificationsReady(actorRef);
344 final NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
346 final TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
348 final CountDownLatch readComplete = new CountDownLatch(1);
349 final AtomicReference<Throwable> caughtEx = new AtomicReference<>();
350 com.google.common.util.concurrent.Futures.addCallback(transactionProxy.read(TestModel.TEST_PATH),
351 new FutureCallback<Optional<NormalizedNode<?, ?>>>() {
353 public void onSuccess(Optional<NormalizedNode<?, ?>> result) {
355 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
356 } catch (Exception e) {
359 readComplete.countDown();
364 public void onFailure(Throwable t) {
366 readComplete.countDown();
370 createTxPromise.success(createTransactionReply(actorRef, DataStoreVersions.CURRENT_VERSION));
372 Uninterruptibles.awaitUninterruptibly(readComplete, 5, TimeUnit.SECONDS);
374 if(caughtEx.get() != null) {
375 throw caughtEx.get();
378 // This sends the batched modification.
379 transactionProxy.ready();
381 verifyOneBatchedModification(actorRef, new WriteModification(TestModel.TEST_PATH, nodeToWrite), true);
384 @Test(expected=IllegalStateException.class)
385 public void testWritePreConditionCheck() {
386 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
387 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
390 @Test(expected=IllegalStateException.class)
391 public void testWriteAfterReadyPreConditionCheck() {
392 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
394 transactionProxy.ready();
396 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
400 public void testMerge() throws Exception {
401 dataStoreContextBuilder.shardBatchedModificationCount(1);
402 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
404 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
406 expectBatchedModifications(actorRef, 1);
408 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
410 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
412 verifyOneBatchedModification(actorRef, new MergeModification(TestModel.TEST_PATH, nodeToWrite), false);
416 public void testDelete() throws Exception {
417 dataStoreContextBuilder.shardBatchedModificationCount(1);
418 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
420 expectBatchedModifications(actorRef, 1);
422 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
424 transactionProxy.delete(TestModel.TEST_PATH);
426 verifyOneBatchedModification(actorRef, new DeleteModification(TestModel.TEST_PATH), false);
430 public void testReadWrite() throws Exception {
431 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
433 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
435 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
436 eq(actorSelection(actorRef)), eqSerializedReadData());
438 expectBatchedModifications(actorRef, 1);
440 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
442 transactionProxy.read(TestModel.TEST_PATH);
444 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
446 transactionProxy.read(TestModel.TEST_PATH);
448 transactionProxy.read(TestModel.TEST_PATH);
450 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
451 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
453 verifyBatchedModifications(batchedModifications.get(0), false,
454 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
458 public void testReadyWithReadWrite() throws Exception {
459 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
461 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
463 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
464 eq(actorSelection(actorRef)), eqSerializedReadData());
466 expectBatchedModificationsReady(actorRef, true);
468 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
470 transactionProxy.read(TestModel.TEST_PATH);
472 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
474 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
476 assertTrue(ready instanceof SingleCommitCohortProxy);
478 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
480 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
481 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
483 verifyBatchedModifications(batchedModifications.get(0), true, true,
484 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
486 assertEquals("getTotalMessageCount", 1, batchedModifications.get(0).getTotalMessagesSent());
490 public void testReadyWithNoModifications() throws Exception {
491 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
493 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
494 eq(actorSelection(actorRef)), eqSerializedReadData());
496 expectBatchedModificationsReady(actorRef, true);
498 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
500 transactionProxy.read(TestModel.TEST_PATH);
502 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
504 assertTrue(ready instanceof SingleCommitCohortProxy);
506 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
508 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
509 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
511 verifyBatchedModifications(batchedModifications.get(0), true, true);
515 public void testReadyWithMultipleShardWrites() throws Exception {
516 ActorRef actorRef1 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
518 ActorRef actorRef2 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY, "junk");
520 expectBatchedModificationsReady(actorRef1);
521 expectBatchedModificationsReady(actorRef2);
523 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
525 transactionProxy.write(TestModel.JUNK_PATH, ImmutableNodes.containerNode(TestModel.JUNK_QNAME));
526 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
528 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
530 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
532 verifyCohortFutures((ThreePhaseCommitCohortProxy)ready, actorSelection(actorRef1),
533 actorSelection(actorRef2));
537 public void testReadyWithWriteOnlyAndLastBatchPending() throws Exception {
538 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
540 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
542 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
544 expectBatchedModificationsReady(actorRef, true);
546 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
548 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
550 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
552 assertTrue(ready instanceof SingleCommitCohortProxy);
554 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
556 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
557 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
559 verifyBatchedModifications(batchedModifications.get(0), true, true,
560 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
562 verify(mockActorContext, never()).executeOperationAsync(eq(actorSelection(actorRef)),
563 isA(ReadyTransaction.SERIALIZABLE_CLASS));
567 public void testReadyWithWriteOnlyAndLastBatchEmpty() throws Exception {
568 dataStoreContextBuilder.shardBatchedModificationCount(1).writeOnlyTransactionOptimizationsEnabled(true);
569 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
571 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
573 expectBatchedModificationsReady(actorRef, true);
575 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
577 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
579 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
581 assertTrue(ready instanceof SingleCommitCohortProxy);
583 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
585 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
586 assertEquals("Captured BatchedModifications count", 2, batchedModifications.size());
588 verifyBatchedModifications(batchedModifications.get(0), false,
589 new WriteModification(TestModel.TEST_PATH, nodeToWrite));
591 verifyBatchedModifications(batchedModifications.get(1), true, true);
593 verify(mockActorContext, never()).executeOperationAsync(eq(actorSelection(actorRef)),
594 isA(ReadyTransaction.SERIALIZABLE_CLASS));
598 public void testReadyWithReplyFailure() throws Exception {
599 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
601 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
603 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
605 expectFailedBatchedModifications(actorRef);
607 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
609 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
611 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
613 assertTrue(ready instanceof SingleCommitCohortProxy);
615 verifyCohortFutures((SingleCommitCohortProxy)ready, TestException.class);
619 public void testReadyWithDebugContextEnabled() throws Exception {
620 dataStoreContextBuilder.transactionDebugContextEnabled(true);
622 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
624 expectBatchedModificationsReady(actorRef, true);
626 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
628 transactionProxy.merge(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
630 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
632 assertTrue(ready instanceof DebugThreePhaseCommitCohort);
634 verifyCohortFutures((DebugThreePhaseCommitCohort)ready, new CommitTransactionReply().toSerializable());
637 private void testWriteOnlyTxWithFindPrimaryShardFailure(Exception toThrow) throws Exception {
638 doReturn(Futures.failed(toThrow)).when(mockActorContext).findPrimaryShardAsync(anyString());
640 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
642 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
644 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
646 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
648 transactionProxy.delete(TestModel.TEST_PATH);
650 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
652 assertTrue(ready instanceof SingleCommitCohortProxy);
654 verifyCohortFutures((SingleCommitCohortProxy)ready, toThrow.getClass());
658 public void testWriteOnlyTxWithPrimaryNotFoundException() throws Exception {
659 testWriteOnlyTxWithFindPrimaryShardFailure(new PrimaryNotFoundException("mock"));
663 public void testWriteOnlyTxWithNotInitializedException() throws Exception {
664 testWriteOnlyTxWithFindPrimaryShardFailure(new NotInitializedException("mock"));
668 public void testWriteOnlyTxWithNoShardLeaderException() throws Exception {
669 testWriteOnlyTxWithFindPrimaryShardFailure(new NoShardLeaderException("mock"));
673 public void testReadyWithInvalidReplyMessageType() throws Exception {
674 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
675 ActorRef actorRef1 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
677 ActorRef actorRef2 = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY, "junk");
679 doReturn(Futures.successful(new Object())).when(mockActorContext).
680 executeOperationAsync(eq(actorSelection(actorRef1)), isA(BatchedModifications.class));
682 expectBatchedModificationsReady(actorRef2);
684 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, WRITE_ONLY);
686 transactionProxy.write(TestModel.JUNK_PATH, ImmutableNodes.containerNode(TestModel.JUNK_QNAME));
687 transactionProxy.write(TestModel.TEST_PATH, ImmutableNodes.containerNode(TestModel.TEST_QNAME));
689 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
691 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
693 verifyCohortFutures((ThreePhaseCommitCohortProxy)ready, actorSelection(actorRef2),
694 IllegalArgumentException.class);
698 public void testGetIdentifier() {
699 setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
700 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
702 Object id = transactionProxy.getIdentifier();
703 assertNotNull("getIdentifier returned null", id);
704 assertTrue("Invalid identifier: " + id, id.toString().startsWith(memberName));
708 public void testClose() throws Exception{
709 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
711 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
712 eq(actorSelection(actorRef)), eqSerializedReadData());
714 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
716 transactionProxy.read(TestModel.TEST_PATH);
718 transactionProxy.close();
720 verify(mockActorContext).sendOperationAsync(
721 eq(actorSelection(actorRef)), isA(CloseTransaction.SERIALIZABLE_CLASS));
726 * Method to test a local Tx actor. The Tx paths are matched to decide if the
727 * Tx actor is local or not. This is done by mocking the Tx actor path
728 * and the caller paths and ensuring that the paths have the remote-address format
730 * Note: Since the default akka provider for test is not a RemoteActorRefProvider,
731 * the paths returned for the actors for all the tests are not qualified remote paths.
732 * Hence are treated as non-local/remote actors. In short, all tests except
733 * few below run for remote actors
738 public void testLocalTxActorRead() throws Exception {
739 setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
740 doReturn(true).when(mockActorContext).isPathLocal(anyString());
742 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
744 // negative test case with null as the reply
745 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
746 any(ActorSelection.class), eqReadData());
748 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
749 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
751 assertEquals("NormalizedNode isPresent", false, readOptional.isPresent());
753 // test case with node as read data reply
754 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
756 doReturn(readDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
757 any(ActorSelection.class), eqReadData());
759 readOptional = transactionProxy.read(TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
761 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
763 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
765 // test for local data exists
766 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
767 any(ActorSelection.class), eqDataExists());
769 boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
771 assertEquals("Exists response", true, exists);
775 public void testLocalTxActorReady() throws Exception {
776 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
777 doReturn(true).when(mockActorContext).isPathLocal(anyString());
779 expectBatchedModificationsReady(actorRef, true);
781 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
783 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
784 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
786 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
788 assertTrue(ready instanceof SingleCommitCohortProxy);
790 verifyCohortFutures((SingleCommitCohortProxy)ready, new CommitTransactionReply().toSerializable());
793 private static interface TransactionProxyOperation {
794 void run(TransactionProxy transactionProxy);
797 private void throttleOperation(TransactionProxyOperation operation) {
798 throttleOperation(operation, 1, true);
801 private PrimaryShardInfo newPrimaryShardInfo(ActorRef actorRef){
802 return new PrimaryShardInfo(getSystem().actorSelection(actorRef.path()), DataStoreVersions.CURRENT_VERSION,
803 Optional.<DataTree>absent());
806 private PrimaryShardInfo newPrimaryShardInfo(ActorRef actorRef, Optional<DataTree> dataTreeOptional){
807 return new PrimaryShardInfo(getSystem().actorSelection(actorRef.path()), DataStoreVersions.CURRENT_VERSION,
812 private void throttleOperation(TransactionProxyOperation operation, int outstandingOpsLimit, boolean shardFound){
813 ActorSystem actorSystem = getSystem();
814 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
816 doReturn(outstandingOpsLimit).when(mockActorContext).getTransactionOutstandingOperationLimit();
818 doReturn(actorSystem.actorSelection(shardActorRef.path())).
819 when(mockActorContext).actorSelection(shardActorRef.path().toString());
822 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef))).
823 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
825 doReturn(Futures.failed(new Exception("not found")))
826 .when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
829 String actorPath = "akka.tcp://system@127.0.0.1:2550/user/tx-actor";
830 CreateTransactionReply createTransactionReply = CreateTransactionReply.newBuilder().
831 setTransactionId("txn-1").setTransactionActorPath(actorPath).
832 setMessageVersion(DataStoreVersions.CURRENT_VERSION).build();
834 doReturn(Futures.successful(createTransactionReply)).when(mockActorContext).
835 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
836 eqCreateTransaction(memberName, READ_WRITE));
838 doReturn(true).when(mockActorContext).isPathLocal(actorPath);
840 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
842 long start = System.nanoTime();
844 operation.run(transactionProxy);
846 long end = System.nanoTime();
848 long expected = TimeUnit.SECONDS.toNanos(mockActorContext.getDatastoreContext().getOperationTimeoutInSeconds());
849 Assert.assertTrue(String.format("Expected elapsed time: %s. Actual: %s",
850 expected, (end-start)), (end - start) > expected);
854 private void completeOperation(TransactionProxyOperation operation){
855 completeOperation(operation, true);
858 private void completeOperation(TransactionProxyOperation operation, boolean shardFound){
859 ActorSystem actorSystem = getSystem();
860 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
862 doReturn(1).when(mockActorContext).getTransactionOutstandingOperationLimit();
864 doReturn(actorSystem.actorSelection(shardActorRef.path())).
865 when(mockActorContext).actorSelection(shardActorRef.path().toString());
868 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef))).
869 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
871 doReturn(Futures.failed(new PrimaryNotFoundException("test")))
872 .when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
875 ActorRef txActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
876 String actorPath = txActorRef.path().toString();
877 CreateTransactionReply createTransactionReply = CreateTransactionReply.newBuilder().
878 setTransactionId("txn-1").setTransactionActorPath(actorPath).
879 setMessageVersion(DataStoreVersions.CURRENT_VERSION).build();
881 doReturn(actorSystem.actorSelection(actorPath)).when(mockActorContext).actorSelection(actorPath);
883 doReturn(Futures.successful(createTransactionReply)).when(mockActorContext).
884 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
885 eqCreateTransaction(memberName, READ_WRITE));
887 doReturn(true).when(mockActorContext).isPathLocal(anyString());
889 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
891 long start = System.nanoTime();
893 operation.run(transactionProxy);
895 long end = System.nanoTime();
897 long expected = TimeUnit.SECONDS.toNanos(mockActorContext.getDatastoreContext().getOperationTimeoutInSeconds());
898 Assert.assertTrue(String.format("Expected elapsed time: %s. Actual: %s",
899 expected, (end-start)), (end - start) <= expected);
902 private void completeOperationLocal(TransactionProxyOperation operation, Optional<DataTree> dataTreeOptional){
903 ActorSystem actorSystem = getSystem();
904 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
906 doReturn(1).when(mockActorContext).getTransactionOutstandingOperationLimit();
908 doReturn(actorSystem.actorSelection(shardActorRef.path())).
909 when(mockActorContext).actorSelection(shardActorRef.path().toString());
911 doReturn(Futures.successful(newPrimaryShardInfo(shardActorRef, dataTreeOptional))).
912 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
914 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
916 long start = System.nanoTime();
918 operation.run(transactionProxy);
920 long end = System.nanoTime();
922 long expected = TimeUnit.SECONDS.toNanos(mockActorContext.getDatastoreContext().getOperationTimeoutInSeconds());
923 Assert.assertTrue(String.format("Expected elapsed time: %s. Actual: %s",
924 expected, (end-start)), (end - start) <= expected);
927 private Optional<DataTree> createDataTree(){
928 DataTree dataTree = mock(DataTree.class);
929 Optional<DataTree> dataTreeOptional = Optional.of(dataTree);
930 DataTreeSnapshot dataTreeSnapshot = mock(DataTreeSnapshot.class);
931 DataTreeModification dataTreeModification = mock(DataTreeModification.class);
933 doReturn(dataTreeSnapshot).when(dataTree).takeSnapshot();
934 doReturn(dataTreeModification).when(dataTreeSnapshot).newModification();
936 return dataTreeOptional;
939 private Optional<DataTree> createDataTree(NormalizedNode readResponse){
940 DataTree dataTree = mock(DataTree.class);
941 Optional<DataTree> dataTreeOptional = Optional.of(dataTree);
942 DataTreeSnapshot dataTreeSnapshot = mock(DataTreeSnapshot.class);
943 DataTreeModification dataTreeModification = mock(DataTreeModification.class);
945 doReturn(dataTreeSnapshot).when(dataTree).takeSnapshot();
946 doReturn(dataTreeModification).when(dataTreeSnapshot).newModification();
947 doReturn(Optional.of(readResponse)).when(dataTreeModification).readNode(any(YangInstanceIdentifier.class));
949 return dataTreeOptional;
954 public void testWriteCompletionForLocalShard(){
955 dataStoreContextBuilder.shardBatchedModificationCount(1);
956 completeOperationLocal(new TransactionProxyOperation() {
958 public void run(TransactionProxy transactionProxy) {
959 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
961 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
963 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
966 }, createDataTree());
970 public void testWriteThrottlingWhenShardFound(){
971 dataStoreContextBuilder.shardBatchedModificationCount(1);
972 throttleOperation(new TransactionProxyOperation() {
974 public void run(TransactionProxy transactionProxy) {
975 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
977 expectIncompleteBatchedModifications();
979 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
981 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
987 public void testWriteThrottlingWhenShardNotFound(){
988 // Confirm that there is no throttling when the Shard is not found
989 dataStoreContextBuilder.shardBatchedModificationCount(1);
990 completeOperation(new TransactionProxyOperation() {
992 public void run(TransactionProxy transactionProxy) {
993 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
995 expectBatchedModifications(2);
997 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
999 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1007 public void testWriteCompletion(){
1008 dataStoreContextBuilder.shardBatchedModificationCount(1);
1009 completeOperation(new TransactionProxyOperation() {
1011 public void run(TransactionProxy transactionProxy) {
1012 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1014 expectBatchedModifications(2);
1016 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1018 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1024 public void testMergeThrottlingWhenShardFound(){
1025 dataStoreContextBuilder.shardBatchedModificationCount(1);
1026 throttleOperation(new TransactionProxyOperation() {
1028 public void run(TransactionProxy transactionProxy) {
1029 NormalizedNode<?, ?> nodeToMerge = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1031 expectIncompleteBatchedModifications();
1033 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1035 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1041 public void testMergeThrottlingWhenShardNotFound(){
1042 dataStoreContextBuilder.shardBatchedModificationCount(1);
1043 completeOperation(new TransactionProxyOperation() {
1045 public void run(TransactionProxy transactionProxy) {
1046 NormalizedNode<?, ?> nodeToMerge = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1048 expectBatchedModifications(2);
1050 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1052 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1058 public void testMergeCompletion(){
1059 dataStoreContextBuilder.shardBatchedModificationCount(1);
1060 completeOperation(new TransactionProxyOperation() {
1062 public void run(TransactionProxy transactionProxy) {
1063 NormalizedNode<?, ?> nodeToMerge = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1065 expectBatchedModifications(2);
1067 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1069 transactionProxy.merge(TestModel.TEST_PATH, nodeToMerge);
1076 public void testMergeCompletionForLocalShard(){
1077 dataStoreContextBuilder.shardBatchedModificationCount(1);
1078 completeOperationLocal(new TransactionProxyOperation() {
1080 public void run(TransactionProxy transactionProxy) {
1081 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1083 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
1085 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
1088 }, createDataTree());
1093 public void testDeleteThrottlingWhenShardFound(){
1095 throttleOperation(new TransactionProxyOperation() {
1097 public void run(TransactionProxy transactionProxy) {
1098 expectIncompleteBatchedModifications();
1100 transactionProxy.delete(TestModel.TEST_PATH);
1102 transactionProxy.delete(TestModel.TEST_PATH);
1109 public void testDeleteThrottlingWhenShardNotFound(){
1111 completeOperation(new TransactionProxyOperation() {
1113 public void run(TransactionProxy transactionProxy) {
1114 expectBatchedModifications(2);
1116 transactionProxy.delete(TestModel.TEST_PATH);
1118 transactionProxy.delete(TestModel.TEST_PATH);
1124 public void testDeleteCompletionForLocalShard(){
1125 dataStoreContextBuilder.shardBatchedModificationCount(1);
1126 completeOperationLocal(new TransactionProxyOperation() {
1128 public void run(TransactionProxy transactionProxy) {
1130 transactionProxy.delete(TestModel.TEST_PATH);
1132 transactionProxy.delete(TestModel.TEST_PATH);
1134 }, createDataTree());
1139 public void testDeleteCompletion(){
1140 dataStoreContextBuilder.shardBatchedModificationCount(1);
1141 completeOperation(new TransactionProxyOperation() {
1143 public void run(TransactionProxy transactionProxy) {
1144 expectBatchedModifications(2);
1146 transactionProxy.delete(TestModel.TEST_PATH);
1148 transactionProxy.delete(TestModel.TEST_PATH);
1155 public void testReadThrottlingWhenShardFound(){
1157 throttleOperation(new TransactionProxyOperation() {
1159 public void run(TransactionProxy transactionProxy) {
1160 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1161 any(ActorSelection.class), eqReadData());
1163 transactionProxy.read(TestModel.TEST_PATH);
1165 transactionProxy.read(TestModel.TEST_PATH);
1171 public void testReadThrottlingWhenShardNotFound(){
1173 completeOperation(new TransactionProxyOperation() {
1175 public void run(TransactionProxy transactionProxy) {
1176 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1177 any(ActorSelection.class), eqReadData());
1179 transactionProxy.read(TestModel.TEST_PATH);
1181 transactionProxy.read(TestModel.TEST_PATH);
1188 public void testReadCompletion(){
1189 completeOperation(new TransactionProxyOperation() {
1191 public void run(TransactionProxy transactionProxy) {
1192 NormalizedNode<?, ?> nodeToRead = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1194 doReturn(readDataReply(nodeToRead)).when(mockActorContext).executeOperationAsync(
1195 any(ActorSelection.class), eqReadData());
1197 transactionProxy.read(TestModel.TEST_PATH);
1199 transactionProxy.read(TestModel.TEST_PATH);
1206 public void testReadCompletionForLocalShard(){
1207 final NormalizedNode nodeToRead = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1208 completeOperationLocal(new TransactionProxyOperation() {
1210 public void run(TransactionProxy transactionProxy) {
1211 transactionProxy.read(TestModel.TEST_PATH);
1213 transactionProxy.read(TestModel.TEST_PATH);
1215 }, createDataTree(nodeToRead));
1220 public void testReadCompletionForLocalShardWhenExceptionOccurs(){
1221 completeOperationLocal(new TransactionProxyOperation() {
1223 public void run(TransactionProxy transactionProxy) {
1224 transactionProxy.read(TestModel.TEST_PATH);
1226 transactionProxy.read(TestModel.TEST_PATH);
1228 }, createDataTree());
1233 public void testExistsThrottlingWhenShardFound(){
1235 throttleOperation(new TransactionProxyOperation() {
1237 public void run(TransactionProxy transactionProxy) {
1238 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1239 any(ActorSelection.class), eqDataExists());
1241 transactionProxy.exists(TestModel.TEST_PATH);
1243 transactionProxy.exists(TestModel.TEST_PATH);
1249 public void testExistsThrottlingWhenShardNotFound(){
1251 completeOperation(new TransactionProxyOperation() {
1253 public void run(TransactionProxy transactionProxy) {
1254 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1255 any(ActorSelection.class), eqDataExists());
1257 transactionProxy.exists(TestModel.TEST_PATH);
1259 transactionProxy.exists(TestModel.TEST_PATH);
1266 public void testExistsCompletion(){
1267 completeOperation(new TransactionProxyOperation() {
1269 public void run(TransactionProxy transactionProxy) {
1270 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
1271 any(ActorSelection.class), eqDataExists());
1273 transactionProxy.exists(TestModel.TEST_PATH);
1275 transactionProxy.exists(TestModel.TEST_PATH);
1282 public void testExistsCompletionForLocalShard(){
1283 final NormalizedNode nodeToRead = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1284 completeOperationLocal(new TransactionProxyOperation() {
1286 public void run(TransactionProxy transactionProxy) {
1287 transactionProxy.exists(TestModel.TEST_PATH);
1289 transactionProxy.exists(TestModel.TEST_PATH);
1291 }, createDataTree(nodeToRead));
1296 public void testExistsCompletionForLocalShardWhenExceptionOccurs(){
1297 completeOperationLocal(new TransactionProxyOperation() {
1299 public void run(TransactionProxy transactionProxy) {
1300 transactionProxy.exists(TestModel.TEST_PATH);
1302 transactionProxy.exists(TestModel.TEST_PATH);
1304 }, createDataTree());
1308 public void testReadyThrottling(){
1310 throttleOperation(new TransactionProxyOperation() {
1312 public void run(TransactionProxy transactionProxy) {
1313 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1315 expectBatchedModifications(1);
1317 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1318 any(ActorSelection.class), any(ReadyTransaction.class));
1320 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1322 transactionProxy.ready();
1328 public void testReadyThrottlingWithTwoTransactionContexts(){
1330 throttleOperation(new TransactionProxyOperation() {
1332 public void run(TransactionProxy transactionProxy) {
1333 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1334 NormalizedNode<?, ?> carsNode = ImmutableNodes.containerNode(CarsModel.BASE_QNAME);
1336 expectBatchedModifications(2);
1338 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
1339 any(ActorSelection.class), any(ReadyTransaction.class));
1341 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1343 transactionProxy.write(TestModel.TEST_PATH, carsNode);
1345 transactionProxy.ready();
1350 private void testModificationOperationBatching(TransactionType type) throws Exception {
1351 int shardBatchedModificationCount = 3;
1352 dataStoreContextBuilder.shardBatchedModificationCount(shardBatchedModificationCount);
1354 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), type);
1356 expectBatchedModifications(actorRef, shardBatchedModificationCount);
1358 YangInstanceIdentifier writePath1 = TestModel.TEST_PATH;
1359 NormalizedNode<?, ?> writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1361 YangInstanceIdentifier writePath2 = TestModel.OUTER_LIST_PATH;
1362 NormalizedNode<?, ?> writeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME);
1364 YangInstanceIdentifier writePath3 = TestModel.INNER_LIST_PATH;
1365 NormalizedNode<?, ?> writeNode3 = ImmutableNodes.containerNode(TestModel.INNER_LIST_QNAME);
1367 YangInstanceIdentifier mergePath1 = TestModel.TEST_PATH;
1368 NormalizedNode<?, ?> mergeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1370 YangInstanceIdentifier mergePath2 = TestModel.OUTER_LIST_PATH;
1371 NormalizedNode<?, ?> mergeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME);
1373 YangInstanceIdentifier mergePath3 = TestModel.INNER_LIST_PATH;
1374 NormalizedNode<?, ?> mergeNode3 = ImmutableNodes.containerNode(TestModel.INNER_LIST_QNAME);
1376 YangInstanceIdentifier deletePath1 = TestModel.TEST_PATH;
1377 YangInstanceIdentifier deletePath2 = TestModel.OUTER_LIST_PATH;
1379 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, type);
1381 transactionProxy.write(writePath1, writeNode1);
1382 transactionProxy.write(writePath2, writeNode2);
1383 transactionProxy.delete(deletePath1);
1384 transactionProxy.merge(mergePath1, mergeNode1);
1385 transactionProxy.merge(mergePath2, mergeNode2);
1386 transactionProxy.write(writePath3, writeNode3);
1387 transactionProxy.merge(mergePath3, mergeNode3);
1388 transactionProxy.delete(deletePath2);
1390 // This sends the last batch.
1391 transactionProxy.ready();
1393 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
1394 assertEquals("Captured BatchedModifications count", 3, batchedModifications.size());
1396 verifyBatchedModifications(batchedModifications.get(0), false, new WriteModification(writePath1, writeNode1),
1397 new WriteModification(writePath2, writeNode2), new DeleteModification(deletePath1));
1399 verifyBatchedModifications(batchedModifications.get(1), false, new MergeModification(mergePath1, mergeNode1),
1400 new MergeModification(mergePath2, mergeNode2), new WriteModification(writePath3, writeNode3));
1402 verifyBatchedModifications(batchedModifications.get(2), true, true,
1403 new MergeModification(mergePath3, mergeNode3), new DeleteModification(deletePath2));
1405 assertEquals("getTotalMessageCount", 3, batchedModifications.get(2).getTotalMessagesSent());
1409 public void testReadWriteModificationOperationBatching() throws Throwable {
1410 testModificationOperationBatching(READ_WRITE);
1414 public void testWriteOnlyModificationOperationBatching() throws Throwable {
1415 testModificationOperationBatching(WRITE_ONLY);
1419 public void testOptimizedWriteOnlyModificationOperationBatching() throws Throwable {
1420 dataStoreContextBuilder.writeOnlyTransactionOptimizationsEnabled(true);
1421 testModificationOperationBatching(WRITE_ONLY);
1425 public void testModificationOperationBatchingWithInterleavedReads() throws Throwable {
1427 int shardBatchedModificationCount = 10;
1428 dataStoreContextBuilder.shardBatchedModificationCount(shardBatchedModificationCount);
1430 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
1432 expectBatchedModifications(actorRef, shardBatchedModificationCount);
1434 YangInstanceIdentifier writePath1 = TestModel.TEST_PATH;
1435 NormalizedNode<?, ?> writeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1437 YangInstanceIdentifier writePath2 = TestModel.OUTER_LIST_PATH;
1438 NormalizedNode<?, ?> writeNode2 = ImmutableNodes.containerNode(TestModel.OUTER_LIST_QNAME);
1440 YangInstanceIdentifier mergePath1 = TestModel.TEST_PATH;
1441 NormalizedNode<?, ?> mergeNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1443 YangInstanceIdentifier mergePath2 = TestModel.INNER_LIST_PATH;
1444 NormalizedNode<?, ?> mergeNode2 = ImmutableNodes.containerNode(TestModel.INNER_LIST_QNAME);
1446 YangInstanceIdentifier deletePath = TestModel.OUTER_LIST_PATH;
1448 doReturn(readSerializedDataReply(writeNode2)).when(mockActorContext).executeOperationAsync(
1449 eq(actorSelection(actorRef)), eqSerializedReadData(writePath2));
1451 doReturn(readSerializedDataReply(mergeNode2)).when(mockActorContext).executeOperationAsync(
1452 eq(actorSelection(actorRef)), eqSerializedReadData(mergePath2));
1454 doReturn(dataExistsSerializedReply(true)).when(mockActorContext).executeOperationAsync(
1455 eq(actorSelection(actorRef)), eqSerializedDataExists());
1457 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_WRITE);
1459 transactionProxy.write(writePath1, writeNode1);
1460 transactionProxy.write(writePath2, writeNode2);
1462 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(writePath2).
1463 get(5, TimeUnit.SECONDS);
1465 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1466 assertEquals("Response NormalizedNode", writeNode2, readOptional.get());
1468 transactionProxy.merge(mergePath1, mergeNode1);
1469 transactionProxy.merge(mergePath2, mergeNode2);
1471 readOptional = transactionProxy.read(mergePath2).get(5, TimeUnit.SECONDS);
1473 transactionProxy.delete(deletePath);
1475 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
1476 assertEquals("Exists response", true, exists);
1478 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1479 assertEquals("Response NormalizedNode", mergeNode2, readOptional.get());
1481 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
1482 assertEquals("Captured BatchedModifications count", 3, batchedModifications.size());
1484 verifyBatchedModifications(batchedModifications.get(0), false, new WriteModification(writePath1, writeNode1),
1485 new WriteModification(writePath2, writeNode2));
1487 verifyBatchedModifications(batchedModifications.get(1), false, new MergeModification(mergePath1, mergeNode1),
1488 new MergeModification(mergePath2, mergeNode2));
1490 verifyBatchedModifications(batchedModifications.get(2), false, new DeleteModification(deletePath));
1492 InOrder inOrder = Mockito.inOrder(mockActorContext);
1493 inOrder.verify(mockActorContext).executeOperationAsync(
1494 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
1496 inOrder.verify(mockActorContext).executeOperationAsync(
1497 eq(actorSelection(actorRef)), eqSerializedReadData(writePath2));
1499 inOrder.verify(mockActorContext).executeOperationAsync(
1500 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
1502 inOrder.verify(mockActorContext).executeOperationAsync(
1503 eq(actorSelection(actorRef)), eqSerializedReadData(mergePath2));
1505 inOrder.verify(mockActorContext).executeOperationAsync(
1506 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
1508 inOrder.verify(mockActorContext).executeOperationAsync(
1509 eq(actorSelection(actorRef)), eqSerializedDataExists());
1513 public void testReadRoot() throws ReadFailedException, InterruptedException, ExecutionException, java.util.concurrent.TimeoutException {
1515 SchemaContext schemaContext = SchemaContextHelper.full();
1516 Configuration configuration = mock(Configuration.class);
1517 doReturn(configuration).when(mockActorContext).getConfiguration();
1518 doReturn(schemaContext).when(mockActorContext).getSchemaContext();
1519 doReturn(Sets.newHashSet("test", "cars")).when(configuration).getAllShardNames();
1521 NormalizedNode<?, ?> expectedNode1 = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1522 NormalizedNode<?, ?> expectedNode2 = ImmutableNodes.containerNode(CarsModel.CARS_QNAME);
1524 setUpReadData("test", NormalizedNodeAggregatorTest.getRootNode(expectedNode1, schemaContext));
1525 setUpReadData("cars", NormalizedNodeAggregatorTest.getRootNode(expectedNode2, schemaContext));
1527 doReturn(memberName).when(mockActorContext).getCurrentMemberName();
1529 doReturn(10).when(mockActorContext).getTransactionOutstandingOperationLimit();
1531 doReturn(getSystem().dispatchers().defaultGlobalDispatcher()).when(mockActorContext).getClientDispatcher();
1533 TransactionProxy transactionProxy = new TransactionProxy(mockComponentFactory, READ_ONLY);
1535 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
1536 YangInstanceIdentifier.builder().build()).get(5, TimeUnit.SECONDS);
1538 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1540 NormalizedNode<?, ?> normalizedNode = readOptional.get();
1542 assertTrue("Expect value to be a Collection", normalizedNode.getValue() instanceof Collection);
1544 Collection<NormalizedNode<?,?>> collection = (Collection<NormalizedNode<?,?>>) normalizedNode.getValue();
1546 for(NormalizedNode<?,?> node : collection){
1547 assertTrue("Expected " + node + " to be a ContainerNode", node instanceof ContainerNode);
1550 assertTrue("Child with QName = " + TestModel.TEST_QNAME + " not found",
1551 NormalizedNodeAggregatorTest.findChildWithQName(collection, TestModel.TEST_QNAME) != null);
1553 assertEquals(expectedNode1, NormalizedNodeAggregatorTest.findChildWithQName(collection, TestModel.TEST_QNAME));
1555 assertTrue("Child with QName = " + CarsModel.BASE_QNAME + " not found",
1556 NormalizedNodeAggregatorTest.findChildWithQName(collection, CarsModel.BASE_QNAME) != null);
1558 assertEquals(expectedNode2, NormalizedNodeAggregatorTest.findChildWithQName(collection, CarsModel.BASE_QNAME));
1562 private void setUpReadData(String shardName, NormalizedNode<?, ?> expectedNode) {
1563 ActorSystem actorSystem = getSystem();
1564 ActorRef shardActorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
1566 doReturn(getSystem().actorSelection(shardActorRef.path())).
1567 when(mockActorContext).actorSelection(shardActorRef.path().toString());
1569 doReturn(primaryShardInfoReply(getSystem(), shardActorRef)).
1570 when(mockActorContext).findPrimaryShardAsync(eq(shardName));
1572 doReturn(true).when(mockActorContext).isPathLocal(shardActorRef.path().toString());
1574 ActorRef txActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
1576 doReturn(actorSystem.actorSelection(txActorRef.path())).
1577 when(mockActorContext).actorSelection(txActorRef.path().toString());
1579 doReturn(Futures.successful(createTransactionReply(txActorRef, DataStoreVersions.CURRENT_VERSION))).when(mockActorContext).
1580 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
1581 eqCreateTransaction(memberName, TransactionType.READ_ONLY));
1583 doReturn(readSerializedDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
1584 eq(actorSelection(txActorRef)), eqSerializedReadData(YangInstanceIdentifier.builder().build()));