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