mappingservice/lisp-proto/src/test/java/org/opendaylight/lispflowmapping/serializer/MapReplySerializationTest.java

   1 /*
   2  * Copyright (c) 2014 Contextream, 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
   9 package org.opendaylight.lispflowmapping.serializer;
  10
  11 import static org.junit.Assert.assertArrayEquals;
  12 import static org.junit.Assert.assertEquals;
  13
  14 import java.nio.ByteBuffer;
  15 import java.util.ArrayList;
  16
  17 import junitx.framework.ArrayAssert;
  18
  19 import org.junit.Ignore;
  20 import org.junit.Test;
  21 import org.opendaylight.lispflowmapping.lisp.serializer.MapReplySerializer;
  22 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
  23 import org.opendaylight.lispflowmapping.lisp.util.MaskUtil;
  24 import org.opendaylight.lispflowmapping.tools.junit.BaseTestCase;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4Prefix;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4Binary;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6Binary;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapReply;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord.Action;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItem;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.list.MappingRecordItemBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapreplymessage.MapReplyBuilder;
  36
  37 public class MapReplySerializationTest extends BaseTestCase {
  38
  39     @Test
  40     @Ignore
  41     public void todo() throws Exception {
  42         fail("support no eid to locator???");
  43         fail("Validation of values in setters (map-version)");
  44         fail("Non NPE for no locator in LocatorRecord.serialize");
  45     }
  46
  47     @Test
  48     public void serialize__SomeFlags() throws Exception {
  49         MapReplyBuilder mr = new MapReplyBuilder();
  50         mr.setMappingRecordItem(new ArrayList<MappingRecordItem>());
  51         MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
  52         recordBuilder.setEid(LispAddressUtil.asIpv4PrefixEid("0.0.0.1/32"));
  53         mr.getMappingRecordItem().add(
  54                 new MappingRecordItemBuilder().setMappingRecord(recordBuilder.build()).build());
  55         mr.setProbe(true);
  56         mr.setEchoNonceEnabled(false);
  57
  58         ByteBuffer packet = MapReplySerializer.getInstance().serialize(mr.build());
  59         byte firstByte = packet.get(0);
  60         assertHexEquals((byte) 0x28, firstByte);
  61
  62         mr.setProbe(false);
  63         mr.setEchoNonceEnabled(true);
  64
  65         packet = MapReplySerializer.getInstance().serialize(mr.build());
  66         firstByte = packet.get(0);
  67         assertHexEquals((byte) 0x24, firstByte);
  68     }
  69
  70     @Test
  71     public void deserialize__SomeFlags() throws Exception {
  72
  73         MapReply mr = MapReplySerializer.getInstance().deserialize(hexToByteBuffer("2A 00 00 00 00 00 "
  74                 + "00 00 00 00 00 00"));
  75         assertEquals(true, mr.isProbe());
  76         assertEquals(false, mr.isEchoNonceEnabled());
  77         assertEquals(true, mr.isSecurityEnabled());
  78     }
  79
  80     @Test
  81     public void deserialize__All() throws Exception {
  82         MapReply mr = MapReplySerializer.getInstance().deserialize(hexToByteBuffer("20 00 00 02 00 00 "
  83                 + "00 00 00 00 00 02 00 00 "
  84                 + "00 02 02 20 00 00 00 00 "
  85                 + "00 01 01 02 03 04 01 02 "
  86                 + "03 04 00 06 00 01 0a 0a "
  87                 + "0a 0a 04 03 02 01 00 01 "
  88                 + "00 02 00 01 00 02 00 03 "
  89                 + "00 04 00 05 00 06 00 07 00 08 00 00 00 00 00 10 30 00 00 02 00 01 04 03 00 00"));
  90         assertEquals(2, mr.getNonce().longValue());
  91         assertEquals("1.2.3.4/32", ((Ipv4Prefix) mr.getMappingRecordItem().get(0)
  92                 .getMappingRecord().getEid().getAddress()).getIpv4Prefix().getValue());
  93         // XXX Why here normalized and other cases not normalized?
  94         assertEquals("4.3.0.0/16", ((Ipv4Prefix) mr.getMappingRecordItem().get(1)
  95                 .getMappingRecord().getEid().getAddress()).getIpv4Prefix().getValue());
  96         assertEquals(false, mr.getMappingRecordItem().get(0).getMappingRecord().isAuthoritative());
  97         assertEquals(true, mr.getMappingRecordItem().get(1).getMappingRecord().isAuthoritative());
  98         assertEquals(Action.NoAction, mr.getMappingRecordItem().get(0).getMappingRecord().getAction());
  99         assertEquals(Action.NativelyForward, mr.getMappingRecordItem().get(1).getMappingRecord().getAction());
 100         assertEquals(0, mr.getMappingRecordItem().get(0).getMappingRecord().getMapVersion().shortValue());
 101         assertEquals(2, mr.getMappingRecordItem().get(1).getMappingRecord().getMapVersion().shortValue());
 102         assertEquals(32, MaskUtil.getMaskForAddress(mr.getMappingRecordItem().get(0).getMappingRecord()
 103                 .getEid().getAddress()));
 104         assertEquals(16, MaskUtil.getMaskForAddress(mr.getMappingRecordItem().get(1).getMappingRecord()
 105                 .getEid().getAddress()));
 106         assertEquals(2, mr.getMappingRecordItem().get(0).getMappingRecord().getRecordTtl().byteValue());
 107         assertEquals(0, mr.getMappingRecordItem().get(1).getMappingRecord().getRecordTtl().byteValue());
 108         assertArrayEquals(new byte[] {0, 1, 0, 2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8},
 109                 ((Ipv6Binary) mr.getMappingRecordItem().get(0).getMappingRecord()
 110                 .getLocatorRecord().get(1).getRloc().getAddress()).getIpv6Binary().getValue());
 111         assertArrayEquals(new byte[] {10, 10, 10, 10},
 112                 ((Ipv4Binary) mr.getMappingRecordItem().get(0).getMappingRecord()
 113                 .getLocatorRecord().get(0).getRloc().getAddress()).getIpv4Binary().getValue());
 114         assertEquals(1, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 115                 .getPriority().byteValue());
 116         assertEquals(2, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 117                 .getWeight().byteValue());
 118         assertEquals(3, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 119                 .getMulticastPriority().byteValue());
 120         assertEquals(4, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 121                 .getMulticastWeight().byteValue());
 122         assertEquals(4, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1)
 123                 .getPriority().byteValue());
 124         assertEquals(3, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1)
 125                 .getWeight().byteValue());
 126         assertEquals(2, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1)
 127                 .getMulticastPriority().byteValue());
 128         assertEquals(1, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1)
 129                 .getMulticastWeight().byteValue());
 130         assertEquals(true, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 131                 .isLocalLocator());
 132         assertEquals(true, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 133                 .isRlocProbed());
 134         assertEquals(false, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(0)
 135                 .isRouted());
 136         assertEquals(false, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1)
 137                 .isLocalLocator());
 138         assertEquals(false, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1)
 139                 .isRlocProbed());
 140         assertEquals(true, mr.getMappingRecordItem().get(0).getMappingRecord().getLocatorRecord().get(1).isRouted());
 141     }
 142
 143     @Test
 144     public void serialize__MultipleRecordsWithoutRLOCs() throws Exception {
 145         MapReplyBuilder mrBuilder = new MapReplyBuilder();
 146         mrBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
 147         MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
 148         recordBuilder.setEid(LispAddressUtil.asIpv6PrefixEid("0:0:0:0:0:0:0:8/128"));
 149         mrBuilder.getMappingRecordItem().add(
 150                 new MappingRecordItemBuilder().setMappingRecord(recordBuilder.build()).build());
 151
 152         recordBuilder.setEid(LispAddressUtil.asIpv4PrefixEid("8.2.4.5/32"));
 153         mrBuilder.getMappingRecordItem().add(
 154                 new MappingRecordItemBuilder().setMappingRecord(recordBuilder.build()).build());
 155
 156         ByteBuffer packet = MapReplySerializer.getInstance().serialize(mrBuilder.build());
 157         assertEquals(2, packet.get(3));
 158
 159         packet.position(24); // EID in first record
 160         byte[] expected = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 161                 0x08 };
 162         byte[] actual = new byte[16];
 163         packet.get(actual);
 164         ArrayAssert.assertEquals(expected, actual);
 165
 166         packet.position(packet.position() + 12); // EID in second record
 167         assertEquals(0x08020405, packet.getInt());
 168     }
 169
 170     @Test
 171     public void deserialize__MultipleRecordsWithoutRLOCs() throws Exception {
 172         MapReply mr = MapReplySerializer.getInstance().deserialize(hexToByteBuffer("20 00 00 02 00 00 "
 173                 + "00 00 00 00 00 00 00 00 00 01 00 20 00 00 00 00 "
 174                 + "00 01 01 02 03 04 00 00 00 00 00 10 30 00 00 02 00 01 04 03 00 00"));
 175         assertEquals("1.2.3.4/32", ((Ipv4Prefix) mr.getMappingRecordItem().get(0)
 176                 .getMappingRecord().getEid().getAddress()).getIpv4Prefix().getValue());
 177         // XXX Why here normalized and other cases not normalized?
 178         assertEquals("4.3.0.0/16", ((Ipv4Prefix) mr.getMappingRecordItem().get(1)
 179                 .getMappingRecord().getEid().getAddress()).getIpv4Prefix().getValue());
 180         assertEquals(false, mr.getMappingRecordItem().get(0).getMappingRecord().isAuthoritative());
 181         assertEquals(true, mr.getMappingRecordItem().get(1).getMappingRecord().isAuthoritative());
 182         assertEquals(Action.NoAction, mr.getMappingRecordItem().get(0).getMappingRecord().getAction());
 183         assertEquals(Action.NativelyForward, mr.getMappingRecordItem().get(1).getMappingRecord().getAction());
 184         assertEquals(0, mr.getMappingRecordItem().get(0).getMappingRecord().getMapVersion().shortValue());
 185         assertEquals(2, mr.getMappingRecordItem().get(1).getMappingRecord().getMapVersion().shortValue());
 186         assertEquals(32, MaskUtil.getMaskForAddress(mr.getMappingRecordItem().get(0).getMappingRecord()
 187                 .getEid().getAddress()));
 188         assertEquals(16, MaskUtil.getMaskForAddress(mr.getMappingRecordItem().get(1).getMappingRecord()
 189                 .getEid().getAddress()));
 190         assertEquals(1, mr.getMappingRecordItem().get(0).getMappingRecord().getRecordTtl().byteValue());
 191         assertEquals(0, mr.getMappingRecordItem().get(1).getMappingRecord().getRecordTtl().byteValue());
 192     }
 193
 194     @Test
 195     public void serialize__EidRecordDefaultAction() throws Exception {
 196         MapReplyBuilder mrBuilder = new MapReplyBuilder();
 197         mrBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
 198         MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
 199         recordBuilder.setEid(LispAddressUtil.asIpv4PrefixEid("0.0.0.1/32"));
 200         mrBuilder.getMappingRecordItem().add(
 201                 new MappingRecordItemBuilder().setMappingRecord(recordBuilder.build()).build());
 202
 203         ByteBuffer packet = MapReplySerializer.getInstance().serialize(mrBuilder.build());
 204
 205         packet.position(18);
 206         assertHexEquals((byte) 0x00, packet.get()); // MapReplyAction.NoAction
 207     }
 208
 209     @Test
 210     public void serialize__EidRecordNullActionShouldTranslateToDefault() throws Exception {
 211         MapReplyBuilder mrBuilder = new MapReplyBuilder();
 212         mrBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
 213         MappingRecordBuilder recordBuilder = new MappingRecordBuilder();
 214         recordBuilder.setEid(LispAddressUtil.asIpv4PrefixEid("0.0.0.1/32"));
 215         recordBuilder.setAction(null);
 216         mrBuilder.getMappingRecordItem().add(
 217                 new MappingRecordItemBuilder().setMappingRecord(recordBuilder.build()).build());
 218
 219         ByteBuffer packet = MapReplySerializer.getInstance().serialize(mrBuilder.build());
 220
 221         packet.position(18);
 222         assertHexEquals((byte) 0x00, packet.get()); // MapReplyAction.NoAction
 223     }
 224
 225     @Test
 226     public void serialize__EidRecordFields() throws Exception {
 227         MapReplyBuilder mrBuilder = new MapReplyBuilder();
 228         mrBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
 229
 230         MappingRecordBuilder eidToLocator1 = new MappingRecordBuilder();
 231         eidToLocator1.setEid(LispAddressUtil.asIpv4PrefixEid("0.0.0.1/32"));
 232         eidToLocator1.setRecordTtl(7);
 233         eidToLocator1.setAction(Action.SendMapRequest);
 234         eidToLocator1.setAuthoritative(true);
 235         eidToLocator1.setMapVersion((short) 3072);
 236         mrBuilder.getMappingRecordItem().add(
 237                 new MappingRecordItemBuilder().setMappingRecord(eidToLocator1.build()).build());
 238
 239         MappingRecordBuilder eidToLocator2 = new MappingRecordBuilder();
 240         eidToLocator2.setEid(LispAddressUtil.asIpv4PrefixEid("0.0.0.7/32"));
 241         eidToLocator2.setRecordTtl(1000000);
 242         eidToLocator2.setAction(Action.Drop);
 243         eidToLocator2.setAuthoritative(false);
 244         eidToLocator2.setMapVersion((short) 29);
 245         mrBuilder.getMappingRecordItem().add(
 246                 new MappingRecordItemBuilder().setMappingRecord(eidToLocator2.build()).build());
 247
 248         ByteBuffer packet = MapReplySerializer.getInstance().serialize(mrBuilder.build());
 249
 250         packet.position(12); // First record
 251         assertEquals(7, packet.getInt());
 252         packet.position(packet.position() + 2); // skip Locator Count & Mask-len
 253
 254         assertHexEquals((byte) 0x50, packet.get());
 255         packet.position(packet.position() + 1); // skip Reserved byte
 256         assertEquals((short) 3072, packet.getShort());
 257
 258         packet.position(packet.position() + 6); // Second record
 259         assertEquals(1000000, packet.getInt());
 260         packet.position(packet.position() + 2); // skip Locator Count & Mask-len
 261
 262         assertHexEquals((byte) 0x60, packet.get());
 263         packet.position(packet.position() + 1); // skip Reserved byte
 264         assertEquals((short) 29, packet.getShort());
 265     }
 266
 267     @Test
 268     public void serialize__LocatorRecordFields() throws Exception {
 269         MapReplyBuilder mrBuilder = new MapReplyBuilder();
 270         mrBuilder.setMappingRecordItem(new ArrayList<MappingRecordItem>());
 271
 272         MappingRecordBuilder eidToLocatorBuilder = new MappingRecordBuilder();
 273         eidToLocatorBuilder.setEid(LispAddressUtil.asIpv4PrefixEid("0.0.0.1/32"));
 274         eidToLocatorBuilder.setLocatorRecord(new ArrayList<LocatorRecord>());
 275
 276         LocatorRecordBuilder locatorBuilder1 = new LocatorRecordBuilder();
 277         locatorBuilder1.setPriority((short) 0xF3);
 278         locatorBuilder1.setWeight((short) 0xF6);
 279         locatorBuilder1.setMulticastPriority((short) 0xA3);
 280         locatorBuilder1.setMulticastWeight((short) 0x06);
 281         locatorBuilder1.setRloc(LispAddressUtil.asIpv4Rloc("0.0.0.1"));
 282         locatorBuilder1.setLocalLocator(true);
 283         locatorBuilder1.setRlocProbed(true);
 284         locatorBuilder1.setRouted(true);
 285         eidToLocatorBuilder.getLocatorRecord().add(locatorBuilder1.build());
 286
 287         LocatorRecordBuilder locatorBuilder2 = new LocatorRecordBuilder();
 288         locatorBuilder2.setPriority((short) 0x03);
 289         locatorBuilder2.setWeight((short) 0x06);
 290         locatorBuilder2.setMulticastPriority((short) 0x03);
 291         locatorBuilder2.setMulticastWeight((short) 0xF1);
 292         locatorBuilder2.setRloc(LispAddressUtil.asIpv4Rloc("0.0.0.2"));
 293         locatorBuilder2.setLocalLocator(false);
 294         locatorBuilder2.setRlocProbed(false);
 295         locatorBuilder2.setRouted(false);
 296         eidToLocatorBuilder.getLocatorRecord().add(locatorBuilder2.build());
 297
 298         mrBuilder.getMappingRecordItem().add(
 299                 new MappingRecordItemBuilder().setMappingRecord(eidToLocatorBuilder.build()).build());
 300
 301         ByteBuffer packet = MapReplySerializer.getInstance().serialize(mrBuilder.build());
 302
 303         packet.position(12 + 16); // First locator record
 304         assertHexEquals((byte) 0xF3, packet.get());
 305         assertHexEquals((byte) 0xF6, packet.get());
 306         assertHexEquals((byte) 0xA3, packet.get());
 307         assertHexEquals((byte) 0x06, packet.get());
 308         packet.position(packet.position() + 1);
 309         assertHexEquals((byte) 0x07, packet.get());
 310
 311         packet.position(packet.position() + 6); // Second locator record
 312         assertHexEquals((byte) 0x03, packet.get());
 313         assertHexEquals((byte) 0x06, packet.get());
 314         assertHexEquals((byte) 0x03, packet.get());
 315         assertHexEquals((byte) 0xF1, packet.get());
 316         packet.position(packet.position() + 1);
 317         assertHexEquals((byte) 0x00, packet.get());
 318     }
 319 }