openflow-protocol-impl/src/test/java/org/opendaylight/openflowjava/protocol/impl/core/PublishingChannelInitializerTest.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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
   9 package org.opendaylight.openflowjava.protocol.impl.core;
  10
  11 import static org.junit.Assert.assertEquals;
  12 import static org.mockito.Matchers.any;
  13 import static org.mockito.Matchers.eq;
  14 import static org.mockito.Mockito.doThrow;
  15 import static org.mockito.Mockito.times;
  16 import static org.mockito.Mockito.verify;
  17 import static org.mockito.Mockito.when;
  18 import io.netty.channel.ChannelHandler;
  19 import io.netty.channel.ChannelPipeline;
  20 import io.netty.channel.group.DefaultChannelGroup;
  21 import io.netty.channel.socket.SocketChannel;
  22 import io.netty.handler.ssl.SslHandler;
  23
  24 import java.net.InetAddress;
  25 import java.net.InetSocketAddress;
  26 import java.net.UnknownHostException;
  27
  28 import javax.net.ssl.SSLEngine;
  29
  30 import org.junit.Before;
  31 import org.junit.Test;
  32 import org.mockito.Mock;
  33 import org.mockito.MockitoAnnotations;
  34 import org.opendaylight.openflowjava.protocol.api.connection.SwitchConnectionHandler;
  35 import org.opendaylight.openflowjava.protocol.api.connection.TlsConfiguration;
  36 import org.opendaylight.openflowjava.protocol.api.connection.TlsConfigurationImpl;
  37 import org.opendaylight.openflowjava.protocol.impl.core.connection.ConnectionAdapterFactory;
  38 import org.opendaylight.openflowjava.protocol.impl.core.connection.ConnectionFacade;
  39 import org.opendaylight.openflowjava.protocol.impl.deserialization.DeserializationFactory;
  40 import org.opendaylight.openflowjava.protocol.impl.serialization.SerializationFactory;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.KeystoreType;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.config.rev140630.PathType;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.provider.impl.rev140328.Tls;
  44
  45 /**
  46  *
  47  * @author james.hall
  48  */
  49 public class PublishingChannelInitializerTest {
  50
  51     @Mock SocketChannel mockSocketCh ;
  52     @Mock ChannelPipeline mockChPipeline ;
  53     @Mock SwitchConnectionHandler mockSwConnHandler ;
  54     @Mock ConnectionAdapterFactory mockConnAdaptorFactory;
  55     @Mock DefaultChannelGroup mockChGrp ;
  56     @Mock ConnectionFacade mockConnFacade ;
  57     @Mock Tls mockTls ;
  58     SSLEngine sslEngine ;
  59
  60     @Mock SerializationFactory mockSerializationFactory ;
  61     @Mock DeserializationFactory mockDeserializationFactory ;
  62
  63     TlsConfiguration tlsConfiguration ;
  64     InetSocketAddress inetSockAddr;
  65     TcpChannelInitializer pubChInitializer  ;
  66
  67     /**
  68      * Sets up test environment
  69      * @throws Exception
  70      */
  71     @Before
  72     public void setUp() throws Exception {
  73         MockitoAnnotations.initMocks(this);
  74         pubChInitializer= new TcpChannelInitializer(mockChGrp, mockConnAdaptorFactory) ;
  75         pubChInitializer.setSerializationFactory(mockSerializationFactory);
  76         pubChInitializer.setDeserializationFactory(mockDeserializationFactory);
  77         pubChInitializer.setSwitchIdleTimeout(1) ;
  78         pubChInitializer.getConnectionIterator() ;
  79
  80         when( mockChGrp.size()).thenReturn(1) ;
  81         pubChInitializer.setSwitchConnectionHandler( mockSwConnHandler ) ;
  82
  83         inetSockAddr = new InetSocketAddress(InetAddress.getLocalHost(), 8675 ) ;
  84
  85         when(mockConnAdaptorFactory.createConnectionFacade(mockSocketCh, null))
  86         .thenReturn(mockConnFacade);
  87         when(mockSocketCh.remoteAddress()).thenReturn(inetSockAddr) ;
  88         when(mockSocketCh.localAddress()).thenReturn(inetSockAddr) ;
  89         when(mockSocketCh.remoteAddress()).thenReturn(inetSockAddr) ;
  90         when(mockSwConnHandler.accept(eq(InetAddress.getLocalHost()))).thenReturn(true) ;
  91         when(mockSocketCh.pipeline()).thenReturn(mockChPipeline) ;
  92
  93         tlsConfiguration = new TlsConfigurationImpl(KeystoreType.JKS, "/selfSignedSwitch", PathType.CLASSPATH,
  94                 KeystoreType.JKS, "/selfSignedController", PathType.CLASSPATH);
  95     }
  96
  97
  98     /**
  99      * Test channel initialization with encryption config set
 100      */
 101     @Test
 102     public void testinitChannelEncryptionSet()  {
 103         pubChInitializer.setTlsConfiguration(tlsConfiguration);
 104         pubChInitializer.initChannel(mockSocketCh) ;
 105
 106         verifyCommonHandlers();
 107         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.SSL_HANDLER.name()),any(SslHandler.class)) ;
 108     }
 109
 110     /**
 111      * Test channel initialization with null encryption config
 112      */
 113     @Test
 114     public void testinitChannelEncryptionSetNullTls()  {
 115         pubChInitializer.setTlsConfiguration(null);
 116         pubChInitializer.initChannel(mockSocketCh) ;
 117
 118         verifyCommonHandlers();
 119         verify(mockChPipeline, times(0)).addLast(eq(PipelineHandlers.SSL_HANDLER.name()),any(SslHandler.class)) ;
 120     }
 121
 122     /**
 123      * Test channel initialization without setting the encryption
 124      */
 125     @Test
 126     public void testinitChannelEncryptionNotSet()  {
 127         // Without encryption, only the common
 128         pubChInitializer.initChannel(mockSocketCh) ;
 129
 130         verifyCommonHandlers();
 131     }
 132
 133     /**
 134      * Test disconnect on new connection rejected
 135      * @throws UnknownHostException
 136      */
 137     @Test
 138     public void testinitChannelNoEncryptionAcceptFails() throws UnknownHostException  {
 139         when(mockSwConnHandler.accept(eq(InetAddress.getLocalHost()))).thenReturn(false) ;
 140         pubChInitializer.initChannel(mockSocketCh) ;
 141
 142         verify(mockSocketCh, times(1)).disconnect();
 143         verify(mockChPipeline, times(0))
 144         .addLast( any(String.class), any(ChannelHandler.class) ) ;
 145     }
 146
 147     /**
 148      * Test channel close on exception during initialization
 149      */
 150     @Test
 151     public void testExceptionThrown() {
 152         doThrow(new IllegalArgumentException()).when(mockSocketCh).pipeline() ;
 153         pubChInitializer.initChannel(mockSocketCh);
 154
 155         verify( mockSocketCh, times(1)).close() ;
 156     }
 157
 158     /**
 159      * All paths should install these six handlers:
 160      */
 161     private void verifyCommonHandlers() {
 162         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.IDLE_HANDLER.name()),any(IdleHandler.class)) ;
 163         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.OF_DECODER.name()),any(OFDecoder.class)) ;
 164         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.OF_ENCODER.name()),any(OFEncoder.class)) ;
 165         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.OF_FRAME_DECODER.name()),any(OFFrameDecoder.class)) ;
 166         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.OF_VERSION_DETECTOR.name()),any(OFVersionDetector.class)) ;
 167         verify(mockChPipeline, times(1)).addLast(eq(PipelineHandlers.DELEGATING_INBOUND_HANDLER.name()),any(DelegatingInboundHandler.class));
 168         assertEquals(1, pubChInitializer.size()) ;
 169     }
 170 }