core/api/src/test/java/org/onosproject/net/ConnectPointTest.java

/*
 * Copyright 2014-present Open Networking Foundation
 *
 * 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.onosproject.net;

import com.google.common.testing.EqualsTester;
import org.junit.Test;

import static junit.framework.TestCase.fail;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.onosproject.net.ConnectPointTest.Relate.AFTER;
import static org.onosproject.net.ConnectPointTest.Relate.BEFORE;
import static org.onosproject.net.ConnectPointTest.Relate.SAME_AS;
import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.PortNumber.portNumber;

/**
 * Test of the connection point entity.
 */
public class ConnectPointTest {

    private static final DeviceId DID1 = deviceId("1");
    private static final DeviceId DID2 = deviceId("2");
    private static final PortNumber P1 = portNumber(1);
    private static final PortNumber P2 = portNumber(2);

    private ConnectPoint cp(DeviceId d, PortNumber p) {
        return new ConnectPoint(d, p);
    }

    @Test
    public void basics() {
        ConnectPoint p = cp(DID1, P2);
        assertEquals("incorrect element id", DID1, p.deviceId());
        assertEquals("incorrect element id", P2, p.port());
    }

    @Test
    public void testEquality() {
        new EqualsTester()
                .addEqualityGroup(cp(DID1, P1), cp(DID1, P1))
                .addEqualityGroup(cp(DID1, P2), cp(DID1, P2))
                .addEqualityGroup(cp(DID2, P1), cp(DID2, P1))
                .testEquals();
    }

    @Test
    public void testParseDeviceConnectPoint() {
        String cp = "of:0011223344556677/1";

        ConnectPoint connectPoint = ConnectPoint.deviceConnectPoint(cp);
        assertEquals("of:0011223344556677", connectPoint.deviceId().toString());
        assertEquals("1", connectPoint.port().toString());

        expectDeviceParseException("");
        expectDeviceParseException("1/");
        expectDeviceParseException("of:0011223344556677/word");
    }

    @Test
    public void testParseFromStringOF() {
        String cp = "of:0011223344556677/1";

        ConnectPoint connectPoint = ConnectPoint.fromString(cp);
        assertEquals("of:0011223344556677", connectPoint.deviceId().toString());
        assertEquals("1", connectPoint.port().toString());

        expectStringParseException("[");
        expectStringParseException("1/[");
        expectStringParseException("1/[aasksk");
        expectStringParseException("1/[alksas]");
    }

    @Test
    public void testParseFromStringNetconf() {
        String cp = "netconf:127.0.0.1/[TYPE](1)";

        ConnectPoint connectPoint = ConnectPoint.fromString(cp);
        assertEquals("netconf:127.0.0.1", connectPoint.deviceId().toString());
        assertEquals("[TYPE](1)", connectPoint.port().toString());
        assertEquals(connectPoint, ConnectPoint.fromString(connectPoint.toString()));
    }

    @Test
    public void testParseFromStringBmv2() {
        String cp = "device:leaf1/[leaf1-eth4](1)";

        ConnectPoint connectPoint = ConnectPoint.fromString(cp);
        assertEquals("device:leaf1", connectPoint.deviceId().toString());
        assertEquals("[leaf1-eth4](1)", connectPoint.port().toString());
        assertEquals(connectPoint, ConnectPoint.fromString(connectPoint.toString()));
    }

    @Test
    public void testParseFromStringStratum() {
        String cp = "device:leaf1/[3/0](1)";

        ConnectPoint connectPoint = ConnectPoint.fromString(cp);
        assertEquals("device:leaf1", connectPoint.deviceId().toString());
        assertEquals("[3/0](1)", connectPoint.port().toString());
        assertEquals(connectPoint, ConnectPoint.fromString(connectPoint.toString()));
    }

    /**
     * Parse a device connect point and expect an exception to be thrown.
     *
     * @param string string to parse
     */
    private static void expectDeviceParseException(String string) {
        try {
            ConnectPoint.deviceConnectPoint(string);
            fail(String.format("Expected exception was not thrown for '%s'", string));
        } catch (Exception e) {
            assertTrue(true);
        }
    }

    /**
     * Parse a string connect point and expect an exception to be thrown.
     *
     * @param string string to parse
     */
    private static void expectStringParseException(String string) {
        try {
            ConnectPoint.fromString(string);
            fail(String.format("Expected exception was not thrown for '%s'", string));
        } catch (Exception e) {
            assertTrue(true);
        }
    }

    @Test
    public void testParseHostConnectPoint() {
        String cp = "16:3A:BD:6E:31:E4/-1/1";

        ConnectPoint connectPoint = ConnectPoint.hostConnectPoint(cp);
        assertEquals("16:3A:BD:6E:31:E4/None", connectPoint.hostId().toString());
        assertEquals("1", connectPoint.port().toString());

        expectHostParseException("");
        expectHostParseException("1/");
        expectHostParseException("1/1");
        expectHostParseException("1/1/1/1");
        expectHostParseException("16:3A:BD:6E:31:E4/word/1");
        expectHostParseException("16:3A:BD:6E:31:E4/1/word");
    }

    /**
     * Parse a host connect point and expect an exception to be thrown.
     *
     * @param string string to parse
     */
    private static void expectHostParseException(String string) {
        try {
            ConnectPoint.hostConnectPoint(string);
            fail("Expected exception was not thrown");
        } catch (Exception e) {
            assertTrue(true);
        }
    }

    enum Relate { BEFORE, SAME_AS, AFTER }

    private void checkComparison(ConnectPoint cpA, Relate r, ConnectPoint cpB) {
        switch (r) {
            case BEFORE:
                assertTrue("Bad before", cpA.compareTo(cpB) < 0);
                assertTrue("Bad before", cpB.compareTo(cpA) > 0);
                break;
            case SAME_AS:
                assertTrue("Bad same_as", cpA.compareTo(cpB) == 0);
                assertTrue("Bad same_as", cpB.compareTo(cpA) == 0);
                break;
            case AFTER:
                assertTrue("Bad after", cpA.compareTo(cpB) > 0);
                assertTrue("Bad after", cpB.compareTo(cpA) < 0);
                break;
            default:
                fail("Bad relation");
        }
    }

    @Test
    public void comparator() {
        checkComparison(cp(DID1, P1), SAME_AS, cp(DID1, P1));
        checkComparison(cp(DID1, P1), BEFORE, cp(DID1, P2));
        checkComparison(cp(DID1, P2), AFTER, cp(DID1, P1));

        checkComparison(cp(DID1, P1), BEFORE, cp(DID2, P1));
        checkComparison(cp(DID1, P2), BEFORE, cp(DID2, P1));
        checkComparison(cp(DID1, P1), BEFORE, cp(DID2, P2));
        checkComparison(cp(DID1, P2), BEFORE, cp(DID2, P2));
    }
}