test_bpdu: add unit test

Signed-off-by: WATANABE Fumitaka <watanabe.fumitaka1@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

ryu/tests/unit/packet/test_bpdu.py

@@ -17,6 +17,7 @@
 
 import unittest
 import logging
+import struct
 
 from nose.tools import eq_
 from ryu.lib.packet import bpdu
@@ -26,7 +27,140 @@ LOG = logging.getLogger(__name__)
 
 
 class Test_ConfigurationBPDUs(unittest.TestCase):
-    msg = bpdu.ConfigurationBPDUs()
+    """ Test case for ConfigurationBPDUs
+    """
+
+    def setUp(self):
+        self.protocol_id = bpdu.PROTOCOL_IDENTIFIER
+        self.version_id = bpdu.ConfigurationBPDUs.VERSION_ID
+        self.bpdu_type = bpdu.ConfigurationBPDUs.BPDU_TYPE
+        self.flags = 0b00000001
+        self.root_priority = 4096
+        self.root_system_id_extension = 1
+        self.root_mac_address = '12:34:56:78:9a:bc'
+        self.root_path_cost = 2
+        self.bridge_priority = 8192
+        self.bridge_system_id_extension = 3
+        self.bridge_mac_address = 'aa:aa:aa:aa:aa:aa'
+        self.port_priority = 16
+        self.port_number = 4
+        self.message_age = 5
+        self.max_age = 6
+        self.hello_time = 7
+        self.forward_delay = 8
+
+        self.msg = bpdu.ConfigurationBPDUs(
+            flags=self.flags,
+            root_priority=self.root_priority,
+            root_system_id_extension=self.root_system_id_extension,
+            root_mac_address=self.root_mac_address,
+            root_path_cost=self.root_path_cost,
+            bridge_priority=self.bridge_priority,
+            bridge_system_id_extension=self.bridge_system_id_extension,
+            bridge_mac_address=self.bridge_mac_address,
+            port_priority=self.port_priority,
+            port_number=self.port_number,
+            message_age=self.message_age,
+            max_age=self.max_age,
+            hello_time=self.hello_time,
+            forward_delay=self.forward_delay)
+
+        self.fmt = (bpdu.bpdu._PACK_STR
+                    + bpdu.ConfigurationBPDUs._PACK_STR[1:])
+        self.buf = struct.pack(self.fmt,
+                               self.protocol_id, self.version_id,
+                               self.bpdu_type, self.flags,
+                               bpdu.ConfigurationBPDUs.encode_bridge_id(
+                                   self.root_priority,
+                                   self.root_system_id_extension,
+                                   self.root_mac_address),
+                               self.root_path_cost,
+                               bpdu.ConfigurationBPDUs.encode_bridge_id(
+                                   self.bridge_priority,
+                                   self.bridge_system_id_extension,
+                                   self.bridge_mac_address),
+                               bpdu.ConfigurationBPDUs.encode_port_id(
+                                   self.port_priority,
+                                   self.port_number),
+                               bpdu.ConfigurationBPDUs._encode_timer(
+                                   self.message_age),
+                               bpdu.ConfigurationBPDUs._encode_timer(
+                                   self.max_age),
+                               bpdu.ConfigurationBPDUs._encode_timer(
+                                   self.hello_time),
+                               bpdu.ConfigurationBPDUs._encode_timer(
+                                   self.forward_delay))
+
+    def test_init(self):
+        eq_(self.protocol_id, self.msg._protocol_id)
+        eq_(self.version_id, self.msg._version_id)
+        eq_(self.bpdu_type, self.msg._bpdu_type)
+        eq_(self.flags, self.msg.flags)
+        eq_(self.root_priority, self.msg.root_priority)
+        eq_(self.root_system_id_extension,
+            self.msg.root_system_id_extension)
+        eq_(self.root_mac_address, self.msg.root_mac_address)
+        eq_(self.root_path_cost, self.msg.root_path_cost)
+        eq_(self.bridge_priority, self.msg.bridge_priority)
+        eq_(self.bridge_system_id_extension,
+            self.msg.bridge_system_id_extension)
+        eq_(self.bridge_mac_address, self.msg.bridge_mac_address)
+        eq_(self.port_priority, self.msg.port_priority)
+        eq_(self.port_number, self.msg.port_number)
+        eq_(self.message_age, self.msg.message_age)
+        eq_(self.max_age, self.msg.max_age)
+        eq_(self.hello_time, self.msg.hello_time)
+        eq_(self.forward_delay, self.msg.forward_delay)
+
+    def test_parser(self):
+        r1, r2, _ = bpdu.bpdu.parser(self.buf)
+
+        eq_(type(r1), type(self.msg))
+        eq_(r1._protocol_id, self.protocol_id)
+        eq_(r1._version_id, self.version_id)
+        eq_(r1._bpdu_type, self.bpdu_type)
+        eq_(r1.flags, self.flags)
+        eq_(r1.root_priority, self.root_priority)
+        eq_(r1.root_system_id_extension, self.root_system_id_extension)
+        eq_(r1.root_mac_address, self.root_mac_address)
+        eq_(r1.root_path_cost, self.root_path_cost)
+        eq_(r1.bridge_priority, self.bridge_priority)
+        eq_(r1.bridge_system_id_extension, self.bridge_system_id_extension)
+        eq_(r1.bridge_mac_address, self.bridge_mac_address)
+        eq_(r1.port_priority, self.port_priority)
+        eq_(r1.port_number, self.port_number)
+        eq_(r1.message_age, self.message_age)
+        eq_(r1.max_age, self.max_age)
+        eq_(r1.hello_time, self.hello_time)
+        eq_(r1.forward_delay, self.forward_delay)
+        eq_(r2, None)
+
+    def test_serialize(self):
+        data = bytearray()
+        prev = None
+        buf = self.msg.serialize(data, prev)
+        res = struct.unpack(self.fmt, buf)
+
+        eq_(res[0], self.protocol_id)
+        eq_(res[1], self.version_id)
+        eq_(res[2], self.bpdu_type)
+        eq_(res[3], self.flags)
+        eq_(bpdu.ConfigurationBPDUs._decode_bridge_id(res[4]),
+            (self.root_priority,
+             self.root_system_id_extension,
+             self.root_mac_address))
+        eq_(res[5], self.root_path_cost)
+        eq_(bpdu.ConfigurationBPDUs._decode_bridge_id(res[6]),
+            (self.bridge_priority,
+             self.bridge_system_id_extension,
+             self.bridge_mac_address))
+        eq_(bpdu.ConfigurationBPDUs._decode_port_id(res[7]),
+            (self.port_priority,
+             self.port_number))
+        eq_(bpdu.ConfigurationBPDUs._decode_timer(res[8]), self.message_age)
+        eq_(bpdu.ConfigurationBPDUs._decode_timer(res[9]), self.max_age)
+        eq_(bpdu.ConfigurationBPDUs._decode_timer(res[10]), self.hello_time)
+        eq_(bpdu.ConfigurationBPDUs._decode_timer(res[11]), self.forward_delay)
 
     def test_json(self):
         jsondict = self.msg.to_jsondict()
