5 from framework import VppTestCase, VppTestRunner
6 from template_bd import BridgeDomain
8 from scapy.layers.l2 import Ether
9 from scapy.packet import Raw, bind_layers
10 from scapy.layers.inet6 import IP, IPv6, UDP
11 from scapy.layers.vxlan import VXLAN
14 from vpp_ip_route import VppIpRoute, VppRoutePath
15 from vpp_vxlan_tunnel import VppVxlanTunnel
16 from vpp_ip import INVALID_INDEX
19 class TestVxlan6(BridgeDomain, VppTestCase):
20 """ VXLAN over IPv6 Test Case """
22 def __init__(self, *args):
23 BridgeDomain.__init__(self)
24 VppTestCase.__init__(self, *args)
26 def encapsulate(self, pkt, vni):
28 Encapsulate the original payload frame by adding VXLAN header with its
29 UDP, IP and Ethernet fields
31 return (Ether(src=self.pg0.remote_mac, dst=self.pg0.local_mac) /
32 IPv6(src=self.pg0.remote_ip6, dst=self.pg0.local_ip6) /
33 UDP(sport=self.dport, dport=self.dport, chksum=0) /
34 VXLAN(vni=vni, flags=self.flags) /
38 def ip_range(cls, s, e):
39 """ range of remote ip's """
40 tmp = cls.pg0.remote_ip6.rsplit(':', 1)[0]
41 return ("%s:%x" % (tmp, i) for i in range(s, e))
43 def encap_mcast(self, pkt, src_ip, src_mac, vni):
45 Encapsulate the original payload frame by adding VXLAN header with its
46 UDP, IP and Ethernet fields
48 return (Ether(src=src_mac, dst=self.mcast_mac) /
49 IPv6(src=src_ip, dst=self.mcast_ip6) /
50 UDP(sport=self.dport, dport=self.dport, chksum=0) /
51 VXLAN(vni=vni, flags=self.flags) /
54 def decapsulate(self, pkt):
56 Decapsulate the original payload frame by removing VXLAN header
58 # check if is set I flag
59 self.assertEqual(pkt[VXLAN].flags, int('0x8', 16))
60 return pkt[VXLAN].payload
62 # Method for checking VXLAN encapsulation.
64 def check_encapsulation(self, pkt, vni, local_only=False, mcast_pkt=False):
65 # TODO: add error messages
66 # Verify source MAC is VPP_MAC and destination MAC is MY_MAC resolved
68 self.assertEqual(pkt[Ether].src, self.pg0.local_mac)
71 self.assertEqual(pkt[Ether].dst, self.pg0.remote_mac)
73 self.assertEqual(pkt[Ether].dst, type(self).mcast_mac)
74 # Verify VXLAN tunnel source IP is VPP_IP and destination IP is MY_IP.
75 self.assertEqual(pkt[IPv6].src, self.pg0.local_ip6)
78 self.assertEqual(pkt[IPv6].dst, self.pg0.remote_ip6)
80 self.assertEqual(pkt[IPv6].dst, type(self).mcast_ip6)
81 # Verify UDP destination port is VXLAN 4789, source UDP port could be
83 self.assertEqual(pkt[UDP].dport, self.dport)
85 self.assert_udp_checksum_valid(pkt, ignore_zero_checksum=False)
87 self.assertEqual(pkt[VXLAN].vni, vni)
90 def create_vxlan_flood_test_bd(cls, vni, n_ucast_tunnels, port):
91 # Create 10 ucast vxlan tunnels under bd
93 end = start + n_ucast_tunnels
94 for dest_ip6 in cls.ip_range(start, end):
95 # add host route so dest ip will not be resolved
96 rip = VppIpRoute(cls, dest_ip6, 128,
97 [VppRoutePath(cls.pg0.remote_ip6, INVALID_INDEX)],
100 r = VppVxlanTunnel(cls, src=cls.pg0.local_ip6,
101 src_port=port, dst_port=port,
102 dst=dest_ip6, vni=vni)
104 cls.vapi.sw_interface_set_l2_bridge(r.sw_if_index, bd_id=vni)
107 def add_mcast_tunnels_load(cls):
108 cls.add_del_mcast_tunnels_load(is_add=1)
111 def del_mcast_tunnels_load(cls):
112 cls.add_del_mcast_tunnels_load(is_add=0)
114 # Class method to start the VXLAN test case.
115 # Overrides setUpClass method in VppTestCase class.
116 # Python try..except statement is used to ensure that the tear down of
117 # the class will be executed even if exception is raised.
118 # @param cls The class pointer.
121 super(TestVxlan6, cls).setUpClass()
126 # Create 2 pg interfaces.
127 cls.create_pg_interfaces(range(4))
128 for pg in cls.pg_interfaces:
131 # Configure IPv6 addresses on VPP pg0.
134 # Resolve MAC address for VPP's IP address on pg0.
135 cls.pg0.resolve_ndp()
137 # Our Multicast address
138 cls.mcast_ip6 = 'ff0e::1'
139 cls.mcast_mac = util.mcast_ip_to_mac(cls.mcast_ip6)
141 super(TestVxlan6, cls).tearDownClass()
145 def tearDownClass(cls):
146 super(TestVxlan6, cls).tearDownClass()
149 super(TestVxlan6, self).setUp()
151 def createVxLANInterfaces(self, port=4789):
152 # Create VXLAN VTEP on VPP pg0, and put vxlan_tunnel0 and pg1
156 self.single_tunnel_vni = 0x12345
157 self.single_tunnel_bd = 1
158 r = VppVxlanTunnel(self, src=self.pg0.local_ip6,
159 dst=self.pg0.remote_ip6,
160 src_port=self.dport, dst_port=self.dport,
161 vni=self.single_tunnel_vni)
163 self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
164 bd_id=self.single_tunnel_bd)
165 self.vapi.sw_interface_set_l2_bridge(
166 rx_sw_if_index=self.pg1.sw_if_index, bd_id=self.single_tunnel_bd)
168 # Setup vni 2 to test multicast flooding
169 self.n_ucast_tunnels = 10
170 self.mcast_flood_bd = 2
171 self.create_vxlan_flood_test_bd(self.mcast_flood_bd,
172 self.n_ucast_tunnels,
174 r = VppVxlanTunnel(self, src=self.pg0.local_ip6, dst=self.mcast_ip6,
175 src_port=self.dport, dst_port=self.dport,
176 mcast_sw_if_index=1, vni=self.mcast_flood_bd)
178 self.vapi.sw_interface_set_l2_bridge(rx_sw_if_index=r.sw_if_index,
179 bd_id=self.mcast_flood_bd)
180 self.vapi.sw_interface_set_l2_bridge(
181 rx_sw_if_index=self.pg2.sw_if_index, bd_id=self.mcast_flood_bd)
183 # Setup vni 3 to test unicast flooding
184 self.ucast_flood_bd = 3
185 self.create_vxlan_flood_test_bd(self.ucast_flood_bd,
186 self.n_ucast_tunnels,
188 self.vapi.sw_interface_set_l2_bridge(
189 rx_sw_if_index=self.pg3.sw_if_index, bd_id=self.ucast_flood_bd)
191 # Set scapy listen custom port for VxLAN
192 bind_layers(UDP, VXLAN, dport=self.dport)
194 # Method to define VPP actions before tear down of the test case.
195 # Overrides tearDown method in VppTestCase class.
196 # @param self The object pointer.
198 super(TestVxlan6, self).tearDown()
200 def show_commands_at_teardown(self):
201 self.logger.info(self.vapi.cli("show bridge-domain 1 detail"))
202 self.logger.info(self.vapi.cli("show bridge-domain 2 detail"))
203 self.logger.info(self.vapi.cli("show bridge-domain 3 detail"))
204 self.logger.info(self.vapi.cli("show vxlan tunnel"))
206 def encap_fragmented_packet(self):
207 frame = (Ether(src='00:00:00:00:00:02', dst='00:00:00:00:00:01') /
208 IP(src='4.3.2.1', dst='1.2.3.4') /
209 UDP(sport=20000, dport=10000) /
212 frags = util.fragment_rfc791(frame, 400)
214 self.pg1.add_stream(frags)
216 self.pg0.enable_capture()
220 out = self.pg0.get_capture(3)
224 payload.append(self.decapsulate(pkt))
225 self.check_encapsulation(pkt, self.single_tunnel_vni)
227 reassembled = util.reassemble4(payload)
229 self.assertEqual(Ether(raw(frame))[IP], reassembled[IP])
232 Tests with default port (4789)
234 def test_decap(self):
235 """ Decapsulation test
238 self.createVxLANInterfaces()
239 super(TestVxlan6, self).test_decap()
241 def test_encap(self):
242 """ Encapsulation test
245 self.createVxLANInterfaces()
246 super(TestVxlan6, self).test_encap()
248 def test_encap_fragmented_packet(self):
249 """ Encapsulation test send fragments from pg1
250 Verify receipt of encapsulated frames on pg0
252 self.createVxLANInterfaces()
253 self.encap_fragmented_packet()
255 def test_ucast_flood(self):
256 """ Unicast flood test
259 self.createVxLANInterfaces()
260 super(TestVxlan6, self).test_ucast_flood()
262 def test_mcast_flood(self):
263 """ Multicast flood test
266 self.createVxLANInterfaces()
267 super(TestVxlan6, self).test_mcast_flood()
269 def test_mcast_rcv(self):
270 """ Multicast receive test
273 self.createVxLANInterfaces()
274 super(TestVxlan6, self).test_mcast_rcv()
277 Tests with custom port
279 def test_decap_custom_port(self):
280 """ Decapsulation test custom port
283 self.createVxLANInterfaces(1111)
284 super(TestVxlan6, self).test_decap()
286 def test_encap_custom_port(self):
287 """ Encapsulation test custom port
290 self.createVxLANInterfaces(1111)
291 super(TestVxlan6, self).test_encap()
293 def test_ucast_flood_custom_port(self):
294 """ Unicast flood test custom port
297 self.createVxLANInterfaces(1111)
298 super(TestVxlan6, self).test_ucast_flood()
300 def test_mcast_flood_custom_port(self):
301 """ Multicast flood test custom port
304 self.createVxLANInterfaces(1111)
305 super(TestVxlan6, self).test_mcast_flood()
307 def test_mcast_rcv_custom_port(self):
308 """ Multicast receive test custom port
311 self.createVxLANInterfaces(1111)
312 super(TestVxlan6, self).test_mcast_rcv()
315 if __name__ == '__main__':
316 unittest.main(testRunner=VppTestRunner)