4 from util import ip4n_range, ip4_range
6 from framework import VppTestCase, VppTestRunner, running_extended_tests
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether, Raw
10 from scapy.layers.inet import IP, UDP
11 from scapy.layers.vxlan import VXLAN
12 from scapy.utils import atol
15 @unittest.skipUnless(running_extended_tests, "part of extended tests")
16 class TestVxlanGpe(BridgeDomain, VppTestCase):
17 """ VXLAN-GPE Test Case """
19 def __init__(self, *args):
20 BridgeDomain.__init__(self)
21 VppTestCase.__init__(self, *args)
23 def encapsulate(self, pkt, vni):
25 Encapsulate the original payload frame by adding VXLAN-GPE header
26 with its UDP, IP and Ethernet fields
28 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
29 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
30 UDP(sport=self.dport, dport=self.dport, chksum=0) /
31 VXLAN(vni=vni, flags=self.flags) /
34 def ip_range(self, start, end):
35 """ range of remote ip's """
36 return ip4_range(self.pg0.remote_ip4, start, end)
38 def encap_mcast(self, pkt, src_ip, src_mac, vni):
40 Encapsulate the original payload frame by adding VXLAN-GPE header
41 with its UDP, IP and Ethernet fields
43 return (Ether(src=src_mac, dst=self.mcast_mac) /
44 IP(src=src_ip, dst=self.mcast_ip4) /
45 UDP(sport=self.dport, dport=self.dport, chksum=0) /
46 VXLAN(vni=vni, flags=self.flags) /
49 def decapsulate(self, pkt):
51 Decapsulate the original payload frame by removing VXLAN-GPE header
53 # check if is set I and P flag
54 self.assertEqual(pkt[VXLAN].flags, 0x0c)
55 return pkt[VXLAN].payload
57 # Method for checking VXLAN-GPE encapsulation.
59 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
60 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
62 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
65 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
67 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
68 # Verify VXLAN-GPE tunnel src IP is VPP_IP and dst IP is MY_IP.
69 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
72 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
74 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
75 # Verify UDP destination port is VXLAN-GPE 4790, source UDP port
77 self.assertEqual(pkt[UDP].dport, type(self).dport)
79 self.assertEqual(pkt[VXLAN].vni, vni)
82 def create_vxlan_gpe_flood_test_bd(cls, vni, n_ucast_tunnels):
83 # Create 10 ucast vxlan_gpe tunnels under bd
85 ip_range_end = ip_range_start + n_ucast_tunnels
86 next_hop_address = cls.pg0.remote_ip4n
87 for dest_ip4n in ip4n_range(next_hop_address, ip_range_start,
89 # add host route so dest_ip4n will not be resolved
90 cls.vapi.ip_add_del_route(dest_ip4n, 32, next_hop_address)
91 r = cls.vapi.vxlan_gpe_add_del_tunnel(
92 src_addr=cls.pg0.local_ip4n,
95 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
98 def add_del_shared_mcast_dst_load(cls, is_add):
100 add or del tunnels sharing the same mcast dst
101 to test vxlan_gpe ref_count mechanism
103 n_shared_dst_tunnels = 20
105 vni_end = vni_start + n_shared_dst_tunnels
106 for vni in range(vni_start, vni_end):
107 r = cls.vapi.vxlan_gpe_add_del_tunnel(
108 src_addr=cls.pg0.local_ip4n,
109 dst_addr=cls.mcast_ip4n,
113 if r.sw_if_index == 0xffffffff:
114 raise "bad sw_if_index"
117 def add_shared_mcast_dst_load(cls):
118 cls.add_del_shared_mcast_dst_load(is_add=1)
121 def del_shared_mcast_dst_load(cls):
122 cls.add_del_shared_mcast_dst_load(is_add=0)
125 def add_del_mcast_tunnels_load(cls, is_add):
127 add or del tunnels to test vxlan_gpe stability
129 n_distinct_dst_tunnels = 20
131 ip_range_end = ip_range_start + n_distinct_dst_tunnels
132 for dest_ip4n in ip4n_range(cls.mcast_ip4n, ip_range_start,
134 vni = bytearray(dest_ip4n)[3]
135 cls.vapi.vxlan_gpe_add_del_tunnel(
136 src_addr=cls.pg0.local_ip4n,
143 def add_mcast_tunnels_load(cls):
144 cls.add_del_mcast_tunnels_load(is_add=1)
147 def del_mcast_tunnels_load(cls):
148 cls.add_del_mcast_tunnels_load(is_add=0)
150 # Class method to start the VXLAN-GPE test case.
151 # Overrides setUpClass method in VppTestCase class.
152 # Python try..except statement is used to ensure that the tear down of
153 # the class will be executed even if exception is raised.
154 # @param cls The class pointer.
157 super(TestVxlanGpe, cls).setUpClass()
163 # Create 2 pg interfaces.
164 cls.create_pg_interfaces(range(4))
165 for pg in cls.pg_interfaces:
168 # Configure IPv4 addresses on VPP pg0.
171 # Resolve MAC address for VPP's IP address on pg0.
172 cls.pg0.resolve_arp()
174 # Our Multicast address
175 cls.mcast_ip4 = '239.1.1.1'
176 cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
177 iplong = atol(cls.mcast_ip4)
178 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
179 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
181 # Create VXLAN-GPE VTEP on VPP pg0, and put vxlan_gpe_tunnel0
183 cls.single_tunnel_bd = 11
184 r = cls.vapi.vxlan_gpe_add_del_tunnel(
185 src_addr=cls.pg0.local_ip4n,
186 dst_addr=cls.pg0.remote_ip4n,
187 vni=cls.single_tunnel_bd)
188 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
189 bd_id=cls.single_tunnel_bd)
190 cls.vapi.sw_interface_set_l2_bridge(cls.pg1.sw_if_index,
191 bd_id=cls.single_tunnel_bd)
193 # Setup vni 2 to test multicast flooding
194 cls.n_ucast_tunnels = 10
195 cls.mcast_flood_bd = 12
196 cls.create_vxlan_gpe_flood_test_bd(cls.mcast_flood_bd,
198 r = cls.vapi.vxlan_gpe_add_del_tunnel(
199 src_addr=cls.pg0.local_ip4n,
200 dst_addr=cls.mcast_ip4n,
202 vni=cls.mcast_flood_bd)
203 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
204 bd_id=cls.mcast_flood_bd)
205 cls.vapi.sw_interface_set_l2_bridge(cls.pg2.sw_if_index,
206 bd_id=cls.mcast_flood_bd)
208 # Add and delete mcast tunnels to check stability
209 cls.add_shared_mcast_dst_load()
210 cls.add_mcast_tunnels_load()
211 cls.del_shared_mcast_dst_load()
212 cls.del_mcast_tunnels_load()
214 # Setup vni 3 to test unicast flooding
215 cls.ucast_flood_bd = 13
216 cls.create_vxlan_gpe_flood_test_bd(cls.ucast_flood_bd,
218 cls.vapi.sw_interface_set_l2_bridge(cls.pg3.sw_if_index,
219 bd_id=cls.ucast_flood_bd)
221 super(TestVxlanGpe, cls).tearDownClass()
225 def tearDownClass(cls):
226 super(TestVxlanGpe, cls).tearDownClass()
228 @unittest.skip("test disabled for vxlan-gpe")
229 def test_mcast_flood(self):
230 """ inherited from BridgeDomain """
233 @unittest.skip("test disabled for vxlan-gpe")
234 def test_mcast_rcv(self):
235 """ inherited from BridgeDomain """
238 # Method to define VPP actions before tear down of the test case.
239 # Overrides tearDown method in VppTestCase class.
240 # @param self The object pointer.
242 super(TestVxlanGpe, self).tearDown()
243 if not self.vpp_dead:
244 self.logger.info(self.vapi.cli("show bridge-domain 11 detail"))
245 self.logger.info(self.vapi.cli("show bridge-domain 12 detail"))
246 self.logger.info(self.vapi.cli("show bridge-domain 13 detail"))
247 self.logger.info(self.vapi.cli("show int"))
248 self.logger.info(self.vapi.cli("show vxlan-gpe"))
249 self.logger.info(self.vapi.cli("show trace"))
252 if __name__ == '__main__':
253 unittest.main(testRunner=VppTestRunner)