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 akka.actor.ActorRef;
  19 import akka.dispatch.Futures;
  20 import com.google.common.base.Optional;
  21 import java.util.concurrent.TimeUnit;
  22 import org.junit.Test;
  23 import org.mockito.ArgumentMatcher;
  24 import org.mockito.Mockito;
  25 import org.opendaylight.controller.cluster.datastore.AbstractTransactionProxyTest;
  26 import org.opendaylight.controller.cluster.datastore.DataStoreVersions;
  27 import org.opendaylight.controller.cluster.datastore.ThreePhaseCommitCohortProxy;
  28 import org.opendaylight.controller.cluster.datastore.TransactionProxy;
  29 import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
  30 import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
  31 import org.opendaylight.controller.cluster.datastore.messages.MergeData;
  32 import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
  33 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
  34 import org.opendaylight.controller.cluster.datastore.messages.WriteData;
  35 import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
  36 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
  37 import org.opendaylight.controller.protobuff.messages.transaction.ShardTransactionMessages;
  38 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  42
  43 /**
  44  * Unit tests for backwards compatibility with pre-Lithium versions.
  45  *
  46  * @author Thomas Pantelis
  47  */
  48 public class PreLithiumTransactionProxyTest extends AbstractTransactionProxyTest {
  49
  50     private WriteData eqLegacyWriteData(final NormalizedNode<?, ?> nodeToWrite) {
  51         ArgumentMatcher<WriteData> matcher = new ArgumentMatcher<WriteData>() {
  52             @Override
  53             public boolean matches(Object argument) {
  54                 if(ShardTransactionMessages.WriteData.class.equals(argument.getClass())) {
  55                     WriteData obj = WriteData.fromSerializable(argument);
  56                     return obj.getPath().equals(TestModel.TEST_PATH) && obj.getData().equals(nodeToWrite);
  57                 }
  58
  59                 return false;
  60             }
  61         };
  62
  63         return argThat(matcher);
  64     }
  65
  66     private MergeData eqLegacyMergeData(final NormalizedNode<?, ?> nodeToWrite) {
  67         ArgumentMatcher<MergeData> matcher = new ArgumentMatcher<MergeData>() {
  68             @Override
  69             public boolean matches(Object argument) {
  70                 if(ShardTransactionMessages.MergeData.class.equals(argument.getClass())) {
  71                     MergeData obj = MergeData.fromSerializable(argument);
  72                     return obj.getPath().equals(TestModel.TEST_PATH) && obj.getData().equals(nodeToWrite);
  73                 }
  74
  75                 return false;
  76             }
  77         };
  78
  79         return argThat(matcher);
  80     }
  81
  82     private DeleteData eqLegacyDeleteData(final YangInstanceIdentifier expPath) {
  83         ArgumentMatcher<DeleteData> matcher = new ArgumentMatcher<DeleteData>() {
  84             @Override
  85             public boolean matches(Object argument) {
  86                 return ShardTransactionMessages.DeleteData.class.equals(argument.getClass()) &&
  87                        DeleteData.fromSerializable(argument).getPath().equals(expPath);
  88             }
  89         };
  90
  91         return argThat(matcher);
  92     }
  93
  94     private ActorRef testCompatibilityWithHeliumVersion(short version) throws Exception {
  95         ActorRef actorRef = setupActorContextWithInitialCreateTransaction(getSystem(), READ_WRITE, version);
  96
  97         NormalizedNode<?, ?> testNode = ImmutableNodes.containerNode(TestModel.TEST_QNAME);
  98
  99         doReturn(readSerializedDataReply(testNode, version)).when(mockActorContext).executeOperationAsync(
 100                 eq(actorSelection(actorRef)), eqSerializedReadData(TestModel.TEST_PATH));
 101
 102         doReturn(Futures.successful(new WriteDataReply().toSerializable(version))).when(mockActorContext).
 103                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyWriteData(testNode));
 104
 105         doReturn(Futures.successful(new MergeDataReply().toSerializable(version))).when(mockActorContext).
 106                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyMergeData(testNode));
 107
 108         doReturn(Futures.successful(new DeleteDataReply().toSerializable(version))).when(mockActorContext).
 109                 executeOperationAsync(eq(actorSelection(actorRef)), eqLegacyDeleteData(TestModel.TEST_PATH));
 110
 111         doReturn(readySerializedTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
 112                 eq(actorSelection(actorRef)), isA(ReadyTransaction.SERIALIZABLE_CLASS));
 113
 114         doReturn(actorRef.path().toString()).when(mockActorContext).resolvePath(eq(actorRef.path().toString()),
 115                 eq(actorRef.path().toString()));
 116
 117         TransactionProxy transactionProxy = new TransactionProxy(mockActorContext, READ_WRITE);
 118
 119         Optional<NormalizedNode<?, ?>> readOptional = transactionProxy.read(TestModel.TEST_PATH).
 120                 get(5, TimeUnit.SECONDS);
 121
 122         assertEquals("NormalizedNode isPresent", true, readOptional.isPresent());
 123         assertEquals("Response NormalizedNode", testNode, readOptional.get());
 124
 125         transactionProxy.write(TestModel.TEST_PATH, testNode);
 126
 127         transactionProxy.merge(TestModel.TEST_PATH, testNode);
 128
 129         transactionProxy.delete(TestModel.TEST_PATH);
 130
 131         DOMStoreThreePhaseCommitCohort ready = transactionProxy.ready();
 132
 133         assertTrue(ready instanceof ThreePhaseCommitCohortProxy);
 134
 135         ThreePhaseCommitCohortProxy proxy = (ThreePhaseCommitCohortProxy) ready;
 136
 137         verifyCohortFutures(proxy, getSystem().actorSelection(actorRef.path()));
 138
 139         return actorRef;
 140     }
 141
 142     @Test
 143     public void testCompatibilityWithBaseHeliumVersion() throws Exception {
 144         ActorRef actorRef = testCompatibilityWithHeliumVersion(DataStoreVersions.BASE_HELIUM_VERSION);
 145
 146         verify(mockActorContext).resolvePath(eq(actorRef.path().toString()),
 147                 eq(actorRef.path().toString()));
 148     }
 149
 150     @Test
 151     public void testCompatibilityWithHeliumR1Version() throws Exception {
 152         ActorRef actorRef = testCompatibilityWithHeliumVersion(DataStoreVersions.HELIUM_1_VERSION);
 153
 154         verify(mockActorContext, Mockito.never()).resolvePath(eq(actorRef.path().toString()),
 155                 eq(actorRef.path().toString()));
 156     }
 157 }