opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/compat/PreLithiumTransactionProxyTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.compat;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.mockito.Matchers.argThat;
  13 import static org.mockito.Matchers.eq;
  14 import static org.mockito.Matchers.isA;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.verify;
  17 import static org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType.READ_WRITE;
  18 import static org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType.WRITE_ONLY;
  19 import akka.actor.ActorRef;
  20 import akka.dispatch.Futures;
  21 import com.google.common.base.Optional;
  22 import java.util.concurrent.TimeUnit;
  23 import org.junit.Ignore;
  24 import org.junit.Test;
  25 import org.mockito.ArgumentMatcher;
  26 import org.mockito.Mockito;
  27 import org.opendaylight.controller.cluster.datastore.AbstractTransactionProxyTest;
  28 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  29 import org.opendaylight.controller.cluster.datastore.ThreePhaseCommitCohortProxy;
  30 import org.opendaylight.controller.cluster.datastore.TransactionProxy;
  31 import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
  32 import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
  33 import org.opendaylight.controller.cluster.datastore.messages.MergeData;
  34 import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
  35 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
  36 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
  37 import org.opendaylight.controller.cluster.datastore.messages.WriteData;
  38 import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
  39 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
  40 import org.opendaylight.controller.protobuff.messages.transaction.ShardTransactionMessages;
  41 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  45 import scala.concurrent.Future;
  46
  47 /**
  48  * Unit tests for backwards compatibility with pre-Lithium versions.
  49  *
  50  * @author Thomas Pantelis
  51  */
  52 public class PreLithiumTransactionProxyTest extends AbstractTransactionProxyTest {
  53
  54     private WriteData eqLegacyWriteData(final NormalizedNode<?, ?> nodeToWrite) {
  55         ArgumentMatcher<WriteData> matcher = new ArgumentMatcher<WriteData>() {
  56             @Override
  57             public boolean matches(Object argument) {
  58                 if(ShardTransactionMessages.WriteData.class.equals(argument.getClass())) {
  59                     WriteData obj = WriteData.fromSerializable(argument);
  60                     return obj.getPath().equals(TestModel.TEST_PATH) && obj.getData().equals(nodeToWrite);
  61                 }
  62
  63                 return false;
  64             }
  65         };
  66
  67         return argThat(matcher);
  68     }
  69
  70     private MergeData eqLegacyMergeData(final NormalizedNode<?, ?> nodeToWrite) {
  71         ArgumentMatcher<MergeData> matcher = new ArgumentMatcher<MergeData>() {
  72             @Override
  73             public boolean matches(Object argument) {
  74                 if(ShardTransactionMessages.MergeData.class.equals(argument.getClass())) {
  75                     MergeData obj = MergeData.fromSerializable(argument);
  76                     return obj.getPath().equals(TestModel.TEST_PATH) && obj.getData().equals(nodeToWrite);
  77                 }
  78
  79                 return false;
  80             }
  81         };
  82
  83         return argThat(matcher);
  84     }
  85
  86     private DeleteData eqLegacyDeleteData(final YangInstanceIdentifier expPath) {
  87         ArgumentMatcher<DeleteData> matcher = new ArgumentMatcher<DeleteData>() {
  88             @Override
  89             public boolean matches(Object argument) {
  90                 return ShardTransactionMessages.DeleteData.class.equals(argument.getClass()) &&
  91                        DeleteData.fromSerializable(argument).getPath().equals(expPath);
  92             }
  93         };
  94
  95         return argThat(matcher);
  96     }
  97
  98     private Future<Object> readySerializedTxReply(String path, short version) {
  99         return Futures.successful(new ReadyTransactionReply(path, version).toSerializable());
 100     }
 101
 102     private ActorRef testCompatibilityWithHeliumVersion(short version) throws Exception {
 103         ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE, version);
 104
 105         NormalizedNode<?, ?> testNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
 106
 107         doReturn(readSerializedDataReply(testNode, version)).when(mockActorContext).executeOperationAsync(
 108                 eq(actorSelection(actorRef)), eqSerializedReadData(TestModel.TEST_PATH));
 109
 110         doReturn(Futures.successful(new WriteDataReply().toSerializable(version))).when(mockActorContext).
 111                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyWriteData(testNode));
 112
 113         doReturn(Futures.successful(new MergeDataReply().toSerializable(version))).when(mockActorContext).
 114                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyMergeData(testNode));
 115
 116         doReturn(Futures.successful(new DeleteDataReply().toSerializable(version))).when(mockActorContext).
 117                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyDeleteData(TestModel.TEST_PATH));
 118
 119         doReturn(readySerializedTxReply(actorRef.path().toString(), version)).when(mockActorContext).executeOperationAsync(
 120                 eq(actorSelection(actorRef)), isA(ReadyTransaction.SERIALIZABLE_CLASS));
 121
 122         doReturn(actorRef.path().toString()).when(mockActorContext).resolvePath(eq(actorRef.path().toString()),
 123                 eq(actorRef.path().toString()));
 124
 125         TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, READ_WRITE);
 126
 127         Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(TestModel.TEST_PATH).
 128                 get(5, TimeUnit.SECONDS);
 129
 130         assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
 131         assertEquals("Response NormalizedNode", testNode, readOptional.get());
 132
 133         transactionProxy.write(TestModel.TEST_PATH, testNode);
 134
 135         transactionProxy.merge(TestModel.TEST_PATH, testNode);
 136
 137         transactionProxy.delete(TestModel.TEST_PATH);
 138
 139         DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
 140
 141         assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
 142
 143         ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
 144
 145         verifyCohortFutures(proxy, getSystem().actorSelection(actorRef.path()));
 146
 147         return actorRef;
 148     }
 149
 150     @Test
 151     public void testCompatibilityWithBaseHeliumVersion() throws Exception {
 152         ActorRef actorRef = testCompatibilityWithHeliumVersion(DataStoreVersions.BASE_HELIUM_VERSION);
 153
 154         verify(mockActorContext).resolvePath(eq(actorRef.path().toString()),
 155                 eq(actorRef.path().toString()));
 156     }
 157
 158     @Test
 159     public void testCompatibilityWithHeliumR1Version() throws Exception {
 160         ActorRef actorRef = testCompatibilityWithHeliumVersion(DataStoreVersions.HELIUM_1_VERSION);
 161
 162         verify(mockActorContext, Mockito.never()).resolvePath(eq(actorRef.path().toString()),
 163                 eq(actorRef.path().toString()));
 164     }
 165
 166     @Test
 167     @Ignore
 168     // FIXME: disabled until we can get the primary shard version from the ShardManager as we now skip
 169     // creating transaction actors for write-only Tx's.
 170     public void testWriteOnlyCompatibilityWithHeliumR2Version() throws Exception {
 171         short version = DataStoreVersions.HELIUM_2_VERSION;
 172         ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), WRITE_ONLY, version);
 173
 174         NormalizedNode<?, ?> testNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
 175
 176         doReturn(Futures.successful(new WriteDataReply().toSerializable(version))).when(mockActorContext).
 177                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyWriteData(testNode));
 178
 179         doReturn(readySerializedTxReply(actorRef.path().toString(), version)).when(mockActorContext).executeOperationAsync(
 180                 eq(actorSelection(actorRef)), isA(ReadyTransaction.SERIALIZABLE_CLASS));
 181
 182         doReturn(actorRef.path().toString()).when(mockActorContext).resolvePath(eq(actorRef.path().toString()),
 183                 eq(actorRef.path().toString()));
 184
 185         TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, WRITE_ONLY);
 186
 187         transactionProxy.write(TestModel.TEST_PATH, testNode);
 188
 189         DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
 190
 191         assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
 192
 193         ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
 194
 195         verifyCohortFutures(proxy, getSystem().actorSelection(actorRef.path()));
 196     }
 197 }