Trace IPv6 hosts

ONOS-511: Implement NeighborSolicitation

Change-Id: I9aaf35d499cfc7885c74f9c4bf281210ef9f3969

ONOS-507: Trace NeighborSolicitation/NeighborAdvertisement/IPv6 packets in HostLocationProvider
	* Complete Javadoc of IPv6, ICMP6, NeighborAdvertisement and NeighborSolicitation
		- The Javadoc for serialize() is removed since the one in its superclass just works fine.
	* Change 'diffServ' in IPv6 to 'trafficClass' to meet the field name in RFC.
		- The setter method, getter method and unit test are also updated accordingly.
	* Add IpAddress.isZero() to determine if this address is zero.
		- The unit test is also updated accordingly.
	* Fix misuse of IpAddress.valueOf(int) in HostLocationProvider

Change-Id: Id0d873aeb1bc61bf26d4964e7aab4bb06ccd0a38
diff --git a/utils/misc/src/test/java/org/onlab/packet/IPv6Test.java b/utils/misc/src/test/java/org/onlab/packet/IPv6Test.java
index 0c14fea..b229ee0 100644
--- a/utils/misc/src/test/java/org/onlab/packet/IPv6Test.java
+++ b/utils/misc/src/test/java/org/onlab/packet/IPv6Test.java
@@ -73,7 +73,7 @@
         IPv6 ipv6 = new IPv6();
         ipv6.setPayload(udp);
         ipv6.setVersion((byte) 6);
-        ipv6.setDiffServ((byte) 0x93);
+        ipv6.setTrafficClass((byte) 0x93);
         ipv6.setFlowLabel(0x13579);
         ipv6.setNextHeader(IPv6.PROTOCOL_UDP);
         ipv6.setHopLimit((byte) 32);
@@ -92,7 +92,7 @@
         ipv6.deserialize(bytePacket, 0, bytePacket.length);
 
         assertThat(ipv6.getVersion(), is((byte) 6));
-        assertThat(ipv6.getDiffServ(), is((byte) 0x93));
+        assertThat(ipv6.getTrafficClass(), is((byte) 0x93));
         assertThat(ipv6.getFlowLabel(), is(0x13579));
         assertThat(ipv6.getNextHeader(), is(IPv6.PROTOCOL_UDP));
         assertThat(ipv6.getHopLimit(), is((byte) 32));
@@ -108,7 +108,7 @@
         IPv6 packet1 = new IPv6();
         packet1.setPayload(udp);
         packet1.setVersion((byte) 6);
-        packet1.setDiffServ((byte) 0x93);
+        packet1.setTrafficClass((byte) 0x93);
         packet1.setFlowLabel(0x13579);
         packet1.setNextHeader(IPv6.PROTOCOL_UDP);
         packet1.setHopLimit((byte) 32);
@@ -118,7 +118,7 @@
         IPv6 packet2 = new IPv6();
         packet2.setPayload(udp);
         packet2.setVersion((byte) 6);
-        packet2.setDiffServ((byte) 0x93);
+        packet2.setTrafficClass((byte) 0x93);
         packet2.setFlowLabel(0x13579);
         packet2.setNextHeader(IPv6.PROTOCOL_UDP);
         packet2.setHopLimit((byte) 32);
diff --git a/utils/misc/src/test/java/org/onlab/packet/IpAddressTest.java b/utils/misc/src/test/java/org/onlab/packet/IpAddressTest.java
index 7c07b07..f0e6ae7 100644
--- a/utils/misc/src/test/java/org/onlab/packet/IpAddressTest.java
+++ b/utils/misc/src/test/java/org/onlab/packet/IpAddressTest.java
@@ -26,6 +26,7 @@
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.assertFalse;
 import static org.onlab.junit.ImmutableClassChecker.assertThatClassIsImmutableBaseClass;
 
 /**
@@ -703,6 +704,28 @@
     }
 
     /**
+     * Tests if address is zero for IPv4.
+     */
+    @Test
+    public void testIsZeroIPv4() {
+        IpAddress normalIP = IpAddress.valueOf("10.0.0.1");
+        IpAddress zeroIP = IpAddress.valueOf("0.0.0.0");
+        assertFalse(normalIP.isZero());
+        assertTrue(zeroIP.isZero());
+    }
+
+    /**
+     * Tests if address is zero for IPv6.
+     */
+    @Test
+    public void testIsZeroIPv6() {
+        IpAddress normalIP = IpAddress.valueOf("fe80::1");
+        IpAddress zeroIP = IpAddress.valueOf("::");
+        assertFalse(normalIP.isZero());
+        assertTrue(zeroIP.isZero());
+    }
+
+    /**
      * Tests comparison of {@link IpAddress} for IPv4.
      */
     @Test
