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