@@ -36,7 +170,45 @@ class Test_ConfigurationBPDUs(unittest.TestCase):
 
 
 class Test_TopologyChangeNotificationBPDUs(unittest.TestCase):
-    msg = bpdu.TopologyChangeNotificationBPDUs()
+    """ Test case for TopologyChangeNotificationBPDUs
+    """
+
+    def setUp(self):
+        self.protocol_id = bpdu.PROTOCOL_IDENTIFIER
+        self.version_id = bpdu.TopologyChangeNotificationBPDUs.VERSION_ID
+        self.bpdu_type = bpdu.TopologyChangeNotificationBPDUs.BPDU_TYPE
+
+        self.msg = bpdu.TopologyChangeNotificationBPDUs()
+
+        self.fmt = bpdu.bpdu._PACK_STR
+        self.buf = struct.pack(self.fmt,
+                               self.protocol_id,
+                               self.version_id,
+                               self.bpdu_type)
+
+    def test_init(self):
+        eq_(self.protocol_id, self.msg._protocol_id)
+        eq_(self.version_id, self.msg._version_id)
+        eq_(self.bpdu_type, self.msg._bpdu_type)
+
+    def test_parser(self):
+        r1, r2, _ = bpdu.bpdu.parser(self.buf)
+
+        eq_(type(r1), type(self.msg))
+        eq_(r1._protocol_id, self.protocol_id)
+        eq_(r1._version_id, self.version_id)
+        eq_(r1._bpdu_type, self.bpdu_type)
+        eq_(r2, None)
+
+    def test_serialize(self):
+        data = bytearray()
+        prev = None
+        buf = self.msg.serialize(data, prev)
+        res = struct.unpack(self.fmt, buf)
+
+        eq_(res[0], self.protocol_id)
+        eq_(res[1], self.version_id)
+        eq_(res[2], self.bpdu_type)
 
     def test_json(self):
         jsondict = self.msg.to_jsondict()
