2 """IP4 VRF Multi-instance Test Case HLD:
5 - higher number of pg-ip4 interfaces causes problems => only 15 pg-ip4 \
6 interfaces in 5 VRFs are tested
7 - jumbo packets in configuration with 15 pg-ip4 interfaces leads to \
11 - add 15 pg-ip4 interfaces
12 - configure 5 hosts per pg-ip4 interface
14 - add 3 pg-ip4 interfaces per VRF
17 - send IP4 packets between all pg-ip4 interfaces in all VRF groups
20 - check VRF data by parsing output of ip_fib_dump API command
21 - all packets received correctly in case of pg-ip4 interfaces in the same
23 - no packet received in case of pg-ip4 interfaces not in VRF
24 - no packet received in case of pg-ip4 interfaces in different VRFs
30 - send IP4 packets between all pg-ip4 interfaces in all VRF groups
33 - all packets received correctly in case of pg-ip4 interfaces in the same
35 - no packet received in case of pg-ip4 interfaces not in VRF
36 - no packet received in case of pg-ip4 interfaces in different VRFs
39 - add 1 of reset VRFs and 1 new VRF
42 - send IP4 packets between all pg-ip4 interfaces in all VRF groups
45 - check VRF data by parsing output of ip_fib_dump API command
46 - all packets received correctly in case of pg-ip4 interfaces in the same
48 - no packet received in case of pg-ip4 interfaces not in VRF
49 - no packet received in case of pg-ip4 interfaces in different VRFs
52 - reset all created VRFs
55 - send IP4 packets between all pg-ip4 interfaces in all VRF groups
58 - check VRF data by parsing output of ip_fib_dump API command
59 - all packets received correctly in case of pg-ip4 interfaces in the same
61 - no packet received in case of pg-ip4 interfaces not in VRF
62 - no packet received in case of pg-ip4 interfaces in different VRFs
70 from scapy.packet import Raw
71 from scapy.layers.l2 import Ether, ARP
72 from scapy.layers.inet import IP, UDP
74 from framework import VppTestCase, VppTestRunner
76 from vrf import VRFState
80 """ Is packet one of uninteresting IPv4 broadcasts? """
86 class TestIp4VrfMultiInst(VppTestCase):
87 """ IP4 VRF Multi-instance Test Case """
92 Perform standard class setup (defined by class method setUpClass in
93 class VppTestCase) before running the test case, set test case related
94 variables and configure VPP.
96 super(TestIp4VrfMultiInst, cls).setUpClass()
101 cls.pg_ifs_per_vrf = 3
104 # Create pg interfaces
105 cls.create_pg_interfaces(
106 range(cls.nr_of_vrfs * cls.pg_ifs_per_vrf))
108 # Packet flows mapping pg0 -> pg1, pg2 etc.
110 for i in range(len(cls.pg_interfaces)):
111 multiplicand = i // cls.pg_ifs_per_vrf
113 cls.pg_interfaces[multiplicand * cls.pg_ifs_per_vrf + j]
114 for j in range(cls.pg_ifs_per_vrf)
115 if (multiplicand * cls.pg_ifs_per_vrf + j) != i]
116 cls.flows[cls.pg_interfaces[i]] = pg_list
118 # Packet sizes - jumbo packet (9018 bytes) skipped
119 cls.pg_if_packet_sizes = [64, 512, 1518]
121 # Set up all interfaces
122 for pg_if in cls.pg_interfaces:
124 pg_if.generate_remote_hosts(cls.hosts_per_pg)
126 # Create list of VRFs
127 cls.vrf_list = list()
129 # Create list of reset VRFs
130 cls.vrf_reset_list = list()
132 # Create list of pg_interfaces in VRFs
133 cls.pg_in_vrf = list()
135 # Create list of pg_interfaces not in VRFs
136 cls.pg_not_in_vrf = [pg_if for pg_if in cls.pg_interfaces]
138 # Create mapping of pg_interfaces to VRF IDs
139 cls.pg_if_by_vrf_id = dict()
140 for i in range(cls.nr_of_vrfs):
143 cls.pg_interfaces[i * cls.pg_ifs_per_vrf + j]
144 for j in range(cls.pg_ifs_per_vrf)]
145 cls.pg_if_by_vrf_id[vrf_id] = pg_list
148 super(TestIp4VrfMultiInst, cls).tearDownClass()
152 def tearDownClass(cls):
153 super(TestIp4VrfMultiInst, cls).tearDownClass()
157 Clear trace and packet infos before running each test.
159 super(TestIp4VrfMultiInst, self).setUp()
160 self.reset_packet_infos()
164 Show various debug prints after each test.
166 super(TestIp4VrfMultiInst, self).tearDown()
168 def show_commands_at_teardown(self):
169 self.logger.info(self.vapi.ppcli("show ip fib"))
170 self.logger.info(self.vapi.ppcli("show ip4 neighbors"))
172 def create_vrf_and_assign_interfaces(self, count, start=1):
174 Create required number of FIB tables / VRFs, put 3 pg-ip4 interfaces
175 to every FIB table / VRF.
177 :param int count: Number of FIB tables / VRFs to be created.
178 :param int start: Starting number of the FIB table / VRF ID. \
182 for i in range(count):
184 pg_if = self.pg_if_by_vrf_id[vrf_id][0]
185 self.vapi.ip_table_add_del(is_add=1, table={'table_id': vrf_id})
186 self.logger.info("IPv4 VRF ID %d created" % vrf_id)
187 if vrf_id not in self.vrf_list:
188 self.vrf_list.append(vrf_id)
189 if vrf_id in self.vrf_reset_list:
190 self.vrf_reset_list.remove(vrf_id)
191 for j in range(self.pg_ifs_per_vrf):
192 pg_if = self.pg_if_by_vrf_id[vrf_id][j]
193 pg_if.set_table_ip4(vrf_id)
194 self.logger.info("pg-interface %s added to IPv4 VRF ID %d"
195 % (pg_if.name, vrf_id))
196 if pg_if not in self.pg_in_vrf:
197 self.pg_in_vrf.append(pg_if)
198 if pg_if in self.pg_not_in_vrf:
199 self.pg_not_in_vrf.remove(pg_if)
201 pg_if.configure_ipv4_neighbors()
202 self.logger.debug(self.vapi.ppcli("show ip fib"))
203 self.logger.debug(self.vapi.ppcli("show ip4 neighbors"))
205 def reset_vrf_and_remove_from_vrf_list(self, vrf_id):
207 Reset required FIB table / VRF and remove it from VRF list.
209 :param int vrf_id: The FIB table / VRF ID to be reset.
211 self.vapi.ip_table_flush(table={'table_id': vrf_id})
212 if vrf_id in self.vrf_list:
213 self.vrf_list.remove(vrf_id)
214 if vrf_id not in self.vrf_reset_list:
215 self.vrf_reset_list.append(vrf_id)
216 for j in range(self.pg_ifs_per_vrf):
217 pg_if = self.pg_if_by_vrf_id[vrf_id][j]
219 if pg_if in self.pg_in_vrf:
220 self.pg_in_vrf.remove(pg_if)
221 if pg_if not in self.pg_not_in_vrf:
222 self.pg_not_in_vrf.append(pg_if)
223 self.logger.info("IPv4 VRF ID %d reset finished" % vrf_id)
224 self.logger.debug(self.vapi.ppcli("show ip fib"))
225 self.logger.debug(self.vapi.ppcli("show ip neighbors"))
226 self.vapi.ip_table_add_del(is_add=0, table={'table_id': vrf_id})
228 def create_stream(self, src_if, packet_sizes):
230 Create input packet stream for defined interface using hosts list.
232 :param object src_if: Interface to create packet stream for.
233 :param list packet_sizes: List of required packet sizes.
234 :return: Stream of packets.
237 src_hosts = src_if.remote_hosts
238 for dst_if in self.flows[src_if]:
239 for dst_host in dst_if.remote_hosts:
240 src_host = random.choice(src_hosts)
241 pkt_info = self.create_packet_info(src_if, dst_if)
242 payload = self.info_to_payload(pkt_info)
243 p = (Ether(dst=src_if.local_mac, src=src_host.mac) /
244 IP(src=src_host.ip4, dst=dst_host.ip4) /
245 UDP(sport=1234, dport=1234) /
247 pkt_info.data = p.copy()
248 size = random.choice(packet_sizes)
249 self.extend_packet(p, size)
251 self.logger.debug("Input stream created for port %s. Length: %u pkt(s)"
252 % (src_if.name, len(pkts)))
255 def create_stream_crosswise_vrf(self, src_if, vrf_id, packet_sizes):
257 Create input packet stream for negative test for leaking across
258 different VRFs for defined interface using hosts list.
260 :param object src_if: Interface to create packet stream for.
261 :param int vrf_id: The FIB table / VRF ID where src_if is assigned.
262 :param list packet_sizes: List of required packet sizes.
263 :return: Stream of packets.
266 src_hosts = src_if.remote_hosts
267 vrf_lst = list(self.vrf_list)
268 vrf_lst.remove(vrf_id)
270 for dst_if in self.pg_if_by_vrf_id[vrf]:
271 for dst_host in dst_if.remote_hosts:
272 src_host = random.choice(src_hosts)
273 pkt_info = self.create_packet_info(src_if, dst_if)
274 payload = self.info_to_payload(pkt_info)
275 p = (Ether(dst=src_if.local_mac, src=src_host.mac) /
276 IP(src=src_host.ip4, dst=dst_host.ip4) /
277 UDP(sport=1234, dport=1234) /
279 pkt_info.data = p.copy()
280 size = random.choice(packet_sizes)
281 self.extend_packet(p, size)
283 self.logger.debug("Input stream created for port %s. Length: %u pkt(s)"
284 % (src_if.name, len(pkts)))
287 def verify_capture(self, pg_if, capture):
289 Verify captured input packet stream for defined interface.
291 :param object pg_if: Interface to verify captured packet stream for.
292 :param list capture: Captured packet stream.
295 for i in self.pg_interfaces:
296 last_info[i.sw_if_index] = None
297 dst_sw_if_index = pg_if.sw_if_index
298 for packet in capture:
302 payload_info = self.payload_to_info(packet[Raw])
303 packet_index = payload_info.index
304 self.assertEqual(payload_info.dst, dst_sw_if_index)
305 self.logger.debug("Got packet on port %s: src=%u (id=%u)" %
306 (pg_if.name, payload_info.src, packet_index))
307 next_info = self.get_next_packet_info_for_interface2(
308 payload_info.src, dst_sw_if_index,
309 last_info[payload_info.src])
310 last_info[payload_info.src] = next_info
311 self.assertIsNotNone(next_info)
312 self.assertEqual(packet_index, next_info.index)
313 saved_packet = next_info.data
314 # Check standard fields
315 self.assertEqual(ip.src, saved_packet[IP].src)
316 self.assertEqual(ip.dst, saved_packet[IP].dst)
317 self.assertEqual(udp.sport, saved_packet[UDP].sport)
318 self.assertEqual(udp.dport, saved_packet[UDP].dport)
320 self.logger.error(ppp("Unexpected or invalid packet:", packet))
322 for i in self.pg_interfaces:
323 remaining_packet = self.get_next_packet_info_for_interface2(
324 i, dst_sw_if_index, last_info[i.sw_if_index])
327 "Port %u: Packet expected from source %u didn't arrive" %
328 (dst_sw_if_index, i.sw_if_index))
330 def verify_vrf(self, vrf_id):
332 Check if the FIB table / VRF ID is configured.
334 :param int vrf_id: The FIB table / VRF ID to be verified.
335 :return: 1 if the FIB table / VRF ID is configured, otherwise return 0.
337 ip_fib_dump = self.vapi.ip_route_dump(vrf_id)
338 vrf_exist = len(ip_fib_dump)
340 for ip_fib_details in ip_fib_dump:
341 addr = ip_fib_details.route.prefix.network_address
343 for pg_if in self.pg_if_by_vrf_id[vrf_id]:
346 for host in pg_if.remote_hosts:
347 if str(addr) == host.ip4:
351 if not vrf_exist and vrf_count == 0:
352 self.logger.info("IPv4 VRF ID %d is not configured" % vrf_id)
353 return VRFState.not_configured
354 elif vrf_exist and vrf_count == 0:
355 self.logger.info("IPv4 VRF ID %d has been reset" % vrf_id)
356 return VRFState.reset
358 self.logger.info("IPv4 VRF ID %d is configured" % vrf_id)
359 return VRFState.configured
361 def run_verify_test(self):
363 Create packet streams for all configured pg interfaces, send all \
364 prepared packet streams and verify that:
365 - all packets received correctly on all pg-ip4 interfaces assigned
367 - no packet received on all pg-ip4 interfaces not assigned to VRFs
369 :raise RuntimeError: If no packet captured on pg-ip4 interface assigned
370 to VRF or if any packet is captured on pg-ip4 interface not
374 # Create incoming packet streams for packet-generator interfaces
375 for pg_if in self.pg_interfaces:
376 pkts = self.create_stream(pg_if, self.pg_if_packet_sizes)
377 pg_if.add_stream(pkts)
379 # Enable packet capture and start packet sending
380 self.pg_enable_capture(self.pg_interfaces)
384 # Verify outgoing packet streams per packet-generator interface
385 for pg_if in self.pg_interfaces:
386 if pg_if in self.pg_in_vrf:
387 capture = pg_if.get_capture(remark="interface is in VRF")
388 self.verify_capture(pg_if, capture)
389 elif pg_if in self.pg_not_in_vrf:
390 pg_if.assert_nothing_captured(remark="interface is not in VRF",
391 filter_out_fn=is_ipv4_misc)
392 self.logger.debug("No capture for interface %s" % pg_if.name)
394 raise Exception("Unknown interface: %s" % pg_if.name)
396 def run_crosswise_vrf_test(self):
398 Create packet streams for every pg-ip4 interface in VRF towards all
399 pg-ip4 interfaces in other VRFs, send all prepared packet streams and \
401 - no packet received on all configured pg-ip4 interfaces
403 :raise RuntimeError: If any packet is captured on any pg-ip4 interface.
406 # Create incoming packet streams for packet-generator interfaces
407 for vrf_id in self.vrf_list:
408 for pg_if in self.pg_if_by_vrf_id[vrf_id]:
409 pkts = self.create_stream_crosswise_vrf(
410 pg_if, vrf_id, self.pg_if_packet_sizes)
411 pg_if.add_stream(pkts)
413 # Enable packet capture and start packet sending
414 self.pg_enable_capture(self.pg_interfaces)
418 # Verify outgoing packet streams per packet-generator interface
419 for pg_if in self.pg_interfaces:
420 pg_if.assert_nothing_captured(remark="interface is in other VRF",
421 filter_out_fn=is_ipv4_misc)
422 self.logger.debug("No capture for interface %s" % pg_if.name)
424 def test_ip4_vrf_01(self):
425 """ IP4 VRF Multi-instance test 1 - create 4 VRFs
429 self.create_vrf_and_assign_interfaces(4)
432 for vrf_id in self.vrf_list:
433 self.assert_equal(self.verify_vrf(vrf_id),
434 VRFState.configured, VRFState)
437 self.run_verify_test()
438 self.run_crosswise_vrf_test()
440 def test_ip4_vrf_02(self):
441 """ IP4 VRF Multi-instance test 2 - reset 2 VRFs
445 self.reset_vrf_and_remove_from_vrf_list(1)
446 self.reset_vrf_and_remove_from_vrf_list(2)
449 for vrf_id in self.vrf_reset_list:
450 self.assert_equal(self.verify_vrf(vrf_id),
451 VRFState.reset, VRFState)
452 for vrf_id in self.vrf_list:
453 self.assert_equal(self.verify_vrf(vrf_id),
454 VRFState.configured, VRFState)
457 self.run_verify_test()
458 self.run_crosswise_vrf_test()
460 def test_ip4_vrf_03(self):
461 """ IP4 VRF Multi-instance 3 - add 2 VRFs
464 # Add 1 of reset VRFs and 1 new VRF
465 self.create_vrf_and_assign_interfaces(1)
466 self.create_vrf_and_assign_interfaces(1, start=5)
469 for vrf_id in self.vrf_reset_list:
470 self.assert_equal(self.verify_vrf(vrf_id),
471 VRFState.reset, VRFState)
472 for vrf_id in self.vrf_list:
473 self.assert_equal(self.verify_vrf(vrf_id),
474 VRFState.configured, VRFState)
477 self.run_verify_test()
478 self.run_crosswise_vrf_test()
480 def test_ip4_vrf_04(self):
481 """ IP4 VRF Multi-instance test 4 - reset 4 VRFs
484 # Reset all VRFs (i.e. no VRF except VRF=0 configured)
485 for i in range(len(self.vrf_list)):
486 self.reset_vrf_and_remove_from_vrf_list(self.vrf_list[0])
489 for vrf_id in self.vrf_reset_list:
490 self.assert_equal(self.verify_vrf(vrf_id),
491 VRFState.reset, VRFState)
492 vrf_list_length = len(self.vrf_list)
495 "List of configured VRFs is not empty: %s != 0" % vrf_list_length)
498 self.run_verify_test()
499 self.run_crosswise_vrf_test()
502 if __name__ == '__main__':
503 unittest.main(testRunner=VppTestRunner)