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     @Test
  89     public void handleSerializedLispBufferTest_withIpv4() throws
  90             NoSuchFieldException, IllegalAccessException, UnknownHostException {
  91         final ArgumentCaptor<DatagramPacket> captor = ArgumentCaptor.forClass(DatagramPacket.class);
  92         final InetAddress address = InetAddress.getByAddress(IPV4_BINARY.getIpv4AddressBinary().getValue());
  93         final InetSocketAddress inetSocketAddress = new InetSocketAddress(address, PORT);
  94
  95         // Ensures that NPE is not thrown.
  96         Mockito.when(channel.write(Mockito.any())).thenReturn(Mockito.mock(ChannelFuture.class));
  97
  98         lispSouthboundPlugin.handleSerializedLispBuffer(TRANSPORT_ADDRESS_IPV4, PACKET, MessageType.MapRequest);
  99         Mockito.verify(channel).write(captor.capture());
 100         Mockito.verify(channel).flush();
 101
 102         final DatagramPacket result = captor.getValue();
 103         assertArrayEquals(PACKET.array(), result.content().array());
 104         assertEquals(inetSocketAddress, result.recipient());
 105     }
 106
 107     /**
 108      * Tests {@link LispSouthboundPlugin#handleSerializedLispBuffer} method with ipv6.
 109      */
 110     @Test
 111     public void handleSerializedLispBufferTest_withIpv6() throws
 112             NoSuchFieldException, IllegalAccessException, UnknownHostException {
 113         final ArgumentCaptor<DatagramPacket> captor = ArgumentCaptor.forClass(DatagramPacket.class);
 114         final InetAddress address = InetAddress.getByAddress(IPV6_BINARY.getIpv6AddressBinary().getValue());
 115         final InetSocketAddress inetSocketAddress = new InetSocketAddress(address, PORT);
 116
 117         // Ensures that NPE is not thrown.
 118         Mockito.when(channel.write(Mockito.any())).thenReturn(Mockito.mock(ChannelFuture.class));
 119
 120         lispSouthboundPlugin.handleSerializedLispBuffer(TRANSPORT_ADDRESS_IPV6, PACKET, MessageType.MapRequest);
 121         Mockito.verify(channel).write(captor.capture());
 122         Mockito.verify(channel).flush();
 123
 124         final DatagramPacket result = captor.getValue();
 125         assertArrayEquals(PACKET.array(), result.content().array());
 126         assertEquals(inetSocketAddress, result.recipient());
 127     }
 128
 129     /**
 130      * Tests {@link LispSouthboundPlugin#setLispAddress} method - binding address has changed.
 131      */
 132     @Test
 133     public void setLispAddressTest_withEqualAddress() throws NoSuchFieldException, IllegalAccessException {
 134         injectField("bootstrap", BOOTSTRAP_MOCK);
 135         lispSouthboundPlugin.setLispAddress(ADDRESS_2);
 136
 137         Mockito.verify(BOOTSTRAP_MOCK).bind(ADDRESS_2, LispMessage.PORT_NUM);
 138         Mockito.verify(channel).close();
 139     }
 140
 141     /**
 142      * Tests {@link LispSouthboundPlugin#setLispAddress} method - binding address has not changed.
 143      */
 144     @Test
 145     public void setLispAddressTest_withChangedAddress() throws NoSuchFieldException, IllegalAccessException {
 146         injectField("bootstrap", BOOTSTRAP_MOCK);
 147         lispSouthboundPlugin.setLispAddress(ADDRESS_1);
 148
 149         Mockito.verifyZeroInteractions(BOOTSTRAP_MOCK);
 150         Mockito.verifyZeroInteractions(channel);
 151     }
 152
 153     /**
 154      * Tests {@link LispSouthboundPlugin#shouldListenOnXtrPort} method, shouldListenOnXtrPort == true.
 155      */
 156     @Test
 157     public void shouldListenOnXtrPortTest_true() throws NoSuchFieldException, IllegalAccessException {
 158         lispSouthboundPlugin.shouldListenOnXtrPort(true);
 159
 160         Mockito.verify(xtrChannel).close();
 161     }
 162
 163     /**
 164      * Tests {@link LispSouthboundPlugin#shouldListenOnXtrPort} method, shouldListenOnXtrPort == false.
 165      */
 166     @Test
 167     public void shouldListenOnXtrPortTest_false() throws NoSuchFieldException, IllegalAccessException {
 168         lispSouthboundPlugin.shouldListenOnXtrPort(false);
 169
 170         Mockito.verifyZeroInteractions(xtrChannel);
 171     }
 172
 173     /**
 174      * Tests {@link LispSouthboundPlugin#setXtrPort} method.
 175      */
 176     @Test
 177     public void setXtrPortTest() throws NoSuchFieldException, IllegalAccessException {
 178         lispSouthboundPlugin.shouldListenOnXtrPort(true);
 179         lispSouthboundPlugin.setXtrPort(PORT);
 180
 181         Mockito.verify(xtrChannel, Mockito.times(2)).close();
 182         assertEquals(PORT, (int) LispSouthboundPluginTest.<Integer>getField("xtrPort"));
 183     }
 184
 185     /**
 186      * Tests {@link LispSouthboundPlugin#close} method.
 187      */
 188     @Test
 189     @SuppressWarnings("unchecked")
 190     public void closeTest() throws Exception {
 191         EventLoopGroup elgMock = Mockito.mock(EventLoopGroup.class);
 192         LispSouthboundPluginTest.injectField("eventLoopGroup", elgMock);
 193
 194         BindingAwareBroker.RpcRegistration<OdlLispSbService> registrationMock =
 195                 Mockito.mock(BindingAwareBroker.RpcRegistration.class);
 196         LispSouthboundPluginTest.injectField("sbRpcRegistration", registrationMock);
 197
 198         LispSouthboundHandler handlerMock = Mockito.mock(LispSouthboundHandler.class);
 199         LispSouthboundPluginTest.injectField("lispSouthboundHandler", handlerMock);
 200         Mockito.when(channel.close()).thenReturn(Mockito.mock(ChannelFuture.class));
 201
 202         lispSouthboundPlugin.close();
 203
 204         Mockito.verify(channel).close();
 205         Mockito.verify(elgMock).shutdownGracefully();
 206         Mockito.verify(registrationMock).close();
 207         Mockito.verify(handlerMock).close();
 208         assertNull(getField("lispSouthboundHandler"));
 209         assertNull(getField("lispXtrSouthboundHandler"));
 210         assertNull(getField("channel"));
 211     }
 212
 213     private static void injectChannel() throws NoSuchFieldException, IllegalAccessException {
 214         final Field channelField = LispSouthboundPlugin.class.getDeclaredField("channel");
 215         channelField.setAccessible(true);
 216         channelField.set(lispSouthboundPlugin, channel);
 217     }
 218
 219     private static void injectXtrChannel() throws NoSuchFieldException, IllegalAccessException {
 220         final Field xtrChannelField = LispSouthboundPlugin.class.getDeclaredField("xtrChannel");
 221         xtrChannelField.setAccessible(true);
 222         xtrChannelField.set(lispSouthboundPlugin, xtrChannel);
 223     }
 224
 225     private static ByteBuffer parseHexString(String packet) {
 226         final String[] tokens = packet.split("\\s+");
 227         final ByteBuffer buffer = ByteBuffer.allocate(tokens.length);
 228         for (String token : tokens) {
 229             buffer.put((byte) Integer.parseInt(token, 16));
 230         }
 231
 232         return buffer;
 233     }
 234
 235     private static <T> void injectField(String fieldName, T obj) throws NoSuchFieldException, IllegalAccessException {
 236         Field field = LispSouthboundPlugin.class.getDeclaredField(fieldName);
 237         field.setAccessible(true);
 238         field.set(lispSouthboundPlugin, obj);
 239     }
 240
 241     @SuppressWarnings("unchecked")
 242     private static <T> T getField(String fieldName) throws NoSuchFieldException, IllegalAccessException {
 243         Field field = LispSouthboundPlugin.class.getDeclaredField(fieldName);
 244         field.setAccessible(true);
 245
 246         return (T) field.get(lispSouthboundPlugin);
 247     }
 248 }