make "test-all" target pass again
[vpp.git] / test / test_vxlan.py
index 1db3492..99d5d13 100644 (file)
 #!/usr/bin/env python
 
+import socket
+from util import ip4n_range
 import unittest
 from framework import VppTestCase, VppTestRunner
-from util import Util
 from template_bd import BridgeDomain
 
 from scapy.layers.l2 import Ether
 from scapy.layers.inet import IP, UDP
-from scapy_handlers.vxlan import VXLAN
+from scapy.layers.vxlan import VXLAN
+from scapy.utils import atol
 
 
-## TestVxlan is a subclass of BridgeDomain, Util, VppTestCase classes.
-#
-#  TestVxlan class defines VXLAN test cases for VXLAN encapsulation,
-#  decapsulation and VXLAN tunnel termination in L2 bridge-domain.
-class TestVxlan(BridgeDomain, Util, VppTestCase):
+class TestVxlan(BridgeDomain, VppTestCase):
     """ VXLAN Test Case """
 
-    ## Method to initialize all parent classes.
-    #
-    #  Initialize BridgeDomain objects, set documentation string for inherited
-    #  tests and initialize VppTestCase object which must be called after
-    #  doc strings are set.
     def __init__(self, *args):
         BridgeDomain.__init__(self)
-        self.test_decap.__func__.__doc__ = ' VXLAN BD decapsulation '
-        self.test_encap.__func__.__doc__ = ' VXLAN BD encapsulation '
         VppTestCase.__init__(self, *args)
 
-    ## Method for VXLAN encapsulate function.
-    #
-    #  Encapsulate the original payload frame by adding VXLAN header with its
-    #  UDP, IP and Ethernet fields.
-    def encapsulate(self, pkt):
-        return (Ether(src=self.MY_MACS[0], dst=self.VPP_MACS[0]) /
-                IP(src=self.MY_IP4S[0], dst=self.VPP_IP4S[0]) /
-                UDP(sport=4789, dport=4789, chksum=0) /
-                VXLAN(vni=1) /
+    def encapsulate(self, pkt, vni):
+        """
+        Encapsulate the original payload frame by adding VXLAN header with its
+        UDP, IP and Ethernet fields
+        """
+        return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
+                IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
+                UDP(sport=self.dport, dport=self.dport, chksum=0) /
+                VXLAN(vni=vni, flags=self.flags) /
+                pkt)
+
+    def encap_mcast(self, pkt, src_ip, src_mac, vni):
+        """
+        Encapsulate the original payload frame by adding VXLAN header with its
+        UDP, IP and Ethernet fields
+        """
+        return (Ether(src=src_mac, dst=self.mcast_mac) /
+                IP(src=src_ip, dst=self.mcast_ip4) /
+                UDP(sport=self.dport, dport=self.dport, chksum=0) /
+                VXLAN(vni=vni, flags=self.flags) /
                 pkt)
 
-    ## Method for VXLAN decapsulate function.
-    #
-    #  Decapsulate the original payload frame by removing VXLAN header with
-    #  its UDP, IP and Ethernet fields.
     def decapsulate(self, pkt):
+        """
+        Decapsulate the original payload frame by removing VXLAN header
+        """
+        # check if is set I flag
+        self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
         return pkt[VXLAN].payload
 
-    ## Method for checking VXLAN encapsulation.
+    # Method for checking VXLAN encapsulation.
     #
-    def check_encapsulation(self, pkt):
+    def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
         # TODO: add error messages
-        ## Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
+        # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
         #  by VPP using ARP.
-        self.assertEqual(pkt[Ether].src, self.VPP_MACS[0])
-        self.assertEqual(pkt[Ether].dst, self.MY_MACS[0])
-        ## Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
-        self.assertEqual(pkt[IP].src, self.VPP_IP4S[0])
-        self.assertEqual(pkt[IP].dst, self.MY_IP4S[0])
-        ## Verify UDP destination port is VXLAN 4789, source UDP port could be
+        self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
+        if not local_only:
+            if not mcast_pkt:
+                self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
+            else:
+                self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
+        # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
+        self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
+        if not local_only:
+            if not mcast_pkt:
+                self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
+            else:
+                self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
+        # Verify UDP destination port is VXLAN 4789, source UDP port could be
         #  arbitrary.
