plugins/netconf-client-mdsal/src/test/java/org/opendaylight/netconf/client/mdsal/SchemalessNetconfDeviceTest.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;
   9
  10 import static org.mockito.ArgumentMatchers.any;
  11 import static org.mockito.Mockito.doNothing;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.verify;
  15
  16 import com.google.common.collect.Lists;
  17 import java.net.InetSocketAddress;
  18 import java.util.Collection;
  19 import java.util.List;
  20 import org.junit.Test;
  21 import org.mockito.Mockito;
  22 import org.opendaylight.mdsal.dom.api.DOMNotification;
  23 import org.opendaylight.netconf.api.CapabilityURN;
  24 import org.opendaylight.netconf.api.messages.NetconfMessage;
  25 import org.opendaylight.netconf.api.xml.XmlUtil;
  26 import org.opendaylight.netconf.client.mdsal.api.NetconfSessionPreferences;
  27 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceHandler;
  28 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceId;
  29 import org.opendaylight.netconf.client.mdsal.api.RemoteDeviceServices;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  31 import org.w3c.dom.Document;
  32
  33 public class SchemalessNetconfDeviceTest extends AbstractBaseSchemasTest {
  34
  35     private static final String TEST_NAMESPACE = "test:namespace";
  36     private static final String TEST_MODULE = "test-module";
  37     private static final String TEST_REVISION = "2013-07-22";
  38
  39     @Test
  40     public void testSessionOnMethods() throws Exception {
  41         final RemoteDeviceHandler facade = getFacade();
  42         final NetconfDeviceCommunicator listener = mockCloseableClass(NetconfDeviceCommunicator.class);
  43         final RemoteDeviceId remoteDeviceId = new RemoteDeviceId("test-D",
  44                 InetSocketAddress.createUnresolved("localhost", 22));
  45
  46         final SchemalessNetconfDevice device = new SchemalessNetconfDevice(BASE_SCHEMAS, remoteDeviceId, facade);
  47
  48         final NetconfSessionPreferences sessionCaps = getSessionCaps(true,
  49                 List.of(TEST_NAMESPACE + "?module=" + TEST_MODULE + "&amp;revision=" + TEST_REVISION));
  50
  51         device.onRemoteSessionUp(sessionCaps, listener);
  52         verify(facade).onDeviceConnected(
  53                 any(NetconfDeviceSchema.class), any(NetconfSessionPreferences.class), any(RemoteDeviceServices.class));
  54
  55         final NetconfMessage netconfMessage = mock(NetconfMessage.class);
  56         final Document document = XmlUtil.readXmlToDocument("""
  57             <notification xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
  58               <eventTime>2021-11-11T11:26:16Z</eventTime>
  59               <netconf-config-change xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-notifications"/>
  60             </notification>""");
  61         doReturn(document).when(netconfMessage).getDocument();
  62
  63         device.onNotification(netconfMessage);
  64         verify(facade).onNotification(any());
  65
  66         device.onRemoteSessionDown();
  67         verify(facade).onDeviceDisconnected();
  68     }
  69
  70     private static RemoteDeviceHandler getFacade() throws Exception {
  71         final RemoteDeviceHandler remoteDeviceHandler = mockCloseableClass(RemoteDeviceHandler.class);
  72         doNothing().when(remoteDeviceHandler).onDeviceConnected(
  73                 any(NetconfDeviceSchema.class), any(NetconfSessionPreferences.class), any(RemoteDeviceServices.class));
  74         doNothing().when(remoteDeviceHandler).onDeviceDisconnected();
  75         doNothing().when(remoteDeviceHandler).onNotification(any(DOMNotification.class));
  76         return remoteDeviceHandler;
  77     }
  78
  79     private static <T extends AutoCloseable> T mockCloseableClass(
  80             final Class<T> remoteDeviceHandlerClass) throws Exception {
  81         final T mock = mockClass(remoteDeviceHandlerClass);
  82         doNothing().when(mock).close();
  83         return mock;
  84     }
  85
  86     private static <T> T mockClass(final Class<T> remoteDeviceHandlerClass) {
  87         final T mock = mock(remoteDeviceHandlerClass);
  88         Mockito.doReturn(remoteDeviceHandlerClass.getSimpleName()).when(mock).toString();
  89         return mock;
  90     }
  91
  92     private static NetconfSessionPreferences getSessionCaps(final boolean addMonitor,
  93                                                             final Collection<String> additionalCapabilities) {
  94         final var capabilities = Lists.newArrayList(CapabilityURN.BASE, CapabilityURN.BASE_1_1);
  95         if (addMonitor) {
  96             capabilities.add(NetconfState.QNAME.getNamespace().toString());
  97         }
  98         capabilities.addAll(additionalCapabilities);
  99         return NetconfSessionPreferences.fromStrings(capabilities);
 100     }
 101 }