netconf/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/tx/WriteOnlyTransactionTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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
   9 package org.opendaylight.netconf.topology.singleton.impl.tx;
  10
  11 import static junit.framework.TestCase.assertNull;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.mockito.Matchers.any;
  15 import static org.mockito.Mockito.doNothing;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.mock;
  18 import static org.mockito.Mockito.times;
  19 import static org.mockito.Mockito.verify;
  20 import static org.mockito.MockitoAnnotations.initMocks;
  21 import static org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY;
  22
  23 import akka.actor.ActorRef;
  24 import akka.actor.ActorSystem;
  25 import akka.actor.Props;
  26 import akka.pattern.Patterns;
  27 import akka.testkit.JavaTestKit;
  28 import akka.testkit.TestActorRef;
  29 import akka.util.Timeout;
  30 import com.google.common.collect.Lists;
  31 import com.google.common.util.concurrent.CheckedFuture;
  32 import com.google.common.util.concurrent.Futures;
  33 import java.net.InetAddress;
  34 import java.net.InetSocketAddress;
  35 import java.net.UnknownHostException;
  36 import java.util.List;
  37 import java.util.concurrent.TimeUnit;
  38 import org.junit.After;
  39 import org.junit.Before;
  40 import org.junit.Rule;
  41 import org.junit.Test;
  42 import org.junit.rules.ExpectedException;
  43 import org.mockito.Mock;
  44 import org.mockito.Mockito;
  45 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  46 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  47 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  48 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  49 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  50 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  51 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  52 import org.opendaylight.netconf.topology.singleton.api.NetconfDOMTransaction;
  53 import org.opendaylight.netconf.topology.singleton.impl.NetconfDOMDataBroker;
  54 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
  55 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  56 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
  57 import org.opendaylight.netconf.topology.singleton.messages.MasterActorDataInitialized;
  58 import org.opendaylight.yangtools.yang.common.QName;
  59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  60 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  62 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  63 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  64 import scala.concurrent.Await;
  65 import scala.concurrent.Future;
  66 import scala.concurrent.duration.Duration;
  67
  68 public class WriteOnlyTransactionTest {
  69     private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
  70     private static final int TIMEOUT_SEC = 5;
  71     private static ActorSystem system;
  72
  73     @Rule
  74     public final ExpectedException exception = ExpectedException.none();
  75
  76     private ActorRef masterRef;
  77     private NetconfDOMDataBroker slaveDataBroker;
  78     private DOMDataBroker masterDataBroker;
  79     private List<SourceIdentifier> sourceIdentifiers;
  80
  81     @Mock
  82     private DOMDataWriteTransaction writeTx;
  83
  84     @Mock
  85     private DOMRpcService domRpcService;
  86
  87     @Before
  88     public void setup() throws UnknownHostException {
  89         initMocks(this);
  90
  91         system = ActorSystem.create();
  92
  93         final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("netconf-topology",
  94                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
  95
  96         final NetconfTopologySetup setup = mock(NetconfTopologySetup.class);
  97         final Props props = NetconfNodeActor.props(setup, remoteDeviceId, DEFAULT_SCHEMA_REPOSITORY,
  98                 DEFAULT_SCHEMA_REPOSITORY);
  99
 100         masterRef = TestActorRef.create(system, props, "master_read");
 101
 102         sourceIdentifiers = Lists.newArrayList();
 103
 104         // Create master data broker
 105
 106         final DOMDataBroker delegateDataBroker = mock(DOMDataBroker.class);
 107         writeTx = mock(DOMDataWriteTransaction.class);
 108         final DOMDataReadOnlyTransaction readTx = mock(DOMDataReadOnlyTransaction.class);
 109
 110         doReturn(writeTx).when(delegateDataBroker).newWriteOnlyTransaction();
 111         doReturn(readTx).when(delegateDataBroker).newReadOnlyTransaction();
 112
 113         final NetconfDOMTransaction masterDOMTransactions =
 114                 new NetconfMasterDOMTransaction(remoteDeviceId, delegateDataBroker);
 115
 116         masterDataBroker =
 117                 new NetconfDOMDataBroker(system, remoteDeviceId, masterDOMTransactions);
 118
 119         // Create slave data broker for testing proxy
 120
 121         final NetconfDOMTransaction proxyDOMTransactions =
 122                 new NetconfProxyDOMTransaction(remoteDeviceId, system, masterRef);
 123
 124         slaveDataBroker = new NetconfDOMDataBroker(system, remoteDeviceId, proxyDOMTransactions);
 125
 126
 127     }
 128
 129     @After
 130     public void teardown() {
 131         JavaTestKit.shutdownActorSystem(system);
 132         system = null;
 133     }
 134
 135     @Test
 136     public void testPutMergeDeleteCalls() throws Exception {
 137
 138         /* Initialize data on master */
 139
 140         initializeDataTest();
 141
 142         final YangInstanceIdentifier instanceIdentifier = YangInstanceIdentifier.EMPTY;
 143         final LogicalDatastoreType storeType = LogicalDatastoreType.CONFIGURATION;
 144         final NormalizedNode<?, ?> testNode = ImmutableContainerNodeBuilder.create()
 145                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create("TestQname")))
 146                 .withChild(ImmutableNodes.leafNode(QName.create("NodeQname"), "foo")).build();
 147
 148         // Test of invoking put on master through slave proxy
 149
 150         doNothing().when(writeTx).put(storeType, instanceIdentifier, testNode);
 151         slaveDataBroker.newWriteOnlyTransaction().put(storeType, instanceIdentifier, testNode);
 152
 153         verify(writeTx, times(1)).put(storeType, instanceIdentifier, testNode);
 154
 155         // Test of invoking merge on master through slave proxy
 156
 157         doNothing().when(writeTx).merge(storeType, instanceIdentifier, testNode);
 158         slaveDataBroker.newWriteOnlyTransaction().merge(storeType, instanceIdentifier, testNode);
 159
 160         verify(writeTx, times(1)).merge(storeType, instanceIdentifier, testNode);
 161
 162         // Test of invoking delete on master through slave proxy
 163
 164         doNothing().when(writeTx).delete(storeType, instanceIdentifier);
 165         slaveDataBroker.newWriteOnlyTransaction().delete(storeType, instanceIdentifier);
 166
 167         verify(writeTx, times(1)).delete(storeType, instanceIdentifier);
 168
 169     }
 170
 171     @Test
 172     public void testSubmit() throws Exception {
 173
 174         /* Initialize data on master */
 175
 176         initializeDataTest();
 177
 178         // Without Tx
 179
 180         final CheckedFuture<Void,TransactionCommitFailedException> resultSubmit = Futures.immediateCheckedFuture(null);
 181         doReturn(resultSubmit).when(writeTx).submit();
 182
 183         final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitResponse =
 184                 slaveDataBroker.newWriteOnlyTransaction().submit();
 185
 186         final Object result= resultSubmitResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 187
 188         assertNull(result);
 189
 190         // With Tx
 191
 192         doNothing().when(writeTx).delete(any(), any());
 193         slaveDataBroker.newWriteOnlyTransaction().delete(LogicalDatastoreType.CONFIGURATION,
 194                 YangInstanceIdentifier.EMPTY);
 195
 196         final CheckedFuture<Void,TransactionCommitFailedException> resultSubmitTx = Futures.immediateCheckedFuture(null);
 197         doReturn(resultSubmitTx).when(writeTx).submit();
 198
 199         final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitTxResponse =
 200                 slaveDataBroker.newWriteOnlyTransaction().submit();
 201
 202         final Object resultTx = resultSubmitTxResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 203
 204         assertNull(resultTx);
 205
 206         slaveDataBroker.newWriteOnlyTransaction().delete(LogicalDatastoreType.CONFIGURATION,
 207                 YangInstanceIdentifier.EMPTY);
 208
 209         final TransactionCommitFailedException throwable = new TransactionCommitFailedException("Fail", null);
 210         final CheckedFuture<Void,TransactionCommitFailedException> resultThrowable =
 211                 Futures.immediateFailedCheckedFuture(throwable);
 212
 213         doReturn(resultThrowable).when(writeTx).submit();
 214
 215         final CheckedFuture<Void, TransactionCommitFailedException> resultThrowableResponse =
 216                 slaveDataBroker.newWriteOnlyTransaction().submit();
 217
 218         exception.expect(TransactionCommitFailedException.class);
 219         resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 220     }
 221
 222     @Test
 223     public void testCancel() throws Exception {
 224
 225         /* Initialize data on master */
 226
 227         initializeDataTest();
 228
 229         // Without Tx
 230
 231         final Boolean resultFalseNoTx = slaveDataBroker.newWriteOnlyTransaction().cancel();
 232         assertEquals(false, resultFalseNoTx);
 233
 234         // With Tx, readWriteTx test
 235
 236         doNothing().when(writeTx).delete(any(), any());
 237         slaveDataBroker.newReadWriteTransaction().delete(LogicalDatastoreType.CONFIGURATION,
 238                 YangInstanceIdentifier.EMPTY);
 239
 240         doReturn(true).when(writeTx).cancel();
 241
 242         final Boolean resultTrue = slaveDataBroker.newWriteOnlyTransaction().cancel();
 243         assertEquals(true, resultTrue);
 244
 245         doReturn(false).when(writeTx).cancel();
 246
 247         final Boolean resultFalse = slaveDataBroker.newWriteOnlyTransaction().cancel();
 248         assertEquals(false, resultFalse);
 249
 250     }
 251
 252     private void initializeDataTest() throws Exception {
 253         final Future<Object> initialDataToActor =
 254                 Patterns.ask(masterRef, new CreateInitialMasterActorData(masterDataBroker, sourceIdentifiers,
 255                                 domRpcService), TIMEOUT);
 256
 257         final Object success = Await.result(initialDataToActor, TIMEOUT.duration());
 258
 259         assertTrue(success instanceof MasterActorDataInitialized);
 260     }
 261
 262 }