OPNFLWPLUG-1032: Neon-MRI: Bump odlparent, yangtools, mdsal
[openflowplugin.git] / openflowjava / 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.ArgumentMatchers.any;
12 import static org.mockito.Mockito.times;
13 import static org.mockito.Mockito.verify;
14 import static org.mockito.Mockito.when;
15
16 import com.google.common.cache.Cache;
17 import com.google.common.cache.CacheBuilder;
18 import com.google.common.cache.RemovalListener;
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  * Unit test for ConnectionAdapterImpl.
62  *
63  * @author michal.polkorab
64  * @author madamjak
65  */
66 public class ConnectionAdapterImplTest {
67
68     private static final int RPC_RESPONSE_EXPIRATION = 1;
69     private static final int CHANNEL_OUTBOUND_QUEUE_SIZE = 1024;
70     private static final RemovalListener<RpcResponseKey, ResponseExpectedRpcListener<?>> REMOVAL_LISTENER =
71         notification -> notification.getValue().discard();
72
73     @Mock SocketChannel channel;
74     @Mock ChannelPipeline pipeline;
75     @Mock OpenflowProtocolListener messageListener;
76     @Mock SystemNotificationsListener systemListener;
77     @Mock ConnectionReadyListener readyListener;
78     @Mock Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> mockCache;
79     @Mock ChannelFuture channelFuture;
80
81     private ConnectionAdapterImpl adapter;
82     private Cache<RpcResponseKey, ResponseExpectedRpcListener<?>> cache;
83
84     /**
85      * Initializes ConnectionAdapter.
86      */
87     @Before
88     public void setUp() {
89         MockitoAnnotations.initMocks(this);
90         when(channel.pipeline()).thenReturn(pipeline);
91         adapter = new ConnectionAdapterImpl(channel, InetSocketAddress.createUnresolved("10.0.0.1", 6653), true,
92                 CHANNEL_OUTBOUND_QUEUE_SIZE);
93         adapter.setMessageListener(messageListener);
94         adapter.setSystemListener(systemListener);
95         adapter.setConnectionReadyListener(readyListener);
96         cache = CacheBuilder.newBuilder().concurrencyLevel(1)
97                 .expireAfterWrite(RPC_RESPONSE_EXPIRATION, TimeUnit.MINUTES).removalListener(REMOVAL_LISTENER).build();
98         adapter.setResponseCache(cache);
99         when(channel.disconnect()).thenReturn(channelFuture);
100     }
101
102     /**
103      * Tests {@link ConnectionAdapterImpl#consume(DataObject)} with notifications.
104      */
105     @Test
106     public void testConsume() {
107         DataObject message = new EchoRequestMessageBuilder().build();
108         adapter.consume(message);
109         verify(messageListener, times(1)).onEchoRequestMessage((EchoRequestMessage) message);
110         message = new ErrorMessageBuilder().build();
111         adapter.consume(message);
112         verify(messageListener, times(1)).onErrorMessage((ErrorMessage) message);
113         message = new ExperimenterMessageBuilder().build();
114         adapter.consume(message);
115         verify(messageListener, times(1)).onExperimenterMessage((ExperimenterMessage) message);
116         message = new FlowRemovedMessageBuilder().build();
117         adapter.consume(message);
118         verify(messageListener, times(1)).onFlowRemovedMessage((FlowRemovedMessage) message);
119         message = new HelloMessageBuilder().build();
120         adapter.consume(message);
121         verify(messageListener, times(1)).onHelloMessage((HelloMessage) message);
122         message = new MultipartReplyMessageBuilder().build();
123         adapter.consume(message);
124         verify(messageListener, times(1)).onMultipartReplyMessage((MultipartReplyMessage) message);
125         message = new PacketInMessageBuilder().build();
126         adapter.consume(message);
127         verify(messageListener, times(1)).onPacketInMessage((PacketInMessage) message);
128         message = new PortStatusMessageBuilder().build();
129         adapter.consume(message);
130         verify(messageListener, times(1)).onPortStatusMessage((PortStatusMessage) message);
131         message = new SwitchIdleEventBuilder().build();
132         adapter.consume(message);
133         verify(systemListener, times(1)).onSwitchIdleEvent((SwitchIdleEvent) message);
134         message = new DisconnectEventBuilder().build();
135         adapter.consume(message);
136         verify(systemListener, times(1)).onDisconnectEvent((DisconnectEvent) message);
137         message = new EchoRequestMessageBuilder().build();
138         adapter.consume(message);
139         verify(messageListener, times(1)).onEchoRequestMessage((EchoRequestMessage) message);
140     }
141
142     /**
143      * Tests {@link ConnectionAdapterImpl#consume(DataObject)} with unexpected rpc.
144      */
145     @Test
146     public void testConsume2() {
147         adapter.setResponseCache(mockCache);
148         final BarrierOutputBuilder barrierBuilder = new BarrierOutputBuilder();
149         barrierBuilder.setXid(42L);
150         final BarrierOutput barrier = barrierBuilder.build();
151         adapter.consume(barrier);
152         verify(mockCache, times(1)).getIfPresent(any(RpcResponseKey.class));
153     }
154
155     /**
156      * Tests {@link ConnectionAdapterImpl#consume(DataObject)} with expected rpc.
157      */
158     @Test
159     public void testConsume3() {
160         final BarrierInputBuilder inputBuilder = new BarrierInputBuilder();
161         inputBuilder.setVersion((short) EncodeConstants.OF13_VERSION_ID);
162         inputBuilder.setXid(42L);
163         final BarrierInput barrierInput = inputBuilder.build();
164         final RpcResponseKey key = new RpcResponseKey(42L,
165                 "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput");
166         final ResponseExpectedRpcListener<OfHeader> listener = new ResponseExpectedRpcListener<>(barrierInput,
167                 "failure", mockCache, key);
168         cache.put(key, listener);
169         final BarrierOutputBuilder barrierBuilder = new BarrierOutputBuilder();
170         barrierBuilder.setXid(42L);
171         final BarrierOutput barrierOutput = barrierBuilder.build();
172         adapter.consume(barrierOutput);
173         final ResponseExpectedRpcListener<?> ifPresent = cache.getIfPresent(key);
174         Assert.assertNull("Listener was not discarded", ifPresent);
175     }
176
177     /**
178      * Test IsAlive method.
179      */
180     @Test
181     public void testIsAlive() {
182         final int port = 9876;
183         final String host = "localhost";
184         final InetSocketAddress inetSockAddr = InetSocketAddress.createUnresolved(host, port);
185         final ConnectionAdapterImpl connAddapter = new ConnectionAdapterImpl(channel, inetSockAddr, true,
186                 CHANNEL_OUTBOUND_QUEUE_SIZE);
187         Assert.assertEquals("Wrong - diffrence between channel.isOpen() and ConnectionAdapterImpl.isAlive()",
188                 channel.isOpen(), connAddapter.isAlive());
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                 CHANNEL_OUTBOUND_QUEUE_SIZE);
203         connAddapter.setSystemListener(null);
204         connAddapter.setMessageListener(null);
205         connAddapter.setConnectionReadyListener(null);
206         connAddapter.checkListeners();
207     }
208 }