@@ -46,9 +218,252 @@ class Test_TopologyChangeNotificationBPDUs(unittest.TestCase):
 
 
 class Test_RstBPDUs(unittest.TestCase):
-    msg = bpdu.RstBPDUs()
+    """ Test case for RstBPDUs
+    """
+
+    def setUp(self):
+        self.protocol_id = bpdu.PROTOCOL_IDENTIFIER
+        self.version_id = bpdu.RstBPDUs.VERSION_ID
+        self.bpdu_type = bpdu.RstBPDUs.BPDU_TYPE
+        self.flags = 0b01111110
+        self.root_priority = 4096
+        self.root_system_id_extension = 1
+        self.root_mac_address = '12:34:56:78:9a:bc'
+        self.root_path_cost = 2
+        self.bridge_priority = 8192
+        self.bridge_system_id_extension = 3
+        self.bridge_mac_address = 'aa:aa:aa:aa:aa:aa'
+        self.port_priority = 16
+        self.port_number = 4
+        self.message_age = 5
+        self.max_age = 6
+        self.hello_time = 7
+        self.forward_delay = 8
+        self.version_1_length = bpdu.VERSION_1_LENGTH
+
+        self.msg = bpdu.RstBPDUs(
+            flags=self.flags,
+            root_priority=self.root_priority,
+            root_system_id_extension=self.root_system_id_extension,
+            root_mac_address=self.root_mac_address,
+            root_path_cost=self.root_path_cost,
+            bridge_priority=self.bridge_priority,
+            bridge_system_id_extension=self.bridge_system_id_extension,
+            bridge_mac_address=self.bridge_mac_address,
+            port_priority=self.port_priority,
+            port_number=self.port_number,
+            message_age=self.message_age,
+            max_age=self.max_age,
+            hello_time=self.hello_time,
+            forward_delay=self.forward_delay)
+
+        self.fmt = (bpdu.bpdu._PACK_STR
+                    + bpdu.ConfigurationBPDUs._PACK_STR[1:]
+                    + bpdu.RstBPDUs._PACK_STR[1:])
+        self.buf = struct.pack(self.fmt,
+                               self.protocol_id, self.version_id,
+                               self.bpdu_type, self.flags,
+                               bpdu.RstBPDUs.encode_bridge_id(
+                                   self.root_priority,
+                                   self.root_system_id_extension,
+                                   self.root_mac_address),
+                               self.root_path_cost,
+                               bpdu.RstBPDUs.encode_bridge_id(
+                                   self.bridge_priority,
+                                   self.bridge_system_id_extension,
+                                   self.bridge_mac_address),
+                               bpdu.RstBPDUs.encode_port_id(
+                                   self.port_priority,
+                                   self.port_number),
+                               bpdu.RstBPDUs._encode_timer(self.message_age),
+                               bpdu.RstBPDUs._encode_timer(self.max_age),
+                               bpdu.RstBPDUs._encode_timer(self.hello_time),
+                               bpdu.RstBPDUs._encode_timer(self.forward_delay),
+                               self.version_1_length)
+
+    def test_init(self):
+        eq_(self.protocol_id, self.msg._protocol_id)
+        eq_(self.version_id, self.msg._version_id)
+        eq_(self.bpdu_type, self.msg._bpdu_type)
+        eq_(self.flags, self.msg.flags)
+        eq_(self.root_priority, self.msg.root_priority)
+        eq_(self.root_system_id_extension,
+            self.msg.root_system_id_extension)
+        eq_(self.root_mac_address, self.msg.root_mac_address)
+        eq_(self.root_path_cost, self.msg.root_path_cost)
+        eq_(self.bridge_priority, self.msg.bridge_priority)
+        eq_(self.bridge_system_id_extension,
+            self.msg.bridge_system_id_extension)
+        eq_(self.bridge_mac_address, self.msg.bridge_mac_address)
+        eq_(self.port_priority, self.msg.port_priority)
+        eq_(self.port_number, self.msg.port_number)
+        eq_(self.message_age, self.msg.message_age)
+        eq_(self.max_age, self.msg.max_age)
+        eq_(self.hello_time, self.msg.hello_time)
+        eq_(self.forward_delay, self.msg.forward_delay)
+        eq_(self.version_1_length, self.msg._version_1_length)
+
+    def test_parser(self):
+        r1, r2, _ = bpdu.bpdu.parser(self.buf)
+
+        eq_(type(r1), type(self.msg))
+        eq_(r1._protocol_id, self.protocol_id)
+        eq_(r1._version_id, self.version_id)
+        eq_(r1._bpdu_type, self.bpdu_type)
+        eq_(r1.flags, self.flags)
+        eq_(r1.root_priority, self.root_priority)
+        eq_(r1.root_system_id_extension, self.root_system_id_extension)
+        eq_(r1.root_mac_address, self.root_mac_address)
+        eq_(r1.root_path_cost, self.root_path_cost)
+        eq_(r1.bridge_priority, self.bridge_priority)
+        eq_(r1.bridge_system_id_extension, self.bridge_system_id_extension)
+        eq_(r1.bridge_mac_address, self.bridge_mac_address)
+        eq_(r1.port_priority, self.port_priority)
+        eq_(r1.port_number, self.port_number)
+        eq_(r1.message_age, self.message_age)
+        eq_(r1.max_age, self.max_age)
+        eq_(r1.hello_time, self.hello_time)
+        eq_(r1.forward_delay, self.forward_delay)
+        eq_(r1._version_1_length, self.version_1_length)
+        eq_(r2, None)
+
+    def test_serialize(self):
+        data = bytearray()
+        prev = None
+        buf = self.msg.serialize(data, prev)
+        res = struct.unpack(self.fmt, buf)
+
+        eq_(res[0], self.protocol_id)
+        eq_(res[1], self.version_id)
+        eq_(res[2], self.bpdu_type)
+        eq_(res[3], self.flags)
+        eq_(bpdu.RstBPDUs._decode_bridge_id(res[4]),
+            (self.root_priority,
+             self.root_system_id_extension,
+             self.root_mac_address))
+        eq_(res[5], self.root_path_cost)
+        eq_(bpdu.RstBPDUs._decode_bridge_id(res[6]),
+            (self.bridge_priority,
+             self.bridge_system_id_extension,
+             self.bridge_mac_address))
+        eq_(bpdu.RstBPDUs._decode_port_id(res[7]),
+            (self.port_priority,
+             self.port_number))
+        eq_(bpdu.RstBPDUs._decode_timer(res[8]), self.message_age)
+        eq_(bpdu.RstBPDUs._decode_timer(res[9]), self.max_age)
+        eq_(bpdu.RstBPDUs._decode_timer(res[10]), self.hello_time)
+        eq_(bpdu.RstBPDUs._decode_timer(res[11]), self.forward_delay)
+        eq_(res[12], self.version_1_length)
 
     def test_json(self):
         jsondict = self.msg.to_jsondict()
         msg = bpdu.RstBPDUs.from_jsondict(jsondict['RstBPDUs'])
         eq_(str(self.msg), str(msg))
