reassembly: replace asserts with error counters
[vpp.git] / test / test_reassembly.py
index 531caa4..828c4d1 100644 (file)
@@ -1,19 +1,24 @@
 #!/usr/bin/env python
+
+import six
 import unittest
 from random import shuffle
 
-from framework import VppTestCase, VppTestRunner
+from framework import VppTestCase, VppTestRunner, is_skip_aarch64_set,\
+    is_platform_aarch64
 
 from scapy.packet import Raw
 from scapy.layers.l2 import Ether, GRE
-from scapy.layers.inet import IP, UDP
+from scapy.layers.inet import IP, UDP, ICMP
 from util import ppp, fragment_rfc791, fragment_rfc8200
 from scapy.layers.inet6 import IPv6, IPv6ExtHdrFragment, ICMPv6ParamProblem,\
     ICMPv6TimeExceeded
 from vpp_gre_interface import VppGreInterface, VppGre6Interface
-from vpp_ip_route import VppIpRoute, VppRoutePath, DpoProto
+from vpp_ip import DpoProto
+from vpp_ip_route import VppIpRoute, VppRoutePath
 
-test_packet_count = 257
+# 35 is enough to have >257 400-byte fragments
+test_packet_count = 35
 
 
 class TestIPv4Reassembly(VppTestCase):
@@ -56,7 +61,7 @@ class TestIPv4Reassembly(VppTestCase):
 
     @classmethod
     def create_stream(cls, packet_sizes, packet_count=test_packet_count):
