openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/translator/PacketReceivedTranslatorTest.java

   1 /*
   2  * Copyright (c) 2015 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.impl.translator;
   9
  10 import com.google.common.collect.Lists;
  11 import java.math.BigInteger;
  12 import java.util.Collections;
  13 import java.util.List;
  14 import org.junit.Assert;
  15 import org.junit.Before;
  16 import org.junit.Test;
  17 import org.junit.runner.RunWith;
  18 import org.mockito.Mock;
  19 import org.mockito.Mockito;
  20 import org.mockito.junit.MockitoJUnitRunner;
  21 import org.opendaylight.mdsal.binding.api.DataBroker;
  22 import org.opendaylight.openflowplugin.api.OFConstants;
  23 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  24 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
  25 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
  26 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
  27 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
  28 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PacketInReason;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableId;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.InPort;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OpenflowBasicClass;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.InPortCaseBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.in.port._case.InPortBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.MatchBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessageBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.features.reply.PhyPort;
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match;
  51 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  52
  53 @RunWith(MockitoJUnitRunner.class)
  54 public class PacketReceivedTranslatorTest {
  55
  56     @Mock
  57     ConnectionContext connectionContext;
  58     @Mock
  59     FeaturesReply featuresReply;
  60     @Mock
  61     GetFeaturesOutput getFeaturesOutput;
  62     @Mock
  63     DeviceState deviceState;
  64     @Mock
  65     DataBroker dataBroker;
  66     @Mock
  67     DeviceContext deviceContext;
  68     @Mock
  69     DeviceInfo deviceInfo;
  70     @Mock
  71     PhyPort phyPort;
  72
  73     ConvertorManager convertorManager;
  74
  75     static final Long PORT_NO = 5L;
  76     static final Long PORT_NO_DS = 6L;
  77     static final String DATA = "Test_Data";
  78     static final Long PORT_NUM_VALUE = 11L;
  79
  80     @Before
  81     public void setUp() throws Exception {
  82         final List<PhyPort> phyPorts = Collections.singletonList(phyPort);
  83         convertorManager = ConvertorManagerFactory.createDefaultManager();
  84
  85         Mockito.when(deviceInfo.getDatapathId()).thenReturn(BigInteger.TEN);
  86     }
  87
  88     @Test
  89     public void testTranslate() throws Exception {
  90         final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
  91                 .create(Nodes.class)
  92                 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
  93         final PacketReceivedTranslator packetReceivedTranslator = new PacketReceivedTranslator(convertorManager);
  94         final PacketInMessage packetInMessage = createPacketInMessage(DATA.getBytes(), PORT_NO);
  95
  96         final PacketReceived packetReceived = packetReceivedTranslator.translate(packetInMessage, deviceInfo, null);
  97
  98         Assert.assertArrayEquals(packetInMessage.getData(), packetReceived.getPayload());
  99         Assert.assertEquals("org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.SendToController",
 100                 packetReceived.getPacketInReason().getName());
 101         Assert.assertEquals("openflow:10:" + PORT_NO,
 102                 packetReceived.getIngress().getValue().firstKeyOf(NodeConnector.class).getId().getValue());
 103         Assert.assertEquals(0L, packetReceived.getFlowCookie().getValue().longValue());
 104         Assert.assertEquals(42L, packetReceived.getTableId().getValue().longValue());
 105     }
 106
 107     private static PacketInMessage createPacketInMessage(final byte[] data,
 108                                                          final long port) {
 109         final PacketInReason reason = PacketInReason.OFPRACTION;
 110
 111         MatchEntryBuilder matchEntryBuilder = assembleMatchEntryBld(port);
 112         MatchBuilder packetInMatchBld = new MatchBuilder()
 113                 .setMatchEntry(Lists.newArrayList(matchEntryBuilder.build()));
 114
 115         return new PacketInMessageBuilder()
 116                 .setVersion(OFConstants.OFP_VERSION_1_0)
 117                 .setData(data).setReason(reason)
 118                 .setMatch(packetInMatchBld.build())
 119                 .setVersion(OFConstants.OFP_VERSION_1_3)
 120                 .setCookie(BigInteger.ZERO)
 121                 .setTableId(new TableId(42L))
 122                 .build();
 123
 124     }
 125
 126     @Test
 127     public void testGetPacketInMatch() throws Exception {
 128         MatchEntryBuilder matchEntryBuilder = assembleMatchEntryBld(PORT_NUM_VALUE);
 129         MatchBuilder packetInMatchBld = new MatchBuilder()
 130                 .setMatchEntry(Lists.newArrayList(matchEntryBuilder.build()));
 131         PacketInMessageBuilder inputBld = new PacketInMessageBuilder()
 132                 .setMatch(packetInMatchBld.build())
 133                 .setVersion(OFConstants.OFP_VERSION_1_3);
 134         BigInteger dpid = BigInteger.TEN;
 135
 136         final PacketReceivedTranslator packetReceivedTranslator = new PacketReceivedTranslator(convertorManager);
 137         final Match packetInMatch = packetReceivedTranslator.getPacketInMatch(inputBld.build(), dpid);
 138
 139         Assert.assertNotNull(packetInMatch.getInPort());
 140         Assert.assertEquals("openflow:10:" + PORT_NUM_VALUE, packetInMatch.getInPort().getValue());
 141     }
 142
 143     private static MatchEntryBuilder assembleMatchEntryBld(long portNumValue) {
 144         MatchEntryBuilder matchEntryBuilder = prepareHeader(InPort.class, false);
 145         InPortBuilder inPortBld = new InPortBuilder().setPortNumber(new PortNumber(portNumValue));
 146         InPortCaseBuilder caseBuilder = new InPortCaseBuilder();
 147         caseBuilder.setInPort(inPortBld.build());
 148         matchEntryBuilder.setMatchEntryValue(caseBuilder.build());
 149         return matchEntryBuilder;
 150     }
 151
 152     private static MatchEntryBuilder prepareHeader(Class<? extends MatchField> oxmMatchField, boolean hasMask) {
 153         MatchEntryBuilder builder = new MatchEntryBuilder();
 154         builder.setOxmClass(OpenflowBasicClass.class);
 155         builder.setOxmMatchField(oxmMatchField);
 156         builder.setHasMask(hasMask);
 157         return builder;
 158     }
 159 }