2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.lispflowmapping.implementation;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNull;
13 import com.google.common.collect.Lists;
14 import java.lang.reflect.Field;
15 import java.util.ArrayList;
16 import java.util.List;
17 import org.apache.commons.lang3.tuple.ImmutablePair;
18 import org.apache.commons.lang3.tuple.MutablePair;
19 import org.apache.commons.lang3.tuple.Pair;
20 import org.junit.Test;
21 import org.junit.runner.RunWith;
22 import org.mockito.ArgumentMatcher;
23 import org.mockito.InjectMocks;
24 import org.mockito.Mock;
25 import org.mockito.Mockito;
26 import org.mockito.runners.MockitoJUnitRunner;
27 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
28 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
29 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapServerAsync;
30 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
31 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
32 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
33 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
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.lisp.proto.rev151105.AddMapping;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotify;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapReply;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapNotify;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapReply;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingKeepAlive;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMapping;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrReplyMapping;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrRequestMapping;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItemBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadata;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadataBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddress;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddressBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.SourceEidBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequest;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequestBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.OdlLispSbService;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInput;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInputBuilder;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyInputBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestInputBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
70 @RunWith(MockitoJUnitRunner.class)
71 public class LispMappingServiceTest {
72 @Mock private static MapRegister mapRegisterMock;
73 @Mock(name = "mapServer") private static IMapServerAsync mapServerMock;
74 @Mock(name = "mapResolver") private static IMapResolverAsync mapResolverMock;
75 @Mock(name = "tlsMapReply") private static ThreadLocal<MapReply> tlsMapReplyMock;
76 @Mock(name = "tlsMapNotify") private static ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotifyMock;
77 @Mock(name = "tlsMapRequest") private static ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequestMock;
79 private final NotificationService notificationService = Mockito.mock(NotificationService.class);
80 private final IMappingService mappingService = Mockito.mock(IMappingService.class);
81 private final OdlLispSbService odlLispSbService = Mockito.mock(OdlLispSbService.class);
82 private final ClusterSingletonServiceProvider clusterSingletonService = Mockito.mock(
83 ClusterSingletonServiceProvider.class);
86 private LispMappingService lispMappingService = new LispMappingService(
87 notificationService, mappingService, odlLispSbService, clusterSingletonService);
89 private static final byte[] IPV4_BYTES_1 = new byte[] {1, 2, 3, 0};
90 private static final byte[] IPV4_BYTES_2 = new byte[] {1, 2, 4, 0};
91 private static final String IPV4_STRING_1 = "1.2.3.0";
92 private static final String IPV4_STRING_2 = "1.2.3.1";
93 private static final String IPV4_SOURCE_STRING = "192.168.0.1";
94 private static final String IPV4_PREFIX_STRING = "/24";
95 private static final long TIMESTAMP = 1L;
97 private static final Eid IPV4_PREFIX_EID_1 = LispAddressUtil.asIpv4PrefixEid(IPV4_STRING_1 + IPV4_PREFIX_STRING);
98 private static final Eid IPV4_SOURCE_EID = LispAddressUtil.asIpv4Eid(IPV4_SOURCE_STRING);
99 private static final Eid IPV4_EID_1 = LispAddressUtil.asIpv4Eid(IPV4_STRING_1);
100 private static final Eid IPV4_EID_2 = LispAddressUtil.asIpv4Eid(IPV4_STRING_2);
101 private static final EidItemBuilder EID_ITEM_BUILDER = new EidItemBuilder()
102 .setEidItemId("eid-item-id")
103 .setEid(IPV4_PREFIX_EID_1);
104 private static final MappingRecordItemBuilder MAPPING_RECORD_ITEM_BUILDER = new MappingRecordItemBuilder()
105 .setMappingRecord(new MappingRecordBuilder().setEid(IPV4_PREFIX_EID_1).build());
107 private static final TransportAddress TRANSPORT_ADDRESS_1 = new TransportAddressBuilder()
108 .setIpAddress(new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES_1)))
109 .setPort(new PortNumber(9999)).build();
110 private static final TransportAddress TRANSPORT_ADDRESS_2 = new TransportAddressBuilder()
111 .setIpAddress(new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES_2)))
112 .setPort(new PortNumber(8888)).build();
113 private static final TransportAddress TRANSPORT_ADDRESS = new TransportAddressBuilder()
114 .setIpAddress(new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES_1)))
115 .setPort(new PortNumber(LispMessage.PORT_NUM)).build();
118 * Tests {@link LispMappingService#handleMapRequest} method.
121 public void handleMapRequestTest() {
122 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
123 final MapReply mapReply = new MapReplyBuilder().build();
124 Mockito.when(mapRequest.getEidItem()).thenReturn(Lists.newArrayList(EID_ITEM_BUILDER.build()));
125 Mockito.when(tlsMapRequestMock.get()).thenReturn(null);
126 Mockito.when(tlsMapReplyMock.get()).thenReturn(mapReply);
128 final MapReply result = lispMappingService.handleMapRequest(mapRequest);
130 Mockito.verify(tlsMapRequestMock).set(null);
131 Mockito.verify(tlsMapRequestMock).get();
132 Mockito.verifyNoMoreInteractions(tlsMapRequestMock);
133 Mockito.verify(mapResolverMock).handleMapRequest(mapRequest);
134 Mockito.verify(tlsMapReplyMock).set(Mockito.any(MapReply.class));
135 Mockito.verify(tlsMapReplyMock).get();
137 assertEquals(result, mapReply);
141 * Tests {@link LispMappingService#handleMapRequest} method request from non-proxy xTR.
144 public void handleMapRequestTest_NonProxy() {
145 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
146 final Pair<MapRequest, TransportAddress> pair = getDefaultMapRequestPair();
147 final SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder()
148 .setMapRequest(pair.getLeft())
149 .setTransportAddress(pair.getRight());
151 Mockito.when(mapRequest.getEidItem()).thenReturn(Lists.newArrayList(EID_ITEM_BUILDER.build()));
152 Mockito.when(tlsMapRequestMock.get()).thenReturn(pair);
154 assertNull(lispMappingService.handleMapRequest(mapRequest));
155 Mockito.verify(odlLispSbService).sendMapRequest(smrib.build());
159 * Tests {@link LispMappingService#handleMapRegister} method.
162 @SuppressWarnings("unchecked")
163 public void handleMapRegisterTest() {
164 final Pair<MapNotify, List<TransportAddress>> pairMock = Mockito.mock(Pair.class);
166 Mockito.when(mapRegisterMock.getMappingRecordItem())
167 .thenReturn(Lists.newArrayList(MAPPING_RECORD_ITEM_BUILDER.build()));
168 Mockito.when(tlsMapNotifyMock.get()).thenReturn(pairMock);
170 lispMappingService.handleMapRegister(mapRegisterMock);
171 Mockito.verify(mapServerMock).handleMapRegister(mapRegisterMock);
172 Mockito.verify(tlsMapNotifyMock).set(Mockito.any(MutablePair.class));
176 * Tests {@link LispMappingService#onAddMapping} method.
179 public void onAddMappingTest() {
180 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregisternotification.MapRegister
181 mapRegister = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
182 .mapregisternotification.MapRegister.class);
183 final AddMapping addMapping = Mockito.mock(AddMapping.class);
185 Mockito.when(addMapping.getMapRegister()).thenReturn(mapRegister);
186 Mockito.when(mapRegister.getMappingRecordItem())
187 .thenReturn(Lists.newArrayList(MAPPING_RECORD_ITEM_BUILDER.build()));
188 Mockito.when(tlsMapNotifyMock.get()).thenReturn(getDefaultMapNotifyPair());
190 lispMappingService.onAddMapping(addMapping);
191 Mockito.verify(odlLispSbService, Mockito.times(2)).sendMapNotify(Mockito.argThat(new TransportAddressMatch()));
195 * Tests {@link LispMappingService#onAddMapping} method with no TransportAddress.
198 public void onAddMappingTest_noTransportAddress() {
199 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregisternotification.MapRegister
200 mapRegister = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
201 .mapregisternotification.MapRegister.class);
202 final AddMapping addMapping = Mockito.mock(AddMapping.class);
203 final MapNotify mapNotify = new MapNotifyBuilder().setKeyId((short) 1).build();
205 Mockito.when(addMapping.getMapRegister()).thenReturn(mapRegister);
206 Mockito.when(mapRegister.getMappingRecordItem())
207 .thenReturn(Lists.newArrayList(MAPPING_RECORD_ITEM_BUILDER.build()));
208 Mockito.when(tlsMapNotifyMock.get()).thenReturn(new MutablePair<>(mapNotify, null));
209 Mockito.when(addMapping.getTransportAddress()).thenReturn(TRANSPORT_ADDRESS_1);
212 final SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder()
213 .setMapNotify(new org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
214 .mapnotifymessage.MapNotifyBuilder().setKeyId((short) 1).build())
215 .setTransportAddress(TRANSPORT_ADDRESS);
217 lispMappingService.onAddMapping(addMapping);
218 Mockito.verify(odlLispSbService).sendMapNotify(smnib.build());
222 * Tests {@link LispMappingService#onRequestMapping} method.
225 public void onRequestMappingTest() {
226 final RequestMapping requestMapping = Mockito.mock(RequestMapping.class);
227 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequest
228 mapRequest = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
229 .maprequestnotification.MapRequest.class);
230 final MapReply mapReply = new MapReplyBuilder().build();
232 Mockito.when(requestMapping.getMapRequest()).thenReturn(mapRequest);
233 Mockito.when(requestMapping.getTransportAddress()).thenReturn(TRANSPORT_ADDRESS_1);
234 Mockito.when(mapRequest.getEidItem()).thenReturn(Lists.newArrayList(EID_ITEM_BUILDER.build()));
235 Mockito.when(tlsMapReplyMock.get()).thenReturn(mapReply);
238 final SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder()
239 .setMapReply(new MapReplyBuilder(mapReply).build())
240 .setTransportAddress(TRANSPORT_ADDRESS_1);
242 lispMappingService.onRequestMapping(requestMapping);
243 Mockito.verify(odlLispSbService).sendMapReply(smrib.build());
247 * Tests {@link LispMappingService#onRequestMapping} method with mapReply == null.
250 public void onRequestMappingTest_withNullMapReply() {
251 final RequestMapping requestMapping = Mockito.mock(RequestMapping.class);
252 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequest
253 mapRequest = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
254 .maprequestnotification.MapRequest.class);
256 Mockito.when(requestMapping.getMapRequest()).thenReturn(mapRequest);
257 Mockito.when(mapRequest.getEidItem()).thenReturn(Lists.newArrayList(EID_ITEM_BUILDER.build()));
258 Mockito.when(tlsMapReplyMock.get()).thenReturn(null);
260 lispMappingService.onRequestMapping(requestMapping);
261 Mockito.verifyZeroInteractions(odlLispSbService);
265 * Tests {@link LispMappingService#onMappingKeepAlive} method.
268 public void onMappingKeepAliveTest() {
269 final MappingKeepAlive mappingKeepAlive = Mockito.mock(MappingKeepAlive.class);
270 Mockito.when(mappingKeepAlive.getMapRegisterCacheMetadata()).thenReturn(getDefaultMapRegisterCacheMetadata());
272 lispMappingService.onMappingKeepAlive(mappingKeepAlive);
273 Mockito.verify(mappingService).updateMappingRegistration(MappingOrigin.Southbound, IPV4_EID_1, TIMESTAMP);
274 Mockito.verify(mappingService).updateMappingRegistration(MappingOrigin.Southbound, IPV4_EID_2, TIMESTAMP);
278 * Tests {@link LispMappingService#handleSMR} method.
281 public void handleSmrTest() {
282 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
283 final Rloc subscriber = LispAddressUtil.asIpv4Rloc(IPV4_STRING_1);
285 Mockito.when(mapRequest.getSourceEid()).thenReturn(new SourceEidBuilder().setEid(IPV4_SOURCE_EID).build());
286 Mockito.when(mapRequest.getEidItem()).thenReturn(Lists.newArrayList(EID_ITEM_BUILDER.build()));
289 final SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder()
290 .setMapRequest(new MapRequestBuilder(mapRequest).build())
291 .setTransportAddress(TRANSPORT_ADDRESS);
293 lispMappingService.handleSMR(mapRequest, subscriber);
294 Mockito.verify(odlLispSbService).sendMapRequest(smrib.build());
298 * Tests {@link LispMappingService#setShouldUseSmr} method.
301 public void setShouldUseSmrTest() {
302 final boolean value = true;
304 lispMappingService.setShouldUseSmr(value);
305 Mockito.verify(mapServerMock).setSubscriptionService(value);
306 Mockito.verify(mapResolverMock).setSubscriptionService(value);
310 * Tests {@link LispMappingService#handleMapNotify} method.
313 @SuppressWarnings("unchecked")
314 public void handleMapNotifyTest() {
315 final MapNotify mapNotify = Mockito.mock(MapNotify.class);
316 final List<TransportAddress> list = Mockito.mock(ArrayList.class);
318 lispMappingService.handleMapNotify(mapNotify, list);
319 Mockito.verify(tlsMapNotifyMock).set(Mockito.any(MutablePair.class));
323 * Tests {@link LispMappingService#handleNonProxyMapRequest} method.
326 @SuppressWarnings("unchecked")
327 public void handleNonProxyMapRequestTest() {
328 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
329 final TransportAddress transportAddress = Mockito.mock(TransportAddress.class);
331 lispMappingService.handleNonProxyMapRequest(mapRequest, transportAddress);
332 Mockito.verify(tlsMapRequestMock).set(Mockito.any(MutablePair.class));
336 * Tests {@link LispMappingService#handleMapReply} method.
339 public void handleMapReplyTest() {
340 final MapReply mapReply = Mockito.mock(MapReply.class);
342 lispMappingService.handleMapReply(mapReply);
343 Mockito.verify(tlsMapReplyMock).set(Mockito.any(MapReply.class));
347 * Tests {@link LispMappingService#close} method.
350 public void closeTest() throws Exception {
351 lispMappingService.close();
353 assertNull(getField("mapResolver"));
354 assertNull(getField("mapServer"));
358 * Tests {@link LispMappingService} other setter and getter methods.
361 public void otherTest() throws Exception {
362 assertEquals(notificationService, lispMappingService.getNotificationService());
363 assertEquals(true, lispMappingService.shouldUseSmr());
365 lispMappingService.setShouldAuthenticate(true);
366 Mockito.verify(mapResolverMock).setShouldAuthenticate(true);
368 lispMappingService.onGotMapReply(Mockito.mock(GotMapReply.class));
369 lispMappingService.onGotMapNotify(Mockito.mock(GotMapNotify.class));
370 lispMappingService.onXtrRequestMapping(Mockito.mock(XtrRequestMapping.class));
371 lispMappingService.onXtrReplyMapping(Mockito.mock(XtrReplyMapping.class));
374 @SuppressWarnings("unchecked")
375 private <T> T getField(String fieldName) throws NoSuchFieldException, IllegalAccessException {
376 final Field field = LispMappingService.class.getDeclaredField(fieldName);
377 field.setAccessible(true);
379 return (T) field.get(lispMappingService);
382 private static Pair<MapNotify, List<TransportAddress>> getDefaultMapNotifyPair() {
383 final MapNotify mapNotify = new MapNotifyBuilder().setKeyId((short) 1).build();
384 return new MutablePair<>(mapNotify, Lists.newArrayList(TRANSPORT_ADDRESS_1, TRANSPORT_ADDRESS_2));
387 private static Pair<MapRequest, TransportAddress> getDefaultMapRequestPair() {
388 final MapRequestBuilder mapRequestBuilder = new MapRequestBuilder()
389 .setEidItem(Lists.newArrayList(EID_ITEM_BUILDER.build()));
391 return new ImmutablePair<>(mapRequestBuilder.build(), TRANSPORT_ADDRESS_1);
394 private static MapRegisterCacheMetadata getDefaultMapRegisterCacheMetadata() {
395 final EidLispAddress eidLispAddress_1 = new EidLispAddressBuilder()
396 .setEidLispAddressId("id-1")
397 .setEid(IPV4_EID_1).build();
398 final EidLispAddress eidLispAddress_2 = new EidLispAddressBuilder()
399 .setEidLispAddressId("id-2")
400 .setEid(IPV4_EID_2).build();
402 return new MapRegisterCacheMetadataBuilder()
403 .setEidLispAddress(Lists.newArrayList(eidLispAddress_1, eidLispAddress_2))
404 .setTimestamp(TIMESTAMP).build();
407 class TransportAddressMatch extends ArgumentMatcher<SendMapNotifyInput> {
408 public boolean matches(Object sendMapNotify) {
409 final SendMapNotifyInput sendMapNotifyInput = (SendMapNotifyInput) sendMapNotify;
410 final TransportAddress notifyTransportAddress = sendMapNotifyInput.getTransportAddress();
411 return TRANSPORT_ADDRESS_1.equals(notifyTransportAddress)
412 || TRANSPORT_ADDRESS_2.equals(notifyTransportAddress);