netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/sal/NetconfDeviceSalFacadeTest.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.sal.connect.netconf.sal;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.ArgumentMatchers.eq;
  14 import static org.mockito.Mockito.doNothing;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.times;
  18 import static org.mockito.Mockito.verify;
  19
  20 import java.net.InetSocketAddress;
  21 import java.util.List;
  22 import org.junit.Before;
  23 import org.junit.Test;
  24 import org.junit.runner.RunWith;
  25 import org.mockito.ArgumentCaptor;
  26 import org.mockito.Captor;
  27 import org.mockito.Mock;
  28 import org.mockito.junit.MockitoJUnitRunner;
  29 import org.opendaylight.mdsal.binding.api.DataBroker;
  30 import org.opendaylight.mdsal.binding.api.TransactionChain;
  31 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  32 import org.opendaylight.mdsal.common.api.CommitInfo;
  33 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  34 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  35 import org.opendaylight.mdsal.dom.api.DOMNotification;
  36 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  37 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices;
  38 import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices.Rpcs;
  39 import org.opendaylight.netconf.sal.connect.netconf.NetconfDeviceSchema;
  40 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  41 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  42 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  43 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.ConnectionOper.ConnectionStatus;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
  46 import org.opendaylight.yangtools.rfc8528.data.util.EmptyMountPointContext;
  47 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  48
  49 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  50 public class NetconfDeviceSalFacadeTest {
  51     private final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("test", new InetSocketAddress("127.0.0.1", 8000));
  52
  53     @Mock
  54     private NetconfDeviceSalProvider.MountInstance mountInstance;
  55     @Mock
  56     private NetconfDeviceSalProvider salProvider;
  57     @Mock
  58     private DataBroker dataBroker;
  59     @Mock
  60     private TransactionChain txChain;
  61     @Mock
  62     private WriteTransaction tx;
  63     @Captor
  64     private ArgumentCaptor<NetconfNode> nodeCaptor;
  65
  66     private NetconfDeviceSalFacade deviceFacade;
  67
  68     @Before
  69     public void setUp() throws Exception {
  70         doReturn(txChain).when(dataBroker).createMergingTransactionChain(any());
  71         doReturn(tx).when(txChain).newWriteOnlyTransaction();
  72         doNothing().when(tx).mergeParentStructurePut(eq(LogicalDatastoreType.OPERATIONAL),
  73             eq(remoteDeviceId.getTopologyBindingPath().augmentation(NetconfNode.class)), nodeCaptor.capture());
  74         doReturn(CommitInfo.emptyFluentFuture()).when(tx).commit();
  75
  76         final NetconfDeviceTopologyAdapter adapter = new NetconfDeviceTopologyAdapter(dataBroker, remoteDeviceId);
  77
  78         deviceFacade = new NetconfDeviceSalFacade(remoteDeviceId, salProvider, true);
  79
  80         doReturn(adapter).when(salProvider).getTopologyDatastoreAdapter();
  81
  82         doReturn(mountInstance).when(salProvider).getMountInstance();
  83         doNothing().when(mountInstance).onTopologyDeviceDisconnected();
  84     }
  85
  86     @Test
  87     public void testOnDeviceDisconnected() {
  88         deviceFacade.onDeviceDisconnected();
  89
  90         verifyConnectionStatusUpdate(ConnectionStatus.Connecting);
  91         verify(mountInstance, times(1)).onTopologyDeviceDisconnected();
  92     }
  93
  94     @Test
  95     public void testOnDeviceFailed() {
  96         final Throwable throwable = new Throwable();
  97         deviceFacade.onDeviceFailed(throwable);
  98
  99         verifyConnectionStatusUpdate(ConnectionStatus.UnableToConnect);
 100         verify(mountInstance, times(1)).onTopologyDeviceDisconnected();
 101     }
 102
 103     @Test
 104     public void testOnDeviceClose() throws Exception {
 105         deviceFacade.close();
 106         verify(salProvider).close();
 107     }
 108
 109     @Test
 110     public void testOnDeviceConnected() {
 111         final EffectiveModelContext schemaContext = mock(EffectiveModelContext.class);
 112
 113         final var netconfSessionPreferences = NetconfSessionPreferences.fromStrings(
 114             List.of(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString()));
 115
 116         final var deviceServices = new RemoteDeviceServices(mock(Rpcs.Normalized.class), null);
 117         deviceFacade.onDeviceConnected(
 118             new NetconfDeviceSchema(NetconfDeviceCapabilities.empty(), new EmptyMountPointContext(schemaContext)),
 119             netconfSessionPreferences, deviceServices);
 120
 121         verifyConnectionStatusUpdate(ConnectionStatus.Connected);
 122         verify(mountInstance, times(1)).onTopologyDeviceConnected(eq(schemaContext), eq(deviceServices),
 123             any(DOMDataBroker.class), any(NetconfDataTreeService.class));
 124     }
 125
 126     @Test
 127     public void testOnDeviceNotification() throws Exception {
 128         final DOMNotification domNotification = mock(DOMNotification.class);
 129         deviceFacade.onNotification(domNotification);
 130         verify(mountInstance).publish(domNotification);
 131     }
 132
 133     private void verifyConnectionStatusUpdate(final ConnectionStatus expectedStatus) {
 134         verify(tx).mergeParentStructurePut(eq(LogicalDatastoreType.OPERATIONAL),
 135             eq(remoteDeviceId.getTopologyBindingPath().augmentation(NetconfNode.class)), any());
 136         assertEquals(expectedStatus, nodeCaptor.getValue().getConnectionStatus());
 137     }
 138 }