Auto-convert String IPs in Mapping
[lispflowmapping.git] / mappingservice / implementation / src / test / java / org / opendaylight / lispflowmapping / implementation / lisp / MapResolverTest.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.implementation.lisp;
9
10 import java.util.ArrayList;
11 import java.util.List;
12 import java.util.Set;
13 import org.junit.Before;
14 import org.junit.Test;
15 import org.mockito.Mockito;
16 import org.opendaylight.lispflowmapping.implementation.LispMappingService;
17 import org.opendaylight.lispflowmapping.implementation.MappingService;
18 import org.opendaylight.lispflowmapping.implementation.config.ConfigIni;
19 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
20 import org.opendaylight.lispflowmapping.interfaces.dao.SubscriberRLOC;
21 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
22 import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list
26         .MappingRecordItemBuilder;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.list.EidItemBuilder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordKey;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container
33         .MappingRecordBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRloc;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRlocBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRlocKey;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.SourceEidBuilder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequestBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.Rloc;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.authkey.container
43         .MappingAuthkeyBuilder;
44
45 public class MapResolverTest {
46
47     private static MapResolver mapResolver;
48     private static MappingService mapServiceMock;
49     private static Set<SubscriberRLOC> subscriberSetMock;
50     private static LispMappingService lispMappingServiceMock;
51
52     private static final String ITR_RLOC_KEY_STRING =   "itr_rloc_key";
53     private static final String ITR_RLOC_ID_STRING =    "itr_rloc_id";
54     private static final String IPV4_STRING_1 =         "1.2.3.0";
55     private static final String IPV4_STRING_2 =         "1.2.4.0";
56     private static final String IPV4_RLOC_STRING_1 =    "100.100.100.100";
57     private static final String IPV4_SOURCE =           "127.0.0.1";
58     private static final String IPV4_PREFIX_STRING =    "/24";
59     private static final String IPV6_STRING =           "0:0:0:0:0:0:0:1";
60     private static final String IPV6_PREFIX_STRING =    "/128";
61
62     private static final LocatorRecordKey LOCATOR_RECORD_KEY = new LocatorRecordKey("key");
63     private static final int TTL_RLOC_TIMED_OUT = 1;
64
65     private static final IpAddress IPV4_ADDRESS_1 = new IpAddress(new Ipv4Address(IPV4_STRING_1));
66     private static final IpAddress IPV4_ADDRESS_2 = new IpAddress(new Ipv4Address(IPV4_STRING_2));
67
68     private static final Eid IPV4_PREFIX_EID_1 = LispAddressUtil.asIpv4PrefixEid(IPV4_STRING_1 + IPV4_PREFIX_STRING);
69     private static final Eid IPV4_PREFIX_EID_2 = LispAddressUtil.asIpv4PrefixEid(IPV4_STRING_2 + IPV4_PREFIX_STRING);
70     private static final Eid IPV6_PREFIX_EID = LispAddressUtil.asIpv6PrefixEid(IPV6_STRING + IPV6_PREFIX_STRING);
71     private static final Eid SOURCE_DEST_KEY_EID = LispAddressUtil.asSrcDstEid(IPV4_SOURCE, IPV4_STRING_2, 24, 24, 0);
72
73     private static final Rloc RLOC_1 = LispAddressUtil.asIpv4Rloc(IPV4_RLOC_STRING_1);
74     private static MapRequestBuilder mapRequestBuilder = getDefaultMapRequestBuilder();
75     private static final SubscriberRLOC SUBSCRIBER_RLOC_1 = new SubscriberRLOC(RLOC_1,
76             LispAddressUtil.asIpv4Eid(IPV4_SOURCE));
77
78     @Before
79     @SuppressWarnings("unchecked")
80     public void init() throws Exception {
81         mapServiceMock = Mockito.mock(MappingService.class, "mapService");
82         subscriberSetMock = Mockito.mock(Set.class);
83         lispMappingServiceMock = Mockito.mock(LispMappingService.class, "requestHandler");
84         mapResolver = new MapResolver(mapServiceMock, true, ConfigIni.getInstance().getElpPolicy(),
85                 lispMappingServiceMock);
86         mapRequestBuilder = getDefaultMapRequestBuilder();
87     }
88
89     /**
90      * Tests {@link MapResolver#handleMapRequest} method.
91      */
92     @Test
93     public void handleMapRequest__withSingleLocator() {
94         // input mapping
95         final LocatorRecordBuilder locatorRecordBuilder = getDefaultLocatorBuilder();
96         final MappingRecordBuilder mappingRecordBuilder = getDefaultMappingRecordBuilder();
97         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder.build());
98
99         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_1))
100                 .thenReturn(mappingRecordBuilder.build());
101
102         // result
103         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
104         mapReplyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder()
105                 .setMappingRecord(mappingRecordBuilder.build()).build());
106
107         mapResolver.handleMapRequest(mapRequestBuilder.build());
108         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
109     }
110
111     /**
112      * Tests {@link MapResolver#handleMapRequest} method.
113      */
114     @Test
115     public void handleMapRequest__withNoMapping() {
116         final MappingRecordBuilder mappingRecordBuilder = new MappingRecordBuilder()
117                 .setAuthoritative(false)
118                 .setMapVersion((short) 0)
119                 .setEid(IPV4_PREFIX_EID_1)
120                 .setAction(MappingRecord.Action.NativelyForward)
121                 .setRecordTtl(TTL_RLOC_TIMED_OUT);
122
123
124         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_1))
125                 .thenReturn(null);
126         Mockito.when(mapServiceMock.getAuthenticationKey(IPV4_PREFIX_EID_1))
127                 .thenReturn(new MappingAuthkeyBuilder().build());
128
129         // result
130         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
131         mapReplyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder()
132                 .setMappingRecord(mappingRecordBuilder.build()).build());
133
134         mapResolver.handleMapRequest(mapRequestBuilder.build());
135         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
136     }
137
138     /**
139      * Tests {@link MapResolver#handleMapRequest} method.
140      */
141     @Test
142     public void handleMapRequest__withSubscribers() {
143         // input mapping
144         final LocatorRecordBuilder locatorRecordBuilder = getDefaultLocatorBuilder();
145         final MappingRecordBuilder mappingRecordBuilder = getDefaultMappingRecordBuilder();
146         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder.build());
147
148         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_1))
149                 .thenReturn(mappingRecordBuilder.build());
150         Mockito.when(mapServiceMock.getData(MappingOrigin.Southbound, IPV4_PREFIX_EID_1, SubKeys.SUBSCRIBERS))
151                 .thenReturn(subscriberSetMock);
152         Mockito.when(subscriberSetMock.contains(Mockito.any(SubscriberRLOC.class))).thenReturn(false);
153
154         // result
155         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
156         mapReplyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder()
157                 .setMappingRecord(mappingRecordBuilder.build()).build());
158
159         mapResolver.handleMapRequest(mapRequestBuilder.build());
160         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
161         Mockito.verify(subscriberSetMock, Mockito.never()).remove(Mockito.any(SubscriberRLOC.class));
162     }
163
164     /**
165      * Tests {@link MapResolver#handleMapRequest} method.
166      */
167     @Test
168     public void handleMapRequest__withSubscribersToRemove() {
169         // input mapping
170         final LocatorRecordBuilder locatorRecordBuilder = getDefaultLocatorBuilder();
171         final MappingRecordBuilder mappingRecordBuilder = getDefaultMappingRecordBuilder();
172         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder.build());
173
174         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_1))
175                 .thenReturn(mappingRecordBuilder.build());
176         Mockito.when(mapServiceMock.getData(MappingOrigin.Southbound, IPV4_PREFIX_EID_1, SubKeys.SUBSCRIBERS))
177                 .thenReturn(subscriberSetMock);
178         Mockito.when(subscriberSetMock.contains(new SubscriberRLOC(
179                 mapRequestBuilder.getItrRloc().get(0).getRloc(),
180                 mapRequestBuilder.getSourceEid().getEid())))
181                 .thenReturn(true);
182
183         // result
184         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
185         mapReplyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder()
186                 .setMappingRecord(mappingRecordBuilder.build()).build());
187
188         // check if a subscriber is re-instantiating when there already is one in the subscriber set
189         mapResolver.handleMapRequest(mapRequestBuilder.build());
190         Mockito.verify(subscriberSetMock).remove(SUBSCRIBER_RLOC_1);
191         Mockito.verify(subscriberSetMock).add(SUBSCRIBER_RLOC_1);
192         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
193         Mockito.verify(mapServiceMock).addData(MappingOrigin.Southbound, IPV4_PREFIX_EID_1,
194                 SubKeys.SUBSCRIBERS, subscriberSetMock);
195
196         // verify that itrRloc is subscribed to dst address
197         mappingRecordBuilder.setEid(SOURCE_DEST_KEY_EID);
198         mapRequestBuilder.getEidItem().add(new EidItemBuilder().setEid(IPV4_PREFIX_EID_2).build());
199         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_2))
200                 .thenReturn(mappingRecordBuilder.build());
201
202         mapResolver.handleMapRequest(mapRequestBuilder.build());
203         Mockito.verify(mapServiceMock).getData(MappingOrigin.Southbound,
204                 SourceDestKeyHelper.getDstBinary(SOURCE_DEST_KEY_EID), SubKeys.SUBSCRIBERS);
205     }
206
207     /**
208      * Tests {@link MapResolver#handleMapRequest} method.
209      */
210     @Test
211     public void handleMapRequest_withBothPolicy() {
212         mapResolver = new MapResolver(mapServiceMock, true, "both", lispMappingServiceMock);
213
214         final List<IpAddress> ipAddressList = new ArrayList<>();
215         ipAddressList.add(IPV4_ADDRESS_1); // hop 1
216         ipAddressList.add(IPV4_ADDRESS_2); // hop 2
217
218         final Rloc rloc = LispAddressUtil.asTeLcafRloc(ipAddressList);
219         final LocatorRecordBuilder locatorRecordBuilder_1 = getDefaultLocatorBuilder();
220         final LocatorRecordBuilder locatorRecordBuilder_2 = getDefaultLocatorBuilder().setRloc(rloc);
221
222         // input mapping
223         final MappingRecordBuilder mappingRecordBuilder = getDefaultMappingRecordBuilder();
224         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_1.build());
225         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_2.build());
226
227         final MapRequestBuilder mapRequestBuilder = getDefaultMapRequestBuilder();
228         mapRequestBuilder.getItrRloc().add(new ItrRlocBuilder().setRloc(LispAddressUtil.asIpv4Rloc(IPV4_STRING_1))
229                 .build());
230         mapRequestBuilder.getItrRloc().add(new ItrRlocBuilder().setRloc(LispAddressUtil.asIpv4Rloc(IPV4_STRING_2))
231                 .build());
232
233         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_1))
234                 .thenReturn(mappingRecordBuilder.build());
235
236         // result
237         final LocatorRecordBuilder locatorRecordBuilder_3 = getDefaultLocatorBuilder()
238                 .setRloc(LispAddressUtil.asIpv4Rloc(IPV4_STRING_2)).setPriority((short) 1); // priority increased by 1
239         final MappingRecordBuilder resultMappingRecordBuilder = getDefaultMappingRecordBuilder();
240
241         resultMappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_1.build()); // as Ipv4
242         resultMappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_2.build()); // as ELP
243         resultMappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_3.build()); // added to the result
244
245         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
246         mapReplyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder()
247                 .setMappingRecord(resultMappingRecordBuilder.build()).build());
248
249         // invocation
250         mapResolver.handleMapRequest(mapRequestBuilder.build());
251         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
252     }
253
254     /**
255      * Tests {@link MapResolver#handleMapRequest} method.
256      */
257     @Test
258     public void handleMapRequest_withReplacePolicy() {
259         mapResolver = new MapResolver(mapServiceMock, true, "replace", lispMappingServiceMock);
260
261         final List<IpAddress> ipAddressList = new ArrayList<>();
262         ipAddressList.add(IPV4_ADDRESS_1); // hop 1
263         ipAddressList.add(IPV4_ADDRESS_2); // hop 2
264
265         final Rloc rloc = LispAddressUtil.asTeLcafRloc(ipAddressList);
266         final LocatorRecordBuilder locatorRecordBuilder_1 = getDefaultLocatorBuilder();
267         final LocatorRecordBuilder locatorRecordBuilder_2 = getDefaultLocatorBuilder().setRloc(rloc);
268
269         // input mapping
270         final MappingRecordBuilder mappingRecordBuilder = getDefaultMappingRecordBuilder();
271         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_1.build());
272         mappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_2.build());
273
274         final MapRequestBuilder mapRequestBuilder = getDefaultMapRequestBuilder();
275         mapRequestBuilder.getItrRloc().add(new ItrRlocBuilder().setRloc(LispAddressUtil.asIpv4Rloc(IPV4_STRING_1))
276                 .build());
277         mapRequestBuilder.getItrRloc().add(new ItrRlocBuilder().setRloc(LispAddressUtil.asIpv4Rloc(IPV4_STRING_2))
278                 .build());
279
280         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(), IPV4_PREFIX_EID_1))
281                 .thenReturn(mappingRecordBuilder.build());
282
283         // result
284         final LocatorRecordBuilder locatorRecordBuilder_3 = getDefaultLocatorBuilder()
285                 .setRloc(LispAddressUtil.asIpv4Rloc(IPV4_STRING_2));
286         final MappingRecordBuilder resultMappingRecordBuilder = getDefaultMappingRecordBuilder();
287
288         resultMappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_1.build()); // as Ipv4
289         resultMappingRecordBuilder.getLocatorRecord().add(locatorRecordBuilder_3.build()); // added to the result
290
291         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
292         mapReplyBuilder.getMappingRecordItem().add(new MappingRecordItemBuilder()
293                 .setMappingRecord(resultMappingRecordBuilder.build()).build());
294
295         // invocation
296         mapResolver.handleMapRequest(mapRequestBuilder.build());
297         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
298     }
299
300     /**
301      * Tests {@link MapResolver#handleMapRequest} method.
302      */
303     @Test
304     public void handleMapRequest_withMultipleEids() {
305         mapRequestBuilder.getEidItem().add(new EidItemBuilder().setEid(IPV6_PREFIX_EID).build());
306
307         final LocatorRecordBuilder locatorRecordBuilder_1 = getDefaultLocatorBuilder();
308         final LocatorRecordBuilder locatorRecordBuilder_2 = getDefaultLocatorBuilder();
309         locatorRecordBuilder_2.setRloc(LispAddressUtil.asIpv6Rloc(IPV6_STRING));
310
311         //input mapping
312         final MappingRecordBuilder mappingRecordBuilder_1 = getDefaultMappingRecordBuilder();
313         mappingRecordBuilder_1.getLocatorRecord().add(locatorRecordBuilder_1.build());
314         final MappingRecordBuilder mappingRecordBuilder_2 = getDefaultMappingRecordBuilder();
315         mappingRecordBuilder_2.getLocatorRecord().add(locatorRecordBuilder_2.build());
316         mappingRecordBuilder_2.setEid(IPV6_PREFIX_EID);
317
318         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(),
319                 mapRequestBuilder.getEidItem().get(0).getEid())).thenReturn(mappingRecordBuilder_1.build());
320         Mockito.when(mapServiceMock.getMapping(mapRequestBuilder.getSourceEid().getEid(),
321                 mapRequestBuilder.getEidItem().get(1).getEid())).thenReturn(mappingRecordBuilder_2.build());
322
323         //result
324         final MapReplyBuilder mapReplyBuilder = getDefaultMapReplyBuilder();
325         mapReplyBuilder.getMappingRecordItem()
326                 .add(new MappingRecordItemBuilder().setMappingRecord(mappingRecordBuilder_1.build()).build());
327         mapReplyBuilder.getMappingRecordItem()
328                 .add(new MappingRecordItemBuilder().setMappingRecord(mappingRecordBuilder_2.build()).build());
329
330         mapResolver.handleMapRequest(mapRequestBuilder.build());
331         Mockito.verify(lispMappingServiceMock).handleMapReply(mapReplyBuilder.build());
332     }
333
334     private static List<ItrRloc> getDefaultItrRlocList() {
335         final List<ItrRloc> itrRlocList = new ArrayList<>();
336         final ItrRloc itrRloc = new ItrRlocBuilder()
337                 .setKey(new ItrRlocKey(ITR_RLOC_KEY_STRING))
338                 .setItrRlocId(ITR_RLOC_ID_STRING)
339                 .setRloc(RLOC_1).build();
340         itrRlocList.add(itrRloc);
341
342         return itrRlocList;
343     }
344
345     private static MapRequestBuilder getDefaultMapRequestBuilder() {
346         MapRequestBuilder mrBuilder = new MapRequestBuilder()
347                 .setAuthoritative(false)
348                 .setEidItem(new ArrayList<>())
349                 .setItrRloc(new ArrayList<>())
350                 .setMapDataPresent(true)
351                 .setNonce((long) 0)
352                 .setPitr(false)
353                 .setProbe(false)
354                 .setSmr(false)
355                 .setSmrInvoked(true)
356                 .setSourceEid(new SourceEidBuilder().setEid(LispAddressUtil.asIpv4Eid(IPV4_SOURCE)).build())
357                 .setItrRloc(getDefaultItrRlocList());
358
359         mrBuilder.getEidItem().add(new EidItemBuilder().setEid(IPV4_PREFIX_EID_1).build());
360
361         return mrBuilder;
362     }
363
364     private static MappingRecordBuilder getDefaultMappingRecordBuilder() {
365         return new MappingRecordBuilder()
366                 .setAction(MappingRecord.Action.NoAction)
367                 .setAuthoritative(false)
368                 .setLocatorRecord(new ArrayList<>())
369                 .setMapVersion((short) 0)
370                 .setRecordTtl(60)
371                 .setEid(IPV4_PREFIX_EID_1);
372     }
373
374     private static LocatorRecordBuilder getDefaultLocatorBuilder() {
375         return new LocatorRecordBuilder()
376                 .setLocalLocator(false)
377                 .setMulticastPriority((short) 0)
378                 .setMulticastWeight((short) 0)
379                 .setPriority((short) 0)
380                 .setRlocProbed(false)
381                 .setRouted(true)
382                 .setWeight((short) 0)
383                 .setKey(LOCATOR_RECORD_KEY)
384                 .setRloc(LispAddressUtil.asIpv4Rloc(IPV4_RLOC_STRING_1));
385     }
386
387     private static MapReplyBuilder getDefaultMapReplyBuilder() {
388         return new MapReplyBuilder()
389                 .setEchoNonceEnabled(false)
390                 .setProbe(false)
391                 .setSecurityEnabled(false)
392                 .setNonce(mapRequestBuilder.getNonce())
393                 .setMappingRecordItem(new ArrayList<>());
394     }
395 }