1 # Copyright (c) 2019 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """VPP util library."""
18 from robot.api import logger
20 from resources.libraries.python.Constants import Constants
21 from resources.libraries.python.DUTSetup import DUTSetup
22 from resources.libraries.python.PapiExecutor import PapiExecutor
23 from resources.libraries.python.ssh import exec_cmd_no_error
24 from resources.libraries.python.topology import NodeType
27 class VPPUtil(object):
28 """General class for any VPP related methods/functions."""
31 def show_vpp_settings(node, *additional_cmds):
32 """Print default VPP settings. In case others are needed, can be
33 accepted as next parameters (each setting one parameter), preferably
36 :param node: VPP node.
37 :param additional_cmds: Additional commands that the vpp should print
40 :type additional_cmds: tuple
42 def_setting_tb_displayed = {
43 'IPv6 FIB': 'ip6 fib',
45 'Interface IP': 'int addr',
52 for cmd in additional_cmds:
53 def_setting_tb_displayed['Custom Setting: {}'.format(cmd)] = cmd
55 for _, cmd in def_setting_tb_displayed.items():
56 command = 'vppctl sh {cmd}'.format(cmd=cmd)
57 exec_cmd_no_error(node, command, timeout=30, sudo=True)
60 def restart_vpp_service(node):
61 """Restart VPP service on the specified topology node.
63 :param node: Topology node.
66 DUTSetup.restart_service(node, Constants.VPP_UNIT)
69 def restart_vpp_service_on_all_duts(nodes):
70 """Restart VPP service on all DUT nodes.
72 :param nodes: Topology nodes.
75 for node in nodes.values():
76 if node['type'] == NodeType.DUT:
77 VPPUtil.restart_vpp_service(node)
80 def stop_vpp_service(node):
81 """Stop VPP service on the specified topology node.
83 :param node: Topology node.
86 DUTSetup.stop_service(node, Constants.VPP_UNIT)
89 def stop_vpp_service_on_all_duts(nodes):
90 """Stop VPP service on all DUT nodes.
92 :param nodes: Topology nodes.
95 for node in nodes.values():
96 if node['type'] == NodeType.DUT:
97 VPPUtil.stop_vpp_service(node)
100 def verify_vpp_installed(node):
101 """Verify that VPP is installed on the specified topology node.
103 :param node: Topology node.
106 cmd = 'command -v vpp'
108 node, cmd, message='VPP is not installed!')
111 def verify_vpp_started(node):
112 """Verify that VPP is started on the specified topology node.
114 :param node: Topology node.
117 cmd = ('vppctl show pci 2>&1 | '
118 'fgrep -v "Connection refused" | '
119 'fgrep -v "No such file or directory"')
121 node, cmd, sudo=True, message='VPP failed to start!', retries=120)
124 def verify_vpp(node):
125 """Verify that VPP is installed and started on the specified topology
128 :param node: Topology node.
130 :raises RuntimeError: If VPP service fails to start.
132 VPPUtil.verify_vpp_installed(node)
134 # Verify responsivness of vppctl.
135 VPPUtil.verify_vpp_started(node)
136 # Verify responsivness of PAPI.
137 VPPUtil.show_log(node)
139 DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
142 def verify_vpp_on_all_duts(nodes):
143 """Verify that VPP is installed and started on all DUT nodes.
145 :param nodes: Nodes in the topology.
148 for node in nodes.values():
149 if node['type'] == NodeType.DUT:
150 VPPUtil.verify_vpp(node)
153 def vpp_show_version(node, verbose=True):
154 """Run "show_version" PAPI command.
156 :param node: Node to run command on.
157 :param verbose: Show version, compile date and compile location if True
158 otherwise show only version.
161 :returns: VPP version.
164 with PapiExecutor(node) as papi_exec:
165 data = papi_exec.add('show_version').get_replies().verify_reply()
166 version = ('VPP version: {ver}\n'.
167 format(ver=data['version'].rstrip('\0x00')))
169 version += ('Compile date: {date}\n'
170 'Compile location: {cl}\n '.
171 format(date=data['build_date'].rstrip('\0x00'),
172 cl=data['build_directory'].rstrip('\0x00')))
174 return data['version'].rstrip('\0x00')
177 def show_vpp_version_on_all_duts(nodes):
178 """Show VPP version verbose on all DUTs.
180 :param nodes: Nodes in the topology.
183 for node in nodes.values():
184 if node['type'] == NodeType.DUT:
185 VPPUtil.vpp_show_version(node)
188 def vpp_show_interfaces(node):
189 """Run "show interface" CLI command.
191 :param node: Node to run command on.
195 cmd = 'sw_interface_dump'
196 cmd_reply = 'sw_interface_details'
197 args = dict(name_filter_valid=0, name_filter='')
198 err_msg = 'Failed to get interface dump on host {host}'.format(
200 with PapiExecutor(node) as papi_exec:
201 papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg)
203 papi_if_dump = papi_resp.reply[0]['api_reply']
206 for item in papi_if_dump:
207 data = item[cmd_reply]
208 data['interface_name'] = data['interface_name'].rstrip('\x00')
209 data['tag'] = data['tag'].rstrip('\x00')
210 data['l2_address'] = str(':'.join(binascii.hexlify(
211 data['l2_address'])[i:i + 2] for i in range(0, 12, 2)).
214 # TODO: return only base data
215 logger.trace('Interface data of host {host}:\n{if_data}'.format(
216 host=node['host'], if_data=if_data))
219 def vpp_enable_traces_on_dut(node, fail_on_error=True):
220 """Enable vpp packet traces on the DUT node.
222 :param node: DUT node to set up.
223 :param fail_on_error: If True, keyword fails if an error occurs,
226 :type fail_on_error: bool
229 "trace add dpdk-input 50",
230 "trace add vhost-user-input 50",
231 "trace add memif-input 50"
236 PapiExecutor.run_cli_cmd(node, cmd)
237 except AssertionError as err:
241 logger.error(repr(err))
244 def vpp_enable_traces_on_all_duts(nodes, fail_on_error=True):
245 """Enable vpp packet traces on all DUTs in the given topology.
247 :param nodes: Nodes in the topology.
248 :param fail_on_error: If True, keyword fails if an error occurs,
251 :type fail_on_error: bool
253 for node in nodes.values():
254 if node['type'] == NodeType.DUT:
255 VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error)
258 def vpp_enable_elog_traces_on_dut(node):
259 """Enable API/CLI/Barrier traces on the DUT node.
261 :param node: DUT node to set up.
264 PapiExecutor.run_cli_cmd(node, "elog trace api cli barrier")
267 def vpp_enable_elog_traces_on_all_duts(nodes):
268 """Enable API/CLI/Barrier traces on all DUTs in the given topology.
270 :param nodes: Nodes in the topology.
273 for node in nodes.values():
274 if node['type'] == NodeType.DUT:
275 VPPUtil.vpp_enable_elog_traces_on_dut(node)
278 def show_event_logger_on_dut(node):
279 """Show event logger on the DUT node.
281 :param node: DUT node to show traces on.
284 PapiExecutor.run_cli_cmd(node, "show event-logger")
287 def show_event_logger_on_all_duts(nodes):
288 """Show event logger on all DUTs in the given topology.
290 :param nodes: Nodes in the topology.
293 for node in nodes.values():
294 if node['type'] == NodeType.DUT:
295 VPPUtil.show_event_logger_on_dut(node)
299 """Show log on the specified topology node.
301 :param node: Topology node.
303 :returns: VPP log data.
306 return PapiExecutor.run_cli_cmd(node, "show log")["reply"]
309 def vpp_show_threads(node):
310 """Show VPP threads on node.
312 :param node: Node to run command on.
314 :returns: VPP thread data.
317 with PapiExecutor(node) as papi_exec:
318 data = papi_exec.add('show_threads').get_replies().\
319 verify_reply()["thread_data"]
321 threads_data = list()
325 if isinstance(item, unicode):
326 item = item.rstrip('\x00')
327 thread_data.append(item)
328 threads_data.append(thread_data)
330 logger.info("show threads:\n{threads}".format(threads=threads_data))