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

   1 /*
   2  * Copyright (c) 2016 Brocade Communication Systems 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.Assert.assertFalse;
  11 import static org.mockito.ArgumentMatchers.any;
  12 import static org.mockito.ArgumentMatchers.eq;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.Mockito.mock;
  15 import static org.mockito.Mockito.times;
  16 import static org.mockito.Mockito.verify;
  17
  18 import io.netty.util.concurrent.EventExecutor;
  19 import io.netty.util.concurrent.Future;
  20 import java.net.InetSocketAddress;
  21 import java.net.UnknownHostException;
  22 import org.junit.Before;
  23 import org.junit.Test;
  24 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  25 import org.opendaylight.controller.config.threadpool.ScheduledThreadPool;
  26 import org.opendaylight.controller.config.threadpool.ThreadPool;
  27 import org.opendaylight.mdsal.binding.api.DataBroker;
  28 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  29 import org.opendaylight.netconf.api.messages.NetconfHelloMessageAdditionalHeader;
  30 import org.opendaylight.netconf.callhome.protocol.CallHomeChannelActivator;
  31 import org.opendaylight.netconf.callhome.protocol.CallHomeProtocolSessionContext;
  32 import org.opendaylight.netconf.client.NetconfClientSession;
  33 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  34 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  35 import org.opendaylight.netconf.client.conf.NetconfClientConfigurationBuilder;
  36 import org.opendaylight.netconf.client.mdsal.api.BaseNetconfSchemas;
  37 import org.opendaylight.netconf.client.mdsal.api.CredentialProvider;
  38 import org.opendaylight.netconf.client.mdsal.api.SchemaResourceManager;
  39 import org.opendaylight.netconf.client.mdsal.api.SslHandlerFactoryProvider;
  40 import org.opendaylight.netconf.nettyutil.handler.ssh.authentication.AuthenticationHandler;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  43
  44 public class CallHomeMountDispatcherTest {
  45     private String topologyId;
  46     private EventExecutor mockExecutor;
  47     private ScheduledThreadPool mockKeepAlive;
  48     private ThreadPool mockProcessingExecutor;
  49     private SchemaResourceManager mockSchemaRepoProvider;
  50
  51     private CallHomeMountDispatcher instance;
  52     private DataBroker mockDataBroker;
  53     private DOMMountPointService mockMount;
  54
  55     private CallHomeMountSessionManager mockSessMgr;
  56     private CallHomeTopology mockTopology;
  57     private CallHomeProtocolSessionContext mockProtoSess;
  58     private AAAEncryptionService mockEncryptionService;
  59     private BaseNetconfSchemas mockBaseSchemas;
  60     private CredentialProvider mockCredentialProvider;
  61     private SslHandlerFactoryProvider mockSslHandlerFactoryProvider;
  62
  63     @Before
  64     public void setup() {
  65         topologyId = "";
  66         mockExecutor = mock(EventExecutor.class);
  67         mockKeepAlive = mock(ScheduledThreadPool.class);
  68         mockProcessingExecutor = mock(ThreadPool.class);
  69         mockSchemaRepoProvider = mock(SchemaResourceManager.class);
  70         mockDataBroker = mock(DataBroker.class);
  71         mockMount = mock(DOMMountPointService.class);
  72         mockSessMgr = mock(CallHomeMountSessionManager.class);
  73         mockTopology = mock(CallHomeTopology.class);
  74         mockProtoSess = mock(CallHomeProtocolSessionContext.class);
  75         mockEncryptionService = mock(AAAEncryptionService.class);
  76         mockBaseSchemas = mock(BaseNetconfSchemas.class);
  77         mockCredentialProvider = mock(CredentialProvider.class);
  78         mockSslHandlerFactoryProvider = mock(SslHandlerFactoryProvider.class);
  79
  80         instance = new CallHomeMountDispatcher(topologyId, mockExecutor, mockKeepAlive,
  81                 mockProcessingExecutor, mockSchemaRepoProvider, mockBaseSchemas, mockDataBroker, mockMount,
  82                 mockEncryptionService, mockCredentialProvider, mockSslHandlerFactoryProvider) {
  83             @Override
  84             CallHomeMountSessionManager sessionManager() {
  85                 return mockSessMgr;
  86             }
  87
  88             @Override
  89             void createTopology() {
  90                 topology = mockTopology;
  91             }
  92         };
  93     }
  94
  95     NetconfClientConfiguration someConfiguration(final InetSocketAddress address) {
  96         // NetconfClientConfiguration has mostly final methods, making it un-mock-able
  97
  98         final NetconfClientConfiguration.NetconfClientProtocol protocol =
  99                 NetconfClientConfiguration.NetconfClientProtocol.SSH;
 100         final NetconfHelloMessageAdditionalHeader additionalHeader = mock(NetconfHelloMessageAdditionalHeader.class);
 101         final NetconfClientSessionListener sessionListener = mock(NetconfClientSessionListener.class);
 102         final AuthenticationHandler authHandler = mock(AuthenticationHandler.class);
 103
 104         return NetconfClientConfigurationBuilder.create().withProtocol(protocol).withAddress(address)
 105                 .withConnectionTimeoutMillis(0).withAdditionalHeader(additionalHeader)
 106                 .withSessionListener(sessionListener).withAuthHandler(authHandler).build();
 107     }
 108
 109     @Test
 110     public void canCreateASessionFromAConfiguration() {
 111         // given
 112         final CallHomeMountSessionContext mockContext = mock(CallHomeMountSessionContext.class);
 113         final InetSocketAddress someAddress = InetSocketAddress.createUnresolved("1.2.3.4", 123);
 114         doReturn(mockContext).when(mockSessMgr).getByAddress(eq(someAddress));
 115
 116         final NetconfClientConfiguration someCfg = someConfiguration(someAddress);
 117         // when
 118         instance.createClient(someCfg);
 119         // then
 120         verify(mockContext, times(1)).activateNetconfChannel(any(NetconfClientSessionListener.class));
 121     }
 122
 123     @Test
 124     public void noSessionIsCreatedWithoutAContextAvailableForAGivenAddress() {
 125         // given
 126         final InetSocketAddress someAddress = InetSocketAddress.createUnresolved("1.2.3.4", 123);
 127         final NetconfClientConfiguration someCfg = someConfiguration(someAddress);
 128         // when
 129         final Future<NetconfClientSession> future = instance.createClient(someCfg);
 130         // then
 131         assertFalse(future.isSuccess());
 132     }
 133
 134     @Test
 135     public void nodeIsInsertedIntoTopologyWhenSubsystemIsOpened() throws UnknownHostException {
 136         // given
 137         final NodeId mockNodeId = mock(NodeId.class);
 138         final Node mockNode = mock(Node.class);
 139         final CallHomeMountSessionContext mockDevCtxt = mock(CallHomeMountSessionContext.class);
 140         doReturn(mockNodeId).when(mockDevCtxt).getId();
 141         doReturn(mockNode).when(mockDevCtxt).getConfigNode();
 142         doReturn(mockDevCtxt).when(mockSessMgr).createSession(any(CallHomeProtocolSessionContext.class),
 143                 any(CallHomeChannelActivator.class), any(CallHomeMountSessionContext.CloseCallback.class));
 144         final CallHomeChannelActivator activator = mock(CallHomeChannelActivator.class);
 145         instance.createTopology();
 146         // when
 147         instance.onNetconfSubsystemOpened(mockProtoSess, activator);
 148         // then
 149         verify(instance.topology, times(1)).connectNode(any(Node.class));
 150     }
 151 }