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