1 # Copyright (c) 2017 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Implementation of keywords for Honeycomb setup."""
16 from json import loads
17 from time import time, sleep
19 from ipaddress import IPv6Address, AddressValueError
21 from robot.api import logger
23 from resources.libraries.python.HTTPRequest import HTTPRequest, HTTPCodes, \
25 from resources.libraries.python.constants import Constants as Const
26 from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
27 from resources.libraries.python.honeycomb.HoneycombUtil \
28 import HoneycombUtil as HcUtil
29 from resources.libraries.python.ssh import SSH
30 from resources.libraries.python.topology import NodeType
33 class HoneycombSetup(object):
34 """Implements keywords for Honeycomb setup.
36 The keywords implemented in this class make possible to:
39 - check the Honeycomb start-up state,
40 - check the Honeycomb shutdown state,
41 - add VPP to the topology.
48 def start_honeycomb_on_duts(*nodes):
49 """Start Honeycomb on specified DUT nodes.
51 This keyword starts the Honeycomb service on specified DUTs.
52 The keyword just starts the Honeycomb and does not check its startup
53 state. Use the keyword "Check Honeycomb Startup State" to check if the
54 Honeycomb is up and running.
55 Honeycomb must be installed in "/opt" directory, otherwise the start
57 :param nodes: List of nodes to start Honeycomb on.
59 :raises HoneycombError: If Honeycomb fails to start.
62 HoneycombSetup.print_environment(nodes)
64 cmd = "sudo service honeycomb start"
67 if node['type'] == NodeType.DUT:
69 "\n(re)Starting Honeycomb service on node {0}".format(
73 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
74 if int(ret_code) != 0:
75 raise HoneycombError('Node {0} failed to start Honeycomb.'.
78 logger.info("Starting the Honeycomb service on node {0} is "
79 "in progress ...".format(node['host']))
82 def stop_honeycomb_on_duts(*nodes):
83 """Stop the Honeycomb service on specified DUT nodes.
85 This keyword stops the Honeycomb service on specified nodes. It just
86 stops the Honeycomb and does not check its shutdown state. Use the
87 keyword "Check Honeycomb Shutdown State" to check if Honeycomb has
89 :param nodes: List of nodes to stop Honeycomb on.
91 :raises HoneycombError: If Honeycomb failed to stop.
94 cmd = "sudo service honeycomb stop"
98 if node['type'] == NodeType.DUT:
100 "\nShutting down Honeycomb service on node {0}".format(
104 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
105 if int(ret_code) != 0:
106 errors.append(node['host'])
108 logger.info("Stopping the Honeycomb service on node {0} is "
109 "in progress ...".format(node['host']))
111 raise HoneycombError('Node(s) {0} failed to stop Honeycomb.'.
115 def restart_honeycomb_on_dut(node):
116 """Restart Honeycomb on specified DUT nodes.
118 This keyword restarts the Honeycomb service on specified DUTs. Use the
119 keyword "Check Honeycomb Startup State" to check if the Honeycomb is up
122 :param node: Node to restart Honeycomb on.
124 :raises HoneycombError: If Honeycomb fails to start.
128 "\n(re)Starting Honeycomb service on node {0}".format(node["host"]))
130 cmd = "sudo service honeycomb restart"
134 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
135 if int(ret_code) != 0:
136 raise HoneycombError('Node {0} failed to restart Honeycomb.'.
137 format(node['host']))
140 "Honeycomb service restart is in progress on node {0}".format(
144 def check_honeycomb_startup_state(node, timeout=360, retries=20,
146 """Repeatedly check the status of Honeycomb startup until it is fully
147 started or until timeout or max retries is reached.
149 :param node: Honeycomb node.
150 :param timeout: Timeout value in seconds.
151 :param retries: Max number of retries.
152 :param interval: Interval between checks, in seconds.
157 :raises HoneycombError: If the Honeycomb process IP cannot be found,
158 or if timeout or number of retries is exceeded."""
165 while time() - start < timeout and count < retries:
169 status_code_version, _ = HcUtil.get_honeycomb_data(
170 node, "oper_vpp_version")
171 status_code_if_cfg, _ = HcUtil.get_honeycomb_data(
172 node, "config_vpp_interfaces")
173 status_code_if_oper, _ = HcUtil.get_honeycomb_data(
174 node, "oper_vpp_interfaces")
175 except HTTPRequestError:
178 if status_code_if_cfg == HTTPCodes.OK\
179 and status_code_if_cfg == HTTPCodes.OK\
180 and status_code_if_oper == HTTPCodes.OK:
181 logger.info("Check successful, Honeycomb is up and running.")
185 "Attempt ${count} failed on Restconf check. Status codes:\n"
186 "Version: {version}\n"
187 "Interface config: {if_cfg}\n"
188 "Interface operational: {if_oper}".format(
190 version=status_code_version,
191 if_cfg=status_code_if_cfg,
192 if_oper=status_code_if_oper))
196 _, vpp_status, _ = ssh.exec_command("sudo service vpp status")
197 raise HoneycombError(
198 "Timeout or max retries exceeded. Status of VPP:\n"
199 "{vpp_status}".format(vpp_status=vpp_status))
202 def check_honeycomb_shutdown_state(node):
203 """Check state of Honeycomb service during shutdown on specified nodes.
205 Honeycomb nodes reply with connection refused or the following status
206 codes depending on shutdown progress: codes 200, 404.
208 :param node: List of DUT nodes stopping Honeycomb.
210 :return: True if all GETs fail to connect.
213 cmd = "pgrep honeycomb"
217 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
219 raise HoneycombError('Honeycomb on node {0} is still '
220 'running.'.format(node['host']),
221 enable_logging=False)
223 logger.info("Honeycomb on node {0} has stopped".
224 format(node['host']))
228 def configure_restconf_binding_address(node):
229 """Configure Honeycomb to accept restconf requests from all IP
230 addresses. IP version is determined by node data.
232 :param node: Information about a DUT node.
234 :raises HoneycombError: If the configuration could not be changed.
237 find = "restconf-binding-address"
239 IPv6Address(unicode(node["host"]))
240 # if management IP of the node is in IPv6 format
241 replace = '\\"restconf-binding-address\\": \\"0::0\\",'
242 except (AttributeError, AddressValueError):
243 replace = '\\"restconf-binding-address\\": \\"0.0.0.0\\",'
245 argument = '"/{0}/c\\ {1}"'.format(find, replace)
246 path = "{0}/config/restconf.json".format(Const.REMOTE_HC_DIR)
247 command = "sed -i {0} {1}".format(argument, path)
251 (ret_code, _, stderr) = ssh.exec_command_sudo(command)
253 raise HoneycombError("Failed to modify configuration on "
254 "node {0}, {1}".format(node, stderr))
257 def configure_jvpp_timeout(node, timeout=10):
258 """Configure timeout value for Java API commands Honeycomb sends to VPP.
260 :param node: Information about a DUT node.
261 :param timeout: Timeout value in seconds.
264 :raises HoneycombError: If the configuration could not be changed.
267 find = "jvpp-request-timeout"
268 replace = '\\"jvpp-request-timeout\\": {0}'.format(timeout)
270 argument = '"/{0}/c\\ {1}"'.format(find, replace)
271 path = "{0}/config/jvpp.json".format(Const.REMOTE_HC_DIR)
272 command = "sed -i {0} {1}".format(argument, path)
276 (ret_code, _, stderr) = ssh.exec_command_sudo(command)
278 raise HoneycombError("Failed to modify configuration on "
279 "node {0}, {1}".format(node, stderr))
282 def print_environment(nodes):
283 """Print information about the nodes to log. The information is defined
284 by commands in cmds tuple at the beginning of this method.
286 :param nodes: List of DUT nodes to get information about.
290 # TODO: When everything is set and running in VIRL env, transform this
291 # method to a keyword checking the environment.
299 "dpkg --list | grep openjdk",
300 "ls -la /opt/honeycomb",
301 "cat /opt/honeycomb/modules/*module-config")
304 if node['type'] == NodeType.DUT:
305 logger.info("Checking node {} ...".format(node['host']))
307 logger.info("Command: {}".format(cmd))
310 ssh.exec_command_sudo(cmd)
313 def print_ports(node):
314 """Uses "sudo netstat -anp | grep java" to print port where a java
317 :param node: Honeycomb node where we want to print the ports.
321 cmds = ("netstat -anp | grep java",
322 "ps -ef | grep [h]oneycomb")
324 logger.info("Checking node {} ...".format(node['host']))
326 logger.info("Command: {}".format(cmd))
329 ssh.exec_command_sudo(cmd)
332 def configure_log_level(node, level):
333 """Set Honeycomb logging to the specified level.
335 :param node: Honeycomb node.
336 :param level: Log level (INFO, DEBUG, TRACE).
341 find = 'logger name=\\"io.fd\\"'
342 replace = '<logger name=\\"io.fd\\" level=\\"{0}\\"/>'.format(level)
344 argument = '"/{0}/c\\ {1}"'.format(find, replace)
345 path = "{0}/config/logback.xml".format(Const.REMOTE_HC_DIR)
346 command = "sed -i {0} {1}".format(argument, path)
350 (ret_code, _, stderr) = ssh.exec_command_sudo(command)
352 raise HoneycombError("Failed to modify configuration on "
353 "node {0}, {1}".format(node, stderr))
356 def manage_honeycomb_features(node, feature, disable=False):
357 """Configure Honeycomb to use features that are disabled by default, or
358 disable previously enabled features.
360 ..Note:: If the module is not enabled in VPP, Honeycomb will
361 be unable to establish VPP connection.
363 :param node: Honeycomb node.
364 :param feature: Feature to enable.
365 :param disable: Disable the specified feature instead of enabling it.
367 :type feature: string
369 :raises HoneycombError: If the configuration could not be changed.
372 disabled_features = {
373 "NSH": ["io.fd.hc2vpp.vppnsh.impl.VppNshModule"],
374 "BGP": ["io.fd.hc2vpp.bgp.inet.BgpInetModule",
375 "io.fd.honeycomb.infra.bgp.BgpModule",
376 "io.fd.honeycomb.infra.bgp.BgpReadersModule",
377 "io.fd.honeycomb.infra.bgp.BgpWritersModule",
378 "io.fd.honeycomb.northbound.bgp.extension.InetModule",
379 "io.fd.honeycomb.northbound.bgp.extension.EvpnModule",
380 "io.fd.honeycomb.northbound.bgp.extension.L3VpnV4Module",
381 "io.fd.honeycomb.northbound.bgp.extension.L3VpnV6Module",
382 "io.fd.honeycomb.northbound.bgp.extension."
383 "LabeledUnicastModule",
384 "io.fd.honeycomb.northbound.bgp.extension.LinkstateModule"]
390 if feature in disabled_features.keys():
391 # for every module, uncomment by replacing the entire line
392 for item in disabled_features[feature]:
393 find = replace = "{0}".format(item)
395 replace = "// {0}".format(find)
397 argument = '"/{0}/c\\ {1}"'.format(find, replace)
398 path = "{0}/modules/*module-config"\
399 .format(Const.REMOTE_HC_DIR)
400 command = "sed -i {0} {1}".format(argument, path)
402 (ret_code, _, stderr) = ssh.exec_command_sudo(command)
404 raise HoneycombError("Failed to modify configuration on "
405 "node {0}, {1}".format(node, stderr))
407 raise HoneycombError(
408 "Unrecognized feature {0}.".format(feature))
411 def copy_java_libraries(node):
412 """Copy Java libraries installed by vpp-api-java package to honeycomb
415 This is a (temporary?) workaround for jvpp version mismatches.
417 :param node: Honeycomb node
423 (_, stdout, _) = ssh.exec_command_sudo(
424 "ls /usr/share/java | grep ^jvpp-*")
426 files = stdout.split("\n")[:-1]
429 # jvpp-registry-17.04.jar
430 # jvpp-core-17.04.jar
432 parts = item.split("-")
433 version = "{0}-SNAPSHOT".format(parts[2][:5])
434 artifact_id = "{0}-{1}".format(parts[0], parts[1])
436 directory = "{0}/lib/io/fd/vpp/{1}/{2}".format(
437 Const.REMOTE_HC_DIR, artifact_id, version)
438 cmd = "sudo mkdir -p {0}; " \
439 "sudo cp /usr/share/java/{1} {0}/{2}-{3}.jar".format(
440 directory, item, artifact_id, version)
442 (ret_code, _, stderr) = ssh.exec_command(cmd)
444 raise HoneycombError("Failed to copy JVPP libraries on "
445 "node {0}, {1}".format(node, stderr))
448 def copy_odl_client(node, odl_name, src_path, dst_path):
449 """Copy ODL Client from source path to destination path.
451 :param node: Honeycomb node.
452 :param odl_name: Name of ODL client version to use.
453 :param src_path: Source Path where to find ODl client.
454 :param dst_path: Destination path.
459 :raises HoneycombError: If the operation fails.
465 cmd = "sudo rm -rf {dst}/*karaf_{odl_name} && " \
466 "cp -r {src}/*karaf_{odl_name}* {dst}".format(
467 src=src_path, odl_name=odl_name, dst=dst_path)
469 ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=180)
470 if int(ret_code) != 0:
471 raise HoneycombError(
472 "Failed to copy ODL client on node {0}".format(node["host"]))
475 def setup_odl_client(node, path):
476 """Start ODL client on the specified node.
478 Karaf should be located in the provided path, and VPP and Honeycomb
479 should already be running, otherwise the start will fail.
480 :param node: Node to start ODL client on.
481 :param path: Path to ODL client on node.
484 :raises HoneycombError: If Honeycomb fails to start.
487 logger.console("\nStarting ODL client ...")
491 cmd = "{path}/*karaf*/bin/start clean".format(path=path)
492 ret_code, _, _ = ssh.exec_command_sudo(cmd)
494 if int(ret_code) != 0:
495 raise HoneycombError('Node {0} failed to start ODL.'.
496 format(node['host']))
498 logger.info("Starting the ODL client on node {0} is "
499 "in progress ...".format(node['host']))
502 def install_odl_features(node, odl_name, path, *features):
503 """Install required features on a running ODL client.
505 :param node: Honeycomb node.
506 :param odl_name: Name of ODL client version to use.
507 :param path: Path to ODL client on node.
508 :param features: Optional, list of additional features to install.
519 if odl_name.lower() == "oxygen":
520 auth = "-u karaf -p karaf"
522 cmd = "{path}/*karaf*/bin/client {auth} feature:install " \
523 "odl-restconf-all " \
524 "odl-netconf-connector-all " \
525 "odl-netconf-topology".format(path=path, auth=auth)
526 for feature in features:
527 cmd += " {0}".format(feature)
529 ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=250)
531 if int(ret_code) != 0:
532 raise HoneycombError("Feature install did not succeed.")
535 def check_odl_startup_state(node):
536 """Check the status of ODL client startup.
538 :param node: Honeycomb node.
540 :returns: True when ODL is started.
542 :raises HoneycombError: When the response is not code 200: OK.
545 path = HcUtil.read_path_from_url_file(
546 "odl_client/odl_netconf_connector")
547 expected_status_codes = (HTTPCodes.UNAUTHORIZED,
550 HTTPCodes.SERVICE_UNAVAILABLE,
551 HTTPCodes.INTERNAL_SERVER_ERROR)
553 status_code, _ = HTTPRequest.get(node, path, timeout=10,
554 enable_logging=False)
555 if status_code == HTTPCodes.OK:
556 logger.info("ODL client on node {0} is up and running".
557 format(node['host']))
558 elif status_code in expected_status_codes:
559 if status_code == HTTPCodes.UNAUTHORIZED:
560 logger.info('Unauthorized. If this triggers keyword '
561 'timeout, verify username and password.')
562 raise HoneycombError('ODL client on node {0} running but '
563 'not yet ready.'.format(node['host']),
564 enable_logging=False)
566 raise HoneycombError('Unexpected return code: {0}.'.
571 def check_odl_shutdown_state(node):
572 """Check the status of ODL client shutdown.
574 :param node: Honeycomb node.
576 :returns: True when ODL is stopped.
578 :raises HoneycombError: When the response is not code 200: OK.
581 cmd = "pgrep -f karaf"
582 path = HcUtil.read_path_from_url_file(
583 "odl_client/odl_netconf_connector")
586 HTTPRequest.get(node, path, timeout=10, enable_logging=False)
587 raise HoneycombError("ODL client is still running.")
588 except HTTPRequestError:
589 logger.debug("Connection refused, checking process state....")
592 ret_code, _, _ = ssh.exec_command(cmd)
594 raise HoneycombError("ODL client is still running.")
599 def mount_honeycomb_on_odl(node):
600 """Tell ODL client to mount Honeycomb instance over netconf.
602 :param node: Honeycomb node.
604 :raises HoneycombError: When the response is not code 200: OK.
607 path = HcUtil.read_path_from_url_file(
608 "odl_client/odl_netconf_connector")
610 url_file = "{0}/{1}".format(Const.RESOURCES_TPL_HC,
611 "odl_client/mount_honeycomb.json")
613 with open(url_file) as template:
614 data = template.read()
618 status_code, _ = HTTPRequest.post(
621 headers={"Content-Type": "application/json",
622 "Accept": "text/plain"},
625 enable_logging=False)
627 if status_code == HTTPCodes.OK:
628 logger.info("ODL mount point configured successfully.")
629 elif status_code == HTTPCodes.CONFLICT:
630 logger.info("ODL mount point was already configured.")
632 raise HoneycombError('Mount point configuration not successful')
635 def stop_odl_client(node, path):
636 """Stop ODL client service on the specified node.
638 :param node: Node to start ODL client on.
639 :param path: Path to ODL client.
642 :raises HoneycombError: If ODL client fails to stop.
648 cmd = "{0}/*karaf*/bin/stop".format(path)
652 ret_code, _, _ = ssh.exec_command_sudo(cmd)
653 if int(ret_code) != 0:
654 logger.debug("ODL Client refused to shut down.")
655 cmd = "pkill -f 'karaf'"
656 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
657 if int(ret_code) != 0:
658 raise HoneycombError('Node {0} failed to stop ODL.'.
659 format(node['host']))
661 logger.info("ODL client service stopped.")
664 def set_static_arp(node, ip_address, mac_address):
665 """Configure a static ARP entry using arp.
667 :param node: Node in topology.
668 :param ip_address: IP address for the entry.
669 :param mac_address: MAC adddress for the entry.
671 :type ip_address: str
672 :type mac_address: str
673 :raises RuntimeError: If the operation fails.
678 ret_code, _, _ = ssh.exec_command_sudo("arp -s {0} {1}".format(
679 ip_address, mac_address))
682 raise RuntimeError("Failed to configure static ARP adddress.")
685 class HoneycombStartupConfig(object):
686 """Generator for Honeycomb startup configuration.
691 self.template = """#!/bin/sh -
694 while [ $STATUS -eq 100 ]
696 {java_call} -jar $(dirname $0)/{jar_filename}
698 echo "Honeycomb exited with status: $STATUS"
699 if [ $STATUS -eq 100 ]
706 self.java_call = "{scheduler} {affinity} java{jit_mode}{params}"
709 self.core_affinity = ""
717 def apply_config(self, node):
718 """Generate configuration file /opt/honeycomb/honeycomb on the specified
721 :param node: Honeycomb node.
725 self.ssh.connect(node)
726 _, filename, _ = self.ssh.exec_command("ls /opt/honeycomb | grep .jar")
728 java_call = self.java_call.format(scheduler=self.scheduler,
729 affinity=self.core_affinity,
730 jit_mode=self.jit_mode,
732 self.config = self.template.format(java_call=java_call,
733 jar_filename=filename)
735 self.ssh.connect(node)
736 cmd = "echo '{config}' > /tmp/honeycomb " \
737 "&& chmod +x /tmp/honeycomb " \
738 "&& sudo mv -f /tmp/honeycomb /opt/honeycomb".\
739 format(config=self.config)
740 self.ssh.exec_command(cmd)
742 def set_cpu_scheduler(self, scheduler="FIFO"):
743 """Use alternate CPU scheduler.
745 Note: OTHER scheduler doesn't load-balance over isolcpus.
747 :param scheduler: CPU scheduler to use.
751 schedulers = {"FIFO": "-f 99", # First In, First Out
752 "RR": "-r 99", # Round Robin
753 "OTHER": "-o", # Ubuntu default
755 self.scheduler = "chrt {0}".format(schedulers[scheduler])
757 def set_cpu_core_affinity(self, low, high=None):
758 """Set core affinity for the honeycomb process and subprocesses.
760 :param low: Lowest core ID number.
761 :param high: Highest core ID number. Leave empty to use a single core.
766 self.core_affinity = "taskset -c {low}-{high}".format(
767 low=low, high=high if high else low)
769 def set_jit_compiler_mode(self, jit_mode):
770 """Set running mode for Java's JIT compiler.
772 :param jit_mode: Desiret JIT mode.
776 modes = {"client": " -client", # Default
777 "server": " -server", # Higher performance but longer warmup
778 "classic": " -classic" # Disables JIT compiler
781 self.jit_mode = modes[jit_mode]
783 def set_memory_size(self, mem_min, mem_max=None):
784 """Set minimum and maximum memory use for the JVM.
786 :param mem_min: Minimum amount of memory (MB).
787 :param mem_max: Maximum amount of memory (MB). Default is 4 times
793 self.params += " -Xms{min}m -Xmx{max}m".format(
794 min=mem_min, max=mem_max if mem_max else mem_min*4)
796 def set_metaspace_size(self, mem_min, mem_max=None):
797 """Set minimum and maximum memory used for class metadata in the JVM.
799 :param mem_min: Minimum metaspace size (MB).
800 :param mem_max: Maximum metaspace size (MB). Defailt is 4 times
806 self.params += " -XX:MetaspaceSize={min}m " \
807 "-XX:MaxMetaspaceSize={max}m".format(
808 min=mem_min, max=mem_max if mem_max else mem_min*4)
810 def set_numa_optimization(self):
811 """Use optimization of memory use and garbage collection for NUMA
814 self.params += " -XX:+UseNUMA -XX:+UseParallelGC"
816 def set_ssh_security_provider(self):
817 """Disables BouncyCastle for SSHD."""
818 # Workaround for issue described in:
819 # https://wiki.fd.io/view/Honeycomb/Releases/1609/Honeycomb_and_ODL
821 self.params += " -Dorg.apache.sshd.registerBouncyCastle=false"