openflowplugin/src/test/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/PacketOutConvertorTest.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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.openflowplugin.openflow.md.core.sal.convertor;
   9
  10 import java.math.BigInteger;
  11 import java.util.ArrayList;
  12 import java.util.List;
  13 import java.util.Optional;
  14 import org.junit.Assert;
  15 import org.junit.Before;
  16 import org.junit.Test;
  17 import org.opendaylight.openflowplugin.api.OFConstants;
  18 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
  19 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.action.data.ActionConvertorData;
  20 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.XidConvertorData;
  21 import org.opendaylight.openflowplugin.openflow.md.util.InventoryDataServiceUtil;
  22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.OutputActionCaseBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.output.action._case.OutputActionBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionKey;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.OutputPortValues;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.ActionBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketOutInput;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.ConnectionCookie;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInput;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInputBuilder;
  43 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  44 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
  45 import org.opendaylight.yangtools.yang.common.Uint16;
  46 import org.opendaylight.yangtools.yang.common.Uint32;
  47 import org.opendaylight.yangtools.yang.common.Uint64;
  48 import org.opendaylight.yangtools.yang.common.Uint8;
  49
  50 /**
  51  * Created by Jakub Toth jatoth@cisco.com on 9/23/14.
  52  */
  53 public class PacketOutConvertorTest {
  54
  55     private ConvertorManager convertorManager;
  56
  57     @Before
  58     public void setUp() {
  59         convertorManager = ConvertorManagerFactory.createDefaultManager();
  60     }
  61
  62     /**
  63      * Test for {@link org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.PacketOutConvertor}
  64      *  with null parameters.
  65      */
  66     @Test
  67     public void toPacketOutInputAllParmNullTest() {
  68         String nodeId = "0";
  69         String port = "0";
  70         NodeConnectorKey nodeConnKey = PacketOutConvertorTest.createNodeConnKey(nodeId, port);
  71         NodeConnectorRef egressConfRef = new NodeConnectorRef(createNodeConnRef(nodeId, nodeConnKey));
  72
  73         TransmitPacketInput transmitPacketInput = new TransmitPacketInputBuilder()
  74             .setBufferId((Uint32) null)
  75             .setConnectionCookie(null)
  76             .setNode(createNodeRef(nodeId))
  77             .setPayload(null)
  78             .setEgress(egressConfRef)
  79             .setIngress(null)
  80             .build();
  81
  82         Uint8 version = OFConstants.OFP_VERSION_1_3;
  83         Long xid = null;
  84         XidConvertorData data = new XidConvertorData(version);
  85         PacketOutInput message = convert(transmitPacketInput, data);
  86
  87         //FIXME : this has to be fixed along with actions changed in openflowjava
  88
  89         Assert.assertEquals(buildActionForNullTransmitPacketInputAction(nodeConnKey, version), message.getAction());
  90
  91         Assert.assertEquals(OFConstants.OFP_NO_BUFFER, message.getBufferId());
  92         Assert.assertEquals(new PortNumber(Uint32.valueOf(0xfffffffdL)), message.getInPort());
  93         Assert.assertEquals(version, message.getVersion());
  94         Assert.assertEquals(xid, message.getXid());
  95         Assert.assertArrayEquals(transmitPacketInput.getPayload(), message.getData());
  96     }
  97
  98     /**
  99      * Test for XidConvertorData.
 100      */
 101     @Test
 102     public void toPacketOutInputAllParmTest() {
 103         org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder ab =
 104                 new org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder();
 105
 106         OutputActionBuilder output = new OutputActionBuilder();
 107         output.setMaxLength(OFConstants.OFPCML_NO_BUFFER);
 108         Uri value = new Uri(OutputPortValues.CONTROLLER.toString());
 109         output.setOutputNodeConnector(value);
 110         ab.setAction(new OutputActionCaseBuilder().setOutputAction(
 111                 output.build()).build());
 112         ab.setOrder(0);
 113         ab.withKey(new ActionKey(0));
 114
 115         List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action> actionList =
 116                 new ArrayList<>();
 117         actionList.add(ab.build());
 118
 119         final Uint32 bufferId = Uint32.valueOf(0xf);
 120
 121         final Uint32 valueForCookie = Uint32.valueOf(0xe);
 122         ConnectionCookie connCook = new ConnectionCookie(valueForCookie);
 123
 124         String nodeId = "node:1";
 125
 126         String portO = "0xfffffffd";
 127         NodeConnectorKey egrConKey = PacketOutConvertorTest.createNodeConnKey(nodeId, portO);
 128         NodeConnectorRef egressConfRef = new NodeConnectorRef(
 129                 createNodeConnRef(nodeId, egrConKey));
 130
 131         String inPort = "2";
 132         NodeConnectorKey ingrConKey = PacketOutConvertorTest.createNodeConnKey(nodeId, inPort);
 133         NodeConnectorRef ingressConRef = new NodeConnectorRef(
 134                 createNodeConnRef(nodeId, ingrConKey));
 135
 136         final TransmitPacketInput transmitPacketInput = new TransmitPacketInputBuilder()
 137             .setAction(BindingMap.of(ab.build()))
 138             .setBufferId(bufferId)
 139             .setConnectionCookie(connCook)
 140             .setEgress(egressConfRef)
 141             .setIngress(ingressConRef)
 142             .setNode(createNodeRef(nodeId))
 143             .setPayload("sendOutputMsg_TEST".getBytes())
 144             .build();
 145
 146         Uint8 version = OFConstants.OFP_VERSION_1_3;
 147         byte[] datapathIdByte = new byte[Long.BYTES];
 148         for (int i = 0; i < datapathIdByte.length; i++) {
 149             datapathIdByte[i] = 1;
 150         }
 151         Uint64 datapathId = Uint64.valueOf(new BigInteger(1, datapathIdByte));
 152         Uint32 xid = Uint32.valueOf(0xfffffL);
 153
 154         XidConvertorData data = new XidConvertorData(version);
 155         data.setXid(xid);
 156         data.setDatapathId(datapathId);
 157         PacketOutInput message = convert(transmitPacketInput, data);
 158
 159         Assert.assertEquals(transmitPacketInput.getBufferId(), message.getBufferId());
 160         Assert.assertEquals(Uint32.valueOf(inPort), message.getInPort().getValue());
 161         Assert.assertEquals(version, message.getVersion());
 162         Assert.assertEquals(xid, message.getXid());
 163
 164         ActionConvertorData actionConvertorData = new ActionConvertorData(version);
 165         actionConvertorData.setDatapathId(datapathId);
 166
 167         Optional<List<Action>> actionsOptional = convertorManager.convert(actionList, actionConvertorData);
 168
 169         List<Action> actions = actionsOptional.orElse(null);
 170         Assert.assertEquals(actions, message.getAction());
 171         Assert.assertArrayEquals(transmitPacketInput.getPayload(), message.getData());
 172     }
 173
 174     private static List<Action> buildActionForNullTransmitPacketInputAction(
 175             final NodeConnectorKey nodeConKey, final Uint8 version) {
 176
 177         PortNumber outPort = getPortNumber(nodeConKey, version);
 178
 179         org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice
 180             .OutputActionCaseBuilder outputActionCaseBuilder =
 181                 new org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping
 182                     .action.choice.OutputActionCaseBuilder();
 183
 184         org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice
 185             .output.action._case.OutputActionBuilder outputActionBuilder =
 186                 new org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping
 187                     .action.choice.output.action._case.OutputActionBuilder();
 188
 189         outputActionBuilder.setPort(outPort);
 190         outputActionBuilder.setMaxLength(Uint16.MAX_VALUE);
 191         outputActionCaseBuilder.setOutputAction(outputActionBuilder.build());
 192         ActionBuilder actionBuilder = new ActionBuilder();
 193         actionBuilder.setActionChoice(outputActionCaseBuilder.build());
 194
 195         List<Action> actions = new ArrayList<>();
 196         actions.add(actionBuilder.build());
 197         return actions;
 198     }
 199
 200     private static PortNumber getPortNumber(final NodeConnectorKey nodeConKey, final Uint8 ofVersion) {
 201         Uint32 port = InventoryDataServiceUtil.portNumberfromNodeConnectorId(OpenflowVersion.get(ofVersion),
 202                 nodeConKey.getId());
 203         return new PortNumber(port);
 204     }
 205
 206     private static NodeConnectorRef createNodeConnRef(final String nodeId, final NodeConnectorKey nodeConKey) {
 207         InstanceIdentifier<NodeConnector> path = InstanceIdentifier
 208                 .builder(Nodes.class)
 209                 .child(Node.class,
 210                         new NodeKey(new NodeId(nodeId)))
 211                 .child(NodeConnector.class,
 212                         nodeConKey).build();
 213
 214         return new NodeConnectorRef(path);
 215     }
 216
 217     private static NodeConnectorKey createNodeConnKey(final String nodeId, final String port) {
 218         StringBuilder builder = new StringBuilder(nodeId).append(':').append(port);
 219
 220         return new NodeConnectorKey(new NodeConnectorId(builder.toString()));
 221     }
 222
 223     private static NodeRef createNodeRef(final String nodeId) {
 224         NodeKey key = new NodeKey(new NodeId(nodeId));
 225         InstanceIdentifier<Node> path = InstanceIdentifier
 226                 .builder(Nodes.class)
 227                 .child(Node.class, key).build();
 228         return new NodeRef(path);
 229     }
 230
 231     private PacketOutInput convert(final TransmitPacketInput transmitPacketInput, final XidConvertorData data) {
 232         Optional<PacketOutInput> messageOptional = convertorManager.convert(transmitPacketInput, data);
 233         return messageOptional.orElse(PacketOutConvertor.defaultResult(data.getVersion()));
 234     }
 235 }