Merge branch 'master' into binarydata

Author: cemsbr

CHANGELOG.rst

@@ -21,6 +21,7 @@ Removed
 
 Fixed
 =====
+- [v0x01] Fixed method to unpack error messages.
 
 Security
 ========

pyof/v0x01/asynchronous/error_msg.py

@@ -7,7 +7,6 @@
 from pyof.foundation.basic_types import BinaryData, UBInt16
 from pyof.foundation.exceptions import PackException
 # Do not import new_message_from_header directly to avoid cyclic import.
-from pyof.v0x01 import common
 from pyof.v0x01.common.header import Header, Type
 
 __all__ = ('ErrorMsg', 'ErrorType', 'BadActionCode', 'BadRequestCode',
@@ -37,6 +36,20 @@ class ErrorType(IntEnum):
     #: Problem in modifying Queue entry
     OFPET_QUEUE_OP_FAILED = 5
 
+    def get_class(self):
+        """Method used to return a Code class based on current ErrorType value.
+
+        Returns:
+            error_code_class (IntEnum): class referenced by current error type.
+        """
+        classes = {'OFPET_HELLO_FAILED': HelloFailedCode,
+                   'OFPET_BAD_REQUEST': BadRequestCode,
+                   'OFPET_BAD_ACTION': BadActionCode,
+                   'OFPET_FLOW_MOD_FAILED': FlowModFailedCode,
+                   'OFPET_PORT_MOD_FAILED': PortModFailedCode,
+                   'OFPET_QUEUE_OP_FAILED': QueueOpFailedCode}
+        return classes[self.name]
+
 
 class HelloFailedCode(IntEnum):
     """Error_msg 'code' values for OFPET_HELLO_FAILED.
@@ -206,20 +219,5 @@ def pack(self, value=None):
     def unpack(self, buff, offset=0):
         """Unpack binary data into python object."""
         super().unpack(buff, offset)
-        self.data = self._unpack_data()
-
-    def _unpack_data(self):
-        if self.data == b'':
-            return BinaryData()
-        # header unpacking
-        header = Header()
-        header_size = header.get_size()
-        header_data = self.data.value[:header_size]
-        header.unpack(header_data)
-
-        # message unpacking
-        msg = common.utils.new_message_from_header(header)
-        msg_data = self.data.value[header_size:]
-        msg.unpack(msg_data)
-
-        return msg
+        CodeClass = ErrorType(self.error_type).get_class()
+        self.code = CodeClass(self.code)

tests/v0x01/test_asynchronous/test_error_msg.py

@@ -1,7 +1,6 @@
 """Testing Error Message."""
-from pyof.foundation.basic_types import BinaryData
 from pyof.v0x01.asynchronous.error_msg import (
-    BadRequestCode, ErrorMsg, ErrorType)
+    BadRequestCode, ErrorMsg, ErrorType, FlowModFailedCode)
 from tests.test_struct import TestStruct
 
 
@@ -12,9 +11,23 @@ class TestErrorMessage(TestStruct):
     def setUpClass(cls):
         """Setup TestStruct."""
         super().setUpClass()
-        super().set_raw_dump_file('v0x01', 'ofpt_error_message')
+        super().set_raw_dump_file('v0x01', 'ofpt_error_msg')
         super().set_raw_dump_object(ErrorMsg, xid=12,
                                     error_type=ErrorType.OFPET_BAD_REQUEST,
                                     code=BadRequestCode.OFPBRC_BAD_STAT,
-                                    data=BinaryData(b'object_test'))
+                                    data=b'')
         super().set_minimum_size(12)
+
+    def test_unpack_error_msg(self):
+        """Test Unpack a sample ErrorMsg."""
+        expected = b'\x01\x01\x00\x1b\x00\x00\x00\x18\x00\x03\x00\x02FLOW'
+
+        error_msg = ErrorMsg(xid=24,
+                             error_type=ErrorType.OFPET_FLOW_MOD_FAILED,
+                             code=FlowModFailedCode.OFPFMFC_EPERM,
+                             data=b'FLOW')
+
+        actual = ErrorMsg(xid=24)
+        actual.unpack(expected[8:])
+
+        self.assertEqual(actual, error_msg)