From 400b39c68e3e988403f65b5c16e18403b6d445ef Mon Sep 17 00:00:00 2001
From: Timotej Kubas <tkubas@cisco.com>
Date: Wed, 1 Apr 2015 19:05:59 +0200
Subject: [PATCH] Handling async replies from device in DeviceCtx

- introduced simple test for PacketReceivedTranslator
- fixed asterix in inports

Change-Id: I172d7b2db82a552140e5fd3822d080df9cbb97f9
Signed-off-by: Timotej Kubas <tkubas@cisco.com>
---
 .../impl/device/DeviceContextImpl.java        | 15 +++++++--
 .../translator/PacketReceivedTranslator.java  | 25 ++++++++++-----
 .../translator/PortUpdateTranslator.java      |  5 +--
 .../PacketReceivedTranslatorTest.java         | 32 ++++++++++++++++---
 4 files changed, 61 insertions(+), 16 deletions(-)

diff --git a/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java b/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java
index 2203b65b31..78d772c36d 100644
--- a/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java
+++ b/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/DeviceContextImpl.java
@@ -23,7 +23,14 @@ import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.*;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceReplyProcessor;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
+import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
+import org.opendaylight.openflowplugin.api.openflow.device.RequestContext;
+import org.opendaylight.openflowplugin.api.openflow.device.TranslatorLibrary;
+import org.opendaylight.openflowplugin.api.openflow.device.Xid;
+import org.opendaylight.openflowplugin.api.openflow.device.XidGenerator;
 import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
 import org.opendaylight.openflowplugin.api.openflow.md.core.TranslatorKey;
@@ -32,8 +39,12 @@ import org.opendaylight.openflowplugin.impl.device.translator.PacketReceivedTran
 import org.opendaylight.openflowplugin.impl.device.translator.PortUpdateTranslator;
 import org.opendaylight.openflowplugin.openflow.md.core.session.SwitchConnectionCookieOFImpl;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNodeConnector;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.*;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.Error;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemoved;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
 import org.opendaylight.yangtools.yang.binding.ChildOf;
diff --git a/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslator.java b/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslator.java
index 4e26486ab9..ac506d54f7 100644
--- a/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslator.java
+++ b/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslator.java
@@ -7,6 +7,7 @@
  */
 package org.opendaylight.openflowplugin.impl.device.translator;
 
+import org.opendaylight.openflowplugin.api.OFConstants;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
@@ -41,9 +42,9 @@ public class PacketReceivedTranslator implements MessageTranslator<PacketInMessa
 
         // extract the port number
         Long port = null;
