Separate files needing GPL license

[csit.git] / resources / libraries / python / TrafficScriptExecutor.py

diff --git a/resources/libraries/python/TrafficScriptExecutor.py b/resources/libraries/python/TrafficScriptExecutor.py
index 108b2b9..8faa084 100644 (file)
--- 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,15 +13,13 @@
 
 """Traffic script executor library."""
 
-from robot.api import logger
-
-from resources.libraries.python.constants import Constants
+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
@@ -30,14 +28,14 @@ class TrafficScriptExecutor(object):
 
         :param string: String to escape.
         :type string: str
-        :return: Escaped string.
+        :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.
@@ -48,27 +46,41 @@ class TrafficScriptExecutor(object):
         :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 --system-site-packages 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:
-            if "RuntimeError: ICMP echo Rx timeout" in stderr:
-                raise Exception("ICMP echo Rx timeout")
+            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:
-                raise Exception("Traffic script execution failed")
+                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):
@@ -86,10 +98,9 @@ class TrafficScriptExecutor(object):
         :type dst_mac: str
         :type src_ip: str
         :type dst_ip: str
-        :return: Traffic script arguments string.
+        :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