netconf/callhome-protocol/src/test/java/org/opendaylight/netconf/callhome/protocol/NetconfCallHomeServerTest.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
   9 package org.opendaylight.netconf.callhome.protocol;
  10
  11 import static org.junit.Assert.assertFalse;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.times;
  15 import static org.mockito.Mockito.verify;
  16
  17 import java.io.IOException;
  18 import java.net.InetSocketAddress;
  19 import java.net.SocketAddress;
  20 import java.security.PublicKey;
  21 import java.util.HashMap;
  22 import java.util.Map;
  23 import org.apache.sshd.ClientSession;
  24 import org.apache.sshd.SshClient;
  25 import org.apache.sshd.client.future.AuthFuture;
  26 import org.apache.sshd.client.session.ClientSessionImpl;
  27 import org.apache.sshd.common.Session;
  28 import org.apache.sshd.common.SessionListener;
  29 import org.apache.sshd.common.future.SshFutureListener;
  30 import org.apache.sshd.common.io.IoAcceptor;
  31 import org.apache.sshd.common.io.IoHandler;
  32 import org.apache.sshd.common.io.IoServiceFactory;
  33 import org.junit.Before;
  34 import org.junit.Test;
  35 import org.mockito.Mockito;
  36
  37 public class NetconfCallHomeServerTest {
  38     private SshClient mockSshClient;
  39     private CallHomeAuthorizationProvider mockCallHomeAuthProv;
  40     private CallHomeAuthorization mockAuth;
  41     private CallHomeSessionContext.Factory mockFactory;
  42     private InetSocketAddress mockAddress;
  43     private ClientSession mockSession;
  44     private StatusRecorder mockStatusRecorder;
  45
  46     private NetconfCallHomeServer instance;
  47
  48     @Before
  49     public void setup() {
  50         mockSshClient = Mockito.spy(SshClient.setUpDefaultClient());
  51         mockCallHomeAuthProv = mock(CallHomeAuthorizationProvider.class);
  52         mockAuth = mock(CallHomeAuthorization.class);
  53         mockFactory = mock(CallHomeSessionContext.Factory.class);
  54         mockAddress = InetSocketAddress.createUnresolved("1.2.3.4", 123);
  55         mockSession = mock(ClientSession.class);
  56         mockStatusRecorder = mock(StatusRecorder.class);
  57
  58         Map<String, String> props = new HashMap<>();
  59         props.put("nio-workers", "1");
  60         Mockito.doReturn(props).when(mockSshClient).getProperties();
  61         Mockito.doReturn("test").when(mockSession).toString();
  62         instance = new NetconfCallHomeServer(
  63             mockSshClient, mockCallHomeAuthProv, mockFactory, mockAddress, mockStatusRecorder);
  64     }
  65
  66     @Test
  67     public void sessionListenerShouldHandleEventsOfKeyEstablishedAndAuthenticated() throws IOException {
  68         // Weird - IJ was ok but command line compile failed using the usual array initializer syntax ????
  69         SessionListener.Event[] evt = new SessionListener.Event[2];
  70         evt[0] = SessionListener.Event.KeyEstablished;
  71         evt[1] = SessionListener.Event.Authenticated;
  72
  73         int[] hitOpen = new int[2];
  74         hitOpen[0] = 0;
  75         hitOpen[1] = 1;
  76
  77         int[] hitAuth = new int[2];
  78         hitAuth[0] = 1;
  79         hitAuth[1] = 0;
  80
  81         for (int pass = 0; pass < evt.length; pass++) {
  82             // given
  83             AuthFuture mockAuthFuture = mock(AuthFuture.class);
  84             Mockito.doReturn(null).when(mockAuthFuture).addListener(any(SshFutureListener.class));
  85             CallHomeSessionContext mockContext = mock(CallHomeSessionContext.class);
  86             Mockito.doNothing().when(mockContext).openNetconfChannel();
  87             Mockito.doReturn(mockContext).when(mockSession).getAttribute(any(Session.AttributeKey.class));
  88             SessionListener listener = instance.createSessionListener();
  89             Mockito.doReturn(mockAuthFuture).when(mockContext).authorize();
  90             // when
  91             listener.sessionEvent(mockSession, evt[pass]);
  92             // then
  93             verify(mockContext, times(hitOpen[pass])).openNetconfChannel();
  94             verify(mockContext, times(hitAuth[pass])).authorize();
  95         }
  96     }
  97
  98     @Test
  99     public void verificationOfTheServerKeyShouldBeSuccessfulForServerIsAllowed() {
 100         // given
 101
 102         ClientSessionImpl mockClientSession = mock(ClientSessionImpl.class);
 103         Mockito.doReturn("test").when(mockClientSession).toString();
 104         SocketAddress mockSocketAddr = mock(SocketAddress.class);
 105         Mockito.doReturn("testAddr").when(mockSocketAddr).toString();
 106         PublicKey mockPublicKey = mock(PublicKey.class);
 107
 108         CallHomeAuthorization mockAuth = mock(CallHomeAuthorization.class);
 109         Mockito.doReturn("test").when(mockAuth).toString();
 110         Mockito.doReturn(true).when(mockAuth).isServerAllowed();
 111         Mockito.doReturn("some-session-name").when(mockAuth).getSessionName();
 112
 113         Mockito.doReturn(mockAuth).when(mockCallHomeAuthProv).provideAuth(mockSocketAddr, mockPublicKey);
 114
 115         Mockito.doReturn(null).when(mockFactory).createIfNotExists(mockClientSession, mockAuth, mockSocketAddr);
 116
 117         // expect
 118         instance.verifyServerKey(mockClientSession, mockSocketAddr, mockPublicKey);
 119     }
 120
 121     @Test
 122     public void verificationOfTheServerKeyShouldFailIfTheServerIsNotAllowed() {
 123         // given
 124
 125         ClientSessionImpl mockClientSession = mock(ClientSessionImpl.class);
 126         SocketAddress mockSocketAddr = mock(SocketAddress.class);
 127         PublicKey mockPublicKey = mock(PublicKey.class);
 128
 129         Mockito.doReturn(false).when(mockAuth).isServerAllowed();
 130         Mockito.doReturn(mockAuth).when(mockCallHomeAuthProv).provideAuth(mockSocketAddr, mockPublicKey);
 131         Mockito.doReturn("").when(mockClientSession).toString();
 132
 133         // expect
 134         assertFalse(instance.verifyServerKey(mockClientSession, mockSocketAddr, mockPublicKey));
 135     }
 136
 137     static class TestableCallHomeServer extends NetconfCallHomeServer {
 138         static IoServiceFactory minaServiceFactory;
 139
 140         static SshClient factoryHook(SshClient client, IoServiceFactory minaFactory) {
 141             minaServiceFactory = minaFactory;
 142             return client;
 143         }
 144
 145         SshClient client;
 146
 147         TestableCallHomeServer(SshClient sshClient, CallHomeAuthorizationProvider authProvider,
 148                                CallHomeSessionContext.Factory factory, InetSocketAddress socketAddress,
 149                                IoServiceFactory minaFactory, StatusRecorder recorder) {
 150             super(factoryHook(sshClient, minaFactory), authProvider, factory, socketAddress, recorder);
 151             client = sshClient;
 152         }
 153
 154         @Override
 155         protected IoServiceFactory createMinaServiceFactory(SshClient sshClient) {
 156             return minaServiceFactory;
 157         }
 158     }
 159
 160     @Test
 161     public void bindShouldStartTheClientAndBindTheAddress() throws IOException {
 162         // given
 163         IoAcceptor mockAcceptor = mock(IoAcceptor.class);
 164         IoServiceFactory mockMinaFactory = mock(IoServiceFactory.class);
 165
 166         Mockito.doReturn(mockAcceptor).when(mockMinaFactory).createAcceptor(any(IoHandler.class));
 167         Mockito.doReturn(mockAcceptor).when(mockMinaFactory).createAcceptor(any(IoHandler.class));
 168         Mockito.doNothing().when(mockAcceptor).bind(mockAddress);
 169         instance = new TestableCallHomeServer(
 170             mockSshClient, mockCallHomeAuthProv, mockFactory, mockAddress, mockMinaFactory, mockStatusRecorder);
 171         // when
 172         instance.bind();
 173         // then
 174         verify(mockSshClient, times(1)).start();
 175         verify(mockAcceptor, times(1)).bind(mockAddress);
 176     }
 177 }