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