test/test_ip6_vrf_multi_instance.py

   1 #!/usr/bin/env python3
   2 """IP6 VRF Multi-instance Test Case HLD:
   3
   4 **NOTES:**
   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 \
   8     problems too
   9
  10 **config 1**
  11     - add 15 pg-ip6 interfaces
  12     - configure 5 hosts per pg-ip6 interface
  13     - configure 4 VRFs
  14     - add 3 pg-ip6 interfaces per VRF
  15
  16 **test 1**
  17     - send IP6 packets between all pg-ip6 interfaces in all VRF groups
  18
  19 **verify 1**
  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
  22     VRF
  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
  25
  26 **config 2**
  27     - reset 2 VRFs
  28
  29 **test 2**
  30     - send IP6 packets between all pg-ip6 interfaces in all VRF groups
  31
  32 **verify 2**
  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
  35     VRF
  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
  38
  39 **config 3**
  40     - add 1 of reset VRFs and 1 new VRF
  41
  42 **test 3**
  43     - send IP6 packets between all pg-ip6 interfaces in all VRF groups
  44
  45 **verify 3**
  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
  48     VRF
  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
  51
  52 **config 4**
  53     - reset all VRFs (i.e. no VRF except VRF=0 created)
  54
  55 **test 4**
  56     - send IP6 packets between all pg-ip6 interfaces in all VRF groups
  57
  58 **verify 4**
  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
  61     VRF
  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
  64 """
  65
  66 import unittest
  67 import random
  68 import socket
  69
  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
  76
  77 from framework import VppTestCase, VppTestRunner
  78 from util import ppp
  79 from vrf import VRFState
  80
  81
  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):
  87             return True
  88     if p.haslayer(ICMPv6ND_NS):
  89         if in6_isllsnmaddr(p[IPv6].dst):
  90             return True
  91     if p.haslayer(IPv6ExtHdrHopByHop):
  92         for o in p[IPv6ExtHdrHopByHop].options:
  93             if isinstance(o, RouterAlert):
  94                 return True
  95     return False
  96
  97
  98 class TestIP6VrfMultiInst(VppTestCase):
  99     """ IP6 VRF  Multi-instance Test Case """
 100
 101     @classmethod
 102     def setUpClass(cls):
 103         """
 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.
 107         """
 108         super(TestIP6VrfMultiInst, cls).setUpClass()
 109
 110         # Test variables
 111         cls.hosts_per_pg = 5
 112         cls.nr_of_vrfs = 5
 113         cls.pg_ifs_per_vrf = 3
 114
 115         try:
 116             # Create pg interfaces
 117             cls.create_pg_interfaces(
 118                 range(cls.nr_of_vrfs * cls.pg_ifs_per_vrf))
 119
 120             # Packet flows mapping pg0 -> pg1, pg2 etc.
 121             cls.flows = dict()
 122             for i in range(len(cls.pg_interfaces)):
 123                 multiplicand = i // cls.pg_ifs_per_vrf
 124                 pg_list = [
 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
 129
 130             # Packet sizes - jumbo packet (9018 bytes) skipped
 131             cls.pg_if_packet_sizes = [64, 512, 1518]
 132
 133             # Set up all interfaces
 134             for pg_if in cls.pg_interfaces:
 135                 pg_if.admin_up()
 136                 pg_if.generate_remote_hosts(cls.hosts_per_pg)
 137
 138             # Create list of VRFs
 139             cls.vrf_list = list()
 140
 141             # Create list of reset VRFs
 142             cls.vrf_reset_list = list()
 143
 144             # Create list of pg_interfaces in VRFs
 145             cls.pg_in_vrf = list()
 146
 147             # Create list of pg_interfaces not in VRFs
 148             cls.pg_not_in_vrf = [pg_if for pg_if in cls.pg_interfaces]
 149
 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):
 153                 vrf_id = i + 1
 154                 pg_list = [
 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
 158
 159         except Exception:
 160             super(TestIP6VrfMultiInst, cls).tearDownClass()
 161             raise
 162
 163     @classmethod
 164     def tearDownClass(cls):
 165         super(TestIP6VrfMultiInst, cls).tearDownClass()
 166
 167     def setUp(self):
 168         """
 169         Clear trace and packet infos before running each test.
 170         """
 171         super(TestIP6VrfMultiInst, self).setUp()
 172         self.reset_packet_infos()
 173
 174     def tearDown(self):
 175         """
 176         Show various debug prints after each test.
 177         """
 178         super(TestIP6VrfMultiInst, self).tearDown()
 179
 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"))
 183
 184     def create_vrf_and_assign_interfaces(self, count, start=1):
 185         """
 186         Create required number of FIB tables / VRFs, put 3 pg-ip6 interfaces
 187         to every FIB table / VRF.
 188
 189         :param int count: Number of FIB tables / VRFs to be created.
 190         :param int start: Starting number of the FIB table / VRF ID. \
 191         (Default value = 1)
 192         """
 193         for i in range(count):
 194             vrf_id = i + start
 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)
 212                 pg_if.config_ip6()
 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"))
 217
 218     def reset_vrf_and_remove_from_vrf_list(self, vrf_id):
 219         """
 220         Reset required FIB table / VRF and remove it from VRF list.
 221
 222         :param int vrf_id: The FIB table / VRF ID to be reset.
 223         """
 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]
 231             pg_if.unconfig_ip6()
 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})
 241
 242     def create_stream(self, src_if, packet_sizes):
 243         """
 244         Create input packet stream for defined interface using hosts list.
 245
 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.
 249         """
 250         pkts = []
 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) /
 260                      Raw(payload))
 261                 pkt_info.data = p.copy()
 262                 size = random.choice(packet_sizes)
 263                 self.extend_packet(p, size)
 264                 pkts.append(p)
 265         self.logger.debug("Input stream created for port %s. Length: %u pkt(s)"
 266                           % (src_if.name, len(pkts)))
 267         return pkts
 268
 269     def create_stream_crosswise_vrf(self, src_if, vrf_id, packet_sizes):
 270         """
 271         Create input packet stream for negative test for leaking across
 272         different VRFs for defined interface using hosts list.
 273
 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.
 278         """
 279         pkts = []
 280         src_hosts = src_if.remote_hosts
 281         vrf_lst = list(self.vrf_list)
 282         vrf_lst.remove(vrf_id)
 283         for vrf in vrf_lst:
 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) /
 292                          Raw(payload))
 293                     pkt_info.data = p.copy()
 294                     size = random.choice(packet_sizes)
 295                     self.extend_packet(p, size)
 296                     pkts.append(p)
 297         self.logger.debug("Input stream created for port %s. Length: %u pkt(s)"
 298                           % (src_if.name, len(pkts)))
 299         return pkts
 300
 301     def verify_capture(self, pg_if, capture):
 302         """
 303         Verify captured input packet stream for defined interface.
 304
 305         :param object pg_if: Interface to verify captured packet stream for.
 306         :param list capture: Captured packet stream.
 307         """
 308         last_info = dict()
 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:
 313             try:
 314                 ip = packet[IPv6]
 315                 udp = packet[UDP]
 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)
 333             except:
 334                 self.logger.error(ppp("Unexpected or invalid packet:", packet))
 335                 raise
 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])
 339             self.assertIsNone(
 340                 remaining_packet,
 341                 "Port %u: Packet expected from source %u didn't arrive" %
 342                 (dst_sw_if_index, i.sw_if_index))
 343
 344     def verify_vrf(self, vrf_id):
 345         """
 346         Check if the FIB table / VRF ID is configured.
 347
 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.
 350         """
 351         ip6_fib_dump = self.vapi.ip_route_dump(vrf_id, True)
 352         vrf_exist = len(ip6_fib_dump)
 353         vrf_count = 0
 354         for ip6_fib_details in ip6_fib_dump:
 355             addr = ip6_fib_details.route.prefix.network_address
 356             found = False
 357             for pg_if in self.pg_if_by_vrf_id[vrf_id]:
 358                 if found:
 359                     break
 360                 for host in pg_if.remote_hosts:
 361                     if str(addr) == host.ip6:
 362                         vrf_count += 1
 363                         found = True
 364                         break
 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
 371         else:
 372             self.logger.info("IPv6 VRF ID %d is configured" % vrf_id)
 373             return VRFState.configured
 374
 375     def run_verify_test(self):
 376         """
 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
 380               to VRFs
 381             - no packet received on all pg-ip6 interfaces not assigned to VRFs
 382
 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
 385             assigned to VRF.
 386         """
 387         # Test
 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)
 392
 393         # Enable packet capture and start packet sending
 394         self.pg_enable_capture(self.pg_interfaces)
 395         self.pg_start()
 396
 397         # Verify
 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)
 407             else:
 408                 raise Exception("Unknown interface: %s" % pg_if.name)
 409
 410     def run_crosswise_vrf_test(self):
 411         """
 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 \
 414         verify that:
 415              - no packet received on all configured pg-ip6 interfaces
 416
 417         :raise RuntimeError: If any packet is captured on any pg-ip6 interface.
 418         """
 419         # Test
 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)
 426
 427         # Enable packet capture and start packet sending
 428         self.pg_enable_capture(self.pg_interfaces)
 429         self.pg_start()
 430
 431         # Verify
 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)
 437
 438     def test_ip6_vrf_01(self):
 439         """ IP6 VRF  Multi-instance test 1 - create 4 VRFs
 440         """
 441         # Config 1
 442         # Create 4 VRFs
 443         self.create_vrf_and_assign_interfaces(4)
 444
 445         # Verify 1
 446         for vrf_id in self.vrf_list:
 447             self.assert_equal(self.verify_vrf(vrf_id),
 448                               VRFState.configured, VRFState)
 449
 450         # Test 1
 451         self.run_verify_test()
 452         self.run_crosswise_vrf_test()
 453
 454     def test_ip6_vrf_02(self):
 455         """ IP6 VRF  Multi-instance test 2 - reset 2 VRFs
 456         """
 457         # Config 2
 458         # Delete 2 VRFs
 459         self.reset_vrf_and_remove_from_vrf_list(1)
 460         self.reset_vrf_and_remove_from_vrf_list(2)
 461
 462         # Verify 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)
 469
 470         # Test 2
 471         self.run_verify_test()
 472         self.run_crosswise_vrf_test()
 473
 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)
 477
 478     def test_ip6_vrf_03(self):
 479         """ IP6 VRF  Multi-instance 3 - add 2 VRFs
 480         """
 481         # Config 3
 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)
 485
 486         # Verify 3
 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)
 493
 494         # Test 3
 495         self.run_verify_test()
 496         self.run_crosswise_vrf_test()
 497
 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)
 501
 502     def test_ip6_vrf_04(self):
 503         """ IP6 VRF  Multi-instance test 4 - reset 4 VRFs
 504         """
 505         # Config 4
 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])
 509
 510         # Verify 4
 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)
 515         self.assertEqual(
 516             vrf_list_length, 0,
 517             "List of configured VRFs is not empty: %s != 0" % vrf_list_length)
 518
 519         # Test 4
 520         self.run_verify_test()
 521         self.run_crosswise_vrf_test()
 522
 523
 524 if __name__ == '__main__':
 525     unittest.main(testRunner=VppTestRunner)