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.ChannelFuture;
  16 import io.netty.channel.EventLoopGroup;
  17 import io.netty.channel.socket.DatagramPacket;
  18 import io.netty.channel.socket.nio.NioDatagramChannel;
  19 import java.lang.reflect.Field;
  20 import java.net.InetAddress;
  21 import java.net.InetSocketAddress;
  22 import java.net.UnknownHostException;
  23 import java.nio.ByteBuffer;
  24 import org.junit.Before;
  25 import org.junit.Test;
  26 import org.junit.runner.RunWith;
  27 import org.mockito.ArgumentCaptor;
  28 import org.mockito.Mockito;
  29 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  30 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  31 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
  32 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
  33 import org.opendaylight.lispflowmapping.southbound.lisp.LispSouthboundHandler;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.IpAddressBinary;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.Ipv4AddressBinary;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.inet.binary.types.rev160303.Ipv6AddressBinary;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MessageType;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.OdlLispSbService;
  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         lispSouthboundPlugin.setBindingAddress(ADDRESS_1);
  78         lispSouthboundPlugin.setMapRegisterCacheEnabled(false);
  79         channel = PowerMockito.mock(NioDatagramChannel.class);
  80         xtrChannel = PowerMockito.mock(NioDatagramChannel.class);
  81         injectChannel();
  82         injectXtrChannel();
  83     }
  84
  85     /**
  86      * Tests {@link LispSouthboundPlugin#handleSerializedLispBuffer} method with ipv4.
  87      *
  88      * @throws NoSuchFieldException
  89      * @throws IllegalAccessException
  90      * @throws UnknownHostException
  91      */
  92     @Test
  93     public void handleSerializedLispBufferTest_withIpv4() throws
  94             NoSuchFieldException, IllegalAccessException, UnknownHostException {
  95         final ArgumentCaptor<DatagramPacket> captor = ArgumentCaptor.forClass(DatagramPacket.class);
  96         final InetAddress address = InetAddress.getByAddress(IPV4_BINARY.getIpv4AddressBinary().getValue());
  97         final InetSocketAddress inetSocketAddress = new InetSocketAddress(address, PORT);
  98
  99         // Ensures that NPE is not thrown.
 100         Mockito.when(channel.write(Mockito.any())).thenReturn(Mockito.mock(ChannelFuture.class));
 101
 102         lispSouthboundPlugin.handleSerializedLispBuffer(TRANSPORT_ADDRESS_IPV4, PACKET, MessageType.MapRequest);
 103         Mockito.verify(channel).write(captor.capture());
 104         Mockito.verify(channel).flush();
 105
 106         final DatagramPacket result = captor.getValue();
 107         assertArrayEquals(PACKET.array(), result.content().array());
 108         assertEquals(inetSocketAddress, result.recipient());
 109     }
 110
 111     /**
 112      * Tests {@link LispSouthboundPlugin#handleSerializedLispBuffer} method with ipv6.
 113      *
 114      * @throws NoSuchFieldException
 115      * @throws IllegalAccessException
 116      * @throws UnknownHostException
 117      */
 118     @Test
 119     public void handleSerializedLispBufferTest_withIpv6() throws
 120             NoSuchFieldException, IllegalAccessException, UnknownHostException {
 121         final ArgumentCaptor<DatagramPacket> captor = ArgumentCaptor.forClass(DatagramPacket.class);
 122         final InetAddress address = InetAddress.getByAddress(IPV6_BINARY.getIpv6AddressBinary().getValue());
 123         final InetSocketAddress inetSocketAddress = new InetSocketAddress(address, PORT);
 124
 125         // Ensures that NPE is not thrown.
 126         Mockito.when(channel.write(Mockito.any())).thenReturn(Mockito.mock(ChannelFuture.class));
 127
 128         lispSouthboundPlugin.handleSerializedLispBuffer(TRANSPORT_ADDRESS_IPV6, PACKET, MessageType.MapRequest);
 129         Mockito.verify(channel).write(captor.capture());
 130         Mockito.verify(channel).flush();
 131
 132         final DatagramPacket result = captor.getValue();
 133         assertArrayEquals(PACKET.array(), result.content().array());
 134         assertEquals(inetSocketAddress, result.recipient());
 135     }
 136
 137     /**
 138      * Tests {@link LispSouthboundPlugin#setLispAddress} method - binding address has changed.
 139      */
 140     @Test
 141     public void setLispAddressTest_withEqualAddress() throws NoSuchFieldException, IllegalAccessException {
 142         injectField("bootstrap", BOOTSTRAP_MOCK);
 143         lispSouthboundPlugin.setLispAddress(ADDRESS_2);
 144
 145         Mockito.verify(BOOTSTRAP_MOCK).bind(ADDRESS_2, LispMessage.PORT_NUM);
 146         Mockito.verify(channel).close();
 147     }
 148
 149     /**
 150      * Tests {@link LispSouthboundPlugin#setLispAddress} method - binding address has not changed.
 151      */
 152     @Test
 153     public void setLispAddressTest_withChangedAddress() throws NoSuchFieldException, IllegalAccessException {
 154         injectField("bootstrap", BOOTSTRAP_MOCK);
 155         lispSouthboundPlugin.setLispAddress(ADDRESS_1);
 156
 157         Mockito.verifyZeroInteractions(BOOTSTRAP_MOCK);
 158         Mockito.verifyZeroInteractions(channel);
 159     }
 160
 161     /**
 162      * Tests {@link LispSouthboundPlugin#shouldListenOnXtrPort} method, shouldListenOnXtrPort == true.
 163      */
 164     @Test
 165     public void shouldListenOnXtrPortTest_true() throws NoSuchFieldException, IllegalAccessException {
 166         lispSouthboundPlugin.shouldListenOnXtrPort(true);
 167
 168         Mockito.verify(xtrChannel).close();
 169     }
 170
 171     /**
 172      * Tests {@link LispSouthboundPlugin#shouldListenOnXtrPort} method, shouldListenOnXtrPort == false.
 173      */
 174     @Test
 175     public void shouldListenOnXtrPortTest_false() throws NoSuchFieldException, IllegalAccessException {
 176         lispSouthboundPlugin.shouldListenOnXtrPort(false);
 177
 178         Mockito.verifyZeroInteractions(xtrChannel);
 179     }
 180
 181     /**
 182      * Tests {@link LispSouthboundPlugin#setXtrPort} method.
 183      */
 184     @Test
 185     public void setXtrPortTest() throws NoSuchFieldException, IllegalAccessException {
 186         lispSouthboundPlugin.shouldListenOnXtrPort(true);
 187         lispSouthboundPlugin.setXtrPort(PORT);
 188
 189         Mockito.verify(xtrChannel, Mockito.times(2)).close();
 190         assertEquals(PORT, (int) LispSouthboundPluginTest.<Integer>getField("xtrPort"));
 191     }
 192
 193     /**
 194      * Tests {@link LispSouthboundPlugin#close} method.
 195      */
 196     @Test
 197     @SuppressWarnings("unchecked")
 198     public void closeTest() throws Exception {
 199         EventLoopGroup elgMock = Mockito.mock(EventLoopGroup.class);
 200         LispSouthboundPluginTest.injectField("eventLoopGroup", elgMock);
 201
 202         BindingAwareBroker.RpcRegistration<OdlLispSbService> registrationMock =
 203                 Mockito.mock(BindingAwareBroker.RpcRegistration.class);
 204         LispSouthboundPluginTest.injectField("sbRpcRegistration", registrationMock);
 205
 206         LispSouthboundHandler handlerMock = Mockito.mock(LispSouthboundHandler.class);
 207         LispSouthboundPluginTest.injectField("lispSouthboundHandler", handlerMock);
 208         Mockito.when(channel.close()).thenReturn(Mockito.mock(ChannelFuture.class));
 209
 210         lispSouthboundPlugin.close();
 211
 212         Mockito.verify(channel).close();
 213         Mockito.verify(elgMock).shutdownGracefully();
 214         Mockito.verify(registrationMock).close();
 215         Mockito.verify(handlerMock).close();
 216         assertNull(getField("lispSouthboundHandler"));
 217         assertNull(getField("lispXtrSouthboundHandler"));
 218         assertNull(getField("channel"));
 219     }
 220
 221     private static void injectChannel() throws NoSuchFieldException, IllegalAccessException {
 222         final Field channelField = LispSouthboundPlugin.class.getDeclaredField("channel");
 223         channelField.setAccessible(true);
 224         channelField.set(lispSouthboundPlugin, channel);
 225     }
 226
 227     private static void injectXtrChannel() throws NoSuchFieldException, IllegalAccessException {
 228         final Field xtrChannelField = LispSouthboundPlugin.class.getDeclaredField("xtrChannel");
 229         xtrChannelField.setAccessible(true);
 230         xtrChannelField.set(lispSouthboundPlugin, xtrChannel);
 231     }
 232
 233     private static ByteBuffer parseHexString(String packet) {
 234         final String[] tokens = packet.split("\\s+");
 235         final ByteBuffer buffer = ByteBuffer.allocate(tokens.length);
 236         for (String token : tokens) {
 237              buffer.put((byte) Integer.parseInt(token, 16));
 238         }
 239
 240         return buffer;
 241     }
 242
 243     private static <T> void injectField(String fieldName, T obj) throws NoSuchFieldException, IllegalAccessException {
 244         Field field = LispSouthboundPlugin.class.getDeclaredField(fieldName);
 245         field.setAccessible(true);
 246         field.set(lispSouthboundPlugin, obj);
 247     }
 248
 249     @SuppressWarnings("unchecked")
 250     private static <T> T getField(String fieldName) throws NoSuchFieldException, IllegalAccessException {
 251         Field field = LispSouthboundPlugin.class.getDeclaredField(fieldName);
 252         field.setAccessible(true);
 253
 254         return (T) field.get(lispSouthboundPlugin);
 255     }
 256 }