-        self.assertEqual(pkt[UDP].dport, 4789)
+        self.assertEqual(pkt[UDP].dport, type(self).dport)
         # TODO: checksum check
-        ## Verify VNI, based on configuration it must be 1.
-        self.assertEqual(pkt[VXLAN].vni, 1)
+        # Verify VNI
+        self.assertEqual(pkt[VXLAN].vni, vni)
+
+    @classmethod
+    def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels):
+        # Create 10 ucast vxlan tunnels under bd
+        ip_range_start = 10
+        ip_range_end = ip_range_start + n_ucast_tunnels
+        next_hop_address = cls.pg0.remote_ip4n
+        for dest_ip4n in ip4n_range(next_hop_address, ip_range_start,
+                                    ip_range_end):
+            # add host route so dest_ip4n will not be resolved
+            cls.vapi.ip_add_del_route(dest_ip4n, 32, next_hop_address)
+            r = cls.vapi.vxlan_add_del_tunnel(
+                src_addr=cls.pg0.local_ip4n,
+                dst_addr=dest_ip4n,
+                vni=vni)
+            cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
+
+    @classmethod
+    def add_del_shared_mcast_dst_load(cls, is_add):
+        """
+        add or del tunnels sharing the same mcast dst
+        to test vxlan ref_count mechanism
+        """
+        n_shared_dst_tunnels = 20
+        vni_start = 10000
+        vni_end = vni_start + n_shared_dst_tunnels
+        for vni in range(vni_start, vni_end):
+            r = cls.vapi.vxlan_add_del_tunnel(
+                src_addr=cls.pg0.local_ip4n,
+                dst_addr=cls.mcast_ip4n,
+                mcast_sw_if_index=1,
+                vni=vni,
+                is_add=is_add)
+            if r.sw_if_index == 0xffffffff:
+                raise "bad sw_if_index"
+
+    @classmethod
+    def add_shared_mcast_dst_load(cls):
+        cls.add_del_shared_mcast_dst_load(is_add=1)
+
+    @classmethod
+    def del_shared_mcast_dst_load(cls):
+        cls.add_del_shared_mcast_dst_load(is_add=0)
+
+    @classmethod
+    def add_del_mcast_tunnels_load(cls, is_add):
+        """
+        add or del tunnels to test vxlan stability
+        """
+        n_distinct_dst_tunnels = 200
+        ip_range_start = 10
+        ip_range_end = ip_range_start + n_distinct_dst_tunnels
+        for dest_ip4n in ip4n_range(cls.mcast_ip4n, ip_range_start,
+                                    ip_range_end):
+            vni = bytearray(dest_ip4n)[3]
+            cls.vapi.vxlan_add_del_tunnel(
+                src_addr=cls.pg0.local_ip4n,
+                dst_addr=dest_ip4n,
+                mcast_sw_if_index=1,
+                vni=vni,
+                is_add=is_add)
 
-    ## Class method to start the VXLAN test case.
+    @classmethod
+    def add_mcast_tunnels_load(cls):
+        cls.add_del_mcast_tunnels_load(is_add=1)
+
+    @classmethod
+    def del_mcast_tunnels_load(cls):
+        cls.add_del_mcast_tunnels_load(is_add=0)
+
+    # Class method to start the VXLAN test case.
     #  Overrides setUpClass method in VppTestCase class.
     #  Python try..except statement is used to ensure that the tear down of
     #  the class will be executed even if exception is raised.
@@ -72,31 +152,83 @@ class TestVxlan(BridgeDomain, Util, VppTestCase):
     @classmethod
     def setUpClass(cls):
         super(TestVxlan, cls).setUpClass()
+
         try:
