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