test/test_vxlan_gpe.py

   1 #!/usr/bin/env python3
   2
   3 import socket
   4 from util import ip4_range
   5 import unittest
   6 from framework import VppTestCase, VppTestRunner, running_extended_tests
   7 from template_bd import BridgeDomain
   8
   9 from scapy.layers.l2 import Ether
  10 from scapy.packet import Raw, bind_layers
  11 from scapy.layers.inet import IP, UDP
  12 from scapy.layers.vxlan import VXLAN
  13
  14 import util
  15 from vpp_ip_route import VppIpRoute, VppRoutePath
  16 from vpp_vxlan_gpe_tunnel import VppVxlanGpeTunnel
  17 from vpp_ip import INVALID_INDEX
  18
  19
  20 @unittest.skipUnless(running_extended_tests, "part of extended tests")
  21 class TestVxlanGpe(BridgeDomain, VppTestCase):
  22     """ VXLAN-GPE Test Case """
  23
  24     def __init__(self, *args):
  25         BridgeDomain.__init__(self)
  26         VppTestCase.__init__(self, *args)
  27
  28     def encapsulate(self, pkt, vni):
  29         """
  30         Encapsulate the original payload frame by adding VXLAN-GPE header
  31         with its UDP, IP and Ethernet fields
  32         """
  33         return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
  34                 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
  35                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
  36                 VXLAN(vni=vni, flags=self.flags) /
  37                 pkt)
  38
  39     def ip_range(self, start, end):
  40         """ range of remote ip's """
  41         return ip4_range(self.pg0.remote_ip4, start, end)
  42
  43     def encap_mcast(self, pkt, src_ip, src_mac, vni):
  44         """
  45         Encapsulate the original payload frame by adding VXLAN-GPE header
  46         with its UDP, IP and Ethernet fields
  47         """
  48         return (Ether(src=src_mac, dst=self.mcast_mac) /
  49                 IP(src=src_ip, dst=self.mcast_ip4) /
  50                 UDP(sport=self.dport, dport=self.dport, chksum=0) /
  51                 VXLAN(vni=vni, flags=self.flags) /
  52                 pkt)
  53
  54     def decapsulate(self, pkt):
  55         """
  56         Decapsulate the original payload frame by removing VXLAN-GPE header
  57         """
  58         # check if is set I and P flag
  59         self.assertEqual(pkt[VXLAN].flags, 0x0c)
  60         return pkt[VXLAN].payload
  61
  62     # Method for checking VXLAN-GPE encapsulation.
  63     #
  64     def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
  65         # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
  66         #  by VPP using ARP.
  67         self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
  68         if not local_only:
  69             if not mcast_pkt:
  70                 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
  71             else:
  72                 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
  73         # Verify VXLAN-GPE tunnel src IP is VPP_IP and dst IP is MY_IP.
  74         self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
  75         if not local_only:
  76             if not mcast_pkt:
  77                 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
  78             else:
  79                 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
  80         # Verify UDP destination port is VXLAN-GPE 4790, source UDP port
  81         #  could be arbitrary.
  82         self.assertEqual(pkt[UDP].dport, self.dport)
  83         # Verify UDP checksum
  84         self.assert_udp_checksum_valid(pkt)
  85         # Verify VNI
  86         self.assertEqual(pkt[VXLAN].vni, vni)
  87
  88     @classmethod
  89     def create_vxlan_gpe_flood_test_bd(cls, vni, n_ucast_tunnels, port):
  90         # Create 10 ucast vxlan tunnels under bd
  91         ip_range_start = 10
  92         ip_range_end = ip_range_start + n_ucast_tunnels
  93         next_hop_address = cls.pg0.remote_ip4
  94         for dest_ip4 in ip4_range(next_hop_address, ip_range_start,
  95                                   ip_range_end):
  96             # add host route so dest_ip4n will not be resolved
  97             rip = VppIpRoute(cls, dest_ip4, 32,
  98                              [VppRoutePath(next_hop_address,
  99                                            INVALID_INDEX)],
 100                              register=False)
 101             rip.add_vpp_config()
 102
 103             r = VppVxlanGpeTunnel(cls,
 104                                   src_addr=cls.pg0.local_ip4,
 105                                   dst_addr=dest_ip4,
 106                                   src_port=port,
 107                                   dst_port=port,
 108                                   vni=vni)
 109             r.add_vpp_config()
 110             cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 111                                                 bd_id=vni)
 112
 113     @classmethod
 114     def add_del_shared_mcast_dst_load(cls, port, is_add):
 115         """
 116         add or del tunnels sharing the same mcast dst
 117         to test vxlan_gpe ref_count mechanism
 118         """
 119         n_shared_dst_tunnels = 20
 120         vni_start = 1000
 121         vni_end = vni_start + n_shared_dst_tunnels
 122         for vni in range(vni_start, vni_end):
 123             r = VppVxlanGpeTunnel(cls,
 124                                   src_addr=cls.pg0.local_ip4,
 125                                   dst_addr=cls.mcast_ip4,
 126                                   src_port=port,
 127                                   dst_port=port,
 128                                   mcast_sw_if_index=1,
 129                                   vni=vni)
 130             if is_add:
 131                 r.add_vpp_config()
 132                 if r.sw_if_index == 0xffffffff:
 133                     raise ValueError("bad sw_if_index: ~0")
 134             else:
 135                 r.remove_vpp_config()
 136
 137     @classmethod
 138     def add_shared_mcast_dst_load(cls, port):
 139         cls.add_del_shared_mcast_dst_load(port=port, is_add=1)
 140
 141     @classmethod
 142     def del_shared_mcast_dst_load(cls, port):
 143         cls.add_del_shared_mcast_dst_load(port=port, is_add=0)
 144
 145     @classmethod
 146     def add_del_mcast_tunnels_load(cls, port, is_add):
 147         """
 148         add or del tunnels to test vxlan_gpe stability
 149         """
 150         n_distinct_dst_tunnels = 20
 151         ip_range_start = 10
 152         ip_range_end = ip_range_start + n_distinct_dst_tunnels
 153         for dest_ip4 in ip4_range(cls.mcast_ip4, ip_range_start,
 154                                   ip_range_end):
 155             vni = int(dest_ip4.split(".")[3])
 156             r = VppVxlanGpeTunnel(cls,
 157                                   src_addr=cls.pg0.local_ip4,
 158                                   dst_addr=dest_ip4,
 159                                   src_port=port,
 160                                   dst_port=port,
 161                                   mcast_sw_if_index=1,
 162                                   vni=vni)
 163             if is_add:
 164                 r.add_vpp_config()
 165             else:
 166                 r.remove_vpp_config()
 167
 168     @classmethod
 169     def add_mcast_tunnels_load(cls, port):
 170         cls.add_del_mcast_tunnels_load(port=port, is_add=1)
 171
 172     @classmethod
 173     def del_mcast_tunnels_load(cls, port):
 174         cls.add_del_mcast_tunnels_load(port=port, is_add=0)
 175
 176     # Class method to start the VXLAN-GPE test case.
 177     #  Overrides setUpClass method in VppTestCase class.
 178     #  Python try..except statement is used to ensure that the tear down of
 179     #  the class will be executed even if exception is raised.
 180     #  @param cls The class pointer.
 181     @classmethod
 182     def setUpClass(cls):
 183         super(TestVxlanGpe, cls).setUpClass()
 184
 185         try:
 186             cls.flags = 0x0c
 187
 188             # Create 2 pg interfaces.
 189             cls.create_pg_interfaces(range(4))
 190             for pg in cls.pg_interfaces:
 191                 pg.admin_up()
 192
 193             # Configure IPv4 addresses on VPP pg0.
 194             cls.pg0.config_ip4()
 195
 196             # Resolve MAC address for VPP's IP address on pg0.
 197             cls.pg0.resolve_arp()
 198
 199             # Our Multicast address
 200             cls.mcast_ip4 = '239.1.1.1'
 201             cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip4)
 202         except Exception:
 203             cls.tearDownClass()
 204             raise
 205
 206     @classmethod
 207     def tearDownClass(cls):
 208         super(TestVxlanGpe, cls).tearDownClass()
 209
 210     def setUp(self):
 211         super(TestVxlanGpe, self).setUp()
 212
 213     def createVxLANInterfaces(self, port=4790):
 214         # Create VXLAN-GPE VTEP on VPP pg0, and put vxlan_gpe_tunnel0
 215         # and pg1 into BD.
 216         self.dport = port
 217
 218         self.single_tunnel_vni = 0xabcde
 219         self.single_tunnel_bd = 11
 220         r = VppVxlanGpeTunnel(self,
 221                               src_addr=self.pg0.local_ip4,
 222                               dst_addr=self.pg0.remote_ip4,
 223                               src_port=port,
 224                               dst_port=port,
 225                               vni=self.single_tunnel_vni)
 226         r.add_vpp_config()
 227         self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 228                                              bd_id=self.single_tunnel_bd)
 229         self.vapi.sw_interface_set_l2_bridge(
 230             rx_sw_if_index=self.pg1.sw_if_index, bd_id=self.single_tunnel_bd)
 231
 232         # Setup vni 2 to test multicast flooding
 233         self.n_ucast_tunnels = 10
 234         self.mcast_flood_bd = 12
 235         self.create_vxlan_gpe_flood_test_bd(self.mcast_flood_bd,
 236                                             self.n_ucast_tunnels,
 237                                             self.dport)
 238         r = VppVxlanGpeTunnel(self,
 239                               src_addr=self.pg0.local_ip4,
 240                               dst_addr=self.mcast_ip4,
 241                               src_port=port,
 242                               dst_port=port,
 243                               mcast_sw_if_index=1,
 244                               vni=self.mcast_flood_bd)
 245         r.add_vpp_config()
 246         self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
 247                                              bd_id=self.mcast_flood_bd)
 248         self.vapi.sw_interface_set_l2_bridge(
 249             rx_sw_if_index=self.pg2.sw_if_index, bd_id=self.mcast_flood_bd)
 250
 251         # Add and delete mcast tunnels to check stability
 252         self.add_shared_mcast_dst_load(self.dport)
 253         self.add_mcast_tunnels_load(self.dport)
 254         self.del_shared_mcast_dst_load(self.dport)
 255         self.del_mcast_tunnels_load(self.dport)
 256
 257         # Setup vni 3 to test unicast flooding
 258         self.ucast_flood_bd = 13
 259         self.create_vxlan_gpe_flood_test_bd(self.ucast_flood_bd,
 260                                             self.n_ucast_tunnels,
 261                                             self.dport)
 262         self.vapi.sw_interface_set_l2_bridge(
 263             rx_sw_if_index=self.pg3.sw_if_index, bd_id=self.ucast_flood_bd)
 264
 265         # Set scapy listen custom port for VxLAN
 266         bind_layers(UDP, VXLAN, dport=self.dport)
 267
 268     """
 269     Tests with default port (4790)
 270     """
 271     def test_decap(self):
 272         """ Decapsulation test
 273         from BridgeDoman
 274         """
 275         self.createVxLANInterfaces()
 276         super(TestVxlanGpe, self).test_decap()
 277
 278     def test_encap(self):
 279         """ Encapsulation test
 280         from BridgeDoman
 281         """
 282         self.createVxLANInterfaces()
 283         super(TestVxlanGpe, self).test_encap()
 284
 285     def test_ucast_flood(self):
 286         """ Unicast flood test
 287         from BridgeDoman
 288         """
 289         self.createVxLANInterfaces()
 290         super(TestVxlanGpe, self).test_ucast_flood()
 291
 292     """
 293     Tests with custom port (1112)
 294     """
 295     def test_decap_custom_port(self):
 296         """ Decapsulation test custom port
 297         from BridgeDoman
 298         """
 299         self.createVxLANInterfaces(1112)
 300         super(TestVxlanGpe, self).test_decap()
 301
 302     def test_encap_custom_port(self):
 303         """ Encapsulation test custom port
 304         from BridgeDoman
 305         """
 306         self.createVxLANInterfaces(1112)
 307         super(TestVxlanGpe, self).test_encap()
 308
 309     def test_ucast_flood_custom_port(self):
 310         """ Unicast flood test custom port
 311         from BridgeDoman
 312         """
 313         self.createVxLANInterfaces(1112)
 314         super(TestVxlanGpe, self).test_ucast_flood()
 315
 316     @unittest.skip("test disabled for vxlan-gpe")
 317     def test_mcast_flood(self):
 318         """ inherited from BridgeDomain """
 319         pass
 320
 321     @unittest.skip("test disabled for vxlan-gpe")
 322     def test_mcast_rcv(self):
 323         """ inherited from BridgeDomain """
 324         pass
 325
 326     # Method to define VPP actions before tear down of the test case.
 327     #  Overrides tearDown method in VppTestCase class.
 328     #  @param self The object pointer.
 329     def tearDown(self):
 330         super(TestVxlanGpe, self).tearDown()
 331
 332     def show_commands_at_teardown(self):
 333         self.logger.info(self.vapi.cli("show bridge-domain 11 detail"))
 334         self.logger.info(self.vapi.cli("show bridge-domain 12 detail"))
 335         self.logger.info(self.vapi.cli("show bridge-domain 13 detail"))
 336         self.logger.info(self.vapi.cli("show int"))
 337         self.logger.info(self.vapi.cli("show vxlan-gpe"))
 338         self.logger.info(self.vapi.cli("show trace"))
 339
 340
 341 if __name__ == '__main__':
 342     unittest.main(testRunner=VppTestRunner)