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."""
16 from robot.api import logger
18 from resources.libraries.python.Constants import Constants
19 from resources.libraries.python.DUTSetup import DUTSetup
20 from resources.libraries.python.PapiExecutor import PapiExecutor
21 from resources.libraries.python.ssh import exec_cmd_no_error
22 from resources.libraries.python.topology import NodeType
23 from resources.libraries.python.VatExecutor import VatExecutor
26 class VPPUtil(object):
27 """General class for any VPP related methods/functions."""
30 def show_vpp_settings(node, *additional_cmds):
31 """Print default VPP settings. In case others are needed, can be
32 accepted as next parameters (each setting one parameter), preferably
35 :param node: VPP node.
36 :param additional_cmds: Additional commands that the vpp should print
39 :type additional_cmds: tuple
41 def_setting_tb_displayed = {
42 'IPv6 FIB': 'ip6 fib',
44 'Interface IP': 'int addr',
51 for cmd in additional_cmds:
52 def_setting_tb_displayed['Custom Setting: {}'.format(cmd)] = cmd
54 for _, cmd in def_setting_tb_displayed.items():
55 command = 'vppctl sh {cmd}'.format(cmd=cmd)
56 exec_cmd_no_error(node, command, timeout=30, sudo=True)
59 def restart_vpp_service(node):
60 """Restart VPP service on the specified topology node.
62 :param node: Topology node.
65 DUTSetup.restart_service(node, Constants.VPP_UNIT)
68 def restart_vpp_service_on_all_duts(nodes):
69 """Restart VPP service on all DUT nodes.
71 :param nodes: Topology nodes.
74 for node in nodes.values():
75 if node['type'] == NodeType.DUT:
76 VPPUtil.restart_vpp_service(node)
79 def stop_vpp_service(node):
80 """Stop VPP service on the specified topology node.
82 :param node: Topology node.
85 DUTSetup.stop_service(node, Constants.VPP_UNIT)
88 def stop_vpp_service_on_all_duts(nodes):
89 """Stop VPP service on all DUT nodes.
91 :param nodes: Topology nodes.
94 for node in nodes.values():
95 if node['type'] == NodeType.DUT:
96 VPPUtil.stop_vpp_service(node)
99 def verify_vpp_installed(node):
100 """Verify that VPP is installed on the specified topology node.
102 :param node: Topology node.
105 cmd = 'command -v vpp'
107 node, cmd, message='VPP is not installed!')
110 def verify_vpp_started(node):
111 """Verify that VPP is started on the specified topology node.
113 :param node: Topology node.
116 cmd = ('vppctl show pci 2>&1 | '
117 'fgrep -v "Connection refused" | '
118 'fgrep -v "No such file or directory"')
120 node, cmd, sudo=True, message='VPP failed to start!', retries=120)
123 def verify_vpp(node):
124 """Verify that VPP is installed and started on the specified topology
127 :param node: Topology node.
129 :raises RuntimeError: If VPP service fails to start.
131 VPPUtil.verify_vpp_installed(node)
133 # Verify responsivness of vppctl.
134 VPPUtil.verify_vpp_started(node)
135 # Verify responsivness of PAPI.
136 VPPUtil.show_log(node)
138 DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
141 def verify_vpp_on_all_duts(nodes):
142 """Verify that VPP is installed and started on all DUT nodes.
144 :param nodes: Nodes in the topology.
147 for node in nodes.values():
148 if node['type'] == NodeType.DUT:
149 VPPUtil.verify_vpp(node)
152 def vpp_show_version(node, verbose=True):
153 """Run "show_version" PAPI command.
155 :param node: Node to run command on.
156 :param verbose: Show version, compile date and compile location if True
157 otherwise show only version.
160 :returns: VPP version.
163 with PapiExecutor(node) as papi_exec:
164 data = papi_exec.add('show_version').execute_should_pass().\
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 vat.execute_script("show_interface.vat", node, json_out=False)
198 vat.script_should_have_passed()
199 except AssertionError:
200 raise RuntimeError('Failed to get VPP interfaces on host: {name}'.
201 format(name=node['host']))
204 def vpp_show_crypto_device_mapping(node):
205 """Run "show crypto device mapping" CLI command.
207 :param node: Node to run command on.
211 vat.execute_script("show_crypto_device_mapping.vat", node,
215 def vpp_enable_traces_on_dut(node):
216 """Enable vpp packet traces on the DUT node.
218 :param node: DUT node to set up.
222 vat.execute_script("enable_dpdk_traces.vat", node, json_out=False)
223 vat.execute_script("enable_vhost_user_traces.vat", node, json_out=False)
224 vat.execute_script("enable_memif_traces.vat", node, json_out=False)
227 def vpp_enable_traces_on_all_duts(nodes):
228 """Enable vpp packet traces on all DUTs in the given topology.
230 :param nodes: Nodes in the topology.
233 for node in nodes.values():
234 if node['type'] == NodeType.DUT:
235 VPPUtil.vpp_enable_traces_on_dut(node)
238 def vpp_enable_elog_traces_on_dut(node):
239 """Enable API/CLI/Barrier traces on the DUT node.
241 :param node: DUT node to set up.
245 vat.execute_script("elog_trace_api_cli_barrier.vat", node,
249 def vpp_enable_elog_traces_on_all_duts(nodes):
250 """Enable API/CLI/Barrier traces on all DUTs in the given topology.
252 :param nodes: Nodes in the topology.
255 for node in nodes.values():
256 if node['type'] == NodeType.DUT:
257 VPPUtil.vpp_enable_elog_traces_on_dut(node)
260 def show_event_logger_on_dut(node):
261 """Show event logger on the DUT node.
263 :param node: DUT node to show traces on.
267 vat.execute_script("show_event_logger.vat", node, json_out=False)
270 def show_event_logger_on_all_duts(nodes):
271 """Show event logger on all DUTs in the given topology.
273 :param nodes: Nodes in the topology.
276 for node in nodes.values():
277 if node['type'] == NodeType.DUT:
278 VPPUtil.show_event_logger_on_dut(node)
282 """Show log on the specified topology node.
284 :param node: Topology node.
286 :returns: VPP log data.
289 with PapiExecutor(node) as papi_exec:
290 return papi_exec.add('cli_inband', cmd='show log').get_replies().\
291 verify_reply()["reply"]
294 def vpp_show_threads(node):
295 """Show VPP threads on node.
297 :param node: Node to run command on.
299 :returns: VPP thread data.
302 with PapiExecutor(node) as papi_exec:
303 return papi_exec.add('show_threads').execute_should_pass().\
304 verify_reply()["thread_data"]