X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FTrafficScriptExecutor.py;h=8faa084ca1cbbb196fa918b077389b813e475b17;hb=7f138bad98908762f9e738c2d7c47ac204acae71;hp=ee296958127323696db9823172998448905b3795;hpb=b92a827b1c7f48da4214e992e5503ebe1c182416;p=csit.git diff --git a/resources/libraries/python/TrafficScriptExecutor.py b/resources/libraries/python/TrafficScriptExecutor.py index ee29695812..8faa084ca1 100644 --- a/resources/libraries/python/TrafficScriptExecutor.py +++ b/resources/libraries/python/TrafficScriptExecutor.py @@ -1,4 +1,4 @@ -# Copyright (c) 2016 Cisco and/or its affiliates. +# Copyright (c) 2020 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,79 +13,94 @@ """Traffic script executor library.""" -from constants import Constants -from ssh import SSH -from robot.api import logger +from resources.libraries.python.Constants import Constants +from resources.libraries.python.ssh import SSH -__all__ = ['TrafficScriptExecutor'] +__all__ = [u"TrafficScriptExecutor"] -class TrafficScriptExecutor(object): +class TrafficScriptExecutor: """Traffic script executor utilities.""" @staticmethod def _escape(string): """Escape quotation mark and dollar mark for shell command. - :param string: String to escape. - :type string: str - :return: Escaped string. - :rtype: str + :param string: String to escape. + :type string: str + :returns: Escaped string. + :rtype: str """ - return string.replace('"', '\\"').replace("$", "\\$") + return string.replace(u'"', u'\\"').replace(u"$", u"\\$") @staticmethod - def run_traffic_script_on_node(script_file_name, node, script_args, - timeout=10): + def run_traffic_script_on_node( + script_file_name, node, script_args, timeout=60): """Run traffic script on the TG node. - :param script_file_name: Traffic script name - :param node: Node to run traffic script on. - :param script_args: Traffic scripts arguments. - :param timeout: Timeout (optional). - :type script_file_name: str - :type node: dict - :type script_args: str - :type timeout: int + :param script_file_name: Traffic script name. + :param node: Node to run traffic script on. + :param script_args: Traffic scripts arguments. + :param timeout: Timeout (optional). + :type script_file_name: str + :type node: dict + :type script_args: str + :type timeout: int + :raises RuntimeError: ICMP echo Rx timeout. + :raises RuntimeError: DHCP REQUEST Rx timeout. + :raises RuntimeError: DHCP DISCOVER Rx timeout. + :raises RuntimeError: TCP/UDP Rx timeout. + :raises RuntimeError: ARP reply timeout. + :raises RuntimeError: Traffic script execution failed. """ - logger.trace("{}".format(timeout)) ssh = SSH() ssh.connect(node) - cmd = ("cd {}; virtualenv env && " + - "export PYTHONPATH=${{PWD}}; " + - ". ${{PWD}}/env/bin/activate; " + - "resources/traffic_scripts/{} {}") \ - .format(Constants.REMOTE_FW_DIR, script_file_name, - script_args) - (ret_code, stdout, stderr) = ssh.exec_command_sudo( - 'sh -c "{}"'.format(TrafficScriptExecutor._escape(cmd)), - timeout=timeout) - logger.debug("stdout: {}".format(stdout)) - logger.debug("stderr: {}".format(stderr)) - logger.debug("ret_code: {}".format(ret_code)) + module_name = script_file_name[:-3].replace('/', '.') + cmd = f"cd {Constants.REMOTE_FW_DIR}; virtualenv -p $(which python3) " \ + f"--system-site-packages --never-download env && " \ + f"export PYTHONPATH=${{PWD}}; . ${{PWD}}/env/bin/activate; " \ + f"cd GPL; python -m traffic_scripts.{module_name} {script_args}" + ret_code, stdout, stderr = ssh.exec_command_sudo( + f'sh -c "{TrafficScriptExecutor._escape(cmd)}"', timeout=timeout + ) if ret_code != 0: - raise Exception("Traffic script execution failed") + if u"RuntimeError: ICMP echo Rx timeout" in stderr: + msg = "ICMP echo Rx timeout" + elif u"RuntimeError: IP packet Rx timeout" in stderr: + msg = u"IP packet Rx timeout" + elif u"RuntimeError: DHCP REQUEST Rx timeout" in stderr: + msg = u"DHCP REQUEST Rx timeout" + elif u"RuntimeError: DHCP DISCOVER Rx timeout" in stderr: + msg = u"DHCP DISCOVER Rx timeout" + elif u"RuntimeError: TCP/UDP Rx timeout" in stderr: + msg = u"TCP/UDP Rx timeout" + elif u"Error occurred: ARP reply timeout" in stdout: + msg = u"ARP reply timeout" + elif u"RuntimeError: ESP packet Rx timeout" in stderr: + msg = u"ESP packet Rx timeout" + else: + msg = u"Traffic script execution failed" + raise RuntimeError(msg) @staticmethod def traffic_script_gen_arg(rx_if, tx_if, src_mac, dst_mac, src_ip, dst_ip): """Generate traffic script basic arguments string. - :param rx_if: Interface that receives traffic. - :param tx_if: Interface that sends traffic. - :param src_mac: Source MAC address. - :param dst_mac: Destination MAC address. - :param src_ip: Source IP address. - :param dst_ip: Destination IP address. - :type rx_if: str - :type tx_if: str - :type src_mac: str - :type dst_mac: str - :type src_ip: str - :type dst_ip: str - :return: Traffic script arguments string. - :rtype: str + :param rx_if: Interface that receives traffic. + :param tx_if: Interface that sends traffic. + :param src_mac: Source MAC address. + :param dst_mac: Destination MAC address. + :param src_ip: Source IP address. + :param dst_ip: Destination IP address. + :type rx_if: str + :type tx_if: str + :type src_mac: str + :type dst_mac: str + :type src_ip: str + :type dst_ip: str + :returns: Traffic script arguments string. + :rtype: str """ - args = '--rx_if {0} --tx_if {1} --src_mac {2} --dst_mac {3} --src_ip' \ - ' {4} --dst_ip {5}'.format(rx_if, tx_if, src_mac, dst_mac, src_ip, - dst_ip) + args = f"--rx_if {rx_if} --tx_if {tx_if} --src_mac {src_mac} " \ + f"--dst_mac {dst_mac} --src_ip {src_ip} --dst_ip {dst_ip}" return args