interfacemgr/interfacemgr-impl/src/test/java/org/opendaylight/vpnservice/interfacemgr/test/InterfaceManagerTestUtil.java

   1 /*
   2  * Copyright (c) 2015 Ericsson India Global Services Pvt Ltd. 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.vpnservice.interfacemgr.test;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.collect.Maps;
  12 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  13 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  14 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  15 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  16 import org.opendaylight.vpnservice.interfacemgr.IfmConstants;
  17 import org.opendaylight.vpnservice.interfacemgr.IfmUtil;
  18 import org.opendaylight.vpnservice.interfacemgr.commons.InterfaceMetaUtils;
  19 import org.opendaylight.vpnservice.interfacemgr.renderer.ovs.utilities.SouthboundUtils;
  20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.L2vlan;
  21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.rev140508.Tunnel;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpAddress;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCase;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadata;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.*;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.Options;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.OptionsKey;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.IdPools;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPool;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.id.pools.IdPoolKey;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.BridgeEntry;
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.BridgeEntryBuilder;
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.BridgeEntryKey;
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.bridge.entry.BridgeInterfaceEntry;
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.bridge.entry.BridgeInterfaceEntryBuilder;
  55 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge._interface.info.bridge.entry.BridgeInterfaceEntryKey;
  56 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge.ref.info.BridgeRefEntry;
  57 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.meta.rev151007.bridge.ref.info.BridgeRefEntryKey;
  58 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.interfacemgr.rev150331.*;
  59 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev130712.NetworkTopology;
  60 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  61 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId;
  62 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  63 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  64 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPoint;
  65 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.node.TerminationPointKey;
  67 import org.opendaylight.yangtools.yang.binding.DataObject;
  68 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  69 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  70
  71 import java.math.BigInteger;
  72 import java.util.ArrayList;
  73 import java.util.Arrays;
  74 import java.util.List;
  75 import java.util.Map;
  76
  77 public class InterfaceManagerTestUtil {
  78     public static final String interfaceName = "s1-eth1";
  79     public static final String tunnelInterfaceName = "s2-gre1";
  80     public static final TopologyId OVSDB_TOPOLOGY_ID = new TopologyId(new Uri("ovsdb:1"));
  81
  82     public static org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface buildStateInterface(
  83             String ifName, NodeConnectorId ncId) {
  84         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder ifaceBuilder =
  85                 new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceBuilder();
  86         ifaceBuilder.setKey(IfmUtil.getStateInterfaceKeyFromName(ifName));
  87         ifaceBuilder.setOperStatus(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface.OperStatus.Up);
  88         ifaceBuilder.setLowerLayerIf(Arrays.asList(ncId.getValue()));
  89         return ifaceBuilder.build();
  90     }
  91
  92     public static InstanceIdentifier<NodeConnector> getNcIdent(String nodeKey, NodeConnectorId ncId) {
  93         return InstanceIdentifier.builder(Nodes.class)
  94                 .child(Node.class, new NodeKey(new NodeId(nodeKey)))
  95                 .child(NodeConnector.class, new NodeConnectorKey(ncId))
  96                 .build();
  97     }
  98
  99     public static Interface buildInterface(String ifName, String desc, boolean enabled, Object ifType,
 100                                            BigInteger dpn) {
 101         InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(ifName)).setName(ifName)
 102                 .setDescription(desc).setEnabled(enabled).setType((Class<? extends InterfaceType>) ifType);
 103         ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 104         builder.addAugmentation(ParentRefs.class, parentRefs);
 105         if(ifType.equals(L2vlan.class)){
 106             IfL2vlan l2vlan = new IfL2vlanBuilder().setVlanId(VlanId.getDefaultInstance("0"))
 107                     .setL2vlanMode(IfL2vlan.L2vlanMode.Access).build();
 108             builder.addAugmentation(IfL2vlan.class, l2vlan);
 109         }else if(ifType.equals(IfTunnel.class)){
 110             IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(null).setTunnelGateway(null).setTunnelSource(null)
 111                     .setTunnelInterfaceType(null).build();
 112             builder.addAugmentation(IfTunnel.class, tunnel);
 113         }
 114         return builder.build();
 115     }
 116
 117     public static Interface buildTunnelInterface(BigInteger dpn, String ifName, String desc, boolean enabled, Class<? extends TunnelTypeBase> tunType,
 118                                            String remoteIpStr, String localIpStr) {
 119         InterfaceBuilder builder = new InterfaceBuilder().setKey(new InterfaceKey(ifName)).setName(ifName)
 120                 .setDescription(desc).setEnabled(enabled).setType(Tunnel.class);
 121         ParentRefs parentRefs = new ParentRefsBuilder().setDatapathNodeIdentifier(dpn).build();
 122         builder.addAugmentation(ParentRefs.class, parentRefs);
 123         IpAddress remoteIp = new IpAddress(Ipv4Address.getDefaultInstance(remoteIpStr));
 124         IpAddress localIp =  new IpAddress(Ipv4Address.getDefaultInstance(localIpStr));
 125         IfTunnel tunnel = new IfTunnelBuilder().setTunnelDestination(remoteIp).setTunnelGateway(localIp).setTunnelSource(localIp)
 126                     .setTunnelInterfaceType( tunType).build();
 127         builder.addAugmentation(IfTunnel.class, tunnel);
 128         return builder.build();
 129     }
 130
 131     public static NodeConnector buildNodeConnector(NodeConnectorId ncId) {
 132         NodeConnectorBuilder ncBuilder = new NodeConnectorBuilder()
 133                 .setId(ncId)
 134                 .setKey(new NodeConnectorKey(ncId));
 135         return ncBuilder.build();
 136     }
 137
 138     public static NodeConnectorId buildNodeConnectorId(BigInteger dpn, long portNo) {
 139         return new NodeConnectorId(buildNodeConnectorString(dpn, portNo));
 140     }
 141
 142     public static String buildNodeConnectorString(BigInteger dpn, long portNo){
 143        return new StringBuffer().append(IfmConstants.OF_URI_PREFIX).
 144                append(dpn).append(IfmConstants.OF_URI_SEPARATOR).
 145                append(portNo).toString();
 146     }
 147
 148     public static InstanceIdentifier<BridgeInterfaceEntry> buildBridgeEntryId(BigInteger dpn, String interfaceName){
 149         BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpn);
 150         BridgeInterfaceEntryKey bridgeInterfaceEntryKey = new BridgeInterfaceEntryKey(interfaceName);
 151         InstanceIdentifier<BridgeInterfaceEntry> bridgeInterfaceEntryIid =
 152                 InterfaceMetaUtils.getBridgeInterfaceEntryIdentifier(bridgeEntryKey, bridgeInterfaceEntryKey);
 153         return bridgeInterfaceEntryIid;
 154     }
 155
 156     public static BridgeEntry buildBridgeEntry(BigInteger dpn, BridgeInterfaceEntry bridgeInterfaceEntry){
 157         BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpn);
 158         BridgeEntry bridgeEntry = new BridgeEntryBuilder().setKey(bridgeEntryKey).setDpid(dpn).
 159                 setBridgeInterfaceEntry(Arrays.asList(bridgeInterfaceEntry)).build();
 160         return bridgeEntry;
 161     }
 162
 163     public static BridgeInterfaceEntry buildBridgeInterfaceEntry(BigInteger dpn, String interfaceName){
 164         BridgeEntryKey bridgeEntryKey = new BridgeEntryKey(dpn);
 165         BridgeInterfaceEntryKey bridgeInterfaceEntryKey = new BridgeInterfaceEntryKey(interfaceName);
 166         BridgeInterfaceEntryBuilder entryBuilder = new BridgeInterfaceEntryBuilder().setKey(bridgeInterfaceEntryKey)
 167                 .setInterfaceName(interfaceName);
 168         return entryBuilder.build();
 169     }
 170
 171     public static InstanceIdentifier<OvsdbBridgeAugmentation> getOvsdbAugmentationInstanceIdentifier(String portName,
 172                                                                                                      org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node node) {
 173         InstanceIdentifier<OvsdbBridgeAugmentation> ovsdbBridgeAugmentationInstanceIdentifier = InstanceIdentifier
 174                 .create(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology.class)
 175                 .child(Topology.class, new TopologyKey(OVSDB_TOPOLOGY_ID))
 176                 .child(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node.class,node.getKey())
 177                 .augmentation(OvsdbBridgeAugmentation.class);
 178         return ovsdbBridgeAugmentationInstanceIdentifier;
 179     }
 180
 181     public static OvsdbBridgeAugmentation getOvsdbBridgeRef(String bridgeName){
 182         OvsdbBridgeAugmentationBuilder builder = new OvsdbBridgeAugmentationBuilder().setBridgeName(new OvsdbBridgeName(bridgeName));
 183         return builder.build();
 184     }
 185
 186     public static InstanceIdentifier<TerminationPoint> getTerminationPointId(InstanceIdentifier<?> bridgeIid, String portName){
 187         InstanceIdentifier<TerminationPoint> tpIid = SouthboundUtils.createTerminationPointInstanceIdentifier(
 188                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node.class)), portName);
 189         return tpIid;
 190     }
 191
 192     public static TerminationPoint getTerminationPoint(InstanceIdentifier<?> bridgeIid, OvsdbBridgeAugmentation bridgeNode,
 193                                             String portName, int vlanId, Class type,
 194                                             Interface iface) {
 195         InstanceIdentifier<TerminationPoint> tpIid = SouthboundUtils.createTerminationPointInstanceIdentifier(
 196                 InstanceIdentifier.keyOf(bridgeIid.firstIdentifierOf(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node.class)), portName);
 197         OvsdbTerminationPointAugmentationBuilder tpAugmentationBuilder = new OvsdbTerminationPointAugmentationBuilder();
 198
 199         tpAugmentationBuilder.setName(portName);
 200
 201         if (type != null) {
 202             tpAugmentationBuilder.setInterfaceType(type);
 203         }
 204         IfTunnel ifTunnel = iface.getAugmentation(IfTunnel.class);
 205         Map<String, String> options = Maps.newHashMap();
 206         options.put("key", "flow");
 207
 208         IpAddress localIp = ifTunnel.getTunnelSource();
 209         options.put("local_ip", localIp.getIpv4Address().getValue());
 210
 211         IpAddress remoteIp = ifTunnel.getTunnelDestination();
 212         options.put("remote_ip", remoteIp.getIpv4Address().getValue());
 213
 214         if (options != null) {
 215             List<Options> optionsList = new ArrayList<Options>();
 216             for (Map.Entry<String, String> entry : options.entrySet()) {
 217                 OptionsBuilder optionsBuilder = new OptionsBuilder();
 218                 optionsBuilder.setKey(new OptionsKey(entry.getKey()));
 219                 optionsBuilder.setOption(entry.getKey());
 220                 optionsBuilder.setValue(entry.getValue());
 221                 optionsList.add(optionsBuilder.build());
 222             }
 223             tpAugmentationBuilder.setOptions(optionsList);
 224         }
 225
 226         if (vlanId != 0) {
 227             tpAugmentationBuilder.setVlanMode(OvsdbPortInterfaceAttributes.VlanMode.Access);
 228             tpAugmentationBuilder.setVlanTag(new VlanId(vlanId));
 229         }
 230
 231         TerminationPointBuilder tpBuilder = new TerminationPointBuilder();
 232         tpBuilder.setKey(InstanceIdentifier.keyOf(tpIid));
 233         tpBuilder.addAugmentation(OvsdbTerminationPointAugmentation.class, tpAugmentationBuilder.build());
 234         return tpBuilder.build();
 235     }
 236 }