tests: vpp_memif fix formatting error in exception
[vpp.git] / src / plugins / memif / test / vpp_memif.py
1 import socket
2 from ipaddress import IPv4Network
3
4 import six
5
6 from vpp_object import VppObject
7 from vpp_papi import VppEnum
8
9
10 def get_if_dump(dump, sw_if_index):
11     for d in dump:
12         if (d.sw_if_index == sw_if_index):
13             return d
14
15
16 def query_all_memif_vpp_config(_test):
17     return _test.vapi.memif_dump()
18
19
20 def remove_all_memif_vpp_config(_test):
21     dump = _test.vapi.memif_dump()
22     for d in dump:
23         _test.vapi.memif_delete(d.sw_if_index)
24     dump = _test.vapi.memif_socket_filename_dump()
25     for d in dump:
26         if d.socket_id != 0:
27             _test.vapi.memif_socket_filename_add_del(
28                 0, d.socket_id, d.socket_filename)
29
30
31 class VppSocketFilename(VppObject):
32     def __init__(self, test, socket_id, socket_filename,
33                  add_default_folder=False):
34         self._test = test
35         self.socket_id = socket_id
36         self.socket_filename = socket_filename
37
38         # if True insert default socket folder before socket filename,
39         # after adding vpp config
40         self.add_default_folder = add_default_folder
41
42     def add_vpp_config(self):
43         rv = self._test.vapi.memif_socket_filename_add_del(
44             1, self.socket_id, self.socket_filename)
45         if self.add_default_folder:
46             self.socket_filename = "%s/%s" % (self._test.tempdir,
47                                               self.socket_filename)
48         return rv
49
50     def remove_vpp_config(self):
51         return self._test.vapi.memif_socket_filename_add_del(
52             0, self.socket_id, self.socket_filename)
53
54     def query_vpp_config(self):
55         return self._test.vapi.memif_socket_filename_dump()
56
57     def object_id(self):
58         return "socket-filename-%d-%s" % (self.socket_id, self.socket_filename)
59
60
61 class VppMemif(VppObject):
62     def __init__(self, test, role, mode, rx_queues=0, tx_queues=0, if_id=0,
63                  socket_id=0, secret="", ring_size=0, buffer_size=0,
64                  hw_addr=""):
65         self._test = test
66         self.role = role
67         self.mode = mode
68         self.rx_queues = rx_queues
69         self.tx_queues = tx_queues
70         self.if_id = if_id
71         self.socket_id = socket_id
72         self.secret = secret
73         self.ring_size = ring_size
74         self.buffer_size = buffer_size
75         self.hw_addr = hw_addr
76         self.sw_if_index = None
77         self.ip_prefix = IPv4Network("192.168.%d.%d/24" %
78                                      (self.if_id + 1, self.role + 1),
79                                      strict=False)
80
81     def add_vpp_config(self):
82         rv = self._test.vapi.memif_create(
83             role=self.role,
84             mode=self.mode,
85             rx_queues=self.rx_queues,
86             tx_queues=self.tx_queues,
87             id=self.if_id,
88             socket_id=self.socket_id,
89             secret=self.secret,
90             ring_size=self.ring_size,
91             buffer_size=self.buffer_size,
92             hw_addr=self.hw_addr)
93         try:
94             self.sw_if_index = rv.sw_if_index
95         except AttributeError:
96             # rv doesn't have .sw_if_index attribute
97             raise AttributeError("%s %s" % (self, rv))
98
99         return self.sw_if_index
100
101     def admin_up(self):
102         if self.sw_if_index:
103             return self._test.vapi.sw_interface_set_flags(
104                 sw_if_index=self.sw_if_index, flags=1)
105
106     def admin_down(self):
107         if self.sw_if_index:
108             return self._test.vapi.sw_interface_set_flags(
109                 sw_if_index=self.sw_if_index, flags=0)
110
111     def wait_for_link_up(self, timeout, step=1):
112         if not self.sw_if_index:
113             return False
114         while True:
115             dump = self.query_vpp_config()
116             f = VppEnum.vl_api_if_status_flags_t.IF_STATUS_API_FLAG_LINK_UP
117             if dump.flags & f:
118                 return True
119             self._test.sleep(step)
120             timeout -= step
121             if timeout <= 0:
122                 return False
123
124     def config_ip4(self):
125         return self._test.vapi.sw_interface_add_del_address(
126             sw_if_index=self.sw_if_index, prefix=self.ip_prefix)
127
128     def remove_vpp_config(self):
129         self._test.vapi.memif_delete(self.sw_if_index)
130         self.sw_if_index = None
131
132     def query_vpp_config(self):
133         if not self.sw_if_index:
134             return None
135         dump = self._test.vapi.memif_dump()
136         return get_if_dump(dump, self.sw_if_index)
137
138     def object_id(self):
139         if self.sw_if_index:
140             return "%d:%d:%d" % (self.role, self.if_id, self.sw_if_index)
141         else:
142             return "%d:%d:None" % (self.role, self.if_id)