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

   1 /*
   2  * Copyright (c) 2014 Pantheon Technologies 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
   9 package org.opendaylight.openflowjava.protocol.impl.core.connection;
  10
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Mockito.times;
  13 import static org.mockito.Mockito.verify;
  14 import static org.mockito.Mockito.when;
  15 import com.google.common.cache.Cache;
  16 import com.google.common.cache.CacheBuilder;
  17 import com.google.common.cache.RemovalListener;
  18 import com.google.common.cache.RemovalNotification;
  19 import io.netty.channel.ChannelFuture;
  20 import io.netty.channel.ChannelPipeline;
  21 import io.netty.channel.socket.SocketChannel;
  22 import java.net.InetSocketAddress;
  23 import java.util.concurrent.TimeUnit;
  24 import org.junit.Assert;
  25 import org.junit.Before;
  26 import org.junit.Test;
  27 import org.mockito.Mock;
  28 import org.mockito.MockitoAnnotations;
  29 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionReadyListener;
  30 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInput;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInputBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutputBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessageBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessageBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessageBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessageBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessageBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessageBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessageBuilder;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEventBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEventBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
  58 import org.opendaylight.yangtools.yang.binding.DataObject;
  59
  60 /**
  61  * @author michal.polkorab
  62  * @author madamjak
  63  *
  64  */
  65 public class ConnectionAdapterImplTest {
  66
  67     private static final int RPC_RESPONSE_EXPIRATION = 1;
  68     private static final RemovalListener<RpcResponseKey, ResponseExpectedRpcListener<?>> REMOVAL_LISTENER =
  69             new RemovalListener<RpcResponseKey, ResponseExpectedRpcListener<?>>() {
  70         @Override
  71         public void onRemoval(
  72                 final RemovalNotification<RpcResponseKey, ResponseExpectedRpcListener<?>> notification) {
  73             notification.getValue().discard();
  74         }
  75     };
  76
  77     @Mock SocketChannel channel;
  78     @Mock ChannelPipeline pipeline;
  79     @Mock OpenflowProtocolListener messageListener;
  80     @Mock SystemNotificationsListener systemListener;
  81     @Mock ConnectionReadyListener readyListener;
  82     @Mock Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> mockCache;
  83     @Mock ChannelFuture channelFuture;
  84
  85     private ConnectionAdapterImpl adapter;
  86     private Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> cache;
  87
  88     /**
  89      * Initializes ConnectionAdapter
  90      */
  91     @Before
  92     public void setUp() {
  93         MockitoAnnotations.initMocks(this);
  94         when(channel.pipeline()).thenReturn(pipeline);
  95         adapter = new ConnectionAdapterImpl(channel, InetSocketAddress.createUnresolved("10.0.0.1", 6653), true);
  96         adapter.setMessageListener(messageListener);
  97         adapter.setSystemListener(systemListener);
  98         adapter.setConnectionReadyListener(readyListener);
  99         cache = CacheBuilder.newBuilder().concurrencyLevel(1).expireAfterWrite(RPC_RESPONSE_EXPIRATION, TimeUnit.MINUTES)
 100                 .removalListener(REMOVAL_LISTENER).build();
 101         adapter.setResponseCache(cache);
 102         when(channel.disconnect()).thenReturn(channelFuture);
 103     }
 104
 105     /**
 106      * Tests {@link ConnectionAdapterImpl#consume(DataObject)} with notifications
 107      */
 108     @Test
 109     public void testConsume() {
 110         DataObject message = new EchoRequestMessageBuilder().build();
 111         adapter.consume(message);
 112         verify(messageListener, times(1)).onEchoRequestMessage((EchoRequestMessage) message);
 113         message = new ErrorMessageBuilder().build();
 114         adapter.consume(message);
 115         verify(messageListener, times(1)).onErrorMessage((ErrorMessage) message);
 116         message = new ExperimenterMessageBuilder().build();
 117         adapter.consume(message);
 118         verify(messageListener, times(1)).onExperimenterMessage((ExperimenterMessage) message);
 119         message = new FlowRemovedMessageBuilder().build();
 120         adapter.consume(message);
 121         verify(messageListener, times(1)).onFlowRemovedMessage((FlowRemovedMessage) message);
 122         message = new HelloMessageBuilder().build();
 123         adapter.consume(message);
 124         verify(messageListener, times(1)).onHelloMessage((HelloMessage) message);
 125         message = new MultipartReplyMessageBuilder().build();
 126         adapter.consume(message);
 127         verify(messageListener, times(1)).onMultipartReplyMessage((MultipartReplyMessage) message);
 128         message = new PacketInMessageBuilder().build();
 129         adapter.consume(message);
 130         verify(messageListener, times(1)).onPacketInMessage((PacketInMessage) message);
 131         message = new PortStatusMessageBuilder().build();
 132         adapter.consume(message);
 133         verify(messageListener, times(1)).onPortStatusMessage((PortStatusMessage) message);
 134         message = new SwitchIdleEventBuilder().build();
 135         adapter.consume(message);
 136         verify(systemListener, times(1)).onSwitchIdleEvent((SwitchIdleEvent) message);
 137         message = new DisconnectEventBuilder().build();
 138         adapter.consume(message);
 139         verify(systemListener, times(1)).onDisconnectEvent((DisconnectEvent) message);
 140         message = new EchoRequestMessageBuilder().build();
 141         adapter.consume(message);
 142         verify(messageListener, times(1)).onEchoRequestMessage((EchoRequestMessage) message);
 143     }
 144
 145     /**
 146      * Tests {@link ConnectionAdapterImpl#consume(DataObject)} with unexpected rpc
 147      */
 148     @Test
 149     public void testConsume2() {
 150         adapter.setResponseCache(mockCache);
 151         final BarrierOutputBuilder barrierBuilder = new BarrierOutputBuilder();
 152         barrierBuilder.setXid(42L);
 153         final BarrierOutput barrier = barrierBuilder.build();
 154         adapter.consume(barrier);
 155         verify(mockCache, times(1)).getIfPresent(any(RpcResponseKey.class));
 156     }
 157
 158     /**
 159      * Tests {@link ConnectionAdapterImpl#consume(DataObject)} with expected rpc
 160      */
 161     @Test
 162     public void testConsume3() {
 163         final BarrierInputBuilder inputBuilder = new BarrierInputBuilder();
 164         inputBuilder.setVersion((short) EncodeConstants.OF13_VERSION_ID);
 165         inputBuilder.setXid(42L);
 166         final BarrierInput barrierInput = inputBuilder.build();
 167         final RpcResponseKey key = new RpcResponseKey(42L, "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput");
 168         final ResponseExpectedRpcListener<OfHeader> listener = new ResponseExpectedRpcListener<>(barrierInput,
 169                 "failure", mockCache, key);
 170         cache.put(key, listener);
 171         final BarrierOutputBuilder barrierBuilder = new BarrierOutputBuilder();
 172         barrierBuilder.setXid(42L);
 173         final BarrierOutput barrierOutput = barrierBuilder.build();
 174         adapter.consume(barrierOutput);
 175         final ResponseExpectedRpcListener<?> ifPresent = cache.getIfPresent(key);
 176         Assert.assertNull("Listener was not discarded", ifPresent);
 177     }
 178     /**
 179      * Test IsAlive method
 180      */
 181     @Test
 182     public void testIsAlive(){
 183         final int port = 9876;
 184         final String host ="localhost";
 185         final InetSocketAddress inetSockAddr = InetSocketAddress.createUnresolved(host, port);
 186         final ConnectionAdapterImpl connAddapter = new ConnectionAdapterImpl(channel, inetSockAddr, true);
 187         Assert.assertEquals("Wrong - diffrence between channel.isOpen() and ConnectionAdapterImpl.isAlive()", channel.isOpen(), connAddapter.isAlive());
 188
 189         connAddapter.disconnect();
 190         Assert.assertFalse("Wrong - ConnectionAdapterImpl can not be alive after disconnet.", connAddapter.isAlive());
 191     }
 192
 193     /**
 194      * Test throw exception if no listeners are present
 195      */
 196     @Test(expected = java.lang.IllegalStateException.class)
 197     public void testMissingListeners(){
 198         final int port = 9876;
 199         final String host ="localhost";
 200         final InetSocketAddress inetSockAddr = InetSocketAddress.createUnresolved(host, port);
 201         final ConnectionAdapterImpl connAddapter = new ConnectionAdapterImpl(channel, inetSockAddr, true);
 202         connAddapter.setSystemListener(null);
 203         connAddapter.setMessageListener(null);
 204         connAddapter.setConnectionReadyListener(null);
 205         connAddapter.checkListeners();
 206     }
 207 }