4 from util import ip4n_range, ip4_range, reassemble4
6 from framework import VppTestCase, VppTestRunner
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 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(dst_address=dest_ip4n,
92 dst_address_length=32,
93 next_hop_address=next_hop_address)
94 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
95 dst_address=dest_ip4n, vni=vni)
96 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
100 def add_del_shared_mcast_dst_load(cls, is_add):
102 add or del tunnels sharing the same mcast dst
103 to test vxlan ref_count mechanism
105 n_shared_dst_tunnels = 20
107 vni_end = vni_start + n_shared_dst_tunnels
108 for vni in range(vni_start, vni_end):
109 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
110 dst_address=cls.mcast_ip4n,
112 is_add=is_add, vni=vni)
113 if r.sw_if_index == 0xffffffff:
114 raise ValueError("bad sw_if_index: ~0")
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 stability
129 n_distinct_dst_tunnels = 200
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_add_del_tunnel(src_address=cls.pg0.local_ip4n,
136 dst_address=dest_ip4n,
137 mcast_sw_if_index=1, is_add=is_add,
141 def add_mcast_tunnels_load(cls):
142 cls.add_del_mcast_tunnels_load(is_add=1)
145 def del_mcast_tunnels_load(cls):
146 cls.add_del_mcast_tunnels_load(is_add=0)
148 # Class method to start the VXLAN test case.
149 # Overrides setUpClass method in VppTestCase class.
150 # Python try..except statement is used to ensure that the tear down of
151 # the class will be executed even if exception is raised.
152 # @param cls The class pointer.
155 super(TestVxlan, cls).setUpClass()
161 # Create 2 pg interfaces.
162 cls.create_pg_interfaces(range(4))
163 for pg in cls.pg_interfaces:
166 # Configure IPv4 addresses on VPP pg0.
169 # Resolve MAC address for VPP's IP address on pg0.
170 cls.pg0.resolve_arp()
172 # Our Multicast address
173 cls.mcast_ip4 = '239.1.1.1'
174 cls.mcast_ip4n = socket.inet_pton(socket.AF_INET, cls.mcast_ip4)
175 iplong = atol(cls.mcast_ip4)
176 cls.mcast_mac = "01:00:5e:%02x:%02x:%02x" % (
177 (iplong >> 16) & 0x7F, (iplong >> 8) & 0xFF, iplong & 0xFF)
179 # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
181 cls.single_tunnel_bd = 1
182 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
183 dst_address=cls.pg0.remote_ip4n,
184 vni=cls.single_tunnel_bd)
185 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
186 bd_id=cls.single_tunnel_bd)
187 cls.vapi.sw_interface_set_l2_bridge(
188 rx_sw_if_index=cls.pg1.sw_if_index, bd_id=cls.single_tunnel_bd)
190 # Setup vni 2 to test multicast flooding
191 cls.n_ucast_tunnels = 10
192 cls.mcast_flood_bd = 2
193 cls.create_vxlan_flood_test_bd(cls.mcast_flood_bd,
195 r = cls.vapi.vxlan_add_del_tunnel(src_address=cls.pg0.local_ip4n,
196 dst_address=cls.mcast_ip4n,
198 vni=cls.mcast_flood_bd)
199 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
200 bd_id=cls.mcast_flood_bd)
201 cls.vapi.sw_interface_set_l2_bridge(
202 rx_sw_if_index=cls.pg2.sw_if_index, bd_id=cls.mcast_flood_bd)
204 # Add and delete mcast tunnels to check stability
205 cls.add_shared_mcast_dst_load()
206 cls.add_mcast_tunnels_load()
207 cls.del_shared_mcast_dst_load()
208 cls.del_mcast_tunnels_load()
210 # Setup vni 3 to test unicast flooding
211 cls.ucast_flood_bd = 3
212 cls.create_vxlan_flood_test_bd(cls.ucast_flood_bd,
214 cls.vapi.sw_interface_set_l2_bridge(
215 rx_sw_if_index=cls.pg3.sw_if_index, bd_id=cls.ucast_flood_bd)
217 super(TestVxlan, cls).tearDownClass()
221 def tearDownClass(cls):
222 super(TestVxlan, cls).tearDownClass()
224 def test_encap_big_packet(self):
225 """ Encapsulation test send big frame from pg1
226 Verify receipt of encapsulated frames on pg0
229 self.vapi.sw_interface_set_mtu(self.pg0.sw_if_index, [1500, 0, 0, 0])
231 frame = (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
232 IP(src='4.3.2.1', dst='1.2.3.4') /
233 UDP(sport=20000, dport=10000) /
236 self.pg1.add_stream([frame])
238 self.pg0.enable_capture()
242 # Pick first received frame and check if it's correctly encapsulated.
243 out = self.pg0.get_capture(2)
245 pkt = reassemble4(out)
247 self.check_encapsulation(pkt, self.single_tunnel_bd)
249 payload = self.decapsulate(pkt)
251 # self.assert_eq_pkts(payload, frame)
253 # Method to define VPP actions before tear down of the test case.
254 # Overrides tearDown method in VppTestCase class.
255 # @param self The object pointer.
257 super(TestVxlan, self).tearDown()
259 def show_commands_at_teardown(self):
260 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
261 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
262 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
263 self.logger.info(self.vapi.cli("show vxlan tunnel"))
266 if __name__ == '__main__':
267 unittest.main(testRunner=VppTestRunner)