resources/libraries/python/VPPUtil.py

   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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """VPP util library."""
  15
  16 from robot.api import logger
  17
  18 from resources.libraries.python.Constants import Constants
  19 from resources.libraries.python.DUTSetup import DUTSetup
  20 from resources.libraries.python.L2Util import L2Util
  21 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
  22 from resources.libraries.python.ssh import exec_cmd_no_error
  23 from resources.libraries.python.topology import NodeType
  24
  25
  26 class VPPUtil(object):
  27     """General class for any VPP related methods/functions."""
  28
  29     @staticmethod
  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
  33         in form of a string.
  34
  35         :param node: VPP node.
  36         :param additional_cmds: Additional commands that the vpp should print
  37             settings for.
  38         :type node: dict
  39         :type additional_cmds: tuple
  40         """
  41         def_setting_tb_displayed = {
  42             'IPv6 FIB': 'ip6 fib',
  43             'IPv4 FIB': 'ip fib',
  44             'Interface IP': 'int addr',
  45             'Interfaces': 'int',
  46             'ARP': 'ip arp',
  47             'Errors': 'err'
  48         }
  49
  50         if additional_cmds:
  51             for cmd in additional_cmds:
  52                 def_setting_tb_displayed['Custom Setting: {}'.format(cmd)] = cmd
  53
  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)
  57
  58     @staticmethod
  59     def restart_vpp_service(node):
  60         """Restart VPP service on the specified topology node.
  61
  62         :param node: Topology node.
  63         :type node: dict
  64         """
  65         DUTSetup.restart_service(node, Constants.VPP_UNIT)
  66
  67     @staticmethod
  68     def restart_vpp_service_on_all_duts(nodes):
  69         """Restart VPP service on all DUT nodes.
  70
  71         :param nodes: Topology nodes.
  72         :type nodes: dict
  73         """
  74         for node in nodes.values():
  75             if node['type'] == NodeType.DUT:
  76                 VPPUtil.restart_vpp_service(node)
  77
  78     @staticmethod
  79     def stop_vpp_service(node):
  80         """Stop VPP service on the specified topology node.
  81
  82         :param node: Topology node.
  83         :type node: dict
  84         """
  85         DUTSetup.stop_service(node, Constants.VPP_UNIT)
  86
  87     @staticmethod
  88     def stop_vpp_service_on_all_duts(nodes):
  89         """Stop VPP service on all DUT nodes.
  90
  91         :param nodes: Topology nodes.
  92         :type nodes: dict
  93         """
  94         for node in nodes.values():
  95             if node['type'] == NodeType.DUT:
  96                 VPPUtil.stop_vpp_service(node)
  97
  98     @staticmethod
  99     def verify_vpp_installed(node):
 100         """Verify that VPP is installed on the specified topology node.
 101
 102         :param node: Topology node.
 103         :type node: dict
 104         """
 105         cmd = 'command -v vpp'
 106         exec_cmd_no_error(
 107             node, cmd, message='VPP is not installed!')
 108
 109     @staticmethod
 110     def verify_vpp_started(node):
 111         """Verify that VPP is started on the specified topology node.
 112
 113         :param node: Topology node.
 114         :type node: dict
 115         """
 116         cmd = ('vppctl show pci 2>&1 | '
 117                'fgrep -v "Connection refused" | '
 118                'fgrep -v "No such file or directory"')
 119         exec_cmd_no_error(
 120             node, cmd, sudo=True, message='VPP failed to start!', retries=120)
 121
 122     @staticmethod
 123     def verify_vpp(node):
 124         """Verify that VPP is installed and started on the specified topology
 125         node.
 126
 127         :param node: Topology node.
 128         :type node: dict
 129         :raises RuntimeError: If VPP service fails to start.
 130         """
 131         VPPUtil.verify_vpp_installed(node)
 132         try:
 133             # Verify responsivness of vppctl.
 134             VPPUtil.verify_vpp_started(node)
 135             # Verify responsivness of PAPI.
 136             VPPUtil.show_log(node)
 137             VPPUtil.vpp_show_version(node)
 138         finally:
 139             DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
 140
 141     @staticmethod
 142     def verify_vpp_on_all_duts(nodes):
 143         """Verify that VPP is installed and started on all DUT nodes.
 144
 145         :param nodes: Nodes in the topology.
 146         :type nodes: dict
 147         """
 148         for node in nodes.values():
 149             if node['type'] == NodeType.DUT:
 150                 VPPUtil.verify_vpp(node)
 151
 152     @staticmethod
 153     def vpp_show_version(node, verbose=True):
 154         """Run "show_version" PAPI command.
 155
 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.
 159         :type node: dict
 160         :type verbose: bool
 161         :returns: VPP version.
 162         :rtype: str
 163         """
 164         with PapiSocketExecutor(node) as papi_exec:
 165             reply = papi_exec.add('show_version').get_reply()
 166         return_version = reply['version'].rstrip('\0x00')
 167         version = 'VPP version:      {ver}\n'.format(ver=return_version)
 168         if verbose:
 169             version += ('Compile date:     {date}\n'
 170                         'Compile location: {cl}\n'.
 171                         format(date=reply['build_date'].rstrip('\0x00'),
 172                                cl=reply['build_directory'].rstrip('\0x00')))
 173         logger.info(version)
 174         return return_version
 175
 176     @staticmethod
 177     def show_vpp_version_on_all_duts(nodes):
 178         """Show VPP version verbose on all DUTs.
 179
 180         :param nodes: Nodes in the topology.
 181         :type nodes: dict
 182         """
 183         for node in nodes.values():
 184             if node['type'] == NodeType.DUT:
 185                 VPPUtil.vpp_show_version(node)
 186
 187     @staticmethod
 188     def vpp_show_interfaces(node):
 189         """Run "show interface" CLI command.
 190
 191         :param node: Node to run command on.
 192         :type node: dict
 193         """
 194
 195         cmd = 'sw_interface_dump'
 196         args = dict(name_filter_valid=0, name_filter='')
 197         err_msg = 'Failed to get interface dump on host {host}'.format(
 198             host=node['host'])
 199         with PapiSocketExecutor(node) as papi_exec:
 200             details = papi_exec.add(cmd, **args).get_details(err_msg)
 201
 202         for if_dump in details:
 203             if_dump['interface_name'] = if_dump['interface_name'].rstrip('\x00')
 204             if_dump['tag'] = if_dump['tag'].rstrip('\x00')
 205             if_dump['l2_address'] = L2Util.bin_to_mac(if_dump['l2_address'])
 206         # TODO: return only base data
 207         logger.trace('Interface data of host {host}:\n{details}'.format(
 208             host=node['host'], details=details))
 209
 210     @staticmethod
 211     def vpp_enable_traces_on_dut(node, fail_on_error=False):
 212         """Enable vpp packet traces on the DUT node.
 213
 214         :param node: DUT node to set up.
 215         :param fail_on_error: If True, keyword fails if an error occurs,
 216             otherwise passes.
 217         :type node: dict
 218         :type fail_on_error: bool
 219         """
 220         cmds = [
 221             "trace add dpdk-input 50",
 222             "trace add vhost-user-input 50",
 223             "trace add memif-input 50"
 224         ]
 225
 226         for cmd in cmds:
 227             try:
 228                 PapiSocketExecutor.run_cli_cmd(node, cmd)
 229             except AssertionError:
 230                 if fail_on_error:
 231                     raise
 232
 233     @staticmethod
 234     def vpp_enable_traces_on_all_duts(nodes, fail_on_error=False):
 235         """Enable vpp packet traces on all DUTs in the given topology.
 236
 237         :param nodes: Nodes in the topology.
 238         :param fail_on_error: If True, keyword fails if an error occurs,
 239             otherwise passes.
 240         :type nodes: dict
 241         :type fail_on_error: bool
 242         """
 243         for node in nodes.values():
 244             if node['type'] == NodeType.DUT:
 245                 VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error)
 246
 247     @staticmethod
 248     def vpp_enable_elog_traces_on_dut(node):
 249         """Enable API/CLI/Barrier traces on the DUT node.
 250
 251         :param node: DUT node to set up.
 252         :type node: dict
 253         """
 254         PapiSocketExecutor.run_cli_cmd(node, "elog trace api cli barrier")
 255
 256     @staticmethod
 257     def vpp_enable_elog_traces_on_all_duts(nodes):
 258         """Enable API/CLI/Barrier traces on all DUTs in the given topology.
 259
 260         :param nodes: Nodes in the topology.
 261         :type nodes: dict
 262         """
 263         for node in nodes.values():
 264             if node['type'] == NodeType.DUT:
 265                 VPPUtil.vpp_enable_elog_traces_on_dut(node)
 266
 267     @staticmethod
 268     def show_event_logger_on_dut(node):
 269         """Show event logger on the DUT node.
 270
 271         :param node: DUT node to show traces on.
 272         :type node: dict
 273         """
 274         PapiSocketExecutor.run_cli_cmd(node, "show event-logger")
 275
 276     @staticmethod
 277     def show_event_logger_on_all_duts(nodes):
 278         """Show event logger on all DUTs in the given topology.
 279
 280         :param nodes: Nodes in the topology.
 281         :type nodes: dict
 282         """
 283         for node in nodes.values():
 284             if node['type'] == NodeType.DUT:
 285                 VPPUtil.show_event_logger_on_dut(node)
 286
 287     @staticmethod
 288     def show_log(node):
 289         """Show log on the specified topology node.
 290
 291         :param node: Topology node.
 292         :type node: dict
 293         :returns: VPP log data.
 294         :rtype: list
 295         """
 296         return PapiSocketExecutor.run_cli_cmd(node, "show log")
 297
 298     @staticmethod
 299     def vpp_show_threads(node):
 300         """Show VPP threads on node.
 301
 302         :param node: Node to run command on.
 303         :type node: dict
 304         :returns: VPP thread data.
 305         :rtype: list
 306         """
 307         with PapiSocketExecutor(node) as papi_exec:
 308             reply = papi_exec.add('show_threads').get_reply()
 309
 310         threads_data = list()
 311         for thread in reply["thread_data"]:
 312             thread_data = list()
 313             for item in thread:
 314                 if isinstance(item, unicode):
 315                     item = item.rstrip('\x00')
 316                 thread_data.append(item)
 317             threads_data.append(thread_data)
 318
 319         logger.info("show threads:\n{threads}".format(threads=threads_data))
 320
 321         return threads_data