tests: cli wrapper should return string
[vpp.git] / test / vpp_interface.py
1 import binascii
2 import socket
3 import abc
4
5 import six
6 from six import moves
7
8 from util import Host, mk_ll_addr
9 from vpp_papi import mac_ntop, VppEnum
10 from vpp_ip import VppIpAddress, VppIpPrefix
11 from ipaddress import IPv4Network
12
13 try:
14     text_type = unicode
15 except NameError:
16     text_type = str
17
18
19 @six.add_metaclass(abc.ABCMeta)
20 class VppInterface(object):
21     """Generic VPP interface."""
22
23     @property
24     def sw_if_index(self):
25         """Interface index assigned by VPP."""
26         return self._sw_if_index
27
28     @property
29     def remote_mac(self):
30         """MAC-address of the remote interface "connected" to this interface"""
31         return self._remote_hosts[0].mac
32
33     @property
34     def local_mac(self):
35         """MAC-address of the VPP interface."""
36         return str(self._local_mac)
37
38     @property
39     def local_addr(self):
40         return self._local_addr
41
42     @property
43     def remote_addr(self):
44         return self._remote_addr
45
46     @property
47     def local_ip4(self):
48         """Local IPv4 address on VPP interface (string)."""
49         return self._local_ip4.address
50
51     @local_ip4.setter
52     def local_ip4(self, value):
53         self._local_ip4.address = value
54
55     @property
56     def local_ip4_prefix_len(self):
57         """Local IPv4 prefix length """
58         return self._local_ip4.len
59
60     @local_ip4_prefix_len.setter
61     def local_ip4_prefix_len(self, value):
62         self._local_ip4.len = value
63
64     @property
65     def local_ip4_prefix(self):
66         """Local IPv4 prefix """
67         return self._local_ip4
68
69     @property
70     def local_ip4n(self):
71         """DEPRECATED """
72         """Local IPv4 address - raw, suitable as API parameter."""
73         return socket.inet_pton(socket.AF_INET, self._local_ip4.address)
74
75     @property
76     def remote_ip4(self):
77         """IPv4 address of remote peer "connected" to this interface."""
78         return self._remote_hosts[0].ip4
79
80     @property
81     def remote_ip4n(self):
82         """DEPRECATED """
83         """Local IPv6 address - raw, suitable as API parameter."""
84         return socket.inet_pton(socket.AF_INET, self._remote_hosts[0].ip4)
85
86     @property
87     def local_ip6(self):
88         """Local IPv6 address on VPP interface (string)."""
89         return self._local_ip6.address
90
91     @local_ip6.setter
92     def local_ip6(self, value):
93         self._local_ip6.address = value
94
95     @property
96     def local_ip6_prefix_len(self):
97         """Local IPv6 prefix length """
98         return self._local_ip6.len
99
100     @local_ip6_prefix_len.setter
101     def local_ip6_prefix_len(self, value):
102         self._local_ip6.len = value
103
104     @property
105     def local_ip6_prefix(self):
106         """Local IPv6 prefix """
107         return self._local_ip6
108
109     @property
110     def local_ip6n(self):
111         """DEPRECATED """
112         """Local IPv6 address - raw, suitable as API parameter."""
113         return socket.inet_pton(socket.AF_INET6, self._local_ip6.address)
114
115     @property
116     def remote_ip6(self):
117         """IPv6 address of remote peer "connected" to this interface."""
118         return self._remote_hosts[0].ip6
119
120     @property
121     def remote_ip6n(self):
122         """DEPRECATED """
123         """Local IPv6 address - raw, suitable as API parameter."""
124         return socket.inet_pton(socket.AF_INET6, self._remote_hosts[0].ip6)
125
126     @property
127     def local_ip6_ll(self):
128         """Local IPv6 link-local address on VPP interface (string)."""
129         return self._local_ip6_ll.address
130
131     @property
132     def local_ip6n_ll(self):
133         """DEPRECATED """
134         """Local IPv6 link-local address on VPP interface (string)."""
135         return socket.inet_pton(socket.AF_INET6, self._local_ip6_ll.address)
136
137     @property
138     def remote_ip6_ll(self):
139         """Link-local IPv6 address of remote peer
140         "connected" to this interface."""
141         return self._remote_ip6_ll
142
143     @property
144     def remote_ip6n_ll(self):
145         """DEPRECATED """
146         """Local IPv6 link-local address on VPP interface (string)."""
147         return socket.inet_pton(socket.AF_INET6, self._remote_ip6_ll)
148
149     @property
150     def name(self):
151         """Name of the interface."""
152         return self._name
153
154     @property
155     def dump(self):
156         """RAW result of sw_interface_dump for this interface."""
157         return self._dump
158
159     @property
160     def test(self):
161         """Test case creating this interface."""
162         return self._test
163
164     @property
165     def remote_hosts(self):
166         """Remote hosts list"""
167         return self._remote_hosts
168
169     @remote_hosts.setter
170     def remote_hosts(self, value):
171         """
172         :param list value: List of remote hosts.
173         """
174         self._remote_hosts = value
175         self._hosts_by_mac = {}
176         self._hosts_by_ip4 = {}
177         self._hosts_by_ip6 = {}
178         for host in self._remote_hosts:
179             self._hosts_by_mac[host.mac] = host
180             self._hosts_by_ip4[host.ip4] = host
181             self._hosts_by_ip6[host.ip6] = host
182
183     def host_by_mac(self, mac):
184         """
185         :param mac: MAC address to find host by.
186         :return: Host object assigned to interface.
187         """
188         return self._hosts_by_mac[mac]
189
190     def host_by_ip4(self, ip):
191         """
192         :param ip: IPv4 address to find host by.
193         :return: Host object assigned to interface.
194         """
195         return self._hosts_by_ip4[ip]
196
197     def host_by_ip6(self, ip):
198         """
199         :param ip: IPv6 address to find host by.
200         :return: Host object assigned to interface.
201         """
202         return self._hosts_by_ip6[ip]
203
204     def generate_remote_hosts(self, count=1):
205         """Generate and add remote hosts for the interface.
206
207         :param int count: Number of generated remote hosts.
208         """
209         self._remote_hosts = []
210         self._hosts_by_mac = {}
211         self._hosts_by_ip4 = {}
212         self._hosts_by_ip6 = {}
213         for i in range(
214                 2, count + 2):  # 0: network address, 1: local vpp address
215             mac = "02:%02x:00:00:ff:%02x" % (self.sw_if_index, i)
216             ip4 = "172.16.%u.%u" % (self.sw_if_index, i)
217             ip6 = "fd01:%x::%x" % (self.sw_if_index, i)
218             ip6_ll = mk_ll_addr(mac)
219             host = Host(mac, ip4, ip6, ip6_ll)
220             self._remote_hosts.append(host)
221             self._hosts_by_mac[mac] = host
222             self._hosts_by_ip4[ip4] = host
223             self._hosts_by_ip6[ip6] = host
224
225     @abc.abstractmethod
226     def __init__(self, test):
227         self._test = test
228
229         self._remote_hosts = []
230         self._hosts_by_mac = {}
231         self._hosts_by_ip4 = {}
232         self._hosts_by_ip6 = {}
233
234     def set_mac(self, mac):
235         self._local_mac = str(mac)
236         self._local_ip6_ll = VppIpAddress(mk_ll_addr(self._local_mac))
237         self.test.vapi.sw_interface_set_mac_address(
238             self.sw_if_index, mac.packed)
239
240     def set_sw_if_index(self, sw_if_index):
241         self._sw_if_index = sw_if_index
242
243         self.generate_remote_hosts()
244
245         self._local_ip4 = VppIpPrefix("172.16.%u.1" % self.sw_if_index, 24)
246         self._local_ip4_subnet = "172.16.%u.0" % self.sw_if_index
247         self._local_ip4_bcast = "172.16.%u.255" % self.sw_if_index
248         self.has_ip4_config = False
249         self.ip4_table_id = 0
250
251         self._local_ip6 = VppIpPrefix("fd01:%x::1" % self.sw_if_index, 64)
252         self.has_ip6_config = False
253         self.ip6_table_id = 0
254
255         self._local_addr = {socket.AF_INET: self.local_ip4,
256                             socket.AF_INET6: self.local_ip6}
257         self._remote_addr = {socket.AF_INET: self.remote_ip4,
258                              socket.AF_INET6: self.remote_ip6}
259
260         r = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
261         for intf in r:
262             if intf.sw_if_index == self.sw_if_index:
263                 self._name = intf.interface_name
264                 self._local_mac = intf.l2_address
265                 self._dump = intf
266                 break
267         else:
268             raise Exception(
269                 "Could not find interface with sw_if_index %d "
270                 "in interface dump %s" %
271                 (self.sw_if_index, moves.reprlib.repr(r)))
272         self._local_ip6_ll = VppIpAddress(mk_ll_addr(self.local_mac))
273         self._remote_ip6_ll = mk_ll_addr(self.remote_mac)
274
275     def config_ip4(self):
276         """Configure IPv4 address on the VPP interface."""
277         self.test.vapi.sw_interface_add_del_address(
278             sw_if_index=self.sw_if_index, prefix=self._local_ip4.encode())
279         self.has_ip4_config = True
280
281     def unconfig_ip4(self):
282         """Remove IPv4 address on the VPP interface."""
283         try:
284             if self.has_ip4_config:
285                 self.test.vapi.sw_interface_add_del_address(
286                     sw_if_index=self.sw_if_index,
287                     prefix=self._local_ip4.encode(), is_add=0)
288         except AttributeError:
289             self.has_ip4_config = False
290         self.has_ip4_config = False
291
292     def configure_ipv4_neighbors(self):
293         """For every remote host assign neighbor's MAC to IPv4 addresses.
294
295         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
296         """
297         for host in self._remote_hosts:
298             self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
299                                                host.mac,
300                                                host.ip4)
301
302     def config_ip6(self):
303         """Configure IPv6 address on the VPP interface."""
304         self.test.vapi.sw_interface_add_del_address(
305             sw_if_index=self.sw_if_index, prefix=self._local_ip6.encode())
306         self.has_ip6_config = True
307
308     def unconfig_ip6(self):
309         """Remove IPv6 address on the VPP interface."""
310         try:
311             if self.has_ip6_config:
312                 self.test.vapi.sw_interface_add_del_address(
313                     sw_if_index=self.sw_if_index,
314                     prefix=self._local_ip6.encode(), is_add=0)
315         except AttributeError:
316             self.has_ip6_config = False
317         self.has_ip6_config = False
318
319     def configure_ipv6_neighbors(self):
320         """For every remote host assign neighbor's MAC to IPv6 addresses.
321
322         :param vrf_id: The FIB table / VRF ID. (Default value = 0)
323         """
324         for host in self._remote_hosts:
325             self.test.vapi.ip_neighbor_add_del(self.sw_if_index,
326                                                host.mac,
327                                                host.ip6)
328
329     def unconfig(self):
330         """Unconfigure IPv6 and IPv4 address on the VPP interface."""
331         self.unconfig_ip4()
332         self.unconfig_ip6()
333
334     def set_table_ip4(self, table_id):
335         """Set the interface in a IPv4 Table.
336
337         .. note:: Must be called before configuring IP4 addresses.
338         """
339         self.ip4_table_id = table_id
340         self.test.vapi.sw_interface_set_table(
341             self.sw_if_index, 0, self.ip4_table_id)
342
343     def set_table_ip6(self, table_id):
344         """Set the interface in a IPv6 Table.
345
346         .. note:: Must be called before configuring IP6 addresses.
347         """
348         self.ip6_table_id = table_id
349         self.test.vapi.sw_interface_set_table(
350             self.sw_if_index, 1, self.ip6_table_id)
351
352     def disable_ipv6_ra(self):
353         """Configure IPv6 RA suppress on the VPP interface."""
354         self.test.vapi.sw_interface_ip6nd_ra_config(
355             sw_if_index=self.sw_if_index,
356             suppress=1)
357
358     def ip6_ra_config(self, no=0, suppress=0, send_unicast=0):
359         """Configure IPv6 RA suppress on the VPP interface."""
360         self.test.vapi.sw_interface_ip6nd_ra_config(
361             sw_if_index=self.sw_if_index,
362             is_no=no,
363             suppress=suppress,
364             send_unicast=send_unicast)
365
366     def ip6_ra_prefix(self, prefix, is_no=0,
367                       off_link=0, no_autoconfig=0, use_default=0):
368         """Configure IPv6 RA suppress on the VPP interface.
369
370         prefix can be a string in the format of '<address>/<length_in_bits>'
371         or ipaddress.ipnetwork object (if strict.)"""
372
373         self.test.vapi.sw_interface_ip6nd_ra_prefix(
374             sw_if_index=self.sw_if_index,
375             prefix=prefix,
376             use_default=use_default,
377             off_link=off_link, no_autoconfig=no_autoconfig,
378             is_no=is_no)
379
380     def admin_up(self):
381         """Put interface ADMIN-UP."""
382         self.test.vapi.sw_interface_set_flags(
383             self.sw_if_index,
384             flags=VppEnum.vl_api_if_status_flags_t.IF_STATUS_API_FLAG_ADMIN_UP)
385
386     def admin_down(self):
387         """Put interface ADMIN-down."""
388         self.test.vapi.sw_interface_set_flags(self.sw_if_index,
389                                               flags=0)
390
391     def link_up(self):
392         """Put interface link-state-UP."""
393         self.test.vapi.cli("test interface link-state %s up" % self.name)
394
395     def link_down(self):
396         """Put interface link-state-down."""
397         self.test.vapi.cli("test interface link-state %s down" % self.name)
398
399     def ip6_enable(self):
400         """IPv6 Enable interface"""
401         self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
402                                                        enable=1)
403
404     def ip6_disable(self):
405         """Put interface ADMIN-DOWN."""
406         self.test.vapi.sw_interface_ip6_enable_disable(self.sw_if_index,
407                                                        enable=0)
408
409     def add_sub_if(self, sub_if):
410         """Register a sub-interface with this interface.
411
412         :param sub_if: sub-interface
413         """
414         if not hasattr(self, 'sub_if'):
415             self.sub_if = sub_if
416         else:
417             if isinstance(self.sub_if, list):
418                 self.sub_if.append(sub_if)
419             else:
420                 self.sub_if = sub_if
421
422     def enable_mpls(self):
423         """Enable MPLS on the VPP interface."""
424         self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index)
425
426     def disable_mpls(self):
427         """Enable MPLS on the VPP interface."""
428         self.test.vapi.sw_interface_set_mpls_enable(self.sw_if_index, 0)
429
430     def is_ip4_entry_in_fib_dump(self, dump):
431         for i in dump:
432             n = IPv4Network(text_type("%s/%d" % (self.local_ip4,
433                                                  self.local_ip4_prefix_len)))
434             if i.route.prefix == n and \
435                i.route.table_id == self.ip4_table_id:
436                 return True
437         return False
438
439     def set_unnumbered(self, ip_sw_if_index):
440         """ Set the interface to unnumbered via ip_sw_if_index """
441         self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
442                                                    self.sw_if_index)
443
444     def unset_unnumbered(self, ip_sw_if_index):
445         """ Unset the interface to unnumbered via ip_sw_if_index """
446         self.test.vapi.sw_interface_set_unnumbered(ip_sw_if_index,
447                                                    self.sw_if_index, is_add=0)
448
449     def set_proxy_arp(self, enable=1):
450         """ Set the interface to enable/disable Proxy ARP """
451         self.test.vapi.proxy_arp_intfc_enable_disable(
452             self.sw_if_index,
453             enable)
454
455     def query_vpp_config(self):
456         dump = self.test.vapi.sw_interface_dump(sw_if_index=self.sw_if_index)
457         return self.is_interface_config_in_dump(dump)
458
459     def get_interface_config_from_dump(self, dump):
460         for i in dump:
461             if i.interface_name.rstrip(' \t\r\n\0') == self.name and \
462                     i.sw_if_index == self.sw_if_index:
463                 return i
464         else:
465             return None
466
467     def is_interface_config_in_dump(self, dump):
468         return self.get_interface_config_from_dump(dump) is not None
469
470     def assert_interface_state(self, admin_up_down, link_up_down,
471                                expect_event=False):
472         if expect_event:
473             event = self.test.vapi.wait_for_event(timeout=1,
474                                                   name='sw_interface_event')
475             self.test.assert_equal(event.sw_if_index, self.sw_if_index,
476                                    "sw_if_index")
477             self.test.assert_equal((event.flags & 1), admin_up_down,
478                                    "admin state")
479             self.test.assert_equal((event.flags & 2), link_up_down,
480                                    "link state")
481         dump = self.test.vapi.sw_interface_dump()
482         if_state = self.get_interface_config_from_dump(dump)
483         self.test.assert_equal((if_state.flags & 1), admin_up_down,
484                                "admin state")
485         self.test.assert_equal((if_state.flags & 2), link_up_down,
486                                "link state")
487
488     def __str__(self):
489         return self.name
490
491     def get_rx_stats(self):
492         c = self.test.statistics.get_counter("^/if/rx$")
493         return c[0][self.sw_if_index]
494
495     def get_tx_stats(self):
496         c = self.test.statistics.get_counter("^/if/tx$")
497         return c[0][self.sw_if_index]