mappingservice/southbound/src/test/java/org/opendaylight/lispflowmapping/southbound/LispSouthboundPluginTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco 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 package org.opendaylight.lispflowmapping.southbound;
   9
  10 import static org.junit.Assert.assertArrayEquals;
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNull;
  13
  14 import io.netty.bootstrap.Bootstrap;
  15 import io.netty.channel.Channel;
  16 import io.netty.channel.ChannelFuture;
  17 import io.netty.channel.EventLoopGroup;
  18 import io.netty.channel.socket.DatagramPacket;
  19 import io.netty.channel.socket.nio.NioDatagramChannel;
  20 import java.lang.reflect.Field;
  21 import java.net.InetAddress;
  22 import java.net.InetSocketAddress;
  23 import java.net.UnknownHostException;
  24 import java.nio.ByteBuffer;
  25 import org.junit.Before;
  26 import org.junit.Test;
  27 import org.mockito.ArgumentCaptor;
  28 import org.mockito.Mockito;
  29 import org.opendaylight.lispflowmapping.dsbackend.DataStoreBackEnd;
  30 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
  31 import org.opendaylight.lispflowmapping.southbound.lisp.LispSouthboundHandler;
  32 import org.opendaylight.mdsal.binding.api.DataBroker;
  33 import org.opendaylight.mdsal.binding.api.NotificationPublishService;
  34 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.Ipv4AddressBinary;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.Ipv6AddressBinary;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MessageType;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
  42 import org.opendaylight.yangtools.yang.common.Uint16;
  43
  44 public class LispSouthboundPluginTest {
  45
  46     private static NioDatagramChannel channel;
  47     private static NioDatagramChannel xtrChannel;
  48     private static LispSouthboundPlugin lispSouthboundPlugin;
  49     private static final Bootstrap BOOTSTRAP_MOCK = Mockito.mock(Bootstrap.class);
  50
  51     private static final String LISP_MAP_REQUEST_PACKET_STRING =
  52             "10 00 00 01 3d 8d 2a cd 39 c8 d6 08 00 01 01 02 03 04 00 01 7f 00 00 02 00 20 00 01 7f 00 00 01";
  53     private static final String ADDRESS_1 = "0.0.0.0";
  54     private static final String ADDRESS_2 = "1.1.1.1";
  55     private static final ByteBuffer PACKET = parseHexString(LISP_MAP_REQUEST_PACKET_STRING);
  56     private static final int PORT = 9999;
  57     private static final byte[] IPV4_BYTES = new byte[]{1, 2, 3, 4};
  58     private static final byte[] IPV6_BYTES = new byte[]{11, 11, 22, 22, 33, 33, 44, 44, 55, 55, 66, 66, 77, 77, 88, 88};
  59     private static final IpAddressBinary IPV4_BINARY = new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES));
  60     private static final IpAddressBinary IPV6_BINARY = new IpAddressBinary(new Ipv6AddressBinary(IPV6_BYTES));
  61     private static final TransportAddress TRANSPORT_ADDRESS_IPV4 = new TransportAddressBuilder()
  62             .setIpAddress(IPV4_BINARY)
  63             .setPort(new PortNumber(Uint16.valueOf(PORT))).build();
  64     private static final TransportAddress TRANSPORT_ADDRESS_IPV6 = new TransportAddressBuilder()
  65             .setIpAddress(IPV6_BINARY)
  66             .setPort(new PortNumber(Uint16.valueOf(PORT))).build();
  67
  68     @Before
  69     public void init() throws NoSuchFieldException, IllegalAccessException, InterruptedException {
  70         lispSouthboundPlugin = new LispSouthboundPlugin(
  71                 Mockito.mock(DataBroker.class),
  72                 Mockito.mock(NotificationPublishService.class),
  73                 Mockito.mock(ClusterSingletonServiceProvider.class));
  74         lispSouthboundPlugin.setBindingAddress(ADDRESS_1);
  75         lispSouthboundPlugin.setMapRegisterCacheEnabled(false);
  76
  77         channel = Mockito.mock(NioDatagramChannel.class);
  78         xtrChannel = Mockito.mock(NioDatagramChannel.class);
  79         injectChannel();
  80         injectXtrChannel();
  81     }
  82
  83     /**
  84      * Tests {@link LispSouthboundPlugin#handleSerializedLispBuffer} method with ipv4.
  85      */
  86     @Test
  87     public void handleSerializedLispBufferTest_withIpv4() throws
  88             NoSuchFieldException, IllegalAccessException, UnknownHostException {
  89         final ArgumentCaptor<DatagramPacket> captor = ArgumentCaptor.forClass(DatagramPacket.class);
  90         final InetAddress address = InetAddress.getByAddress(IPV4_BINARY.getIpv4AddressBinary().getValue());
  91         final InetSocketAddress inetSocketAddress = new InetSocketAddress(address, PORT);
  92
  93         // Ensures that NPE is not thrown.
  94         Mockito.when(channel.write(Mockito.any())).thenReturn(Mockito.mock(ChannelFuture.class));
  95
  96         lispSouthboundPlugin.handleSerializedLispBuffer(TRANSPORT_ADDRESS_IPV4, PACKET, MessageType.MapRequest);
  97         Mockito.verify(channel).write(captor.capture());
  98         Mockito.verify(channel).flush();
  99
 100         final DatagramPacket result = captor.getValue();
 101         assertArrayEquals(PACKET.array(), result.content().array());
 102         assertEquals(inetSocketAddress, result.recipient());
 103     }
 104
 105     /**
 106      * Tests {@link LispSouthboundPlugin#handleSerializedLispBuffer} method with ipv6.
 107      */
 108     @Test
 109     public void handleSerializedLispBufferTest_withIpv6() throws
 110             NoSuchFieldException, IllegalAccessException, UnknownHostException {
 111         final ArgumentCaptor<DatagramPacket> captor = ArgumentCaptor.forClass(DatagramPacket.class);
 112         final InetAddress address = InetAddress.getByAddress(IPV6_BINARY.getIpv6AddressBinary().getValue());
 113         final InetSocketAddress inetSocketAddress = new InetSocketAddress(address, PORT);
 114
 115         // Ensures that NPE is not thrown.
 116         Mockito.when(channel.write(Mockito.any())).thenReturn(Mockito.mock(ChannelFuture.class));
 117
 118         lispSouthboundPlugin.handleSerializedLispBuffer(TRANSPORT_ADDRESS_IPV6, PACKET, MessageType.MapRequest);
 119         Mockito.verify(channel).write(captor.capture());
 120         Mockito.verify(channel).flush();
 121
 122         final DatagramPacket result = captor.getValue();
 123         assertArrayEquals(PACKET.array(), result.content().array());
 124         assertEquals(inetSocketAddress, result.recipient());
 125     }
 126
 127     /**
 128      * Tests {@link LispSouthboundPlugin#setLispAddress} method - binding address has changed.
 129      */
 130     @Test
 131     public void setLispAddressTest_withEqualAddress() throws NoSuchFieldException, IllegalAccessException {
 132         injectField("bootstrap", BOOTSTRAP_MOCK);
 133         lispSouthboundPlugin.setLispAddress(ADDRESS_2);
 134
 135         Mockito.verify(BOOTSTRAP_MOCK).bind(ADDRESS_2, LispMessage.PORT_NUM);
 136         Mockito.verify(channel).close();
 137     }
 138
 139     /**
 140      * Tests {@link LispSouthboundPlugin#setLispAddress} method - binding address has not changed.
 141      */
 142     @Test
 143     public void setLispAddressTest_withChangedAddress() throws NoSuchFieldException, IllegalAccessException {
 144         injectField("bootstrap", BOOTSTRAP_MOCK);
 145         lispSouthboundPlugin.setLispAddress(ADDRESS_1);
 146
 147         Mockito.verifyNoInteractions(BOOTSTRAP_MOCK);
 148         Mockito.verifyNoInteractions(channel);
 149     }
 150
 151     /**
 152      * Tests {@link LispSouthboundPlugin#shouldListenOnXtrPort} method, shouldListenOnXtrPort == true.
 153      */
 154     @Test
 155     public void shouldListenOnXtrPortTest_true() throws NoSuchFieldException, IllegalAccessException {
 156         lispSouthboundPlugin.shouldListenOnXtrPort(true);
 157
 158         Mockito.verify(xtrChannel).close();
 159     }
 160
 161     /**
 162      * Tests {@link LispSouthboundPlugin#shouldListenOnXtrPort} method, shouldListenOnXtrPort == false.
 163      */
 164     @Test
 165     public void shouldListenOnXtrPortTest_false() throws NoSuchFieldException, IllegalAccessException {
 166         lispSouthboundPlugin.shouldListenOnXtrPort(false);
 167
 168         Mockito.verifyNoInteractions(xtrChannel);
 169     }
 170
 171     /**
 172      * Tests {@link LispSouthboundPlugin#setXtrPort} method.
 173      */
 174     @Test
 175     public void setXtrPortTest() throws NoSuchFieldException, IllegalAccessException {
 176         lispSouthboundPlugin.shouldListenOnXtrPort(true);
 177         lispSouthboundPlugin.setXtrPort(PORT);
 178
 179         Mockito.verify(xtrChannel, Mockito.times(2)).close();
 180         assertEquals(PORT, (int) LispSouthboundPluginTest.<Integer>getField("xtrPort"));
 181     }
 182
 183     /**
 184      * Tests {@link LispSouthboundPlugin#close} method.
 185      */
 186     @Test
 187     public void closeTest() throws Exception {
 188         EventLoopGroup elgMock = Mockito.mock(EventLoopGroup.class);
 189         LispSouthboundPluginTest.injectField("eventLoopGroup", elgMock);
 190         DataStoreBackEnd dsbeMock = Mockito.mock(DataStoreBackEnd.class);
 191         LispSouthboundPluginTest.injectField("dsbe", dsbeMock);
 192
 193         LispSouthboundHandler handlerMock = Mockito.mock(LispSouthboundHandler.class);
 194         LispSouthboundPluginTest.injectField("lispSouthboundHandler", handlerMock);
 195         Mockito.when(channel.close()).thenReturn(Mockito.mock(ChannelFuture.class));
 196
 197         lispSouthboundPlugin.close();
 198
 199         Mockito.verify(channel).close();
 200         Mockito.verify(elgMock).shutdownGracefully();
 201         Mockito.verify(handlerMock).close();
 202         assertNull(getField("lispSouthboundHandler"));
 203         assertNull(getField("lispXtrSouthboundHandler"));
 204         Channel[] channels = getField("channel");
 205         assertNull(channels[0]);
 206     }
 207
 208     private static void injectChannel() throws NoSuchFieldException, IllegalAccessException {
 209         final Field channelField = LispSouthboundPlugin.class.getDeclaredField("channel");
 210         channelField.setAccessible(true);
 211         channelField.set(lispSouthboundPlugin, new Channel[] { channel });
 212     }
 213
 214     private static void injectXtrChannel() throws NoSuchFieldException, IllegalAccessException {
 215         final Field xtrChannelField = LispSouthboundPlugin.class.getDeclaredField("xtrChannel");
 216         xtrChannelField.setAccessible(true);
 217         xtrChannelField.set(lispSouthboundPlugin, xtrChannel);
 218     }
 219
 220     private static ByteBuffer parseHexString(String packet) {
 221         final String[] tokens = packet.split("\\s+");
 222         final ByteBuffer buffer = ByteBuffer.allocate(tokens.length);
 223         for (String token : tokens) {
 224             buffer.put((byte) Integer.parseInt(token, 16));
 225         }
 226
 227         return buffer;
 228     }
 229
 230     private static <T> void injectField(String fieldName, T obj) throws NoSuchFieldException, IllegalAccessException {
 231         Field field = LispSouthboundPlugin.class.getDeclaredField(fieldName);
 232         field.setAccessible(true);
 233         field.set(lispSouthboundPlugin, obj);
 234     }
 235
 236     @SuppressWarnings("unchecked")
 237     private static <T> T getField(String fieldName) throws NoSuchFieldException, IllegalAccessException {
 238         Field field = LispSouthboundPlugin.class.getDeclaredField(fieldName);
 239         field.setAccessible(true);
 240
 241         return (T) field.get(lispSouthboundPlugin);
 242     }
 243 }