Merge pull request #323 from macartur/adding_multipart_pack_unpack

Adding multipart pack unpack

Author: beraldoleal

pyof/v0x04/controller2switch/multipart_reply.py

@@ -10,7 +10,9 @@
 from pyof.foundation.constants import DESC_STR_LEN, SERIAL_NUM_LEN
 from pyof.v0x04.common.flow_match import Match
 from pyof.v0x04.common.header import Header, Type
+from pyof.v0x04.common.port import Port
 from pyof.v0x04.controller2switch.common import (Bucket, BucketCounter,
+                                                 ExperimenterMultipartHeader,
                                                  MultipartTypes, TableFeatures)
 from pyof.v0x04.controller2switch.meter_mod import (ListOfMeterBandHeader,
                                                     MeterBandType, MeterFlags)
@@ -93,8 +95,15 @@ def pack(self, value=None):
         buff = self.body
         if not value:
             value = self.body
-        if value and hasattr(value, 'pack'):
-            self.body = BinaryData(value.pack())
+
+        if value:
+            if isinstance(value, (list, FixedTypeList)):
+                obj = self._get_body_instance()
+                obj.extend(value)
+            elif hasattr(value, 'pack'):
+                obj = value
+
+            self.body = obj.pack()
 
         multiparty_packed = super().pack()
         self.body = buff
@@ -127,19 +136,37 @@ def _unpack_body(self):
 
     def _get_body_instance(self):
         """Method used to return the body instance."""
-        pyof_class = self._get_body_class()
-        if pyof_class is None:
-            return BinaryData(b'')
-        else:
-            return FixedTypeList(pyof_class=pyof_class)
+        exp_header = ExperimenterMultipartHeader
+        simple_body = {MultipartTypes.OFPMP_DESC: Desc,
+                       MultipartTypes.OFPMP_GROUP_FEATURES: GroupFeatures,
+                       MultipartTypes.OFPMP_METER_FEATURES: MeterFeatures,
+                       MultipartTypes.OFPMP_EXPERIMENTER: exp_header}
+
+        array_of_bodies = {MultipartTypes.OFPMP_FLOW: FlowStats,
+                           MultipartTypes.OFPMP_AGGREGATE: AggregateStatsReply,
+                           MultipartTypes.OFPMP_TABLE: TableStats,
+                           MultipartTypes.OFPMP_PORT_STATS: PortStats,
+                           MultipartTypes.OFPMP_QUEUE: QueueStats,
+                           MultipartTypes.OFPMP_GROUP: GroupStats,
+                           MultipartTypes.OFPMP_GROUP_DESC: GroupDescStats,
+                           MultipartTypes.OFPMP_METER: MeterStats,
+                           MultipartTypes.OFPMP_METER_CONFIG: MeterConfig,
+                           MultipartTypes.OFPMP_TABLE_FEATURES: TableFeatures,
+                           MultipartTypes.OFPMP_PORT_DESC: Port}
 
-    def _get_body_class(self):
-        """Method used to return the body class using the multipart_type."""
         if isinstance(self.multipart_type, (int, UBInt16)):
             self.multipart_type = self.multipart_type.enum_ref(
                 self.multipart_type.value)
-        if self.multipart_type.value == 12:
-            return TableFeatures
+
+        pyof_class = simple_body.get(self.multipart_type, None)
+        if pyof_class:
+            return pyof_class()
+
+        array_of_class = array_of_bodies.get(self.multipart_type, None)
+        if array_of_class:
+            return FixedTypeList(pyof_class=pyof_class)
+
+        return BinaryData(b'')
 
 
 # MultipartReply Body

pyof/v0x04/controller2switch/multipart_request.py

@@ -5,18 +5,20 @@
 
 # Local source tree imports
 from pyof.foundation.base import GenericMessage, GenericStruct
-from pyof.foundation.basic_types import (BinaryData, Pad,
+from pyof.foundation.basic_types import (BinaryData, FixedTypeList, Pad,
                                          UBInt8, UBInt16, UBInt32, UBInt64)
 from pyof.v0x04.common.flow_match import Match
 from pyof.v0x04.common.header import Header, Type
-from pyof.v0x04.controller2switch.common import MultipartTypes
+from pyof.v0x04.controller2switch.common import (ExperimenterMultipartHeader,
+                                                 MultipartTypes, TableFeatures)
 
 # Third-party imports
 
-
 __all__ = ('MultipartRequest', 'MultipartRequestFlags',
-           'AggregateStatsRequest', 'FlowStatsRequest', 'PortStatsRequest',
-           'QueueStatsRequest', 'GroupStatsRequest', 'MeterMultipartRequest')
+           'AggregateStatsRequest', 'FlowStatsRequest',
+           'PortStatsRequest', 'QueueStatsRequest',
+           'GroupStatsRequest', 'MeterMultipartRequest',
+           'TableFeatures')
 
 # Enum
 
@@ -63,8 +65,87 @@ def __init__(self, xid=None, multipart_type=None, flags=None, body=b''):
         self.flags = flags
         self.body = body
 
