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