Add Vagrantfile for local testing.

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

diff --git a/resources/libraries/python/SetupFramework.py b/resources/libraries/python/SetupFramework.py
index 2a0bd42..b3df489 100644 (file)
--- a/resources/libraries/python/SetupFramework.py
+++ b/resources/libraries/python/SetupFramework.py
@@ -11,19 +11,25 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
 # See the License for the specific language governing permissions and
 # limitations under the License.
 

+"""This module exists to provide setup utilities for the framework on topology
+nodes. All tasks required to be run before the actual tests are started is
+supposed to end up here.
+"""
+

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

+

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

-from ssh import SSH
-from constants import Constants as con
-from topology import NodeType

 
 

-__all__ = ["SetupFramework"]
+from resources.libraries.python.ssh import SSH
+from resources.libraries.python.constants import Constants as con
+from resources.libraries.python.topology import NodeType

 
 

+__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."""


@@ -48,6 +54,14 @@ def pack_framework_dir():
 
 
 def copy_tarball_to_node(tarball, 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
+    :type node: dict
+    :return: nothing
+    """

     logger.console('Copying tarball to {0}'.format(node['host']))
     ssh = SSH()
     ssh.connect(node)
     logger.console('Copying tarball to {0}'.format(node['host']))
     ssh = SSH()
     ssh.connect(node)


@@ -56,6 +70,16 @@ def copy_tarball_to_node(tarball, node):
 
 
 def extract_tarball_at_node(tarball, node):
 
 
 def extract_tarball_at_node(tarball, node):

+    """Extract tarball at given node.
+
+    Extracts tarball using tar on given node to specific CSIT loocation.
+
+    :param tarball: path to tarball to upload
+    :param node: dictionary created from topology
+    :type tarball: string
+    :type node: dict
+    :return: nothing
+    """

     logger.console('Extracting tarball to {0} on {1}'.format(
         con.REMOTE_FW_DIR, node['host']))
     ssh = SSH()
     logger.console('Extracting tarball to {0} on {1}'.format(
         con.REMOTE_FW_DIR, node['host']))
     ssh = SSH()


@@ -63,7 +87,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)
 
     cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
         'rm -f {0}'.format(tarball, con.REMOTE_FW_DIR)

-    (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout=30)
+    (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)

     if 0 != ret_code:
         logger.error('Unpack error: {0}'.format(stderr))
         raise Exception('Failed to unpack {0} at node {1}'.format(
     if 0 != ret_code:
         logger.error('Unpack error: {0}'.format(stderr))
         raise Exception('Failed to unpack {0} at node {1}'.format(


@@ -77,9 +101,9 @@ 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)
+        '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:
         logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
         raise Exception('Virtualenv setup failed')
     if 0 != ret_code:
         logger.error('Virtualenv creation error: {0}'.format(stdout + stderr))
         raise Exception('Virtualenv setup failed')


@@ -87,18 +111,32 @@ def create_env_directory_at_node(node):
         logger.console('Virtualenv created on {0}'.format(node['host']))
 
 def setup_node(args):
         logger.console('Virtualenv created on {0}'.format(node['host']))
 
 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
+    :type args: tuple
+    :return: nothing
+    """

     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)
     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']))

 
 def delete_local_tarball(tarball):
 
 def delete_local_tarball(tarball):

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

 
 

+    :param tarball: path to tarball to upload
+    :type tarball: string
+    :return: nothing
+    """
+    call(shlex.split('sh -c "rm {0} > /dev/null 2>&1"'.format(tarball)))

 
 

-class SetupFramework(object):
+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


@@ -109,7 +147,8 @@ class SetupFramework(object):
     def __init__(self):
         pass
 
     def __init__(self):
         pass
 

-    def setup_framework(self, nodes):
+    @staticmethod
+    def setup_framework(nodes):

         """Pack the whole directory and extract in temp on each node."""
 
         tarball = pack_framework_dir()
         """Pack the whole directory and extract in temp on each node."""
 
         tarball = pack_framework_dir()


@@ -136,3 +175,5 @@ class SetupFramework(object):
         BuiltIn().set_log_level(log_level)
         logger.trace('Test framework copied to all topology nodes')
         delete_local_tarball(tarball)
         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')
+