X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FVPPUtil.py;h=e343d38d2ffbacd2583d97944318fc2faedfa72d;hp=03d39d3e23aa832a95f31541db967469e48ab266;hb=6962831a1f1905e50a3d663c0cf3ce8c2873ecc9;hpb=1577123a3c27541181097cb4186aa8855f20b1cc diff --git a/resources/libraries/python/VPPUtil.py b/resources/libraries/python/VPPUtil.py index 03d39d3e23..e343d38d2f 100644 --- a/resources/libraries/python/VPPUtil.py +++ b/resources/libraries/python/VPPUtil.py @@ -1,4 +1,4 @@ -# Copyright (c) 2019 Cisco and/or its affiliates. +# Copyright (c) 2021 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: @@ -13,18 +13,16 @@ """VPP util library.""" -import binascii - 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 PapiExecutor -from resources.libraries.python.ssh import exec_cmd_no_error -from resources.libraries.python.topology import NodeType +from resources.libraries.python.PapiExecutor import PapiSocketExecutor +from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd +from resources.libraries.python.topology import Topology, SocketType, NodeType -class VPPUtil(object): +class VPPUtil: """General class for any VPP related methods/functions.""" @staticmethod @@ -40,30 +38,41 @@ class VPPUtil(object): :type additional_cmds: tuple """ def_setting_tb_displayed = { - 'IPv6 FIB': 'ip6 fib', - 'IPv4 FIB': 'ip fib', - 'Interface IP': 'int addr', - 'Interfaces': 'int', - 'ARP': 'ip arp', - 'Errors': 'err' + u"IPv6 FIB": u"ip6 fib", + u"IPv4 FIB": u"ip fib", + u"Interface IP": u"int addr", + u"Interfaces": u"int", + u"ARP": u"ip arp", + u"Errors": u"err" } if additional_cmds: for cmd in additional_cmds: - def_setting_tb_displayed['Custom Setting: {}'.format(cmd)] = cmd + def_setting_tb_displayed[f"Custom Setting: {cmd}"] = cmd for _, cmd in def_setting_tb_displayed.items(): - command = 'vppctl sh {cmd}'.format(cmd=cmd) + command = f"vppctl sh {cmd}" exec_cmd_no_error(node, command, timeout=30, sudo=True) @staticmethod - def restart_vpp_service(node): + def restart_vpp_service(node, node_key=None): """Restart VPP service on the specified topology node. + Disconnect possibly connected PAPI executor. + :param node: Topology node. + :param node_key: Topology node key. :type node: dict + :type node_key: str """ + # Containers have a separate lifecycle, but better be safe. + PapiSocketExecutor.disconnect_all_sockets_by_node(node) DUTSetup.restart_service(node, Constants.VPP_UNIT) + if node_key: + Topology.add_new_socket( + node, SocketType.PAPI, node_key, Constants.SOCKSVR_PATH) + Topology.add_new_socket( + node, SocketType.STATS, node_key, Constants.SOCKSTAT_PATH) @staticmethod def restart_vpp_service_on_all_duts(nodes): @@ -72,18 +81,27 @@ class VPPUtil(object): :param nodes: Topology nodes. :type nodes: dict """ - for node in nodes.values(): - if node['type'] == NodeType.DUT: - VPPUtil.restart_vpp_service(node) + for node_key, node in nodes.items(): + if node[u"type"] == NodeType.DUT: + VPPUtil.restart_vpp_service(node, node_key) @staticmethod - def stop_vpp_service(node): + def stop_vpp_service(node, node_key=None): """Stop VPP service on the specified topology node. + Disconnect possibly connected PAPI executor. + :param node: Topology node. + :param node_key: Topology node key. :type node: dict + :type node_key: str """ + # Containers have a separate lifecycle, but better be safe. + PapiSocketExecutor.disconnect_all_sockets_by_node(node) DUTSetup.stop_service(node, Constants.VPP_UNIT) + if node_key: + Topology.del_node_socket_id(node, SocketType.PAPI, node_key) + Topology.del_node_socket_id(node, SocketType.STATS, node_key) @staticmethod def stop_vpp_service_on_all_duts(nodes): @@ -92,9 +110,9 @@ class VPPUtil(object): :param nodes: Topology nodes. :type nodes: dict """ - for node in nodes.values(): - if node['type'] == NodeType.DUT: - VPPUtil.stop_vpp_service(node) + for node_key, node in nodes.items(): + if node[u"type"] == NodeType.DUT: + VPPUtil.stop_vpp_service(node, node_key) @staticmethod def verify_vpp_installed(node): @@ -103,9 +121,19 @@ class VPPUtil(object): :param node: Topology node. :type node: dict """ - cmd = 'command -v vpp' + DUTSetup.verify_program_installed(node, u"vpp") + + @staticmethod + def adjust_privileges(node): + """Adjust privileges to control VPP without sudo. + + :param node: Topology node. + :type node: dict + """ + cmd = u"chmod -R o+rwx /run/vpp" exec_cmd_no_error( - node, cmd, message='VPP is not installed!') + node, cmd, sudo=True, message=u"Failed to adjust privileges!", + retries=120) @staticmethod def verify_vpp_started(node): @@ -114,27 +142,41 @@ class VPPUtil(object): :param node: Topology node. :type node: dict """ - cmd = ('vppctl show pci 2>&1 | ' - 'fgrep -v "Connection refused" | ' - 'fgrep -v "No such file or directory"') + cmd = u"echo \"show pci\" | sudo socat - UNIX-CONNECT:/run/vpp/cli.sock" + exec_cmd_no_error( + node, cmd, sudo=False, message=u"VPP failed to start!", retries=120 + ) + + cmd = u"vppctl show pci 2>&1 | fgrep -v \"Connection refused\" | " \ + u"fgrep -v \"No such file or directory\"" exec_cmd_no_error( - node, cmd, sudo=True, message='VPP failed to start!', retries=120) + node, cmd, sudo=True, message=u"VPP failed to start!", retries=120 + ) + + # Properly enable cards in case they were disabled. This will be + # followed in https://jira.fd.io/browse/VPP-1934. + cmd = u"for i in $(sudo vppctl sho int | grep Eth | cut -d' ' -f1); do"\ + u" sudo vppctl set int sta $i up; done" + exec_cmd(node, cmd, sudo=False) @staticmethod def verify_vpp(node): """Verify that VPP is installed and started on the specified topology - node. + node. Adjust privileges so user can connect without sudo. :param node: Topology node. :type node: dict :raises RuntimeError: If VPP service fails to start. """ - VPPUtil.verify_vpp_installed(node) + DUTSetup.verify_program_installed(node, 'vpp') try: - # Verify responsivness of vppctl. + # Verify responsiveness of vppctl. VPPUtil.verify_vpp_started(node) - # Verify responsivness of PAPI. + # Adjust privileges. + VPPUtil.adjust_privileges(node) + # Verify responsiveness of PAPI. VPPUtil.show_log(node) + VPPUtil.vpp_show_version(node) finally: DUTSetup.get_service_logs(node, Constants.VPP_UNIT) @@ -146,32 +188,33 @@ class VPPUtil(object): :type nodes: dict """ for node in nodes.values(): - if node['type'] == NodeType.DUT: + if node[u"type"] == NodeType.DUT: VPPUtil.verify_vpp(node) @staticmethod - def vpp_show_version(node, verbose=True): + def vpp_show_version( + node, remote_vpp_socket=Constants.SOCKSVR_PATH, log=True): """Run "show_version" PAPI command. + Socket is configurable, so VPP inside container can be accessed. + :param node: Node to run command on. - :param verbose: Show version, compile date and compile location if True - otherwise show only version. + :param remote_vpp_socket: Path to remote socket to target VPP. + :param log: If true, show the result in Robot log. :type node: dict - :type verbose: bool + :type remote_vpp_socket: str + :type log: bool :returns: VPP version. :rtype: str + :raises RuntimeError: If PAPI connection fails. + :raises AssertionError: If PAPI retcode is nonzero. """ - with PapiExecutor(node) as papi_exec: - data = papi_exec.add('show_version').get_replies().verify_reply() - version = ('VPP version: {ver}\n'. - format(ver=data['version'].rstrip('\0x00'))) - if verbose: - version += ('Compile date: {date}\n' - 'Compile location: {cl}\n '. - format(date=data['build_date'].rstrip('\0x00'), - cl=data['build_directory'].rstrip('\0x00'))) - logger.info(version) - return data['version'].rstrip('\0x00') + cmd = u"show_version" + with PapiSocketExecutor(node, remote_vpp_socket) as papi_exec: + reply = papi_exec.add(cmd).get_reply() + if log: + logger.info(f"VPP version: {reply[u'version']}\n") + return f"{reply[u'version']}" @staticmethod def show_vpp_version_on_all_duts(nodes): @@ -181,7 +224,7 @@ class VPPUtil(object): :type nodes: dict """ for node in nodes.values(): - if node['type'] == NodeType.DUT: + if node[u"type"] == NodeType.DUT: VPPUtil.vpp_show_version(node) @staticmethod @@ -192,28 +235,27 @@ class VPPUtil(object): :type node: dict """ - cmd = 'sw_interface_dump' - cmd_reply = 'sw_interface_details' - args = dict(name_filter_valid=0, name_filter='') - err_msg = 'Failed to get interface dump on host {host}'.format( - host=node['host']) - with PapiExecutor(node) as papi_exec: - papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg) - - papi_if_dump = papi_resp.reply[0]['api_reply'] - - if_data = list() - for item in papi_if_dump: - data = item[cmd_reply] - data['interface_name'] = data['interface_name'].rstrip('\x00') - data['tag'] = data['tag'].rstrip('\x00') - data['l2_address'] = str(':'.join(binascii.hexlify( - data['l2_address'])[i:i + 2] for i in range(0, 12, 2)). - decode('ascii')) - if_data.append(data) + cmd = u"sw_interface_dump" + args = dict( + name_filter_valid=False, + name_filter=u"" + ) + err_msg = f"Failed to get interface dump on host {node[u'host']}" + with PapiSocketExecutor(node) as papi_exec: + details = papi_exec.add(cmd, **args).get_details(err_msg) + + for if_dump in details: + if_dump[u"l2_address"] = str(if_dump[u"l2_address"]) + if_dump[u"b_dmac"] = str(if_dump[u"b_dmac"]) + if_dump[u"b_smac"] = str(if_dump[u"b_smac"]) + if_dump[u"flags"] = if_dump[u"flags"].value + if_dump[u"type"] = if_dump[u"type"].value + if_dump[u"link_duplex"] = if_dump[u"link_duplex"].value + if_dump[u"sub_if_flags"] = if_dump[u"sub_if_flags"].value \ + if hasattr(if_dump[u"sub_if_flags"], u"value") \ + else int(if_dump[u"sub_if_flags"]) # TODO: return only base data - logger.trace('Interface data of host {host}:\n{if_data}'.format( - host=node['host'], if_data=if_data)) + logger.trace(f"Interface data of host {node[u'host']}:\n{details}") @staticmethod def vpp_enable_traces_on_dut(node, fail_on_error=False): @@ -226,14 +268,15 @@ class VPPUtil(object): :type fail_on_error: bool """ cmds = [ - "trace add dpdk-input 50", - "trace add vhost-user-input 50", - "trace add memif-input 50" + u"trace add dpdk-input 50", + u"trace add vhost-user-input 50", + u"trace add memif-input 50", + u"trace add avf-input 50" ] for cmd in cmds: try: - PapiExecutor.run_cli_cmd(node, cmd) + PapiSocketExecutor.run_cli_cmd_on_all_sockets(node, cmd) except AssertionError: if fail_on_error: raise @@ -249,17 +292,23 @@ class VPPUtil(object): :type fail_on_error: bool """ for node in nodes.values(): - if node['type'] == NodeType.DUT: + if node[u"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. + def vpp_enable_elog_traces(node): + """Enable API/CLI/Barrier traces on the specified topology node. - :param node: DUT node to set up. + :param node: Topology node. :type node: dict """ - PapiExecutor.run_cli_cmd(node, "elog trace api cli barrier") + try: + PapiSocketExecutor.run_cli_cmd_on_all_sockets( + node, u"event-logger trace api cli barrier") + except AssertionError: + # Perhaps an older VPP build is tested. + PapiSocketExecutor.run_cli_cmd_on_all_sockets( + node, u"elog trace api cli barrier") @staticmethod def vpp_enable_elog_traces_on_all_duts(nodes): @@ -269,17 +318,18 @@ class VPPUtil(object): :type nodes: dict """ for node in nodes.values(): - if node['type'] == NodeType.DUT: - VPPUtil.vpp_enable_elog_traces_on_dut(node) + if node[u"type"] == NodeType.DUT: + VPPUtil.vpp_enable_elog_traces(node) @staticmethod - def show_event_logger_on_dut(node): - """Show event logger on the DUT node. + def show_event_logger(node): + """Show event logger on the specified topology node. - :param node: DUT node to show traces on. + :param node: Topology node. :type node: dict """ - PapiExecutor.run_cli_cmd(node, "show event-logger") + PapiSocketExecutor.run_cli_cmd_on_all_sockets( + node, u"show event-logger") @staticmethod def show_event_logger_on_all_duts(nodes): @@ -289,19 +339,28 @@ class VPPUtil(object): :type nodes: dict """ for node in nodes.values(): - if node['type'] == NodeType.DUT: - VPPUtil.show_event_logger_on_dut(node) + if node[u"type"] == NodeType.DUT: + VPPUtil.show_event_logger(node) @staticmethod def show_log(node): - """Show log on the specified topology node. + """Show logging on the specified topology node. :param node: Topology node. :type node: dict - :returns: VPP log data. - :rtype: list """ - return PapiExecutor.run_cli_cmd(node, "show log")["reply"] + PapiSocketExecutor.run_cli_cmd(node, u"show logging") + + @staticmethod + def show_log_on_all_duts(nodes): + """Show logging on all DUTs in the given topology. + + :param nodes: Nodes in the topology. + :type nodes: dict + """ + for node in nodes.values(): + if node[u"type"] == NodeType.DUT: + VPPUtil.show_log(node) @staticmethod def vpp_show_threads(node): @@ -312,19 +371,34 @@ class VPPUtil(object): :returns: VPP thread data. :rtype: list """ - with PapiExecutor(node) as papi_exec: - data = papi_exec.add('show_threads').get_replies().\ - verify_reply()["thread_data"] - - threads_data = list() - for thread in 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) + cmd = u"show_threads" + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add(cmd).get_reply() - logger.info("show threads:\n{threads}".format(threads=threads_data)) + threads_data = reply[u"thread_data"] + logger.trace(f"show threads:\n{threads_data}") return threads_data + + @staticmethod + def vpp_add_graph_node_next(node, graph_node_name, graph_next_name): + """Set the next node for a given node. + + :param node: Node to run command on. + :param graph_node_name: Graph node to add the next node on. + :param graph_next_name: Graph node to add as the next node. + :type node: dict + :type graph_node_name: str + :type graph_next_name: str + :returns: The index of the next graph node. + :rtype: int + """ + cmd = u"add_node_next" + args = dict( + node_name=graph_node_name, + next_name=graph_next_name + ) + with PapiSocketExecutor(node) as papi_exec: + reply = papi_exec.add(cmd, **args).get_reply() + + return reply[u"next_index"]