core/api/src/test/java/org/onosproject/net/NetTestTools.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.collect.ImmutableList;
import org.onlab.graph.ScalarWeight;
import org.onlab.junit.TestUtils;
import org.onlab.packet.ChassisId;
import org.onlab.packet.IpPrefix;
import org.onlab.packet.MacAddress;
import org.onlab.packet.MplsLabel;
import org.onlab.packet.VlanId;
import org.onosproject.TestApplicationId;
import org.onosproject.cluster.NodeId;
import org.onosproject.core.ApplicationId;
import org.onosproject.event.EventDeliveryService;
import org.onosproject.net.flow.DefaultTrafficSelector;
import org.onosproject.net.flow.DefaultTrafficTreatment;
import org.onosproject.net.flow.TrafficSelector;
import org.onosproject.net.flow.TrafficTreatment;
import org.onosproject.net.intent.Constraint;
import org.onosproject.net.intent.constraint.EncapsulationConstraint;
import org.onosproject.net.provider.ProviderId;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;

import static org.junit.Assert.assertEquals;
import static org.onlab.packet.MacAddress.valueOf;
import static org.onlab.packet.VlanId.vlanId;
import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.HostId.hostId;
import static org.onosproject.net.PortNumber.portNumber;

/**
 * Miscellaneous tools for testing core related to the network model.
 */
public final class NetTestTools {

    private NetTestTools() {
    }

    public static final ProviderId PID = new ProviderId("of", "foo");
    public static final ApplicationId APP_ID = new TestApplicationId("foo");
    public static final NodeId NODE_ID = new NodeId("node1");

    // Short-hand for producing a device id from a string
    public static DeviceId did(String id) {
        return deviceId("of:" + id);
    }


    // Short-hand for producing a host id from a string
    public static HostId hid(String id) {
        return hostId(id);
    }

    // Crates a new device with the specified id
    public static Device device(String id) {
        return new DefaultDevice(PID, did(id), Device.Type.SWITCH,
                                 "mfg", "1.0", "1.1", "1234", new ChassisId());
    }

    // Crates a new host with the specified id
    public static Host host(String id, String did, long port) {
        return new DefaultHost(PID, hid(id), valueOf(1234), vlanId((short) 2),
                               new HostLocation(did(did), portNumber(port), 321),
                               new HashSet<>());
    }

    // Crates a new host with the specified id
    public static Host host(String id, String did) {
        return host(id, did, 1);
    }

    // Short-hand for creating a connection point.
    public static ConnectPoint connectPoint(String id, int port) {
        return new ConnectPoint(did(id), portNumber(port));
    }

    // Short-hand for creating a connection point.
    public static ConnectPoint connectPointNoOF(String id, int port) {
        return new ConnectPoint(DeviceId.deviceId(id), portNumber(port));
    }

    // Short-hand for creating a link.
    public static Link link(String src, int sp, String dst, int dp) {
        return new DefaultLink(PID,
                               connectPoint(src, sp),
                               connectPoint(dst, dp),
                               Link.Type.DIRECT, Link.State.ACTIVE);
    }

    // Short-hand for creating a link.
    public static Link linkNoPrefixes(String src, int sp, String dst, int dp) {
        return new DefaultLink(PID,
                               connectPointNoOF(src, sp),
                               connectPointNoOF(dst, dp),
                               Link.Type.DIRECT, Link.State.ACTIVE);
    }

    /**
     * Short-hand for creating a link.
     *
     * @param src the src of the link
     * @param dst the dst of the link
     * @return a link
     */
    public static Link link(ConnectPoint src, ConnectPoint dst) {
        return new DefaultLink(PID, src, dst, Link.Type.DIRECT, Link.State.ACTIVE);
    }

    // Creates a path that leads through the given devices.
    public static Path createPath(String... ids) {
        List<Link> links = new ArrayList<>();
        for (int i = 0; i < ids.length - 1; i++) {
            links.add(link(ids[i], 2, ids[i + 1], 1));
        }
        return new DefaultPath(PID, links, ScalarWeight.toWeight(ids.length));
    }