+
+
+class Test_UnknownVersion(unittest.TestCase):
+    """ Test case for unknown BPDU version
+    """
+
+    def setUp(self):
+        self.protocol_id = bpdu.PROTOCOL_IDENTIFIER
+        self.version_id = 111  # Unknown version
+        self.bpdu_type = bpdu.RstBPDUs.BPDU_TYPE
+        self.flags = 0b01111110
+        self.root_priority = 4096
+        self.root_system_id_extension = 1
+        self.root_mac_address = '12:34:56:78:9a:bc'
+        self.root_path_cost = 2
+        self.bridge_priority = 8192
+        self.bridge_system_id_extension = 3
+        self.bridge_mac_address = 'aa:aa:aa:aa:aa:aa'
+        self.port_priority = 16
+        self.port_number = 4
+        self.message_age = 5
+        self.max_age = 6
+        self.hello_time = 7
+        self.forward_delay = 8
+        self.version_1_length = bpdu.VERSION_1_LENGTH
+
+        self.fmt = (bpdu.bpdu._PACK_STR
+                    + bpdu.ConfigurationBPDUs._PACK_STR[1:]
+                    + bpdu.RstBPDUs._PACK_STR[1:])
+        self.buf = struct.pack(self.fmt,
+                               self.protocol_id, self.version_id,
+                               self.bpdu_type, self.flags,
+                               bpdu.RstBPDUs.encode_bridge_id(
+                                   self.root_priority,
+                                   self.root_system_id_extension,
+                                   self.root_mac_address),
+                               self.root_path_cost,
+                               bpdu.RstBPDUs.encode_bridge_id(
+                                   self.bridge_priority,
+                                   self.bridge_system_id_extension,
+                                   self.bridge_mac_address),
+                               bpdu.RstBPDUs.encode_port_id(
+                                   self.port_priority,
+                                   self.port_number),
+                               bpdu.RstBPDUs._encode_timer(self.message_age),
+                               bpdu.RstBPDUs._encode_timer(self.max_age),
+                               bpdu.RstBPDUs._encode_timer(self.hello_time),
+                               bpdu.RstBPDUs._encode_timer(self.forward_delay),
+                               self.version_1_length)
+
+    def test_parser(self):
+        r1, r2, _ = bpdu.bpdu.parser(self.buf)
+        eq_(r1, self.buf)
+        eq_(r2, None)
+
+
+class Test_UnknownType(unittest.TestCase):
+    """ Test case for unknown BPDU type
+    """
+
+    def setUp(self):
+        self.protocol_id = bpdu.PROTOCOL_IDENTIFIER
+        self.version_id = bpdu.RstBPDUs.VERSION_ID
+        self.bpdu_type = 222  # Unknown type
+        self.flags = 0b01111110
+        self.root_priority = 4096
+        self.root_system_id_extension = 1
+        self.root_mac_address = '12:34:56:78:9a:bc'
+        self.root_path_cost = 2
+        self.bridge_priority = 8192
+        self.bridge_system_id_extension = 3
+        self.bridge_mac_address = 'aa:aa:aa:aa:aa:aa'
+        self.port_priority = 16
+        self.port_number = 4
+        self.message_age = 5
+        self.max_age = 6
+        self.hello_time = 7
+        self.forward_delay = 8
+        self.version_1_length = bpdu.VERSION_1_LENGTH
+
+        self.fmt = (bpdu.bpdu._PACK_STR
+                    + bpdu.ConfigurationBPDUs._PACK_STR[1:]
+                    + bpdu.RstBPDUs._PACK_STR[1:])
+        self.buf = struct.pack(self.fmt,
+                               self.protocol_id, self.version_id,
+                               self.bpdu_type, self.flags,
+                               bpdu.RstBPDUs.encode_bridge_id(
+                                   self.root_priority,
+                                   self.root_system_id_extension,
+                                   self.root_mac_address),
+                               self.root_path_cost,
+                               bpdu.RstBPDUs.encode_bridge_id(
+                                   self.bridge_priority,
+                                   self.bridge_system_id_extension,
+                                   self.bridge_mac_address),
+                               bpdu.RstBPDUs.encode_port_id(
+                                   self.port_priority,
+                                   self.port_number),
+                               bpdu.RstBPDUs._encode_timer(self.message_age),
+                               bpdu.RstBPDUs._encode_timer(self.max_age),
+                               bpdu.RstBPDUs._encode_timer(self.hello_time),
+                               bpdu.RstBPDUs._encode_timer(self.forward_delay),
+                               self.version_1_length)
+
+    def test_parser(self):
+        r1, r2, _ = bpdu.bpdu.parser(self.buf)
+        eq_(r1, self.buf)
+        eq_(r2, None)