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