    // Creates a path that leads through the given hosts.
    public static Path createPath(boolean srcIsEdge, boolean dstIsEdge, String... ids) {
        List<Link> links = new ArrayList<>();
        for (int i = 0; i < ids.length - 1; i++) {
            if (i == 0 && srcIsEdge) {
                links.add(DefaultEdgeLink.createEdgeLink(host(ids[i], ids[i + 1], 1), true));
            } else if (i == ids.length - 2 && dstIsEdge) {
                links.add(DefaultEdgeLink.createEdgeLink(host(ids[i + 1], ids[i], 2), false));
            } else {
                links.add(link(ids[i], 2, ids[i + 1], 1));
            }
        }
        return new DefaultPath(PID, links, ScalarWeight.toWeight(ids.length));
    }

    // Creates OCh signal
    public static OchSignal createLambda() {
        return new OchSignal(GridType.DWDM, ChannelSpacing.CHL_6P25GHZ, 8, 4);
    }

    /**
     * Verifies that Annotations created by merging {@code annotations} is
     * equal to actual Annotations.
     *
     * @param actual      annotations to check
     * @param annotations expected annotations
     */
    public static void assertAnnotationsEquals(Annotations actual, SparseAnnotations... annotations) {
        DefaultAnnotations expected = DefaultAnnotations.builder().build();
        for (SparseAnnotations a : annotations) {
            expected = DefaultAnnotations.merge(expected, a);
        }
        assertEquals(expected.keys(), actual.keys());
        for (String key : expected.keys()) {
            assertEquals(expected.value(key), actual.value(key));
        }
    }

    /**
     * Injects the given event delivery service into the specified manager
     * component.
     *
     * @param manager manager component
     * @param svc     service reference to be injected
     */
    public static void injectEventDispatcher(Object manager, EventDeliveryService svc) {
        Class mc = manager.getClass();
        for (Field f : mc.getSuperclass().getDeclaredFields()) {
            if (f.getType().equals(EventDeliveryService.class)) {
                try {
                    TestUtils.setField(manager, f.getName(), svc);
                } catch (TestUtils.TestUtilsException e) {
                    throw new IllegalArgumentException("Unable to inject reference", e);
                }
                break;
            }
        }
    }

    /**
     * Builds an empty selector.
     *
     * @return the selector
     */
    public static TrafficSelector emptySelector() {
        return DefaultTrafficSelector.emptySelector();
    }

    /**
     * Builds a vlan selector.
     *
     * @return the selector
     */
    public static TrafficSelector vlanSelector(String vlanId) {
        return DefaultTrafficSelector.builder()
                .matchVlanId(VlanId.vlanId(vlanId))
                .build();
    }

    /**
     * Builds a mpls selector.
     *
     * @return the selector
     */
    public static TrafficSelector mplsSelector(String mplsLabel) {
        return DefaultTrafficSelector.builder()
                .matchMplsLabel(MplsLabel.mplsLabel(mplsLabel))
                .build();
    }

    /**
     * Builds an ip prefix dst selector.
     *
     * @return the selector
     */
    public static TrafficSelector ipPrefixDstSelector(String prefix) {
        return DefaultTrafficSelector.builder()
                .matchIPDst(IpPrefix.valueOf(prefix))
                .build();
    }

    public static TrafficSelector ethDstSelector(String macAddress) {
        return DefaultTrafficSelector.builder()
                .matchEthDst(MacAddress.valueOf(macAddress))
                .build();
    }

    /**
     * Builds an empty treatment.
     *
     * @return the treatment
     */
    public static TrafficTreatment emptyTreatment() {
        return DefaultTrafficTreatment.emptyTreatment();
    }

    /**
     * Builds a mac dst treatment.
     *
     * @return the treatment
     */
    public static TrafficTreatment macDstTreatment(String mac) {
        return DefaultTrafficTreatment.builder()
                .setEthDst(MacAddress.valueOf(mac))
                .build();
    }

    /**
     * Builds a list containing a vlan encapsulation constraint.
     *
     * @return the list of constraints
     */
    public static List<Constraint> vlanConstraint() {
        return ImmutableList.of(
                new EncapsulationConstraint(EncapsulationType.VLAN)
        );
    }

    /**
     * Builds a list containing a mpls encapsulation constraint.
     *
     * @return the list of constraints
     */
    public static List<Constraint> mplsConstraint() {
        return ImmutableList.of(
                new EncapsulationConstraint(EncapsulationType.MPLS)
        );
    }

    /**
     * Builds a treatment which contains the dec ttl
     * actions.
     *
     * @return the treatment
     */
    public static TrafficTreatment decTtlTreatment() {
        return DefaultTrafficTreatment.builder()
                .decMplsTtl()
                .decNwTtl()
                .build();
    }

}