-            ## Create 2 pg interfaces.
-            cls.create_interfaces(range(2))
-            ## Configure IPv4 addresses on VPP pg0.
-            cls.config_ip4([0])
-            ## Resolve MAC address for VPP's IP address on pg0.
-            cls.resolve_arp([0])
-
-            ## Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
+            cls.dport = 4789
+            cls.flags = 0x8
+
+            # Create 2 pg interfaces.
+            cls.create_pg_interfaces(range(4))
+            for pg in cls.pg_interfaces:
+                pg.admin_up()
+
+            # Configure IPv4 addresses on VPP pg0.
+            cls.pg0.config_ip4()
+
+            # Resolve MAC address for VPP's IP address on pg0.
+            cls.pg0.resolve_arp()
+
+            # Our Multicast address
+            cls.mcast_ip4 = '239.1.1.1'
+            cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
+            iplong = atol(cls.mcast_ip4)
+            cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
+                (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
+
+            # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
             #  into BD.
-            cls.api("vxlan_add_del_tunnel src %s dst %s vni 1" %
-                    (cls.VPP_IP4S[0], cls.MY_IP4S[0]))
-            cls.api("sw_interface_set_l2_bridge vxlan_tunnel0 bd_id 1")
-            cls.api("sw_interface_set_l2_bridge pg1 bd_id 1")
-        except:
-            ## In case setUpClass fails run tear down.
-            cls.tearDownClass()
+            cls.single_tunnel_bd = 1
+            r = cls.vapi.vxlan_add_del_tunnel(
+                src_addr=cls.pg0.local_ip4n,
+                dst_addr=cls.pg0.remote_ip4n,
+                vni=cls.single_tunnel_bd)
+            cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
+                                                bd_id=cls.single_tunnel_bd)
+            cls.vapi.sw_interface_set_l2_bridge(cls.pg1.sw_if_index,
+                                                bd_id=cls.single_tunnel_bd)
+
+            # Setup vni 2 to test multicast flooding
+            cls.n_ucast_tunnels = 10
+            cls.mcast_flood_bd = 2
+            cls.create_vxlan_flood_test_bd(cls.mcast_flood_bd,
+                                           cls.n_ucast_tunnels)
+            r = cls.vapi.vxlan_add_del_tunnel(
+                src_addr=cls.pg0.local_ip4n,
+                dst_addr=cls.mcast_ip4n,
+                mcast_sw_if_index=1,
+                vni=cls.mcast_flood_bd)
+            cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
+                                                bd_id=cls.mcast_flood_bd)
+            cls.vapi.sw_interface_set_l2_bridge(cls.pg2.sw_if_index,
+                                                bd_id=cls.mcast_flood_bd)
+
+            # Add and delete mcast tunnels to check stability
+            cls.add_shared_mcast_dst_load()
+            cls.add_mcast_tunnels_load()
+            cls.del_shared_mcast_dst_load()
+            cls.del_mcast_tunnels_load()
+
+            # Setup vni 3 to test unicast flooding
+            cls.ucast_flood_bd = 3
+            cls.create_vxlan_flood_test_bd(cls.ucast_flood_bd,
+                                           cls.n_ucast_tunnels)
+            cls.vapi.sw_interface_set_l2_bridge(cls.pg3.sw_if_index,
+                                                bd_id=cls.ucast_flood_bd)
+        except Exception:
+            super(TestVxlan, cls).tearDownClass()
             raise
 
-    ## Method to define VPP actions before tear down of the test case.
+    # Method to define VPP actions before tear down of the test case.
     #  Overrides tearDown method in VppTestCase class.
     #  @param self The object pointer.
     def tearDown(self):
         super(TestVxlan, self).tearDown()
-        self.cli(2, "show bridge-domain 1 detail")
+        if not self.vpp_dead:
+            self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
+            self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
+            self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
+            self.logger.info(self.vapi.cli("show vxlan tunnel"))
+
 
 if __name__ == '__main__':
     unittest.main(testRunner=VppTestRunner)