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