netconf/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/tx/ReadWriteTransactionTest.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.Mockito.doNothing;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.timeout;
  18 import static org.mockito.Mockito.verify;
  19 import static org.mockito.MockitoAnnotations.initMocks;
  20 import static org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY;
  21
  22 import akka.actor.ActorRef;
  23 import akka.actor.ActorSystem;
  24 import akka.actor.Props;
  25 import akka.pattern.Patterns;
  26 import akka.testkit.JavaTestKit;
  27 import akka.testkit.TestActorRef;
  28 import akka.util.Timeout;
  29 import com.google.common.base.Optional;
  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.util.List;
  36 import java.util.concurrent.TimeUnit;
  37 import org.junit.After;
  38 import org.junit.Before;
  39 import org.junit.Rule;
  40 import org.junit.Test;
  41 import org.junit.rules.ExpectedException;
  42 import org.mockito.Mock;
  43 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  44 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  45 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  46 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  47 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
  48 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  49 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  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.impl.ProxyDOMDataBroker;
  53 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
  54 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  55 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
  56 import org.opendaylight.netconf.topology.singleton.messages.MasterActorDataInitialized;
  57 import org.opendaylight.yangtools.yang.common.QName;
  58 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  59 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  62 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  63 import scala.concurrent.Await;
  64 import scala.concurrent.Future;
  65 import scala.concurrent.duration.Duration;
  66
  67 public class ReadWriteTransactionTest {
  68     private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
  69     private static final int TIMEOUT_SEC = 5;
  70     private static ActorSystem system;
  71
  72     @Rule
  73     public final ExpectedException exception = ExpectedException.none();
  74
  75     @Mock
  76     private DOMDataBroker deviceDataBroker;
  77     @Mock
  78     private DOMDataReadWriteTransaction readWriteTx;
  79     @Mock
  80     private DOMRpcService domRpcService;
  81     @Mock
  82     private DOMMountPointService mountPointService;
  83     private ActorRef masterRef;
  84     private ProxyDOMDataBroker slaveDataBroker;
  85     private List<SourceIdentifier> sourceIdentifiers;
  86     private NormalizedNode<?, ?> testNode;
  87     private YangInstanceIdentifier instanceIdentifier;
  88     private LogicalDatastoreType storeType;
  89
  90     @Before
  91     public void setup() throws Exception {
  92         initMocks(this);
  93
  94         system = ActorSystem.create();
  95
  96         final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("netconf-topology",
  97                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
  98
  99         final NetconfTopologySetup setup = mock(NetconfTopologySetup.class);
 100         doReturn(Duration.apply(0, TimeUnit.SECONDS)).when(setup).getIdleTimeout();
 101         final Props props = NetconfNodeActor.props(setup, remoteDeviceId, DEFAULT_SCHEMA_REPOSITORY,
 102                 DEFAULT_SCHEMA_REPOSITORY, TIMEOUT, mountPointService);
 103
 104         masterRef = TestActorRef.create(system, props, "master_read");
 105
 106         sourceIdentifiers = Lists.newArrayList();
 107
 108         doReturn(readWriteTx).when(deviceDataBroker).newReadWriteTransaction();
 109         doNothing().when(readWriteTx).put(storeType, instanceIdentifier, testNode);
 110         doNothing().when(readWriteTx).merge(storeType, instanceIdentifier, testNode);
 111         doNothing().when(readWriteTx).delete(storeType, instanceIdentifier);
 112
 113         // Create slave data broker for testing proxy
 114         slaveDataBroker =
 115                 new ProxyDOMDataBroker(system, remoteDeviceId, masterRef, Timeout.apply(5, TimeUnit.SECONDS));
 116         initializeDataTest();
 117         testNode = ImmutableContainerNodeBuilder.create()
 118                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create("TestQname")))
 119                 .withChild(ImmutableNodes.leafNode(QName.create("NodeQname"), "foo")).build();
 120         instanceIdentifier = YangInstanceIdentifier.EMPTY;
 121         storeType = LogicalDatastoreType.CONFIGURATION;
 122     }
 123
 124     @After
 125     public void teardown() {
 126         JavaTestKit.shutdownActorSystem(system, null, true);
 127         system = null;
 128     }
 129
 130     @Test
 131     public void testPut() throws Exception {
 132         // Test of invoking put on master through slave proxy
 133         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 134         wTx.put(storeType, instanceIdentifier, testNode);
 135
 136         verify(readWriteTx, timeout(2000)).put(storeType, instanceIdentifier, testNode);
 137
 138         wTx.cancel();
 139     }
 140
 141     @Test
 142     public void testMerge() throws Exception {
 143         // Test of invoking merge on master through slave proxy
 144         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 145         wTx.merge(storeType, instanceIdentifier, testNode);
 146
 147         verify(readWriteTx, timeout(2000)).merge(storeType, instanceIdentifier, testNode);
 148
 149         wTx.cancel();
 150     }
 151
 152     @Test
 153     public void testDelete() throws Exception {
 154         final YangInstanceIdentifier instanceIdentifier = YangInstanceIdentifier.EMPTY;
 155         final LogicalDatastoreType storeType = LogicalDatastoreType.CONFIGURATION;
 156
 157         // Test of invoking delete on master through slave proxy
 158         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 159         wTx.delete(storeType, instanceIdentifier);
 160         wTx.cancel();
 161
 162         verify(readWriteTx, timeout(2000)).delete(storeType, instanceIdentifier);
 163     }
 164
 165     @Test
 166     public void testSubmit() throws Exception {
 167         final CheckedFuture<Void, TransactionCommitFailedException> resultSubmit = Futures.immediateCheckedFuture(null);
 168         doReturn(resultSubmit).when(readWriteTx).submit();
 169
 170         // Without Tx
 171         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 172
 173         final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitResponse = wTx.submit();
 174
 175         final Object result = resultSubmitResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 176
 177         assertNull(result);
 178     }
 179
 180     @Test
 181     public void testSubmitWithOperation() throws Exception {
 182         final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitTx = Futures.immediateCheckedFuture(null);
 183         doReturn(resultSubmitTx).when(readWriteTx).submit();
 184         // With Tx
 185         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 186         wTx.delete(LogicalDatastoreType.CONFIGURATION,
 187                 YangInstanceIdentifier.EMPTY);
 188
 189         final CheckedFuture<Void, TransactionCommitFailedException> resultSubmitTxResponse = wTx.submit();
 190
 191         final Object resultTx = resultSubmitTxResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 192
 193         assertNull(resultTx);
 194     }
 195
 196     @Test
 197     public void testSubmitFail() throws Exception {
 198         final TransactionCommitFailedException throwable = new TransactionCommitFailedException("Fail", null);
 199         final CheckedFuture<Void, TransactionCommitFailedException> resultThrowable =
 200                 Futures.immediateFailedCheckedFuture(throwable);
 201         doReturn(resultThrowable).when(readWriteTx).submit();
 202
 203         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 204         wTx.delete(LogicalDatastoreType.CONFIGURATION,
 205                 YangInstanceIdentifier.EMPTY);
 206         final CheckedFuture<Void, TransactionCommitFailedException> resultThrowableResponse =
 207                 wTx.submit();
 208         exception.expect(TransactionCommitFailedException.class);
 209         resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 210     }
 211
 212     @Test
 213     public void testCancel() throws Exception {
 214         doReturn(true).when(readWriteTx).cancel();
 215
 216         // Without Tx
 217         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 218         final Boolean resultFalseNoTx = wTx.cancel();
 219         assertEquals(true, resultFalseNoTx);
 220     }
 221
 222     @Test
 223     public void testCancelWithOperation() throws Exception {
 224         doReturn(true).when(readWriteTx).cancel();
 225
 226         // With Tx, readWriteTx test
 227         final DOMDataWriteTransaction wTx = slaveDataBroker.newReadWriteTransaction();
 228         wTx.delete(LogicalDatastoreType.CONFIGURATION,
 229                 YangInstanceIdentifier.EMPTY);
 230
 231         final Boolean resultTrue = wTx.cancel();
 232         assertEquals(true, resultTrue);
 233
 234         final Boolean resultFalse = wTx.cancel();
 235         assertEquals(false, resultFalse);
 236     }
 237
 238     @Test
 239     public void testRead() throws Exception {
 240         // Message: NormalizedNodeMessage
 241         final NormalizedNode<?, ?> outputNode = ImmutableContainerNodeBuilder.create()
 242                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create("TestQname")))
 243                 .withChild(ImmutableNodes.leafNode(QName.create("NodeQname"), "foo")).build();
 244         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultNormalizedNodeMessage =
 245                 Futures.immediateCheckedFuture(Optional.of(outputNode));
 246         doReturn(resultNormalizedNodeMessage).when(readWriteTx).read(storeType, instanceIdentifier);
 247
 248         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultNodeMessageResponse =
 249                 slaveDataBroker.newReadWriteTransaction().read(storeType, instanceIdentifier);
 250
 251         final Optional<NormalizedNode<?, ?>> resultNodeMessage =
 252                 resultNodeMessageResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 253
 254         assertTrue(resultNodeMessage.isPresent());
 255         assertEquals(resultNodeMessage.get(), outputNode);
 256     }
 257
 258     @Test
 259     public void testReadEmpty() throws Exception {
 260         // Message: EmptyReadResponse
 261         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultEmpty =
 262                 Futures.immediateCheckedFuture(Optional.absent());
 263         doReturn(resultEmpty).when(readWriteTx).read(storeType, instanceIdentifier);
 264
 265         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultEmptyResponse =
 266                 slaveDataBroker.newReadWriteTransaction().read(storeType,
 267                         instanceIdentifier);
 268
 269         final Optional<NormalizedNode<?, ?>> resultEmptyMessage =
 270                 resultEmptyResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 271
 272         assertEquals(resultEmptyMessage, Optional.absent());
 273     }
 274
 275     @Test
 276     public void testReadFail() throws Exception {
 277         // Message: Throwable
 278         final ReadFailedException readFailedException = new ReadFailedException("Fail", null);
 279         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultThrowable =
 280                 Futures.immediateFailedCheckedFuture(readFailedException);
 281
 282         doReturn(resultThrowable).when(readWriteTx).read(storeType, instanceIdentifier);
 283
 284         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultThrowableResponse =
 285                 slaveDataBroker.newReadWriteTransaction().read(storeType, instanceIdentifier);
 286
 287         exception.expect(ReadFailedException.class);
 288         resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 289     }
 290
 291     @Test
 292     public void testExist() throws Exception {
 293         // Message: True
 294         final CheckedFuture<Boolean, ReadFailedException> resultTrue =
 295                 Futures.immediateCheckedFuture(true);
 296         doReturn(resultTrue).when(readWriteTx).exists(storeType, instanceIdentifier);
 297
 298         final CheckedFuture<Boolean, ReadFailedException> trueResponse =
 299                 slaveDataBroker.newReadWriteTransaction().exists(storeType, instanceIdentifier);
 300
 301         final Boolean trueMessage = trueResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 302
 303         assertEquals(true, trueMessage);
 304     }
 305
 306     @Test
 307     public void testExistsNull() throws Exception {
 308         // Message: False, result null
 309         final CheckedFuture<Boolean, ReadFailedException> resultNull = Futures.immediateCheckedFuture(null);
 310         doReturn(resultNull).when(readWriteTx).exists(storeType, instanceIdentifier);
 311
 312         final CheckedFuture<Boolean, ReadFailedException> nullResponse =
 313                 slaveDataBroker.newReadWriteTransaction().exists(storeType,
 314                         instanceIdentifier);
 315
 316         final Boolean nullFalseMessage = nullResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 317
 318         assertEquals(false, nullFalseMessage);
 319     }
 320
 321     @Test
 322     public void testExistsFalse() throws Exception {
 323         // Message: False
 324         final CheckedFuture<Boolean, ReadFailedException> resultFalse = Futures.immediateCheckedFuture(false);
 325         doReturn(resultFalse).when(readWriteTx).exists(storeType, instanceIdentifier);
 326
 327         final CheckedFuture<Boolean, ReadFailedException> falseResponse =
 328                 slaveDataBroker.newReadWriteTransaction().exists(storeType,
 329                         instanceIdentifier);
 330
 331         final Boolean falseMessage = falseResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 332
 333         assertEquals(false, falseMessage);
 334     }
 335
 336     @Test
 337     public void testExistsFail() throws Exception {
 338         // Message: Throwable
 339         final ReadFailedException readFailedException = new ReadFailedException("Fail", null);
 340         final CheckedFuture<Boolean, ReadFailedException> resultThrowable =
 341                 Futures.immediateFailedCheckedFuture(readFailedException);
 342         doReturn(resultThrowable).when(readWriteTx).exists(storeType, instanceIdentifier);
 343
 344         final CheckedFuture<Boolean, ReadFailedException> resultThrowableResponse =
 345                 slaveDataBroker.newReadWriteTransaction().exists(storeType, instanceIdentifier);
 346
 347         exception.expect(ReadFailedException.class);
 348         resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 349     }
 350
 351     private void initializeDataTest() throws Exception {
 352         final Future<Object> initialDataToActor =
 353                 Patterns.ask(masterRef, new CreateInitialMasterActorData(deviceDataBroker, sourceIdentifiers,
 354                         domRpcService), TIMEOUT);
 355
 356         final Object success = Await.result(initialDataToActor, TIMEOUT.duration());
 357
 358         assertTrue(success instanceof MasterActorDataInitialized);
 359     }
 360
 361 }