4 from util import ip4n_range, ip4_range
6 from framework import VppTestCase, VppTestRunner
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether
10 from scapy.layers.inet import IP, UDP
11 from scapy.layers.vxlan import VXLAN
12 from scapy.utils import atol
15 class TestVxlan(BridgeDomain, VppTestCase):
16 """ VXLAN Test Case """
18 def __init__(self, *args):
19 BridgeDomain.__init__(self)
20 VppTestCase.__init__(self, *args)
22 def encapsulate(self, pkt, vni):
24 Encapsulate the original payload frame by adding VXLAN header with its
25 UDP, IP and Ethernet fields
27 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
28 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
29 UDP(sport=self.dport, dport=self.dport, chksum=0) /
30 VXLAN(vni=vni, flags=self.flags) /
33 def ip_range(self, start, end):
34 """ range of remote ip's """
35 return ip4_range(self.pg0.remote_ip4, start, end)
37 def encap_mcast(self, pkt, src_ip, src_mac, vni):
39 Encapsulate the original payload frame by adding VXLAN header with its
40 UDP, IP and Ethernet fields
42 return (Ether(src=src_mac, dst=self.mcast_mac) /
43 IP(src=src_ip, dst=self.mcast_ip4) /
44 UDP(sport=self.dport, dport=self.dport, chksum=0) /
45 VXLAN(vni=vni, flags=self.flags) /
48 def decapsulate(self, pkt):
50 Decapsulate the original payload frame by removing VXLAN header
52 # check if is set I flag
53 self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
54 return pkt[VXLAN].payload
56 # Method for checking VXLAN encapsulation.
58 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
59 # TODO: add error messages
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 tunnel source IP is VPP_IP and destination 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 4789, source UDP port could be
77 self.assertEqual(pkt[UDP].dport, type(self).dport)
78 # TODO: checksum check
80 self.assertEqual(pkt[VXLAN].vni, vni)
83 def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels):
84 # Create 10 ucast vxlan tunnels under bd
86 ip_range_end = ip_range_start + n_ucast_tunnels
87 next_hop_address = cls.pg0.remote_ip4n
88 for dest_ip4n in ip4n_range(next_hop_address, ip_range_start,
90 # add host route so dest_ip4n will not be resolved
91 cls.vapi.ip_add_del_route(dest_ip4n, 32, next_hop_address)
92 r = cls.vapi.vxlan_add_del_tunnel(
93 src_addr=cls.pg0.local_ip4n,
96 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
99 def add_del_shared_mcast_dst_load(cls, is_add):
101 add or del tunnels sharing the same mcast dst
102 to test vxlan ref_count mechanism
104 n_shared_dst_tunnels = 20
106 vni_end = vni_start + n_shared_dst_tunnels
107 for vni in range(vni_start, vni_end):
108 r = cls.vapi.vxlan_add_del_tunnel(
109 src_addr=cls.pg0.local_ip4n,
110 dst_addr=cls.mcast_ip4n,
114 if r.sw_if_index == 0xffffffff:
115 raise "bad sw_if_index"
118 def add_shared_mcast_dst_load(cls):
119 cls.add_del_shared_mcast_dst_load(is_add=1)
122 def del_shared_mcast_dst_load(cls):
123 cls.add_del_shared_mcast_dst_load(is_add=0)
126 def add_del_mcast_tunnels_load(cls, is_add):
128 add or del tunnels to test vxlan stability
130 n_distinct_dst_tunnels = 200
132 ip_range_end = ip_range_start + n_distinct_dst_tunnels
133 for dest_ip4n in ip4n_range(cls.mcast_ip4n, ip_range_start,
135 vni = bytearray(dest_ip4n)[3]
136 cls.vapi.vxlan_add_del_tunnel(
137 src_addr=cls.pg0.local_ip4n,
144 def add_mcast_tunnels_load(cls):
145 cls.add_del_mcast_tunnels_load(is_add=1)
148 def del_mcast_tunnels_load(cls):
149 cls.add_del_mcast_tunnels_load(is_add=0)
151 # Class method to start the VXLAN test case.
152 # Overrides setUpClass method in VppTestCase class.
153 # Python try..except statement is used to ensure that the tear down of
154 # the class will be executed even if exception is raised.
155 # @param cls The class pointer.
158 super(TestVxlan, cls).setUpClass()
164 # Create 2 pg interfaces.
165 cls.create_pg_interfaces(range(4))
166 for pg in cls.pg_interfaces:
169 # Configure IPv4 addresses on VPP pg0.
172 # Resolve MAC address for VPP's IP address on pg0.
173 cls.pg0.resolve_arp()
175 # Our Multicast address
176 cls.mcast_ip4 = '239.1.1.1'
177 cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
178 iplong = atol(cls.mcast_ip4)
179 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
180 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
182 # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
184 cls.single_tunnel_bd = 1
185 r = cls.vapi.vxlan_add_del_tunnel(
186 src_addr=cls.pg0.local_ip4n,
187 dst_addr=cls.pg0.remote_ip4n,
188 vni=cls.single_tunnel_bd)
189 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
190 bd_id=cls.single_tunnel_bd)
191 cls.vapi.sw_interface_set_l2_bridge(cls.pg1.sw_if_index,
192 bd_id=cls.single_tunnel_bd)
194 # Setup vni 2 to test multicast flooding
195 cls.n_ucast_tunnels = 10
196 cls.mcast_flood_bd = 2
197 cls.create_vxlan_flood_test_bd(cls.mcast_flood_bd,
199 r = cls.vapi.vxlan_add_del_tunnel(
200 src_addr=cls.pg0.local_ip4n,
201 dst_addr=cls.mcast_ip4n,
203 vni=cls.mcast_flood_bd)
204 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index,
205 bd_id=cls.mcast_flood_bd)
206 cls.vapi.sw_interface_set_l2_bridge(cls.pg2.sw_if_index,
207 bd_id=cls.mcast_flood_bd)
209 # Add and delete mcast tunnels to check stability
210 cls.add_shared_mcast_dst_load()
211 cls.add_mcast_tunnels_load()
212 cls.del_shared_mcast_dst_load()
213 cls.del_mcast_tunnels_load()
215 # Setup vni 3 to test unicast flooding
216 cls.ucast_flood_bd = 3
217 cls.create_vxlan_flood_test_bd(cls.ucast_flood_bd,
219 cls.vapi.sw_interface_set_l2_bridge(cls.pg3.sw_if_index,
220 bd_id=cls.ucast_flood_bd)
222 super(TestVxlan, cls).tearDownClass()
225 # Method to define VPP actions before tear down of the test case.
226 # Overrides tearDown method in VppTestCase class.
227 # @param self The object pointer.
229 super(TestVxlan, self).tearDown()
230 if not self.vpp_dead:
231 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
232 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
233 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
234 self.logger.info(self.vapi.cli("show vxlan tunnel"))
237 if __name__ == '__main__':
238 unittest.main(testRunner=VppTestRunner)