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, Raw
10 from scapy.layers.inet import IP, UDP
11 from scapy.layers.vxlan import VXLAN
12 from scapy.utils import atol
13 from vpp_ip_route import VppIpRoute, VppRoutePath
14 from vpp_ip import INVALID_INDEX
17 class TestVxlanGbp(VppTestCase):
18 """ VXLAN GBP Test Case """
21 def frame_request(self):
22 """ Ethernet frame modeling a generic request """
23 return (Ether(src='00:00:00:00:00:01', dst='00:00:00:00:00:02') /
24 IP(src='1.2.3.4', dst='4.3.2.1') /
25 UDP(sport=10000, dport=20000) /
29 def frame_reply(self):
30 """ Ethernet frame modeling a generic reply """
31 return (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
32 IP(src='4.3.2.1', dst='1.2.3.4') /
33 UDP(sport=20000, dport=10000) /
36 def encapsulate(self, pkt, vni):
38 Encapsulate the original payload frame by adding VXLAN GBP header with
39 its UDP, IP and Ethernet fields
41 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
42 IP(src=self.pg0.remote_ip4, dst=self.pg0.local_ip4) /
43 UDP(sport=self.dport, dport=self.dport, chksum=0) /
44 VXLAN(vni=vni, flags=self.flags, gpflags=self.gpflags,
45 gpid=self.sclass) / pkt)
47 def ip_range(self, start, end):
48 """ range of remote ip's """
49 return ip4_range(self.pg0.remote_ip4, start, end)
51 def decapsulate(self, pkt):
53 Decapsulate the original payload frame by removing VXLAN header
55 # check if is set G and I flag
56 self.assertEqual(pkt[VXLAN].flags, int('0x88', 16))
57 return pkt[VXLAN].payload
59 # Method for checking VXLAN GBP encapsulation.
61 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
62 # TODO: add error messages
63 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
65 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
68 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
70 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
71 # Verify VXLAN GBP tunnel source IP is VPP_IP and destination IP is
73 self.assertEqual(pkt[IP].src, self.pg0.local_ip4)
76 self.assertEqual(pkt[IP].dst, self.pg0.remote_ip4)
78 self.assertEqual(pkt[IP].dst, type(self).mcast_ip4)
79 # Verify UDP destination port is VXLAN GBP 48879, source UDP port could
81 self.assertEqual(pkt[UDP].dport, type(self).dport)
82 # TODO: checksum check
85 self.assertEqual(pkt[VXLAN].vni, vni)
87 self.assertEqual(pkt[VXLAN].gpid, 0)
90 def create_vxlan_gbp_flood_test_bd(cls, vni, n_ucast_tunnels):
91 # Create 2 ucast vxlan tunnels under bd
93 ip_range_end = ip_range_start + n_ucast_tunnels
94 next_hop_address = cls.pg0.remote_ip4
95 for dest_ip4 in ip4_range(cls.pg0.remote_ip4,
98 # add host route so dest_ip4n will not be resolved
99 rip = VppIpRoute(cls, dest_ip4, 32,
100 [VppRoutePath(next_hop_address,
104 r = cls.vapi.vxlan_gbp_tunnel_add_del(
106 'src': cls.pg0.local_ip4,
109 'instance': INVALID_INDEX,
110 'mcast_sw_if_index': INVALID_INDEX,
115 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
118 # Class method to start the VXLAN GBP test case.
119 # Overrides setUpClass method in VppTestCase class.
120 # Python try..except statement is used to ensure that the tear down of
121 # the class will be executed even if exception is raised.
122 # @param cls The class pointer.
125 super(TestVxlanGbp, cls).setUpClass()
133 # Create 2 pg interfaces.
134 cls.create_pg_interfaces(range(4))
135 for pg in cls.pg_interfaces:
138 # Configure IPv4 addresses on VPP pg0.
141 # Resolve MAC address for VPP's IP address on pg0.
142 cls.pg0.resolve_arp()
144 # Create VXLAN GBP VTEP on VPP pg0, and put vxlan_gbp_tunnel0 and
146 cls.single_tunnel_bd = 1
147 r = cls.vapi.vxlan_gbp_tunnel_add_del(
149 'src': cls.pg0.local_ip4,
150 'dst': cls.pg0.remote_ip4,
151 'vni': cls.single_tunnel_bd,
152 'instance': INVALID_INDEX,
153 'mcast_sw_if_index': INVALID_INDEX,
158 cls.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
159 bd_id=cls.single_tunnel_bd)
160 cls.vapi.sw_interface_set_l2_bridge(
161 rx_sw_if_index=cls.pg1.sw_if_index,
162 bd_id=cls.single_tunnel_bd)
164 # Setup vni 2 to test multicast flooding
165 cls.n_ucast_tunnels = 2
166 # Setup vni 3 to test unicast flooding
167 cls.ucast_flood_bd = 3
168 cls.create_vxlan_gbp_flood_test_bd(cls.ucast_flood_bd,
170 cls.vapi.sw_interface_set_l2_bridge(
171 rx_sw_if_index=cls.pg3.sw_if_index,
172 bd_id=cls.ucast_flood_bd)
174 super(TestVxlanGbp, cls).tearDownClass()
178 def tearDownClass(cls):
179 super(TestVxlanGbp, cls).tearDownClass()
181 def assert_eq_pkts(self, pkt1, pkt2):
182 """ Verify the Ether, IP, UDP, payload are equal in both
185 self.assertEqual(pkt1[Ether].src, pkt2[Ether].src)
186 self.assertEqual(pkt1[Ether].dst, pkt2[Ether].dst)
187 self.assertEqual(pkt1[IP].src, pkt2[IP].src)
188 self.assertEqual(pkt1[IP].dst, pkt2[IP].dst)
189 self.assertEqual(pkt1[UDP].sport, pkt2[UDP].sport)
190 self.assertEqual(pkt1[UDP].dport, pkt2[UDP].dport)
191 self.assertEqual(pkt1[Raw], pkt2[Raw])
193 def test_decap(self):
194 """ Decapsulation test
195 Send encapsulated frames from pg0
196 Verify receipt of decapsulated frames on pg1
198 encapsulated_pkt = self.encapsulate(self.frame_request,
199 self.single_tunnel_bd)
201 self.pg0.add_stream([encapsulated_pkt, ])
203 self.pg1.enable_capture()
207 # Pick first received frame and check if it's the non-encapsulated
209 out = self.pg1.get_capture(1)
211 self.assert_eq_pkts(pkt, self.frame_request)
213 def test_encap(self):
214 """ Encapsulation test
216 Verify receipt of encapsulated frames on pg0
218 self.pg1.add_stream([self.frame_reply])
220 self.pg0.enable_capture()
224 # Pick first received frame and check if it's correctly encapsulated.
225 out = self.pg0.get_capture(1)
227 self.check_encapsulation(pkt, self.single_tunnel_bd)
229 payload = self.decapsulate(pkt)
230 self.assert_eq_pkts(payload, self.frame_reply)
232 def test_ucast_flood(self):
233 """ Unicast flood test
235 Verify receipt of encapsulated frames on pg0
237 self.pg3.add_stream([self.frame_reply])
239 self.pg0.enable_capture()
243 # Get packet from each tunnel and assert it's correctly encapsulated.
244 out = self.pg0.get_capture(self.n_ucast_tunnels)
246 self.check_encapsulation(pkt, self.ucast_flood_bd, True)
247 payload = self.decapsulate(pkt)
248 self.assert_eq_pkts(payload, self.frame_reply)
250 def test_encap_big_packet(self):
251 """ Encapsulation test send big frame from pg1
252 Verify receipt of encapsulated frames on pg0
255 self.vapi.sw_interface_set_mtu(self.pg0.sw_if_index, [1500, 0, 0, 0])
257 frame = (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
258 IP(src='4.3.2.1', dst='1.2.3.4') /
259 UDP(sport=20000, dport=10000) /
262 self.pg1.add_stream([frame])
264 self.pg0.enable_capture()
268 # Pick first received frame and check if it's correctly encapsulated.
269 out = self.pg0.get_capture(2)
270 pkt = reassemble4_ether(out)
271 self.check_encapsulation(pkt, self.single_tunnel_bd)
273 payload = self.decapsulate(pkt)
274 self.assert_eq_pkts(payload, frame)
276 # Method to define VPP actions before tear down of the test case.
277 # Overrides tearDown method in VppTestCase class.
278 # @param self The object pointer.
280 super(TestVxlanGbp, self).tearDown()
282 def show_commands_at_teardown(self):
283 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
284 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
285 self.logger.info(self.vapi.cli("show vxlan-gbp tunnel"))
286 self.logger.info(self.vapi.cli("show error"))
289 if __name__ == '__main__':
290 unittest.main(testRunner=VppTestRunner)