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