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