-        """Create input packet stream for defined interface.
+        """Create input packet stream
 
         :param list packet_sizes: Required packet sizes.
         """
@@ -76,7 +81,7 @@ class TestIPv4Reassembly(VppTestCase):
     def create_fragments(cls):
         infos = cls._packet_infos
         cls.pkt_infos = []
-        for index, info in infos.iteritems():
+        for index, info in six.iteritems(infos):
             p = info.data
             # cls.logger.debug(ppp("Packet:", p.__class__(str(p))))
             fragments_400 = fragment_rfc791(p, 400)
@@ -174,6 +179,104 @@ class TestIPv4Reassembly(VppTestCase):
         self.verify_capture(packets)
         self.src_if.assert_nothing_captured()
 
+    def test_5737(self):
+        """ fragment length + ip header size > 65535 """
+        self.vapi.cli("clear errors")
+        raw = ('E\x00\x00\x88,\xf8\x1f\xfe@\x01\x98\x00\xc0\xa8\n-\xc0\xa8\n'
+               '\x01\x08\x00\xf0J\xed\xcb\xf1\xf5Test-group: IPv4.IPv4.ipv4-'
+               'message.Ethernet-Payload.IPv4-Packet.IPv4-Header.Fragment-Of'
+               'fset; Test-case: 5737')
+
+        malformed_packet = (Ether(dst=self.src_if.local_mac,
+                                  src=self.src_if.remote_mac) /
+                            IP(raw))
+        p = (Ether(dst=self.src_if.local_mac, src=self.src_if.remote_mac) /
+             IP(id=1000, src=self.src_if.remote_ip4,
+                dst=self.dst_if.remote_ip4) /
+             UDP(sport=1234, dport=5678) /
+             Raw("X" * 1000))
+        valid_fragments = fragment_rfc791(p, 400)
+
+        self.pg_enable_capture()
+        self.src_if.add_stream([malformed_packet] + valid_fragments)
+        self.pg_start()
+
+        self.dst_if.get_capture(1)
+        self.assert_packet_counter_equal("ip4-reassembly-feature", 1)
+        # TODO remove above, uncomment below once clearing of counters
+        # is supported
+        # self.assert_packet_counter_equal(
+        #     "/err/ip4-reassembly-feature/malformed packets", 1)
+
+    def test_44924(self):
+        """ compress tiny fragments """
+        packets = [(Ether(dst=self.src_if.local_mac,
+                          src=self.src_if.remote_mac) /
+                    IP(id=24339, flags="MF", frag=0, ttl=64,
+                       src=self.src_if.remote_ip4,
+                       dst=self.dst_if.remote_ip4) /
+                    ICMP(type="echo-request", code=0, id=0x1fe6, seq=0x2407) /
+                    Raw(load='Test-group: IPv4')),
+                   (Ether(dst=self.src_if.local_mac,
+                          src=self.src_if.remote_mac) /
+                    IP(id=24339, flags="MF", frag=3, ttl=64,
+                       src=self.src_if.remote_ip4,
+                       dst=self.dst_if.remote_ip4) /
+                    ICMP(type="echo-request", code=0, id=0x1fe6, seq=0x2407) /
+                    Raw(load='.IPv4.Fragmentation.vali')),
+                   (Ether(dst=self.src_if.local_mac,
+                          src=self.src_if.remote_mac) /
+                    IP(id=24339, frag=6, ttl=64,
+                       src=self.src_if.remote_ip4,
+                       dst=self.dst_if.remote_ip4) /
+                    ICMP(type="echo-request", code=0, id=0x1fe6, seq=0x2407) /
+                    Raw(load='d; Test-case: 44924'))
+                   ]
+
+        self.pg_enable_capture()
+        self.src_if.add_stream(packets)
+        self.pg_start()
+
+        self.dst_if.get_capture(1)
+
+    def test_frag_1(self):
+        """ fragment of size 1 """
+        self.vapi.cli("clear errors")
+        malformed_packets = [(Ether(dst=self.src_if.local_mac,
+                                    src=self.src_if.remote_mac) /
+                              IP(id=7, len=21, flags="MF", frag=0, ttl=64,
+                                 src=self.src_if.remote_ip4,
+                                 dst=self.dst_if.remote_ip4) /
+                              ICMP(type="echo-request")),
+                             (Ether(dst=self.src_if.local_mac,
+                                    src=self.src_if.remote_mac) /
+                              IP(id=7, len=21, frag=1, ttl=64,
+                                 src=self.src_if.remote_ip4,
+                                 dst=self.dst_if.remote_ip4) /
+                              Raw(load='\x08')),
+                             ]
+
+        p = (Ether(dst=self.src_if.local_mac, src=self.src_if.remote_mac) /
+             IP(id=1000, src=self.src_if.remote_ip4,
+                dst=self.dst_if.remote_ip4) /
+             UDP(sport=1234, dport=5678) /
+             Raw("X" * 1000))
+        valid_fragments = fragment_rfc791(p, 400)
+
+        self.pg_enable_capture()
+        self.src_if.add_stream(malformed_packets + valid_fragments)
+        self.pg_start()
+
+        self.dst_if.get_capture(1)
+
+        self.assert_packet_counter_equal("ip4-reassembly-feature", 1)
+        # TODO remove above, uncomment below once clearing of counters
+        # is supported
+        # self.assert_packet_counter_equal(
+        #     "/err/ip4-reassembly-feature/malformed packets", 1)
+
+    @unittest.skipIf(is_skip_aarch64_set() and is_platform_aarch64(),
+                     "test doesn't work on aarch64")
     def test_random(self):
         """ random order reassembly """
 
@@ -413,7 +516,7 @@ class TestIPv6Reassembly(VppTestCase):
     def create_fragments(cls):
         infos = cls._packet_infos
         cls.pkt_infos = []
-        for index, info in infos.iteritems():
+        for index, info in six.iteritems(infos):
             p = info.data
             # cls.logger.debug(ppp("Packet:", p.__class__(str(p))))
             fragments_400 = fragment_rfc8200(p, info.index, 400)
@@ -749,7 +852,123 @@ class TestIPv6Reassembly(VppTestCase):
         self.assert_equal(icmp[ICMPv6ParamProblem].code, 0, "ICMP code")
 
 
-@unittest.skip("removing GRE tunnels broken, need fix")
+class TestIPv4ReassemblyLocalNode(VppTestCase):
+    """ IPv4 Reassembly for packets coming to ip4-local node """
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestIPv4ReassemblyLocalNode, cls).setUpClass()
+
+        cls.create_pg_interfaces([0])
+        cls.src_dst_if = cls.pg0
+
+        # setup all interfaces
+        for i in cls.pg_interfaces:
+            i.admin_up()
+            i.config_ip4()
+            i.resolve_arp()
+
+        cls.padding = " abcdefghijklmn"
+        cls.create_stream()
+        cls.create_fragments()
+
+    def setUp(self):
+        """ Test setup - force timeout on existing reassemblies """
+        super(TestIPv4ReassemblyLocalNode, self).setUp()
+        self.vapi.ip_reassembly_set(timeout_ms=0, max_reassemblies=1000,
+                                    expire_walk_interval_ms=10)
+        self.sleep(.25)
+        self.vapi.ip_reassembly_set(timeout_ms=1000000, max_reassemblies=1000,
+                                    expire_walk_interval_ms=10000)
+
+    def tearDown(self):
+        super(TestIPv4ReassemblyLocalNode, self).tearDown()
+        self.logger.debug(self.vapi.ppcli("show ip4-reassembly details"))
+
+    @classmethod
+    def create_stream(cls, packet_count=test_packet_count):
+        """Create input packet stream for defined interface.
+
+        :param list packet_sizes: Required packet sizes.
+        """
+        for i in range(0, packet_count):
+            info = cls.create_packet_info(cls.src_dst_if, cls.src_dst_if)
+            payload = cls.info_to_payload(info)
+            p = (Ether(dst=cls.src_dst_if.local_mac,
+                       src=cls.src_dst_if.remote_mac) /
+                 IP(id=info.index, src=cls.src_dst_if.remote_ip4,
+                    dst=cls.src_dst_if.local_ip4) /
+                 ICMP(type='echo-request', id=1234) /
+                 Raw(payload))
+            cls.extend_packet(p, 1518, cls.padding)
+            info.data = p
+
+    @classmethod
+    def create_fragments(cls):
+        infos = cls._packet_infos
+        cls.pkt_infos = []
+        for index, info in six.iteritems(infos):
+            p = info.data
+            # cls.logger.debug(ppp("Packet:", p.__class__(str(p))))
+            fragments_300 = fragment_rfc791(p, 300)
+            cls.pkt_infos.append((index, fragments_300))
+        cls.fragments_300 = [x for (_, frags) in cls.pkt_infos for x in frags]
+        cls.logger.debug("Fragmented %s packets into %s 300-byte fragments" %
+                         (len(infos), len(cls.fragments_300)))
+
+    def verify_capture(self, capture):
+        """Verify captured packet stream.
+
+        :param list capture: Captured packet stream.
+        """
+        info = None
+        seen = set()
+        for packet in capture:
+            try:
+                self.logger.debug(ppp("Got packet:", packet))
+                ip = packet[IP]
+                icmp = packet[ICMP]
+                payload_info = self.payload_to_info(str(packet[Raw]))
+                packet_index = payload_info.index
+                if packet_index in seen:
+                    raise Exception(ppp("Duplicate packet received", packet))
+                seen.add(packet_index)
+                self.assertEqual(payload_info.dst, self.src_dst_if.sw_if_index)
+                info = self._packet_infos[packet_index]
+                self.assertIsNotNone(info)
+                self.assertEqual(packet_index, info.index)
+                saved_packet = info.data
+                self.assertEqual(ip.src, saved_packet[IP].dst)
+                self.assertEqual(ip.dst, saved_packet[IP].src)
+                self.assertEqual(icmp.type, 0)  # echo reply
+                self.assertEqual(icmp.id, saved_packet[ICMP].id)
+                self.assertEqual(icmp.payload, saved_packet[ICMP].payload)
+            except Exception:
+                self.logger.error(ppp("Unexpected or invalid packet:", packet))
+                raise
+        for index in self._packet_infos:
+            self.assertIn(index, seen,
+                          "Packet with packet_index %d not received" % index)
+
+    def test_reassembly(self):
+        """ basic reassembly """
+
+        self.pg_enable_capture()
+        self.src_dst_if.add_stream(self.fragments_300)
+        self.pg_start()
+
+        packets = self.src_dst_if.get_capture(len(self.pkt_infos))
+        self.verify_capture(packets)
+
+        # run it all again to verify correctness
+        self.pg_enable_capture()
+        self.src_dst_if.add_stream(self.fragments_300)
+        self.pg_start()
+
+        packets = self.src_dst_if.get_capture(len(self.pkt_infos))
+        self.verify_capture(packets)
+
+
 class TestFIFReassembly(VppTestCase):
     """ Fragments in fragments reassembly """
 
@@ -867,7 +1086,7 @@ class TestFIFReassembly(VppTestCase):
             self.extend_packet(p, size, self.padding)
             info.data = p[IP]  # use only IP part, without ethernet header
 
-        fragments = [x for _, p in self._packet_infos.iteritems()
+        fragments = [x for _, p in six.iteritems(self._packet_infos)
                      for x in fragment_rfc791(p.data, 400)]
 
         encapped_fragments = \
@@ -933,7 +1152,7 @@ class TestFIFReassembly(VppTestCase):
             self.extend_packet(p, size, self.padding)
             info.data = p[IPv6]  # use only IPv6 part, without ethernet header
 
-        fragments = [x for _, i in self._packet_infos.iteritems()
+        fragments = [x for _, i in six.iteritems(self._packet_infos)
                      for x in fragment_rfc8200(
                          i.data, i.index, 400)]
 
@@ -965,7 +1184,7 @@ class TestFIFReassembly(VppTestCase):
 
         # TODO remove gre vpp config by hand until VppIpRoute gets fixed
         # so that it's query_vpp_config() works as it should
-        self.gre6.remove_vpp_config()
+        self.gre6.remove_vpp_config()
 
 
 if __name__ == '__main__':