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.junit.MockitoJUnitRunner;
27 import org.opendaylight.lispflowmapping.implementation.lisp.MapServer;
28 import org.opendaylight.lispflowmapping.interfaces.lisp.IMapResolverAsync;
29 import org.opendaylight.lispflowmapping.interfaces.mappingservice.IMappingService;
30 import org.opendaylight.lispflowmapping.lisp.type.LispMessage;
31 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
32 import org.opendaylight.mdsal.binding.api.NotificationService;
33 import org.opendaylight.mdsal.binding.api.RpcProviderService;
34 import org.opendaylight.mdsal.singleton.common.api.ClusterSingletonServiceProvider;
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.lisp.proto.rev151105.AddMapping;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapNotify;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.GotMapReply;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapNotify;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRegister;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapReply;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingKeepAlive;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RequestMapping;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrReplyMapping;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrRequestMapping;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItemBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadata;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadataBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddress;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddressBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.container.MappingRecordBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping._record.list.MappingRecordItemBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.SourceEidBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequest;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestmessage.MapRequestBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddress;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.OdlLispSbService;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInput;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapNotifyInputBuilder;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapReplyInputBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.SendMapRequestInputBuilder;
69 import org.opendaylight.yangtools.concepts.Registration;
70 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
71 import org.opendaylight.yangtools.yang.common.Uint16;
73 @RunWith(MockitoJUnitRunner.class)
74 public class LispMappingServiceTest {
75 @Mock private static MapRegister mapRegisterMock;
76 @Mock(name = "mapServer") private static MapServer mapServerMock;
77 @Mock(name = "mapResolver") private static IMapResolverAsync mapResolverMock;
78 @Mock(name = "tlsMapReply") private static ThreadLocal<MapReply> tlsMapReplyMock;
79 @Mock(name = "tlsMapNotify") private static ThreadLocal<Pair<MapNotify, List<TransportAddress>>> tlsMapNotifyMock;
80 @Mock(name = "tlsMapRequest") private static ThreadLocal<Pair<MapRequest, TransportAddress>> tlsMapRequestMock;
81 @Mock private static Registration rpcRegistration;
82 @Mock(name = "listenerRegistration") private static Registration listenerRegistration;
84 private final NotificationService notificationService = Mockito.mock(NotificationService.class);
85 private final RpcProviderService rpcProviderService = Mockito.mock(RpcProviderService.class);
86 private final IMappingService mappingService = Mockito.mock(IMappingService.class);
87 private final OdlLispSbService odlLispSbService = Mockito.mock(OdlLispSbService.class);
88 private final ClusterSingletonServiceProvider clusterSingletonService = Mockito.mock(
89 ClusterSingletonServiceProvider.class);
92 private final LispMappingService lispMappingService = new LispMappingService(
93 mappingService, odlLispSbService, clusterSingletonService, rpcProviderService, notificationService);
95 private static final byte[] IPV4_BYTES_1 = new byte[] {1, 2, 3, 0};
96 private static final byte[] IPV4_BYTES_2 = new byte[] {1, 2, 4, 0};
97 private static final String IPV4_STRING_1 = "1.2.3.0";
98 private static final String IPV4_STRING_2 = "1.2.3.1";
99 private static final String IPV4_SOURCE_STRING = "192.168.0.1";
100 private static final String IPV4_PREFIX_STRING = "/24";
101 private static final long TIMESTAMP = 1L;
103 private static final Eid IPV4_PREFIX_EID_1 = LispAddressUtil.asIpv4PrefixEid(IPV4_STRING_1 + IPV4_PREFIX_STRING);
104 private static final Eid IPV4_SOURCE_EID = LispAddressUtil.asIpv4Eid(IPV4_SOURCE_STRING);
105 private static final Eid IPV4_EID_1 = LispAddressUtil.asIpv4Eid(IPV4_STRING_1);
106 private static final Eid IPV4_EID_2 = LispAddressUtil.asIpv4Eid(IPV4_STRING_2);
107 private static final EidItemBuilder EID_ITEM_BUILDER = new EidItemBuilder()
108 .setEidItemId("eid-item-id")
109 .setEid(IPV4_PREFIX_EID_1);
110 private static final MappingRecordItemBuilder MAPPING_RECORD_ITEM_BUILDER = new MappingRecordItemBuilder()
111 .setMappingRecord(new MappingRecordBuilder().setEid(IPV4_PREFIX_EID_1).build());
113 private static final TransportAddress TRANSPORT_ADDRESS_1 = new TransportAddressBuilder()
114 .setIpAddress(new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES_1)))
115 .setPort(new PortNumber(Uint16.valueOf(9999))).build();
116 private static final TransportAddress TRANSPORT_ADDRESS_2 = new TransportAddressBuilder()
117 .setIpAddress(new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES_2)))
118 .setPort(new PortNumber(Uint16.valueOf(8888))).build();
119 private static final TransportAddress TRANSPORT_ADDRESS = new TransportAddressBuilder()
120 .setIpAddress(new IpAddressBinary(new Ipv4AddressBinary(IPV4_BYTES_1)))
121 .setPort(new PortNumber(LispMessage.PORT_NUMBER)).build();
124 * Tests {@link LispMappingService#handleMapRequest} method.
127 public void handleMapRequestTest() {
128 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
129 final MapReply mapReply = new MapReplyBuilder().build();
130 Mockito.when(tlsMapRequestMock.get()).thenReturn(null);
131 Mockito.when(tlsMapReplyMock.get()).thenReturn(mapReply);
133 final MapReply result = lispMappingService.handleMapRequest(mapRequest);
135 Mockito.verify(tlsMapRequestMock).set(null);
136 Mockito.verify(tlsMapRequestMock).get();
137 Mockito.verifyNoMoreInteractions(tlsMapRequestMock);
138 Mockito.verify(mapResolverMock).handleMapRequest(mapRequest);
139 Mockito.verify(tlsMapReplyMock).set(Mockito.any());
140 Mockito.verify(tlsMapReplyMock).get();
142 assertEquals(result, mapReply);
146 * Tests {@link LispMappingService#handleMapRequest} method request from non-proxy xTR.
149 public void handleMapRequestTest_NonProxy() {
150 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
151 final Pair<MapRequest, TransportAddress> pair = getDefaultMapRequestPair();
152 final SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder()
153 .setMapRequest(pair.getLeft())
154 .setTransportAddress(pair.getRight());
156 Mockito.when(tlsMapRequestMock.get()).thenReturn(pair);
158 assertNull(lispMappingService.handleMapRequest(mapRequest));
159 Mockito.verify(odlLispSbService).sendMapRequest(smrib.build());
163 * Tests {@link LispMappingService#handleMapRegister} method.
166 @SuppressWarnings("unchecked")
167 public void handleMapRegisterTest() {
168 final Pair<MapNotify, List<TransportAddress>> pairMock = Mockito.mock(Pair.class);
170 Mockito.when(tlsMapNotifyMock.get()).thenReturn(pairMock);
172 lispMappingService.handleMapRegister(mapRegisterMock);
173 Mockito.verify(mapServerMock).handleMapRegister(mapRegisterMock);
174 Mockito.verify(tlsMapNotifyMock).set(Mockito.any());
178 * Tests {@link LispMappingService#onAddMapping} method.
181 public void onAddMappingTest() {
182 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregisternotification.MapRegister
183 mapRegister = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
184 .mapregisternotification.MapRegister.class);
185 final AddMapping addMapping = Mockito.mock(AddMapping.class);
187 Mockito.when(addMapping.getMapRegister()).thenReturn(mapRegister);
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(tlsMapNotifyMock.get()).thenReturn(new MutablePair<>(mapNotify, null));
207 Mockito.when(addMapping.getTransportAddress()).thenReturn(TRANSPORT_ADDRESS_1);
210 final SendMapNotifyInputBuilder smnib = new SendMapNotifyInputBuilder()
211 .setMapNotify(new org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
212 .mapnotifymessage.MapNotifyBuilder().setKeyId((short) 1).build())
213 .setTransportAddress(TRANSPORT_ADDRESS);
215 lispMappingService.onAddMapping(addMapping);
216 Mockito.verify(odlLispSbService).sendMapNotify(smnib.build());
220 * Tests {@link LispMappingService#onRequestMapping} method.
223 public void onRequestMappingTest() {
224 final RequestMapping requestMapping = Mockito.mock(RequestMapping.class);
225 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequest
226 mapRequest = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
227 .maprequestnotification.MapRequest.class);
228 final MapReply mapReply = new MapReplyBuilder().build();
230 Mockito.when(requestMapping.getMapRequest()).thenReturn(mapRequest);
231 Mockito.when(requestMapping.getTransportAddress()).thenReturn(TRANSPORT_ADDRESS_1);
232 Mockito.when(tlsMapReplyMock.get()).thenReturn(mapReply);
235 final SendMapReplyInputBuilder smrib = new SendMapReplyInputBuilder()
236 .setMapReply(new MapReplyBuilder(mapReply).build())
237 .setTransportAddress(TRANSPORT_ADDRESS_1);
239 lispMappingService.onRequestMapping(requestMapping);
240 Mockito.verify(odlLispSbService).sendMapReply(smrib.build());
244 * Tests {@link LispMappingService#onRequestMapping} method with mapReply == null.
247 public void onRequestMappingTest_withNullMapReply() {
248 final RequestMapping requestMapping = Mockito.mock(RequestMapping.class);
249 final org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequest
250 mapRequest = Mockito.mock(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105
251 .maprequestnotification.MapRequest.class);
253 Mockito.when(requestMapping.getMapRequest()).thenReturn(mapRequest);
254 Mockito.when(tlsMapReplyMock.get()).thenReturn(null);
256 lispMappingService.onRequestMapping(requestMapping);
257 Mockito.verifyZeroInteractions(odlLispSbService);
261 * Tests {@link LispMappingService#onMappingKeepAlive} method.
264 public void onMappingKeepAliveTest() {
265 final MappingKeepAlive mappingKeepAlive = Mockito.mock(MappingKeepAlive.class);
266 Mockito.when(mappingKeepAlive.getMapRegisterCacheMetadata()).thenReturn(getDefaultMapRegisterCacheMetadata());
268 lispMappingService.onMappingKeepAlive(mappingKeepAlive);
269 Mockito.verify(mappingService).refreshMappingRegistration(IPV4_EID_1, null, TIMESTAMP);
270 Mockito.verify(mappingService).refreshMappingRegistration(IPV4_EID_2, null, TIMESTAMP);
274 * Tests {@link LispMappingService#handleSMR} method.
277 public void handleSmrTest() {
278 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
279 final Rloc subscriber = LispAddressUtil.asIpv4Rloc(IPV4_STRING_1);
281 Mockito.when(mapRequest.getSourceEid()).thenReturn(new SourceEidBuilder().setEid(IPV4_SOURCE_EID).build());
282 Mockito.when(mapRequest.getEidItem()).thenReturn(Lists.newArrayList(EID_ITEM_BUILDER.build()));
285 final SendMapRequestInputBuilder smrib = new SendMapRequestInputBuilder()
286 .setMapRequest(new MapRequestBuilder(mapRequest).build())
287 .setTransportAddress(TRANSPORT_ADDRESS);
289 lispMappingService.handleSMR(mapRequest, subscriber);
290 Mockito.verify(odlLispSbService).sendMapRequest(smrib.build());
294 * Tests {@link LispMappingService#setShouldUseSmr} method.
297 public void setShouldUseSmrTest() {
298 final boolean value = true;
300 lispMappingService.setShouldUseSmr(value);
301 Mockito.verify(mapServerMock).setSubscriptionService(value);
302 Mockito.verify(mapResolverMock).setSubscriptionService(value);
306 * Tests {@link LispMappingService#handleMapNotify} method.
309 @SuppressWarnings("unchecked")
310 public void handleMapNotifyTest() {
311 final MapNotify mapNotify = Mockito.mock(MapNotify.class);
312 final List<TransportAddress> list = Mockito.mock(ArrayList.class);
314 lispMappingService.handleMapNotify(mapNotify, list);
315 Mockito.verify(tlsMapNotifyMock).set(Mockito.any(MutablePair.class));
319 * Tests {@link LispMappingService#handleNonProxyMapRequest} method.
322 @SuppressWarnings("unchecked")
323 public void handleNonProxyMapRequestTest() {
324 final MapRequest mapRequest = Mockito.mock(MapRequest.class);
325 final TransportAddress transportAddress = Mockito.mock(TransportAddress.class);
327 lispMappingService.handleNonProxyMapRequest(mapRequest, transportAddress);
328 Mockito.verify(tlsMapRequestMock).set(Mockito.any(MutablePair.class));
332 * Tests {@link LispMappingService#handleMapReply} method.
335 public void handleMapReplyTest() {
336 final MapReply mapReply = Mockito.mock(MapReply.class);
338 lispMappingService.handleMapReply(mapReply);
339 Mockito.verify(tlsMapReplyMock).set(Mockito.any(MapReply.class));
343 * Tests {@link LispMappingService#close} method.
346 public void closeTest() throws Exception {
347 setMock("rpcRegistration", rpcRegistration);
348 setMock("listenerRegistration", listenerRegistration);
349 lispMappingService.close();
350 Mockito.verify(rpcRegistration).close();
351 Mockito.verify(listenerRegistration).close();
352 Mockito.verify(clusterSingletonService).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 private void setMock(final String fieldName, final Object value)
375 throws IllegalAccessException, NoSuchFieldException {
376 final Field field = LispMappingService.class.getDeclaredField(fieldName);
377 field.setAccessible(true);
378 field.set(lispMappingService, value);
381 @SuppressWarnings("unchecked")
382 private <T> T getField(String fieldName) throws NoSuchFieldException, IllegalAccessException {
383 final Field field = LispMappingService.class.getDeclaredField(fieldName);
384 field.setAccessible(true);
386 return (T) field.get(lispMappingService);
389 private static Pair<MapNotify, List<TransportAddress>> getDefaultMapNotifyPair() {
390 final MapNotify mapNotify = new MapNotifyBuilder().setKeyId((short) 1).build();
391 return new MutablePair<>(mapNotify, Lists.newArrayList(TRANSPORT_ADDRESS_1, TRANSPORT_ADDRESS_2));
394 private static Pair<MapRequest, TransportAddress> getDefaultMapRequestPair() {
395 final MapRequestBuilder mapRequestBuilder = new MapRequestBuilder()
396 .setEidItem(Lists.newArrayList(EID_ITEM_BUILDER.build()));
398 return new ImmutablePair<>(mapRequestBuilder.build(), TRANSPORT_ADDRESS_1);
401 private static MapRegisterCacheMetadata getDefaultMapRegisterCacheMetadata() {
402 final EidLispAddress eidLispAddress_1 = new EidLispAddressBuilder()
403 .setEidLispAddressId("id-1")
404 .setEid(IPV4_EID_1).build();
405 final EidLispAddress eidLispAddress_2 = new EidLispAddressBuilder()
406 .setEidLispAddressId("id-2")
407 .setEid(IPV4_EID_2).build();
409 return new MapRegisterCacheMetadataBuilder()
410 .setEidLispAddress(BindingMap.ordered(eidLispAddress_1, eidLispAddress_2))
411 .setTimestamp(TIMESTAMP).build();
414 class TransportAddressMatch implements ArgumentMatcher<SendMapNotifyInput> {
416 public boolean matches(SendMapNotifyInput sendMapNotify) {
417 final TransportAddress notifyTransportAddress = sendMapNotify.getTransportAddress();
418 return TRANSPORT_ADDRESS_1.equals(notifyTransportAddress)
419 || TRANSPORT_ADDRESS_2.equals(notifyTransportAddress);