netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/sal/NetconfDeviceDataBrokerTest.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 package org.opendaylight.netconf.sal.connect.netconf.sal;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.ArgumentMatchers.eq;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.verify;
  16 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
  17 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
  18
  19 import java.net.InetSocketAddress;
  20 import java.util.List;
  21 import org.junit.AfterClass;
  22 import org.junit.Before;
  23 import org.junit.BeforeClass;
  24 import org.junit.Test;
  25 import org.junit.runner.RunWith;
  26 import org.mockito.Mock;
  27 import org.mockito.Mockito;
  28 import org.mockito.junit.MockitoJUnitRunner;
  29 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
  30 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  31 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  32 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  33 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  34 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  35 import org.opendaylight.netconf.dom.api.tx.NetconfDOMDataBrokerFieldsExtension;
  36 import org.opendaylight.netconf.dom.api.tx.NetconfDOMFieldsReadTransaction;
  37 import org.opendaylight.netconf.dom.api.tx.NetconfDOMFieldsReadWriteTransaction;
  38 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  39 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.AbstractWriteTx;
  40 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteCandidateRunningTx;
  41 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteCandidateTx;
  42 import org.opendaylight.netconf.sal.connect.netconf.sal.tx.WriteRunningTx;
  43 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  44 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.IetfNetconfService;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netconf.monitoring.rev220718.NetconfTcp;
  47 import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext;
  48 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  49 import org.opendaylight.yangtools.yang.common.QName;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  53
  54 @RunWith(MockitoJUnitRunner.class)
  55 public class NetconfDeviceDataBrokerTest {
  56     private static EffectiveModelContext SCHEMA_CONTEXT;
  57
  58     @Mock
  59     private DOMRpcService rpcService;
  60     private NetconfDeviceDataBroker dataBroker;
  61
  62     @BeforeClass
  63     public static void beforeClass() {
  64         SCHEMA_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(IetfNetconfService.class, NetconfTcp.class);
  65     }
  66
  67     @AfterClass
  68     public static void afterClass() {
  69         SCHEMA_CONTEXT = null;
  70     }
  71
  72     @Before
  73     public void setUp() throws Exception {
  74         doReturn(FluentFutures.immediateFluentFuture(new DefaultDOMRpcResult())).when(rpcService)
  75             .invokeRpc(any(QName.class), any(ContainerNode.class));
  76         dataBroker = getDataBroker(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
  77     }
  78
  79     @Test
  80     public void testNewReadOnlyTransaction() {
  81         final DOMDataTreeReadTransaction tx = dataBroker.newReadOnlyTransaction();
  82         tx.read(LogicalDatastoreType.OPERATIONAL, null);
  83         verify(rpcService).invokeRpc(eq(NETCONF_GET_QNAME), any(ContainerNode.class));
  84     }
  85
  86     @Test
  87     public void testNewReadWriteTransaction() {
  88         final DOMDataTreeReadWriteTransaction tx = dataBroker.newReadWriteTransaction();
  89         tx.read(LogicalDatastoreType.OPERATIONAL, null);
  90         verify(rpcService).invokeRpc(eq(NETCONF_GET_QNAME), any(ContainerNode.class));
  91     }
  92
  93     @Test
  94     public void testWritableRunningCandidateWriteTransaction() {
  95         testWriteTransaction(
  96                 WriteCandidateRunningTx.class, NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString(),
  97                 NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
  98     }
  99
 100     @Test
 101     public void testCandidateWriteTransaction() {
 102         testWriteTransaction(WriteCandidateTx.class, NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
 103     }
 104
 105     @Test
 106     public void testRunningWriteTransaction() {
 107         testWriteTransaction(WriteRunningTx.class, NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
 108     }
 109
 110     @Test
 111     public void testDOMFieldsExtensions() {
 112         final NetconfDOMDataBrokerFieldsExtension fieldsExtension = dataBroker.getExtensions().getInstance(
 113                 NetconfDOMDataBrokerFieldsExtension.class);
 114         assertNotNull(fieldsExtension);
 115
 116         // read-only transaction
 117         final NetconfDOMFieldsReadTransaction roTx = fieldsExtension.newReadOnlyTransaction();
 118         roTx.read(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.empty(),
 119                 List.of(YangInstanceIdentifier.empty()));
 120         verify(rpcService).invokeRpc(Mockito.eq(NETCONF_GET_CONFIG_QNAME), any(ContainerNode.class));
 121
 122         // read-write transaction
 123         final NetconfDOMFieldsReadWriteTransaction rwTx = fieldsExtension.newReadWriteTransaction();
 124         rwTx.read(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.empty(),
 125                 List.of(YangInstanceIdentifier.empty()));
 126         verify(rpcService).invokeRpc(Mockito.eq(NETCONF_GET_QNAME), any(ContainerNode.class));
 127     }
 128
 129     private void testWriteTransaction(final Class<? extends AbstractWriteTx> transaction,
 130             final String... capabilities) {
 131         NetconfDeviceDataBroker db = getDataBroker(capabilities);
 132         assertEquals(transaction, db.newWriteOnlyTransaction().getClass());
 133     }
 134
 135     private NetconfDeviceDataBroker getDataBroker(final String... caps) {
 136         NetconfSessionPreferences prefs = NetconfSessionPreferences.fromStrings(List.of(caps));
 137         final RemoteDeviceId id =
 138                 new RemoteDeviceId("device-1", InetSocketAddress.createUnresolved("localhost", 17830));
 139         return new NetconfDeviceDataBroker(id, new EmptyMountPointContext(SCHEMA_CONTEXT), rpcService, prefs);
 140     }
 141
 142 }