CSIT-395 Update TRex version to v2.09

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

diff --git a/resources/libraries/python/SetupFramework.py b/resources/libraries/python/SetupFramework.py
index b3df489..5d3d59a 100644 (file)
--- a/resources/libraries/python/SetupFramework.py
+++ b/resources/libraries/python/SetupFramework.py
@@ -16,11 +16,12 @@ nodes. All tasks required to be run before the actual tests are started is
 supposed to end up here.
 """
 
 supposed to end up here.
 """
 

-import shlex
+from shlex import split

 from subprocess import Popen, PIPE, call
 from multiprocessing import Pool
 from tempfile import NamedTemporaryFile
 from os.path import basename
 from subprocess import Popen, PIPE, call
 from multiprocessing import Pool
 from tempfile import NamedTemporaryFile
 from os.path import basename

+from os import environ

 
 from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn
 
 from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn


@@ -31,23 +32,33 @@ from resources.libraries.python.topology import NodeType
 
 __all__ = ["SetupFramework"]
 
 
 __all__ = ["SetupFramework"]
 

+

 def pack_framework_dir():
     """Pack the testing WS into temp file, return its name."""
 
 def pack_framework_dir():
     """Pack the testing WS into temp file, return its name."""
 

-    tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-")
+    try:
+        directory = environ["TMPDIR"]
+    except KeyError:
+        directory = None
+
+    if directory is not None:
+        tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-",
+                                     dir="{0}".format(directory))
+    else:
+        tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="openvpp-testing-")

     file_name = tmpfile.name
     tmpfile.close()
 
     proc = Popen(
     file_name = tmpfile.name
     tmpfile.close()
 
     proc = Popen(

-        shlex.split("tar --exclude-vcs -zcf {0} .".format(file_name)),
-        stdout=PIPE, stderr=PIPE)
+        split("tar --exclude-vcs --exclude=./tmp --exclude=*.deb -zcf {0} .".
+              format(file_name)), stdout=PIPE, stderr=PIPE)

     (stdout, stderr) = proc.communicate()
 
     logger.debug(stdout)
     logger.debug(stderr)
 
     return_code = proc.wait()
     (stdout, stderr) = proc.communicate()
 
     logger.debug(stdout)
     logger.debug(stderr)
 
     return_code = proc.wait()

-    if 0 != return_code:
+    if return_code != 0:

         raise Exception("Could not pack testing framework.")
 
     return file_name
         raise Exception("Could not pack testing framework.")
 
     return file_name


@@ -56,9 +67,9 @@ def pack_framework_dir():
 def copy_tarball_to_node(tarball, node):
     """Copy tarball file from local host to remote node.
 
 def copy_tarball_to_node(tarball, node):
     """Copy tarball file from local host to remote node.
 

-    :param tarball: path to tarball to upload
-    :param node: dictionary created from topology
-    :type tarball: string
+    :param tarball: Path to tarball to upload.
+    :param node: Dictionary created from topology.
+    :type tarball: str

     :type node: dict
     :return: nothing
     """
     :type node: dict
     :return: nothing
     """


@@ -72,11 +83,11 @@ def copy_tarball_to_node(tarball, node):
 def extract_tarball_at_node(tarball, node):
     """Extract tarball at given node.
 
 def extract_tarball_at_node(tarball, node):
     """Extract tarball at given node.
 

-    Extracts tarball using tar on given node to specific CSIT loocation.
+    Extracts tarball using tar on given node to specific CSIT location.

 
 

-    :param tarball: path to tarball to upload
-    :param node: dictionary created from topology
-    :type tarball: string
+    :param tarball: Path to tarball to upload.
+    :param node: Dictionary created from topology.
+    :type tarball: str

     :type node: dict
     :return: nothing
     """
     :type node: dict
     :return: nothing
     """


