1 package org.opendaylight.controller.cluster.datastore;
3 import akka.actor.ActorRef;
4 import akka.actor.ActorSelection;
5 import akka.actor.ActorSystem;
6 import akka.actor.Props;
7 import akka.dispatch.Futures;
8 import akka.testkit.JavaTestKit;
9 import com.google.common.base.Optional;
10 import com.google.common.collect.ImmutableMap;
11 import com.google.common.util.concurrent.CheckedFuture;
12 import com.typesafe.config.Config;
13 import com.typesafe.config.ConfigFactory;
14 import org.junit.AfterClass;
15 import org.junit.Before;
16 import org.junit.BeforeClass;
17 import org.junit.Test;
18 import org.mockito.ArgumentMatcher;
19 import org.mockito.Mock;
20 import org.mockito.MockitoAnnotations;
21 import org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType;
22 import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException;
23 import org.opendaylight.controller.cluster.datastore.exceptions.TimeoutException;
24 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
25 import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
26 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
27 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
28 import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
29 import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
30 import org.opendaylight.controller.cluster.datastore.messages.MergeData;
31 import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
32 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
33 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
34 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
35 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
36 import org.opendaylight.controller.cluster.datastore.messages.WriteData;
37 import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
38 import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy;
39 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
40 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
41 import org.opendaylight.controller.cluster.datastore.utils.DoNothingActor;
42 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
43 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
44 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
45 import org.opendaylight.controller.protobuff.messages.transaction.ShardTransactionMessages.CreateTransactionReply;
46 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
48 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
50 import scala.concurrent.Await;
51 import scala.concurrent.Future;
52 import scala.concurrent.duration.Duration;
53 import java.io.IOException;
54 import java.util.List;
55 import java.util.concurrent.TimeUnit;
56 import static org.junit.Assert.assertEquals;
57 import static org.junit.Assert.assertNotNull;
58 import static org.junit.Assert.assertTrue;
59 import static org.junit.Assert.fail;
60 import static org.mockito.Matchers.any;
61 import static org.mockito.Matchers.anyString;
62 import static org.mockito.Mockito.argThat;
63 import static org.mockito.Mockito.doReturn;
64 import static org.mockito.Mockito.eq;
65 import static org.mockito.Mockito.isA;
66 import static org.mockito.Mockito.times;
67 import static org.mockito.Mockito.verify;
68 import static org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType.READ_ONLY;
69 import static org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType.READ_WRITE;
70 import static org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType.WRITE_ONLY;
72 @SuppressWarnings("resource")
73 public class TransactionProxyTest {
75 @SuppressWarnings("serial")
76 static class TestException extends RuntimeException {
79 static interface Invoker {
80 CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception;
83 private static ActorSystem system;
85 private final Configuration configuration = new MockConfiguration();
88 private ActorContext mockActorContext;
90 private SchemaContext schemaContext;
93 private ClusterWrapper mockClusterWrapper;
95 String memberName = "mock-member";
98 public static void setUpClass() throws IOException {
100 Config config = ConfigFactory.parseMap(ImmutableMap.<String, Object>builder().
101 put("akka.actor.default-dispatcher.type",
102 "akka.testkit.CallingThreadDispatcherConfigurator").build()).
103 withFallback(ConfigFactory.load());
104 system = ActorSystem.create("test", config);
108 public static void tearDownClass() throws IOException {
109 JavaTestKit.shutdownActorSystem(system);
115 MockitoAnnotations.initMocks(this);
117 schemaContext = TestModel.createTestContext();
119 DatastoreContext dataStoreContext = DatastoreContext.newBuilder().build();
121 doReturn(getSystem()).when(mockActorContext).getActorSystem();
122 doReturn(memberName).when(mockActorContext).getCurrentMemberName();
123 doReturn(schemaContext).when(mockActorContext).getSchemaContext();
124 doReturn(mockClusterWrapper).when(mockActorContext).getClusterWrapper();
125 doReturn(mockClusterWrapper).when(mockActorContext).getClusterWrapper();
126 doReturn(dataStoreContext).when(mockActorContext).getDatastoreContext();
128 ShardStrategyFactory.setConfiguration(configuration);
131 private ActorSystem getSystem() {
135 private CreateTransaction eqCreateTransaction(final String memberName,
136 final TransactionType type) {
137 ArgumentMatcher<CreateTransaction> matcher = new ArgumentMatcher<CreateTransaction>() {
139 public boolean matches(Object argument) {
140 CreateTransaction obj = CreateTransaction.fromSerializable(argument);
141 return obj.getTransactionId().startsWith(memberName) &&
142 obj.getTransactionType() == type.ordinal();
146 return argThat(matcher);
149 private DataExists eqSerializedDataExists() {
150 ArgumentMatcher<DataExists> matcher = new ArgumentMatcher<DataExists>() {
152 public boolean matches(Object argument) {
153 return DataExists.SERIALIZABLE_CLASS.equals(argument.getClass()) &&
154 DataExists.fromSerializable(argument).getPath().equals(TestModel.TEST_PATH);
158 return argThat(matcher);
161 private DataExists eqDataExists() {
162 ArgumentMatcher<DataExists> matcher = new ArgumentMatcher<DataExists>() {
164 public boolean matches(Object argument) {
165 return (argument instanceof DataExists) &&
166 ((DataExists)argument).getPath().equals(TestModel.TEST_PATH);
170 return argThat(matcher);
173 private ReadData eqSerializedReadData() {
174 ArgumentMatcher<ReadData> matcher = new ArgumentMatcher<ReadData>() {
176 public boolean matches(Object argument) {
177 return ReadData.SERIALIZABLE_CLASS.equals(argument.getClass()) &&
178 ReadData.fromSerializable(argument).getPath().equals(TestModel.TEST_PATH);
182 return argThat(matcher);
185 private ReadData eqReadData() {
186 ArgumentMatcher<ReadData> matcher = new ArgumentMatcher<ReadData>() {
188 public boolean matches(Object argument) {
189 return (argument instanceof ReadData) &&
190 ((ReadData)argument).getPath().equals(TestModel.TEST_PATH);
194 return argThat(matcher);
197 private WriteData eqSerializedWriteData(final NormalizedNode<?, ?> nodeToWrite) {
198 ArgumentMatcher<WriteData> matcher = new ArgumentMatcher<WriteData>() {
200 public boolean matches(Object argument) {
201 if(!WriteData.SERIALIZABLE_CLASS.equals(argument.getClass())) {
205 WriteData obj = WriteData.fromSerializable(argument, schemaContext);
206 return obj.getPath().equals(TestModel.TEST_PATH) &&
207 obj.getData().equals(nodeToWrite);
211 return argThat(matcher);
214 private WriteData eqWriteData(final NormalizedNode<?, ?> nodeToWrite) {
215 ArgumentMatcher<WriteData> matcher = new ArgumentMatcher<WriteData>() {
217 public boolean matches(Object argument) {
218 if(argument instanceof WriteData) {
219 WriteData obj = (WriteData) argument;
220 return obj.getPath().equals(TestModel.TEST_PATH) &&
221 obj.getData().equals(nodeToWrite);
227 return argThat(matcher);
230 private MergeData eqSerializedMergeData(final NormalizedNode<?, ?> nodeToWrite) {
231 ArgumentMatcher<MergeData> matcher = new ArgumentMatcher<MergeData>() {
233 public boolean matches(Object argument) {
234 if(!MergeData.SERIALIZABLE_CLASS.equals(argument.getClass())) {
238 MergeData obj = MergeData.fromSerializable(argument, schemaContext);
239 return obj.getPath().equals(TestModel.TEST_PATH) &&
240 obj.getData().equals(nodeToWrite);
244 return argThat(matcher);
247 private MergeData eqMergeData(final NormalizedNode<?, ?> nodeToWrite) {
248 ArgumentMatcher<MergeData> matcher = new ArgumentMatcher<MergeData>() {
250 public boolean matches(Object argument) {
251 if(argument instanceof MergeData) {
252 MergeData obj = ((MergeData) argument);
253 return obj.getPath().equals(TestModel.TEST_PATH) &&
254 obj.getData().equals(nodeToWrite);
261 return argThat(matcher);
264 private DeleteData eqSerializedDeleteData() {
265 ArgumentMatcher<DeleteData> matcher = new ArgumentMatcher<DeleteData>() {
267 public boolean matches(Object argument) {
268 return DeleteData.SERIALIZABLE_CLASS.equals(argument.getClass()) &&
269 DeleteData.fromSerializable(argument).getPath().equals(TestModel.TEST_PATH);
273 return argThat(matcher);
276 private DeleteData eqDeleteData() {
277 ArgumentMatcher<DeleteData> matcher = new ArgumentMatcher<DeleteData>() {
279 public boolean matches(Object argument) {
280 return argument instanceof DeleteData &&
281 ((DeleteData)argument).getPath().equals(TestModel.TEST_PATH);
285 return argThat(matcher);
288 private Future<Object> readySerializedTxReply(String path) {
289 return Futures.successful((Object)new ReadyTransactionReply(path).toSerializable());
292 private Future<Object> readyTxReply(String path) {
293 return Futures.successful((Object)new ReadyTransactionReply(path));
297 private Future<Object> readSerializedDataReply(NormalizedNode<?, ?> data) {
298 return Futures.successful(new ReadDataReply(schemaContext, data).toSerializable());
301 private Future<ReadDataReply> readDataReply(NormalizedNode<?, ?> data) {
302 return Futures.successful(new ReadDataReply(schemaContext, data));
305 private Future<Object> dataExistsSerializedReply(boolean exists) {
306 return Futures.successful(new DataExistsReply(exists).toSerializable());
309 private Future<DataExistsReply> dataExistsReply(boolean exists) {
310 return Futures.successful(new DataExistsReply(exists));
313 private Future<Object> writeSerializedDataReply() {
314 return Futures.successful(new WriteDataReply().toSerializable());
317 private Future<WriteDataReply> writeDataReply() {
318 return Futures.successful(new WriteDataReply());
321 private Future<Object> mergeSerializedDataReply() {
322 return Futures.successful(new MergeDataReply().toSerializable());
325 private Future<MergeDataReply> mergeDataReply() {
326 return Futures.successful(new MergeDataReply());
329 private Future<Object> deleteSerializedDataReply() {
330 return Futures.successful(new DeleteDataReply().toSerializable());
333 private Future<DeleteDataReply> deleteDataReply() {
334 return Futures.successful(new DeleteDataReply());
337 private ActorSelection actorSelection(ActorRef actorRef) {
338 return getSystem().actorSelection(actorRef.path());
341 private CreateTransactionReply createTransactionReply(ActorRef actorRef){
342 return CreateTransactionReply.newBuilder()
343 .setTransactionActorPath(actorRef.path().toString())
344 .setTransactionId("txn-1").build();
347 private ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type) {
348 ActorRef actorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
349 doReturn(actorSystem.actorSelection(actorRef.path())).
350 when(mockActorContext).actorSelection(actorRef.path().toString());
352 doReturn(Futures.successful(actorSystem.actorSelection(actorRef.path()))).
353 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
355 doReturn(Futures.successful(createTransactionReply(actorRef))).when(mockActorContext).
356 executeOperationAsync(eq(actorSystem.actorSelection(actorRef.path())),
357 eqCreateTransaction(memberName, type));
359 doReturn(false).when(mockActorContext).isLocalPath(actorRef.path().toString());
364 private void propagateReadFailedExceptionCause(CheckedFuture<?, ReadFailedException> future)
368 future.checkedGet(5, TimeUnit.SECONDS);
369 fail("Expected ReadFailedException");
370 } catch(ReadFailedException e) {
376 public void testRead() throws Exception {
377 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
379 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
382 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
383 eq(actorSelection(actorRef)), eqSerializedReadData());
385 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
386 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
388 assertEquals("NormalizedNode isPresent", false, readOptional.isPresent());
390 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
392 doReturn(readSerializedDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
393 eq(actorSelection(actorRef)), eqSerializedReadData());
395 readOptional = transactionProxy.read(TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
397 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
399 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
402 @Test(expected = ReadFailedException.class)
403 public void testReadWithInvalidReplyMessageType() throws Exception {
404 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
406 doReturn(Futures.successful(new Object())).when(mockActorContext).
407 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedReadData());
409 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
412 transactionProxy.read(TestModel.TEST_PATH).checkedGet(5, TimeUnit.SECONDS);
415 @Test(expected = TestException.class)
416 public void testReadWithAsyncRemoteOperatonFailure() throws Throwable {
417 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
419 doReturn(Futures.failed(new TestException())).when(mockActorContext).
420 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedReadData());
422 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
425 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
428 private void testExceptionOnInitialCreateTransaction(Exception exToThrow, Invoker invoker)
430 ActorRef actorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
432 if (exToThrow instanceof PrimaryNotFoundException) {
433 doReturn(Futures.failed(exToThrow)).when(mockActorContext).findPrimaryShardAsync(anyString());
435 doReturn(Futures.successful(getSystem().actorSelection(actorRef.path()))).
436 when(mockActorContext).findPrimaryShardAsync(anyString());
439 doReturn(Futures.failed(exToThrow)).when(mockActorContext).executeOperationAsync(
440 any(ActorSelection.class), any());
442 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, READ_ONLY);
444 propagateReadFailedExceptionCause(invoker.invoke(transactionProxy));
447 private void testReadWithExceptionOnInitialCreateTransaction(Exception exToThrow) throws Throwable {
448 testExceptionOnInitialCreateTransaction(exToThrow, new Invoker() {
450 public CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception {
451 return proxy.read(TestModel.TEST_PATH);
456 @Test(expected = PrimaryNotFoundException.class)
457 public void testReadWhenAPrimaryNotFoundExceptionIsThrown() throws Throwable {
458 testReadWithExceptionOnInitialCreateTransaction(new PrimaryNotFoundException("test"));
461 @Test(expected = TimeoutException.class)
462 public void testReadWhenATimeoutExceptionIsThrown() throws Throwable {
463 testReadWithExceptionOnInitialCreateTransaction(new TimeoutException("test",
464 new Exception("reason")));
467 @Test(expected = TestException.class)
468 public void testReadWhenAnyOtherExceptionIsThrown() throws Throwable {
469 testReadWithExceptionOnInitialCreateTransaction(new TestException());
472 @Test(expected = TestException.class)
473 public void testReadWithPriorRecordingOperationFailure() throws Throwable {
474 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
476 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
478 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
479 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
481 doReturn(Futures.failed(new TestException())).when(mockActorContext).
482 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedDeleteData());
484 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
485 eq(actorSelection(actorRef)), eqSerializedReadData());
487 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
490 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
492 transactionProxy.delete(TestModel.TEST_PATH);
495 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
497 verify(mockActorContext, times(0)).executeOperationAsync(
498 eq(actorSelection(actorRef)), eqSerializedReadData());
503 public void testReadWithPriorRecordingOperationSuccessful() throws Throwable {
504 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
506 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
508 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
509 eq(actorSelection(actorRef)), eqSerializedWriteData(expectedNode));
511 doReturn(readSerializedDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
512 eq(actorSelection(actorRef)), eqSerializedReadData());
514 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
517 transactionProxy.write(TestModel.TEST_PATH, expectedNode);
519 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
520 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
522 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
524 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
527 @Test(expected=IllegalStateException.class)
528 public void testReadPreConditionCheck() {
530 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
533 transactionProxy.read(TestModel.TEST_PATH);
536 @Test(expected=IllegalArgumentException.class)
537 public void testInvalidCreateTransactionReply() throws Throwable {
538 ActorRef actorRef = getSystem().actorOf(Props.create(DoNothingActor.class));
540 doReturn(getSystem().actorSelection(actorRef.path())).when(mockActorContext).
541 actorSelection(actorRef.path().toString());
543 doReturn(Futures.successful(getSystem().actorSelection(actorRef.path()))).
544 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
546 doReturn(Futures.successful(new Object())).when(mockActorContext).executeOperationAsync(
547 eq(getSystem().actorSelection(actorRef.path())), eqCreateTransaction(memberName, READ_ONLY));
549 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, READ_ONLY);
551 propagateReadFailedExceptionCause(transactionProxy.read(TestModel.TEST_PATH));
555 public void testExists() throws Exception {
556 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
558 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
561 doReturn(dataExistsSerializedReply(false)).when(mockActorContext).executeOperationAsync(
562 eq(actorSelection(actorRef)), eqSerializedDataExists());
564 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
566 assertEquals("Exists response", false, exists);
568 doReturn(dataExistsSerializedReply(true)).when(mockActorContext).executeOperationAsync(
569 eq(actorSelection(actorRef)), eqSerializedDataExists());
571 exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
573 assertEquals("Exists response", true, exists);
576 @Test(expected = PrimaryNotFoundException.class)
577 public void testExistsWhenAPrimaryNotFoundExceptionIsThrown() throws Throwable {
578 testExceptionOnInitialCreateTransaction(new PrimaryNotFoundException("test"), new Invoker() {
580 public CheckedFuture<?, ReadFailedException> invoke(TransactionProxy proxy) throws Exception {
581 return proxy.exists(TestModel.TEST_PATH);
586 @Test(expected = ReadFailedException.class)
587 public void testExistsWithInvalidReplyMessageType() throws Exception {
588 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
590 doReturn(Futures.successful(new Object())).when(mockActorContext).
591 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedDataExists());
593 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
596 transactionProxy.exists(TestModel.TEST_PATH).checkedGet(5, TimeUnit.SECONDS);
599 @Test(expected = TestException.class)
600 public void testExistsWithAsyncRemoteOperatonFailure() throws Throwable {
601 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
603 doReturn(Futures.failed(new TestException())).when(mockActorContext).
604 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedDataExists());
606 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
609 propagateReadFailedExceptionCause(transactionProxy.exists(TestModel.TEST_PATH));
612 @Test(expected = TestException.class)
613 public void testExistsWithPriorRecordingOperationFailure() throws Throwable {
614 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
616 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
618 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
619 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
621 doReturn(Futures.failed(new TestException())).when(mockActorContext).
622 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedDeleteData());
624 doReturn(dataExistsSerializedReply(false)).when(mockActorContext).executeOperationAsync(
625 eq(actorSelection(actorRef)), eqSerializedDataExists());
627 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
630 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
632 transactionProxy.delete(TestModel.TEST_PATH);
635 propagateReadFailedExceptionCause(transactionProxy.exists(TestModel.TEST_PATH));
637 verify(mockActorContext, times(0)).executeOperationAsync(
638 eq(actorSelection(actorRef)), eqSerializedDataExists());
643 public void testExistsWithPriorRecordingOperationSuccessful() throws Throwable {
644 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
646 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
648 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
649 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
651 doReturn(dataExistsSerializedReply(true)).when(mockActorContext).executeOperationAsync(
652 eq(actorSelection(actorRef)), eqSerializedDataExists());
654 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
657 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
659 Boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
661 assertEquals("Exists response", true, exists);
664 @Test(expected=IllegalStateException.class)
665 public void testxistsPreConditionCheck() {
667 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
670 transactionProxy.exists(TestModel.TEST_PATH);
673 private void verifyRecordingOperationFutures(List<Future<Object>> futures,
674 Class<?>... expResultTypes) throws Exception {
675 assertEquals("getRecordingOperationFutures size", expResultTypes.length, futures.size());
678 for( Future<Object> future: futures) {
679 assertNotNull("Recording operation Future is null", future);
681 Class<?> expResultType = expResultTypes[i++];
682 if(Throwable.class.isAssignableFrom(expResultType)) {
684 Await.result(future, Duration.create(5, TimeUnit.SECONDS));
685 fail("Expected exception from recording operation Future");
686 } catch(Exception e) {
690 assertEquals("Recording operation Future result type", expResultType,
691 Await.result(future, Duration.create(5, TimeUnit.SECONDS)).getClass());
697 public void testWrite() throws Exception {
698 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
700 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
702 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
703 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
705 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
708 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
710 verify(mockActorContext).executeOperationAsync(
711 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
713 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
714 WriteDataReply.SERIALIZABLE_CLASS);
717 @Test(expected=IllegalStateException.class)
718 public void testWritePreConditionCheck() {
720 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
723 transactionProxy.write(TestModel.TEST_PATH,
724 ImmutableNodes.containerNode(TestModel.TEST_QNAME));
727 @Test(expected=IllegalStateException.class)
728 public void testWriteAfterReadyPreConditionCheck() {
730 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
733 transactionProxy.ready();
735 transactionProxy.write(TestModel.TEST_PATH,
736 ImmutableNodes.containerNode(TestModel.TEST_QNAME));
740 public void testMerge() throws Exception {
741 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
743 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
745 doReturn(mergeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
746 eq(actorSelection(actorRef)), eqSerializedMergeData(nodeToWrite));
748 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, WRITE_ONLY);
750 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
752 verify(mockActorContext).executeOperationAsync(
753 eq(actorSelection(actorRef)), eqSerializedMergeData(nodeToWrite));
755 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
756 MergeDataReply.SERIALIZABLE_CLASS);
760 public void testDelete() throws Exception {
761 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
763 doReturn(deleteSerializedDataReply()).when(mockActorContext).executeOperationAsync(
764 eq(actorSelection(actorRef)), eqSerializedDeleteData());
766 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
769 transactionProxy.delete(TestModel.TEST_PATH);
771 verify(mockActorContext).executeOperationAsync(
772 eq(actorSelection(actorRef)), eqSerializedDeleteData());
774 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
775 DeleteDataReply.SERIALIZABLE_CLASS);
778 private void verifyCohortFutures(ThreePhaseCommitCohortProxy proxy,
779 Object... expReplies) throws Exception {
780 assertEquals("getReadyOperationFutures size", expReplies.length,
781 proxy.getCohortFutures().size());
784 for( Future<ActorSelection> future: proxy.getCohortFutures()) {
785 assertNotNull("Ready operation Future is null", future);
787 Object expReply = expReplies[i++];
788 if(expReply instanceof ActorSelection) {
789 ActorSelection actual = Await.result(future, Duration.create(5, TimeUnit.SECONDS));
790 assertEquals("Cohort actor path", expReply, actual);
792 // Expecting exception.
794 Await.result(future, Duration.create(5, TimeUnit.SECONDS));
795 fail("Expected exception from ready operation Future");
796 } catch(Exception e) {
803 @SuppressWarnings("unchecked")
805 public void testReady() throws Exception {
806 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
808 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
810 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
811 eq(actorSelection(actorRef)), eqSerializedReadData());
813 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
814 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
816 doReturn(readySerializedTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
817 eq(actorSelection(actorRef)), isA(ReadyTransaction.SERIALIZABLE_CLASS));
819 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
822 transactionProxy.read(TestModel.TEST_PATH);
824 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
826 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
828 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
830 ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
832 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
833 WriteDataReply.SERIALIZABLE_CLASS);
835 verifyCohortFutures(proxy, getSystem().actorSelection(actorRef.path()));
838 @SuppressWarnings("unchecked")
840 public void testReadyWithRecordingOperationFailure() throws Exception {
841 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
843 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
845 doReturn(mergeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
846 eq(actorSelection(actorRef)), eqSerializedMergeData(nodeToWrite));
848 doReturn(Futures.failed(new TestException())).when(mockActorContext).
849 executeOperationAsync(eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
851 doReturn(readySerializedTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
852 eq(actorSelection(actorRef)), isA(ReadyTransaction.SERIALIZABLE_CLASS));
854 doReturn(false).when(mockActorContext).isLocalPath(actorRef.path().toString());
856 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
859 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
861 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
863 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
865 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
867 ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
869 verifyCohortFutures(proxy, TestException.class);
871 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
872 MergeDataReply.SERIALIZABLE_CLASS, TestException.class);
875 @SuppressWarnings("unchecked")
877 public void testReadyWithReplyFailure() throws Exception {
878 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
880 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
882 doReturn(mergeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
883 eq(actorSelection(actorRef)), eqSerializedMergeData(nodeToWrite));
885 doReturn(Futures.failed(new TestException())).when(mockActorContext).
886 executeOperationAsync(eq(actorSelection(actorRef)),
887 isA(ReadyTransaction.SERIALIZABLE_CLASS));
889 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
892 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
894 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
896 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
898 ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
900 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
901 MergeDataReply.SERIALIZABLE_CLASS);
903 verifyCohortFutures(proxy, TestException.class);
907 public void testReadyWithInitialCreateTransactionFailure() throws Exception {
909 doReturn(Futures.failed(new PrimaryNotFoundException("mock"))).when(
910 mockActorContext).findPrimaryShardAsync(anyString());
912 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
915 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
917 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
919 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
921 transactionProxy.delete(TestModel.TEST_PATH);
923 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
925 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
927 ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
929 verifyCohortFutures(proxy, PrimaryNotFoundException.class);
932 @SuppressWarnings("unchecked")
934 public void testReadyWithInvalidReplyMessageType() throws Exception {
935 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY);
937 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
939 doReturn(writeSerializedDataReply()).when(mockActorContext).executeOperationAsync(
940 eq(actorSelection(actorRef)), eqSerializedWriteData(nodeToWrite));
942 doReturn(Futures.successful(new Object())).when(mockActorContext).
943 executeOperationAsync(eq(actorSelection(actorRef)),
944 isA(ReadyTransaction.SERIALIZABLE_CLASS));
946 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
949 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
951 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
953 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
955 ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
957 verifyCohortFutures(proxy, IllegalArgumentException.class);
961 public void testGetIdentifier() {
962 setupActorContextWithInitialCreateTransaction(getSystem(), READ_ONLY);
963 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
964 TransactionProxy.TransactionType.READ_ONLY);
966 Object id = transactionProxy.getIdentifier();
967 assertNotNull("getIdentifier returned null", id);
968 assertTrue("Invalid identifier: " + id, id.toString().startsWith(memberName));
971 @SuppressWarnings("unchecked")
973 public void testClose() throws Exception{
974 ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE);
976 doReturn(readSerializedDataReply(null)).when(mockActorContext).executeOperationAsync(
977 eq(actorSelection(actorRef)), eqSerializedReadData());
979 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,
982 transactionProxy.read(TestModel.TEST_PATH);
984 transactionProxy.close();
986 verify(mockActorContext).sendOperationAsync(
987 eq(actorSelection(actorRef)), isA(CloseTransaction.SERIALIZABLE_CLASS));
992 * Method to test a local Tx actor. The Tx paths are matched to decide if the
993 * Tx actor is local or not. This is done by mocking the Tx actor path
994 * and the caller paths and ensuring that the paths have the remote-address format
996 * Note: Since the default akka provider for test is not a RemoteActorRefProvider,
997 * the paths returned for the actors for all the tests are not qualified remote paths.
998 * Hence are treated as non-local/remote actors. In short, all tests except
999 * few below run for remote actors
1004 public void testLocalTxActorRead() throws Exception {
1005 ActorSystem actorSystem = getSystem();
1006 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
1008 doReturn(actorSystem.actorSelection(shardActorRef.path())).
1009 when(mockActorContext).actorSelection(shardActorRef.path().toString());
1011 doReturn(Futures.successful(actorSystem.actorSelection(shardActorRef.path()))).
1012 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
1014 String actorPath = "akka.tcp://system@127.0.0.1:2550/user/tx-actor";
1015 CreateTransactionReply createTransactionReply = CreateTransactionReply.newBuilder()
1016 .setTransactionId("txn-1")
1017 .setTransactionActorPath(actorPath)
1020 doReturn(Futures.successful(createTransactionReply)).when(mockActorContext).
1021 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
1022 eqCreateTransaction(memberName, READ_ONLY));
1024 doReturn(true).when(mockActorContext).isLocalPath(actorPath);
1026 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext,READ_ONLY);
1028 // negative test case with null as the reply
1029 doReturn(readDataReply(null)).when(mockActorContext).executeOperationAsync(
1030 any(ActorSelection.class), eqReadData());
1032 Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(
1033 TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
1035 assertEquals("NormalizedNode isPresent", false, readOptional.isPresent());
1037 // test case with node as read data reply
1038 NormalizedNode<?, ?> expectedNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1040 doReturn(readDataReply(expectedNode)).when(mockActorContext).executeOperationAsync(
1041 any(ActorSelection.class), eqReadData());
1043 readOptional = transactionProxy.read(TestModel.TEST_PATH).get(5, TimeUnit.SECONDS);
1045 assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
1047 assertEquals("Response NormalizedNode", expectedNode, readOptional.get());
1049 // test for local data exists
1050 doReturn(dataExistsReply(true)).when(mockActorContext).executeOperationAsync(
1051 any(ActorSelection.class), eqDataExists());
1053 boolean exists = transactionProxy.exists(TestModel.TEST_PATH).checkedGet();
1055 assertEquals("Exists response", true, exists);
1059 public void testLocalTxActorWrite() throws Exception {
1060 ActorSystem actorSystem = getSystem();
1061 ActorRef shardActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
1063 doReturn(actorSystem.actorSelection(shardActorRef.path())).
1064 when(mockActorContext).actorSelection(shardActorRef.path().toString());
1066 doReturn(Futures.successful(actorSystem.actorSelection(shardActorRef.path()))).
1067 when(mockActorContext).findPrimaryShardAsync(eq(DefaultShardStrategy.DEFAULT_SHARD));
1069 String actorPath = "akka.tcp://system@127.0.0.1:2550/user/tx-actor";
1070 CreateTransactionReply createTransactionReply = CreateTransactionReply.newBuilder()
1071 .setTransactionId("txn-1")
1072 .setTransactionActorPath(actorPath)
1075 doReturn(Futures.successful(createTransactionReply)).when(mockActorContext).
1076 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
1077 eqCreateTransaction(memberName, WRITE_ONLY));
1079 doReturn(true).when(mockActorContext).isLocalPath(actorPath);
1081 NormalizedNode<?, ?> nodeToWrite = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
1083 doReturn(writeDataReply()).when(mockActorContext).executeOperationAsync(
1084 any(ActorSelection.class), eqWriteData(nodeToWrite));
1086 TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, WRITE_ONLY);
1087 transactionProxy.write(TestModel.TEST_PATH, nodeToWrite);
1089 verify(mockActorContext).executeOperationAsync(
1090 any(ActorSelection.class), eqWriteData(nodeToWrite));
1092 //testing local merge
1093 doReturn(mergeDataReply()).when(mockActorContext).executeOperationAsync(
1094 any(ActorSelection.class), eqMergeData(nodeToWrite));
1096 transactionProxy.merge(TestModel.TEST_PATH, nodeToWrite);
1098 verify(mockActorContext).executeOperationAsync(
1099 any(ActorSelection.class), eqMergeData(nodeToWrite));
1102 //testing local delete
1103 doReturn(deleteDataReply()).when(mockActorContext).executeOperationAsync(
1104 any(ActorSelection.class), eqDeleteData());
1106 transactionProxy.delete(TestModel.TEST_PATH);
1108 verify(mockActorContext).executeOperationAsync(any(ActorSelection.class), eqDeleteData());
1110 verifyRecordingOperationFutures(transactionProxy.getRecordedOperationFutures(),
1111 WriteDataReply.class, MergeDataReply.class, DeleteDataReply.class);
1114 doReturn(readyTxReply(shardActorRef.path().toString())).when(mockActorContext).executeOperationAsync(
1115 any(ActorSelection.class), isA(ReadyTransaction.class));
1117 DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
1119 assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
1121 ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
1123 verifyCohortFutures(proxy, getSystem().actorSelection(shardActorRef.path()));