+    def pack(self, value=None):
+        """Pack a MultipartRequest using the object's attributes.
+
+        This method will pack the attribute body and multipart_type before pack
+        the MultipartRequest object, then will return this struct as a
+         binary data.
+
+        Returns:
+            multiparty_packed (bytes): Binary data with MultipartRequest
+                                       packed.
+        """
+        buff = self.body
+        if not value:
+            value = self.body
+
+        if value:
+            if isinstance(value, (list, FixedTypeList)):
+                obj = self._get_body_instance()
+                obj.extend(value)
+            elif hasattr(value, 'pack'):
+                obj = value
+
+            self.body = obj.pack()
+
+        multiparty_packed = super().pack()
+        self.body = buff
+
+        return multiparty_packed
+
+    def unpack(self, buff, offset=0):
+        """Unpack a binary message into this object's attributes.
+
+        Unpack the binary value *buff* and update this object attributes based
+        on the results. It is an inplace method and it receives the binary data
+        of the message **without the header**.
+
+        This class' unpack method is like the :meth:`.GenericMessage.unpack`
+        one, except for the ``body`` attribute which has its type determined
+        by the ``multipart_type`` attribute.
+
+        Args:
+            buff (bytes): Binary data package to be unpacked, without the
+                header.
+        """
+        super().unpack(buff[offset:])
+        self._unpack_body()
+
+    def _unpack_body(self):
+        """Unpack `body` replace it by the result."""
+        obj = self._get_body_instance()
+        obj.unpack(self.body.value)
+        self.body = obj
+
+    def _get_body_instance(self):
+        """Method used to return the body instance."""
+        simple_body = {
+            MultipartTypes.OFPMP_FLOW: FlowStatsRequest,
+            MultipartTypes.OFPMP_AGGREGATE: AggregateStatsRequest,
+            MultipartTypes.OFPMP_PORT_STATS: PortStatsRequest,
+            MultipartTypes.OFPMP_QUEUE: QueueStatsRequest,
+            MultipartTypes.OFPMP_GROUP: GroupStatsRequest,
+            MultipartTypes.OFPMP_METER: MeterMultipartRequest,
+            MultipartTypes.OFPMP_EXPERIMENTER: ExperimenterMultipartHeader
+        }
+
+        array_of_bodies = {MultipartTypes.OFPMP_TABLE_FEATURES: TableFeatures}
+
+        if isinstance(self.multipart_type, (int, UBInt16)):
+            self.multipart_type = self.multipart_type.enum_ref(
+                self.multipart_type.value)
+
+        pyof_class = simple_body.get(self.multipart_type, None)
+        if pyof_class:
+            return pyof_class()
+
+        array_of_class = array_of_bodies.get(self.multipart_type, None)
+        if array_of_class:
+            return FixedTypeList(pyof_class=array_of_class)
+
+        return BinaryData(b'')
 
-# MultipartRequest body
 
 class AggregateStatsRequest(GenericStruct):
     """Body for ofp_stats_request of type OFPST_AGGREGATE."""

setup.cfg

@@ -10,3 +10,6 @@ ignore = D105,D203,D213,I0011
 #        Conflicts with D211: No blank lines allowed before class docstring
 # D213: Should be ignored by default, but sometimes it is not
 # I0011: I0011 Locally disabling no-member (E1101) [pylint]
+
+[isort]
+known_first_party = pyof

tests/v0x04/test_common/test_table_feature.py

@@ -1,14 +1,13 @@
 """MultipartReply message test."""
 
 from pyof.v0x04.controller2switch.common import MultipartTypes
-from pyof.v0x04.controller2switch.multipart_reply import (MultipartReply,
+from pyof.v0x04.controller2switch.multipart_reply import (Desc, MultipartReply,
                                                           MultipartReplyFlags)
-
 from tests.v0x04.test_struct import TestStruct
 
 
-class TestTableFeatures(TestStruct):
-    """Test TableFeatures."""
+class TestMultipartReply(TestStruct):
+    """Test MultipartReply."""
 
     @classmethod
     def setUpClass(cls):
@@ -17,5 +16,24 @@ def setUpClass(cls):
         super().set_message(MultipartReply, xid=16,
                             multipart_type=MultipartTypes.OFPMP_METER_CONFIG,
                             flags=MultipartReplyFlags.OFPMPF_REPLY_MORE,
-                            body=b'this is a test')
+                            body='')
         super().set_minimum_size(16)
+
+    @staticmethod
+    def get_attributes(multipart_type=MultipartTypes.OFPMP_DESC,
+                       flags=MultipartReplyFlags.OFPMPF_REPLY_MORE,
+                       body=''):
+        """Method used to return a dict with instance paramenters."""
+        return {'xid': 32, 'multipart_type': multipart_type, 'flags': flags,
+                'body': body}
+
+    def test_pack_unpack_desc(self):
+        """Testing multipart_type with OFPMP_DESC."""
+        instances = Desc(mfr_desc="MANUFACTURER DESCRIPTION",
+                         hw_desc="HARDWARE DESCRIPTION",
+                         sw_desc="SOFTWARE DESCRIPTION",
+                         serial_num="SERIAL NUMBER",
+                         dp_desc="DATAPATH DESCRIPTION")
+        options = TestMultipartReply.get_attributes(
+            multipart_type=MultipartTypes.OFPMP_DESC, body=instances)
+        self._test_pack_unpack(**options)