-        if(input.getVersion() == OpenflowVersion.OF10.getVersion()) {
+        if(input.getVersion() == OFConstants.OFP_VERSION_1_0 && input.getInPort() != null) {
             port = input.getInPort().longValue();
-        } else if (input.getVersion() == OpenflowVersion.OF13.getVersion()) {
+        } else if (input.getVersion() == OFConstants.OFP_VERSION_1_3) {
             if (input.getMatch() != null && input.getMatch().getMatchEntry() != null) {
                 port = getPortNumberFromMatch(input.getMatch().getMatchEntry());
             }
@@ -52,15 +53,23 @@ public class PacketReceivedTranslator implements MessageTranslator<PacketInMessa
         //TODO connection cookie from connection distinguisher
 //        packetReceivedBuilder.setConnectionCookie(new ConnectionCookie(input.getCookie().longValue()));
         packetReceivedBuilder.setPayload(input.getData());
-        packetReceivedBuilder.setFlowCookie(new FlowCookie(input.getCookie()));
-        packetReceivedBuilder.setIngress(InventoryDataServiceUtil.nodeConnectorRefFromDatapathIdPortno(datapathId, port, OpenflowVersion.get(input.getVersion())));
-
+        // get the Cookie if it exists
+        if (input.getCookie() != null) {
+            packetReceivedBuilder.setFlowCookie(new FlowCookie(input.getCookie()));
+        }
+        if(port != null) {
+            packetReceivedBuilder.setIngress(InventoryDataServiceUtil.nodeConnectorRefFromDatapathIdPortno(datapathId, port, OpenflowVersion.get(input.getVersion())));
+        }
         packetReceivedBuilder.setPacketInReason(PacketInUtil.getMdSalPacketInReason(input.getReason()));
-        packetReceivedBuilder.setTableId(new org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId(input.getTableId().getValue().shortValue()));
 
+        if(input.getTableId() != null) {
+            packetReceivedBuilder.setTableId(new org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableId(input.getTableId().getValue().shortValue()));
+        }
 
-        org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match packetInMatch = getPacketInMatch(input, datapathId);
-        packetReceivedBuilder.setMatch(packetInMatch);
+        if(input.getMatch() != null) {
+            org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match packetInMatch = getPacketInMatch(input, datapathId);
+            packetReceivedBuilder.setMatch(packetInMatch);
+        }
 
         return packetReceivedBuilder.build();
     }
diff --git a/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PortUpdateTranslator.java b/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PortUpdateTranslator.java
index b694359cc6..ccb2b56968 100644
--- a/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PortUpdateTranslator.java
+++ b/openflowplugin-impl/src/main/java/org/opendaylight/openflowplugin/impl/device/translator/PortUpdateTranslator.java
@@ -7,6 +7,7 @@
  */
 package org.opendaylight.openflowplugin.impl.device.translator;
 
+import org.opendaylight.openflowplugin.api.OFConstants;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
 import org.opendaylight.openflowplugin.api.openflow.device.MessageTranslator;
 import org.opendaylight.openflowplugin.api.openflow.md.util.OpenflowVersion;
@@ -28,14 +29,14 @@ public class PortUpdateTranslator implements MessageTranslator<PortStatusMessage
         // TODO Auto-generated method stub
         FlowCapableNodeConnectorBuilder builder = new FlowCapableNodeConnectorBuilder();
         //OF1.0
-        if(input.getVersion() == OpenflowVersion.OF10.getVersion()) {
+        if(input.getVersion() == OFConstants.OFP_VERSION_1_0) {
             builder.setAdvertisedFeatures(PortTranslatorUtil.translatePortFeatures(input.getAdvertisedFeaturesV10()));
             builder.setConfiguration(PortTranslatorUtil.translatePortConfig(input.getConfigV10()));
             builder.setCurrentFeature(PortTranslatorUtil.translatePortFeatures(input.getCurrentFeaturesV10()));
             builder.setPeerFeatures(PortTranslatorUtil.translatePortFeatures(input.getPeerFeaturesV10()));
             builder.setState(PortTranslatorUtil.translatePortState(input.getStateV10()));
             builder.setSupported(PortTranslatorUtil.translatePortFeatures(input.getSupportedFeaturesV10()));
-        } else if (input.getVersion() == OpenflowVersion.OF13.getVersion()) {
+        } else if (input.getVersion() == OFConstants.OFP_VERSION_1_3) {
             builder.setAdvertisedFeatures(PortTranslatorUtil.translatePortFeatures(input.getAdvertisedFeatures()));
             builder.setConfiguration(PortTranslatorUtil.translatePortConfig(input.getConfig()));
             builder.setCurrentFeature(PortTranslatorUtil.translatePortFeatures(input.getCurrentFeatures()));
diff --git a/openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslatorTest.java b/openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslatorTest.java
index 9fe9891d6b..4239696b0a 100644
--- a/openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslatorTest.java
+++ b/openflowplugin-impl/src/test/java/org/opendaylight/openflowplugin/impl/device/translator/PacketReceivedTranslatorTest.java
@@ -1,16 +1,25 @@
 package org.opendaylight.openflowplugin.impl.device.translator;
 
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
+import org.mockito.Mockito;
 import org.mockito.runners.MockitoJUnitRunner;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
+import org.opendaylight.openflowplugin.api.OFConstants;
+import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
+import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
 import org.opendaylight.openflowplugin.impl.device.DeviceContextImpl;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PacketInReason;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessageBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
+import java.math.BigInteger;
 
 /**
  * Created by tkubas on 4/1/15.
@@ -19,26 +28,41 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 @RunWith(MockitoJUnitRunner.class)
 public class PacketReceivedTranslatorTest {
 
+    @Mock
+    ConnectionContext connectionContext;
+    @Mock
+    FeaturesReply featuresReply;
+    @Mock
+    DeviceState deviceState;
+    @Mock
+    DataBroker dataBroker;
     @Mock
     DeviceContext deviceContext;
+    String data = "Test_Data";
 
     @Before
     public void setUp() throws Exception {
-
+        Mockito.when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
+        Mockito.when(connectionContext.getFeatures()).thenReturn(featuresReply);
+        Mockito.when(featuresReply.getDatapathId()).thenReturn(BigInteger.TEN);
     }
 
     @Test
     public void testTranslate() throws Exception {
         PacketReceivedTranslator packetReceivedTranslator = new PacketReceivedTranslator();
-//        packetReceivedTranslator.translate()
+        PacketInMessage packetInMessage = createPacketInMessage(data.getBytes(), 5);
+        PacketReceived packetReceived = packetReceivedTranslator.translate(packetInMessage, deviceContext, null);
+        Assert.assertArrayEquals(packetInMessage.getData(), packetReceived.getPayload());
+        Assert.assertEquals("org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.SendToController",
+                             packetReceived.getPacketInReason().getName());
     }
 
     private static PacketInMessage createPacketInMessage(final byte[] data,
                                                          final java.lang.Integer port) {
         PacketInReason reason = PacketInReason.OFPRACTION;
         return new PacketInMessageBuilder()
-                .setVersion((short) EncodeConstants.OF10_VERSION_ID)
-                .setInPort(port).setData(data).setReason(reason).build();
+                .setVersion((short) OFConstants.OFP_VERSION_1_0)
+                .setData(data).setReason(reason).build();
 
     }
 }
\ No newline at end of file
-- 
2.36.6