X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FSetupFramework.py;h=ddc5514c4aa387b14be15925de333f4140c38d2b;hp=cb0d5369877b1cde7e0780a281a8a256dd70c599;hb=c478afc5aec0161cc66e837c1ab919542b68ebbc;hpb=a06a031c5865f34c2a651ef170778149fb8f0396 diff --git a/resources/libraries/python/SetupFramework.py b/resources/libraries/python/SetupFramework.py index cb0d536987..ddc5514c4a 100644 --- a/resources/libraries/python/SetupFramework.py +++ b/resources/libraries/python/SetupFramework.py @@ -11,16 +11,23 @@ # See the License for the specific language governing permissions and # limitations under the License. -import shlex +"""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. +""" + +from shlex import split 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 ssh import SSH -from constants import Constants as con -from topology import NodeType + +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"] @@ -33,7 +40,7 @@ def pack_framework_dir(): tmpfile.close() proc = Popen( - shlex.split("tar --exclude-vcs -zcf {0} .".format(file_name)), + split("tar --exclude-vcs -zcf {0} .".format(file_name)), stdout=PIPE, stderr=PIPE) (stdout, stderr) = proc.communicate() @@ -48,6 +55,14 @@ def pack_framework_dir(): 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: str + :type node: dict + :return: nothing + """ logger.console('Copying tarball to {0}'.format(node['host'])) ssh = SSH() ssh.connect(node) @@ -56,6 +71,16 @@ def copy_tarball_to_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: str + :type node: dict + :return: nothing + """ logger.console('Extracting tarball to {0} on {1}'.format( con.REMOTE_FW_DIR, node['host'])) ssh = SSH() @@ -63,7 +88,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, 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( @@ -77,41 +102,45 @@ def create_env_directory_at_node(node): 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)) + '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') + else: + logger.console('Virtualenv created on {0}'.format(node['host'])) -def install_dependencies(node): - """TEMPORARY FUNCTION TO INSTALL DEPENDENCIES ON NODES BEFORE THE VIRL - HOSTS HAVE ALL PREREQUISITES INSTALLED""" - logger.console('Installing prerequisites on {0}'.format(node['host'])) - ssh = SSH() - ssh.connect(node) - (ret_code, stdout, stderr) = ssh.exec_command( - 'sudo apt-get -y update; ' \ - 'sudo apt-get -y install python-virtualenv python-dev', timeout=120) - if 0 != ret_code: - logger.error('Failed to install prerequisites: {0}'. - format(stdout + stderr)) - raise Exception('Virtualenv setup failed') 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) - install_dependencies(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): - 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: str + :return: nothing + """ + call(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 @@ -119,10 +148,8 @@ class SetupFramework(object): to all nodes in topology under /tmp/ """ - 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() @@ -131,7 +158,7 @@ class SetupFramework(object): 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)) @@ -145,7 +172,9 @@ class SetupFramework(object): logger.info('Results: {0}'.format(result.get())) - # Turn on loggining + # Turn on logging 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') +