X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVPPUtil.py;h=6e3ff707eae58757c84ce962e146beeb64653325;hb=8b1bead7b4b70e3ff4e7d4cb82940695d763ed2d;hp=32e1bb4e7b76067567722e6ff85beeb2c9270522;hpb=a8fcf79bbe184a7ef8c813239400cd8c9de89254;p=csit.git diff --git a/resources/libraries/python/VPPUtil.py b/resources/libraries/python/VPPUtil.py index 32e1bb4e7b..6e3ff707ea 100644 --- a/resources/libraries/python/VPPUtil.py +++ b/resources/libraries/python/VPPUtil.py @@ -1,4 +1,4 @@ -# Copyright (c) 2016 Cisco and/or its affiliates. +# Copyright (c) 2019 Cisco and/or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -11,8 +11,15 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""VPP util library""" -from resources.libraries.python.ssh import SSH +"""VPP util library.""" + +from robot.api import logger + +from resources.libraries.python.Constants import Constants +from resources.libraries.python.DUTSetup import DUTSetup +from resources.libraries.python.PapiExecutor import PapiSocketExecutor +from resources.libraries.python.ssh import exec_cmd_no_error +from resources.libraries.python.topology import NodeType class VPPUtil(object): @@ -26,7 +33,7 @@ class VPPUtil(object): :param node: VPP node. :param additional_cmds: Additional commands that the vpp should print - settings for. + settings for. :type node: dict :type additional_cmds: tuple """ @@ -42,11 +49,284 @@ class VPPUtil(object): if additional_cmds: for cmd in additional_cmds: def_setting_tb_displayed['Custom Setting: {}'.format(cmd)] = cmd - ssh = SSH() - ssh.connect(node) - print("=" * 40) - for key, value in def_setting_tb_displayed.iteritems(): - (_, stdout, _) = ssh.exec_command_sudo('vppctl sh {}'.format(value)) - print("{} : {} \n".format(key, value)) - print(stdout) - print("=" * 40) + + for _, cmd in def_setting_tb_displayed.items(): + command = 'vppctl sh {cmd}'.format(cmd=cmd) + exec_cmd_no_error(node, command, timeout=30, sudo=True) + + @staticmethod + def restart_vpp_service(node): + """Restart VPP service on the specified topology node. + + :param node: Topology node. + :type node: dict + """ + DUTSetup.restart_service(node, Constants.VPP_UNIT) + + @staticmethod + def restart_vpp_service_on_all_duts(nodes): + """Restart VPP service on all DUT nodes. + + :param nodes: Topology nodes. + :type nodes: dict + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.restart_vpp_service(node) + + @staticmethod + def stop_vpp_service(node): + """Stop VPP service on the specified topology node. + + :param node: Topology node. + :type node: dict + """ + DUTSetup.stop_service(node, Constants.VPP_UNIT) + + @staticmethod + def stop_vpp_service_on_all_duts(nodes): + """Stop VPP service on all DUT nodes. + + :param nodes: Topology nodes. + :type nodes: dict + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.stop_vpp_service(node) + + @staticmethod + def verify_vpp_installed(node): + """Verify that VPP is installed on the specified topology node. + + :param node: Topology node. + :type node: dict + """ + cmd = 'command -v vpp' + exec_cmd_no_error( + node, cmd, message='VPP is not installed!') + + @staticmethod + def verify_vpp_started(node): + """Verify that VPP is started on the specified topology node. + + :param node: Topology node. + :type node: dict + """ + cmd = ('vppctl show pci 2>&1 | ' + 'fgrep -v "Connection refused" | ' + 'fgrep -v "No such file or directory"') + exec_cmd_no_error( + node, cmd, sudo=True, message='VPP failed to start!', retries=120) + + @staticmethod + def verify_vpp(node): + """Verify that VPP is installed and started on the specified topology + node. + + :param node: Topology node. + :type node: dict + :raises RuntimeError: If VPP service fails to start. + """ + VPPUtil.verify_vpp_installed(node) + try: + # Verify responsivness of vppctl. + VPPUtil.verify_vpp_started(node) + # Verify responsivness of PAPI. + VPPUtil.show_log(node) + VPPUtil.vpp_show_version(node) + finally: + DUTSetup.get_service_logs(node, Constants.VPP_UNIT) + + @staticmethod + def verify_vpp_on_all_duts(nodes): + """Verify that VPP is installed and started on all DUT nodes. + + :param nodes: Nodes in the topology. + :type nodes: dict + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.verify_vpp(node) + + @staticmethod + def vpp_show_version(node, verbose=True): + """Run "show_version" PAPI command. + + :param node: Node to run command on. + :param verbose: Show version, compile date and compile location if True + otherwise show only version. + :type node: dict + :type verbose: bool + :returns: VPP version. + :rtype: str + """ + cmd = 'show_version' + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add(cmd).get_reply() + return_version = reply['version'].rstrip('\0x00') + version = 'VPP version: {ver}\n'.format(ver=return_version) + if verbose: + version += ('Compile date: {date}\n' + 'Compile location: {cl}\n'. + format(date=reply['build_date'].rstrip('\0x00'), + cl=reply['build_directory'].rstrip('\0x00'))) + logger.info(version) + return return_version + + @staticmethod + def show_vpp_version_on_all_duts(nodes): + """Show VPP version verbose on all DUTs. + + :param nodes: Nodes in the topology. + :type nodes: dict + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.vpp_show_version(node) + + @staticmethod + def vpp_show_interfaces(node): + """Run "show interface" CLI command. + + :param node: Node to run command on. + :type node: dict + """ + + cmd = 'sw_interface_dump' + args = dict( + name_filter_valid=False, + name_filter='' + ) + err_msg = 'Failed to get interface dump on host {host}'.format( + host=node['host']) + with PapiSocketExecutor(node) as papi_exec: + details = papi_exec.add(cmd, **args).get_details(err_msg) + + for if_dump in details: + if_dump['l2_address'] = str(if_dump['l2_address']) + if_dump['b_dmac'] = str(if_dump['b_dmac']) + if_dump['b_smac'] = str(if_dump['b_smac']) + if_dump['flags'] = if_dump['flags'].value + if_dump['type'] = if_dump['type'].value + if_dump['link_duplex'] = if_dump['link_duplex'].value + if_dump['sub_if_flags'] = if_dump['sub_if_flags'].value \ + if hasattr(if_dump['sub_if_flags'], 'value') \ + else int(if_dump['sub_if_flags']) + # TODO: return only base data + logger.trace('Interface data of host {host}:\n{details}'.format( + host=node['host'], details=details)) + + @staticmethod + def vpp_enable_traces_on_dut(node, fail_on_error=False): + """Enable vpp packet traces on the DUT node. + + :param node: DUT node to set up. + :param fail_on_error: If True, keyword fails if an error occurs, + otherwise passes. + :type node: dict + :type fail_on_error: bool + """ + cmds = [ + "trace add dpdk-input 50", + "trace add vhost-user-input 50", + "trace add memif-input 50", + "trace add avf-input 50" + ] + + for cmd in cmds: + try: + PapiSocketExecutor.run_cli_cmd(node, cmd) + except AssertionError: + if fail_on_error: + raise + + @staticmethod + def vpp_enable_traces_on_all_duts(nodes, fail_on_error=False): + """Enable vpp packet traces on all DUTs in the given topology. + + :param nodes: Nodes in the topology. + :param fail_on_error: If True, keyword fails if an error occurs, + otherwise passes. + :type nodes: dict + :type fail_on_error: bool + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error) + + @staticmethod + def vpp_enable_elog_traces_on_dut(node): + """Enable API/CLI/Barrier traces on the DUT node. + + :param node: DUT node to set up. + :type node: dict + """ + PapiSocketExecutor.run_cli_cmd(node, "elog trace api cli barrier") + + @staticmethod + def vpp_enable_elog_traces_on_all_duts(nodes): + """Enable API/CLI/Barrier traces on all DUTs in the given topology. + + :param nodes: Nodes in the topology. + :type nodes: dict + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.vpp_enable_elog_traces_on_dut(node) + + @staticmethod + def show_event_logger_on_dut(node): + """Show event logger on the DUT node. + + :param node: DUT node to show traces on. + :type node: dict + """ + PapiSocketExecutor.run_cli_cmd(node, "show event-logger") + + @staticmethod + def show_event_logger_on_all_duts(nodes): + """Show event logger on all DUTs in the given topology. + + :param nodes: Nodes in the topology. + :type nodes: dict + """ + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.show_event_logger_on_dut(node) + + @staticmethod + def show_log(node): + """Show log on the specified topology node. + + :param node: Topology node. + :type node: dict + :returns: VPP log data. + :rtype: list + """ + return PapiSocketExecutor.run_cli_cmd(node, "show log") + + @staticmethod + def vpp_show_threads(node): + """Show VPP threads on node. + + :param node: Node to run command on. + :type node: dict + :returns: VPP thread data. + :rtype: list + """ + cmd = 'show_threads' + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add(cmd).get_reply() + + threads_data = list() + for thread in reply["thread_data"]: + thread_data = list() + for item in thread: + if isinstance(item, unicode): + item = item.rstrip('\x00') + thread_data.append(item) + threads_data.append(thread_data) + + logger.info("show threads:\n{threads}".format(threads=threads_data)) + + return threads_data