@@ -88,7 +99,7 @@ def extract_tarball_at_node(tarball, node):
     cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
         'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
     (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
     cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
         'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)
     (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)

-    if 0 != ret_code:
+    if ret_code != 0:

         logger.error('Unpack error: {0}'.format(stderr))
         raise Exception('Failed to unpack {0} at node {1}'.format(
             tarball, node['host']))
         logger.error('Unpack error: {0}'.format(stderr))
         raise Exception('Failed to unpack {0} at node {1}'.format(
             tarball, node['host']))


@@ -101,42 +112,56 @@ def create_env_directory_at_node(node):
     ssh = SSH()
     ssh.connect(node)
     (ret_code, stdout, stderr) = ssh.exec_command(
     ssh = SSH()
     ssh.connect(node)
     (ret_code, stdout, stderr) = ssh.exec_command(

-        'cd {0} && rm -rf env && virtualenv env && . env/bin/activate && '
-        'pip install -r requirements.txt'.format(con.REMOTE_FW_DIR),
-                                                 timeout=100)
-    if 0 != ret_code:
+        'cd {0} && rm -rf env && '
+        'virtualenv --system-site-packages --never-download env && '
+        '. env/bin/activate && '
+        'pip install -r requirements.txt'
+        .format(con.REMOTE_FW_DIR), timeout=100)
+    if ret_code != 0:

         logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
         raise Exception('Virtualenv setup failed')
     else:
         logger.console('Virtualenv created on {0}'.format(node['host']))
 
         logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
         raise Exception('Virtualenv setup failed')
     else:
         logger.console('Virtualenv created on {0}'.format(node['host']))
 

+
+# pylint: disable=broad-except

 def setup_node(args):
     """Run all set-up methods for a node.
 
     This method is used as map_async parameter. It receives tuple with all
     parameters as passed to map_async function.
 
 def setup_node(args):
     """Run all set-up methods for a node.
 
     This method is used as map_async parameter. It receives tuple with all
     parameters as passed to map_async function.
 

-    :param args: all parameters needed to setup one node
+    :param args: All parameters needed to setup one node.

     :type args: tuple
     :return: nothing
     :type args: tuple
     :return: nothing

+    :return: True - success, False - error
+    :rtype: bool

     """
     tarball, remote_tarball, node = args
     """
     tarball, remote_tarball, node = args

-    copy_tarball_to_node(tarball, node)
-    extract_tarball_at_node(remote_tarball, node)
-    if node['type'] == NodeType.TG:
-        create_env_directory_at_node(node)
-    logger.console('Setup of node {0} done'.format(node['host']))
+    try:
+        copy_tarball_to_node(tarball, node)
+        extract_tarball_at_node(remote_tarball, node)
+        if node['type'] == NodeType.TG:
+            create_env_directory_at_node(node)
+    except Exception as exc:
+        logger.error("Node setup failed, error:'{0}'".format(exc.message))
+        return False
+    else:
+        logger.console('Setup of node {0} done'.format(node['host']))
+        return True
+

 
 def delete_local_tarball(tarball):
     """Delete local tarball to prevent disk pollution.
 
 
 def delete_local_tarball(tarball):
     """Delete local tarball to prevent disk pollution.
 

-    :param tarball: path to tarball to upload
-    :type tarball: string
+    :param tarball: Path to tarball to upload.
+    :type tarball: str

     :return: nothing
     """
     :return: nothing
     """

-    call(shlex.split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))
+    call(split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))

 
 

-class SetupFramework(object): # pylint: disable=too-few-public-methods
+
+class SetupFramework(object):  # pylint: disable=too-few-public-methods

     """Setup suite run on topology nodes.
 
     Many VAT/CLI based tests need the scripts at remote hosts before executing
     """Setup suite run on topology nodes.
 
     Many VAT/CLI based tests need the scripts at remote hosts before executing


@@ -144,9 +169,6 @@ class SetupFramework(object): # pylint: disable=too-few-public-methods
     to all nodes in topology under /tmp/
     """
 
     to all nodes in topology under /tmp/
     """
 

-    def __init__(self):
-        pass
-

     @staticmethod
     def setup_framework(nodes):
         """Pack the whole directory and extract in temp on each node."""
     @staticmethod
     def setup_framework(nodes):
         """Pack the whole directory and extract in temp on each node."""


@@ -157,7 +179,7 @@ class SetupFramework(object): # pylint: disable=too-few-public-methods
         logger.trace(msg)
         remote_tarball = "/tmp/{0}".format(basename(tarball))
 
         logger.trace(msg)
         remote_tarball = "/tmp/{0}".format(basename(tarball))
 

-        # Turn off loggining since we use multiprocessing
+        # Turn off logging since we use multiprocessing

         log_level = BuiltIn().set_log_level('NONE')
         params = ((tarball, remote_tarball, node) for node in nodes.values())
         pool = Pool(processes=len(nodes))
         log_level = BuiltIn().set_log_level('NONE')
         params = ((tarball, remote_tarball, node) for node in nodes.values())
         pool = Pool(processes=len(nodes))


@@ -165,14 +187,15 @@ class SetupFramework(object): # pylint: disable=too-few-public-methods
         pool.close()
         pool.join()
 
         pool.close()
         pool.join()
 

+        # Turn on logging
+        BuiltIn().set_log_level(log_level)
+

         logger.info(
             'Executed node setups in parallel, waiting for processes to end')
         result.wait()
 
         logger.info('Results: {0}'.format(result.get()))
 
         logger.info(
             'Executed node setups in parallel, waiting for processes to end')
         result.wait()
 
         logger.info('Results: {0}'.format(result.get()))
 

-        # Turn on loggining
-        BuiltIn().set_log_level(log_level)

         logger.trace('Test framework copied to all topology nodes')
         delete_local_tarball(tarball)
         logger.console('All nodes are ready')
         logger.trace('Test framework copied to all topology nodes')
         delete_local_tarball(tarball)
         logger.console('All nodes are ready')