X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVPPUtil.py;h=432a589cd35c5fa932cdbf585ea7285953a1cc19;hp=9d2a2b9dd331deca4727e69273a7b971ceb255ae;hb=b38e5bc9f01528a7633a3132d7d5c8e12d4cbf88;hpb=5729b2d4248c03eae6d9ed6a6e4aa27cf6db0291 diff --git a/resources/libraries/python/VPPUtil.py b/resources/libraries/python/VPPUtil.py index 9d2a2b9dd3..432a589cd3 100644 --- a/resources/libraries/python/VPPUtil.py +++ b/resources/libraries/python/VPPUtil.py @@ -1,4 +1,4 @@ -# Copyright (c) 2018 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: @@ -12,11 +12,14 @@ # limitations under the License. """VPP util library.""" -from resources.libraries.python.constants import Constants + +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 -from resources.libraries.python.VatExecutor import VatExecutor class VPPUtil(object): @@ -52,165 +55,208 @@ class VPPUtil(object): exec_cmd_no_error(node, command, timeout=30, sudo=True) @staticmethod - def start_vpp_service(node): - """Start VPP service on the specified node. + def restart_vpp_service(node): + """Restart VPP service on the specified topology node. - :param node: VPP node. + :param node: Topology node. :type node: dict - :raises RuntimeError: If VPP service fails to start. """ - DUTSetup.start_service(node, Constants.VPP_UNIT) - DUTSetup.get_service_logs(node, Constants.VPP_UNIT) + DUTSetup.restart_service(node, Constants.VPP_UNIT) @staticmethod - def start_vpp_service_on_all_duts(nodes): - """Start up the VPP service on all nodes. + def restart_vpp_service_on_all_duts(nodes): + """Restart VPP service on all DUT nodes. - :param nodes: Nodes in the topology. + :param nodes: Topology nodes. :type nodes: dict """ - DUTSetup.start_service_on_all_duts(nodes, Constants.VPP_UNIT) + 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 node. + """Stop VPP service on the specified topology node. - :param node: VPP node. + :param node: Topology node. :type node: dict - :raises RuntimeError: If VPP service fails to stop. """ DUTSetup.stop_service(node, Constants.VPP_UNIT) @staticmethod def stop_vpp_service_on_all_duts(nodes): - """Stop VPP service on all nodes. + """Stop VPP service on all DUT nodes. - :param nodes: Nodes in the topology. + :param nodes: Topology nodes. :type nodes: dict """ - DUTSetup.stop_service_on_all_duts(nodes, Constants.VPP_UNIT) + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.stop_vpp_service(node) @staticmethod - def verify_vpp_on_dut(node): - """Verify that VPP is installed on DUT node. + def verify_vpp_installed(node): + """Verify that VPP is installed on the specified topology node. - :param node: DUT node. + :param node: Topology node. :type node: dict - :raises RuntimeError: If failed to restart VPP, get VPP version - or get VPP interfaces. """ - VPPUtil.vpp_show_version_verbose(node) - VPPUtil.vpp_show_interfaces(node) + cmd = 'command -v vpp' + exec_cmd_no_error( + node, cmd, message='VPP is not installed!') @staticmethod - def verify_vpp_on_all_duts(nodes): - """Verify that VPP is installed on all DUT nodes. + def verify_vpp_started(node): + """Verify that VPP is started on the specified topology node. - :param nodes: Nodes in the topology. - :type nodes: dict + :param node: Topology node. + :type node: dict """ - for node in nodes.values(): - if node['type'] == NodeType.DUT: - DUTSetup.start_service(node, Constants.VPP_UNIT) - VPPUtil.vpp_show_version_verbose(node) - VPPUtil.vpp_show_interfaces(node) + cmd = 'echo "show pci" | sudo socat - UNIX-CONNECT:/run/vpp/cli.sock' + exec_cmd_no_error( + node, cmd, sudo=False, message='VPP failed to start!', retries=120) + + 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 vpp_show_version_verbose(node): - """Run "show version verbose" CLI command. + def verify_vpp(node): + """Verify that VPP is installed and started on the specified topology + node. - :param node: Node to run command on. + :param node: Topology node. :type node: dict + :raises RuntimeError: If VPP service fails to start. """ - vat = VatExecutor() - vat.execute_script("show_version_verbose.vat", node, json_out=False) - + VPPUtil.verify_vpp_installed(node) try: - vat.script_should_have_passed() - except AssertionError: - raise RuntimeError('Failed to get VPP version on host: {name}'. - format(name=node['host'])) + # 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 show_vpp_version_on_all_duts(nodes): - """Show VPP version verbose on all DUTs. + def verify_vpp_on_all_duts(nodes): + """Verify that VPP is installed and started on all DUT nodes. - :param nodes: VPP nodes. + :param nodes: Nodes in the topology. :type nodes: dict """ for node in nodes.values(): if node['type'] == NodeType.DUT: - VPPUtil.vpp_show_version_verbose(node) + VPPUtil.verify_vpp(node) @staticmethod - def vpp_show_interfaces(node): - """Run "show interface" CLI command. + 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 """ - vat = VatExecutor() - vat.execute_script("show_interface.vat", node, json_out=False) - - try: - vat.script_should_have_passed() - except AssertionError: - raise RuntimeError('Failed to get VPP interfaces on host: {name}'. - format(name=node['host'])) + 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 vpp_show_crypto_device_mapping(node): - """Run "show crypto device mapping" CLI command. + def show_vpp_version_on_all_duts(nodes): + """Show VPP version verbose on all DUTs. - :param node: Node to run command on. - :type node: dict + :param nodes: Nodes in the topology. + :type nodes: dict """ - vat = VatExecutor() - vat.execute_script("show_crypto_device_mapping.vat", node, - json_out=False) + for node in nodes.values(): + if node['type'] == NodeType.DUT: + VPPUtil.vpp_show_version(node) @staticmethod - def vpp_api_trace_dump(node): - """Run "api trace custom-dump" CLI command. + def vpp_show_interfaces(node): + """Run "show interface" CLI command. :param node: Node to run command on. :type node: dict """ - vat = VatExecutor() - vat.execute_script("api_trace_dump.vat", node, json_out=False) - @staticmethod - def vpp_api_trace_save(node): - """Run "api trace save" CLI command. - - :param node: Node to run command on. - :type node: dict - """ - vat = VatExecutor() - vat.execute_script("api_trace_save.vat", node, json_out=False) + 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): + 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 """ - vat = VatExecutor() - vat.execute_script("enable_dpdk_traces.vat", node, json_out=False) - vat.execute_script("enable_vhost_user_traces.vat", node, json_out=False) - vat.execute_script("enable_memif_traces.vat", node, json_out=False) + 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): + 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) + VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error) @staticmethod def vpp_enable_elog_traces_on_dut(node): @@ -219,9 +265,7 @@ class VPPUtil(object): :param node: DUT node to set up. :type node: dict """ - vat = VatExecutor() - vat.execute_script("elog_trace_api_cli_barrier.vat", node, - json_out=False) + PapiSocketExecutor.run_cli_cmd(node, "elog trace api cli barrier") @staticmethod def vpp_enable_elog_traces_on_all_duts(nodes): @@ -241,8 +285,7 @@ class VPPUtil(object): :param node: DUT node to show traces on. :type node: dict """ - vat = VatExecutor() - vat.execute_script("show_event_logger.vat", node, json_out=False) + PapiSocketExecutor.run_cli_cmd(node, "show event-logger") @staticmethod def show_event_logger_on_all_duts(nodes): @@ -254,3 +297,40 @@ class VPPUtil(object): 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