Merge pull request #447 from macartur/issue-#87

Add arbitrary additional data into vendor header

Author: beraldoleal

pyof/v0x01/symmetric/vendor_header.py

@@ -5,7 +5,7 @@
 # Third-party imports
 
 from pyof.foundation.base import GenericMessage
-from pyof.foundation.basic_types import UBInt32
+from pyof.foundation.basic_types import BinaryData, UBInt32
 from pyof.v0x01.common.header import Header, Type
 
 __all__ = ('VendorHeader',)
@@ -21,15 +21,18 @@ class VendorHeader(GenericMessage):
 
     header = Header(message_type=Type.OFPT_VENDOR)
     vendor = UBInt32()
+    data = BinaryData()
 
-    def __init__(self, xid=None, vendor=None):
+    def __init__(self, xid=None, vendor=None, data=None):
         """Create a VendorHeader with the options parameters below.
 
         Args:
             xid (int): xid to be used on the message header.
             vendor (int): Vendor ID:
                 MSB 0: low-order bytes are IEEE OUI.
                 MSB != 0: defined by OpenFlow consortium.
+            data (BinaryData): Vendor-defined arbitrary additional data.
         """
         super().__init__(xid)
         self.vendor = vendor
+        self.data = data

tests/v0x01/test_symmetric/test_vendor_header.py

@@ -6,10 +6,10 @@
 class TestVendorHeader(TestStruct):
     """Vendor message tests (also those in :class:`.TestDump`)."""
 
-    @classmethod
-    def setUpClass(cls):
-        """Configure raw file and its object in parent class (TestDump)."""
-        super().setUpClass()
-        super().set_raw_dump_file('v0x01', 'ofpt_vendor_header')
-        super().set_raw_dump_object(VendorHeader, xid=4, vendor=128)
-        super().set_minimum_size(12)
+    def test_unpack(self):
+        """Test unpack VendorHeader message."""
+        message = b'My custom vendor extra data.'
+        vendor_header = VendorHeader(xid=4, vendor=128,
+                                     data=message)
+        data = b'\x01\x04\x00(\x00\x00\x00\x04\x00\x00\x00\x80' + message
+        self._test_unpack(vendor_header, bytes2unpack=data)