-# 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:
# limitations under the License.
"""VPP util library."""
+
+import time
+
+from robot.api import logger
+
from resources.libraries.python.constants import Constants
from resources.libraries.python.DUTSetup import DUTSetup
-from resources.libraries.python.ssh import exec_cmd_no_error
+from resources.libraries.python.PapiExecutor import PapiExecutor
+from resources.libraries.python.PapiErrors import PapiError
+from resources.libraries.python.ssh import exec_cmd, exec_cmd_no_error
from resources.libraries.python.topology import NodeType
from resources.libraries.python.VatExecutor import VatExecutor
exec_cmd_no_error(node, command, timeout=30, sudo=True)
@staticmethod
- def start_vpp_service(node):
+ def start_vpp_service(node, retries=60):
"""Start VPP service on the specified node.
:param node: VPP node.
+ :param retries: Number of times (default 60) to re-try waiting.
:type node: dict
+ :type retries: int
:raises RuntimeError: If VPP service fails to start.
"""
DUTSetup.start_service(node, Constants.VPP_UNIT)
+ # Sleep 1 second, up to <retry> times,
+ # and verify if VPP is running.
+ for _ in range(retries):
+ time.sleep(1)
+ command = 'vppctl show pci'
+ ret, stdout, _ = exec_cmd(node, command, timeout=30, sudo=True)
+ if not ret and 'Connection refused' not in stdout:
+ break
+ else:
+ raise RuntimeError('VPP failed to start on host {name}'.
+ format(name=node['host']))
DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
@staticmethod
:param nodes: Nodes in the topology.
:type nodes: dict
"""
- DUTSetup.start_service_on_all_duts(nodes, Constants.VPP_UNIT)
+ for node in nodes.values():
+ if node['type'] == NodeType.DUT:
+ VPPUtil.start_vpp_service(node)
@staticmethod
def stop_vpp_service(node):
:param nodes: Nodes in the topology.
: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):
"""
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)
+ VPPUtil.start_vpp_service(node)
+ VPPUtil.verify_vpp_on_dut(node)
@staticmethod
- def vpp_show_version_verbose(node):
- """Run "show version verbose" CLI command.
+ def vpp_show_version(node, verbose=False):
+ """Run "show_version" API 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
+ :raises PapiError: If no reply received for show_version API command.
"""
- vat = VatExecutor()
- vat.execute_script("show_version_verbose.vat", node, json_out=False)
+ # TODO: move composition of api data to separate method
+ api_data = list()
+ api = dict(api_name='show_version')
+ api_args = dict()
+ api['api_args'] = api_args
+ api_data.append(api)
+
+ api_reply = None
+ with PapiExecutor(node) as papi_executor:
+ papi_executor.execute_papi(api_data)
+ try:
+ papi_executor.papi_should_have_passed()
+ except AssertionError:
+ raise RuntimeError('Failed to get VPP version on host: {host}'.
+ format(host=node['host']))
+ api_reply = papi_executor.get_papi_reply()
+
+ if api_reply is not None:
+ version_data = api_reply[0]['api_reply']['show_version_reply']
+ ver = version_data['version'].rstrip('\0x00')
+ if verbose:
+ date = version_data['build_date'].rstrip('\0x00')
+ loc = version_data['build_directory'].rstrip('\0x00')
+ version = \
+ 'VPP Version: {ver}\n' \
+ 'Compile date: {date}\n' \
+ 'Compile location: {loc}\n '\
+ .format(ver=ver, date=date, loc=loc)
+ else:
+ version = 'VPP version:{ver}'.format(ver=ver)
+ logger.info(version)
+ else:
+ raise PapiError('No reply received for show_version API command on '
+ 'host {host}'.format(host=node['host']))
- try:
- vat.script_should_have_passed()
- except AssertionError:
- raise RuntimeError('Failed to get VPP version on host: {name}'.
- format(name=node['host']))
+ @staticmethod
+ def vpp_show_version_verbose(node):
+ """Run "show_version" API command and return verbose string of version
+ data.
+
+ :param node: Node to run command on.
+ :type node: dict
+ """
+ VPPUtil.vpp_show_version(node, verbose=True)
@staticmethod
def show_vpp_version_on_all_duts(nodes):
- """Show VPP version verbose on all DUTs.
+ """Show VPP version on all DUTs.
:param nodes: VPP nodes.
:type nodes: dict
for node in nodes.values():
if node['type'] == NodeType.DUT:
VPPUtil.vpp_enable_traces_on_dut(node)
+
+ @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
+ """
+ vat = VatExecutor()
+ vat.execute_script("elog_trace_api_cli_barrier.vat", node,
+ json_out=False)
+
+ @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
+ """
+ vat = VatExecutor()
+ vat.execute_script("show_event_logger.vat", node, json_out=False)
+
+ @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)