utils/misc/src/test/java/org/onlab/packet/ndp/NeighborSolicitationTest.java

/*
 * Copyright 2015-present 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.ndp;

import org.junit.BeforeClass;
import org.junit.Test;
import org.onlab.packet.DeserializationException;
import org.onlab.packet.Deserializer;
import org.onlab.packet.Ethernet;
import org.onlab.packet.ICMP6;
import org.onlab.packet.IPv6;
import org.onlab.packet.Ip6Address;
import org.onlab.packet.MacAddress;
import org.onlab.packet.PacketTestUtils;
import org.onlab.packet.VlanId;

import java.nio.ByteBuffer;

import static org.hamcrest.Matchers.is;
import static org.junit.Assert.*;
import static org.onlab.packet.ndp.NeighborDiscoveryOptions.TYPE_SOURCE_LL_ADDRESS;

/**
 * Tests for class {@link NeighborSolicitation}.
 */
public class NeighborSolicitationTest {
    private static final Ip6Address TARGET_IP = Ip6Address.valueOf("2000::1");
    private static final Ip6Address SRC_IP = Ip6Address.valueOf("2000::f");
    private static final Ip6Address DST_IP = Ip6Address.valueOf("2000::1");
    private static final MacAddress SRC_MAC = MacAddress.valueOf("00:00:00:00:00:0f");
    private static final MacAddress DST_MAC = MacAddress.valueOf("00:00:00:00:00:01");
    private static final VlanId VLAN_ID = VlanId.NONE;

    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 final MacAddress MAC_ADDRESS =
        MacAddress.valueOf("11:22:33:44:55:66");

    private static byte[] bytePacket;

    private Deserializer<NeighborSolicitation> deserializer
            = NeighborSolicitation.deserializer();

    @BeforeClass
    public static void setUpBeforeClass() throws Exception {
        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,
            (byte) 0x02, (byte) 0x01, (byte) 0x11, (byte) 0x22,
            (byte) 0x33, (byte) 0x44, (byte) 0x55, (byte) 0x66
        };
        bytePacket = new byte[byteHeader.length];
        System.arraycopy(byteHeader, 0, bytePacket, 0, byteHeader.length);
    }

    /**
     * Tests serialize and setters.
     */
    @Test
    public void testSerialize() {
        NeighborSolicitation ns = new NeighborSolicitation();
        ns.setTargetAddress(TARGET_ADDRESS);
        ns.addOption(NeighborDiscoveryOptions.TYPE_TARGET_LL_ADDRESS,
                     MAC_ADDRESS.toBytes());

        assertArrayEquals(ns.serialize(), bytePacket);
    }

    @Test
    public void testDeserializeBadInput() throws Exception {
        PacketTestUtils.testDeserializeBadInput(NeighborSolicitation.deserializer());
    }

    @Test
    public void testDeserializeTruncated() throws Exception {
        // Run the truncation test only on the NeighborSolicitation header
        byte[] nsHeader = new byte[NeighborSolicitation.HEADER_LENGTH];
        ByteBuffer.wrap(bytePacket).get(nsHeader);

        PacketTestUtils.testDeserializeTruncated(NeighborSolicitation.deserializer(), nsHeader);
    }

    /**
     * Tests deserialize and getters.
     */
    @Test
    public void testDeserialize() throws DeserializationException {
        NeighborSolicitation ns = deserializer.deserialize(bytePacket, 0, bytePacket.length);

        assertArrayEquals(ns.getTargetAddress(), TARGET_ADDRESS);

        // Check the option(s)
        assertThat(ns.getOptions().size(), is(1));
        NeighborDiscoveryOptions.Option option = ns.getOptions().get(0);
        assertThat(option.type(),
                   is(NeighborDiscoveryOptions.TYPE_TARGET_LL_ADDRESS));
        assertArrayEquals(option.data(), MAC_ADDRESS.toBytes());
    }

    /**
     * Tests comparator.
     */
    @Test
    public void testEqual() {
        NeighborSolicitation ns1 = new NeighborSolicitation();
        ns1.setTargetAddress(TARGET_ADDRESS);
        ns1.addOption(NeighborDiscoveryOptions.TYPE_TARGET_LL_ADDRESS,
                      MAC_ADDRESS.toBytes());

        NeighborSolicitation ns2 = new NeighborSolicitation();
        ns2.setTargetAddress(TARGET_ADDRESS2);
        ns2.addOption(NeighborDiscoveryOptions.TYPE_TARGET_LL_ADDRESS,
                      MAC_ADDRESS.toBytes());

        assertTrue(ns1.equals(ns1));
        assertFalse(ns1.equals(ns2));
    }

    /**
     * Tests toString.
     */
    @Test
    public void testToStringNS() throws Exception {
        NeighborSolicitation ns = deserializer.deserialize(bytePacket, 0, bytePacket.length);
        String str = ns.toString();

        // TODO: need to handle TARGET_ADDRESS and Options
    }

    /**
     * Tests regular non-DAD neighbor solicitation.
     */
    @Test
    public void testBuildNdpSolicit() throws Exception {
        final Ethernet ethPacket = NeighborSolicitation.buildNdpSolicit(TARGET_IP,
                SRC_IP, DST_IP, SRC_MAC, DST_MAC, VLAN_ID);

        assertTrue(ethPacket.getDestinationMAC().equals(DST_MAC));
        assertTrue(ethPacket.getSourceMAC().equals(SRC_MAC));
        assertTrue(ethPacket.getEtherType() == Ethernet.TYPE_IPV6);
        assertTrue(ethPacket.getVlanID() == VLAN_ID.id());

        final IPv6 ipPacket = (IPv6) ethPacket.getPayload();

        assertArrayEquals(ipPacket.getSourceAddress(), SRC_IP.toOctets());
        assertArrayEquals(ipPacket.getDestinationAddress(), DST_IP.toOctets());

        final ICMP6 icmp6Packet = (ICMP6) ipPacket.getPayload();
        final NeighborSolicitation nsPacket = (NeighborSolicitation) icmp6Packet.getPayload();

        assertArrayEquals(nsPacket.getTargetAddress(), TARGET_IP.toOctets());

        assertEquals("Non-DAD NS should have 1 option", 1, nsPacket.getOptions().size());
        assertEquals("The option should be SRC_LL_ADDR type", TYPE_SOURCE_LL_ADDRESS,
                nsPacket.getOptions().stream().findFirst().get().type());
    }

    /**
     * Tests DAD neighbor solicitation.
     * Source IP should be all-zero.
     */
    @Test
    public void testBuildNdpSolicitDad() throws Exception {
        Ethernet ethPacket = NeighborSolicitation.buildNdpSolicit(TARGET_IP,
                Ip6Address.ZERO, DST_IP, SRC_MAC, DST_MAC, VLAN_ID);
        IPv6 ipPacket = (IPv6) ethPacket.getPayload();
        ICMP6 icmp6Packet = (ICMP6) ipPacket.getPayload();
        NeighborSolicitation nsPacket = (NeighborSolicitation) icmp6Packet.getPayload();

        assertEquals("DAD NS should have no option", 0, nsPacket.getOptions().size());
    }
}