-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 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:
"""DUT setup library."""
+import os
+
from robot.api import logger
-from resources.libraries.python.topology import NodeType
-from resources.libraries.python.topology import Topology
+from resources.libraries.python.topology import NodeType, Topology
from resources.libraries.python.ssh import SSH
from resources.libraries.python.constants import Constants
from resources.libraries.python.VatExecutor import VatExecutor
+from resources.libraries.python.VPPUtil import VPPUtil
class DUTSetup(object):
"""Contains methods for setting up DUTs."""
@staticmethod
def start_vpp_service_on_all_duts(nodes):
- """Start up the VPP service on all nodes."""
+ """Start up the VPP service on all nodes.
+
+ :param nodes: Nodes in the topology.
+ :type nodes: dict
+ """
ssh = SSH()
for node in nodes.values():
if node['type'] == NodeType.DUT:
(ret_code, stdout, stderr) = \
ssh.exec_command_sudo('service vpp restart', timeout=120)
if int(ret_code) != 0:
- logger.debug('stdout: {0}'.format(stdout))
- logger.debug('stderr: {0}'.format(stderr))
raise Exception('DUT {0} failed to start VPP service'.
format(node['host']))
vat = VatExecutor()
vat.execute_script("show_version_verbose.vat", node, json_out=False)
+ try:
+ vat.script_should_have_passed()
+ except AssertionError:
+ raise RuntimeError('Failed to get VPP version on host: {}'.
+ format(node['host']))
+
+ @staticmethod
+ def show_vpp_version_on_all_duts(nodes):
+ """Show VPP version verbose on all DUTs.
+
+ :param nodes: VPP nodes
+ :type nodes: dict
+ """
+ for node in nodes.values():
+ if node['type'] == NodeType.DUT:
+ DUTSetup.vpp_show_version_verbose(node)
+
+ @staticmethod
+ 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("show_interface.vat", node, json_out=False)
+
+ try:
+ vat.script_should_have_passed()
+ except AssertionError:
+ raise RuntimeError('Failed to get VPP interfaces on host: {}'.
+ format(node['host']))
+
@staticmethod
def vpp_api_trace_save(node):
"""Run "api trace save" CLI command.
ssh.exec_command('sudo -Sn bash {0}/{1}/dut_setup.sh'.
format(Constants.REMOTE_FW_DIR,
Constants.RESOURCES_LIB_SH), timeout=120)
- logger.trace(stdout)
- logger.trace(stderr)
if int(ret_code) != 0:
logger.debug('DUT {0} setup script failed: "{1}"'.
format(node['host'], stdout + stderr))
ssh.connect(node)
cryptodev = Topology.get_cryptodev(node)
- cmd = 'cat /sys/bus/pci/devices/{}/sriov_numvfs'.\
+ cmd = 'cat /sys/bus/pci/devices/{0}/sriov_numvfs'.\
format(cryptodev.replace(':', r'\:'))
# Try to read number of VFs from PCI address of QAT device
try:
sriov_numvfs = int(stdout)
except ValueError:
- logger.trace('Reading sriov_numvfs info failed on: {}'.
+ logger.trace('Reading sriov_numvfs info failed on {0}'.
format(node['host']))
else:
if sriov_numvfs != numvfs:
# with numvfs
DUTSetup.crypto_device_init(node, numvfs)
else:
- raise RuntimeError('QAT device {} is not '
- 'initialized to {} on host: {}'.
- format(cryptodev, numvfs,
- node['host']))
+ raise RuntimeError('QAT device {0} is not '
+ 'initialized to {1} on host {2}'
+ .format(cryptodev, numvfs,
+ node['host']))
break
@staticmethod
:type node: dict
:type numvfs: int
:returns: nothing
- :raises RuntimeError: If QAT failed to initialize.
+ :raises RuntimeError: If failed to stop VPP or QAT failed to initialize.
"""
+ cryptodev = Topology.get_cryptodev(node)
- ssh = SSH()
- ssh.connect(node)
+ # QAT device must be re-bound to kernel driver before initialization
+ driver = 'dh895xcc'
+ kernel_module = 'qat_dh895xcc'
+ current_driver = DUTSetup.get_pci_dev_driver(
+ node, cryptodev.replace(':', r'\:'))
- cryptodev = Topology.get_cryptodev(node)
+ DUTSetup.kernel_module_verify(node, kernel_module, force_load=True)
- # QAT device must be bind to kernel driver before initialization
- DUTSetup.pci_driver_unbind(node, cryptodev)
- DUTSetup.pci_driver_bind(node, cryptodev, "dh895xcc")
+ VPPUtil.stop_vpp_service(node)
+ if current_driver is not None:
+ DUTSetup.pci_driver_unbind(node, cryptodev)
+ DUTSetup.pci_driver_bind(node, cryptodev, driver)
+
+ ssh = SSH()
+ ssh.connect(node)
# Initialize QAT VFs
- ret_code, _, _ = ssh.exec_command(
- "sudo sh -c 'echo {} | tee /sys/bus/pci/devices/{}/sriov_numvfs'"
- .format(numvfs, cryptodev.replace(':', r'\:')))
+ if numvfs > 0:
+ cmd = 'echo "{0}" | tee /sys/bus/pci/devices/{1}/sriov_numvfs'.\
+ format(numvfs, cryptodev.replace(':', r'\:'), timeout=180)
+ ret_code, _, _ = ssh.exec_command_sudo("sh -c '{0}'".format(cmd))
- if int(ret_code) != 0:
- raise RuntimeError('Failed to initialize {} VFs on QAT device on '
- 'host: {}'.format(numvfs, node['host']))
+ if int(ret_code) != 0:
+ raise RuntimeError('Failed to initialize {0} VFs on QAT device '
+ ' on host {1}'.format(numvfs, node['host']))
@staticmethod
def pci_driver_unbind(node, pci_addr):
ssh = SSH()
ssh.connect(node)
- ret_code, _, _ = ssh.exec_command(
- "sudo sh -c 'echo {} | tee /sys/bus/pci/devices/{}/driver/unbind'"
- .format(pci_addr, pci_addr.replace(':', r'\:')))
+ ret_code, _, _ = ssh.exec_command_sudo(
+ "sh -c 'echo {0} | tee /sys/bus/pci/devices/{1}/driver/unbind'"
+ .format(pci_addr, pci_addr.replace(':', r'\:')), timeout=180)
if int(ret_code) != 0:
- raise RuntimeError('Failed to unbind PCI device from driver on '
- 'host: {}'.format(node['host']))
+ raise RuntimeError('Failed to unbind PCI device {0} from driver on '
+ 'host {1}'.format(pci_addr, node['host']))
@staticmethod
def pci_driver_bind(node, pci_addr, driver):
ssh = SSH()
ssh.connect(node)
- ret_code, _, _ = ssh.exec_command(
- "sudo sh -c 'echo {} | tee /sys/bus/pci/drivers/{}/bind'"
- .format(pci_addr, driver))
+ ret_code, _, _ = ssh.exec_command_sudo(
+ "sh -c 'echo {0} | tee /sys/bus/pci/drivers/{1}/bind'".format(
+ pci_addr, driver), timeout=180)
if int(ret_code) != 0:
- raise RuntimeError('Failed to bind PCI device to {} driver on '
- 'host: {}'.format(driver, node['host']))
+ raise RuntimeError('Failed to bind PCI device {0} to {1} driver on '
+ 'host {2}'.format(pci_addr, driver,
+ node['host']))
+
+ @staticmethod
+ def get_pci_dev_driver(node, pci_addr):
+ """Get current PCI device driver on node.
+
+ :param node: DUT node.
+ :param pci_addr: PCI device address.
+ :type node: dict
+ :type pci_addr: str
+ :returns: Driver or None
+ :raises RuntimeError: If PCI rescan or lspci command execution failed.
+ """
+ ssh = SSH()
+ ssh.connect(node)
+
+ for i in range(3):
+ logger.trace('Try {0}: Get interface driver'.format(i))
+ cmd = 'sh -c "echo 1 > /sys/bus/pci/rescan"'
+ ret_code, _, _ = ssh.exec_command_sudo(cmd)
+ if int(ret_code) != 0:
+ raise RuntimeError("'{0}' failed on '{1}'"
+ .format(cmd, node['host']))
+
+ cmd = 'lspci -vmmks {0}'.format(pci_addr)
+ ret_code, stdout, _ = ssh.exec_command(cmd)
+ if int(ret_code) != 0:
+ raise RuntimeError("'{0}' failed on '{1}'"
+ .format(cmd, node['host']))
+
+ for line in stdout.splitlines():
+ if len(line) == 0:
+ continue
+ name = None
+ value = None
+ try:
+ name, value = line.split("\t", 1)
+ except ValueError:
+ if name == "Driver:":
+ return None
+ if name == 'Driver:':
+ return value
+ else:
+ return None
@staticmethod
def kernel_module_verify(node, module, force_load=False):
:param force_load: If True then try to load module.
:type node: dict
:type module: str
- :type force_init: bool
+ :type force_load: bool
:returns: nothing
:raises RuntimeError: If module is not loaded or failed to load.
"""
ssh = SSH()
ssh.connect(node)
- cmd = 'grep -w {} /proc/modules'.format(module)
+ cmd = 'grep -w {0} /proc/modules'.format(module)
ret_code, _, _ = ssh.exec_command(cmd)
if int(ret_code) != 0:
# Module is not loaded and we want to load it
DUTSetup.kernel_module_load(node, module)
else:
- raise RuntimeError('Kernel module {} is not loaded on host: {}'.
- format(module, node['host']))
+ raise RuntimeError('Kernel module {0} is not loaded on host '
+ '{1}'.format(module, node['host']))
@staticmethod
def kernel_module_load(node, module):
ssh = SSH()
ssh.connect(node)
- ret_code, _, _ = ssh.exec_command_sudo("modprobe {}".format(module))
+ ret_code, _, _ = ssh.exec_command_sudo("modprobe {0}".format(module))
if int(ret_code) != 0:
- raise RuntimeError('Failed to load {} kernel module on host: {}'.
+ raise RuntimeError('Failed to load {0} kernel module on host {1}'.
format(module, node['host']))
+
+ @staticmethod
+ def vpp_enable_traces_on_all_duts(nodes):
+ """Enable vpp packet 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:
+ DUTSetup.vpp_enable_traces_on_dut(node)
+
+ @staticmethod
+ def vpp_enable_traces_on_dut(node):
+ """Enable vpp packet traces on the DUT node.
+
+ :param node: DUT node to set up.
+ :type node: dict
+ """
+
+ 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)
+
+ @staticmethod
+ def install_vpp_on_all_duts(nodes, vpp_pkg_dir, vpp_rpm_pkgs, vpp_deb_pkgs):
+ """Install VPP on all DUT nodes.
+
+ :param nodes: Nodes in the topology.
+ :param vpp_pkg_dir: Path to directory where VPP packages are stored.
+ :param vpp_rpm_pkgs: List of VPP rpm packages to be installed.
+ :param vpp_deb_pkgs: List of VPP deb packages to be installed.
+ :type nodes: dict
+ :type vpp_pkg_dir: str
+ :type vpp_rpm_pkgs: list
+ :type vpp_deb_pkgs: list
+ :raises: RuntimeError if failed to remove or install VPP
+ """
+
+ logger.debug("Installing VPP")
+
+ for node in nodes.values():
+ if node['type'] == NodeType.DUT:
+ logger.debug("Installing VPP on node {0}".format(node['host']))
+
+ ssh = SSH()
+ ssh.connect(node)
+
+ if os.path.isfile("/etc/redhat-release"):
+ # workaroud - uninstall existing vpp installation until
+ # start-testcase script is updated on all virl servers
+ rpm_pkgs_remove = " ".join(vpp_rpm_pkgs)
+ r_rcode, _, r_err = ssh.exec_command_sudo(
+ "rpm -e {0}".format(rpm_pkgs_remove), timeout=90)
+ if int(r_rcode) != 0:
+ raise RuntimeError('Failed to remove previous VPP'
+ 'installation on host {0}:\n{1}'
+ .format(node['host']), r_err)
+
+ rpm_pkgs = "*.rpm ".join(str(vpp_pkg_dir + pkg)
+ for pkg in vpp_rpm_pkgs) + "*.rpm"
+ ret_code, _, err = ssh.exec_command_sudo(
+ "rpm -ivh {0}".format(rpm_pkgs), timeout=90)
+ if int(ret_code) != 0:
+ raise RuntimeError('Failed to install VPP on host {0}:'
+ '\n{1}'.format(node['host']), err)
+ else:
+ ssh.exec_command_sudo("rpm -qai vpp*")
+ logger.info("VPP installed on node {0}".
+ format(node['host']))
+ else:
+ # workaroud - uninstall existing vpp installation until
+ # start-testcase script is updated on all virl servers
+ deb_pkgs_remove = " ".join(vpp_deb_pkgs)
+ r_rcode, _, r_err = ssh.exec_command_sudo(
+ "dpkg --purge {0}".format(deb_pkgs_remove), timeout=90)
+ if int(r_rcode) != 0:
+ raise RuntimeError('Failed to remove previous VPP'
+ 'installation on host {0}:\n{1}'
+ .format(node['host']), r_err)
+ deb_pkgs = "*.deb ".join(str(vpp_pkg_dir + pkg)
+ for pkg in vpp_deb_pkgs) + "*.deb"
+ ret_code, _, err = ssh.exec_command_sudo(
+ "dpkg -i --force-all {0}".format(deb_pkgs), timeout=90)
+ if int(ret_code) != 0:
+ raise RuntimeError('Failed to install VPP on host {0}:'
+ '\n{1}'.format(node['host']), err)
+ else:
+ ssh.exec_command_sudo("dpkg -l | grep vpp")
+ logger.info("VPP installed on node {0}".
+ format(node['host']))
+
+ ssh.disconnect(node)
+
+ @staticmethod
+ def verify_vpp_on_all_duts(nodes):
+ """Verify that VPP is installed on all DUT nodes.
+
+ :param nodes: Nodes in the topology.
+ :type nodes: dict
+ """
+
+ logger.debug("Verify VPP on all DUTs")
+
+ DUTSetup.start_vpp_service_on_all_duts(nodes)
+
+ for node in nodes.values():
+ if node['type'] == NodeType.DUT:
+ DUTSetup.verify_vpp_on_dut(node)
+
+ @staticmethod
+ def verify_vpp_on_dut(node):
+ """Verify that VPP is installed on DUT node.
+
+ :param node: DUT node.
+ :type node: dict
+ :raises: RuntimeError if failed to restart VPP, get VPP version or
+ get VPP interfaces
+ """
+
+ logger.debug("Verify VPP on node {0}".format(node['host']))
+
+ DUTSetup.vpp_show_version_verbose(node)
+ DUTSetup.vpp_show_interfaces(node)
Code Review / csit.git / blobdiff