-# Copyright (c) 2017 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:
"""Implementation of keywords for Honeycomb setup."""
+from json import loads
+from time import time, sleep
+
from ipaddress import IPv6Address, AddressValueError
from robot.api import logger
Honeycomb is up and running.
Honeycomb must be installed in "/opt" directory, otherwise the start
will fail.
+
:param nodes: List of nodes to start Honeycomb on.
:type nodes: list
:raises HoneycombError: If Honeycomb fails to start.
HoneycombSetup.print_environment(nodes)
- logger.console("\n(re)Starting Honeycomb service ...")
-
cmd = "sudo service honeycomb start"
for node in nodes:
if node['type'] == NodeType.DUT:
+ logger.console(
+ "\n(re)Starting Honeycomb service on node {0}".format(
+ node["host"]))
ssh = SSH()
ssh.connect(node)
(ret_code, _, _) = ssh.exec_command_sudo(cmd)
stops the Honeycomb and does not check its shutdown state. Use the
keyword "Check Honeycomb Shutdown State" to check if Honeycomb has
stopped.
+
:param nodes: List of nodes to stop Honeycomb on.
:type nodes: list
:raises HoneycombError: If Honeycomb failed to stop.
"""
- logger.console("\nShutting down Honeycomb service ...")
cmd = "sudo service honeycomb stop"
errors = []
for node in nodes:
if node['type'] == NodeType.DUT:
+ logger.console(
+ "\nShutting down Honeycomb service on node {0}".format(
+ node["host"]))
ssh = SSH()
ssh.connect(node)
(ret_code, _, _) = ssh.exec_command_sudo(cmd)
:raises HoneycombError: If Honeycomb fails to start.
"""
- logger.console("\n(re)Starting Honeycomb service ...")
+ logger.console(
+ "\n(re)Starting Honeycomb service on node {0}".format(node["host"]))
cmd = "sudo service honeycomb restart"
node['host']))
@staticmethod
- def check_honeycomb_startup_state(*nodes):
- """Check state of Honeycomb service during startup on specified nodes.
-
- Reads html path from template file oper_vpp_version.url.
+ def check_honeycomb_startup_state(node, timeout=360, retries=20,
+ interval=15):
+ """Repeatedly check the status of Honeycomb startup until it is fully
+ started or until timeout or max retries is reached.
- Honeycomb nodes reply with connection refused or the following status
- codes depending on startup progress: codes 200, 401, 403, 404, 500, 503
-
- :param nodes: List of DUT nodes starting Honeycomb.
- :type nodes: list
- :return: True if all GETs returned code 200(OK).
- :rtype bool
+ :param node: Honeycomb node.
+ :param timeout: Timeout value in seconds.
+ :param retries: Max number of retries.
+ :param interval: Interval between checks, in seconds.
+ :type node: dict
+ :type timeout: int
+ :type retries: int
+ :type interval: int
+ :raises HoneycombError: If the Honeycomb process IP cannot be found,
+ or if timeout or number of retries is exceeded.
"""
- path = HcUtil.read_path_from_url_file("oper_vpp_version")
- expected_status_codes = (HTTPCodes.UNAUTHORIZED,
- HTTPCodes.FORBIDDEN,
- HTTPCodes.NOT_FOUND,
- HTTPCodes.SERVICE_UNAVAILABLE,
- HTTPCodes.INTERNAL_SERVER_ERROR)
- for node in nodes:
- if node['type'] == NodeType.DUT:
- HoneycombSetup.print_ports(node)
- try:
- status_code, _ = HTTPRequest.get(node, path,
- enable_logging=False)
- except HTTPRequestError:
- ssh = SSH()
- ssh.connect(node)
- ssh.exec_command("tail -n 100 /var/log/syslog")
- raise
- if status_code == HTTPCodes.OK:
- logger.info("Honeycomb on node {0} is up and running".
- format(node['host']))
- elif status_code in expected_status_codes:
- if status_code == HTTPCodes.UNAUTHORIZED:
- logger.info('Unauthorized. If this triggers keyword '
- 'timeout, verify Honeycomb username and '
- 'password.')
- raise HoneycombError('Honeycomb on node {0} running but '
- 'not yet ready.'.format(node['host']),
- enable_logging=False)
- else:
- raise HoneycombError('Unexpected return code: {0}.'.
- format(status_code))
+ ssh = SSH()
+ ssh.connect(node)
+
+ count = 0
+ start = time()
+ while time() - start < timeout and count < retries:
+ count += 1
- status_code, _ = HcUtil.get_honeycomb_data(
+ try:
+ status_code_version, _ = HcUtil.get_honeycomb_data(
+ node, "oper_vpp_version")
+ status_code_if_cfg, _ = HcUtil.get_honeycomb_data(
node, "config_vpp_interfaces")
- if status_code != HTTPCodes.OK:
- raise HoneycombError('Honeycomb on node {0} running but '
- 'not yet ready.'.format(node['host']),
- enable_logging=False)
- return True
+ status_code_if_oper, _ = HcUtil.get_honeycomb_data(
+ node, "oper_vpp_interfaces")
+ except HTTPRequestError:
+ sleep(interval)
+ continue
+ if status_code_if_cfg == HTTPCodes.OK\
+ and status_code_if_cfg == HTTPCodes.OK\
+ and status_code_if_oper == HTTPCodes.OK:
+ logger.info("Check successful, Honeycomb is up and running.")
+ break
+ else:
+ logger.debug(
+ "Attempt ${count} failed on Restconf check. Status codes:\n"
+ "Version: {version}\n"
+ "Interface config: {if_cfg}\n"
+ "Interface operational: {if_oper}".format(
+ count=count,
+ version=status_code_version,
+ if_cfg=status_code_if_cfg,
+ if_oper=status_code_if_oper))
+ sleep(interval)
+ continue
+ else:
+ _, vpp_status, _ = ssh.exec_command("sudo service vpp status")
+ raise HoneycombError(
+ "Timeout or max retries exceeded. Status of VPP:\n"
+ "{vpp_status}".format(vpp_status=vpp_status))
@staticmethod
- def check_honeycomb_shutdown_state(*nodes):
+ def check_honeycomb_shutdown_state(node):
"""Check state of Honeycomb service during shutdown on specified nodes.
Honeycomb nodes reply with connection refused or the following status
codes depending on shutdown progress: codes 200, 404.
- :param nodes: List of DUT nodes stopping Honeycomb.
- :type nodes: list
- :return: True if all GETs fail to connect.
- :rtype bool
+ :param node: List of DUT nodes stopping Honeycomb.
+ :type node: dict
+ :returns: True if all GETs fail to connect.
+ :rtype: bool
"""
- cmd = "ps -ef | grep -v grep | grep honeycomb"
- for node in nodes:
- if node['type'] == NodeType.DUT:
- try:
- status_code, _ = HTTPRequest.get(node, '/index.html',
- enable_logging=False)
- if status_code == HTTPCodes.OK:
- raise HoneycombError('Honeycomb on node {0} is still '
- 'running.'.format(node['host']),
- enable_logging=False)
- elif status_code == HTTPCodes.NOT_FOUND:
- raise HoneycombError('Honeycomb on node {0} is shutting'
- ' down.'.format(node['host']),
- enable_logging=False)
- else:
- raise HoneycombError('Unexpected return code: {0}.'.
- format(status_code))
- except HTTPRequestError:
- logger.debug('Connection refused, checking the process '
- 'state ...')
- ssh = SSH()
- ssh.connect(node)
- (ret_code, _, _) = ssh.exec_command_sudo(cmd)
- if ret_code == 0:
- raise HoneycombError('Honeycomb on node {0} is still '
- 'running.'.format(node['host']),
- enable_logging=False)
- else:
- logger.info("Honeycomb on node {0} has stopped".
- format(node['host']))
+ cmd = "pgrep honeycomb"
+
+ ssh = SSH()
+ ssh.connect(node)
+ (ret_code, _, _) = ssh.exec_command_sudo(cmd)
+ if ret_code == 0:
+ raise HoneycombError('Honeycomb on node {0} is still '
+ 'running.'.format(node['host']),
+ enable_logging=False)
+ else:
+ logger.info("Honeycomb on node {0} has stopped".
+ format(node['host']))
return True
@staticmethod
"""Configure Honeycomb to accept restconf requests from all IP
addresses. IP version is determined by node data.
- :param node: Information about a DUT node.
- :type node: dict
- :raises HoneycombError: If the configuration could not be changed.
- """
+ :param node: Information about a DUT node.
+ :type node: dict
+ :raises HoneycombError: If the configuration could not be changed.
+ """
find = "restconf-binding-address"
try:
replace = '\\"restconf-binding-address\\": \\"0.0.0.0\\",'
argument = '"/{0}/c\\ {1}"'.format(find, replace)
- path = "{0}/config/honeycomb.json".format(Const.REMOTE_HC_DIR)
+ path = "{0}/config/restconf.json".format(Const.REMOTE_HC_DIR)
command = "sed -i {0} {1}".format(argument, path)
ssh = SSH()
def configure_jvpp_timeout(node, timeout=10):
"""Configure timeout value for Java API commands Honeycomb sends to VPP.
- :param node: Information about a DUT node.
- :param timeout: Timeout value in seconds.
- :type node: dict
- :type timeout: int
- :raises HoneycombError: If the configuration could not be changed.
- """
+ :param node: Information about a DUT node.
+ :param timeout: Timeout value in seconds.
+ :type node: dict
+ :type timeout: int
+ :raises HoneycombError: If the configuration could not be changed.
+ """
find = "jvpp-request-timeout"
replace = '\\"jvpp-request-timeout\\": {0}'.format(timeout)
"which java",
"java -version",
"dpkg --list | grep openjdk",
- "ls -la /opt/honeycomb")
+ "ls -la /opt/honeycomb",
+ "cat /opt/honeycomb/modules/*module-config")
for node in nodes:
if node['type'] == NodeType.DUT:
:type feature: string
:type disable: bool
:raises HoneycombError: If the configuration could not be changed.
- """
+ """
disabled_features = {
- "NSH": "io.fd.hc2vpp.vppnsh.impl.VppNshModule"
+ "NSH": ["io.fd.hc2vpp.vppnsh.impl.VppNshModule"],
+ "BGP": ["io.fd.hc2vpp.bgp.inet.BgpInetModule",
+ "io.fd.honeycomb.infra.bgp.BgpModule",
+ "io.fd.honeycomb.infra.bgp.BgpReadersModule",
+ "io.fd.honeycomb.infra.bgp.BgpWritersModule",
+ "io.fd.honeycomb.northbound.bgp.extension.InetModule",
+ "io.fd.honeycomb.northbound.bgp.extension.EvpnModule",
+ "io.fd.honeycomb.northbound.bgp.extension.L3VpnV4Module",
+ "io.fd.honeycomb.northbound.bgp.extension.L3VpnV6Module",
+ "io.fd.honeycomb.northbound.bgp.extension."
+ "LabeledUnicastModule",
+ "io.fd.honeycomb.northbound.bgp.extension.LinkstateModule"]
}
ssh = SSH()
ssh.connect(node)
if feature in disabled_features.keys():
- # uncomment by replacing the entire line
- find = replace = "{0}".format(disabled_features[feature])
- if disable:
- replace = "// {0}".format(find)
-
- argument = '"/{0}/c\\ {1}"'.format(find, replace)
- path = "{0}/modules/*module-config"\
- .format(Const.REMOTE_HC_DIR)
- command = "sed -i {0} {1}".format(argument, path)
-
- (ret_code, _, stderr) = ssh.exec_command_sudo(command)
- if ret_code != 0:
- raise HoneycombError("Failed to modify configuration on "
- "node {0}, {1}".format(node, stderr))
+ # for every module, uncomment by replacing the entire line
+ for item in disabled_features[feature]:
+ find = replace = "{0}".format(item)
+ if disable:
+ replace = "// {0}".format(find)
+
+ argument = '"/{0}/c\\ {1}"'.format(find, replace)
+ path = "{0}/modules/*module-config"\
+ .format(Const.REMOTE_HC_DIR)
+ command = "sed -i {0} {1}".format(argument, path)
+
+ (ret_code, _, stderr) = ssh.exec_command_sudo(command)
+ if ret_code != 0:
+ raise HoneycombError("Failed to modify configuration on "
+ "node {0}, {1}".format(node, stderr))
else:
raise HoneycombError(
"Unrecognized feature {0}.".format(feature))
ssh = SSH()
ssh.connect(node)
- cmd = "cp -r {src}/*karaf_{odl_name}* {dst}".format(
- src=src_path, odl_name=odl_name, dst=dst_path)
+ cmd = "sudo rm -rf {dst}/*karaf_{odl_name} && " \
+ "cp -r {src}/*karaf_{odl_name}* {dst}".format(
+ src=src_path, odl_name=odl_name, dst=dst_path)
- ret_code, _, _ = ssh.exec_command(cmd, timeout=30)
+ ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=180)
if int(ret_code) != 0:
raise HoneycombError(
"Failed to copy ODL client on node {0}".format(node["host"]))
Karaf should be located in the provided path, and VPP and Honeycomb
should already be running, otherwise the start will fail.
+
:param node: Node to start ODL client on.
:param path: Path to ODL client on node.
:type node: dict
"in progress ...".format(node['host']))
@staticmethod
- def install_odl_features(node, path, *features):
+ def install_odl_features(node, odl_name, path, *features):
"""Install required features on a running ODL client.
:param node: Honeycomb node.
+ :param odl_name: Name of ODL client version to use.
:param path: Path to ODL client on node.
:param features: Optional, list of additional features to install.
:type node: dict
+ :type odl_name: str
:type path: str
:type features: list
"""
ssh = SSH()
ssh.connect(node)
- cmd = "{path}/*karaf*/bin/client -u karaf feature:install " \
- "odl-restconf-all odl-netconf-connector-all".format(path=path)
+ auth = "-u karaf"
+ if odl_name.lower() == "oxygen":
+ auth = "-u karaf -p karaf"
+
+ cmd = "{path}/*karaf*/bin/client {auth} feature:install " \
+ "odl-restconf-all " \
+ "odl-netconf-connector-all " \
+ "odl-netconf-topology".format(path=path, auth=auth)
for feature in features:
cmd += " {0}".format(feature)
- ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=120)
+ ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=250)
if int(ret_code) != 0:
raise HoneycombError("Feature install did not succeed.")
format(status_code))
return True
+ @staticmethod
+ def check_odl_shutdown_state(node):
+ """Check the status of ODL client shutdown.
+
+ :param node: Honeycomb node.
+ :type node: dict
+ :returns: True when ODL is stopped.
+ :rtype: bool
+ :raises HoneycombError: When the response is not code 200: OK.
+ """
+
+ cmd = "pgrep -f karaf"
+ path = HcUtil.read_path_from_url_file(
+ "odl_client/odl_netconf_connector")
+
+ try:
+ HTTPRequest.get(node, path, timeout=10, enable_logging=False)
+ raise HoneycombError("ODL client is still running.")
+ except HTTPRequestError:
+ logger.debug("Connection refused, checking process state....")
+ ssh = SSH()
+ ssh.connect(node)
+ ret_code, _, _ = ssh.exec_command(cmd)
+ if ret_code == 0:
+ raise HoneycombError("ODL client is still running.")
+
+ return True
+
@staticmethod
def mount_honeycomb_on_odl(node):
"""Tell ODL client to mount Honeycomb instance over netconf.
"odl_client/odl_netconf_connector")
url_file = "{0}/{1}".format(Const.RESOURCES_TPL_HC,
- "odl_client/mount_honeycomb.xml")
+ "odl_client/mount_honeycomb.json")
with open(url_file) as template:
data = template.read()
+ data = loads(data)
+
status_code, _ = HTTPRequest.post(
- node, path, headers={"Content-Type": "application/xml"},
- payload=data, timeout=10, enable_logging=False)
+ node,
+ path,
+ headers={"Content-Type": "application/json",
+ "Accept": "text/plain"},
+ json=data,
+ timeout=10,
+ enable_logging=False)
if status_code == HTTPCodes.OK:
logger.info("ODL mount point configured successfully.")
ssh.connect(node)
ret_code, _, _ = ssh.exec_command_sudo(cmd)
if int(ret_code) != 0:
- logger.warn("ODL Client refused to shut down.")
+ logger.debug("ODL Client refused to shut down.")
cmd = "pkill -f 'karaf'"
(ret_code, _, _) = ssh.exec_command_sudo(cmd)
if int(ret_code) != 0:
logger.info("ODL client service stopped.")
@staticmethod
- def stop_vpp_service(node):
- """Stop VPP service on the specified node.
+ def set_static_arp(node, ip_address, mac_address):
+ """Configure a static ARP entry using arp.
- :param node: VPP node.
+ :param node: Node in topology.
+ :param ip_address: IP address for the entry.
+ :param mac_address: MAC adddress for the entry.
:type node: dict
- :raises RuntimeError: If VPP fails to stop.
+ :type ip_address: str
+ :type mac_address: str
+ :raises RuntimeError: If the operation fails.
"""
ssh = SSH()
ssh.connect(node)
- cmd = "service vpp stop"
- ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=80)
- if int(ret_code) != 0:
- raise RuntimeError("Could not stop VPP service on node {0}".format(
- node['host']))
+ ret_code, _, _ = ssh.exec_command_sudo("arp -s {0} {1}".format(
+ ip_address, mac_address))
+
+ if ret_code != 0:
+ raise RuntimeError("Failed to configure static ARP adddress.")
class HoneycombStartupConfig(object):
def __init__(self):
"""Initializer."""
- self.template = """
- #!/bin/sh -
+ self.template = """#!/bin/sh -
STATUS=100
while [ $STATUS -eq 100 ]
done
"""
- self.java_call = "{scheduler} {affinity} java {jit_mode} {params}"
+ self.java_call = "{scheduler} {affinity} java{jit_mode}{params}"
self.scheduler = ""
self.core_affinity = ""
def apply_config(self, node):
"""Generate configuration file /opt/honeycomb/honeycomb on the specified
- node.
+ node.
- :param node: Honeycomb node.
- :type node: dict
- """
+ :param node: Honeycomb node.
+ :type node: dict
+ """
self.ssh.connect(node)
_, filename, _ = self.ssh.exec_command("ls /opt/honeycomb | grep .jar")
self.ssh.connect(node)
cmd = "echo '{config}' > /tmp/honeycomb " \
"&& chmod +x /tmp/honeycomb " \
- "&& sudo mv -f /tmp/honeycomb /opt/honeycomb".format(
- config=self.config)
+ "&& sudo mv -f /tmp/honeycomb /opt/honeycomb".\
+ format(config=self.config)
self.ssh.exec_command(cmd)
def set_cpu_scheduler(self, scheduler="FIFO"):
:type jit_mode: str
"""
- modes = {"client": "-client", # Default
- "server": "-server", # Higher performance but longer warmup
- "classic": "-classic" # Disables JIT compiler
+ modes = {"client": " -client", # Default
+ "server": " -server", # Higher performance but longer warmup
+ "classic": " -classic" # Disables JIT compiler
}
self.jit_mode = modes[jit_mode]
:param mem_min: Minimum amount of memory (MB).
:param mem_max: Maximum amount of memory (MB). Default is 4 times
- minimum value.
+ minimum value.
:type mem_min: int
:type mem_max: int
"""
:param mem_min: Minimum metaspace size (MB).
:param mem_max: Maximum metaspace size (MB). Defailt is 4 times
- minimum value.
+ minimum value.
:type mem_min: int
:type mem_max: int
"""
architectures."""
self.params += " -XX:+UseNUMA -XX:+UseParallelGC"
+
+ def set_ssh_security_provider(self):
+ """Disables BouncyCastle for SSHD."""
+ # Workaround for issue described in:
+ # https://wiki.fd.io/view/Honeycomb/Releases/1609/Honeycomb_and_ODL
+
+ self.params += " -Dorg.apache.sshd.registerBouncyCastle=false"
Code Review / csit.git / blobdiff