test/vpp_neighbor.py

   1 """
   2   Neighbour Entries
   3
   4   object abstractions for ARP and ND
   5 """
   6
   7 from ipaddress import ip_address
   8 from vpp_object import VppObject
   9 from vpp_papi import VppEnum
  10
  11 try:
  12     text_type = unicode
  13 except NameError:
  14     text_type = str
  15
  16
  17 def find_nbr(test, sw_if_index, nbr_addr, is_static=0, mac=None):
  18     ip_addr = ip_address(text_type(nbr_addr))
  19     e = VppEnum.vl_api_ip_neighbor_flags_t
  20     nbrs = test.vapi.ip_neighbor_dump(sw_if_index=sw_if_index, af=ip_addr.vapi_af)
  21
  22     for n in nbrs:
  23         if (
  24             sw_if_index == n.neighbor.sw_if_index
  25             and ip_addr == n.neighbor.ip_address
  26             and is_static == (n.neighbor.flags & e.IP_API_NEIGHBOR_FLAG_STATIC)
  27         ):
  28             if mac:
  29                 if mac == str(n.neighbor.mac_address):
  30                     return True
  31             else:
  32                 return True
  33     return False
  34
  35
  36 class VppNeighbor(VppObject):
  37     """
  38     ARP Entry
  39     """
  40
  41     def __init__(
  42         self,
  43         test,
  44         sw_if_index,
  45         mac_addr,
  46         nbr_addr,
  47         is_static=False,
  48         is_no_fib_entry=False,
  49     ):
  50         self._test = test
  51         self.sw_if_index = sw_if_index
  52         self.mac_addr = mac_addr
  53         self.nbr_addr = nbr_addr
  54
  55         e = VppEnum.vl_api_ip_neighbor_flags_t
  56         self.flags = e.IP_API_NEIGHBOR_FLAG_NONE
  57         if is_static:
  58             self.flags |= e.IP_API_NEIGHBOR_FLAG_STATIC
  59         if is_no_fib_entry:
  60             self.flags |= e.IP_API_NEIGHBOR_FLAG_NO_FIB_ENTRY
  61
  62     def add_vpp_config(self):
  63         r = self._test.vapi.ip_neighbor_add_del(
  64             self.sw_if_index, self.mac_addr, self.nbr_addr, is_add=1, flags=self.flags
  65         )
  66         self.stats_index = r.stats_index
  67         self._test.registry.register(self, self._test.logger)
  68         return self
  69
  70     def remove_vpp_config(self):
  71         self._test.vapi.ip_neighbor_add_del(
  72             self.sw_if_index, self.mac_addr, self.nbr_addr, is_add=0, flags=self.flags
  73         )
  74
  75     def is_static(self):
  76         e = VppEnum.vl_api_ip_neighbor_flags_t
  77         return self.flags & e.IP_API_NEIGHBOR_FLAG_STATIC
  78
  79     def query_vpp_config(self):
  80         return find_nbr(self._test, self.sw_if_index, self.nbr_addr, self.is_static())
  81
  82     def object_id(self):
  83         return "%d:%s" % (self.sw_if_index, self.nbr_addr)
  84
  85     def get_stats(self):
  86         c = self._test.statistics["/net/adjacency"]
  87         return c[0][self.stats_index]