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