4 from util import ip4_range, reassemble4_ether
6 from framework import VppTestCase, VppTestRunner
7 from template_bd import BridgeDomain
9 from scapy.layers.l2 import Ether
10 from scapy.packet import Raw
11 from scapy.layers.inet import IP, UDP
12 from scapy.layers.vxlan import VXLAN
14 from vpp_ip_route import VppIpRoute, VppRoutePath
15 from vpp_ip import INVALID_INDEX
18 class TestVxlanGbp(VppTestCase):
19 """ VXLAN GBP Test Case """
22 def frame_request(self):
23 """ Ethernet frame modeling a generic request """
24 return (Ether(src='00:00:00:00:00:01', dst='00:00:00:00:00:02') /
25 IP(src='1.2.3.4', dst='4.3.2.1') /
26 UDP(sport=10000, dport=20000) /
30 def frame_reply(self):
31 """ Ethernet frame modeling a generic reply """
32 return (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
33 IP(src='4.3.2.1', dst='1.2.3.4') /
34 UDP(sport=20000, dport=10000) /
37 def encapsulate(self, pkt, vni):
39 Encapsulate the original payload frame by adding VXLAN GBP header with
40 its UDP, IP and Ethernet fields
42 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
43 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
44 UDP(sport=self.dport, dport=self.dport, chksum=0) /
45 VXLAN(vni=vni, flags=self.flags, gpflags=self.gpflags,
46 gpid=self.sclass) / pkt)
48 def ip_range(self, start, end):
49 """ range of remote ip's """
50 return ip4_range(self.pg0.remote_ip4, start, end)
52 def decapsulate(self, pkt):
54 Decapsulate the original payload frame by removing VXLAN header
56 # check if is set G and I flag
57 self.assertEqual(pkt[VXLAN].flags, int('0x88', 16))
58 return pkt[VXLAN].payload
60 # Method for checking VXLAN GBP encapsulation.
62 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
63 # TODO: add error messages
64 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
66 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
69 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
71 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
72 # Verify VXLAN GBP tunnel source IP is VPP_IP and destination IP is
74 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
77 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
79 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
80 # Verify UDP destination port is VXLAN GBP 48879, source UDP port could
82 self.assertEqual(pkt[UDP].dport, type(self).dport)
83 # TODO: checksum check
86 self.assertEqual(pkt[VXLAN].vni, vni)
88 self.assertEqual(pkt[VXLAN].gpid, 0)
91 def create_vxlan_gbp_flood_test_bd(cls, vni, n_ucast_tunnels):
92 # Create 2 ucast vxlan tunnels under bd
94 ip_range_end = ip_range_start + n_ucast_tunnels
95 next_hop_address = cls.pg0.remote_ip4
96 for dest_ip4 in ip4_range(cls.pg0.remote_ip4,
99 # add host route so dest_ip4 will not be resolved
100 rip = VppIpRoute(cls, dest_ip4, 32,
101 [VppRoutePath(next_hop_address,
105 r = cls.vapi.vxlan_gbp_tunnel_add_del(
107 'src': cls.pg0.local_ip4,
110 'instance': INVALID_INDEX,
111 'mcast_sw_if_index': INVALID_INDEX,
116 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
119 # Class method to start the VXLAN GBP test case.
120 # Overrides setUpClass method in VppTestCase class.
121 # Python try..except statement is used to ensure that the tear down of
122 # the class will be executed even if exception is raised.
123 # @param cls The class pointer.
126 super(TestVxlanGbp, cls).setUpClass()
134 # Create 2 pg interfaces.
135 cls.create_pg_interfaces(range(4))
136 for pg in cls.pg_interfaces:
139 # Configure IPv4 addresses on VPP pg0.
142 # Resolve MAC address for VPP's IP address on pg0.
143 cls.pg0.resolve_arp()
145 # Create VXLAN GBP VTEP on VPP pg0, and put vxlan_gbp_tunnel0 and
147 cls.single_tunnel_bd = 1
148 cls.single_tunnel_vni = 0xabcde
149 r = cls.vapi.vxlan_gbp_tunnel_add_del(
151 'src': cls.pg0.local_ip4,
152 'dst': cls.pg0.remote_ip4,
153 'vni': cls.single_tunnel_vni,
154 'instance': INVALID_INDEX,
155 'mcast_sw_if_index': INVALID_INDEX,
160 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
161 bd_id=cls.single_tunnel_bd)
162 cls.vapi.sw_interface_set_l2_bridge(
163 rx_sw_if_index=cls.pg1.sw_if_index,
164 bd_id=cls.single_tunnel_bd)
166 # Setup vni 2 to test multicast flooding
167 cls.n_ucast_tunnels = 2
168 # Setup vni 3 to test unicast flooding
169 cls.ucast_flood_bd = 3
170 cls.create_vxlan_gbp_flood_test_bd(cls.ucast_flood_bd,
172 cls.vapi.sw_interface_set_l2_bridge(
173 rx_sw_if_index=cls.pg3.sw_if_index,
174 bd_id=cls.ucast_flood_bd)
176 super(TestVxlanGbp, cls).tearDownClass()
180 def tearDownClass(cls):
181 super(TestVxlanGbp, cls).tearDownClass()
183 def assert_eq_pkts(self, pkt1, pkt2):
184 """ Verify the Ether, IP, UDP, payload are equal in both
187 self.assertEqual(pkt1[Ether].src, pkt2[Ether].src)
188 self.assertEqual(pkt1[Ether].dst, pkt2[Ether].dst)
189 self.assertEqual(pkt1[IP].src, pkt2[IP].src)
190 self.assertEqual(pkt1[IP].dst, pkt2[IP].dst)
191 self.assertEqual(pkt1[UDP].sport, pkt2[UDP].sport)
192 self.assertEqual(pkt1[UDP].dport, pkt2[UDP].dport)
193 self.assertEqual(pkt1[Raw], pkt2[Raw])
195 def test_decap(self):
196 """ Decapsulation test
197 Send encapsulated frames from pg0
198 Verify receipt of decapsulated frames on pg1
200 encapsulated_pkt = self.encapsulate(self.frame_request,
201 self.single_tunnel_vni)
203 self.pg0.add_stream([encapsulated_pkt, ])
205 self.pg1.enable_capture()
209 # Pick first received frame and check if it's the non-encapsulated
211 out = self.pg1.get_capture(1)
213 self.assert_eq_pkts(pkt, self.frame_request)
215 def test_encap(self):
216 """ Encapsulation test
218 Verify receipt of encapsulated frames on pg0
220 self.pg1.add_stream([self.frame_reply])
222 self.pg0.enable_capture()
226 # Pick first received frame and check if it's correctly encapsulated.
227 out = self.pg0.get_capture(1)
229 self.check_encapsulation(pkt, self.single_tunnel_vni)
231 payload = self.decapsulate(pkt)
232 self.assert_eq_pkts(payload, self.frame_reply)
234 def test_ucast_flood(self):
235 """ Unicast flood test
237 Verify receipt of encapsulated frames on pg0
239 self.pg3.add_stream([self.frame_reply])
241 self.pg0.enable_capture()
245 # Get packet from each tunnel and assert it's correctly encapsulated.
246 out = self.pg0.get_capture(self.n_ucast_tunnels)
248 self.check_encapsulation(pkt, self.ucast_flood_bd, True)
249 payload = self.decapsulate(pkt)
250 self.assert_eq_pkts(payload, self.frame_reply)
252 def test_encap_big_packet(self):
253 """ Encapsulation test send big frame from pg1
254 Verify receipt of encapsulated frames on pg0
257 self.vapi.sw_interface_set_mtu(self.pg0.sw_if_index, [1500, 0, 0, 0])
259 frame = (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
260 IP(src='4.3.2.1', dst='1.2.3.4') /
261 UDP(sport=20000, dport=10000) /
264 self.pg1.add_stream([frame])
266 self.pg0.enable_capture()
270 # Pick first received frame and check if it's correctly encapsulated.
271 out = self.pg0.get_capture(2)
272 pkt = reassemble4_ether(out)
273 self.check_encapsulation(pkt, self.single_tunnel_vni)
275 payload = self.decapsulate(pkt)
276 self.assert_eq_pkts(payload, frame)
278 # Method to define VPP actions before tear down of the test case.
279 # Overrides tearDown method in VppTestCase class.
280 # @param self The object pointer.
282 super(TestVxlanGbp, self).tearDown()
284 def show_commands_at_teardown(self):
285 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
286 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
287 self.logger.info(self.vapi.cli("show vxlan-gbp tunnel"))
288 self.logger.info(self.vapi.cli("show error"))
291 if __name__ == '__main__':
292 unittest.main(testRunner=VppTestRunner)