apps/callhome-provider/src/test/java/org/opendaylight/netconf/callhome/mount/CallHomeMountServiceTest.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech s.r.o. 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.callhome.mount;
   9
  10 import static org.junit.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertNotNull;
  12 import static org.junit.jupiter.api.Assertions.assertNull;
  13 import static org.junit.jupiter.api.Assertions.assertSame;
  14 import static org.mockito.ArgumentMatchers.any;
  15 import static org.mockito.ArgumentMatchers.eq;
  16 import static org.mockito.Mockito.doAnswer;
  17 import static org.mockito.Mockito.doNothing;
  18 import static org.mockito.Mockito.doReturn;
  19 import static org.mockito.Mockito.times;
  20 import static org.mockito.Mockito.verify;
  21
  22 import com.google.common.util.concurrent.ListenableFuture;
  23 import io.netty.channel.Channel;
  24 import java.net.InetSocketAddress;
  25 import java.net.SocketAddress;
  26 import org.junit.jupiter.api.BeforeEach;
  27 import org.junit.jupiter.api.Test;
  28 import org.junit.jupiter.api.extension.ExtendWith;
  29 import org.mockito.Mock;
  30 import org.mockito.junit.jupiter.MockitoExtension;
  31 import org.opendaylight.netconf.callhome.server.CallHomeStatusRecorder;
  32 import org.opendaylight.netconf.callhome.server.tls.CallHomeTlsAuthProvider;
  33 import org.opendaylight.netconf.client.NetconfClientSession;
  34 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  35 import org.opendaylight.netconf.shaded.sshd.client.session.ClientSession;
  36 import org.opendaylight.netconf.transport.api.UnsupportedConfigurationException;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNode;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  40
  41 @ExtendWith(MockitoExtension.class)
  42 public class CallHomeMountServiceTest {
  43
  44     private static final SocketAddress SOCKET_ADDRESS = new InetSocketAddress("127.0.0.1", 12345);
  45     private static final String ID1 = "id1";
  46     private static final NodeId NODE_ID1 = new NodeId(ID1);
  47     private static final String ID2 = "id2";
  48
  49     @Mock
  50     private CallHomeTopology topology;
  51     @Mock
  52     private NetconfClientSessionListener sessionListener;
  53     @Mock
  54     private ClientSession sshSession;
  55     @Mock
  56     private Channel nettyChannel;
  57     @Mock
  58     private CallHomeTlsAuthProvider tlsAuthProvider;
  59     @Mock
  60     private CallHomeStatusRecorder statusRecorder;
  61
  62     private CallHomeMountService service;
  63     private ListenableFuture<NetconfClientSession> netconfSessionFuture;
  64
  65     @BeforeEach
  66     void beforeEach() {
  67         service = new CallHomeMountService(topology);
  68         /*
  69          * Reproduce behavior of org.opendaylight.netconf.topology.spi.AbstractNetconfTopology#ensureNode(Node)
  70          * for ID1 only.
  71          */
  72         doAnswer(invocation -> {
  73             final var node = (Node) invocation.getArguments()[0];
  74             if (ID1.equals(node.requireNodeId().getValue())) {
  75                 final var configBuilderFactory = CallHomeMountService.createClientConfigurationBuilderFactory();
  76                 final var config = configBuilderFactory
  77                     .createClientConfigurationBuilder(node.requireNodeId(), node.augmentation(NetconfNode.class))
  78                     .withSessionListener(sessionListener).build();
  79                 try {
  80                     netconfSessionFuture = service.createClientFactory().createClient(config);
  81                 } catch (UnsupportedConfigurationException e) {
  82                     netconfSessionFuture = null;
  83                 }
  84             } else {
  85                 netconfSessionFuture = null;
  86             }
  87             return null;
  88         }).when(topology).enableNode(any(Node.class));
  89         doNothing().when(topology).disableNode(any(NodeId.class));
  90     }
  91
  92     @Test
  93     void sshSessionContextManager() throws Exception {
  94         doReturn(SOCKET_ADDRESS).when(sshSession).getRemoteAddress();
  95         final var sshSessionContextManager = service.createSshSessionContextManager();
  96
  97         // id 1 -- netconf layer created
  98         final var context = sshSessionContextManager.createContext(ID1, sshSession);
  99         assertNotNull(context);
 100         assertEquals(ID1, context.id());
 101         assertEquals(SOCKET_ADDRESS, context.remoteAddress());
 102         assertSame(sshSession, context.sshSession());
 103         assertSame(sessionListener, context.netconfSessionListener());
 104         assertNotNull(context.settableFuture());
 105         assertSame(netconfSessionFuture, context.settableFuture());
 106         // id 2 -- netconf layer omitted
 107         assertNull(sshSessionContextManager.createContext(ID2, sshSession));
 108
 109         // remove context
 110         sshSessionContextManager.remove(ID1);
 111         verify(topology, times(1)).disableNode(eq(NODE_ID1));
 112     }
 113
 114     @Test
 115     void tlsSessionContextManager() {
 116         doReturn(SOCKET_ADDRESS).when(nettyChannel).remoteAddress();
 117         final var tlsSessionContextManager = service.createTlsSessionContextManager(tlsAuthProvider, statusRecorder);
 118
 119         // id 1 -- netconf layer created
 120         final var context = tlsSessionContextManager.createContext(ID1, nettyChannel);
 121         assertNotNull(context);
 122         assertEquals(ID1, context.id());
 123         assertSame(nettyChannel, context.nettyChannel());
 124         assertSame(sessionListener, context.netconfSessionListener());
 125         assertNotNull(context.settableFuture());
 126         assertSame(netconfSessionFuture, context.settableFuture());
 127         // id 2 -- netconf layer omitted
 128         assertNull(tlsSessionContextManager.createContext(ID2, nettyChannel));
 129
 130         // remove context
 131         tlsSessionContextManager.remove(ID1);
 132         verify(topology, times(1)).disableNode(eq(NODE_ID1));
 133     }
 134
 135 }