netconf/netconf-topology-singleton/src/test/java/org/opendaylight/netconf/topology/singleton/impl/tx/ReadOnlyTransactionTest.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 org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertTrue;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.Mockito.mock;
  15 import static org.mockito.MockitoAnnotations.initMocks;
  16 import static org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologyUtils.DEFAULT_SCHEMA_REPOSITORY;
  17
  18 import akka.actor.ActorRef;
  19 import akka.actor.ActorSystem;
  20 import akka.actor.Props;
  21 import akka.pattern.Patterns;
  22 import akka.testkit.JavaTestKit;
  23 import akka.testkit.TestActorRef;
  24 import akka.util.Timeout;
  25 import com.google.common.base.Optional;
  26 import com.google.common.collect.Lists;
  27 import com.google.common.util.concurrent.CheckedFuture;
  28 import com.google.common.util.concurrent.Futures;
  29 import java.net.InetAddress;
  30 import java.net.InetSocketAddress;
  31 import java.util.List;
  32 import java.util.concurrent.TimeUnit;
  33 import org.junit.After;
  34 import org.junit.Before;
  35 import org.junit.Rule;
  36 import org.junit.Test;
  37 import org.junit.rules.ExpectedException;
  38 import org.mockito.Mock;
  39 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  40 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  41 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  42 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadOnlyTransaction;
  43 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  44 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
  45 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  46 import org.opendaylight.netconf.topology.singleton.impl.ProxyDOMDataBroker;
  47 import org.opendaylight.netconf.topology.singleton.impl.actors.NetconfNodeActor;
  48 import org.opendaylight.netconf.topology.singleton.impl.utils.NetconfTopologySetup;
  49 import org.opendaylight.netconf.topology.singleton.messages.CreateInitialMasterActorData;
  50 import org.opendaylight.netconf.topology.singleton.messages.MasterActorDataInitialized;
  51 import org.opendaylight.yangtools.yang.common.QName;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  56 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  57 import scala.concurrent.Await;
  58 import scala.concurrent.Future;
  59 import scala.concurrent.duration.Duration;
  60
  61 public class ReadOnlyTransactionTest {
  62     private static final Timeout TIMEOUT = new Timeout(Duration.create(5, "seconds"));
  63     private static final int TIMEOUT_SEC = 5;
  64     private static ActorSystem system;
  65
  66     @Rule
  67     public final ExpectedException exception = ExpectedException.none();
  68
  69     private ActorRef masterRef;
  70     private ProxyDOMDataBroker slaveDataBroker;
  71     private List<SourceIdentifier> sourceIdentifiers;
  72     private YangInstanceIdentifier instanceIdentifier;
  73     private LogicalDatastoreType storeType;
  74     @Mock
  75     private DOMDataBroker deviceDataBroker;
  76     @Mock
  77     private DOMDataReadOnlyTransaction readTx;
  78     @Mock
  79     private DOMRpcService domRpcService;
  80     @Mock
  81     private DOMMountPointService mountPointService;
  82
  83     @Before
  84     public void setup() throws Exception {
  85         initMocks(this);
  86
  87         system = ActorSystem.create();
  88
  89         final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("netconf-topology",
  90                 new InetSocketAddress(InetAddress.getByName("127.0.0.1"), 9999));
  91
  92         final NetconfTopologySetup setup = mock(NetconfTopologySetup.class);
  93         final Props props = NetconfNodeActor.props(setup, remoteDeviceId, DEFAULT_SCHEMA_REPOSITORY,
  94                 DEFAULT_SCHEMA_REPOSITORY, TIMEOUT, mountPointService);
  95
  96         masterRef = TestActorRef.create(system, props, "master_read");
  97
  98         sourceIdentifiers = Lists.newArrayList();
  99
 100         //device read tx
 101         doReturn(readTx).when(deviceDataBroker).newReadOnlyTransaction();
 102
 103         // Create slave data broker for testing proxy
 104         slaveDataBroker =
 105                 new ProxyDOMDataBroker(system, remoteDeviceId, masterRef, Timeout.apply(5, TimeUnit.SECONDS));
 106         initializeDataTest();
 107         instanceIdentifier = YangInstanceIdentifier.EMPTY;
 108         storeType = LogicalDatastoreType.CONFIGURATION;
 109     }
 110
 111     @After
 112     public void teardown() {
 113         JavaTestKit.shutdownActorSystem(system, null, true);
 114         system = null;
 115     }
 116
 117     @Test
 118     public void testRead() throws Exception {
 119         // Message: NormalizedNodeMessage
 120         final NormalizedNode<?, ?> outputNode = ImmutableContainerNodeBuilder.create()
 121                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create("TestQname")))
 122                 .withChild(ImmutableNodes.leafNode(QName.create("NodeQname"), "foo")).build();
 123         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultNormalizedNodeMessage =
 124                 Futures.immediateCheckedFuture(Optional.of(outputNode));
 125         doReturn(resultNormalizedNodeMessage).when(readTx).read(storeType, instanceIdentifier);
 126
 127         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultNodeMessageResponse =
 128                 slaveDataBroker.newReadOnlyTransaction().read(storeType, instanceIdentifier);
 129
 130         final Optional<NormalizedNode<?, ?>> resultNodeMessage =
 131                 resultNodeMessageResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 132
 133         assertTrue(resultNodeMessage.isPresent());
 134         assertEquals(resultNodeMessage.get(), outputNode);
 135     }
 136
 137     @Test
 138     public void testReadEmpty() throws Exception {
 139         // Message: EmptyReadResponse
 140         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultEmpty =
 141                 Futures.immediateCheckedFuture(Optional.absent());
 142         doReturn(resultEmpty).when(readTx).read(storeType, instanceIdentifier);
 143
 144         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultEmptyResponse =
 145                 slaveDataBroker.newReadOnlyTransaction().read(storeType,
 146                         instanceIdentifier);
 147
 148         final Optional<NormalizedNode<?, ?>> resultEmptyMessage =
 149                 resultEmptyResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 150
 151         assertEquals(resultEmptyMessage, Optional.absent());
 152     }
 153
 154     @Test
 155     public void testReadFail() throws Exception {
 156         // Message: Throwable
 157         final ReadFailedException readFailedException = new ReadFailedException("Fail", null);
 158         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultThrowable =
 159                 Futures.immediateFailedCheckedFuture(readFailedException);
 160
 161         doReturn(resultThrowable).when(readTx).read(storeType, instanceIdentifier);
 162
 163         final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> resultThrowableResponse =
 164                 slaveDataBroker.newReadOnlyTransaction().read(storeType, instanceIdentifier);
 165
 166         exception.expect(ReadFailedException.class);
 167         resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 168     }
 169
 170     @Test
 171     public void testExist() throws Exception {
 172         // Message: True
 173         final CheckedFuture<Boolean, ReadFailedException> resultTrue =
 174                 Futures.immediateCheckedFuture(true);
 175         doReturn(resultTrue).when(readTx).exists(storeType, instanceIdentifier);
 176
 177         final CheckedFuture<Boolean, ReadFailedException> trueResponse =
 178                 slaveDataBroker.newReadOnlyTransaction().exists(storeType, instanceIdentifier);
 179
 180         final Boolean trueMessage = trueResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 181
 182         assertEquals(true, trueMessage);
 183     }
 184
 185     @Test
 186     public void testExistsNull() throws Exception {
 187         // Message: False, result null
 188         final CheckedFuture<Boolean, ReadFailedException> resultNull = Futures.immediateCheckedFuture(null);
 189         doReturn(resultNull).when(readTx).exists(storeType, instanceIdentifier);
 190
 191         final CheckedFuture<Boolean, ReadFailedException> nullResponse =
 192                 slaveDataBroker.newReadOnlyTransaction().exists(storeType,
 193                         instanceIdentifier);
 194
 195         final Boolean nullFalseMessage = nullResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 196
 197         assertEquals(false, nullFalseMessage);
 198     }
 199
 200     @Test
 201     public void testExistsFalse() throws Exception {
 202         // Message: False
 203         final CheckedFuture<Boolean, ReadFailedException> resultFalse = Futures.immediateCheckedFuture(false);
 204         doReturn(resultFalse).when(readTx).exists(storeType, instanceIdentifier);
 205
 206         final CheckedFuture<Boolean, ReadFailedException> falseResponse =
 207                 slaveDataBroker.newReadOnlyTransaction().exists(storeType,
 208                         instanceIdentifier);
 209
 210         final Boolean falseMessage = falseResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 211
 212         assertEquals(false, falseMessage);
 213     }
 214
 215     @Test
 216     public void testExistsFail() throws Exception {
 217         // Message: Throwable
 218         final ReadFailedException readFailedException = new ReadFailedException("Fail", null);
 219         final CheckedFuture<Boolean, ReadFailedException> resultThrowable =
 220                 Futures.immediateFailedCheckedFuture(readFailedException);
 221         doReturn(resultThrowable).when(readTx).exists(storeType, instanceIdentifier);
 222
 223         final CheckedFuture<Boolean, ReadFailedException> resultThrowableResponse =
 224                 slaveDataBroker.newReadOnlyTransaction().exists(storeType, instanceIdentifier);
 225
 226         exception.expect(ReadFailedException.class);
 227         resultThrowableResponse.checkedGet(TIMEOUT_SEC, TimeUnit.SECONDS);
 228     }
 229
 230     private void initializeDataTest() throws Exception {
 231         final Future<Object> initialDataToActor =
 232                 Patterns.ask(masterRef, new CreateInitialMasterActorData(deviceDataBroker, sourceIdentifiers,
 233                                 domRpcService), TIMEOUT);
 234
 235         final Object success = Await.result(initialDataToActor, TIMEOUT.duration());
 236
 237         assertTrue(success instanceof MasterActorDataInitialized);
 238     }
 239 }