2 """IP6 VRF Multi-instance Test Case HLD:
5 - higher number of pg-ip6 interfaces causes problems => only 15 pg-ip6 \
6 interfaces in 5 VRFs are tested
7 - jumbo packets in configuration with 15 pg-ip6 interfaces leads to \
11 - add 15 pg-ip6 interfaces
12 - configure 5 hosts per pg-ip6 interface
14 - add 3 pg-ip6 interfaces per VRF
17 - send IP6 packets between all pg-ip6 interfaces in all VRF groups
20 - check VRF data by parsing output of ip_route_dump API command
21 - all packets received correctly in case of pg-ip6 interfaces in the same
23 - no packet received in case of pg-ip6 interfaces not in VRF
24 - no packet received in case of pg-ip6 interfaces in different VRFs
30 - send IP6 packets between all pg-ip6 interfaces in all VRF groups
33 - check VRF data by parsing output of ip_route_dump API command
34 - all packets received correctly in case of pg-ip6 interfaces in the same
36 - no packet received in case of pg-ip6 interfaces not in VRF
37 - no packet received in case of pg-ip6 interfaces in different VRFs
40 - add 1 of reset VRFs and 1 new VRF
43 - send IP6 packets between all pg-ip6 interfaces in all VRF groups
46 - check VRF data by parsing output of ip_route_dump API command
47 - all packets received correctly in case of pg-ip6 interfaces in the same
49 - no packet received in case of pg-ip6 interfaces not in VRF
50 - no packet received in case of pg-ip6 interfaces in different VRFs
53 - reset all VRFs (i.e. no VRF except VRF=0 created)
56 - send IP6 packets between all pg-ip6 interfaces in all VRF groups
59 - check VRF data by parsing output of ip_route_dump API command
60 - all packets received correctly in case of pg-ip6 interfaces in the same
62 - no packet received in case of pg-ip6 interfaces not in VRF
63 - no packet received in case of pg-ip6 interfaces in different VRFs
70 from scapy.packet import Raw
71 from scapy.layers.l2 import Ether
72 from scapy.layers.inet6 import UDP, IPv6, ICMPv6ND_NS, ICMPv6ND_RA, \
73 RouterAlert, IPv6ExtHdrHopByHop
74 from scapy.utils6 import in6_ismaddr, in6_isllsnmaddr, in6_getAddrType
75 from scapy.pton_ntop import inet_ntop
77 from framework import VppTestCase, VppTestRunner
79 from vrf import VRFState
82 def is_ipv6_misc_ext(p):
83 """ Is packet one of uninteresting IPv6 broadcasts (extended to filter out
84 ICMPv6 Neighbor Discovery - Neighbor Advertisement packets too)? """
85 if p.haslayer(ICMPv6ND_RA):
86 if in6_ismaddr(p[IPv6].dst):
88 if p.haslayer(ICMPv6ND_NS):
89 if in6_isllsnmaddr(p[IPv6].dst):
91 if p.haslayer(IPv6ExtHdrHopByHop):
92 for o in p[IPv6ExtHdrHopByHop].options:
93 if isinstance(o, RouterAlert):
98 class TestIP6VrfMultiInst(VppTestCase):
99 """ IP6 VRF Multi-instance Test Case """
104 Perform standard class setup (defined by class method setUpClass in
105 class VppTestCase) before running the test case, set test case related
106 variables and configure VPP.
108 super(TestIP6VrfMultiInst, cls).setUpClass()
113 cls.pg_ifs_per_vrf = 3
116 # Create pg interfaces
117 cls.create_pg_interfaces(
118 range(cls.nr_of_vrfs * cls.pg_ifs_per_vrf))
120 # Packet flows mapping pg0 -> pg1, pg2 etc.
122 for i in range(len(cls.pg_interfaces)):
123 multiplicand = i // cls.pg_ifs_per_vrf
125 cls.pg_interfaces[multiplicand * cls.pg_ifs_per_vrf + j]
126 for j in range(cls.pg_ifs_per_vrf)
127 if (multiplicand * cls.pg_ifs_per_vrf + j) != i]
128 cls.flows[cls.pg_interfaces[i]] = pg_list
130 # Packet sizes - jumbo packet (9018 bytes) skipped
131 cls.pg_if_packet_sizes = [64, 512, 1518]
133 # Set up all interfaces
134 for pg_if in cls.pg_interfaces:
136 pg_if.generate_remote_hosts(cls.hosts_per_pg)
138 # Create list of VRFs
139 cls.vrf_list = list()
141 # Create list of reset VRFs
142 cls.vrf_reset_list = list()
144 # Create list of pg_interfaces in VRFs
145 cls.pg_in_vrf = list()
147 # Create list of pg_interfaces not in VRFs
148 cls.pg_not_in_vrf = [pg_if for pg_if in cls.pg_interfaces]
150 # Create mapping of pg_interfaces to VRF IDs
151 cls.pg_if_by_vrf_id = dict()
152 for i in range(cls.nr_of_vrfs):
155 cls.pg_interfaces[i * cls.pg_ifs_per_vrf + j]
156 for j in range(cls.pg_ifs_per_vrf)]
157 cls.pg_if_by_vrf_id[vrf_id] = pg_list
160 super(TestIP6VrfMultiInst, cls).tearDownClass()
164 def tearDownClass(cls):
165 super(TestIP6VrfMultiInst, cls).tearDownClass()
169 Clear trace and packet infos before running each test.
171 super(TestIP6VrfMultiInst, self).setUp()
172 self.reset_packet_infos()
176 Show various debug prints after each test.
178 super(TestIP6VrfMultiInst, self).tearDown()
180 def show_commands_at_teardown(self):
181 self.logger.info(self.vapi.ppcli("show ip6 fib"))
182 self.logger.info(self.vapi.ppcli("show ip6 neighbors"))
184 def create_vrf_and_assign_interfaces(self, count, start=1):
186 Create required number of FIB tables / VRFs, put 3 pg-ip6 interfaces
187 to every FIB table / VRF.
189 :param int count: Number of FIB tables / VRFs to be created.
190 :param int start: Starting number of the FIB table / VRF ID. \
193 for i in range(count):
195 pg_if = self.pg_if_by_vrf_id[vrf_id][0]
196 self.vapi.ip_table_add_del(is_add=1,
197 table={'table_id': vrf_id, 'is_ip6': 1})
198 self.logger.info("IPv6 VRF ID %d created" % vrf_id)
199 if vrf_id not in self.vrf_list:
200 self.vrf_list.append(vrf_id)
201 if vrf_id in self.vrf_reset_list:
202 self.vrf_reset_list.remove(vrf_id)
203 for j in range(self.pg_ifs_per_vrf):
204 pg_if = self.pg_if_by_vrf_id[vrf_id][j]
205 pg_if.set_table_ip6(vrf_id)
206 self.logger.info("pg-interface %s added to IPv6 VRF ID %d"
207 % (pg_if.name, vrf_id))
208 if pg_if not in self.pg_in_vrf:
209 self.pg_in_vrf.append(pg_if)
210 if pg_if in self.pg_not_in_vrf:
211 self.pg_not_in_vrf.remove(pg_if)
213 pg_if.disable_ipv6_ra()
214 pg_if.configure_ipv6_neighbors()
215 self.logger.debug(self.vapi.ppcli("show ip6 fib"))
216 self.logger.debug(self.vapi.ppcli("show ip6 neighbors"))
218 def reset_vrf_and_remove_from_vrf_list(self, vrf_id):
220 Reset required FIB table / VRF and remove it from VRF list.
222 :param int vrf_id: The FIB table / VRF ID to be reset.
224 self.vapi.ip_table_flush(table={'table_id': vrf_id, 'is_ip6': 1})
225 if vrf_id in self.vrf_list:
226 self.vrf_list.remove(vrf_id)
227 if vrf_id not in self.vrf_reset_list:
228 self.vrf_reset_list.append(vrf_id)
229 for j in range(self.pg_ifs_per_vrf):
230 pg_if = self.pg_if_by_vrf_id[vrf_id][j]
232 if pg_if in self.pg_in_vrf:
233 self.pg_in_vrf.remove(pg_if)
234 if pg_if not in self.pg_not_in_vrf:
235 self.pg_not_in_vrf.append(pg_if)
236 self.logger.info("IPv6 VRF ID %d reset finished" % vrf_id)
237 self.logger.debug(self.vapi.ppcli("show ip6 fib"))
238 self.logger.debug(self.vapi.ppcli("show ip6 neighbors"))
239 self.vapi.ip_table_add_del(is_add=0,
240 table={'table_id': vrf_id, 'is_ip6': 1})
242 def create_stream(self, src_if, packet_sizes):
244 Create input packet stream for defined interface using hosts list.
246 :param object src_if: Interface to create packet stream for.
247 :param list packet_sizes: List of required packet sizes.
248 :return: Stream of packets.
251 src_hosts = src_if.remote_hosts
252 for dst_if in self.flows[src_if]:
253 for dst_host in dst_if.remote_hosts:
254 src_host = random.choice(src_hosts)
255 pkt_info = self.create_packet_info(src_if, dst_if)
256 payload = self.info_to_payload(pkt_info)
257 p = (Ether(dst=src_if.local_mac, src=src_host.mac) /
258 IPv6(src=src_host.ip6, dst=dst_host.ip6) /
259 UDP(sport=1234, dport=1234) /
261 pkt_info.data = p.copy()
262 size = random.choice(packet_sizes)
263 self.extend_packet(p, size)
265 self.logger.debug("Input stream created for port %s. Length: %u pkt(s)"
266 % (src_if.name, len(pkts)))
269 def create_stream_crosswise_vrf(self, src_if, vrf_id, packet_sizes):
271 Create input packet stream for negative test for leaking across
272 different VRFs for defined interface using hosts list.
274 :param object src_if: Interface to create packet stream for.
275 :param int vrf_id: The FIB table / VRF ID where src_if is assigned.
276 :param list packet_sizes: List of required packet sizes.
277 :return: Stream of packets.
280 src_hosts = src_if.remote_hosts
281 vrf_lst = list(self.vrf_list)
282 vrf_lst.remove(vrf_id)
284 for dst_if in self.pg_if_by_vrf_id[vrf]:
285 for dst_host in dst_if.remote_hosts:
286 src_host = random.choice(src_hosts)
287 pkt_info = self.create_packet_info(src_if, dst_if)
288 payload = self.info_to_payload(pkt_info)
289 p = (Ether(dst=src_if.local_mac, src=src_host.mac) /
290 IPv6(src=src_host.ip6, dst=dst_host.ip6) /
291 UDP(sport=1234, dport=1234) /
293 pkt_info.data = p.copy()
294 size = random.choice(packet_sizes)
295 self.extend_packet(p, size)
297 self.logger.debug("Input stream created for port %s. Length: %u pkt(s)"
298 % (src_if.name, len(pkts)))
301 def verify_capture(self, pg_if, capture):
303 Verify captured input packet stream for defined interface.
305 :param object pg_if: Interface to verify captured packet stream for.
306 :param list capture: Captured packet stream.
309 for i in self.pg_interfaces:
310 last_info[i.sw_if_index] = None
311 dst_sw_if_index = pg_if.sw_if_index
312 for packet in capture:
316 payload_info = self.payload_to_info(packet[Raw])
317 packet_index = payload_info.index
318 self.assertEqual(payload_info.dst, dst_sw_if_index)
319 self.logger.debug("Got packet on port %s: src=%u (id=%u)" %
320 (pg_if.name, payload_info.src, packet_index))
321 next_info = self.get_next_packet_info_for_interface2(
322 payload_info.src, dst_sw_if_index,
323 last_info[payload_info.src])
324 last_info[payload_info.src] = next_info
325 self.assertIsNotNone(next_info)
326 self.assertEqual(packet_index, next_info.index)
327 saved_packet = next_info.data
328 # Check standard fields
329 self.assertEqual(ip.src, saved_packet[IPv6].src)
330 self.assertEqual(ip.dst, saved_packet[IPv6].dst)
331 self.assertEqual(udp.sport, saved_packet[UDP].sport)
332 self.assertEqual(udp.dport, saved_packet[UDP].dport)
334 self.logger.error(ppp("Unexpected or invalid packet:", packet))
336 for i in self.pg_interfaces:
337 remaining_packet = self.get_next_packet_info_for_interface2(
338 i, dst_sw_if_index, last_info[i.sw_if_index])
341 "Port %u: Packet expected from source %u didn't arrive" %
342 (dst_sw_if_index, i.sw_if_index))
344 def verify_vrf(self, vrf_id):
346 Check if the FIB table / VRF ID is configured.
348 :param int vrf_id: The FIB table / VRF ID to be verified.
349 :return: 1 if the FIB table / VRF ID is configured, otherwise return 0.
351 ip6_fib_dump = self.vapi.ip_route_dump(vrf_id, True)
352 vrf_exist = len(ip6_fib_dump)
354 for ip6_fib_details in ip6_fib_dump:
355 addr = ip6_fib_details.route.prefix.network_address
357 for pg_if in self.pg_if_by_vrf_id[vrf_id]:
360 for host in pg_if.remote_hosts:
361 if str(addr) == host.ip6:
365 if not vrf_exist and vrf_count == 0:
366 self.logger.info("IPv6 VRF ID %d is not configured" % vrf_id)
367 return VRFState.not_configured
368 elif vrf_exist and vrf_count == 0:
369 self.logger.info("IPv6 VRF ID %d has been reset" % vrf_id)
370 return VRFState.reset
372 self.logger.info("IPv6 VRF ID %d is configured" % vrf_id)
373 return VRFState.configured
375 def run_verify_test(self):
377 Create packet streams for all configured pg interfaces, send all \
378 prepared packet streams and verify that:
379 - all packets received correctly on all pg-ip6 interfaces assigned
381 - no packet received on all pg-ip6 interfaces not assigned to VRFs
383 :raise RuntimeError: If no packet captured on pg-ip6 interface assigned
384 to VRF or if any packet is captured on pg-ip6 interface not
388 # Create incoming packet streams for packet-generator interfaces
389 for pg_if in self.pg_interfaces:
390 pkts = self.create_stream(pg_if, self.pg_if_packet_sizes)
391 pg_if.add_stream(pkts)
393 # Enable packet capture and start packet sending
394 self.pg_enable_capture(self.pg_interfaces)
398 # Verify outgoing packet streams per packet-generator interface
399 for pg_if in self.pg_interfaces:
400 if pg_if in self.pg_in_vrf:
401 capture = pg_if.get_capture(remark="interface is in VRF")
402 self.verify_capture(pg_if, capture)
403 elif pg_if in self.pg_not_in_vrf:
404 pg_if.assert_nothing_captured(remark="interface is not in VRF",
405 filter_out_fn=is_ipv6_misc_ext)
406 self.logger.debug("No capture for interface %s" % pg_if.name)
408 raise Exception("Unknown interface: %s" % pg_if.name)
410 def run_crosswise_vrf_test(self):
412 Create packet streams for every pg-ip6 interface in VRF towards all
413 pg-ip6 interfaces in other VRFs, send all prepared packet streams and \
415 - no packet received on all configured pg-ip6 interfaces
417 :raise RuntimeError: If any packet is captured on any pg-ip6 interface.
420 # Create incoming packet streams for packet-generator interfaces
421 for vrf_id in self.vrf_list:
422 for pg_if in self.pg_if_by_vrf_id[vrf_id]:
423 pkts = self.create_stream_crosswise_vrf(
424 pg_if, vrf_id, self.pg_if_packet_sizes)
425 pg_if.add_stream(pkts)
427 # Enable packet capture and start packet sending
428 self.pg_enable_capture(self.pg_interfaces)
432 # Verify outgoing packet streams per packet-generator interface
433 for pg_if in self.pg_interfaces:
434 pg_if.assert_nothing_captured(remark="interface is in other VRF",
435 filter_out_fn=is_ipv6_misc_ext)
436 self.logger.debug("No capture for interface %s" % pg_if.name)
438 def test_ip6_vrf_01(self):
439 """ IP6 VRF Multi-instance test 1 - create 4 VRFs
443 self.create_vrf_and_assign_interfaces(4)
446 for vrf_id in self.vrf_list:
447 self.assert_equal(self.verify_vrf(vrf_id),
448 VRFState.configured, VRFState)
451 self.run_verify_test()
452 self.run_crosswise_vrf_test()
454 def test_ip6_vrf_02(self):
455 """ IP6 VRF Multi-instance test 2 - reset 2 VRFs
459 self.reset_vrf_and_remove_from_vrf_list(1)
460 self.reset_vrf_and_remove_from_vrf_list(2)
463 for vrf_id in self.vrf_reset_list:
464 self.assert_equal(self.verify_vrf(vrf_id),
465 VRFState.reset, VRFState)
466 for vrf_id in self.vrf_list:
467 self.assert_equal(self.verify_vrf(vrf_id),
468 VRFState.configured, VRFState)
471 self.run_verify_test()
472 self.run_crosswise_vrf_test()
474 # Reset routes learned from ICMPv6 Neighbor Discovery
475 for vrf_id in self.vrf_reset_list:
476 self.reset_vrf_and_remove_from_vrf_list(vrf_id)
478 def test_ip6_vrf_03(self):
479 """ IP6 VRF Multi-instance 3 - add 2 VRFs
482 # Add 1 of reset VRFs and 1 new VRF
483 self.create_vrf_and_assign_interfaces(1)
484 self.create_vrf_and_assign_interfaces(1, start=5)
487 for vrf_id in self.vrf_reset_list:
488 self.assert_equal(self.verify_vrf(vrf_id),
489 VRFState.reset, VRFState)
490 for vrf_id in self.vrf_list:
491 self.assert_equal(self.verify_vrf(vrf_id),
492 VRFState.configured, VRFState)
495 self.run_verify_test()
496 self.run_crosswise_vrf_test()
498 # Reset routes learned from ICMPv6 Neighbor Discovery
499 for vrf_id in self.vrf_reset_list:
500 self.reset_vrf_and_remove_from_vrf_list(vrf_id)
502 def test_ip6_vrf_04(self):
503 """ IP6 VRF Multi-instance test 4 - reset 4 VRFs
506 # Reset all VRFs (i.e. no VRF except VRF=0 configured)
507 for i in range(len(self.vrf_list)):
508 self.reset_vrf_and_remove_from_vrf_list(self.vrf_list[0])
511 for vrf_id in self.vrf_reset_list:
512 self.assert_equal(self.verify_vrf(vrf_id),
513 VRFState.reset, VRFState)
514 vrf_list_length = len(self.vrf_list)
517 "List of configured VRFs is not empty: %s != 0" % vrf_list_length)
520 self.run_verify_test()
521 self.run_crosswise_vrf_test()
524 if __name__ == '__main__':
525 unittest.main(testRunner=VppTestRunner)