diff --git a/utils/misc/src/test/java/org/onlab/packet/NeighborSolicitationTest.java b/utils/misc/src/test/java/org/onlab/packet/NeighborSolicitationTest.java
new file mode 100644
index 0000000..bb6ec60
--- /dev/null
+++ b/utils/misc/src/test/java/org/onlab/packet/NeighborSolicitationTest.java
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2014 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+
+package org.onlab.packet;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+/**
+ * Tests for class {@link org.onlab.packet.NeighborSolicitation}.
+ */
+public class NeighborSolicitationTest {
+    private static final byte[] TARGET_ADDRESS = {
+            (byte) 0x20, (byte) 0x01, (byte) 0x0f, (byte) 0x18, (byte) 0x01, (byte) 0x13, (byte) 0x02, (byte) 0x15,
+            (byte) 0xca, (byte) 0x2a, (byte) 0x14, (byte) 0xff, (byte) 0xfe, (byte) 0x35, (byte) 0x26, (byte) 0xce
+    };
+    private static final byte[] TARGET_ADDRESS2 = {
+            (byte) 0x20, (byte) 0x01, (byte) 0x0f, (byte) 0x18, (byte) 0x01, (byte) 0x13, (byte) 0x02, (byte) 0x15,
+            (byte) 0xe6, (byte) 0xce, (byte) 0x8f, (byte) 0xff, (byte) 0xfe, (byte) 0x54, (byte) 0x37, (byte) 0xc8
+    };
+    private static Data data;
+    private static byte[] bytePacket;
+
+    @BeforeClass
+    public static void setUpBeforeClass() throws Exception {
+        data = new Data();
+        data.setData("".getBytes());
+
+        byte[] bytePayload = data.serialize();
+        byte[] byteHeader = {
+                (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00,
+                (byte) 0x20, (byte) 0x01, (byte) 0x0f, (byte) 0x18, (byte) 0x01, (byte) 0x13, (byte) 0x02, (byte) 0x15,
+                (byte) 0xca, (byte) 0x2a, (byte) 0x14, (byte) 0xff, (byte) 0xfe, (byte) 0x35, (byte) 0x26, (byte) 0xce
+        };
+        bytePacket = new byte[byteHeader.length + bytePayload.length];
+        System.arraycopy(byteHeader, 0, bytePacket, 0, byteHeader.length);
+        System.arraycopy(bytePayload, 0, bytePacket, byteHeader.length, bytePayload.length);
+    }
+
+    /**
+     * Tests serialize and setters.
+     */
+    @Test
+    public void testSerialize() {
+        NeighborSolicitation ns = new NeighborSolicitation();
+        ns.setTargetAddress(TARGET_ADDRESS);
+
+        assertArrayEquals(ns.serialize(), bytePacket);
+    }
+
+    /**
+     * Tests deserialize and getters.
+     */
+    @Test
+    public void testDeserialize() {
+        NeighborSolicitation ns = new NeighborSolicitation();
+        ns.deserialize(bytePacket, 0, bytePacket.length);
+
+        assertArrayEquals(ns.getTargetAddress(), TARGET_ADDRESS);
+    }
+
+    /**
+     * Tests comparator.
+     */
+    @Test
+    public void testEqual() {
+        NeighborSolicitation ns1 = new NeighborSolicitation();
+        ns1.setTargetAddress(TARGET_ADDRESS);
+
+        NeighborSolicitation ns2 = new NeighborSolicitation();
+        ns2.setTargetAddress(TARGET_ADDRESS2);
+
+        assertTrue(ns1.equals(ns1));
+        assertFalse(ns1.equals(ns2));
+    }
+}